attribute_mapper 0.9.1

data/.gitignore

@@ -0,0 +1,2 @@
+coverage
+pkg

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2007-2009 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
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

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/Rakefile

@@ -0,0 +1,27 @@
+require 'rake/testtask'
+require 'rcov/rcovtask'
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/*_test.rb']
+  t.ruby_opts = ['-rubygems']
+end
+
+Rcov::RcovTask.new do |t|
+  t.test_files = FileList['test/*_test.rb']
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = 'attribute_mapper'
+    s.summary = 'Map symbolic types to primitive types and stash them in a column.'
+    s.email = 'adamkkeys@gmail.com'
+    s.homepage = 'http://github.com/therealadam/attribute_mapper'
+    s.description = 'Provides a transparent interface for mapping symbolic representations to a column in the database of a more primitive type.'
+    s.authors = ['Marcel Molina Jr.', 'Bruce Williams', 'Adam Keys']
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION.yml

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

data/attribute_mapper.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{attribute_mapper}
+  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{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.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 = ["--inline-source", "--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Map symbolic types to primitive types and stash them in a column.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/init.rb

@@ -0,0 +1,2 @@
+require File.dirname(__FILE__) << "/lib/attribute_mapper"
+AttributeMapper.load

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,66 @@
+--- !ruby/object:Gem::Specification 
+name: 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-10-26 00:00:00 -05: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: 
+- LICENSE
+- README.md
+files: 
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION.yml
+- attribute_mapper.gemspec
+- init.rb
+- lib/attribute_mapper.rb
+- test/attribute_mapper_test.rb
+has_rdoc: true
+homepage: http://github.com/therealadam/attribute_mapper
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --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.3.5
+signing_key: 
+specification_version: 3
+summary: Map symbolic types to primitive types and stash them in a column.
+test_files: 
+- test/attribute_mapper_test.rb