enumerated_state 0.0.3 → 0.0.4

data/README.rdoc

@@ -15,31 +15,33 @@ Use
 	
 == Description
 
-This gem falls under the family of gems ASPIUM, ie (Another State Pattern Implementation Using Mixology).  However,
-this one adds much needed state pattern support for enumerated attributes (see http://github.com/jeffp/enumerated_attribute)
-and supports multiple states per objection since each attribute manages a state.
+This gem belongs to the ASPIUM family of gems -- (Another State Pattern Implementation
+Using Mixology).  This ASPIUM adds state pattern support to enumerated attributes (see enumerated_attribute[http://github.com/jeffp/enumerated_attribute])
+and allows multiple state variables per object, one for each enumerated attribute.
 
 == Basic implementation
 
-So if you are using enumerated_attribute for an object tractor, you can replace the following code
+If you are using enumerated_attribute, you may have code looking something like
 
-  case
-  when tractor.gear_is_first? then 'forwards'
-  when tractor.gear_is_reverse? then 'backwards'
-  else
-    'stopped'
+  class Tractor
+    def direction
+      case
+      when tractor.gear_is_first? then 'forwards'
+      when tractor.gear_is_reverse? then 'backwards'
+      else
+        'stopped'
+      end
+    end
   end
 
-with the more maintainable version
-
-  tractor.direction
-
-if you define
+Enumerated State lets you clean it up as so
 
   class Tractor
-    enum_attr :gear, %w(reverse ^neutral first), allow_nil=>false
+    enum_attr :gear, %w(reverse ^neutral first)
     acts_as_enumerated_state :gear
 
+    def direction; nil; end  # called if gear == nil
+
     module Reverse
       def direction; 'backwards'; end
     end
@@ -51,6 +53,27 @@ if you define
     end
   end
 
+== Multi-variable state and enum value conflicts
+
+Use the :module option to avoid naming conflicts between enumerated attributes
+
+  class Foobar
+    enum_attr :alpha, %w(state1 state2)
+    enum_attr :beta, %w(state1 state2 state3)  # names will overlap when mapped to modules
+
+    acts_as_enumerated_state :alpha
+    acts_as_enumerated_state :beta, :module=>'Beta'
+
+    module State1 ... end
+    module State2 ... end
+
+    module Beta
+      module State1 ... end
+      module State2 ... end
+      module State3 ... end
+    end
+  end
+
 == Dependencies
 
 * meta_programming

data/lib/enumerated_state.rb

@@ -20,29 +20,52 @@ class Class
 
     self.extend EnumeratedStateClassMethods
     self.set_enumerated_state_property(enum_attr, :module_prefix, opts[:module] ? "#{opts[:module]}::" : '')
+    self.set_enumerated_state_property(enum_attr, :strict, opts[:strict] == false ? false : true)
 
     if self.method_defined?("write_enumerated_attribute_without_#{enum_attr}")
       raise EnumeratedState::RedefinitionError, "Enumerated state already defined for :#{enum_attr}"
     end
 
     define_chained_method(:write_enumerated_attribute, enum_attr) do |attribute, value|
-      module_prefix = self.class.get_enumerated_state_property(attribute, :module_prefix) || ''
       if (value != (old_value = self.read_enumerated_attribute(attribute)))
         unless old_value.nil?
-          _module = self.class.class_eval(module_prefix + old_value.to_s.split(/_/).map(&:capitalize).join)
-          self.unmix _module
+          _module = self.class.get_module_for_enumerated_state(attribute, old_value)
+          self.unmix(_module) if _module
         end
       end
       self.__send__("write_enumerated_attribute_without_#{enum_attr}".to_sym, attribute, value)
       if (enum_attr == attribute.to_sym && !value.nil?)
-        _module = self.class.class_eval(module_prefix + value.to_s.split(/_/).map(&:capitalize).join)
-        self.mixin _module
+        _module = self.class.get_module_for_enumerated_state(attribute, value)
+        self.mixin(_module) if _module
       end
     end
   end
   alias_method :enumerated_state_pattern, :acts_as_enumerated_state
 
+  module EnumeratedStateHelpers
+
+  end
+
   module EnumeratedStateClassMethods
+    def get_module_for_enumerated_state(attribute, value)
+      value = value.to_sym unless value.nil?
+      return self.get_enumerated_state_property(attribute, value) if self.enumerated_state_property_exists?(attribute, value)
+
+      module_prefix = self.get_enumerated_state_property(attribute, :module_prefix) || ''
+      module_name = module_prefix + value.to_s.split(/_/).map(&:capitalize).join
+      strict = self.get_enumerated_state_property(attribute, :strict)
+      _module = begin
+        self.class_eval(module_name)
+      rescue
+        begin
+          Kernel.class_eval(module_name)
+        rescue Exception => ex
+          raise ex if strict
+        end
+      end
+      self.set_enumerated_state_property(attribute, value, _module)
+      _module
+    end
     def get_enumerated_state_property(enum_attr, prop_name)
       if @_enumerated_state.has_key?(enum_attr)
         if @_enumerated_state[enum_attr].has_key?(prop_name)
@@ -59,6 +82,9 @@ class Class
       end
       return nil
     end
+    def enumerated_state_property_exists?(enum_attr, prop_name)
+      @_enumerated_state[enum_attr].has_key?(prop_name) rescue false
+    end
     def set_enumerated_state_property(enum_attr, prop_name, value)
       @_enumerated_state ||= {}
       @_enumerated_state[enum_attr] ||= {}

data/spec/enumerated_state_spec.rb

@@ -375,6 +375,42 @@ describe 'Enumerated State' do
     end
   end
 
+  describe "implementation with missing module" do
+    class Impl20
+      enum_attr :enum1, %w(mod1 mod2)
+      enum_attr :enum2, %w(mod3 mod2)
+      acts_as_enumerated_state :enum1, :strict=>false
+      acts_as_enumerated_state :enum2
+
+      def hello; 'hello Impl'; end
+      def hi; 'hi Impl'; end
+
+      module Mod1
+        def hello; 'hello Mod1'; end
+      end
+      module Mod3
+        def hi; 'hi Mod3'; end
+      end
+    end
+
+    it "should call Impl hello when enum1 set to Mod2 and :strict option set to false" do
+      obj = Impl20.new
+      obj.hello.should == 'hello Impl'
+      obj.enum1 = :mod1
+      obj.hello.should == 'hello Mod1'
+      obj.enum1 = :mod2
+      obj.hello.should == 'hello Impl'
+    end
+
+    it "should raise exception when enum2 set to Mod2 and :strict option not set" do
+      obj = Impl20.new
+      obj.hi.should == 'hi Impl'
+      obj.enum2 = :mod3
+      obj.hi.should == 'hi Mod3'
+      lambda { obj.enum2 = :mod2 }.should raise_exception(NameError)
+    end
+  end
+
   describe "implementation error checking" do
 
     it "should raise exception when redeclaring enumerated states in subclass" do

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: enumerated_state
 version: !ruby/object:Gem::Version 
-  hash: 25
   prerelease: false
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Jeff Patmon
@@ -22,11 +21,9 @@ dependencies:
   name: enumerated_attribute
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         - 2
@@ -38,11 +35,9 @@ dependencies:
   name: mixology
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 23
         segments: 
         - 0
         - 2
@@ -54,11 +49,9 @@ dependencies:
   name: meta_programming
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 21
         segments: 
         - 0
         - 2
@@ -94,29 +87,25 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 57
       segments: 
       - 1
       - 8
       - 7
       version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: ASPIUM (Another State Pattern Implementation Using Mixology)