workflow_to_hash 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.gitignore +9 -0
- data/.travis.yml +5 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +21 -0
- data/README.md +150 -0
- data/Rakefile +10 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/lib/workflow_to_hash/unknown_workflow_error.rb +4 -0
- data/lib/workflow_to_hash/version.rb +3 -0
- data/lib/workflow_to_hash/workflow.rb +36 -0
- data/lib/workflow_to_hash.rb +7 -0
- data/workflow_to_hash.gemspec +27 -0
- metadata +100 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: a07af50045c07bc2a75af261eb83cb062ce2729f
|
4
|
+
data.tar.gz: 52101b8d2a9aa463a2dd90c5422b12f015277fc2
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: f8ab3ece098435ca12260d4ff8f3a12a224224d0ab65f10b658fd27cefa506614e6f8e316e7d0ff985784e93ec4e5896221f48a1971e455f210d1a03740dd7cc
|
7
|
+
data.tar.gz: da5ec629a4855f32b945a72a0d37aca3065d0445038e03c283e1fcad96ae8f1c90ab84e5d948d13704bfebd567c3be7012ac204ed4eb809de1fe2df9440de382
|
data/.gitignore
ADDED
data/.travis.yml
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2017 Rob Nichols
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
13
|
+
all copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
21
|
+
THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,150 @@
|
|
1
|
+
# WorkflowToHash
|
2
|
+
|
3
|
+
A tool to allow a sequence of actions in a state machine to be defined
|
4
|
+
as an array.
|
5
|
+
|
6
|
+
## Installation
|
7
|
+
|
8
|
+
Add this line to your application's Gemfile:
|
9
|
+
|
10
|
+
```ruby
|
11
|
+
gem 'workflow_to_hash'
|
12
|
+
```
|
13
|
+
|
14
|
+
And then execute:
|
15
|
+
|
16
|
+
$ bundle
|
17
|
+
|
18
|
+
Or install it yourself as:
|
19
|
+
|
20
|
+
$ gem install workflow_to_hash
|
21
|
+
|
22
|
+
## Usage
|
23
|
+
|
24
|
+
This tool has been specifically designed to work with
|
25
|
+
[Piotr Murach's FiniteMachine](https://github.com/piotrmurach/finite_machine)
|
26
|
+
but is not limited to that environment.
|
27
|
+
|
28
|
+
When building state matchines, I regularly find that state needs to move in a sequence of
|
29
|
+
steps. For example, `:one` to `:two` to `three`. In FiniteMachine, to achieve that you
|
30
|
+
can do this:
|
31
|
+
|
32
|
+
```ruby
|
33
|
+
class StateMachine < FiniteMachine::Definition
|
34
|
+
initial :one
|
35
|
+
|
36
|
+
events {
|
37
|
+
event(
|
38
|
+
:next,
|
39
|
+
:one => :two,
|
40
|
+
:two => :three
|
41
|
+
)
|
42
|
+
}
|
43
|
+
end
|
44
|
+
|
45
|
+
sm = StateMachine.new
|
46
|
+
sm.state # --> :one
|
47
|
+
sm.next
|
48
|
+
sm.state # --> :two
|
49
|
+
sm.next
|
50
|
+
sm.state # --> :three
|
51
|
+
```
|
52
|
+
|
53
|
+
That is OK, but gets a little unwieldy as the sequence grows or when you want to swap out
|
54
|
+
sequences depending on a condition.
|
55
|
+
|
56
|
+
WorkflowToHash allow me to create state sequences more easily. For example, to achieve
|
57
|
+
the above I could:
|
58
|
+
|
59
|
+
```ruby
|
60
|
+
class Workflow < WorkflowToHash::Workflow
|
61
|
+
def forward
|
62
|
+
[:start, :one, :two, :three]
|
63
|
+
end
|
64
|
+
|
65
|
+
def backward
|
66
|
+
[:start, :three, :two, :one]
|
67
|
+
end
|
68
|
+
end
|
69
|
+
|
70
|
+
class StateMachine < FiniteMachine::Definition
|
71
|
+
initial :start
|
72
|
+
|
73
|
+
events {
|
74
|
+
event(
|
75
|
+
:next,
|
76
|
+
Workflow.for(:forward)
|
77
|
+
)
|
78
|
+
}
|
79
|
+
end
|
80
|
+
|
81
|
+
sm = StateMachine.new
|
82
|
+
sm.state # --> :start
|
83
|
+
sm.next
|
84
|
+
sm.state # --> :one
|
85
|
+
sm.next
|
86
|
+
sm.state # --> :two
|
87
|
+
sm.next
|
88
|
+
sm.state # --> :three
|
89
|
+
```
|
90
|
+
|
91
|
+
And the it allows me to build more complex state machines succinctly:
|
92
|
+
|
93
|
+
```ruby
|
94
|
+
|
95
|
+
class StateMachine < FiniteMachine::Definition
|
96
|
+
initial :start
|
97
|
+
|
98
|
+
events {
|
99
|
+
event(
|
100
|
+
:next,
|
101
|
+
Workflow.for(:forward).merge(if: -> {target.forward})
|
102
|
+
),
|
103
|
+
event(
|
104
|
+
:next,
|
105
|
+
Workflow.for(:backward).merge(if: -> {!target.forward)
|
106
|
+
)
|
107
|
+
}
|
108
|
+
end
|
109
|
+
|
110
|
+
require 'ostruct'
|
111
|
+
forward = OpenStruct.new forward: true
|
112
|
+
backward = OpenStruct.new forward: false
|
113
|
+
|
114
|
+
sm = StateMachine.new
|
115
|
+
sm.target forward
|
116
|
+
sm.state # --> :start
|
117
|
+
sm.next
|
118
|
+
sm.state # --> :one
|
119
|
+
sm.next
|
120
|
+
sm.state # --> :two
|
121
|
+
sm.next
|
122
|
+
sm.state # --> :three
|
123
|
+
|
124
|
+
sm = StateMachine.new
|
125
|
+
sm.target backward
|
126
|
+
sm.state # --> :start
|
127
|
+
sm.next
|
128
|
+
sm.state # --> :three
|
129
|
+
sm.next
|
130
|
+
sm.state # --> :two
|
131
|
+
sm.next
|
132
|
+
sm.state # --> :one
|
133
|
+
```
|
134
|
+
|
135
|
+
## Development
|
136
|
+
|
137
|
+
Run `rake test` to run the tests.
|
138
|
+
|
139
|
+
You can also run `bin/console` for an interactive prompt that will allow you to experiment.
|
140
|
+
|
141
|
+
To install this gem onto your local machine, run `bundle exec rake install`.
|
142
|
+
|
143
|
+
## Contributing
|
144
|
+
|
145
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/reggieb/workflow_to_hash.
|
146
|
+
|
147
|
+
## License
|
148
|
+
|
149
|
+
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
|
150
|
+
|
data/Rakefile
ADDED
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "workflow_to_hash"
|
5
|
+
|
6
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
7
|
+
# with your gem easier. You can also use a different console, if you like.
|
8
|
+
|
9
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
10
|
+
# require "pry"
|
11
|
+
# Pry.start
|
12
|
+
|
13
|
+
require "irb"
|
14
|
+
IRB.start(__FILE__)
|
data/bin/setup
ADDED
@@ -0,0 +1,36 @@
|
|
1
|
+
module WorkflowToHash
|
2
|
+
class Workflow
|
3
|
+
|
4
|
+
def self.for(workflow)
|
5
|
+
new(workflow).send(:to_hash)
|
6
|
+
end
|
7
|
+
|
8
|
+
private
|
9
|
+
attr_reader :workflow
|
10
|
+
def initialize(workflow)
|
11
|
+
raise_unknown_workflow_error unless is_public_method?(workflow)
|
12
|
+
@workflow = send workflow
|
13
|
+
end
|
14
|
+
|
15
|
+
def to_hash
|
16
|
+
make_hash workflow
|
17
|
+
end
|
18
|
+
|
19
|
+
# Converts [:a, :b, :c] into
|
20
|
+
# {:a => :b, :b => :c}
|
21
|
+
def make_hash(array)
|
22
|
+
all_but_last = array[0..-2]
|
23
|
+
all_but_first = array[1..-1]
|
24
|
+
pairs = [all_but_last, all_but_first].transpose
|
25
|
+
Hash[pairs]
|
26
|
+
end
|
27
|
+
|
28
|
+
def is_public_method?(name)
|
29
|
+
public_methods.include?(name.to_sym)
|
30
|
+
end
|
31
|
+
|
32
|
+
def raise_unknown_workflow_error
|
33
|
+
raise UnknownWorkflowError.new 'Workflow name must match a public method'
|
34
|
+
end
|
35
|
+
end
|
36
|
+
end
|
@@ -0,0 +1,27 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'workflow_to_hash/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "workflow_to_hash"
|
8
|
+
spec.version = WorkflowToHash::VERSION
|
9
|
+
spec.authors = ["Rob Nichols"]
|
10
|
+
spec.email = ["rob@nicholshayes.co.uk"]
|
11
|
+
|
12
|
+
spec.summary = %q{A tool to allow a sequence of actions in a state machine to be defined as an array}
|
13
|
+
spec.description = %q{Takes `[:one, :two, :three]` and convert it to `{one: :two, two: :three}`}
|
14
|
+
spec.homepage = "https://github.com/reggieb/workflow_to_hash"
|
15
|
+
spec.license = "MIT"
|
16
|
+
|
17
|
+
spec.files = `git ls-files -z`.split("\x0").reject do |f|
|
18
|
+
f.match(%r{^(test|spec|features)/})
|
19
|
+
end
|
20
|
+
spec.bindir = "exe"
|
21
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
22
|
+
spec.require_paths = ["lib"]
|
23
|
+
|
24
|
+
spec.add_development_dependency "bundler", "~> 1.14"
|
25
|
+
spec.add_development_dependency "rake", "~> 10.0"
|
26
|
+
spec.add_development_dependency "minitest", "~> 5.0"
|
27
|
+
end
|
metadata
ADDED
@@ -0,0 +1,100 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: workflow_to_hash
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Rob Nichols
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2017-05-12 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: bundler
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '1.14'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.14'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rake
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '10.0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '10.0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: minitest
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '5.0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '5.0'
|
55
|
+
description: 'Takes `[:one, :two, :three]` and convert it to `{one: :two, two: :three}`'
|
56
|
+
email:
|
57
|
+
- rob@nicholshayes.co.uk
|
58
|
+
executables: []
|
59
|
+
extensions: []
|
60
|
+
extra_rdoc_files: []
|
61
|
+
files:
|
62
|
+
- ".gitignore"
|
63
|
+
- ".travis.yml"
|
64
|
+
- Gemfile
|
65
|
+
- LICENSE.txt
|
66
|
+
- README.md
|
67
|
+
- Rakefile
|
68
|
+
- bin/console
|
69
|
+
- bin/setup
|
70
|
+
- lib/workflow_to_hash.rb
|
71
|
+
- lib/workflow_to_hash/unknown_workflow_error.rb
|
72
|
+
- lib/workflow_to_hash/version.rb
|
73
|
+
- lib/workflow_to_hash/workflow.rb
|
74
|
+
- workflow_to_hash.gemspec
|
75
|
+
homepage: https://github.com/reggieb/workflow_to_hash
|
76
|
+
licenses:
|
77
|
+
- MIT
|
78
|
+
metadata: {}
|
79
|
+
post_install_message:
|
80
|
+
rdoc_options: []
|
81
|
+
require_paths:
|
82
|
+
- lib
|
83
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
84
|
+
requirements:
|
85
|
+
- - ">="
|
86
|
+
- !ruby/object:Gem::Version
|
87
|
+
version: '0'
|
88
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
89
|
+
requirements:
|
90
|
+
- - ">="
|
91
|
+
- !ruby/object:Gem::Version
|
92
|
+
version: '0'
|
93
|
+
requirements: []
|
94
|
+
rubyforge_project:
|
95
|
+
rubygems_version: 2.6.11
|
96
|
+
signing_key:
|
97
|
+
specification_version: 4
|
98
|
+
summary: A tool to allow a sequence of actions in a state machine to be defined as
|
99
|
+
an array
|
100
|
+
test_files: []
|