attribute_choices 1.0.1 → 1.0.2

data/.gitignore

@@ -0,0 +1,3 @@
+test/*.log
+rdoc
+*.gem

data/.travis.yml

@@ -0,0 +1,8 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - rbx
+  - rbx-2.0
+  - ree
+  - jruby
+  - ruby-head

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    attribute_choices (1.0.2)
+      activerecord
+      activesupport
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.1.0)
+      activesupport (= 3.1.0)
+      bcrypt-ruby (~> 3.0.0)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activerecord (3.1.0)
+      activemodel (= 3.1.0)
+      activesupport (= 3.1.0)
+      arel (~> 2.2.1)
+      tzinfo (~> 0.3.29)
+    activesupport (3.1.0)
+      multi_json (~> 1.0)
+    arel (2.2.1)
+    bcrypt-ruby (3.0.1)
+    builder (3.0.0)
+    i18n (0.6.0)
+    multi_json (1.0.3)
+    rake (0.9.2)
+    sqlite3 (1.3.4)
+    tzinfo (0.3.29)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  attribute_choices!
+  rake
+  sqlite3

data/README.md

@@ -1,62 +1,101 @@
-# AttributeChoices
+## AttributeChoices
 
-AttributeChoices is a plugin that simplifies the common pattern of mapping a set of discreet values for an ActiveRecord model attribute, to a set of display values for human consumption.
+[![Build Status](https://secure.travis-ci.org/christos/attribute_choices.png)](http://travis-ci.org/christos/attribute_choices)
 
-# Installation
+Extends ActiveRecord attributes with a `:choices` pseudo-type that provides convenient methods for mapping each choice to its human readable form.
 
-## Rails 3
+## Examples
+
+By defining the available choices for the `gender` attribute in your `User` model,
+
+    class User < ActiveRecord::Base
+      attribute_choices :gender,  [ ['m', "Male"], ['f', 'Female'] ], 
+                                  :validate => true
+    end
+
+...for any given `User` instance,
+
+    @john = User.new(:gender => 'm')
+    @john.gender
+     => 'm'
+
+...you can access the human readable attribute value like this:
+
+    @john.gender_display
+     => 'Male'
+
+If you need to provide the available choices in a `select` tag, you can simply use `User#gender_choices`,
+
+    <%= select("user", "gender", User.gender_choices) %>
+
+...which would give you the following HTML snippet
+ 
+    <select name="user[gender]">
+      <option value="m">Male</option>
+      <option value="f">Femail</option>
+    </select>
+
+Validation is also taken care of, if you specify `:validate => true` in the options
+
+     @john.gender = 'x'
+     @john.valid? 
+      => false
+
+And if you work with multiple languages, given the following `es.yml`
+
+    es:
+      user:
+        gender_choices:
+          male:  'Hombre
+          female: 'Mujer'
+
+...you can specify the attribute choices like this:
+
+    class User < ActiveRecord::Base
+      attribute_choices :gender,  [ ['m', 'user.gender_choices.male'], ['f', 'user.gender_choices.female'] ], 
+                                  :validate => true, :localize => true
+    end
+
+Then, provided that `I18n.locale == :es`, you are good to go:
+
+    @john.gender_display
+     => 'Hombre'
+
+    User.gender_choices
+      => [["Hombre", 'm'], ['Mujer', 'f']]
+
+
+## Installation
+
+#### Rails 3.x
 
   In your `Gemfile` add
   
     gem 'attribute_choices'
 
-## Rails 2
+#### Rails 2.x
 
   In `environment.rb` add:
     
     config.gem 'attribute_choices'
 
-# Usage
+## Changelog
 
-Define your model:
+#### V1.0.2
 
-    class User < ActiveRecord::Base
-      attribute_choices :gender,  { 'm' => "Male", 'f' => 'Female'}, :validate => true
-      attribute_choices :age_group,  [
-        ['18-24', '18 to 24 years old'], 
-        ['25-45', '25 to 45 years old']
-      ]
-    end
+* Works correctly with overridden ActiveRecord attribute accessors
+* Multi-ruby integration testing with Travis-CI
 
-Then try this in the console:
-
-    >> @john # User.new :gender => 'm', :age_group => '18-24', :name => 'John'
-    >> @john.gender
-    => 'm'
-    >> @john.gender_display
-    => 'Male'
-    >> User.gender_choices
-    => [["Male", 'm'], ['Female', 'f']]
-
-    >> @john.valid?
-    => true
-    >> @john.gender # 'o'
-    >> @john.valid?
-    => false
-
-    => I18n.locale # :es
-    >> @john.gender_display
-    => "translation missing: es, Male"
- 
-    >> @john.age_group_display
-    => '18 to 24 years old'
-    >> User.age_group_choices
-    => [['18-24', '18 to 24 years old], ['25-45', '25 to 45 years old']]
-    
-# ToDo
+#### v1.0.1
 
-* Validate absence of _display and _choices methods
-* Consider the usefulness of _choices# method
+* Refactor to eliminate deprecation warnings in Rails 3.1 (@porras)
 
+#### v1.0.0
+
+* Initial release
+
+## ToDo
+
+* Validate absence of _display and _choices methods
 
 Copyright (c) 2009-2011 Christos Zisopoulos, released under the MIT license

data/Rakefile

@@ -0,0 +1,15 @@
+require 'rake'
+require 'rake/testtask'
+require "bundler/gem_tasks"
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the attribute_choices plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+

data/attribute_choices.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "attribute_choices/version"
+
+Gem::Specification.new do |s|
+  s.name    = "attribute_choices"
+  s.version = AttributeChoices::VERSION
+
+  s.authors = ["Christos Zisopoulos"]
+  s.date    = "2011-05-12"
+  s.email   = "christos@me.com"
+
+
+  s.rubyforge_project = "attribute_choices"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.homepage = "http://github.com/christos/attribute_choices"
+
+  s.rdoc_options  = ["--main", "README.md"]
+  s.extra_rdoc_files = ["README.md"]
+  s.summary       = s.description = "Extends ActiveRecord attributes with a `:choices` pseudo-type that provides convenient methods for mapping each choice to its human readable form."
+
+  s.add_development_dependency "rake"
+  s.add_development_dependency "sqlite3"
+
+  s.add_dependency "activesupport"
+  s.add_dependency "activerecord"
+end

data/lib/attribute_choices.rb

@@ -7,7 +7,8 @@ module AttributeChoices
 
   module AttributeChoicesMacro
 
-    # Associate a list of display values for an attribute with a list of discreet values
+    # Extends ActiveRecord attributes with a `:choices` pseudo-type that provides convenient methods for mapping
+    # each choice to its human readable form.
     #
     # The arguments are:
     #
@@ -61,7 +62,7 @@ module AttributeChoices
 
       define_method("#{attribute.to_s}_display") do
         # The local variable `choices` is saved inside this Proc
-        tupple = choices.assoc(read_attribute(attribute))
+        tupple = choices.assoc(send(attribute))
         tupple && tupple.last
       end
 
@@ -74,14 +75,23 @@ module AttributeChoices
       end
 
     end
-    
+
+    #:nodoc:
     def attribute_choices_options
       @attribute_choices_options ||= {}
     end
 
     private
     def assert_valid_attribute(attr_name)
-      unless column_names.include?(attr_name.to_s)
+
+      if /1\.9/.match(RUBY_VERSION)
+        getter = attr_name.to_sym
+        setter ="#{attr_name}=".to_sym
+      else
+        getter = setter = attr_name.to_s
+      end
+
+      unless column_names.include?(attr_name.to_s) || (instance_methods.include?(getter) && instance_methods.include?(setter))
         raise ArgumentError, "Model attribute '#{attr_name.to_s}' doesn't exist" 
       end
     end

data/lib/attribute_choices/version.rb

@@ -0,0 +1,3 @@
+module AttributeChoices
+  VERSION = "1.0.2"
+end

data/tasks/attributes_with_choices_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :attributes_with_choices do
+#   # Task goes here
+# end

data/test/attribute_choices_test.rb

@@ -0,0 +1,142 @@
+require 'test_helper'
+
+class AttributeChoicesTest < ActiveSupport::TestCase
+
+  class Person < ActiveRecord::Base
+    attribute_choices :gender, {'m' => 'Male', 'f' => 'Female'}
+  end
+
+  class Adult < Person
+    attribute_choices :gender , {'m' => 'Man', 'f' => 'Woman', 'o' => 'Other'}
+    attribute_choices :salutation, [
+      ["mr", 'Mister'],
+      ["mrs", 'Misses'],
+      ["ms", 'Miss'],
+    ]
+  end
+
+  test "It should add a class method to all ActiveRecord objects" do
+    assert_respond_to(Person, :attribute_choices)
+  end
+
+  test "It should add a class and an instance method for each attribute" do
+    assert_respond_to(Person, :gender_choices)
+    assert_respond_to(Person.new, :gender_display)
+    
+    assert_raise(NoMethodError) do
+       Object.gender_choices
+    end
+    
+  end
+  
+  test "A child AR object should not share the parent's choices" do
+    assert_not_equal Adult.gender_choices, Person.gender_choices
+  end
+
+  test "Does not allow specifying non-existent attributes" do
+    assert_raise ArgumentError do
+      class Person < ActiveRecord::Base
+        attribute_choices :non_existent_attribute, []
+      end
+    end
+  end
+
+  test "Allow specifying virtual attributes" do
+    assert_nothing_raised do
+      class Person < ActiveRecord::Base
+        attr_accessor :virtual_attribute
+        attribute_choices :virtual_attribute, {'w' => 'Wadus'}
+      end
+    end
+    
+    @person = Person.new(:virtual_attribute => 'w')
+    
+    assert_equal('Wadus', @person.virtual_attribute_display)
+  end
+
+  test "Does not allow invalid option keys" do
+    assert_raise ArgumentError do
+      class Person < ActiveRecord::Base
+        attribute_choices :gender, {'m' => 'Male', 'f' => 'Female'}, :not_a_real_option => true
+      end
+    end
+  end
+
+  test "given a valid value for an attribute the correct display value is returned " do
+    @person = Person.new(:gender => 'm', :salutation => 'mr')
+    assert @person.valid?
+
+    assert_equal 'Male', @person.gender_display
+  end
+
+  test "a localized version of the display value is returned when :localize => true" do
+    class Human < Person
+      attribute_choices :gender, [['m', 'Male'], ['f', 'Female']], :localize => true
+    end
+    @human = Human.new(:gender => 'm', :salutation => 'mr')
+
+    assert_equal I18n.translate('Male'), @human.gender_display
+  end
+
+  test "a localized version of the attribute choices is returned when :localize => true" do
+    class Human < Person
+      attribute_choices :gender, [['m', 'Male'], ['f', 'Female']], :localize => true
+    end
+    @human = Human.new(:gender => 'm', :salutation => 'mr')
+
+    assert_equal [[I18n.translate('Male'), 'm'], [I18n.translate('Female'), 'f']], Human.gender_choices
+  end
+
+  test "nil is returned as the display value of an attribute without a value to display mapping" do
+    @adult = Adult.new(:salutation => 'master')
+    assert_nil @adult.salutation_display
+
+    @adult.gender = 'unknown'
+    assert_nil @adult.gender_display
+
+  end
+
+  test "Multiple calls to attribute_choices update the attribute choices" do
+    class Medic < Adult; end
+    assert_equal [['Mister', 'mr'], ['Misses', 'mrs'], ["Miss", 'ms']], Medic.salutation_choices
+
+    class Medic < Adult
+      attribute_choices :salutation, [ ["dr", 'Doctor'] ]
+    end
+
+    assert_equal [ ['Doctor', 'dr'] ], Medic.salutation_choices
+  end
+
+  test "It should store an options Hash if passed as the the optional third parameter" do
+    class Person < ActiveRecord::Base
+      attribute_choices :gender, {'m' => 'Male', 'f' => 'Female'}, :localize => true, :validate => false
+    end
+    assert_equal Hash[:localize, true, :validate, false], Person.attribute_choices_options[:gender]
+  end
+
+  test "Default values are assigned for any options that are not specified" do
+    class Person < ActiveRecord::Base
+      attribute_choices :gender, {'m' => 'Male', 'f' => 'Female'}, :localize => true
+    end
+
+    assert_equal Hash[:localize, true, :validate, false], Person.attribute_choices_options[:gender]
+  end
+
+  test "Doesn't validate inclusion of attribute value in choices values by default" do
+    @person = Person.new(:gender => 'trans', :salutation => 'mr')
+    assert @person.valid?
+  end
+
+  test "Validates inclusion of attribute value in choices values when :localize => true" do
+    class Person < ActiveRecord::Base
+      attribute_choices :gender, {'m' => 'Male', 'f' => 'Female'}, :validate => true
+    end
+
+    @person = Person.new(:gender => 'm', :salutation => 'mr')
+    assert @person.valid?
+
+    @person.gender = 'trans'
+    assert !@person.valid?
+  end
+
+end

data/test/database.yml

@@ -0,0 +1,3 @@
+sqlite3mem:
+  :adapter: sqlite3
+  :database: ":memory:"

data/test/schema.rb

@@ -0,0 +1,22 @@
+# This file is auto-generated from the current state of the database. Instead of editing this file, 
+# please use the migrations feature of Active Record to incrementally modify your database, and
+# then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your database schema. If you need
+# to create the application database on another system, you should be using db:schema:load, not running
+# all the migrations from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended to check this file into your version control system.
+
+ActiveRecord::Schema.define(:version => 20090418155608) do
+
+  create_table "people", :force => true do |t|
+    t.string   "salutation"
+    t.string   "name"
+    t.string   "gender"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,19 @@
+ENV["RAILS_ENV"] = "test"
+
+require 'rubygems'
+
+require 'attribute_choices'
+
+require 'test/unit'
+
+require 'active_support/test_case'
+require 'active_record/fixtures'
+
+
+config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
+ActiveRecord::Base.establish_connection(config[ENV['DB'] || 'sqlite3mem'])
+
+ActiveRecord::Migration.verbose = false
+load(File.dirname(__FILE__) + "/schema.rb")
+

metadata

@@ -1,8 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: attribute_choices
 version: !ruby/object:Gem::Version 
+  hash: 19
   prerelease: 
-  version: 1.0.1
+  segments: 
+  - 1
+  - 0
+  - 2
+  version: 1.0.2
 platform: ruby
 authors: 
 - Christos Zisopoulos
@@ -10,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-12 00:00:00 +02:00
-default_executable: 
+date: 2011-05-12 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake
@@ -21,6 +25,9 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
   type: :development
   version_requirements: *id001
@@ -32,6 +39,9 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
   type: :development
   version_requirements: *id002
@@ -43,6 +53,9 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
   type: :runtime
   version_requirements: *id003
@@ -54,10 +67,13 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
   type: :runtime
   version_requirements: *id004
-description: AttributeChoices is a plugin that simplifies the common pattern of mapping a set of discreet values for an ActiveRecord model attribute, to a set of display values for human consumption.
+description: Extends ActiveRecord attributes with a `:choices` pseudo-type that provides convenient methods for mapping each choice to its human readable form.
 email: christos@me.com
 executables: []
 
@@ -66,10 +82,21 @@ extensions: []
 extra_rdoc_files: 
 - README.md
 files: 
+- .gitignore
+- .travis.yml
+- Gemfile
+- Gemfile.lock
 - License.md
 - README.md
+- Rakefile
+- attribute_choices.gemspec
 - lib/attribute_choices.rb
-has_rdoc: true
+- lib/attribute_choices/version.rb
+- tasks/attributes_with_choices_tasks.rake
+- test/attribute_choices_test.rb
+- test/database.yml
+- test/schema.rb
+- test/test_helper.rb
 homepage: http://github.com/christos/attribute_choices
 licenses: []
 
@@ -84,19 +111,28 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
 requirements: []
 
-rubyforge_project: 
-rubygems_version: 1.6.2
+rubyforge_project: attribute_choices
+rubygems_version: 1.8.9
 signing_key: 
 specification_version: 3
-summary: AttributeChoices is a plugin that simplifies the common pattern of mapping a set of discreet values for an ActiveRecord model attribute, to a set of display values for human consumption.
-test_files: []
-
+summary: Extends ActiveRecord attributes with a `:choices` pseudo-type that provides convenient methods for mapping each choice to its human readable form.
+test_files: 
+- test/attribute_choices_test.rb
+- test/database.yml
+- test/schema.rb
+- test/test_helper.rb