attribute_mapper 1.0.0 → 1.1.1

data/.gitignore

@@ -1,2 +1,4 @@
 coverage
-pkg
+pkg
+doc
+.yardoc

data/Rakefile

@@ -5,13 +5,23 @@ task :default => :test
 
 Rake::TestTask.new do |t|
   t.test_files = FileList['test/*_test.rb']
-  t.ruby_opts = ['-rubygems']
+  t.ruby_opts = ['-Itest', '-rubygems']
 end
 
 Rcov::RcovTask.new do |t|
   t.test_files = FileList['test/*_test.rb']
 end
 
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new(:doc) do |t|
+    t.options = ['--no-private']
+    t.files = FileList['lib/**/*.rb']
+  end
+rescue LoadError => e
+  puts "yard not available. Install it with: gem install yard"
+end
+
 begin
   require 'jeweler'
   Jeweler::Tasks.new do |s|
@@ -24,4 +34,4 @@ begin
   end
 rescue LoadError
   puts "Jeweler not available. Install it with: gem install technicalpickles-jeweler -s http://gems.github.com"
-end
+end

data/VERSION.yml

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

data/attribute_mapper.gemspec

@@ -1,25 +1,46 @@
+# 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 = "0.9.1"
+  s.version = "1.1.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.date = %q{2010-01-08}
   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.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.homepage = %q{http://github.com/therealadam/attribute_mapper}
-  s.rdoc_options = ["--inline-source", "--charset=UTF-8"]
+  s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.1}
+  s.rubygems_version = %q{1.3.5}
   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 = 2
+    s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
     else
@@ -27,3 +48,4 @@ Gem::Specification.new do |s|
   else
   end
 end
+

data/lib/attribute_mapper.rb

@@ -5,14 +5,36 @@ module AttributeMapper
     model.send(:include, InstanceMethods)
   end
   
-  module ClassMethods
+  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.
+    #
+    # 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.
+    #
+    # 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
+    #   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.
     def map_attribute(attribute, options)
-        mapping = options[:to]
-        verify_existence_of attribute
-        add_accessor_for    attribute, mapping
-        override            attribute
+      mapping = options[:to]
+      verify_existence_of attribute
+      add_accessor_for    attribute, mapping
+      add_predicates_for  attribute, mapping.keys
+      override            attribute
     end
-    
+
     private
       def add_accessor_for(attribute, mapping)
         class_eval(<<-EVAL)
@@ -22,7 +44,17 @@ module AttributeMapper
             end
           end
         EVAL
-      end
+        end
+
+        def add_predicates_for(attribute, names)
+          names.each do |name|
+            class_eval(<<-RUBY)
+              def #{name}?
+                self.#{attribute} == :#{name}
+              end
+            RUBY
+          end
+        end
     
       def override(*args)
         override_getters *args
@@ -60,4 +92,4 @@ module AttributeMapper
         mapping[check_value] || check_value
       end
   end
-end
+end

data/test/attribute_mapper_test.rb

@@ -1,24 +1,4 @@
-require 'test/unit'
-require 'shoulda'
-
-require 'active_record'
-require 'attribute_mapper'
-
-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
-  include AttributeMapper
-end
+require 'test_helper'
 
 class AttributeMapperTest < Test::Unit::TestCase
   
@@ -47,6 +27,11 @@ class AttributeMapperTest < Test::Unit::TestCase
       assert_equal :closed, ticket.status
       assert_equal mapping[:closed], ticket[:status]
     end
+
+    should 'define predicates for each attribute' do
+      ticket.status = :open
+      assert ticket.open?
+    end
   
     should "allow indifferent access to setters" do
       assert_nothing_raised do

data/test/test_helper.rb

@@ -0,0 +1,22 @@
+require 'test/unit'
+require 'shoulda'
+
+require 'active_record'
+require 'attribute_mapper'
+
+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
+  include AttributeMapper
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: attribute_mapper
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.1.1
 platform: ruby
 authors: 
 - Marcel Molina Jr.
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-22 00:00:00 -06:00
+date: 2010-01-08 00:00:00 -06:00
 default_executable: 
 dependencies: []
 
@@ -34,6 +34,7 @@ files:
 - init.rb
 - lib/attribute_mapper.rb
 - test/attribute_mapper_test.rb
+- test/test_helper.rb
 has_rdoc: true
 homepage: http://github.com/therealadam/attribute_mapper
 licenses: []
@@ -64,3 +65,4 @@ specification_version: 3
 summary: Map symbolic types to primitive types and stash them in a column.
 test_files: 
 - test/attribute_mapper_test.rb
+- test/test_helper.rb