lab42_state_machine 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9cb027906651d393d34115d3caeb20cbbc1d21fe
-  data.tar.gz: 7aaf1ebbe0a829426fb37af2ae98c0b90f20e540
+SHA256:
+  metadata.gz: 9c9d1c0162351343ecc3460ed1b6b83373d80eb76690014ab7e2c0cc93f45107
+  data.tar.gz: ba351f35f4d8672660bfb40c9b7047c2ec6fe6027703291b071f013045d42052
 SHA512:
-  metadata.gz: ba307dc46b61393a908927b31672083af04411b425cd55d3347bf68c2db987c8a6d76d0672f2e4aa7be80c8bd85c70770fec7c5910dfa39f1970d92edb201887
-  data.tar.gz: 4e5990cf6a562b00ed0aed7c1176f1906750972461c4e951cb4ea91f0dcf9739d9e55f9ea42ac00c6309c7161a2103828643abe49a4c1669d36f54dc71f64c7f
+  metadata.gz: e98313b5a11d968b6d41c8521847e446ac9f517a13554f2bd9c4a5177fd003c21f503b148e9857c54c2dd84735e5b572f351c2910f8442d934ad26674f7ba798
+  data.tar.gz: 75fc35f6072842d0fa12f86ca49c0e1f56a5b91b36d7bf34fdd2a3b6ad23424a6b214906b82d9c3560cb3d602741e9fca6c19b6e4cda87d559536cf82cef3281

data/LICENSE

@@ -1,20 +1,201 @@
-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.
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -1,213 +1,74 @@
-# lab42_state_machine
 
-A simple State Machine
+# Lab42::StateMachine
 
-## Design Principles
+[![Build Status](https://travis-ci.org/RobertDober/lab42_stat_machine.svg?branch=master)](https://travis-ci.org/RobertDober/lab42_stat_machine)
+[![Gem Version](https://badge.fury.io/rb/lab42_stat_machine.svg)](http://badge.fury.io/rb/lab42_stat_machine)
+[![Code Climate](https://codeclimate.com/github/RobertDober/lab42_stat_machine/badges/gpa.svg)](https://codeclimate.com/github/RobertDober/lab42_stat_machine)
+[![Issue Count](https://codeclimate.com/github/RobertDober/lab42_stat_machine/badges/issue_count.svg)](https://codeclimate.com/github/RobertDober/lab42_stat_machine)
+[![Test Coverage](https://codeclimate.com/github/RobertDober/lab42_stat_machine/badges/coverage.svg)](https://codeclimate.com/github/RobertDober/lab42_stat_machine)
 
-* A minimalistic but powerful API
+## Usage
 
-* Protection of the SM's inner state through delegation from the API to the implementation
+### The DSL
 
-* Run SM against Enumerables or Enumerators
+Define a State Machine by giving it a name and defining states with their transitions in a block:
 
-* 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 ;)?
+Example: A Simple Definition
 
-
-## 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
+```ruby :example 
+    Lab42::StateMachine.new "my machine" do
+      state :start do
+        trigger %r{\A[aeiou]} do |acc, _|
+           [nil, [acc.first+1, acc.last]]
+         end
+      end
     end
-  end.run %w{a b c} # ===> 3 (self.subject)
 ```
 
-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```
-
-* The initial state of the State Machine defaults to `:init`
+Be aware that a trigger block needs to accept at least one argument
 
-The next example will demonstrate more API methods
+Example: This raises an ArgumentError
 
-```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
+```ruby :example
+  machine = 
+    Lab42::StateMachine.new "my machine" do
+      state :start do
+        trigger %r{\A[aeiou]} do
+           [nil, nil]
+         end
+      end
+    end
+  expect{ machine.run(nil, ["abc"]) }.to raise_error(ArgumentError)
+```
 
-        # 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
+Also there is one state you must not defined, the `:stop` state
 
-        # 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
+Example: Defining the `:stop` state
 
-        # 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
+```ruby :example
+   expect do
+     Lab42::StateMachine.new "booom, don't stop" do
+        state :stop do
+          trigger true, :start
         end
-
-      end.run [true, false, false, true, true, true, false] 
-           # ===> { true => [[0,1],[3,6]], false => [[1,3], [6,7]] }
-  ```
-
-In particular we are allowed to use instance variables (and their sexier accessor implementations) to transport
-state between the states of the State Machine. This is without danger as the API hides all behind the controller
-and does not contain *any* instance variable (not even `@controller`).
-
-Of course it might be worthwile to consider closing over some local variables like in the following example if appropriate.
-
-```ruby
-   # Sometime is is preferble to use the State Machine with a state implementing object
-   result = SomeObject.new
-   StateMachine.new do
-     before do | input |
-       state = some_function_of input
-     end
-     transition a: :b do | input |
-       result.update from: :a, to: :b, with: :input
      end
-     teardown do | last_input, old_state |
-       result.update from: old_state, to: result.end, with: last_input
-     end
-   end.run ...
+   end.to raise_error(FrozenError)
+    
 ```
 
-## API
-
-### Setup Methods and Handler Definitions
-
-The following methods can be used inside the constructor block without explicit revceiver, or just invoked on a `StateMachine` instance.
-
-#### after
-
-`after do | input, old_state, new_state |`  will be run after each input record has been processed. As all handlers they will be executed
-in order of definition.
-
-#### before
-
-`before do | input, old_state, new_state |`  will be run before each input record has been processed. As all handlers they will be executed
-in order of definition.
-
-
-#### setup
-
-`setup do |input|` The StateMachine peeks into the lazy enumerator and provides the first value (or nil for empty) as parameter. These handlers are the first to be run before any other and *before* the first input record will be
-fetched. Yet they give access to the Runtime API, notably they allow to set the initial state to something else as `:init` by means of the one parameter form to the state call
-     ```state :new_initial_state```
 
-#### state
 
-This is the (overloaded - for the sake of a slim API) workerbee of the State Machine, it comes in three forms:
 
-##### state querying form (0 params)
 
-Really part of the *Runtime API*
-
-`state` currrent_state of the StateMachine
-
-##### state setter form (1 param)
-
-Really part of the *Runtime API*
-
-`state new_state` You'll never guess what this one does.
-
-##### state handler definition form (1 param and block)
-
-`state some_state do |input, old_state, current_state| ...` These blocks will be called for each input record processed in some\_state
-
-#### teardown
-
-`teardown do | last_input, last_state |` Will be called at the very end of the processing cycle.
-
-#### transition
-
-`transition a: :b, b: :c do |input, old_state, new_state|` These are execute when the state changes from :a to :b, or :b to :a. Of course only one transition can be indicated (and mostly will be). These handlers are executed *after* the state handlers fot the new states, that is :b or :c in our case.
-
-### Runtime API
-
-#### halt\_machine
-
-```halt_machine``` stops the execution and makes run return the current `subject`
-
-Raises a `StopIteration` and does therefore not make any sense in `setup` or `teardown` handlers
-
-
-#### state
-
-As already mentioned in the Definition and Setup API
-
-This is the (overloaded - for the sake of a slim API) workerbee of the State Machine, it comes in three forms:
-
-##### state querying form (0 params)
-
-
-`state` Query currrent_state of the StateMachine
-
-##### 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**)
+## Author
 
-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)
+Copyright © 2020 Robert Dober
+mailto: robert.dober@gmail.com
 
-#### drop\_until( &condition)
+# LICENSE
 
-Works like ```drop_while{ |ele| !condition.( ele ) }```
+Same as Elixir -- &#X1F609; --, which is Apache License v2.0. Please refer to [LICENSE](LICENSE) for details.
 
-#### drop\_while( &condition )
+SPDX-License-Identifier: Apache-2.0
 
-Forwarded to the internal stream which is replaced by this result.

data/lib/lab42/state_machine.rb

@@ -1,53 +1,72 @@
-require 'lab42/state_machine/controller'
-require 'forwarder'
-
+require_relative 'state_machine/state.rb'
+require_relative 'state_machine/dsl.rb'
 module Lab42
   class StateMachine
-    extend Forwarder
-    attr_accessor :subject
 
-    forward_all :after, :before, :setup, :skip, :state, :teardown, :transition, to: :controller
+    attr_accessor :current, :input, :output
+    attr_reader :designation, :options, :states
+
+
+    def add(state, trigger, action, new_state=nil)
+      s = states[state]
+      s.add(trigger, action, new_state)
+    end
 
-    def behavior name, &behave
-      class << self; self end. module_eval do
-        define_method name do behave end
+    def run(accumulator=nil, input=nil)
+      if input
+        @input = input
+        @input = input.enum_for(:each) unless Enumerator === input
       end
+      loop do
+        accumulator = _transition(accumulator)
+      end
+      accumulator
     end
 
-    def clone new_subject=nil, &redefinition
-      old_controller = controller
-      copy = self.class.new( new_subject || subject.clone ){
-        controller.send :inherit_from!, old_controller
+
+    private
+
+    def initialize(name=nil, copy_on_nil: false, &blk)
+      @options = {
+        copy_on_nil: copy_on_nil,
       }
-      copy.instance_eval( &redefinition ) if redefinition
-      copy
+      @designation = name
+      _init_vars
+      _define_machine blk
     end
 
-    def halt_machine
-      raise StopIteration, "#{self} halted"
+    def _init_stop_state
+      add(:stop, true, ->(_){ raise StopIteration })
+      @states[:stop].freeze
     end
 
-    def run input=[]
-      controller.run input
-      subject
-    end 
-
-    private
+    def _init_vars
+      @output      = []
+      @current     = :start
+      @states      = Hash.new{ |h, k| h[k] = State.new(k) }
+      _init_stop_state
+    end
 
-    def initialize subject=nil, &define_machine
-      self.subject = subject
-      __make_new_controller__
+    def _current_state
+      states[current]
+    end
 
-      instance_eval( &define_machine ) if define_machine
+    def _define_machine blk
+      return unless blk
+      DSL.new(self, &blk)
     end
 
-    def __make_new_controller__
-      controller = Controller.new self
-      class << self; self end.module_eval do
-        define_method( :controller ){ controller }
+    def _transition(accumulator)
+      next_line = input.next
+      output, accumulator, next_state = _current_state.transition(accumulator, next_line)
+      @current = next_state
+      if output
+        @output << output
+      elsif options[:copy_on_nil]
+        @output << next_line
       end
+      accumulator
     end
 
-
-  end # class StateMachine
-end # module Lab42
+  end
+end

data/lib/lab42/state_machine/dsl.rb

@@ -0,0 +1,27 @@
+module Lab42
+  class StateMachine
+    class DSL
+      IllegalMonitorState = Class.new RuntimeError
+
+      attr_reader :current_state, :machine
+
+      def state designation, &blk
+        @current_state = designation
+        instance_eval(&blk)
+      end
+
+      def trigger trigger_exp, new_state = nil, &blk
+        raise IllegalMonitorState unless current_state
+        machine.add(current_state, trigger_exp, blk, new_state)
+      end
+
+
+      private
+
+      def initialize machine, &blk 
+        @machine = machine
+        instance_eval(&blk)
+      end
+    end
+  end
+end

data/lib/lab42/state_machine/state.rb

@@ -0,0 +1,66 @@
+require "lab42/match"
+module Lab42
+  class StateMachine
+    class State
+      attr_reader :designation, :triggers
+
+      def add(trigger, action, new_state)
+        trigger = Lab42::Match.new(trigger) if Regexp === trigger
+        new_state ||= designation
+        @triggers << [trigger, action, new_state]
+      end
+
+      def transition(accumulator, input)
+        triggers.each do |trigger, action, new_state|
+          match = _match input, trigger
+          next unless match
+          output, new_acc, new_state1 = _apply(match, accumulator, input: input, to: action)
+          output = output.string if Lab42::Match === output
+          return [output, new_acc || accumulator, new_state1 || new_state || designation]
+        end
+        [input, accumulator, designation]
+      end
+
+      def _match(input, trigger)
+        case trigger
+        when Lab42::Match
+          m =trigger.match(input)
+          m.success? && m
+        when TrueClass
+          true
+        when FalseClass
+          raise StopIteration
+        when Symbol
+          input.send trigger
+        end
+      end
+
+      def freeze
+        super
+        @triggers.freeze
+      end
+
+      private
+
+      def _apply(match, accumulator, input:, to:)
+        if to
+          case to.arity
+          when 1
+            to.(match)
+          when 2
+            to.(accumulator, match)
+          else
+            raise ArgumentError, "#{to} needs to accept one or two parameters , as it is a State's action"
+          end
+        else
+          input
+        end
+      end
+
+      def initialize(designation)
+        @designation = designation
+        @triggers    = []
+      end
+    end
+  end
+end

data/lib/lab42/state_machine/version.rb

@@ -1,5 +1,5 @@
 module Lab42
   class StateMachine
-    Version = "0.2.1"
-  end # class StateMachine
-end # module Lab42
+    VERSION = "0.3.0"
+  end
+end

metadata

@@ -1,72 +1,157 @@
 --- !ruby/object:Gem::Specification
 name: lab42_state_machine
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Robert Dober
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-13 00:00:00.000000000 Z
+date: 2020-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: forwarder19
+  name: forwarder2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '0.2'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: lab42_match
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.12
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.12
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: speculate_about
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: '0.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.13.0
-description: Filters, Transitions
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: travis-lint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Define triggers and transitios, what else? Well... Filter
 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/controller/stream_api.rb
-- lib/lab42/state_machine.rb
 - LICENSE
 - README.md
+- lib/lab42/state_machine.rb
+- lib/lab42/state_machine/dsl.rb
+- lib/lab42/state_machine/state.rb
+- lib/lab42/state_machine/version.rb
 homepage: https://github.com/RobertDober/lab42_state_machine
 licenses:
-- MIT
+- Apache
+- '2'
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -74,18 +159,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.1.0
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: A Simple State Machine
+summary: Define triggers and transitios, what else?
 test_files: []

data/lib/lab42/state_machine/controller.rb

@@ -1,167 +0,0 @@
-require 'lab42/state_machine/controller/stream_api'
-module Lab42
-  class StateMachine
-    class Controller
-
-      include StreamApi
-
-      attr_reader :stream
-
-      SkipState = Class.new RuntimeError
-
-      def after blk=nil, &block
-        @afters << mk_block(blk, block)
-      end
-
-      def before blk=nil, &block
-        @befores << mk_block(blk, block)
-      end
-
-      def run input
-        mk_input_stream input
-        run_setups
-        loop do
-          run_one
-        end
-        run_teardowns 
-      end
-
-      def run_afters
-        run_state_blocks @afters
-      end
-
-      def run_befores
-        run_state_blocks @befores
-      end
-
-      def run_one
-        @current_input = stream.peek
-        @stream = stream.drop 1
-
-        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
-        @setups.each do | block |
-          @sm.instance_exec( peek_first, &block )
-        end
-      rescue SkipState
-      end
-
-      def run_states
-        run_state_blocks @handlers[@state]
-      end
-
-      def run_teardowns
-        @teardowns.each do | teardown |
-          @sm.instance_exec( @current_input, @state, &teardown )
-        end
-      rescue SkipState
-      end
-
-      def run_transitions
-        run_state_blocks @transitions[current_transition]
-      end
-
-      def set_state! st
-        @old_state = @state
-        @state     = st
-      end
-
-      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
-        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 blk=nil, &block
-        @teardowns << mk_block(blk, 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 inherit_from! old_controller
-        raise ArgumentError, "not a controller #{old_controller}" unless self.class === old_controller
-
-        %w{setups teardowns afters befores handlers transitions}.each do | handlers |
-          instance_variable_set( "@#{handlers}", 
-                                old_controller.instance_variable_get( "@#{handlers}" ).clone )
-        end
-      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
-
-      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
-          b
-        when Symbol
-          @sm.method b
-        else
-          raise ArgumentError, "Cannot create a proc or method from #{b}"
-        end
-      end
-
-      def mk_input_stream input
-        case input
-        when Enumerable, Enumerator
-          @original_stream = @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

@@ -1,70 +0,0 @@
-require 'forwarder'
-module Lab42
-  class StateMachine
-    class Controller
-      module StreamApi
-
-        extend Forwarder
-        forward_all :count, :take,:take_while, 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 has_next?
-          stream.peek
-          true
-        rescue StopIteration
-          false
-        end
-        def last?; !has_next? end
-
-        def peek *args
-          stream.peek
-        rescue StopIteration
-          args.first
-        end
-
-        def reject &filter
-          @stream = @stream.reject( &filter )
-        end
-
-        def rewind
-          @stream = @original_stream
-        end
-
-        def rewind!
-          rewind
-          @sm.skip
-        end
-
-        def select &filter
-          @stream = @stream.select( &filter )
-        end
-
-        def take_until &condition
-          take_while( &condition.negated )
-        end
-
-      end # module StreamApi
-    end # class Controller
-  end # class StateMachine
-end # module Lab42