spoonsix-ssm 0.1.5 → 0.1.6

data/lib/ssm.rb

@@ -1,4 +1,5 @@
 require File.join(File.dirname(__FILE__), 'state_machine')
+require File.join(File.dirname(__FILE__), 'injection_strategies', 'base')
 
 # SSM - Simple State Machine mixin 
 #
@@ -40,7 +41,7 @@ require File.join(File.dirname(__FILE__), 'state_machine')
 #--
 module SSM
   
-  VERSION = '0.1.5';
+  VERSION = '0.1.6';
 
   class InvalidTransition     < RuntimeError; end
   class UndefinedState        < RuntimeError; end
@@ -63,6 +64,7 @@ module SSM
   # the hash will see it as a new key, even though if you inspect the hash you will see two keys whose string
   # representation is the same.
   def self.included(klass) #:nodoc:
+    
     klass.extend SSM::ClassMethods
     SSM::TemplateStateMachines[klass] = SSM::StateMachine.new
     
@@ -81,18 +83,22 @@ module SSM
     end
 
     def klass.setup(instance)
+      
       SSM::TemplateStateMachines[self].validate
       
       sm = SSM::TemplateStateMachines[self].clone_and_freeze
       instance.instance_variable_set(:@ssm_state_machine, sm)
-
-      unless sm.property_name.nil?
-        # This allows others to set up the object however they see fit, including mixing in setters.
-        instance.instance_eval("def #{sm.property_name}; @#{sm.property_name}; end") unless instance.respond_to?(sm.property_name)
-        instance.instance_eval("def #{sm.property_name}=(v); @#{sm.property_name} = v; end") unless instance.respond_to?("#{sm.property_name}=".to_sym)
-         
-        instance.send(:_synchronize_state)
+      
+      begin
+        strategy_name = sm.injection_strategy.nil? ? "object" : sm.injection_strategy.to_s
+        module_name = "#{strategy_name.gsub(/\/(.?)/) { "::" + $1.upcase }.gsub(/(^|_)(.)/) { $2.upcase }}Strategy" # from ActiveSupport
+        require File.join(File.dirname(__FILE__), 'injection_strategies', "#{strategy_name}_strategy.rb")
+        instance.extend(SSM::InjectionStrategies.const_get(module_name))
+      rescue
+        raise
       end
+      
+      instance.ssm_setup
     end
         
   end
@@ -136,7 +142,7 @@ module SSM
     #   class Door
     #     include SSM
     #
-    #     ssm_property :state
+    #     ssm_inject_state_into :state
     #     ssm_initial_state :closed
     #   end
     #
@@ -146,18 +152,18 @@ module SSM
     #   class Door
     #     include SSM
     #
-    #     ssm_property :state, :use_index
+    #     ssm_inject_state_into :state, :use_index
     #     ssm_initial_state :closed
     #   end
     #
     #   Door.new.state #=> 0
     #
-    def ssm_property(name, use_index=nil)
+    def ssm_inject_state_into(name, options={}, &block)
       SSM::TemplateStateMachines[self].property_name = name
-      SSM::TemplateStateMachines[self].use_property_index = use_index.nil? ? false : true
+      SSM::TemplateStateMachines[self].use_property_index = options[:map_to_index].nil? ? false : true
+      SSM::TemplateStateMachines[self].injection_strategy = options[:strategy] #SSM::InjectionStrategies::Base.factory(options[:strategy])
     end
     
-    
     # Adds new States. This method takes a string or a symbol.
     #
     #   class Door
@@ -258,6 +264,7 @@ module SSM
   #   door = Door.new
   #   door.open
   #   door.is?(:opened) #=> true
+  #
   def is?(state_name_or_symbol)
     _synchronize_state
     @ssm_state_machine.current_state.name.to_sym == state_name_or_symbol.to_sym
@@ -284,11 +291,22 @@ module SSM
   #   door = Door.new
   #   door.open
   #   door.is?(:closed) #=> false  
+  #
   def is_not?(state_name_or_symbol)
     _synchronize_state
     @ssm_state_machine.current_state.name.to_sym != state_name_or_symbol.to_sym
   end
   
+  # Returns a symbol representing the current State
+  #
+  #    door = Door.new
+  #    door.ssm_state #=> :closed
+  #
+  def ssm_state
+    _synchronize_state
+    @ssm_state_machine.current_state.name  
+  end
+  
   private
 
   def _ssm_trigger_event(event_name_or_symbol, args)
@@ -296,21 +314,10 @@ module SSM
     event = @ssm_state_machine.get_event_by_name(event_name_or_symbol)
     
     @ssm_state_machine.transition(event.transition)
-    _update_instance_state_property unless @ssm_state_machine.property_name.nil?
+    ssm_set(@ssm_state_machine.get_state_for_property) unless @ssm_state_machine.property_name.nil?
     instance_exec *args, &event.block
   end
   
-  def _update_instance_state_property
-    unless @ssm_state_machine.current_state.nil?
-      if @ssm_state_machine.use_property_index == true
-        value = @ssm_state_machine.get_state_index_by_name(@ssm_state_machine.current_state.name)
-      else
-        value = @ssm_state_machine.current_state.name
-      end
-      self.send("#{@ssm_state_machine.property_name}=".to_sym, value)
-    end
-  end
-  
   # instance_exec for 1.8.x
   # http://groups.google.com/group/ruby-talk-google/browse_thread/thread/34bc4c9b2cac3424
   unless instance_methods.include? 'instance_exec' #:nodoc:
@@ -328,39 +335,20 @@ module SSM
     end
   end
   
-  
   def _synchronize_state
-    
-    if instance_variable_get("@#{@ssm_state_machine.property_name}".to_sym).nil?
-      state_value = @ssm_state_machine.use_property_index == true ?
-        @ssm_state_machine.get_state_index_by_name(@ssm_state_machine.current_state.name) :
-        @ssm_state_machine.current_state.name
-      send("#{@ssm_state_machine.property_name}=".to_sym, state_value)
-    else
-      _update_ssm_state unless _state_up_to_date?
-    end
+    ssm_get.nil? ? ssm_set(@ssm_state_machine.get_state_for_property) : _update_ssm_state unless _state_up_to_date?
     true
   end
   
   # Checks whether the StateMachine and the property in the instance are in sync
   def _state_up_to_date?
-    unless @ssm_state_machine.property_name.nil?
-      state_value = self.send("#{@ssm_state_machine.property_name}".to_sym)
-      if @ssm_state_machine.use_property_index == true
-        state_value == @ssm_state_machine.get_state_index_by_name(@ssm_state_machine.current_state.name)
-      else
-        state_value == @ssm_state_machine.current_state.name
-      end
-    else
-      true
-    end
+    @ssm_state_machine.property_name.nil? ? true : ssm_get == @ssm_state_machine.get_state_for_property
   end
   
   # Updates the StateMachine based on the value of the state property of the instance
   def _update_ssm_state
     unless @ssm_state_machine.property_name.nil?
-      state_value = send("#{@ssm_state_machine.property_name}".to_sym)
-      @ssm_state_machine.current_state = @ssm_state_machine.use_property_index == true ? @ssm_state_machine.get_state_by_index(state_value) : @ssm_state_machine.get_state_by_name(state_value)
+      @ssm_state_machine.current_state = @ssm_state_machine.use_property_index == true ? @ssm_state_machine.get_state_by_index(ssm_get) : @ssm_state_machine.get_state_by_name(ssm_get)
     end
   end
 end

data/lib/state_machine.rb

@@ -6,10 +6,13 @@ module SSM
 
   class StateMachine
     
-    attr_reader :initial_state
+    attr_reader   :initial_state
     attr_accessor :current_state
+    
     attr_accessor :property_name
     attr_accessor :use_property_index
+    attr_accessor :injection_strategy
+    
     attr_reader :states
     attr_reader :events
     
@@ -66,6 +69,10 @@ module SSM
       @events.find { |existing_event| existing_event.equal(event_to_compare) }
     end
     
+    def get_state_for_property
+      @use_property_index == true ? get_state_index_by_name(@current_state.name) : @current_state.name
+    end
+    
     def get_state_by_name(name)
       state = @states.find { |state| state.name == name}
       raise SSM::UndefinedState.new unless state.is_a?(SSM::State)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: spoonsix-ssm
 version: !ruby/object:Gem::Version 
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors: 
 - Luis Correa d'Almeida
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-12 00:00:00 -07:00
+date: 2009-07-13 00:00:00 -07:00
 default_executable: 
 dependencies: []