lab42_state_machine 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b9a37c4012f2237fa5f1091a526fdeeede4beae5
+  data.tar.gz: df6284a690961697d3a57c592a1c2518966b44b4
+SHA512:
+  metadata.gz: d1c8f0bffc1f5a0b16104f742d99390cb159df8ba7f4a3b5377b39f8eae5c9df0b36cd9bf1778e3e4b2f4be69ee2235c5a33f2cb2e3cf568874ffdb8d36753d4
+  data.tar.gz: 2671e4029d32fb74b8a7ad887ed28fcb0d61a8068024870984d9b1c4356dcbe7523b2345c6d2c90904d7f518c9a2ce8997e65db5a9c60e2d8073fdc314c7a105

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Robert Dober
+
+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,75 @@
+# lab42_state_machine
+
+A simple State Machine
+
+## Design Principles
+
+* A minimalistic but powerful API
+
+* Protection of the SM's inner state through delegation from the API to the implementation
+
+* Run SM against Enumerables or Enumerators
+
+* Define a `subject` in the SM's contsructor and run will return ths `subject`, defaulting to nil, in case you are aiming for side effects, but you are surely not, right ;)?
+
+
+## Examples
+
+See also spec/acceptance/readme\_spec.rb
+
+
+A counter
+
+```ruby
+  require 'lab42/state_machine'
+
+  Lab42::StateMachine.new 0 do # self.subject <-- 0
+    state :init do
+      self.subject += 1
+    end
+  end.run %w{a b c} # ===> 3 (self.subject)
+```
+
+```ruby
+      SM = Lab42::StateMachine
+
+      SM.new do
+        # Before anything is run
+        setup do
+          @index = 0
+          self.subject = Hash.new{ |h, k| h[k]=[] }
+        end
+        # After each transition
+        after do
+          @index += 1
+        end
+        
+        # Before each transition
+        before do | input |
+          state input # sets state to input {true, false} in our case
+        end
+
+        # In this case input and new_state are known to be true of course
+        transition init: true, false => true do | input, old_state, new_state |
+          subject[true] << [@index]
+          subject[false].last << @index if subject[false].last
+        end
+
+        # We show a different variation for the to false transitions here
+        # much more elegant IMHO
+        transition init: false do
+          subject[false] << [0]
+        end
+        transition true => false do
+          subject[false] << [@index]
+          subject[true].last << @index
+        end
+
+        # There is no transition towards the end state (yet?).
+        teardown do | last_state |
+          subject[last_state].last << @index.succ if subject[last_state].last # Take care of empty input here
+        end
+
+      end.run [true, false, false, true, true, true, false] 
+           # ===> { true => [[0,1],[3,6]], false => [[1,3], [6,7]] }
+  ```

data/lib/lab42/state_machine/controller.rb

@@ -0,0 +1,99 @@
+module Lab42
+  class StateMachine
+    class Controller
+
+      def after &block
+        @afters << block
+      end
+
+      def before &block
+        @befores << block
+      end
+
+      def run input
+        @current_input = input
+        run_befores
+        run_states
+        run_transitions
+        run_afters
+      end
+
+      def run_afters
+        run_state_blocks @afters
+      end
+
+      def run_befores
+        run_state_blocks @befores
+      end
+
+      def run_setup_blocks blox
+        blox.each do | block |
+          @sm.instance_exec( @state, &block )
+        end
+      end
+
+      def run_state_blocks blox
+        blox.each do | block |
+          @sm.instance_exec( @current_input, @old_state, @state, &block )
+        end
+      end
+
+      def run_setups
+        run_setup_blocks @setups
+      end
+
+      def run_states
+        run_state_blocks @handlers[@state]
+      end
+
+
+      def run_teardowns
+        run_setup_blocks @teardowns
+      end
+
+      def run_transitions
+        run_state_blocks @transitions[current_transition]
+      end
+
+      def set_state! st
+        @old_state = @state
+        @state     = st
+      end
+
+      def setup &block; @setups << block end
+
+      def state *args, &block
+        raise ArgumentError, "args.size = #{args.size} instead of 0..1" if args.size > 1
+        return @state if block.nil? && args.empty?
+        return set_state! args.first unless block
+        @handlers[ args.first ] << block
+      end
+
+      def teardown &block; @teardowns << block end
+
+      def transition trs_hshes, &block
+        trs_hshes.each do | from, to |
+          @transitions[[from, to]] << block
+        end
+      end
+
+      private
+      def current_transition; [@old_state, @state] end
+
+      def mk_ary_hash; Hash.new{ |h,k| h[k] = [] } end
+
+      def initialize state_machine
+        @sm        = state_machine
+        @old_state = nil
+        @state     = :init
+
+        @setups      = []
+        @teardowns   = []
+        @afters      = []
+        @befores     = []
+        @handlers    = mk_ary_hash
+        @transitions = mk_ary_hash
+      end
+    end # class Controller
+  end # class StateMachine
+end # module Lab42

data/lib/lab42/state_machine/version.rb

@@ -0,0 +1,5 @@
+module Lab42
+  class StateMachine
+    Version = "0.1.0"
+  end # class StateMachine
+end # module Lab42

data/lib/lab42/state_machine.rb

@@ -0,0 +1,47 @@
+require 'lab42/state_machine/controller'
+require 'forwarder'
+
+module Lab42
+  class StateMachine
+    extend Forwarder
+    attr_accessor :subject
+
+    forward_all :after, :before, :setup, :state, :step, :teardown, :transition, to: :controller
+
+    def run input=[]
+      inputs = make_inputs input
+      controller.run_setups
+      inputs.each do | input |
+        controller.run input
+      end
+      controller.run_teardowns
+      subject
+    end 
+
+    private
+
+    def initialize subject=nil, &define_machine
+      self.subject = subject
+      __make_new_controller__
+
+      instance_eval( &define_machine ) if define_machine
+    end
+
+    def __make_new_controller__
+      controller = Controller.new self
+      class << self; self end.module_eval do
+        define_method( :controller ){ controller }
+      end
+    end
+
+    def make_inputs input
+      case input
+      when Enumerable, Enumerator
+        input
+      else
+        raise ArgumentError, "cannot enumerate on object #{input}"
+      end
+    end
+
+  end # class StateMachine
+end # module Lab42

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: lab42_state_machine
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Robert Dober
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: forwarder19
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+description: Filters, Transitions
+email: robert.dober@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/lab42/state_machine/version.rb
+- lib/lab42/state_machine/controller.rb
+- lib/lab42/state_machine.rb
+- LICENSE
+- README.md
+homepage: https://github.com/RobertDober/lab42_state_machine
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A Simple State Machine
+test_files: []