Skip to content

Commit

Permalink
Fix README w/ Floraison and add some basic instructions.
Browse files Browse the repository at this point in the history
  • Loading branch information
northox committed Nov 18, 2018
1 parent 4568e32 commit fb47149
Showing 1 changed file with 37 additions and 56 deletions.
93 changes: 37 additions & 56 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,61 +1,28 @@
# Floristry
The goal of this gem is to help you represent [Flor's workflows](https://github.com/floraison/flor) using standard Rails facilities, e.g. partials, helpers, render, models, etc.

The goal of this gem is to help you represent [Ruote's workflows](http://ruote.rubyforge.org/) using standard Rails
facilities, e.g. partials, helpers, render, models, etc.

Ruote::Trail is an [isolated engine](http://guides.rubyonrails.org/engines.html) which provides basic
behaviors and representation of Ruote's Flow Expression, e.g. define, sequence, concurrence, if, wait, participant, inc,
set. Obviously, you can override their default behaviors and representations by defining your owns.
Floristry is an [isolated engine](http://guides.rubyonrails.org/engines.html) which provides basic behaviors and representations to Flor's workflow language, e.g. sequence, concurrence, task, if, sleep, cron. Obviously, you can override their default behaviors (e.g. model) and representations (e.g. partial) your owns.

To override a view, simply create a new one in:

/app/views/floristry/_participant.html.erb.
/app/views/floristry/_cron.html.erb.

## Hierarchy
## Features
TODO

### Hierarchy
- Expression
- Leaf Expression
- Participant
- Tasker
- If
- Wait
- ...
- Branch Expression
- Define
- Sequence
- Concurrence
- ...

## Installation

TODO

Add this line to your application's Gemfile:

gem 'active-trail'

And then execute:

$ bundle

Or install it yourself as:

$ gem install active-trail

Then register the service in the ruote engine:

```ruby
RuoteKit.engine.add_service('trail',
'floristry/observer',
'Floristry::Observer',
'archive' => 'Floristry::Archive::ActiveRecord')
```

## Usage

TODO


### Era - :pass, :present, :future

The following methods are available on each Expressions to identify its era:

```
Expand All @@ -67,12 +34,10 @@ is_present?
is_future?
```

## Extend
New behaviors ca be added to low-level Expression such as Expression (root), BranchExpression or LeafExpression
to affect all Expressions at once, only Leaves or only Branches.
### Extend
New behaviors ca be added to low-level Expression such as Expression (root), BranchExpression or LeafExpression to affect all Expressions at once, only Leaves or only Branches respectively.

Create a file called /config/initializers/active-trail.rb containing modules with the desired behaviors. Then
use the following config to define which module will be included in the which low-level Expression.
Create a file called /config/initializers/active-trail.rb containing modules with the desired behaviors. Then use the following config to define which module will be included in the which low-level Expression.

```ruby
module FloristryBranchBehavior
Expand All @@ -90,26 +55,42 @@ Floristry.configure do |config|
end
```

## TODO
## Requirements
TODO

## Installation
1. Add this line to your application's Gemfile:

1.
`gem 'floristry'`

## Contributing
2. And then execute:

`$ bundle install`

3. Then register the service in flor engine by running:

`rails g floristry:install --flack-and-flor`

This will our default Taskers and install [Flack](https://github.com/floraison/flack) and [Flor](https://github.com/floraison/flor) one directory level below your app ( ../). Remove the `--flack-and-flor` switch if you already have them installed.

4. TODO

## Usage
TODO

## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request

## License

GPLv2
MIT

## Source
https://github.com/mantor/floristry

https://github.com/northox/active-trail

## Author

Mantor Organization
## Author(s)
Danny Fullerton - Mantor Organization
Jean-Francois Rioux - Mantor Organization

0 comments on commit fb47149

Please sign in to comment.