workflow_to_hash 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a07af50045c07bc2a75af261eb83cb062ce2729f
+  data.tar.gz: 52101b8d2a9aa463a2dd90c5422b12f015277fc2
+SHA512:
+  metadata.gz: f8ab3ece098435ca12260d4ff8f3a12a224224d0ab65f10b658fd27cefa506614e6f8e316e7d0ff985784e93ec4e5896221f48a1971e455f210d1a03740dd7cc
+  data.tar.gz: da5ec629a4855f32b945a72a0d37aca3065d0445038e03c283e1fcad96ae8f1c90ab84e5d948d13704bfebd567c3be7012ac204ed4eb809de1fe2df9440de382

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in workflow_to_hash.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Rob Nichols
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,150 @@
+# WorkflowToHash
+
+A tool to allow a sequence of actions in a state machine to be defined
+as an array.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'workflow_to_hash'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install workflow_to_hash
+
+## Usage
+
+This tool has been specifically designed to work with
+[Piotr Murach's FiniteMachine](https://github.com/piotrmurach/finite_machine)
+but is not limited to that environment.
+
+When building state matchines, I regularly find that state needs to move in a sequence of
+steps. For example, `:one` to `:two` to `three`. In FiniteMachine, to achieve that you
+can do this:
+
+```ruby
+class StateMachine < FiniteMachine::Definition
+  initial :one
+
+  events {
+    event(
+      :next,
+      :one => :two,
+      :two => :three
+    )
+  }
+end
+
+sm = StateMachine.new
+sm.state # --> :one
+sm.next
+sm.state # --> :two
+sm.next
+sm.state # --> :three
+```
+
+That is OK, but gets a little unwieldy as the sequence grows or when you want to swap out
+sequences depending on a condition.
+
+WorkflowToHash allow me to create state sequences more easily. For example, to achieve
+the above I could:
+
+```ruby
+class Workflow < WorkflowToHash::Workflow
+  def forward
+    [:start, :one, :two, :three]
+  end
+
+  def backward
+    [:start, :three, :two, :one]
+  end
+end
+
+class StateMachine < FiniteMachine::Definition
+  initial :start
+
+  events {
+    event(
+      :next,
+      Workflow.for(:forward)
+    )
+  }
+end
+
+sm = StateMachine.new
+sm.state # --> :start
+sm.next
+sm.state # --> :one
+sm.next
+sm.state # --> :two
+sm.next
+sm.state # --> :three
+```
+
+And the it allows me to build more complex state machines succinctly:
+
+```ruby
+
+class StateMachine < FiniteMachine::Definition
+  initial :start
+
+  events {
+    event(
+      :next,
+      Workflow.for(:forward).merge(if: -> {target.forward})
+    ),
+    event(
+      :next,
+      Workflow.for(:backward).merge(if: -> {!target.forward)
+    )
+  }
+end
+
+require 'ostruct'
+forward = OpenStruct.new forward: true
+backward = OpenStruct.new forward: false
+
+sm = StateMachine.new
+sm.target forward
+sm.state # --> :start
+sm.next
+sm.state # --> :one
+sm.next
+sm.state # --> :two
+sm.next
+sm.state # --> :three
+
+sm = StateMachine.new
+sm.target backward
+sm.state # --> :start
+sm.next
+sm.state # --> :three
+sm.next
+sm.state # --> :two
+sm.next
+sm.state # --> :one
+```
+
+## Development
+
+Run `rake test` to run the tests.
+
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/reggieb/workflow_to_hash.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "workflow_to_hash"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/workflow_to_hash/unknown_workflow_error.rb

@@ -0,0 +1,4 @@
+module WorkflowToHash
+  class UnknownWorkflowError < StandardError
+  end
+end

data/lib/workflow_to_hash/version.rb

@@ -0,0 +1,3 @@
+module WorkflowToHash
+  VERSION = "0.1.0"
+end

data/lib/workflow_to_hash/workflow.rb

@@ -0,0 +1,36 @@
+module WorkflowToHash
+  class Workflow
+
+    def self.for(workflow)
+      new(workflow).send(:to_hash)
+    end
+
+    private
+    attr_reader :workflow
+    def initialize(workflow)
+      raise_unknown_workflow_error unless is_public_method?(workflow)
+      @workflow = send workflow
+    end
+
+    def to_hash
+      make_hash workflow
+    end
+
+    # Converts [:a, :b, :c] into
+    # {:a => :b, :b => :c}
+    def make_hash(array)
+      all_but_last = array[0..-2]
+      all_but_first = array[1..-1]
+      pairs = [all_but_last, all_but_first].transpose
+      Hash[pairs]
+    end
+
+    def is_public_method?(name)
+      public_methods.include?(name.to_sym)
+    end
+
+    def raise_unknown_workflow_error
+      raise UnknownWorkflowError.new 'Workflow name must match a public method'
+    end
+  end
+end

data/lib/workflow_to_hash.rb

@@ -0,0 +1,7 @@
+require "workflow_to_hash/version"
+require "workflow_to_hash/workflow"
+require "workflow_to_hash/unknown_workflow_error"
+
+module WorkflowToHash
+  # namespace
+end

data/workflow_to_hash.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'workflow_to_hash/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "workflow_to_hash"
+  spec.version       = WorkflowToHash::VERSION
+  spec.authors       = ["Rob Nichols"]
+  spec.email         = ["rob@nicholshayes.co.uk"]
+
+  spec.summary       = %q{A tool to allow a sequence of actions in a state machine to be defined as an array}
+  spec.description   = %q{Takes `[:one, :two, :three]` and convert it to `{one: :two, two: :three}`}
+  spec.homepage      = "https://github.com/reggieb/workflow_to_hash"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: workflow_to_hash
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rob Nichols
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 'Takes `[:one, :two, :three]` and convert it to `{one: :two, two: :three}`'
+email:
+- rob@nicholshayes.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/workflow_to_hash.rb
+- lib/workflow_to_hash/unknown_workflow_error.rb
+- lib/workflow_to_hash/version.rb
+- lib/workflow_to_hash/workflow.rb
+- workflow_to_hash.gemspec
+homepage: https://github.com/reggieb/workflow_to_hash
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: A tool to allow a sequence of actions in a state machine to be defined as
+  an array
+test_files: []