hifsm 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4d654a06d28adc762a19f31cacf281568503e4de
-  data.tar.gz: 2d8e83ee31acc329efcce082d33d43d65574e71c
+  metadata.gz: 58e7c452cb3f0ebfce493c75f0130b191807daae
+  data.tar.gz: 973378be201d7957f7fc22231d0d86e34896825a
 SHA512:
-  metadata.gz: 5ea67c4a15aaee373a2b672184781e975ba67b2ef2681ce461a66c9c062d7bce9509d5bc01e1d8ce82848391d0a63c1df21e9530bc177251d6fb798f2a5560f5
-  data.tar.gz: 7eb5c56002cc5a98c74a55255e465fa280e91b9ba038b3d99355c23884f960040938b97931d65ea0406c63f84e73afe0e978ed37d490b2f6e3d485a7369bc92a
+  metadata.gz: 2093aab1fc0253c749fd3b352560ad517a64f4b6a6d14a437197b61e77b7aa8364cf38a269b6455ed2b7eb4c5bb130442ca938fd21a2bfcc86e6d98ae359b30a
+  data.tar.gz: 4730e63e2f71fa653e7c487953da10b0415c00a26a2a005578f92d24178882d9e09b271ac8f1f9715e848ee5078f44ae4428ff99420b84cdf700a92ccf1e0ee9

data/.travis.yml

@@ -1,6 +1,6 @@
 language: ruby
 rvm:
-  - 2.0.0
+  - rbx
   - 2.1.0
 gemfile:
   - Gemfile

data/README.md

@@ -192,7 +192,7 @@ On event:
 
 If any of `before...` callbacks returns `false` then no further processing is done, no exceptions raised, machine state is not changed.
 
-On `act!` state's actions called from top state to nested. If [several FSMs defined]](https://github.com/stiff/hifsm/blob/master/test/test_two_machines.rb), object's `act!` invokes them all in order as they were defined and returns value from last action.
+On `act!` state's actions called from top state to nested. If [several FSMs defined](https://github.com/stiff/hifsm/blob/master/test/test_two_machines.rb), object's `act!` invokes them all in order as they were defined and returns value from last action.
 
 ## ActiveRecord integration
 

data/hifsm.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = '>= 1.9'
+
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest"

data/lib/hifsm/callbacks.rb

@@ -1,8 +1,13 @@
 class Callbacks
 
-  class <<self
-    def invoke(target, cb, *args)
+  def initialize(listeners = [])
+    @listeners = listeners
+  end
+
+  def trigger(target, *args)
+    @listeners.map do |cb|
       if cb.nil?
+        # raise something maybe? :)
       elsif cb.is_a? Symbol
         if target.method(cb).arity.zero?
           target.send(cb)
@@ -14,18 +19,4 @@ class Callbacks
       end
     end
   end
-
-  def initialize
-    @listeners = []
-  end
-
-  def add(symbol = nil, &callback)
-    @listeners.push symbol || callback
-  end
-
-  def trigger(target, *args)
-    @listeners.map do |callback|
-      Callbacks.invoke target, callback, *args
-    end
-  end
 end

data/lib/hifsm/dsl/abstract_builder.rb

@@ -0,0 +1,36 @@
+module Hifsm
+  module DSL
+    class AbstractBuilder
+
+      def self.define_dsl_callback(cb)
+        define_method(cb) do |symbol = nil, &block|
+          @defs.each do |ev_def|
+            ev_def[cb].push symbol || block
+          end
+        end
+      end
+
+      def initialize
+        @defs = []
+      end
+
+      def each(&block)
+        @defs.each(&block)
+      end
+
+      protected
+        def defs
+          @defs
+        end
+
+        def slice_callbacks(options, names)
+          Hash[names.map {|n| [n, array_wrap(options[n])]}]
+        end
+
+        # like in ActiveSupport
+        def array_wrap(anything)
+          anything.is_a?(Array) ? anything : [anything].compact
+        end
+    end
+  end
+end

data/lib/hifsm/dsl/event_builder.rb

@@ -0,0 +1,31 @@
+module Hifsm
+  module DSL
+    # Normalizes event definitions to form
+    # {:from => [], :to => ..., :guard => ..., before, after}
+    class EventBuilder < AbstractBuilder
+
+      def initialize(options, &block)
+        super()
+        build_def(options) if options[:to]
+        instance_eval(&block) if block
+      end
+
+      Hifsm::Event::CALLBACKS.each do |cb|
+        define_dsl_callback(cb)
+      end
+
+      # from :state, :to => :state
+      def from(state, options)
+        build_def(options.dup.merge(:from => state))
+      end
+
+      private
+        def build_def(options)
+          defs << slice_callbacks(options, Hifsm::Event::CALLBACKS).merge(
+            :from => array_wrap(options[:from]),
+            :to => options[:to]
+          )
+        end
+    end
+  end
+end

data/lib/hifsm/dsl/state_builder.rb

@@ -0,0 +1,34 @@
+module Hifsm
+  module DSL
+    # Normalizes state definitions
+    class StateBuilder < AbstractBuilder
+
+      def initialize(options = {}, &block)
+        super()
+        build_def(options)
+        instance_eval(&block) if block
+      end
+
+      Hifsm::State::CALLBACKS.each do |cb|
+        define_dsl_callback(cb)
+      end
+
+      def state(*args, &block)
+        defs.first[:sub_states].push [args, block]
+      end
+
+      def event(*args, &block)
+        defs.first[:sub_events].push [args, block]
+      end
+
+      private
+        def build_def(options)
+          defs << slice_callbacks(options, Hifsm::State::CALLBACKS).merge(
+            :initial => options[:initial],
+            :sub_states => [],
+            :sub_events => []
+          )
+        end
+    end
+  end
+end

data/lib/hifsm/event.rb

@@ -4,20 +4,15 @@ module Hifsm
 
     attr_reader :name, :to
 
-    def initialize(name, to, guards)
+    def initialize(name, to, callbacks_options)
       @name = name
       @to = to
-      @callbacks = Hash.new {|h, key| h[key] = Callbacks.new }
-
-      guards.each do |g|
-        @callbacks[:guard].add g
+      @callbacks = {}
+      CALLBACKS.each do |cb|
+        @callbacks[cb] = Callbacks.new(callbacks_options[cb])
       end
     end
 
-    CALLBACKS.each do |cb|
-      define_method(cb) { |&block| @callbacks[cb].add(&block) }
-    end
-
     def trigger(target, cb, *args)
       @callbacks[cb].trigger(target, *args)
     end

data/lib/hifsm/fsm.rb

@@ -12,33 +12,42 @@ module Hifsm
 
       instance_eval(&block) if block
 
-      @fsm_module = fsm_module = initialize_module
-      @machine_class = Class.new(Hifsm::Machine) do
-        include fsm_module
-        define_method("#{name}_machine") { self }
-      end
+      @fsm_module = nil
+      @machine_class = nil
     end
 
     def instantiate(target = nil, initial_state = nil)
+      fsm_module = get_fsm_module
+      machine_name = "#{name}_machine"
+      @machine_class ||= Class.new(Hifsm::Machine) do
+        include fsm_module
+        define_method(machine_name) { self }
+      end
       @machine_class.new(self, target, initial_state)
     end
 
     #DSL
-    def event(name, options, &block)
-      ev = Hifsm::Event.new(name, get_state!(options[:to]), array_wrap(options[:guard]))
-      from_states = array_wrap(options[:from])
-      from_states = @states.keys if from_states.empty?
-      from_states.each do |from|
-        st = get_state!(from)
-        st.add_transition(ev)
+    def event(name, options = {}, &block)
+      Hifsm::DSL::EventBuilder.new(options, &block).each do |ev_def|
+        ev = Hifsm::Event.new name,
+                              get_state!(ev_def[:to]),
+                              ev_def
+
+        from_states = ev_def[:from]
+        from_states = @states.keys if from_states.empty?
+        from_states.each do |from|
+          st = get_state!(from)
+          st.add_transition(ev)
+        end
+
       end
-      ev.instance_eval(&block) if block
     end
 
     def state(name, options = {}, &block)
-      st = @states[name.to_s] = Hifsm::State.new(self, name, @parent)
-      @initial_state = st if options[:initial]
-      st.instance_eval(&block) if block
+      Hifsm::DSL::StateBuilder.new(options, &block).each do |st_def|
+        st = @states[name.to_s] = Hifsm::State.new(name, @parent, st_def)
+        @initial_state = st if options[:initial]
+      end
     end
 
     # internals
@@ -68,41 +77,38 @@ module Hifsm
     end
 
     def to_module
-      @fsm_module
+      get_fsm_module
     end
 
     private
-      # like in ActiveSupport
-      def array_wrap(anything)
-        anything.is_a?(Array) ? anything : [anything].compact
-      end
-
-      def initialize_module
-        fsm = self  # capture self
-        machine_var = "@#{name}_machine"
-        machine_name = "#{name}_machine"
-
-        Module.new do
-          define_singleton_method :included do |base|
-            base.send(:define_singleton_method, "#{machine_name}_definition") { fsm }
-          end
+      def get_fsm_module
+        @fsm_module ||= begin
+          fsm = self  # capture self
+          machine_var = "@#{name}_machine"
+          machine_name = "#{name}_machine"
+
+          Module.new do
+            define_singleton_method :included do |base|
+              base.send(:define_singleton_method, "#{machine_name}_definition") { fsm }
+            end
 
-          # <state>_machine returns machine instance
-          define_method(machine_name) do
-            if instance_variable_defined?(machine_var)
-              instance_variable_get(machine_var)
-            else
-              machine = fsm.instantiate(self)
-              instance_variable_set(machine_var, machine)
+            # <state>_machine returns machine instance
+            define_method(machine_name) do
+              if instance_variable_defined?(machine_var)
+                instance_variable_get(machine_var)
+              else
+                machine = fsm.instantiate(self)
+                instance_variable_set(machine_var, machine)
+              end
             end
-          end
 
-          # <state> returns string representation of the current state
-          define_method(fsm.name) { send(machine_name).to_s }
+            # <state> returns string representation of the current state
+            define_method(fsm.name) { send(machine_name).to_s }
 
-          # <event> fires event
-          fsm.all_events.each do |event_name, event|
-            define_method(event_name) {|*args| send(machine_name).fire(event_name, *args) }
+            # <event> fires event
+            fsm.all_events.each do |event_name, event|
+              define_method(event_name) {|*args| send(machine_name).fire(event_name, *args) }
+            end
           end
         end
       end

data/lib/hifsm/state.rb

@@ -1,41 +1,30 @@
 module Hifsm
   class State
-    CALLBACKS = [:before_enter, :before_exit, :after_enter, :after_exit].freeze
+    CALLBACKS = [:before_enter, :before_exit, :after_enter, :after_exit, :action].freeze
 
     attr_reader :sub_fsm
 
-    def initialize(fsm, name, parent = nil)
-      @fsm = fsm
+    def initialize(name, parent = nil, options)
       @name = name
       @parent = parent
-      @action = nil
-      @sub_fsm = nil
-
-      @callbacks = Hash.new {|h, key| h[key] = Callbacks.new }
+      @callbacks = {}
+      CALLBACKS.each do |cb|
+        @callbacks[cb] = Callbacks.new(options[cb])
+      end
       @transitions = Hash.new {|h, key| h[key] = Array.new }
-    end
-
-    # DSL
-    def action(&block)
-      @action = block
-    end
-
-    def state(*args, &block)
-      sub_fsm!.state(*args, &block)
-    end
 
-    def event(*args, &block)
-      sub_fsm!.event(*args, &block)
-    end
-
-    CALLBACKS.each do |cb|
-      define_method(cb) { |&block| @callbacks[cb].add(&block) }
+      if options[:sub_states].empty?
+        @sub_fsm = nil
+      else
+        @sub_fsm = Hifsm::FSM.new(nil, self)
+        options[:sub_states].each {|args, block| @sub_fsm.state(*args, &block) }
+        options[:sub_events].each {|args, block| @sub_fsm.event(*args, &block) }
+      end
     end
 
-    # internals
     def act!(target, *args)
       @parent.act!(target, *args) if @parent
-      @action && Callbacks.invoke(target, @action, *args)
+      trigger(target, :action, *args).last
     end
 
     def add_transition(ev)
@@ -94,11 +83,5 @@ module Hifsm
         @name.to_s
       end
     end
-
-    private
-      def sub_fsm!
-        # FIXME .name = too much coupling
-        @sub_fsm ||= Hifsm::FSM.new(@fsm.name, self)
-      end
   end
 end

data/lib/hifsm/version.rb

@@ -1,3 +1,3 @@
 module Hifsm
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

data/lib/hifsm.rb

@@ -3,6 +3,9 @@ require "hifsm/fsm"
 require "hifsm/event"
 require "hifsm/machine"
 require "hifsm/state"
+require "hifsm/dsl/abstract_builder"
+require "hifsm/dsl/event_builder"
+require "hifsm/dsl/state_builder"
 require "hifsm/version"
 
 module Hifsm

data/test/test_groupped_transitions.rb

@@ -0,0 +1,58 @@
+require 'setup_tests'
+
+class TestGrouppedTransitions < Minitest::Test
+  class Button
+    include Hifsm
+
+    hifsm do
+      state :active, :initial => true
+      state :alternative
+      state :disabled
+
+      # each :to generates new event
+      event :click, :to => :disabled, :guard => :disable_on_click
+      event :click, :from => :disabled, :to => :disabled
+      event :click do
+        from :active, :to => :alternative
+        from :alternative, :to => :active
+
+        after do
+          log << "alternated"
+        end
+      end
+    end
+
+    attr_accessor :disable_on_click, :log
+
+    def initialize
+      self.log = []
+    end
+  end
+
+  def setup
+    @button = Button.new
+  end
+
+  def test_click_from_active
+    @button.click
+    assert_equal 'alternative', @button.state
+    assert_equal ['alternated'], @button.log
+  end
+
+  def test_click_with_disable_on_click
+    @button.disable_on_click = true
+    @button.click
+    assert_equal 'disabled', @button.state
+    assert_equal [], @button.log
+  end
+
+  def test_click_from_disabled
+    @button.disable_on_click = true
+    @button.click
+    @button.disable_on_click = false
+    @button.click
+    assert_equal 'disabled', @button.state
+    assert_equal [], @button.log
+  end
+
+end

data/test/test_two_machines.rb

@@ -13,9 +13,11 @@ class TestTwoMachines < Minitest::Test
         end
       end
 
-      event :cycle_color!, :from => :red, :to => :green
-      event :cycle_color!, :from => :green, :to => :blue
-      event :cycle_color!, :from => :blue, :to => :red
+      event :cycle_color! do
+        from :red, :to => :green
+        from :green, :to => :blue
+        from :blue, :to => :red
+      end
     end
 
     hifsm :working_state do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hifsm
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Vladimir Meremyanin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-04 00:00:00.000000000 Z
+date: 2014-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -111,6 +111,9 @@ files:
 - lib/hifsm.rb
 - lib/hifsm/adapters/active_record_adapter.rb
 - lib/hifsm/callbacks.rb
+- lib/hifsm/dsl/abstract_builder.rb
+- lib/hifsm/dsl/event_builder.rb
+- lib/hifsm/dsl/state_builder.rb
 - lib/hifsm/event.rb
 - lib/hifsm/fsm.rb
 - lib/hifsm/machine.rb
@@ -124,6 +127,7 @@ files:
 - test/test_basic_fsm.rb
 - test/test_dynamic_initial_state.rb
 - test/test_event_guard.rb
+- test/test_groupped_transitions.rb
 - test/test_hierarchical.rb
 - test/test_ifless_factorial.rb
 - test/test_many_states.rb
@@ -141,7 +145,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -162,6 +166,7 @@ test_files:
 - test/test_basic_fsm.rb
 - test/test_dynamic_initial_state.rb
 - test/test_event_guard.rb
+- test/test_groupped_transitions.rb
 - test/test_hierarchical.rb
 - test/test_ifless_factorial.rb
 - test/test_many_states.rb