attribute_choices 1.0.0

data/License.md

@@ -0,0 +1,23 @@
+Copyright (c) 2009-2011 Christos Zisopoulos ( [@christos](http://twitter.com/christos) )
+========================================================================================
+
+The "attribute_choices" plugin is released under the **MIT LICENSE**
+--------------------------------------------------------------------
+
+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 NON-INFRINGEMENT. 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,62 @@
+# 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.
+
+# Installation
+
+## Rails 3
+
+  In your `Gemfile` add
+  
+    gem 'attribute_choices'
+
+## Rails 2
+
+  In `environment.rb` add:
+    
+    config.gem 'attribute_choices'
+
+# Usage
+
+Define your model:
+
+    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
+
+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
+
+* Validate absence of _display and _choices methods
+* Consider the usefulness of _choices# method
+
+
+Copyright (c) 2009-2011 Christos Zisopoulos, released under the MIT license

data/lib/attribute_choices.rb

@@ -0,0 +1,90 @@
+module AttributeChoices
+  def self.included(base) #:nodoc:
+    base.extend(AttributeChoicesMacro)
+  end
+
+  module AttributeChoicesMacro
+
+    # Associate a list of display values for an attribute with a list of discreet values
+    #
+    # The arguments are:
+    #
+    # * +attribute+ - The attribute whose values you want to map to display values
+    # * +choices+ - Either an +Array+ of tupples where the first value of the tupple is the attribute \
+    #               value and the second one is the display value mapping, or a +Hash+ where the key is the \
+    #               attribute value and the value is the display value mapping.
+    # * <tt>options</tt> - An optional hash of options:
+    #   * <tt>:localize</tt> - If set to +true+, then <tt>I18n.trasnlate</tt> is used to translate the value \
+    #                          returned by the +_display+ instance methods as well as translate the display \
+    #                          values returned by the +_choices+ class method
+    #   * <tt>:validate</tt> - If set to +true+, +validates_inclusion_of+ is used to ensure that the attribute \
+    #                          only accepts the values passed in with the +choices+
+    #
+    # For example:
+    #   class User < ActiveRecord::Base
+    #     attribute_choices :gender,  { 'm' => "Male", 'f' => 'Female'}
+    #     attribute_choices :age_group,  [
+    #       ['18-24', '18 to 24 years old], 
+    #       ['25-45', '25 to 45 years old']
+    #     ], :localize => true, :validate => false
+    #   end
+    #
+    # The macro adds an instance method named after the attribute, suffixed with <tt>_display</tt>
+    # (e.g. <tt>gender_display</tt> for <tt>:gender</tt>) that returns the display value of the
+    # attribute for a given value, or <tt>nil</tt> if a mapping for a value is missing.
+    # 
+    # It also adds a class method named after the attribute, suffixed with <tt>_choices</tt>
+    # (e.g. <tt>User.gender_choices</tt> for <tt>:gender</tt>) that returns an array of choices and values
+    # in a fomrat that is suitable for passing directly to the Rails <tt>select_*</tt> helpers.
+    #
+    # NOTE: You can use a Hash for the +choices+ argument which is converted to an Array. The order of the \
+    # tupples of the resulting Array is only guaranteed to be preserved if you are using Ruby 1.9
+    def attribute_choices(attribute, choices, *args)
+
+      assert_valid_attribute(attribute.to_s)
+
+      write_inheritable_hash :attribute_choices_storage, {}
+      class_inheritable_reader :attribute_choices_storage
+
+      write_inheritable_hash :attribute_choices_options,  {}
+      class_inheritable_reader :attribute_choices_options
+
+      attribute = attribute.to_sym
+
+      options = args.extract_options!
+      options.reverse_merge!(:validate => false, :localize => false)
+      options.assert_valid_keys(:validate, :localize)
+      attribute_choices_options[attribute.to_sym] = options
+
+      if options[:localize]
+        attribute_choices_storage[attribute] = choices.to_a.collect {|t| [t.first, I18n.translate(t.last)]}
+      else
+        attribute_choices_storage[attribute] = choices.to_a
+      end
+
+      define_method("#{attribute.to_s}_display") do
+        tupple = attribute_choices_storage[attribute].assoc(read_attribute(attribute))
+        tupple && tupple.last
+      end
+
+      (class << self; self; end).send(:define_method, "#{attribute.to_s}_choices") do
+        attribute_choices_storage[attribute].collect(&:reverse)
+      end
+
+      if column_names.include?(attribute.to_s) && options[:validate]
+        validates_inclusion_of attribute.to_sym, :in => attribute_choices_storage[attribute].collect {|i| i.first}
+      end
+
+    end
+
+    private
+    def assert_valid_attribute(attr_name)
+      unless column_names.include?(attr_name.to_s)
+        raise ArgumentError, "Model attribute '#{attr_name.to_s}' doesn't exist" 
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, AttributeChoices) 
+

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification 
+name: attribute_choices
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Christos Zisopoulos
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-12 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    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.
+email: christos@me.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- License.md
+- README.md
+- lib/attribute_choices.rb
+has_rdoc: true
+homepage: http://github.com/christos/attribute_choices
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.md
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  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
+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: []
+