lab42_state_machine 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7794b97f4ada35102cd112f803d049df99e0fcdb
-  data.tar.gz: 5f3f4276da47d24c629f57c9f4e957c9b84e0e21
+  metadata.gz: 1a04c2bcbca5f354f981c2f929f862ca3dde8d20
+  data.tar.gz: 28f8f7ab95247ebbe85b8f0738e7971642e42d20
 SHA512:
-  metadata.gz: 1c5c90bb25e28f7585981f0557ead12e9a2231dc51c47e326d29a7170620b17537b36dfd4bec0fd3ab499b85d13bc222a5d940c91ccd9bc4c36627e8e2aa095f
-  data.tar.gz: 256aef995922fbba3c09d5380f3152fd3d343e7c7418d8566ce94a8c0bbf12edfcdabf6030ae501daee63314f68af7074a84d4da2856a58c7aa6a946ffaa6986
+  metadata.gz: 4c2391b75893b6779206664fc468b8ce289fcb42b59b27f1613a30e9a5a02819d6d433111b3299d0a4c82e8ab198cef718915488d5394838fd1673c06d50b240
+  data.tar.gz: ad0f241232884a58993dccf3997b9629cea8d7ae25e85b45a4cabb70c478144a21d4213e643d8b35a675cb68c34c3a05af10f2c191c5520761fa1e2ab04def4c

data/README.md

@@ -35,7 +35,7 @@ This simple example demonstrates the following essential rules:
 * An easy way to setup the State Machine is by providing a block to its constructor. This block
 is instance evalled and thus has access to the whole API (see below). But of course the public API
 methods can be accessed in a more detached style too:
-    `state\_machine.state :reset do @counter = 0 end`
+    ```state_machine.state :reset do @counter = 0 end```
 
 * The initial state of the State Machine defaults to `:init`
 
@@ -181,3 +181,33 @@ This is the (overloaded - for the sake of a slim API) workerbee of the State Mac
 ##### state setter form (1 param)
 
 ```state new_state``` Set new state of the StateMachine
+
+### Advanced Stream API
+
+This part of the API is exposed by `controller` and allows the StateMachine to implement some stream operations like `rewind` or `drop_while`.
+
+Unless indicated otherwise the invocation of a method in this API does not interrupt the normal flow of the StateMachine but the bang version
+also implies a `skip`. Thusly in general
+
+```ruby
+    controller.<advanced_stream_api_method>!
+```
+
+is the same as
+
+```ruby
+    controller.<advanced_stream_api_method>
+    skip
+```
+
+Also unless indicated otherwise the result of the invocation replaces the internal stream of the controller (having effect on input from the **next step only**)
+
+In order to better understand this API we recommand to have a look at the [corresponding specs]( https://github.com/RobertDober/lab42_state_machine/blob/master/spec/units/stream_api_spec.rb)
+
+#### drop\_until( &condition)
+
+Works like ```drop_while{ |ele| !condition.( ele ) }```
+
+#### drop\_while( &condition )
+
+Forwarded to the internal stream which is replaced by this result.

data/lib/lab42/state_machine.rb

@@ -6,7 +6,7 @@ module Lab42
     extend Forwarder
     attr_accessor :subject
 
-    forward_all :after, :before, :setup, :state, :teardown, :transition, to: :controller
+    forward_all :after, :before, :setup, :skip, :state, :teardown, :transition, to: :controller
 
     def behavior name, &behave
       class << self; self end. module_eval do
@@ -19,15 +19,7 @@ module Lab42
     end
 
     def run input=[]
-      inputs = __make_inputs__ input
-      input  = nil
-      
-      controller.run_setups( (inputs.peek rescue nil) )
-      loop do
-        input = inputs.next
-        controller.run input
-      end
-      controller.run_teardowns input
+      controller.run input
       subject
     end 
 
@@ -47,14 +39,6 @@ module Lab42
       end
     end
 
-    def __make_inputs__ input
-      case input
-      when Enumerable, Enumerator
-        input.lazy
-      else
-        raise ArgumentError, "cannot enumerate on object #{input}"
-      end
-    end
 
   end # class StateMachine
 end # module Lab42

data/lib/lab42/state_machine/controller.rb

@@ -1,23 +1,29 @@
+require 'lab42/state_machine/controller/stream_api'
 module Lab42
   class StateMachine
     class Controller
 
-      def after  block=nil, &blk
-        behavior = get_behavior block, blk
-        @afters << behavior
+      include StreamApi
+
+      attr_reader :stream
+
+      SkipState = Class.new RuntimeError
+
+      def after blk=nil, &block
+        @afters << mk_block(blk, block)
       end
 
-      def before  block=nil, &blk
-        behavior = get_behavior block, blk
-        @befores << behavior
+      def before blk=nil, &block
+        @befores << mk_block(blk, block)
       end
 
       def run input
-        @current_input = input
-        run_befores
-        run_states
-        run_transitions
-        run_afters
+        mk_input_stream input
+        run_setups
+        loop do
+          run_one
+        end
+        run_teardowns 
       end
 
       def run_afters
@@ -28,27 +34,43 @@ module Lab42
         run_state_blocks @befores
       end
 
+      def run_one
+        @current_input = stream.next
+        run_befores
+        run_states
+        run_transitions
+        run_afters
+      rescue SkipState
+      end
+
+      def run_setup_blocks blox
+        blox.each do | block |
+          @sm.instance_exec( __peek__, &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 input
+      def run_setups
         @setups.each do | block |
-          @sm.instance_exec( input, &block )
+          @sm.instance_exec( peek_first, &block )
         end
+      rescue SkipState
       end
 
       def run_states
         run_state_blocks @handlers[@state]
       end
 
-
-      def run_teardowns input
+      def run_teardowns
         @teardowns.each do | teardown |
-          @sm.instance_exec( input, @state, &teardown )
+          @sm.instance_exec( @current_input, @state, &teardown )
         end
+      rescue SkipState
       end
 
       def run_transitions
@@ -60,9 +82,12 @@ module Lab42
         @state     = st
       end
 
-      def setup  block=nil, &blk
-        behavior = get_behavior block, blk
-        @setups << behavior
+      def setup blk=nil, &block
+        @setups << mk_block(blk, block)
+      end
+
+      def skip
+        raise SkipState, "skipping actions in this setup/state/teardown"
       end
 
       def state *args, &block
@@ -72,7 +97,9 @@ module Lab42
         @handlers[ args.first ] << block
       end
 
-      def teardown &block; @teardowns << block end
+      def teardown blk=nil, &block
+        @teardowns << mk_block(blk, block)
+      end
 
       def transition trs_hshes, &block
         trs_hshes.each do | from, to |
@@ -83,37 +110,47 @@ module Lab42
       private
       def current_transition; [@old_state, @state] end
 
-      def get_behavior block1, block2
-        raise ArgumentError, "need exactly one block ( or symbol )" unless !!block1 != !!block2
-        mk_block block1 || block2
-      end
-
       def initialize state_machine
         @sm        = state_machine
         @old_state = nil
         @state     = :init
 
-        @setups       = []
-        @teardowns    = []
-        @afters       = []
-        @befores      = []
-        @before_first = []
-        @handlers     = mk_ary_hash
-        @transitions  = mk_ary_hash
+        @setups      = []
+        @teardowns   = []
+        @afters      = []
+        @befores     = []
+        @handlers    = mk_ary_hash
+        @transitions = mk_ary_hash
       end
 
-      def mk_block blocky
-        case blocky
+      def mk_ary_hash; Hash.new{ |h,k| h[k] = [] } end
+
+      def mk_block block, blk
+        raise ArgumentError, "Need a block or a proc param" unless !!block != !!blk
+        case b = block || blk
         when Proc, Method
-          blocky
-        when Symbol, String
-          @sm.method blocky
+          b
+        when Symbol
+          @sm.method b
         else
-          blocky.to_proc
+          raise ArgumentError, "Cannot create a proc or method from #{b}"
         end
       end
 
-      def mk_ary_hash; Hash.new{ |h,k| h[k] = [] } end
+      def mk_input_stream input
+        case input
+        when Enumerable, Enumerator
+          @stream = input.lazy
+        else
+          raise ArgumentError, "cannot enumerate on object #{input}"
+        end
+      end
+
+      def peek_first
+        @__peek_first__ ||= stream.peek
+      rescue StopIteration
+        nil
+      end
     end # class Controller
   end # class StateMachine
 end # module Lab42

data/lib/lab42/state_machine/controller/stream_api.rb

@@ -0,0 +1,39 @@
+require 'forwarder'
+module Lab42
+  class StateMachine
+    class Controller
+      module StreamApi
+
+        extend Forwarder
+        forward :rewind, to: :stream
+
+        class ::Proc
+          def negated
+            ->(*args, &blk){ !self.(*args, &blk) }
+          end
+        end
+
+        def drop_until &condition
+          @stream = stream.drop_while( &condition.negated )
+        end
+        def drop_until! &condition
+          drop_until( &condition )
+          @sm.skip
+        end
+
+        def drop_while &condition
+          @stream = stream.drop_while( &condition )
+        end
+        def drop_while! &condition
+          drop_while( &condition )
+          @sm.skip
+        end
+
+        def rewind!
+          rewind
+          @sm.skip
+        end
+      end # module StreamApi
+    end # class Controller
+  end # class StateMachine
+end # module Lab42

data/lib/lab42/state_machine/version.rb

@@ -1,5 +1,5 @@
 module Lab42
   class StateMachine
-    Version = "0.1.2"
+    Version = "0.2.0"
   end # class StateMachine
 end # module Lab42

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lab42_state_machine
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Robert Dober
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-10 00:00:00.000000000 Z
+date: 2013-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: forwarder19
@@ -60,6 +60,7 @@ extra_rdoc_files: []
 files:
 - lib/lab42/state_machine/version.rb
 - lib/lab42/state_machine/controller.rb
+- lib/lab42/state_machine/controller/stream_api.rb
 - lib/lab42/state_machine.rb
 - LICENSE
 - README.md