attribute_mapper 1.3.0 → 1.3.1

data/lib/attribute_mapper.rb

@@ -1,12 +1,12 @@
 module AttributeMapper
-  
+
   def self.included(model)
     model.extend ClassMethods
     model.send(:include, InstanceMethods)
   end
-  
+
   module ClassMethods # @private
-    
+
     # Map a column in your table to a human-friendly attribute on your
     # model. When +attribute+ is accessed, it will return the key
     # from the mapping hash. When the attribute is updated, the value
@@ -25,6 +25,7 @@ module AttributeMapper
     # Each attribute you map generates an options method, suitable for
     # use in form helpers. If you define an attribute +status+,
     # instances of your model will have a +status_options+ method
+    # (on the class and any instances)
     # that returns a sorted array of arrays containing
     # humanized-option-name/value pairs. By default this array is
     # sorted by the option name (closed/open/etc.) If you'd rather
@@ -42,16 +43,32 @@ module AttributeMapper
     # @option options :predicate_methods Generate methods for checking
     #   whether an object has a certain attribute set
     def map_attribute(attribute, options)
-      mapping = options[:to]
+      mapping = build_mapping(options)
       verify_existence_of attribute
       add_accessor_for    attribute, mapping
       add_predicates_for  attribute, mapping.keys if options.fetch(:predicate_methods) { true }
       override            attribute
       add_options_helper_for attribute, mapping
+      add_options_helper_to_class attribute, self
     end
 
     private
-    
+    def build_mapping(options)
+      case options[:to]
+      when Hash
+        options[:to]
+      when Array
+        build_mapping_from_array(options[:to])
+      end
+    end
+
+    # Transforms an array into a hash for the mapping.
+    #   [:open, :closed] # => { :open => 1, :closed => 2 }
+    #
+    def build_mapping_from_array(array)
+      array.enum_for(:each_with_index).inject({}) { |h, (o, i)| h[o] = i+1; h }
+    end
+
     def add_accessor_for(attribute, mapping)
       class_eval(<<-EVAL, __FILE__, __LINE__)
         class << self
@@ -78,18 +95,30 @@ module AttributeMapper
           options = self.class.#{attribute.to_s.pluralize}.sort { |l, r|
             sort_by_keys ? l.first.to_s <=> r.first.to_s : l.last <=> r.last
           }.map { |f|
-            [f[0].to_s.humanize, f[0]]
+            [f[0].to_s.capitalize, f[0]]
           }
-        self.#{attribute}.present? ? [options, {:selected => self.#{attribute}}] : [options]
+          self.#{attribute}.present? ? [options, {:selected => self.#{attribute}}] : [options]
         end
       EVAL
     end
-        
+
+    def add_options_helper_to_class(attribute, klass)
+      klass.instance_eval(<<-EVAL, __FILE__, __LINE__)
+        def #{attribute}_options(sort_by_keys=true)
+          options = #{attribute.to_s.pluralize}.sort { |l, r|
+            sort_by_keys ? l.first.to_s <=> r.first.to_s : l.last <=> r.last
+          }.map { |f|
+            [f[0].to_s.capitalize, f[0]]
+          }
+        end
+      EVAL
+    end
+
     def override(*args)
       override_getters *args
       override_setters *args
     end
-    
+
     def override_getters(attribute)
       class_eval(<<-EVAL, __FILE__, __LINE__)
         def #{attribute}
@@ -97,7 +126,7 @@ module AttributeMapper
         end
       EVAL
     end
-    
+
     def override_setters(attribute)
       class_eval(<<-EVAL, __FILE__, __LINE__)
         def #{attribute}=(raw_value)
@@ -106,15 +135,15 @@ module AttributeMapper
         end
       EVAL
     end
-    
+
     def verify_existence_of(attribute)
       raise ArgumentError, "`#{attribute}' is not an attribute of `#{self}'" unless column_names.include?(attribute.to_s)
     end
-    
+
   end
-  
+
   module InstanceMethods
-    
+
     private
 
     def resolve_value_of(attribute, raw_value)
@@ -126,5 +155,5 @@ module AttributeMapper
     end
 
   end
-  
+
 end

data/test/attribute_mapper_test.rb

@@ -1,17 +1,17 @@
 require 'test_helper'
 
 class AttributeMapperTest < Test::Unit::TestCase
-  
+
   context "Attribute Mapper" do
     setup do
       Ticket.map_attribute :status, :to => mapping
     end
-    
+
     should "set mapping for each attribute" do
       assert_equal mapping[:open], Ticket.statuses[:open]
       assert_equal mapping[:closed], Ticket.statuses[:closed]
     end
-  
+
     should "override getters and setters" do
       assert_nil ticket.status
       assert_nothing_raised do
@@ -19,11 +19,11 @@ class AttributeMapperTest < Test::Unit::TestCase
       end
       assert_equal :open, ticket.status
       assert_equal mapping[:open], ticket[:status]
-    
+
       assert_nothing_raised do
         ticket.status = :closed
       end
-    
+
       assert_equal :closed, ticket.status
       assert_equal mapping[:closed], ticket[:status]
     end
@@ -32,7 +32,7 @@ class AttributeMapperTest < Test::Unit::TestCase
       ticket.status = :open
       assert ticket.open?
     end
-  
+
     should "allow indifferent access to setters" do
       assert_nothing_raised do
         ticket.status = :open
@@ -43,27 +43,27 @@ class AttributeMapperTest < Test::Unit::TestCase
       end
       assert_equal :open, ticket.status
     end
-  
+
     should "raise an exception when trying to map to a non-existent column" do
       assert_raises(ArgumentError) do
         Ticket.map_attribute :this_column_does_not_exist, :to => {:i_will_fail => 1}
       end
     end
-  
+
     should "raise an exception when setting an invalid value" do
       assert_raises(ArgumentError) do
         ticket.status = :non_existent_value
       end
     end
-  
+
     should "allow setting a primitive value directly if the value is present in the mapping" do
       ticket = Ticket.new
       assert_nothing_raised do
         ticket.status = mapping[:open]
       end
-    
+
       assert_equal :open, ticket.status
-    
+
       assert_raises(ArgumentError) do
         ticket.status = 500
       end
@@ -76,10 +76,10 @@ class AttributeMapperTest < Test::Unit::TestCase
     should "work with attr_accessible" do
       new_ticket = Class.new(ActiveRecord::Base) do
         set_table_name "tickets"
-        
+
         include AttributeMapper
         map_attribute :status, :to => {:open => 1, :closed => 2}
-        
+
         attr_accessible :status
       end
 
@@ -95,6 +95,40 @@ class AttributeMapperTest < Test::Unit::TestCase
       ticket.status = :open
       assert_equal [[["Open", :open], ["Closed", :closed]], {:selected => :open}], ticket.status_options(false)
     end
+
+    should "provide a class level helper for forms" do
+      assert_equal [["Closed", :closed], ["Open", :open]], Ticket.status_options
+      assert_equal [["Open", :open], ["Closed", :closed]], Ticket.status_options(false)
+    end
+
+    should "not raise an error when setting to a blank value" do
+      assert_nothing_raised {
+        ticket.update_attributes(:status => "")
+      }
+    end
+
+    should "not raise an error when setting to a nil value" do
+      assert_nothing_raised {
+        ticket.update_attributes(:status => nil)
+      }
+    end
+
+    should "turn off generation of predicate methods" do
+      new_ticket = Class.new(ActiveRecord::Base) do
+        set_table_name "tickets"
+
+        include AttributeMapper
+        map_attribute :status, :to => {:open => 1, :closed => 2}, :predicate_methods => false
+      end
+
+      t = new_ticket.new
+      t.status = :open
+
+      assert_raises(NoMethodError) {
+        t.open?
+      }
+    end
+
     
     context "setting nil as a valid value in the mapping" do
       setup do
@@ -120,46 +154,44 @@ class AttributeMapperTest < Test::Unit::TestCase
 
     end
 
-    should "not raise an error when setting to a blank value" do
-      assert_nothing_raised {
-        ticket.update_attributes(:status => "")
-      }
-    end
-
-    should "not raise an error when setting to a nil value" do
-      assert_nothing_raised {
-        ticket.update_attributes(:status => nil)
-      }
-    end
-
-    should "turn off generation of predicate methods" do
-      new_ticket = Class.new(ActiveRecord::Base) do
+    should 'auto-expand arrays to a hash with the raw value being the index + 1' do
+      array_ticket = Class.new(ActiveRecord::Base) do
         set_table_name "tickets"
 
         include AttributeMapper
-        map_attribute :status, :to => {:open => 1, :closed => 2}, :predicate_methods => false
+        map_attribute :status, :to => [:open, :closed]
       end
 
-      t = new_ticket.new
-      t.status = :open
+      ticket = array_ticket.new
+
+      assert_nil ticket.status
+      assert_nothing_raised do
+        ticket.status = :open
+      end
+      assert_equal :open, ticket.status
+      assert_equal mapping[:open], ticket[:status]
+
+      assert_nothing_raised do
+        ticket.status = :closed
+      end
+
+      assert_equal :closed, ticket.status
+      assert_equal mapping[:closed], ticket[:status]
 
-      assert_raises(NoMethodError) {
-        t.open?
-      }
     end
-    
+
   end
-  
+
   #######
   private
   #######
-  
+
   def mapping(options = {})
     {:open => 1, :closed => 2}.merge(options)
   end
-  
+
   def ticket
     @ticket ||= Ticket.new
   end
-  
+
 end

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: attribute_mapper
 version: !ruby/object:Gem::Version 
-  version: 1.3.0
+  hash: 25
+  prerelease: false
+  segments: 
+  - 1
+  - 3
+  - 1
+  version: 1.3.1
 platform: ruby
 authors: 
 - Marcel Molina Jr.
@@ -38,21 +44,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Map symbolic types to primitive types and stash them in a column.