stateful 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 43a52ed260948a8b25ab8e179b6cc1a4279243b8
-  data.tar.gz: 0099bcace08e9525183ff80bb81b4f8b3b32d6ee
+  metadata.gz: d44fb4b6fd8eb3e91311d9bd585755672d044a25
+  data.tar.gz: 3a06ef8db37c2e377d6e965114da621fb11436fd
 SHA512:
-  metadata.gz: 01255d072732c11031920c57d6fbadc3c9242329ae4cb7ab4d07239e0a7cb2cebefa34cb7eedd7d4c73ed109764a14f64eb98300acbc34447a818383dce33009
-  data.tar.gz: ac27cc34184bbc0cd40676fd2cf1c198b61630080f2d6bd472bd2b30cdf7cdbee4dfe651df688e033d96cbf1085c3dd8326ef85107ab154bcc1ac936d3fea273
+  metadata.gz: f9a1883570f2801945dad7004658acf175e098014226306d961a003a729f6ee8f0e8c78715bcf460377439b9b8947e05aeb06fe6793a834d879aecee021a4a28
+  data.tar.gz: cd0d56bff87db358ec8d8ebf866d840d88a7ed47188773e1bddad22f97b14308307df9f2cba316c49281cd8e2aa891520cece2e1a10be0203acfbf9c2968e4b4

data/lib/stateful.rb

@@ -65,34 +65,81 @@ module Stateful
         #  options[:event] = calling_method if state_events.include? calling_method
         #end
 
-        callbacks = ["#{name}_change".to_sym]
-        callbacks << options[:event] if options[:event]
-        run_callbacks *callbacks do
-          __send__("#{name}=", new_state)
-          block.call if block
-
-          ## if a specific persist method value was provided
-          if options.has_key?(:persist_method)
-            # call the method if one was provided
-            __send__(options[:persist_method]) if options[:persist_method]
-          # if no persist method option was provided than use the defaults
-          else
-            method = persist_methods.find {|m| respond_to?(m)}
-            __send__(method) if method
+        run_callbacks "#{name}_change".to_sym, new_state do
+
+          run_callbacks (options[:event] || "#{name}_non_event_change") do
+            __send__("#{name}=", new_state)
+            block.call if block
+
+            ## if a specific persist method value was provided
+            if options.has_key?(:persist_method)
+              # call the method if one was provided
+              __send__(options[:persist_method]) if options[:persist_method]
+            # if no persist method option was provided than use the defaults
+            else
+              method = persist_methods.find {|m| respond_to?(m)}
+              if method
+                __send__(method)
+              else
+                true
+              end
+            end
           end
         end
-        true
       end
 
       protected "change_#{name}"
       protected "change_#{name}!"
       private :_change_state
 
+      ## state events support:
+
+      # provide a reader so that the current event being fired can be accessed
+      attr_reader "#{name}_event".to_sym
+
+      define_singleton_method "#{name}_event" do |event, &block|
+        define_method(event) do
+          instance_variable_set("@#{name}_change_method", "change_#{name}")
+          instance_variable_set("@#{name}_event", event)
+          begin
+            result = instance_eval &block
+          ensure
+            instance_variable_set("@#{name}_change_method", nil)
+            instance_variable_set("@#{name}_event", nil)
+          end
+          result
+        end
+
+        define_method("#{event}!") do
+          instance_variable_set("@#{name}_change_method", "change_#{name}!")
+          instance_variable_set("@#{name}_event", event)
+          begin
+            result = instance_eval &block
+          ensure
+            instance_variable_set("@#{name}_change_method", nil)
+            instance_variable_set("@#{name}_event", nil)
+          end
+          result
+        end
+      end
+
+      # define the transition_to_state method that works in conjunction with the state_event
+      define_method "transition_to_#{name}" do |new_state, &block|
+        event = __send__("#{name}_event")
+        raise "transition_to_#{name} can only be called while a #{name} event is being called" unless event
+
+        method = instance_variable_get("@#{name}_change_method")
+        __send__(method, new_state, event, &block)
+      end
+
+      protected "transition_to_#{name}"
+
       define_method "can_transition_to_#{name}?" do |new_state|
         __send__("#{name}_info").can_transition_to?(new_state)
       end
 
-      # init and configure state info
+      ## init and configure state info:
+
       init_state_info(name, options[:states])
       __send__("#{name}_infos").values.each do |info|
         info.expand_to_transitions
@@ -106,7 +153,7 @@ module Stateful
       define_state_attribute(options)
 
       # define the event callbacks
-      events = (["#{name}_change".to_sym] + options[:events])
+      events = (["#{name}_change".to_sym, "#{name}_non_event_change".to_sym] + options[:events])
       define_callbacks *events
 
       # define callback helpers

data/lib/stateful/version.rb

@@ -1,3 +1,3 @@
 module Stateful
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/spec/stateful_spec.rb

@@ -4,11 +4,13 @@ require './lib/stateful'
 class Kata
   include Stateful
 
-  attr_accessor :approved_by, :ready_score, :published_at, :state_changes
+  attr_accessor :approved_by, :ready_score, :published_at, :state_changes, :times_pending, :published_by
 
   def initialize
     @ready_score = 0
     @state_changes = 0
+    @times_pending = 0
+    @published_by
   end
 
   stateful  default: :draft,
@@ -36,6 +38,8 @@ class Kata
     doc.state_changes += 1
   end
 
+
+
   def vote(ready)
     @ready_score += ready ? 1 : -1
 
@@ -49,24 +53,29 @@ class Kata
     end
   end
 
-  def publish
-    change_state(enough_votes_for_approval? ? :needs_approval : :needs_feedback) do
+  state_event :publish do |published_by|
+    transition_to_state(enough_votes_for_approval? ? :needs_approval : :needs_feedback) do
       @published_at = Time.now
+      @published_by = published_by
     end
   end
 
+  after_publish do
+    @times_pending += 1
+  end
+
   def unpublish
-    change_state(:draft)
+    change_state(:draft, :unpublish)
   end
 
   def approve(approved_by)
-    change_state(:approved) do
+    change_state(:approved, :approve) do
       @approved_by = approved_by
     end
   end
 
   def retire
-    change_state(:retire)
+    change_state(:retired, :retire)
   end
 
   def enough_votes_for_approval?
@@ -147,10 +156,17 @@ describe Kata do
 
     it 'should support calling passed blocks when state is valid' do
       kata.published_at.should be_nil
-      kata.publish
+      kata.publish!
       kata.published_at.should_not be_nil
     end
 
+    pending 'should support passing in parameters to state_event defined methods' do
+      kata.published_by.should be_nil
+      kata.publish('test')
+      kata.published_by.should == 'test'
+      kata.published?.should be_true
+    end
+
     it 'should support ingoring passed blocked when state is not valid' do
       kata.approve('test')
       kata.approved?.should be_false
@@ -160,6 +176,7 @@ describe Kata do
     it 'should support after callbacks methods' do
       kata.publish
       kata.state_changes.should == 1
+      kata.times_pending.should == 1
     end
 
     it 'should support can_transition_to_state?' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stateful
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - jake hoffner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-20 00:00:00.000000000 Z
+date: 2013-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport