therealadam-attribute_mapper 0.9.1

data/README.md

@@ -0,0 +1,35 @@
+# AttributeMapper
+
+AttributeMapper provides a transparent interface for mapping
+symbolic representations to a column in the database of a more primitive type.
+For example, rather than hardcoding values like 1 or 2 to represent that a
+Ticket model's status column is "open" or "closed" you would create the
+following mapping:
+
+    class Ticket < ActiveRecord::Base
+      map_attribute :status, :to => {:open => 1, :closed => 2}
+    end
+  
+You can now get and set the status column symbolically:
+
+    ticket.status = :open
+    ticket.status # => :open
+  
+Internally, the integer 1 will be stored in the database.
+
+An authoritative list of the mapping is available as a class method which is the pluralized version of the attribute:
+
+    Ticket.statuses # => {:open => 1, :closed => 2}
+  
+The primitive values of the mapping can always be used to assign the column,
+though the getter for the attribute will always return the higher level
+symbolic representation.
+
+    ticket.status = 1
+    ticket.status # => :open
+
+## Authors
+
+Marcel Molina, Jr., Bruce Williams and Adam Keys
+
+Released under the MIT License (see LICENSE).

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 9
+:patch: 1
+:major: 0

data/lib/attribute_mapper.rb

@@ -0,0 +1,71 @@
+module AttributeMapper
+  
+  class << self
+  
+    def included(model)
+      model.extend ClassMethods
+      model.send(:include, InstanceMethods)
+    end
+    
+    def load
+      ActiveRecord::Base.send(:include, AttributeMapper)
+    end
+    
+  end
+  
+  module ClassMethods
+    def map_attribute(attribute, options)
+        mapping = options[:to]
+        verify_existence_of attribute
+        add_accessor_for    attribute, mapping
+        override            attribute
+    end
+    
+    private
+      def add_accessor_for(attribute, mapping)
+        class_eval(<<-EVAL)
+          class << self
+            def #{attribute.to_s.pluralize}
+              #{mapping.inspect}
+            end
+          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
+  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
+  end
+end

data/test/attribute_mapper_test.rb

@@ -0,0 +1,102 @@
+require 'test/unit'
+require 'shoulda'
+require 'active_record'
+
+require 'attribute_mapper'
+
+AttributeMapper.load
+
+ActiveRecord::Base.establish_connection(
+  :adapter  => 'sqlite3',
+  :database => ':memory:'
+)
+
+ActiveRecord::Schema.define do 
+  create_table :tickets do |table|
+    table.column :status, :integer
+  end
+end
+
+# Pseudo model for testing purposes
+class Ticket < ActiveRecord::Base
+end
+
+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
+        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]
+    end
+  
+    should "allow indifferent access to setters" do
+      assert_nothing_raised do
+        ticket.status = :open
+      end
+      assert_equal :open, ticket.status
+      assert_nothing_raised do
+        ticket.status = 'open'
+      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
+    end
+        
+  end
+  
+  #######
+  private
+  #######
+
+  def mapping(options = {})
+    {:open => 1, :closed => 2}.merge(options)
+  end
+
+  def ticket
+    @ticket ||= Ticket.new
+  end
+  
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification 
+name: therealadam-attribute_mapper
+version: !ruby/object:Gem::Version 
+  version: 0.9.1
+platform: ruby
+authors: 
+- Marcel Molina Jr.
+- Bruce Williams
+- Adam Keys
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-10 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Provides a transparent interface for mapping symbolic representations to a column in the database of a more primitive type.
+email: adamkkeys@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.md
+- VERSION.yml
+- lib/attribute_mapper.rb
+- test/attribute_mapper_test.rb
+has_rdoc: true
+homepage: http://github.com/therealadam/attribute_mapper
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Map symbolic types to primitive types and stash them in a column.
+test_files: []
+