hifsm 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2dd540fa33580b8e82c96d82a1746aa5016ab3c6
-  data.tar.gz: ab0492f94873e14a2f75d1e3fd32ae764ed652c1
+  metadata.gz: 313a9e688988c6dac1ee778973a602db61af4ca2
+  data.tar.gz: cf7dc5e882dbf4f8dfaf34f211aa04d136474b01
 SHA512:
-  metadata.gz: 258cd2e2f5a18942a0ee40a96779246ba0b99adc4659834460ac482f96882cef9c2d5ca4f7e49301df4cb759ea12f4969a8f2aeb00554af5f092664c419b089e
-  data.tar.gz: 56cf2f726e53af3fdfa98067030448cbcd86a9306937e30d3ab75ab0c35bfc24246371df1fb1b7e202c7ccf54a443762bb1e126582d2462f36c5139438a244f7
+  metadata.gz: b585b14728b541d4d2863d71e7ac55a59699f71d33ed48ef8b9a366b8f2f2440b8426fbad9287564748e6acb0fb05308f476b66aa72cd61d70877d9691db30d9
+  data.tar.gz: 53df6c486ca83c6745fca49e9cec581348f5b6919d3efcfd76aa6316682d4d3c6dafb31342777d3530838852a9c0665cebfa3b3bdcfd3f0bc319b8e221854f1a

data/README.md

@@ -21,7 +21,7 @@ Or install it yourself as:
 
     $ gem install hifsm
 
-I prefer 1.8-style hashes, and since no advanced Ruby magic used it should work in 1.8, but only tested in 2+.
+Written in Ruby 1.8-style (hashes, lambdas), but few non-essential 1.9 niceties used, tested in 2+.
 
 __This is in early development, so be careful.__
 
@@ -196,20 +196,28 @@ Add column to your database which would hold the state, and then:
 
 ```ruby
 class Order < ActiveRecord::Base
-  hifsm do
+  hifsm :status do
     state :draft, :initial => true
     state :processing do
       state :packaging, :initial => true
       state :delivering
+
+      event :start_delivery, :from => :packaging, :to => :delivering
     end
     state :done
     state :cancelled
 
     event :start_processing, :from => :draft, :to => :processing
-    event :cancel, :to => :cancelled
+    event :cancel!, :to => :cancelled
   end
 end
-Order.new # draft
+order = Order.create          # draft
+order.start_processing.save   # 'processing.packaging'
+
+# scopes defined automatically. parent scopes looked up via like "processing.%"
+Order.processing.first.start_delivery.save
+Order.processing_packaging.first                # nil
+Order.processing_delivering.first.cancel!.save  # save is never called inisde hifsm
 
 ```
 

data/lib/hifsm/adapters/active_record_adapter.rb

@@ -12,6 +12,16 @@ module Hifsm
           include Hifsm.fsm_module(column, &block)
           before_save "hifsm_write_#{column}_attribute"
 
+          send("#{column}_machine_definition").all_states.each do |st|
+            state_name = st.to_s
+            scope_name = state_name.gsub('.', '_')
+            if st.sub_fsm
+              scope scope_name, lambda { where(arel_table[column].matches(state_name + '.%')) }
+            else
+              scope scope_name, lambda { where(column => state_name) }
+            end
+          end
+
           define_method "#{column}=" do |value|
             raise 'not (sure will be) implemented'
           end

data/lib/hifsm/fsm.rb

@@ -23,24 +23,7 @@ module Hifsm
       @machine_class.new(self, target, initial_state)
     end
 
-    def all_events
-      @states.collect {|name, st| st.events }.flatten.uniq
-    end
-
-    def initial_state!
-      @initial_state || raise(Hifsm::MissingState.new("<initial>"))
-    end
-
-    def get_state!(name)
-      top_level_state, rest = name.to_s.split('.', 2)
-      st = @states[top_level_state] || raise(Hifsm::MissingState.new(name.to_s))
-      if rest
-        st.get_substate!(rest)
-      else
-        st
-      end
-    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])
@@ -58,6 +41,32 @@ module Hifsm
       st.instance_eval(&block) if block
     end
 
+    # internals
+    def all_events
+      @states.flat_map {|name, st| st.events }.uniq
+    end
+
+    def all_states
+      @states.flat_map do |state_name, st|
+        # state should delegate to sub_fsm :)
+        [st] + (st.sub_fsm && st.sub_fsm.all_states || [])
+      end
+    end
+
+    def initial_state!
+      @initial_state || raise(Hifsm::MissingState.new("<initial>"))
+    end
+
+    def get_state!(name)
+      top_level_state, rest = name.to_s.split('.', 2)
+      st = @states[top_level_state] || raise(Hifsm::MissingState.new(name.to_s))
+      if rest
+        st.get_substate!(rest)
+      else
+        st
+      end
+    end
+
     def to_module
       @fsm_module
     end
@@ -73,7 +82,17 @@ module Hifsm
         machine_var = "@#{name}_machine"
         machine_name = "#{name}_machine"
 
-        Module.new.module_exec do
+        module_class_methods = Module.new do
+          define_method("#{machine_name}_definition") { fsm }
+        end
+
+        Module.new do
+          const_set('ClassMethods', module_class_methods)
+          def self.included(base)
+            base.class_exec do
+              extend const_get('ClassMethods')
+            end
+          end
 
           # <state>_machine returns machine instance
           define_method(machine_name) do
@@ -92,8 +111,6 @@ module Hifsm
           fsm.all_events.each do |event_name, event|
             define_method(event_name) {|*args| send(machine_name).fire(event_name, *args) }
           end
-
-          self  # return module
         end
       end
   end

data/lib/hifsm/state.rb

@@ -2,6 +2,8 @@ module Hifsm
   class State
     CALLBACKS = [:before_enter, :before_exit, :after_enter, :after_exit].freeze
 
+    attr_reader :sub_fsm
+
     def initialize(fsm, name, parent = nil)
       @fsm = fsm
       @name = name
@@ -13,11 +15,7 @@ module Hifsm
       @transitions = Hash.new {|h, key| h[key] = Array.new }
     end
 
-    def add_transition(ev)
-      name = ev.name.to_s
-      @transitions[name].push ev
-    end
-
+    # DSL
     def action(&block)
       @action = block
     end
@@ -30,10 +28,38 @@ module Hifsm
       sub_fsm!.event(*args, &block)
     end
 
+    CALLBACKS.each do |cb|
+      define_method(cb) { |&block| @callbacks[cb].add(&block) }
+    end
+
+    # internals
+    def act!(target, *args)
+      @parent.act!(target, *args) if @parent
+      @action && Callbacks.invoke(target, @action, *args)
+    end
+
+    def add_transition(ev)
+      name = ev.name.to_s
+      @transitions[name].push ev
+    end
+
+    def enter!
+      if @sub_fsm
+        @sub_fsm.initial_state!
+      else
+        self
+      end
+    end
+
     def events
       @transitions.keys + (@sub_fsm && @sub_fsm.all_events || [])
     end
 
+    def get_substate!(name)
+      raise Hifsm::MissingState.new(name.to_s) unless @sub_fsm
+      @sub_fsm.get_state!(name)
+    end
+
     def fire(target, event_name, *args, &new_state_callback)
       event_name = event_name.to_s
       @transitions[event_name].each do |ev|
@@ -57,32 +83,10 @@ module Hifsm
       raise Hifsm::MissingTransition.new(to_s, event_name)
     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
 
-    def act!(target, *args)
-      @parent.act!(target, *args) if @parent
-      @action && Callbacks.invoke(target, @action, *args)
-    end
-
-    def enter!
-      if @sub_fsm
-        @sub_fsm.initial_state!
-      else
-        self
-      end
-    end
-
-    def get_substate!(name)
-      raise Hifsm::MissingState.new(name.to_s) unless @sub_fsm
-      @sub_fsm.get_state!(name)
-    end
-
     def to_s
       if @parent
         "#{@parent.to_s}.#{@name.to_s}"
@@ -93,7 +97,7 @@ module Hifsm
 
     private
       def sub_fsm!
-        # FIXME too much coupling
+        # FIXME .name = too much coupling
         @sub_fsm ||= Hifsm::FSM.new(@fsm.name, self)
       end
   end

data/lib/hifsm/version.rb

@@ -1,3 +1,3 @@
 module Hifsm
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/test/test_activerecord_adapter.rb

@@ -69,6 +69,14 @@ class TestActiverecrodAdapter < Minitest::Test
     assert_equal 'off', SodaMachine.where(:id => @machine.id).pluck(:state).first
   end
 
+  def test_leaf_scope
+    refute_nil SodaMachine.broken.first
+  end
+
+  def test_parent_scope
+    refute_nil SodaMachine.on.first
+  end
+
   private
     def insert_record(address, state)
       insert_manager = Arel::InsertManager.new(SodaMachine)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hifsm
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Vladimir Meremyanin