state-fu 0.12.3 → 0.13.0

data/spec/features/shared_log_spec.rb

@@ -2,6 +2,6 @@ require File.expand_path("#{File.dirname(__FILE__)}/../helper")
 
 describe "using StateFu w/ shared logs" do
   it "should be sane" do
-    StateFu::Logger.shared?.should == false
+    StateFu::Logging.shared?.should == false
   end
 end

data/spec/integration/active_record_persistence_spec.rb

@@ -4,7 +4,7 @@ describe "an ActiveRecord model with StateFu included:" do
 
   include MySpecHelper
 
-  before(:each) do
+  before(:all) do
     reset!
     prepare_active_record() do
       def self.up
@@ -48,7 +48,8 @@ describe "an ActiveRecord model with StateFu included:" do
     before do
       ExampleRecord.class_eval do
         state_fu_machine do
-                              state :initial do
+          state :initial do
+            # an after transition hook saves the record
             event( :change, :to => :final ) { after :save! }
           end
         end
@@ -84,9 +85,9 @@ describe "an ActiveRecord model with StateFu included:" do
       it "should return false for ExampleRecord, :not_a_column" do
         StateFu::Persistence.active_record_column?( ExampleRecord, :not_a_column ).should == false
       end
+
       it "should not clobber activerecord accessors" do
         @ex.noodle! rescue nil
-        #        lambda { @ex.description }.should_not raise_error()
         @ex.description.should be_nil
         @ex.description= 'foo'
         @ex.description.should == 'foo'
@@ -122,12 +123,6 @@ describe "an ActiveRecord model with StateFu included:" do
         @ex.save!
       end
 
-      it "should fail to save if state_fu! does not instantiate the binding before create" do
-        mock( @ex ).state_fu!.at_least( 1 ) { }
-        lambda { @ex.save! }.should raise_error( ActiveRecord::StatementInvalid )
-        @ex.state_fu_field.should == nil
-      end
-
       it "should create a record given only a name, with the field set to the initial state" do
         ex = ExampleRecord.new( :name => "exemplar" )
         ex.should be_valid
@@ -166,7 +161,7 @@ describe "an ActiveRecord model with StateFu included:" do
         end
       end # saved record after transition
 
-      describe "when a second machine named :status is defined with :field_name => 'status' " do
+      describe "when a second machine named :status is defined with :field_name => 'status'" do
         before do
           ExampleRecord.state_fu_machine(:status, :field_name => 'status') do
             event( :go, :from => :initial, :to => :final )
@@ -196,7 +191,20 @@ describe "an ActiveRecord model with StateFu included:" do
           @ex.status= 'damp'
           lambda { @ex.status }.should raise_error( StateFu::InvalidStateName )
         end
+      end # second machine
+      
+      describe "coexisting with an attribute-backed machine" do
+        it "should get along merrily" do
+          ExampleRecord.machine(:temporary, :field_name => 'temp') do
+            state :new
+          end
+          @ex = ExampleRecord.new()
+          @ex.temporary.should == :new
+          @ex.instance_variable_get("@temp").should == 'new'
+          @ex.temporary.persister.class.should == StateFu::Persistence::Attribute
+        end
       end
-    end # second machine
-  end   # with before_create filter
-end     # default machine
+      
+    end 
+  end   
+end     

data/spec/integration/example_01_document_spec.rb

@@ -106,12 +106,13 @@ describe "Document" do
       #   lambda { @doc.status_field }.should raise_error()
       # end
 
-      it "should be defined before state_fu is called" do
-        @doc.send( :status_field ).should == 'draft'
+      it "should be nil before state_fu is called" do
+        @doc.send(:status_field).should == nil
       end
 
-      it "should have an initial value of 'draft'" do
-        @doc.instance_eval { status_field }.should == "draft"
+      it "should have an initial value of 'draft' once the binding is referenced" do
+        @doc.status # initialize the machine
+        @doc.send(:status_field).should == 'draft'
       end
 
       it "should be set to 'published' after publish! is called successfully" do

data/spec/integration/requirement_reflection_spec.rb

@@ -172,9 +172,10 @@ describe "Transition requirement reflection" do
         stub( @obj ).spacesuit?() { false }
         stub( @obj ).fuel?() { false }
       end
+
       describe "when the arity of the proc is 1" do
         before do
-          @msg = lambda { |trans| "I am a #{trans.class} and I fail it" }
+          @msg = lambda { |transition| "No #{transition.target.name} for you!" }
           @machine.requirement_messages[:spacesuit?] = @msg
         end
 
@@ -186,14 +187,14 @@ describe "Transition requirement reflection" do
           messages.length.should == 2
           messages.strings.length.should == 1
           messages.strings.first.should be_kind_of( String )
-          messages.strings.first.should == "I am a StateFu::Transition and I fail it"
+          messages.strings.first.should == "No moon for you!"
           messages.symbols.first.should == :fuel?
         end
       end # arity 1
 
       describe "when the arity of the proc is 0" do
         before do
-          @msg = lambda { "No #{t.target.name} for you!" }
+          @msg = lambda { "No soup for you!" }
           @machine.requirement_messages[:spacesuit?] = @msg
         end
 
@@ -205,7 +206,7 @@ describe "Transition requirement reflection" do
           messages.length.should == 2
           messages.strings.length.should == 1
           messages.strings.first.should be_kind_of( String )
-          messages.strings.first.should == "No moon for you!"
+          messages.strings.first.should == "No soup for you!"
           messages.symbols.first.should == :fuel?
         end
       end # arity 1

data/spec/integration/transition_spec.rb

@@ -660,8 +660,8 @@ describe StateFu::Transition do
         before do
           Klass.state_fu_machine do
             event( :go ) do
-              execute do 
-                halt!("stop")
+              execute do |transition|
+                transition.halt!("stop")
               end
             end
           end

data/spec/spec_helper.rb

@@ -12,8 +12,8 @@ require 'spec'
 # record the log output on each run
 LOGFILE = File.join('log', 'spec.log') unless Object.const_defined?('LOGFILE')
 FileUtils.rm LOGFILE if File.exists?(LOGFILE)
-StateFu::Logger.level  = Logger::INFO
-StateFu::Logger.logger = Logger.new(LOGFILE)
+StateFu::Logging.level  = Logger::INFO
+StateFu::Logging.logger = Logger.new(LOGFILE)
 
 module MySpecHelper
   include NoStdout

data/spec/state_fu_spec.rb

@@ -79,41 +79,35 @@ describe "A door which opens and shuts:" do
 
     describe "magic event methods" do
 
-      it "doesn't normally have a method #shut!" do
-        @door.respond_to?(:shut!).should == false
-      end
-
-      it "will define #shut! when method_missing is called for the first time" do
-        begin
-          @door.play_the_ukelele
-        rescue NoMethodError
-        end
-        @door.respond_to?(:shut!).should == true
-      end
-
-      it "will keep any existing methods when method_missing is triggered" do
-        @door.respond_to?(:shut).should == true
-        @door.respond_to?(:can_shut?).should == false
-        @door.shut.should == "I don't know how to shut!"
-        @door.can_shut?.should               == true      # triggers method_missing
-        @door.respond_to?(:shut).should      == true
-        @door.respond_to?(:can_shut?).should == true      # new methods defined
-        @door.shut.should == "I don't know how to shut!"  # old method retained
-      end
-
-      it "gets a set of new methods when any magic method is called" do
-        @door.respond_to?(:shut).should      == true  # already defined
-        @door.respond_to?(:open).should      == false
-        @door.respond_to?(:can_shut?).should == false
-        @door.respond_to?(:can_open?).should == false
-        @door.respond_to?(:shut!).should     == false
-        @door.respond_to?(:open!).should     == false
-        @door.can_shut?.should               == true  # call one of them (triggers method_missing)
-        @door.respond_to?(:open).should      == false # a private method: Kernel#open
-        @door.respond_to?(:can_shut?).should == true  # but these are all newly defined public methods
-        @door.respond_to?(:can_open?).should == true
-        @door.respond_to?(:shut!).should     == true
-        @door.respond_to?(:open!).should     == true
+      # it "doesn't normally have a method #shut!" do
+      #   @door.respond_to?(:shut!).should == false
+      # end
+      # 
+      # it "will define #shut! when method_missing is called for the first time" do
+      #   begin
+      #     @door.play_the_ukelele
+      #   rescue NoMethodError
+      #   end
+      #   @door.respond_to?(:shut!).should == true
+      # end
+
+      # it "will keep any existing methods when method_missing is triggered" do
+      #   @door.respond_to?(:shut).should == true
+      #   @door.respond_to?(:can_shut?).should == false
+      #   @door.shut.should == "I don't know how to shut!"
+      #   @door.can_shut?.should               == true      # triggers method_missing
+      #   @door.respond_to?(:shut).should      == true
+      #   @door.respond_to?(:can_shut?).should == true      # new methods defined
+      #   @door.shut.should == "I don't know how to shut!"  # old method retained
+      # end
+      
+      it "TODO RENAME THIS SPEC" do
+        @door.respond_to?(:open).should       == false # a private method: Kernel#open
+        @door.respond_to?(:open, true).should == true
+        @door.respond_to?(:can_shut?).should  == true  # but these are all newly defined public methods
+        @door.respond_to?(:can_open?).should  == true
+        @door.respond_to?(:shut!).should      == true
+        @door.respond_to?(:open!).should      == true
       end
 
       it "retains any previously defined method_missing" do
@@ -160,9 +154,6 @@ describe "A door which opens and shuts:" do
 
     describe "magic state methods" do
       it "should be defined for each state by method_missing voodoo" do
-        @door.should_not respond_to(:closed?)
-        @door.should_not respond_to(:open?)
-        @door.open?.should == true
         @door.should respond_to(:closed?)
         @door.should respond_to(:open?)
       end
@@ -181,7 +172,6 @@ describe "A door which opens and shuts:" do
 
     it "#can_shut? when the current state is open" do
       @door.current_state.should == :open
-      # @door.state_fu.valid_transitions.map(&:destination).inspect
       @door.can_shut?.should     == true
       @door.can_open?.should     == nil # not a valid transition from this state -> nil
     end
@@ -208,7 +198,7 @@ describe "A door which opens and shuts:" do
     it "raises StateFu::RequirementError if #open! is called when it is locked" do
       @door.shut!
       @door.locked = true
-      lambda { @door.open! }.should raise_error(StateFu::RequirementError)
+      lambda { @door.open! }.should raise_error( StateFu::RequirementError )
     end
 
     it "tells you why it won't open if you ask nicely" do
@@ -551,15 +541,14 @@ describe "arguments given to different method signatures" do
       def b2(t,a=nil)   received[:b2] = [t,a] end
       def c2(t,*a)      received[:c2] = [t,a] end
 
-      # these method signatures get a transition, a list of arguments,
-      # and the object which owns the machine
+      # these method signatures take too many arguments and will cause an ArgumentError
       def a3(t,a,o)     received[:a3] = [t,a,o] end
       def b3(t,a,o=nil) received[:b3] = [t,a,o] end
       def c3(t,a,*o)    received[:c3] = [t,a,o] end
 
       machine do
         cycle :state => :observing, :on => :observe do
-          trigger :a1, :b1, :c1, :a2, :b2, :c2, :a3, :b3, :c3
+          trigger :a1, :b1, :c1, :a2, :b2, :c2
         end
       end
 
@@ -572,7 +561,7 @@ describe "arguments given to different method signatures" do
     end
 
     it "have a list of execute hooks" do
-      Recorder.machine.events[:observe].hooks[:execute].should == [:a1, :b1, :c1, :a2, :b2, :c2, :a3, :b3, :c3]
+      Recorder.machine.events[:observe].hooks[:execute].should == [:a1, :b1, :c1, :a2, :b2, :c2]
     end
   end
 
@@ -595,7 +584,7 @@ describe "arguments given to different method signatures" do
       end
 
       it "call the event's :execute hooks on #observe!" do
-        @results.keys.should =~ [:a1, :b1, :c1, :a2, :b2, :c2, :a3, :b3, :c3]
+        @results.keys.should =~ [:a1, :b1, :c1, :a2, :b2, :c2]
       end
 
       describe "methods which expect one argument" do
@@ -615,10 +604,13 @@ describe "arguments given to different method signatures" do
       end
 
       describe "methods which expect three arguments" do
-        it "receive a StateFu::Transition, an argument list and the recorder object" do
-          @results[:a3].should == [@t, @t.args, @recorder]
-          @results[:b3].should == [@t, @t.args, @recorder]
-          @results[:c3].should == [@t, @t.args, [@recorder]]
+        it "raise an ArgumentError" do
+          [:a1, :b1, :c1, :a2, :b2, :c2].each do |meth|
+            @t.call(meth)
+          end
+          [:a3, :b3, :c3].each do |meth|
+            lambda { @t.call(:a3) }.should raise_error(ArgumentError)
+          end
         end
       end
     end
@@ -734,7 +726,8 @@ describe "sitting at a poker machine" do
 
           event :stop_spinning, :to => :ready do
             requires :wheels_stopped?
-            execute :payout do
+            execute :payout do |transition|
+              wheel_states = transition.call(:wheel_states)
               if wheel_states == wheel_states.uniq
                 self.credits += wheel_states.first[:value]
               end
@@ -756,7 +749,7 @@ describe "sitting at a poker machine" do
               execute do
                 silly_noises_inflicted << :spinning_noise
               end
-              after do
+              after do |transition, *args|
                 if rand(3) == 0
                   # we use binding.stop! rather than self.stop! here
                   # to disambiguate which machine we're sending the event to.
@@ -769,7 +762,7 @@ describe "sitting at a poker machine" do
                   # (the first one, becuase it was defined first, and automatically
                   # defined methods never clobber any pre-existing methods) -
                   # which isn't what we want here.
-                  binding.stop!([:bomb, :cherry, :smiley, :gold].rand)
+                  transition.binding.stop!([:bomb, :cherry, :smiley, :gold].rand)
                 end
               end
             end

data/spec/units/binding_spec.rb

@@ -27,7 +27,7 @@ describe StateFu::Binding do
 
   describe "constructor" do
     before do
-      mock(Klass).state_fu_options.at_most(2) do
+      mock(Klass).state_fu_options.at_most(3) do
         { 
           :example => {:field_name => :example_field} 
         }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: state-fu
 version: !ruby/object:Gem::Version 
-  version: 0.12.3
+  version: 0.13.0
 platform: ruby
 authors: 
 - David Lee
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-08 00:00:00 +11:00
+date: 2009-10-17 00:00:00 +11:00
 default_executable: 
 dependencies: []
 
@@ -62,8 +62,7 @@ files:
 - lib/support/core_ext.rb
 - lib/support/exceptions.rb
 - lib/support/has_options.rb
-- lib/support/logger.rb
-- lib/support/methodical.rb
+- lib/support/logging.rb
 - lib/support/no_stdout.rb
 - lib/support/plotter.rb
 - lib/support/vizier.rb
@@ -72,9 +71,9 @@ files:
 - lib/transition.rb
 - lib/transition_query.rb
 - spec/custom_formatter.rb
+- spec/features/active_record_auto_save_spec.rb
 - spec/features/binding_and_transition_helper_mixin_spec.rb
 - spec/features/machine_alias_spec.rb
-- spec/features/method_missing_only_once_spec.rb
 - spec/features/not_requirements_spec.rb
 - spec/features/plotter_spec.rb
 - spec/features/shared_log_spec.rb
@@ -139,9 +138,9 @@ specification_version: 3
 summary: A rich library for state-oriented programming with state machines / workflows
 test_files: 
 - spec/custom_formatter.rb
+- spec/features/active_record_auto_save_spec.rb
 - spec/features/binding_and_transition_helper_mixin_spec.rb
 - spec/features/machine_alias_spec.rb
-- spec/features/method_missing_only_once_spec.rb
 - spec/features/not_requirements_spec.rb
 - spec/features/plotter_spec.rb
 - spec/features/shared_log_spec.rb

data/lib/support/methodical.rb

@@ -1,17 +0,0 @@
-module StateFu
-  module Methodical
-
-    def self.__define_method( method_name, &block )
-      self.class.class_eval do
-        define_method method_name, &block
-      end
-    end
-
-    def __define_singleton_method( method_name, &block )
-      (class << object; self; end).class_eval do
-        define_method method_name, &block
-      end
-    end
-
-  end
-end

data/spec/features/method_missing_only_once_spec.rb

@@ -1,28 +0,0 @@
-require File.expand_path("#{File.dirname(__FILE__)}/../helper")
-
-describe "method_missing" do
-  include MySpecHelper
-  before do
-    make_pristine_class('Klass')
-    Klass.state_fu_machine() {}
-    @obj = Klass.new
-  end
-
-  it "should revert to the original method_missing after it is called once" do
-    mock.proxy( @obj ).state_fu!.times(1)
-    mm1 = @obj.method(:method_missing)
-    call_snafu = lambda do
-      begin
-        @obj.snafu!
-      rescue NoMethodError
-      end
-    end
-    call_snafu.call()
-    mm2 = @obj.method(:method_missing)
-    mm1.should_not == mm2
-    call_snafu.call()
-    mm3 = @obj.method(:method_missing)
-    mm3.should == mm2
-    # @obj.snafu
-  end
-end