davidlee-state-fu 0.0.1 → 0.0.2

data/README.textile

@@ -146,28 +146,42 @@ exceptionally elegant API.
 
 h2. Getting started
 
-First up:
+You can either clone the repository in the usual fashion (eg to
+yourapp/vendor/plugins/state-fu), or use StateFu as a gem.
+
+To install as a gem:
 
 <pre>
 <code>
- sudo gem install rspec rr activesupport
- rake
- rake spec:doc    # generate specdocs
- rake doc         # generate rdoc
- rake gem         # build the gem
- rake gem:install # install it
+gem install davidlee-state-fu -s http://gems.github.com
 </code>
 </pre>
-And have a peek in the specs folder or rdoc for usage / documentation.
 
-Now you can simply:
+To require it in your ruby project:
+
+<pre>
 <code>
- require 'state-fu'
+require 'rubygems'
+require 'state-fu'
 </code>
-and
+</pre>
+
+To install the dependencies for running specs:
+
+<pre>
 <code>
- include StateFu
-</code> in any class you wish to make stateful.
+ sudo gem install rspec rr activesupport
+ rake             # run the specs
+ rake spec:doc    # generate specdocs
+ rake doc         # generate rdocs
+ rake build       # build the gem locally
+ rake install     # install it
+</code>
+</pre>
+
+Now you can simply <code>include StateFu</code> in any class you wish to make stateful.
+
+The spec folder is currently the best source of documentation.
 
 If you have questions, feature request or ideas, please join the "google group":http://groups.google.com/group/state-fu
 

data/lib/state-fu.rb

@@ -87,7 +87,6 @@ module StateFu
 end
 
 if __FILE__ == $0
-  # run rake stuff (specs / doc )
-  # load example_machine.rb
-  # drop into irb
+  # drop into irb?
 end
+

data/lib/state_fu/machine.rb

@@ -2,7 +2,6 @@ module StateFu
   class Machine
     include Helper
 
-
     # meta-constructor; expects to be called via Klass.machine()
     def self.for_class(klass, name, options={}, &block)
       options.symbolize_keys!
@@ -21,12 +20,10 @@ module StateFu
     ## Instance Methods
     ##
 
-    attr_reader :states, :events, :options, :helpers, :named_procs, :requirement_messages, :name
+    attr_reader :states, :events, :options, :helpers, :named_procs, :requirement_messages
 
     def initialize( name, options={}, &block )
-      # TODO - @name isn't actually used anywhere yet except
-      # in deep_clone - remove it?
-      @name    = name
+      # TODO - name isn't actually used anywhere yet - remove from constructor
       @states  = [].extend( StateArray  )
       @events  = [].extend( EventArray  )
       @helpers = [].extend( HelperArray )
@@ -35,10 +32,6 @@ module StateFu
       @options              = options
     end
 
-    def deep_clone()
-      m = Machine.new( name, options.dup )
-    end
-
     # merge the commands in &block with the existing machine; returns
     # a lathe for the machine.
     def apply!( &block )
@@ -151,6 +144,15 @@ module StateFu
       end
     end
 
+    def deep_copy()
+      # use Marshal as a poor man's x-ray photocopier
+      duplify = lambda { |o| Marshal.load Marshal.dump( o ) }
+      returning Machine.new( nil, duplify.call( options )) do |m|
+        @states.each { |s| m.states() << duplify.call(s) }
+        @events.each { |e| m.events() << duplify.call(e) }
+      end
+    end
+
     def inspect
       "#<#{self.class} ##{__id__} states=#{state_names.inspect} events=#{event_names.inspect} options=#{options.inspect}>"
     end

data/spec/helper.rb

@@ -1,6 +1,10 @@
 #!/usr/bin/env ruby
 thisdir = File.expand_path(File.dirname(__FILE__))
-$: << thisdir << "#{thisdir}/../lib"
+
+# ensure we require state-fu from lib, not gems
+$LOAD_PATH.unshift( "#{thisdir}/../lib" )
+require 'state-fu'
+require 'no_stdout'
 
 require 'rubygems'
 
@@ -13,8 +17,7 @@ require 'rubygems'
   end
 end
 
-require 'state-fu'
-require File.join( thisdir, '..' , 'lib', 'no_stdout' )
+# require 'state-fu'
 
 Spec::Runner.configure do |config|
   config.mock_with :rr

data/spec/integration/machine_duplication_spec.rb

@@ -20,29 +20,21 @@ describe "Copying / cloning a Machine" do
       @copy = @original.clone
     end
 
-    it "should update any event in the original when it's changed in the copy" do
+    it "should update a state or event in the original when it's changed in the copy" do
       @original.events[:goto_b].should == @copy.events[:goto_b]
       @copy.lathe do
-        event :goto_b do |e|
-          e.options[:wibble] = :updated
+        event( :goto_b, :wibble => :updated ) do
+          to :bee
+        end
+        state( :b, :picture => "Bee" ) do
         end
       end
       @copy.    events[:goto_b].options[:wibble].should == :updated
       @original.events[:goto_b].options[:wibble].should == :updated
+      @copy.    states[:b].options[:picture].should == 'Bee'
+      @original.states[:b].options[:picture].should == 'Bee'
     end
 
-    it "should update any state in the original when it's changed in the copy" do
-      @original.states[:a].should == @copy.states[:a]
-      @copy.lathe do
-        state :a do |s|
-          s.options[:wibble] = :updated
-        end
-      end
-      @copy.    states[:a].options[:wibble].should == :updated
-      @original.states[:a].options[:wibble].should == :updated
-    end
-
-    it "should update the original with any changes to options"
     it "should update the original with any changes to helpers"
     it "should update the original with any changes to named_procs"
     it "should update the original with any changes to requirement_messages"
@@ -58,34 +50,26 @@ describe "Copying / cloning a Machine" do
           event :goto_b, :to => :b
         end
       end
-      @copy = @original.deep_clone
+      @copy = @original.deep_copy()
     end
 
-    it "should NOT update any event in the original when it's changed in the copy" do
-      pending
-      @original.events[:goto_b].should == @copy.events[:goto_b]
+    it "should NOT update a state or event in the original when it's changed in the copy" do
+      @copy.states.map(&:name).should == @original.states.map(&:name)
+      @copy.events.map(&:name).should == @original.events.map(&:name)
+
       @copy.lathe do
-        event :goto_b do |e|
-          e.options[:wibble] = :updated
+        event( :goto_b, :wibble => :updated ) do
+          to :bee
+        end
+        state( :b, :picture => "Bee" ) do
         end
       end
       @copy.    events[:goto_b].options[:wibble].should == :updated
       @original.events[:goto_b].options[:wibble].should == nil
+      @copy.    states[:b].options[:picture].should == 'Bee'
+      @original.states[:b].options[:picture].should == nil
     end
 
-    it "should NOT update any state in the original when it's changed in the copy" do
-      pending
-      @original.states[:a].should == @copy.states[:a]
-      @copy.lathe do
-        state :a do |s|
-          s.options[:wibble] = :updated
-        end
-      end
-      @copy.    states[:a].options[:wibble].should == :updated
-      @original.states[:a].options[:wibble].should == nil
-    end
-
-    it "should NOT update the original with any changes to options"
     it "should NOT update the original with any changes to helpers"
     it "should NOT update the original with any changes to named_procs"
     it "should NOT update the original with any changes to requirement_messages"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: davidlee-state-fu
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - David Lee
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-04 00:00:00 -07:00
+date: 2009-05-05 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -99,24 +99,24 @@ specification_version: 2
 summary: A rich library for state-oriented programming with state machines / workflows
 test_files: 
 - spec/units/machine_spec.rb
+- spec/units/method_factory_spec.rb
+- spec/units/lathe_spec.rb
 - spec/units/sprocket_spec.rb
+- spec/units/exceptions_spec.rb
 - spec/units/event_spec.rb
-- spec/units/lathe_spec.rb
+- spec/units/fu_space_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/helper.rb
-- spec/integration/example_01_document_spec.rb
+- spec/integration/example_02_string_spec.rb
+- spec/integration/state_definition_spec.rb
+- spec/integration/active_record_persistence_spec.rb
 - spec/integration/transition_spec.rb
-- spec/integration/class_accessor_spec.rb
-- spec/integration/instance_accessor_spec.rb
-- spec/integration/requirement_reflection_spec.rb
 - spec/integration/machine_duplication_spec.rb
-- spec/integration/state_definition_spec.rb
-- spec/integration/event_definition_spec.rb
 - spec/integration/sanity_spec.rb
-- spec/integration/active_record_persistence_spec.rb
-- spec/integration/example_02_string_spec.rb
+- spec/integration/class_accessor_spec.rb
 - spec/integration/ex_machine_for_accounts_spec.rb
+- spec/integration/instance_accessor_spec.rb
+- spec/integration/event_definition_spec.rb
+- spec/integration/example_01_document_spec.rb
+- spec/integration/requirement_reflection_spec.rb
+- spec/helper.rb