attribute_mapper 1.1.1 → 1.2.0

data/.kick

@@ -0,0 +1,6 @@
+recipe :ruby
+
+startup { log "Here we go." }
+
+Ruby.test_options << "-Itest"
+Ruby.test_options << "-rubygems"

data/HISTORY.rdoc

@@ -0,0 +1,8 @@
+= 1.2.0 (2010-02-23)
+
+* Verified compatibility with +update_attributes+ and +attr_accessible+.
+* Add +_options+ helper to make generating select forms for mappings easier
+
+= 1.1.1 (2010-01-08)
+
+* Changelog epoch.

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2007-2009 Marcel Molina, Jr., Bruce Williams, Adam Keys
+Copyright (c) 2007-2010 Marcel Molina, Jr., Bruce Williams, Adam Keys
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
-:minor: 1
-:patch: 1
+:minor: 2
+:patch: 0
 :build: 
 :major: 1

data/attribute_mapper.gemspec

@@ -1,46 +1,25 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{attribute_mapper}
-  s.version = "1.1.1"
+  s.version = "0.9.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Marcel Molina Jr.", "Bruce Williams", "Adam Keys"]
-  s.date = %q{2010-01-08}
+  s.date = %q{2009-03-10}
   s.description = %q{Provides a transparent interface for mapping symbolic representations to a column in the database of a more primitive type.}
   s.email = %q{adamkkeys@gmail.com}
-  s.extra_rdoc_files = [
-    "LICENSE",
-     "README.md"
-  ]
-  s.files = [
-    ".gitignore",
-     "LICENSE",
-     "README.md",
-     "Rakefile",
-     "VERSION.yml",
-     "attribute_mapper.gemspec",
-     "init.rb",
-     "lib/attribute_mapper.rb",
-     "test/attribute_mapper_test.rb",
-     "test/test_helper.rb"
-  ]
+  s.files = ["README.md", "VERSION.yml", "lib/attribute_mapper.rb", "test/attribute_mapper_test.rb"]
+  s.has_rdoc = true
   s.homepage = %q{http://github.com/therealadam/attribute_mapper}
-  s.rdoc_options = ["--charset=UTF-8"]
+  s.rdoc_options = ["--inline-source", "--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.1}
   s.summary = %q{Map symbolic types to primitive types and stash them in a column.}
-  s.test_files = [
-    "test/attribute_mapper_test.rb",
-     "test/test_helper.rb"
-  ]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
+    s.specification_version = 2
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
     else
@@ -48,4 +27,3 @@ Gem::Specification.new do |s|
   else
   end
 end
-

data/lib/attribute_mapper.rb

@@ -7,89 +7,121 @@ module AttributeMapper
   
   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 from the mapping hash is written to the
-    # database.
+    # 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
+    # from the mapping hash is written to the database.
     #
     # A class method is also added providing access to the mapping
-    # hash, i.e. defining an attribute ++status++ will add a
-    # ++statuses++ class method that returns the hash passed to the
-    # ++:to++ option.
+    # hash, i.e. defining an attribute +status+ will add a
+    # +statuses+ class method that returns the hash passed to the
+    # +:to+ option.
     #
-    # Predicates are also added to each object for each attribute. If you have a key
-    # ++open++ in your mapping, your objects will have an ++open?++ method that
-    # returns true if the attribute value is ++:open++
+    # Predicates are also added to each object for each attribute. If
+    # you have a key +open+ in your mapping, your objects will have
+    # an +open?+ method that returns true if the attribute value is
+    # +:open+
     #
-    # @example Define a Ticket model with a status column that maps to open or closed
+    # 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
+    # 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
+    # sort by value, pass +false+ to the options method. This method
+    # also will set the selected option for records where the
+    # attribute is already set.
+    #
+    # @example Define a Ticket model with a status column:
     #   map_attribute :status, :to => {:open => 1, :closed => 2}
     #
     # @param [String] attribute the column to map on
     # @param [Hash] options the options for this attribute
-    # @option options [Hash] :to The enumeration to use for this attribute. See example above.
+    # @option options [Hash] :to The enumeration to use for this
+    #   attribute. See example above.
     def map_attribute(attribute, options)
       mapping = options[:to]
       verify_existence_of attribute
       add_accessor_for    attribute, mapping
       add_predicates_for  attribute, mapping.keys
       override            attribute
+      add_options_helper_for attribute, mapping
     end
 
     private
-      def add_accessor_for(attribute, mapping)
-        class_eval(<<-EVAL)
-          class << self
-            def #{attribute.to_s.pluralize}
-              #{mapping.inspect}
-            end
+    
+    def add_accessor_for(attribute, mapping)
+      class_eval(<<-EVAL)
+        class << self
+          def #{attribute.to_s.pluralize}
+            #{mapping.inspect}
           end
-        EVAL
         end
+      EVAL
+    end
 
-        def add_predicates_for(attribute, names)
-          names.each do |name|
-            class_eval(<<-RUBY)
-              def #{name}?
-                self.#{attribute} == :#{name}
-              end
-            RUBY
+    def add_predicates_for(attribute, names)
+      names.each do |name|
+        class_eval(<<-RUBY)
+          def #{name}?
+            self.#{attribute} == :#{name}
           end
+        RUBY
+      end
+    end
+
+    def add_options_helper_for(attribute, mapping)
+      class_eval(<<-EVAL, __FILE__, __LINE__)
+        def #{attribute}_options(sort_by_keys=true)
+          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]]
+          }
+        self.#{attribute}.present? ? [options, {:selected => self.#{attribute}}] : [options]
         end
+      EVAL
+    end
+        
+    def override(*args)
+      override_getters *args
+      override_setters *args
+    end
+    
+    def override_getters(attribute)
+      class_eval(<<-EVAL)
+        def #{attribute}
+          self.class.#{attribute.to_s.pluralize}.invert[read_attribute(:#{attribute})]
+        end
+      EVAL
+    end
+    
+    def override_setters(attribute)
+      class_eval(<<-EVAL)
+        def #{attribute}=(raw_value)
+          value = resolve_value_of :#{attribute}, raw_value
+          write_attribute(:#{attribute}, value)
+        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
     
-      def override(*args)
-        override_getters *args
-        override_setters *args
-      end
-      
-      def override_getters(attribute)
-        class_eval(<<-EVAL)
-          def #{attribute}
-            self.class.#{attribute.to_s.pluralize}.invert[read_attribute(:#{attribute})]
-          end
-        EVAL
-      end
-      
-      def override_setters(attribute)
-        class_eval(<<-EVAL)
-          def #{attribute}=(raw_value)
-            value = resolve_value_of :#{attribute}, raw_value
-            write_attribute(:#{attribute}, value)
-          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)
-        check_value = raw_value.is_a?(String) ? raw_value.to_sym : raw_value
-        mapping = self.class.send(attribute.to_s.pluralize)
-        raise ArgumentError, "`#{check_value}' not present in attribute mapping `#{mapping.inspect}'" unless mapping.to_a.flatten.include? check_value
-        mapping[check_value] || check_value
-      end
+    
+    def resolve_value_of(attribute, raw_value)
+      check_value = raw_value.is_a?(String) ? raw_value.to_sym : raw_value
+      mapping = self.class.send(attribute.to_s.pluralize)
+      raise ArgumentError, "`#{check_value}' not present in attribute mapping `#{mapping.inspect}'" unless mapping.to_a.flatten.include? check_value
+      mapping[check_value] || check_value
+    end
+    
   end
+  
 end

data/test/attribute_mapper_test.rb

@@ -68,7 +68,34 @@ class AttributeMapperTest < Test::Unit::TestCase
         ticket.status = 500
       end
     end
+
+    should "work with mass assignment" do
+      ticket.update_attributes(:status => :open, :name => 'Red is too red')
+    end
+
+    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
+
+      t = new_ticket.new
+      t.status = :open
+
+      assert_equal :open, t.status
+    end
+
+    should "provide a helper for forms" do
+      assert_equal [[["Closed", :closed], ["Open", :open]]], ticket.status_options
+      assert_equal [[["Open", :open], ["Closed", :closed]]], ticket.status_options(false)
+      ticket.status = :open
+      assert_equal [[["Open", :open], ["Closed", :closed]], {:selected => :open}], ticket.status_options(false)
+    end
+    
   end
   
   #######

data/test/test_helper.rb

@@ -12,6 +12,7 @@ ActiveRecord::Base.establish_connection(
 ActiveRecord::Schema.define do 
   create_table :tickets do |table|
     table.column :status, :integer
+    table.column :name, :string
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: attribute_mapper
 version: !ruby/object:Gem::Version 
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors: 
 - Marcel Molina Jr.
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-08 00:00:00 -06:00
+date: 2010-02-23 00:00:00 -06:00
 default_executable: 
 dependencies: []
 
@@ -26,6 +26,8 @@ extra_rdoc_files:
 - README.md
 files: 
 - .gitignore
+- .kick
+- HISTORY.rdoc
 - LICENSE
 - README.md
 - Rakefile