iron-enum 1.0.0 → 1.0.1

data/History.txt

@@ -1,3 +1,8 @@
+== 1.0.1 / 2013-03-23
+
+* Add validation of inclusion for ActiveRecord enum_attr owners
+* Improve docs and spec coverage a bit
+
 == 1.0.0 / 2013-03-23
 
 * Initial revision

data/README.rdoc

@@ -12,7 +12,7 @@ Managing constants - status flags, system states, etc - is frustrating when work
 with Ruby and Rails.  The canonical solution is to use class constants.  But doing so
 leaves a lot to be desired.  This gem provides a much more Ruby-like way of dealing
 with magic constants, that provides symbol/key-based lookup, automatic conversion between
-keys and values, user-friendly naming, Rails integration, attribute support, and more.
+keys and values, user-friendly naming, attribute support, model scoping and validation, and more.
 
 To use:
 
@@ -48,7 +48,7 @@ To use:
     => :shipped
     
     # Validate values against the set of good values
-    >> OrderStatus.valid?(10)
+    >> OrderStatus.valid_value?(10)
     => false
     
     # Get an array of all valid values
@@ -73,11 +73,21 @@ To use:
     # Set a value
     >> @order.status_returned!
     => 5
+
+    # Setting an invalid value raises an exception
+    # This raises RuntimeError('Unknown key or value [27] in enum OrderStatus')
+    >> @order.status = 27
     
     # You even get free scoping
     >> Order.with_status(:shipped)
     => [...all orders with status == 4...]
     
+    # And model validation, should you somehow set the field to an improper value
+    >> @order = Order.new
+    >> @order.send(:write_attribute, :status, -2)
+    >> @order.valid?
+    => false
+    
 == REQUIREMENTS
 
 None, though you'll need rspec, sqlite3 and active_record gems to test and build the gem

data/Version.txt

@@ -1 +1 @@
-1.0.0
+1.0.1

data/lib/iron/enum/attr_support.rb

@@ -45,13 +45,13 @@ module Enum
   module AttrSupport
 
     # Call with enum_attr :field => Enum
-    def enum_attr(name_to_enum_map)
+    def enum_attr(field_to_enum_map)
       # Save off the attr map
       @enum_attrs ||= {}
-      @enum_attrs.merge!(name_to_enum_map)
+      @enum_attrs.merge!(field_to_enum_map)
 
       # Run each newly added enum attribute
-      name_to_enum_map.each_pair do |attr_name, enum|
+      field_to_enum_map.each_pair do |attr_field, enum|
         # Convert Enum to "Enum"
         enum_klass = enum.to_s
 
@@ -59,12 +59,12 @@ module Enum
         #   attr_as_key to get back eg :production or :online instead of 1 or 5
         #   attr_as_name to get back eg "Production" or "Online"
         class_eval <<-eos, __FILE__, __LINE__ + 1
-          def #{attr_name}_as_key
-            #{enum_klass}.key(self.#{attr_name})
+          def #{attr_field}_as_key
+            #{enum_klass}.key(self.#{attr_field})
           end
 
-          def #{attr_name}_as_name
-            #{enum_klass}.name(self.#{attr_name})
+          def #{attr_field}_as_name
+            #{enum_klass}.name(self.#{attr_field})
           end
         eos
 
@@ -75,12 +75,12 @@ module Enum
 
           # Build sugar for testing and setting the attribute's enumerated value
           class_eval <<-eos, __FILE__, __LINE__ + 1
-            def #{attr_name}_#{key}?
-              self.#{attr_name} == #{val}
+            def #{attr_field}_#{key}?
+              self.#{attr_field} == #{val}
             end
 
-            def #{attr_name}_#{key}!
-              self.#{attr_name} = #{val}
+            def #{attr_field}_#{key}!
+              self.#{attr_field} = #{val}
             end
           eos
         end
@@ -88,21 +88,28 @@ module Enum
         if defined?(ActiveRecord) && self < ActiveRecord::Base
 
           # Define a finder scope
-          scope "with_#{attr_name}", lambda {|*vals|
+          scope "with_#{attr_field}", lambda {|*vals|
             vals.flatten!
             if vals.empty?
               where("?", false)
             elsif vals.count == 1
-              where(attr_name => enum.value(vals.first))
+              where(attr_field => enum.value(vals.first))
             else
-              where(attr_name => enum.values(vals))
+              where(attr_field => enum.values(vals))
             end
           }
+          
+          # Define a validation
+          validates attr_field, :inclusion => { 
+            :in => enum.values,
+            :message => "%{value} is not a valid #{enum_klass} value",
+            :allow_nil => true
+          }
 
           # Override default setter to allow setting an enum attribute via key
           class_eval <<-eos, __FILE__, __LINE__ + 1
-            def #{attr_name}=(val)
-              write_attribute(:#{attr_name}, #{enum_klass}.value(val))
+            def #{attr_field}=(val)
+              write_attribute(:#{attr_field}, #{enum_klass}.value(val))
             end
           eos
 
@@ -110,12 +117,12 @@ module Enum
 
           # Create getter/setter to allow setting an enum attribute via key
           class_eval <<-eos, __FILE__, __LINE__ + 1
-            def #{attr_name}
-              @#{attr_name}
+            def #{attr_field}
+              @#{attr_field}
             end
 
-            def #{attr_name}=(val)
-              @#{attr_name} = #{enum_klass}.value(val)
+            def #{attr_field}=(val)
+              @#{attr_field} = #{enum_klass}.value(val)
             end
           eos
 

data/lib/iron/enum/core.rb

@@ -82,7 +82,7 @@ module Enum
     def row_for(in_key)
       key = to_key(in_key)
       row = enum_list.find {|r| r[KEY_IDX] == key}
-      raise "No information on key [#{in_key.inspect}] in enum #{self}" unless row
+      raise RuntimeError.new("Unknown key or value [#{in_key.inspect}] in enum #{self}") unless row
       row
     end
 

data/spec/enum/attr_spec.rb

@@ -28,5 +28,9 @@ describe Enum do
       @obj.pos_as_name.should == 'First'
     end
     
+    it 'should raise on setting invalid values' do
+      expect { @obj.pos = 4000 }.to raise_error
+    end
+    
   end
 end

data/spec/enum/enum_spec.rb

@@ -25,5 +25,15 @@ describe Enum do
     EnumTest.valid_value?(10).should be_true
     EnumTest.valid_value?(555).should be_false
   end
+  
+  it 'should enforce proper keys' do
+    expect { EnumTest.enum('not-a-key', 27) }.to raise_error
+    expect { EnumTest.enum(27, 100) }.to raise_error
+  end
+  
+  it 'should enforce proper values' do
+    expect { EnumTest.enum(:some_key, nil) }.to raise_error
+    expect { EnumTest.enum(:some_key, '200') }.to raise_error
+  end
 
 end

data/spec/enum/model_spec.rb

@@ -53,6 +53,7 @@ describe Enum do
     
     it 'should support multiple values in the automatic scope' do
       ARTest.delete_all
+      ARTest.create!(:enum_field => :one)
       ARTest.create!(:enum_field => :two)
       ARTest.create!(:enum_field => 33)
       ARTest.with_enum_field(2, :thirty_three).count.should == 2
@@ -75,5 +76,20 @@ describe Enum do
       ARTest.with_enum_field(nil).count.should == 1
     end
     
+    it 'should fail validation with invalid values' do
+      @test.send(:write_attribute, :enum_field, 270)
+      @test.should_not be_valid
+    end
+    
+    it 'should pass validation with valid values' do
+      @test.send(:write_attribute, :enum_field, AREnum::TWO)
+      @test.should be_valid
+    end
+    
+    it 'should pass validation with a nil value' do
+      @test.send(:write_attribute, :enum_field, nil)
+      @test.should be_valid
+    end
+    
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iron-enum
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors: