state-fu 0.13.0 → 0.13.1

data/Rakefile

@@ -7,12 +7,6 @@ require "rubygems"
 
 load File.join( File.dirname(__FILE__),"/lib/tasks/state_fu.rake" )
 
-module Rakefile
-  def self.windows?
-    /djgpp|(cyg|ms|bcc)win|mingw/ =~ RUBY_PLATFORM
-  end
-end
-
 load 'lib/tasks/spec_last.rake'
 load 'lib/tasks/state_fu.rake'
 
@@ -67,7 +61,7 @@ namespace :spec do
   desc "Run all specs with profiling & backtrace" 
   Spec::Rake::SpecTask.new(:prof) do |t|
     t.spec_files = FileList["spec/**/*_spec.rb"]
-    t.spec_opts = ['-c','-b','-u','-f','profile','-R','-L','mtime']
+    t.spec_opts = ['-c','-b','-f','profile','-R','-L','mtime'] 
   end
 
   desc "Print Specdoc for all specs (eaxcluding plugin specs)"

data/lib/method_factory.rb

@@ -10,7 +10,7 @@ module StateFu
     attr_reader   :binding, :machine
 
     # An instance of MethodFactory is created to define methods on a specific StateFu::Binding, and
-    # on the object it is bound to.
+    # on the object / class it is bound to.
 
     def initialize(_binding)
       @binding            = _binding
@@ -20,7 +20,7 @@ module StateFu
     end
 
     def self.method_definitions_for(machine, name)
-      returning({}) do |method_definitions|
+      returning Hash.new do |method_definitions|
         simple_events, complex_events = machine.events.partition &:simple?
 
         # simple event methods
@@ -40,7 +40,7 @@ module StateFu
           end
         end
 
-        # complex event methods
+        # "complex" event methods (for events with more than one possible target)
         # the first argument is the target state
         # any remaining arguments are passed into the transition / transition query
 
@@ -58,7 +58,7 @@ module StateFu
         #
         # as per the method above, except that it also fires the event
 
-        # object.can_event_name? [:target], *arguments
+        # object.can_<event_name>? [:target], *arguments
         #
         # tests that calling event_name or event_name! would not raise an error
         # ie, the transition is legal and is valid with the arguments supplied
@@ -82,9 +82,10 @@ module StateFu
           end
         end
 
-        # methods dedicated to a combination of event and target
-        # all arguments are passed into the transition / transition query
-
+        # methods for a "complex" event with a specific target
+        # eg progress_to_deleted!(*args)
+        # is equivalent to progress!(:deleted, *args)
+        
         (simple_events + complex_events).each do |event|
           event.targets.each do |target|
             method_definitions["#{event.name}_to_#{target.name}"]      = lambda do |*args|
@@ -100,6 +101,8 @@ module StateFu
             end
           end unless event.targets.nil?
         end
+        
+        # sugar: query methods for determining the current state
 
         machine.states.each do |state|
           method_definitions["#{state.name}?"] = lambda do
@@ -113,8 +116,10 @@ module StateFu
     # Class Methods
     #
 
-    # This should be called once per class using StateFu. It aliases and redefines
-    # method_missing for the class.
+    # This should be called once per machine bound to a class.
+    # It defines methods for the machine as standard methods, 
+    # if the machine is the default machine or the options passed to the machine include 
+    # :define_methods => true .
     #
     # Note this happens when a machine is first bound to the class,
     # not when StateFu is included.
@@ -140,6 +145,8 @@ module StateFu
       define_event_methods_on @binding.object if @binding.options[:define_methods] && @binding.options[:singleton]
     end
 
+    private 
+    
     #
     # For each event, on the given object, define three methods.
     # - The first method is the same as the event name.

data/lib/persistence/active_record.rb

@@ -8,7 +8,7 @@ module StateFu
 
         # this adds a before_save hook to ensure that the field is initialized 
         # (and the initial state set) before create.
-        klass.send :before_create, :state_fu!
+        klass.send :before_validation_on_create, :state_fu!
                 
         # it's usually a good idea to do this:
         # validates_presence_of _field_name

data/lib/transition_query.rb

@@ -15,8 +15,10 @@ module StateFu
     end
 
     # calling result() will cause the set of transitions to be calculated -
-    # the cat will then be either dead or alive; until then it's a litte from
-    # column A, a little from column B.
+    # the cat will then be either dead or alive; until then it's anyone's guess.
+    
+    # this is a cheap way of passing any call to #each, #length, etc to result().
+    # TODO: be explicit, eg using delegate, and remove method_missing.   
     def method_missing(method_name, *args, &block)
       if result.respond_to?(method_name, true)
         result.__send__(method_name, *args, &block)
@@ -33,16 +35,6 @@ module StateFu
       self
     end
     
-    # build a list of possible transition destinations ([event, target])
-    # without actually constructing any transition objects
-    # def all_destinations
-    #   binding.events.inject([]){ |arr, evt| arr += evt.targets.map{|tgt| [evt,tgt] }; arr}.uniq
-    # end
-    # 
-    # def all_destination_names
-    #   all_destinations.map {|tuple| tuple.map(&:to_sym) }
-    # end
-
     #
     # Chainable Filters
     #     

data/spec/spec.opts

@@ -2,7 +2,6 @@
 --loadby
 mtime
 --reverse
---debugger
 --require 
 spec/custom_formatter.rb
 --format 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: state-fu
 version: !ruby/object:Gem::Version 
-  version: 0.13.0
+  version: 0.13.1
 platform: ruby
 authors: 
 - David Lee
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-17 00:00:00 +11:00
+date: 2009-10-18 00:00:00 +11:00
 default_executable: 
 dependencies: []