Skip to content

Commit 043b42c

Browse files
author
cfoehrdes
committed
chore(General): initial commit
0 parents  commit 043b42c

27 files changed

+2319
-0
lines changed

.gitignore

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
/bin/
2+
/coverage/
3+
/vendor/
4+
5+
composer.phar

LICENSE

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
Copyright (c) 2015 LeapHub GmbH
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy
4+
of this software and associated documentation files (the "Software"), to deal
5+
in the Software without restriction, including without limitation the rights
6+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7+
copies of the Software, and to permit persons to whom the Software is furnished
8+
to do so, subject to the following conditions:
9+
10+
The above copyright notice and this permission notice shall be included in all
11+
copies or substantial portions of the Software.
12+
13+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
19+
THE SOFTWARE.

README.md

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# LeapHub Flow Engine
2+
3+
LeapHub flow allows you to define and execute job flows by specifying an arbitrary amount of jobs and their pre and post
4+
conditions.
5+
6+
## Installation
7+
8+
9+
10+
## Usage
11+
12+
1. Create the jobs to be executed
13+
14+
15+
16+
2. Instantiate them and specify pre and post conditions
17+
18+
19+
20+
3. Execute the flow
21+
22+
23+
24+
## Events
25+
26+
The library provides a number of events which allow you to hook into the flow execution process. The following events
27+
are triggered during the execution of a flow:
28+
29+
* `flow.flow_exec.started`: Immediately before a flow is executed.
30+
* `flow.flow_exec.finished`: After all job of a flow have successfully been executed.
31+
* `flow.job_exec.started`: Immediately before a job in a flow is executed.
32+
* `flow.job_exec.finished`: After a job in a flow has successfully been executed.
33+
34+
For more information on the flow events see `Leaphub\Flow\Event\FlowEvents`.
35+
36+
## Running the tests
37+
38+
If the dev-dependencies are installed via composer, the test suite can be executed using:
39+
40+
bin/phpunit -c phpunit.xml.dist --coverage-html ./coverage
41+
42+
## Contributing
43+
44+
1. Fork the repository
45+
2. Create a branch for your contribution e.g. my-awesome-feature
46+
3. Mage your changes (Follow the git commenting guidelines and code style)
47+
4. Run the tests to ensure everything works fine
48+
5. Crate a pull request
49+
50+

composer.json

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
{
2+
"name": "leaphub/leaphub-flow",
3+
"description": "A library for the definition and execution of job flows",
4+
"license": "MIT",
5+
"authors": [
6+
{
7+
"name": "Christoph Föhrdes",
8+
"email": "christoph.foehrdes@leaphub.de"
9+
}
10+
],
11+
"autoload": {
12+
"psr-0": {
13+
"Leaphub\\Flow\\": "src/"
14+
}
15+
},
16+
"require": {
17+
"php": ">=5.3.3",
18+
"symfony/event-dispatcher": "~2.5"
19+
},
20+
"require-dev": {
21+
"phpunit/phpunit": "4.*"
22+
},
23+
"config": {
24+
"bin-dir": "bin"
25+
},
26+
"extra": {
27+
"branch-alias": {
28+
"dev-master": "0.9-dev"
29+
}
30+
}
31+
}

0 commit comments

Comments
 (0)