davidlee-state-fu 0.2.0 → 0.3.1

data/spec/features/transition_boolean_comparison.rb

@@ -0,0 +1,90 @@
+require File.expand_path("#{File.dirname(__FILE__)}/../helper")
+
+describe "extending bindings and transitions with Lathe#helper" do
+
+  include MySpecHelper
+
+  before(:each) do
+    reset!
+    make_pristine_class('Klass')
+    Klass.class_eval do
+      attr_accessor :ok
+    end
+
+    @machine = Klass.machine do
+      chain "a -a2b-> b -b2c-> c"
+      events.each do |e|
+        e.requires :ok
+      end
+    end
+
+    @obj = Klass.new
+    @binding       = @obj.state_fu
+    @transition    = @obj.state_fu.transition(:a2b)
+  end # before
+
+  #
+  #
+
+  describe StateFu::Transition  do
+    describe "#==" do
+
+      describe "with an unaccepted transition" do
+        before do
+          stub(@transition).accepted? { false }
+        end
+
+        it "should == true" do
+          @transition.should_not == true
+        end
+
+        it "should not == false" do
+          @transition.should == false
+        end
+
+        it "should === true" do
+          @transition.should_not === true
+        end
+
+        it "should not === false" do
+          @transition.should === false
+        end
+
+        it "should not evaluate as truthy" do
+          pending
+          x = @transition || 1
+          x.should == 1
+        end
+      end
+
+
+      describe "with an accepted transition" do
+        before do
+          stub(@transition).accepted? { true }
+        end
+        it "should == true" do
+          @transition.should == true
+        end
+
+        it "should not == false" do
+          @transition.should_not == false
+        end
+
+        it "should === true" do
+          @transition.should === true
+        end
+
+        it "should not === false" do
+          @transition.should_not === false
+        end
+
+        it "should evaluate as truthy" do
+          x = @transition || 1
+          x.should == @transition
+        end
+
+      end
+    end
+
+  end
+end

data/spec/helper.rb

@@ -6,6 +6,8 @@ $LOAD_PATH.unshift( "#{thisdir}/../lib" )
 require 'state-fu'
 require 'no_stdout'
 
+StateFu::Logger.suppress!
+
 require 'rubygems'
 
 {"rr" => "rr", "spec" => "rspec" }.each do |lib, gem_name|
@@ -30,6 +32,7 @@ module MySpecHelper
     begin
       require 'activesupport'
       require 'active_record'
+      require 'sqlite3'
     rescue LoadError => e
       pending "skipping specifications due to load error: #{e}"
       return false
@@ -62,6 +65,36 @@ module MySpecHelper
     end
   end
 
+  def skip_unless_relaxdb
+    unless Object.const_defined?( 'RelaxDB' )
+      pending('Skipping specs because you do not have the relaxdb gem (paulcarey-relaxdb) installed ...')
+    end
+  end
+
+  def prepare_relaxdb( options={} )
+    begin
+      require 'relaxdb'
+      if Object.const_defined?( "RelaxDB" )
+        RelaxDB.configure :host => "localhost", :port => 5984, :design_doc => "spec_doc"
+        RelaxDB.delete_db "relaxdb_spec" rescue "ok"
+        RelaxDB.use_db    "relaxdb_spec"
+        RelaxDB.enable_view_creation
+      end
+    rescue LoadError => e
+      # pending "skipping specifications due to load error: #{e}"
+      return false
+    end
+    begin
+      RelaxDB.replicate_db "relaxdb_spec_base", "relaxdb_spec"
+      RelaxDB.enable_view_creation
+    rescue => e
+      puts "\n===== Run rake create_base_db before the first spec run ====="
+      puts
+      exit!
+    end
+    #
+  end
+
   def make_pristine_class(class_name, superklass=Object, reset_first = false)
     reset! if reset_first
     @class_names ||= []

data/spec/integration/active_record_persistence_spec.rb

@@ -109,7 +109,6 @@ describe "an ActiveRecord model with StateFu included:" do
       end
 
       it "should fail to save if state_fu! does not instantiate the binding before create" do
-        pending "is this still relevant?"
         mock( @ex ).state_fu!.at_least( 1 ) { }
         lambda { @ex.save! }.should raise_error( ActiveRecord::StatementInvalid )
         @ex.state_fu_field.should == nil

data/spec/integration/example_01_document_spec.rb

@@ -84,7 +84,7 @@ describe "Document" do
     end
 
     it "should not raise an error when publish! is called" do
-      @doc.status.evaluate_requirement(:author).should == "Susan"
+      @doc.status.evaluate_requirement_with_args(:author).should == "Susan"
       lambda { @doc.status.publish! }.should_not raise_error( )
     end
 

data/spec/integration/relaxdb_persistence_spec.rb

@@ -0,0 +1,94 @@
+require File.expand_path("#{File.dirname(__FILE__)}/../helper")
+
+describe "a RelaxDB::Document's persister" do
+
+  include MySpecHelper
+  before(:all) do
+    prepare_relaxdb()
+  end
+
+  before(:each) do
+    skip_unless_relaxdb()
+    reset!
+    make_pristine_class( 'ExampleDoc', RelaxDB::Document )
+  end
+
+  it "should be a subclass of RelaxDB::Document" do
+    ExampleDoc.superclass.should == RelaxDB::Document
+  end
+
+  describe "when no machine is defined" do
+  end
+
+  describe "when the :field_name is a RelaxDB property" do
+    before do
+      ExampleDoc.class_eval do
+        property :property_field
+        machine :field_name => "property_field" do
+          # ...
+        end
+      end
+      @obj = ExampleDoc.new
+    end
+
+    it "should add a relaxdb persister" do
+      @obj.state_fu.persister.class.should == StateFu::Persistence::RelaxDB
+    end
+  end
+
+  describe "when the :field_name is not a RelaxDB property" do
+    before do
+      ExampleDoc.class_eval do
+        machine :field_name => "not_a_property" do
+          # ...
+        end
+      end
+      @obj = ExampleDoc.new
+    end
+    it "should add an attribute-based persister" do
+      @obj.state_fu.persister.class.should == StateFu::Persistence::Attribute
+    end
+  end
+end
+
+describe StateFu::Persistence::RelaxDB do
+  before(:all) do
+    prepare_relaxdb()
+  end
+
+  include MySpecHelper
+  describe "a RelaxDB::Document with a simple machine" do
+    before do
+      skip_unless_relaxdb()
+      reset!
+      make_pristine_class( 'ExampleDoc', RelaxDB::Document )
+      ExampleDoc.class_eval do
+        property :state_fu_field
+        machine do
+          state :hungry do
+            event :eat, :to => :satiated
+          end
+        end # machine
+      end # class_eval
+      @obj = ExampleDoc.new
+    end # before
+
+    it "should update the property on transition acceptance" do
+      @obj.state_fu.should == :hungry
+      t = @obj.eat!
+      t.should be_accepted
+      @obj.state_fu.should == :satiated
+      @obj.send(:state_fu_field).should == 'satiated'
+    end
+
+    it "should persist the current state of the machine to the database" do
+      @obj.state_fu.should == :hungry
+      @obj.eat!
+      @obj.state_fu.should == :satiated
+      @obj.save!
+      @obj2 = RelaxDB.load( @obj._id )
+      @obj2.state_fu.should == :satiated
+    end
+
+  end
+end

data/spec/integration/requirement_reflection_spec.rb

@@ -50,7 +50,7 @@ describe "Transition requirement reflection" do
   describe "transition.valid? / transition.requirements_met?" do
     it "should be true if all requirements are met (return truth)" do
       @obj.state_fu.next_states[:moon].entry_requirements.should == [:spacesuit?]
-      @obj.state_fu.evaluate_requirement(:spacesuit?).should == true
+      @obj.state_fu.evaluate_requirement_with_args(:spacesuit?).should == true
       @obj.fly_spaceship?(:moon).should == true
       @obj.fly_spaceship(:moon).requirements_met?.should == true
       @obj.fly_spaceship(:moon).should be_valid
@@ -59,7 +59,7 @@ describe "Transition requirement reflection" do
     it "should be false if not all requirements are met" do
       stub( @obj ).spacesuit?() { false }
       @obj.state_fu.next_states[:moon].entry_requirements.should == [:spacesuit?]
-      @obj.state_fu.evaluate_requirement(:spacesuit?).should == false
+      @obj.state_fu.evaluate_requirement_with_args(:spacesuit?).should == false
       @obj.fly_spaceship?(:moon).should == false
       @obj.fly_spaceship(:moon).requirements_met?.should == false
       @obj.fly_spaceship(:moon).should_not be_valid

data/spec/integration/transition_spec.rb

@@ -1004,7 +1004,11 @@ describe StateFu::Transition do
 
       describe "when the fireable? event has multiple targets but only one can be entered" do
         before do
-          @machine.lathe do
+          reset!
+          make_pristine_class("Klass")
+          @machine = Klass.machine do
+            initial_state :alive
+
             state :cremated
 
             state :buried do
@@ -1014,15 +1018,19 @@ describe StateFu::Transition do
             end
 
             event :inevitability do
+              from :alive
               to :cremated, :buried
             end
           end
           @obj     = Klass.new()
           @binding = @obj.state_fu
+          @machine.events[:inevitability].should be_kind_of(StateFu::Event)
           @machine.events[:inevitability].fireable_by?( @binding ).should == true
           @machine.states[:cremated].enterable_by?( @binding ).should == true
           @machine.states[:buried].enterable_by?( @binding ).should == false
+          @binding.valid_events.map(&:name).should == [@machine.events[:inevitability]].map(&:name)
           @binding.valid_events.should == [@machine.events[:inevitability]]
+          @binding.valid_transitions.values.flatten.map(&:name).should == [:cremated]
           @binding.valid_transitions.values.flatten.should == [@machine.states[:cremated]]
         end # before
 

data/spec/units/binding_spec.rb

@@ -3,6 +3,27 @@ require File.expand_path("#{File.dirname(__FILE__)}/../helper")
 describe StateFu::Binding do
   include MySpecHelper
 
+  describe "instance methods" do
+  end
+
+  #
+  # class methods
+  #
+
+  describe "class methods" do
+  end
+
+
+  #
+  #
+  #
+
+
+
+  #
+  #
+  #
+
   before do
     reset!
     make_pristine_class('Klass')
@@ -100,7 +121,7 @@ describe StateFu::Binding do
       end
     end
 
-    describe ".state() / initial state" do
+    describe ".state and .initial_state" do
       it "should default to machine.initial_state when no initial_state is explicitly defined" do
         @machine.initial_state.name.should == :new
         @binding.current_state.should == @machine.initial_state
@@ -120,31 +141,39 @@ describe StateFu::Binding do
     before do
     end
     describe "fireable?" do
-      describe "when called with arguments which would return a valid transition from .transition()" do
-        it "should return true"
+      before do
+        reset!
+        make_pristine_class("Klass")
+        @machine = Klass.machine do
+          state :snoo do
+            event :am_fireable, :to => :wizz
+          end
+          state :wizz do
+            event :not_fireable, :to => :pong
+          end
+        end
+        @obj = Klass.new
       end
 
-      describe "when called with arguments which would raise an InvalidTransition from .transition()" do
-        before do
-          reset!
-          make_pristine_class("Klass")
-          @machine = Klass.machine do
-            state :snoo
-            state :wizz do
-              event :ping, :to => :pong
-            end
-          end
-          @obj = Klass.new
+      describe "when called with arguments which would return a valid transition from .transition()" do
+        it "should return true" do
+          @obj.state_fu.fireable?(:am_fireable).should == true
         end
+      end
 
+      describe "when called with arguments which would raise an InvalidTransition from .transition()" do
         it "should return nil" do
           @obj.state_fu.name.should == :snoo
-          lambda { @obj.state_fu.transition(:ping) }.should raise_error( StateFu::InvalidTransition )
-          lambda { @obj.state_fu.fireable?(:ping) }.should_not raise_error( StateFu::InvalidTransition )
-          @obj.state_fu.fireable?(:ping).should == nil
+          lambda { @obj.state_fu.transition(:not_fireable) }.should raise_error( StateFu::InvalidTransition )
+          lambda { @obj.state_fu.fireable?(:not_fireable) }.should_not raise_error( StateFu::InvalidTransition )
+          @obj.state_fu.fireable?(:not_fireable).should == nil
         end
       end
 
+      describe "when called with additional arguments after the destination event/state" do
+        it "should pass the arguments to any requirements to determine transition availability"
+      end
+
     end
 
   end

data/spec/units/lathe_spec.rb

@@ -380,7 +380,7 @@ describe StateFu::Lathe do
 
     describe ".event(:name)" do
       before do
-        mock( @machine ).find_or_create_states_by_name( @lathe.sprocket ) { @lathe.sprocket }
+        mock( @machine ).find_or_create_states_by_name( @lathe.sprocket ).at_least(1) { @lathe.sprocket }
       end
 
       it "should create the named event if it does not exist" do
@@ -474,12 +474,11 @@ describe StateFu::Lathe do
 
   describe "a child lathe for an event" do
     before do
-      stub( @machine ).find_or_create_states_by_name(:a) { [:a] }
-      stub( @machine ).find_or_create_states_by_name(:b) { [:b] }
-
       @master = @lathe
       @event  = @lathe.event( :go )
       @lathe  = StateFu::Lathe.new( @machine, @event )
+      stub( @machine ).find_or_create_states_by_name(:a) { [:a] }
+      stub( @machine ).find_or_create_states_by_name(:b) { [:b] }
     end
 
     describe ".from" do
@@ -494,16 +493,16 @@ describe StateFu::Lathe do
         @event.origins.should == [:a, :b]
       end
 
-      it "should update @origins on successive invocations" do
+      it "should accumulate @origins on successive invocations" do
         mock( @machine ).find_or_create_states_by_name(:a, :b) { [:a, :b] }
         mock( @machine ).find_or_create_states_by_name(:x, :y) { [:x, :y] }
         @lathe.from( :a, :b )
         @event.origins.should == [:a, :b]
         @lathe.from( :x, :y )
-        @event.origins.should == [:x, :y]
+        @event.origins.should == [:a, :b, :x, :y]
       end
 
-      it "should set both origin and target if a hash is given" do
+      it "should set / update both origin and target if a hash is given" do
         mock( @machine ).find_or_create_states_by_name(:a) { [:a] }
         mock( @machine ).find_or_create_states_by_name(:b) { [:b] }
         mock( @machine ).find_or_create_states_by_name(:a, :b) { [:a, :b] }
@@ -511,9 +510,11 @@ describe StateFu::Lathe do
         @lathe.from( :a => :b )
         @event.origin.should == :a
         @event.target.should == :b
-        @lathe.from([:a, :b] => [:x, :y] )
+        @lathe.from( { [:a, :b] => [:x, :y] })
+        @event.origin.should == nil
+        @event.target.should == nil
         @event.origins.should == [:a, :b]
-        @event.targets.should == [:x, :y]
+        @event.targets.should == [:b, :x, :y] # accumulated total
       end
     end
 
@@ -535,7 +536,7 @@ describe StateFu::Lathe do
         @lathe.to( :a, :b )
         @event.targets.should == [:a, :b]
         @lathe.to( :x, :y )
-        @event.targets.should == [:x, :y]
+        @event.targets.should == [:a, :b, :x, :y] # accumulated targets
       end
     end
 

data/spec/units/method_factory_spec.rb

@@ -59,7 +59,12 @@ describe StateFu::MethodFactory do
           @obj.send(:state_fu_field).should == 'targ'
         end
 
-        it "should take a block and use it as per usual"
+        it "should accept a block and pass it to the method on the binding" do 
+          block = lambda { }
+          mock.instance_of( StateFu::Binding ).fire!( is_a(StateFu::Event) )
+          @obj.simple_event! &block
+          pending "don't know how to mock this"
+        end   
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: davidlee-state-fu
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors: 
 - David Lee
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-05 00:00:00 -07:00
+date: 2009-06-26 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -37,6 +37,7 @@ files:
 - lib/state_fu/active_support_lite/cattr_reader.rb
 - lib/state_fu/active_support_lite/inheritable_attributes.rb
 - lib/state_fu/active_support_lite/keys.rb
+- lib/state_fu/active_support_lite/misc.rb
 - lib/state_fu/active_support_lite/object.rb
 - lib/state_fu/active_support_lite/string.rb
 - lib/state_fu/active_support_lite/symbol.rb
@@ -57,10 +58,18 @@ files:
 - lib/state_fu/persistence/active_record.rb
 - lib/state_fu/persistence/attribute.rb
 - lib/state_fu/persistence/base.rb
+- lib/state_fu/persistence/relaxdb.rb
 - lib/state_fu/persistence/session.rb
+- lib/state_fu/plotter.rb
 - lib/state_fu/sprocket.rb
 - lib/state_fu/state.rb
 - lib/state_fu/transition.rb
+- lib/vizier.rb
+- spec/BDD/plotter_spec.rb
+- spec/features/binding_and_transition_helper_mixin_spec.rb
+- spec/features/not_requirements_spec.rb
+- spec/features/state_and_array_options_accessor_spec.rb
+- spec/features/transition_boolean_comparison.rb
 - spec/helper.rb
 - spec/integration/active_record_persistence_spec.rb
 - spec/integration/binding_extension_spec.rb
@@ -73,10 +82,10 @@ files:
 - spec/integration/instance_accessor_spec.rb
 - spec/integration/lathe_extension_spec.rb
 - spec/integration/machine_duplication_spec.rb
+- spec/integration/relaxdb_persistence_spec.rb
 - spec/integration/requirement_reflection_spec.rb
 - spec/integration/sanity_spec.rb
 - spec/integration/state_definition_spec.rb
-- spec/integration/temp_spec.rb
 - spec/integration/transition_spec.rb
 - spec/spec.opts
 - spec/units/binding_spec.rb
@@ -117,29 +126,34 @@ signing_key:
 specification_version: 3
 summary: A rich library for state-oriented programming with state machines / workflows
 test_files: 
-- spec/units/machine_spec.rb
-- spec/units/sprocket_spec.rb
-- spec/units/event_spec.rb
-- spec/units/lathe_spec.rb
-- spec/units/binding_spec.rb
-- spec/units/state_spec.rb
-- spec/units/method_factory_spec.rb
-- spec/units/exceptions_spec.rb
-- spec/units/fu_space_spec.rb
+- spec/BDD/plotter_spec.rb
+- spec/features/binding_and_transition_helper_mixin_spec.rb
+- spec/features/not_requirements_spec.rb
+- spec/features/state_and_array_options_accessor_spec.rb
+- spec/features/transition_boolean_comparison.rb
 - spec/helper.rb
-- spec/integration/example_01_document_spec.rb
-- spec/integration/transition_spec.rb
+- spec/integration/active_record_persistence_spec.rb
+- spec/integration/binding_extension_spec.rb
 - spec/integration/class_accessor_spec.rb
+- spec/integration/dynamic_requirement_spec.rb
+- spec/integration/event_definition_spec.rb
+- spec/integration/ex_machine_for_accounts_spec.rb
+- spec/integration/example_01_document_spec.rb
+- spec/integration/example_02_string_spec.rb
 - spec/integration/instance_accessor_spec.rb
-- spec/integration/requirement_reflection_spec.rb
-- spec/integration/binding_extension_spec.rb
 - spec/integration/lathe_extension_spec.rb
 - spec/integration/machine_duplication_spec.rb
-- spec/integration/state_definition_spec.rb
-- spec/integration/event_definition_spec.rb
+- spec/integration/relaxdb_persistence_spec.rb
+- spec/integration/requirement_reflection_spec.rb
 - spec/integration/sanity_spec.rb
-- spec/integration/active_record_persistence_spec.rb
-- spec/integration/example_02_string_spec.rb
-- spec/integration/dynamic_requirement_spec.rb
-- spec/integration/ex_machine_for_accounts_spec.rb
-- spec/integration/temp_spec.rb
+- spec/integration/state_definition_spec.rb
+- spec/integration/transition_spec.rb
+- spec/units/binding_spec.rb
+- spec/units/event_spec.rb
+- spec/units/exceptions_spec.rb
+- spec/units/fu_space_spec.rb
+- spec/units/lathe_spec.rb
+- spec/units/machine_spec.rb
+- spec/units/method_factory_spec.rb
+- spec/units/sprocket_spec.rb
+- spec/units/state_spec.rb

data/spec/integration/temp_spec.rb

@@ -1,17 +0,0 @@
-require File.expand_path("#{File.dirname(__FILE__)}/../helper")
-
-describe StateFu::State do
-  include MySpecHelper
-
-  it "should respond to deep_copy" do
-    reset!
-    make_pristine_class "Klass"
-    @machine = Klass.machine do
-      state :initial
-    end
-    @state = @machine.states.first
-    @state.should respond_to(:deep_copy)
-  end
-
-end
-