attr_enumerator 0.3.0 → 0.4.0

data/README.rdoc

@@ -1,66 +1,76 @@
 = attr_enumerator
 
-A customizable method for restricting an attribute to a set of choices. By default, <tt>attr_enumerator</tt> will create:
+A method for restricting an attribute to a set of choices.
 
-* A <b>validation</b> requiring the attribute value to be one of the choices
-* A <b>class constant</b> containing all choices
+An invocation of <tt>attr_enumerator</tt> will create:
+
+* A <b>validation</b> requiring the attribute value to be one of the provided choices
+* A <b>class constant</b> containing all valid choices
 * <b>Instance methods</b> for each choice, returning <tt>true</tt> if the attribute is that value and <tt>false</tt> otherwise
 * <b>Scopes</b> for each choice that retrieve records where the attribute is that value (only applicable when used with <tt>ActiveRecord</tt>)
 
-<tt>AttrEnumerator</tt> is automatically included in <tt>ActiveRecord::Base</tt> and is available for use in <tt>ActiveRecord</tt> models. 
+== Example
 
   class Car < ActiveRecord::Base
-    attr_enumerator :color, ["red", "blue"]
+    attr_enumerator :color, ['red', 'blue']
   end
 
-To use <tt>attr_enumerator</tt> on a class that does not descend from <tt>ActiveRecord::Base</tt> it must include <tt>ActiveModel::Validations</tt> and provide an accessor to the attribute.
+  car = Car.new
+  car.color = 'red'
+
+  car.color_red?      # => true
+  car.color_blue?     # => false
+
+  Car::COLORS         # => ['red', 'blue']
+
+  car.save
+  Car.color_red       # => [<#Car>]
+
+  car.color = 'green'
+  car.valid?          # => false
+  car.errors          # => #<OrderedHash {:color=>["is invalid"]}>
+
+== With or without ActiveRecord
+
+The <tt>AttrEnumerator</tt> module is automatically included in <tt>ActiveRecord::Base</tt> and is available for use in all ActiveRecord models.
+
+To use <tt>attr_enumerator</tt> on a non-ActiveRecord model the class must include <tt>ActiveModel::Validations</tt> and provide an accessor to the attribute.
 
   class Car
     include ActiveModel::Validations
     include AttrEnumerator
 
     attr_accessor :color
-    attr_enumerator :color, ["red", "blue"]
+    attr_enumerator :color, ['red', 'blue']
   end
 
 == Configuration
 
-Options may be passed to <tt>attr_enumerator</tt> to configure its behavior. For instance, use <tt>:create_constant => false</tt> to prevent a class constant from being created.
+An options hash may be passed as the last argument to <tt>attr_enumerator</tt> to configure its behavior. For example:
 
   class Car < ActiveRecord::Base
-    attr_enumerator :color, ["red", "blue"], :create_constant => false
+    attr_enumerator :color, ['red', 'blue'], :constant => :PAINT_COLORS, :prefix => :colored
   end
 
-Options that may be passed directly to <tt>attr_enumerator</tt> may also be configured globally. Options passed directly to <tt>attr_enumerator</tt> will override global options.
+  Car::PAINT_COLORS # => ['red', 'blue']
 
-  AttrEnumerator::Options.configure do |config|
-    config.create_constant = false
-  end
+  car = Car.new
+  car.color = 'red'
+  car.colored_red?  # => true
 
 === Options
-* <tt>create_constant</tt> (default: <tt>true</tt>)
-
-  When <tt>true</tt>, a class constant containing an array of choices is created using the pluralized, uppercased attribute name. Set to a string or symbol to change the constant name or <tt>false</tt> to not create the constant.
-  
-* <tt>create_methods</tt> (default: <tt>true</tt>)
-
-  When <tt>true</tt>, create a method for each choice that returns <tt>true</tt> if the attribute is that value and <tt>false</tt> otherwise. Use the <tt>prefix</tt> and <tt>suffix</tt> options to customize the method names. Set to <tt>false</tt> to not create methods.
-
-* <tt>create_scopes</tt> (default: <tt>true</tt>, ignored when not using <tt>ActiveRecord</tt>)
 
-  When <tt>true</tt>, create a scope for each choice that retrieves records where the attribute is that value. Use the <tt>prefix</tt> and <tt>suffix</tt> options to customize the scope names. Set to <tt>false</tt> to not create scopes.
+* <tt>constant</tt> (default: pluralized, uppercased attribute name)
 
-* <tt>prefix</tt> (default: <tt>true</tt>)
+  Set a custom constant name.
 
-  When <tt>true</tt>, prefixes created methods and scopes with the attribute name. Set to a string or symbol to change the prefix or <tt>false</tt> to disable.
-  
-* <tt>suffix</tt> (default: <tt>false</tt>)
+* <tt>prefix</tt> (default: attribute name)
 
-  See <tt>prefix</tt>.
+  Set a custom prefix for methods and scopes. Set to <tt>false</tt> to disable.
 
-* <tt>message</tt> (default: <tt>"is invalid"</tt>)
+* <tt>message</tt> (default: internationalized <tt>"is invalid"</tt>)
 
-  Specifies the error message when the attribute is not a valid value. Use <tt>%{value}</tt> to refer to the value of the attribute, e.g. <tt>"%{value} is not a valid choice"</tt>.
+  Set the validation error message when the attribute is not a valid value. Use <tt>%{value}</tt> to refer to the value of the attribute, e.g. <tt>"%{value} is not a valid choice"</tt>.
 
 * <tt>allow_nil</tt> (default: <tt>false</tt>)
 
@@ -72,11 +82,11 @@ Options that may be passed directly to <tt>attr_enumerator</tt> may also be conf
 
 * <tt>if</tt> (default: unused)
 
-  Specifies a method, proc or string to call to determine if the validation should occur. See <tt>ActiveModel::Validations</tt> for more details.
+  Set a method, proc or string to call to determine if the validation should occur. See <tt>ActiveModel::Validations</tt> for more details.
 
-* <tt>unless</tt>
+* <tt>unless</tt> (default: unused)
 
-  Opposite of <tt>if</tt>.
+  Set a method, proc or string to call to determine if the validation should <em>not</em> occur.
 
 == Contributing to attr_enumerator
 
@@ -86,4 +96,3 @@ Options that may be passed directly to <tt>attr_enumerator</tt> may also be conf
 * Start a feature/bugfix branch
 * Commit and push until you are happy with your contribution
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

data/Rakefile

@@ -15,9 +15,9 @@ Jeweler::Tasks.new do |gem|
   gem.name = "attr_enumerator"
   gem.homepage = "http://github.com/chrisb87/attr_enumerator"
   gem.license = "MIT"
-  gem.summary = %Q{Enumerated attributes for ActiveModel}
-  gem.description = %Q{Enumerated attributes for ActiveModel}
-  gem.email = "baker@socialvibe.com"
+  gem.summary = %Q{A method for restricting an attribute to a set of choices}
+  gem.description = %Q{A method for restricting an attribute to a set of choices}
+  gem.email = "baker.chris.3@gmail.com"
   gem.authors = ["Chris Baker"]
 end
 Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0

data/attr_enumerator.gemspec

@@ -5,13 +5,13 @@
 
 Gem::Specification.new do |s|
   s.name = %q{attr_enumerator}
-  s.version = "0.3.0"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Chris Baker"]
-  s.date = %q{2011-03-25}
-  s.description = %q{Enumerated attributes for ActiveModel}
-  s.email = %q{baker@socialvibe.com}
+  s.date = %q{2011-05-06}
+  s.description = %q{A method for restricting an attribute to a set of choices}
+  s.email = %q{baker.chris.3@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.rdoc"
@@ -33,15 +33,10 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/chrisb87/attr_enumerator}
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Enumerated attributes for ActiveModel}
-  s.test_files = [
-    "spec/attr_enumerator_spec.rb",
-    "spec/spec_helper.rb"
-  ]
+  s.rubygems_version = %q{1.7.2}
+  s.summary = %q{A method for restricting an attribute to a set of choices}
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then

data/lib/attr_enumerator.rb

@@ -5,69 +5,29 @@ module AttrEnumerator
   extend ActiveSupport::Concern
 
   module ClassMethods
-    def attr_enumerator(field, choices, opts={})
-      options = Options.parse(field, choices, opts, self)
+    def attr_enumerator(field, choices, options = {})
+      constant = options.delete(:constant) || field.to_s.pluralize.upcase
+      const_set(constant, choices).freeze
 
-      validates field, :inclusion => options[:validation_options]
+      raw_prefix = options.delete(:prefix)
 
-      if options[:create_constant]
-        const_set(options[:constant], choices).freeze
+      prefix = case raw_prefix
+      when false, '' then ''
+      when nil then field.to_s + '_'
+      else raw_prefix.to_s + '_'
       end
 
-      options[:formatted_choices].each do |formatted_choice, choice|
-        if options[:create_methods]
-          define_method(formatted_choice + '?'){ self.send(field) == choice }
-        end
+      choices.each do |choice|
+        formated_choice = prefix + choice.to_s.underscore.parameterize('_')
 
-        if options[:create_scopes]
-          scope formatted_choice, where(field => choice)
-        end
+        define_method(formated_choice + '?') { self.send(field) == choice }
+        scope formated_choice, where(field => choice) if self.respond_to?(:scope)
       end
-    end
-  end
-
-  class Options
-    include ActiveSupport::Configurable
-
-    config.create_constant  = true
-    config.create_methods   = true
-    config.create_scopes    = true
-    config.prefix           = true
-    config.suffix           = false
-    config.message          = :invalid
-
-    VALIDATION_OPTIONS = [:in, :message, :allow_nil, :allow_blank, :if, :unless].freeze
 
-    def self.parse(field, choices, opts, klass)
-      {}.merge!(config).merge!(opts).merge!(:in => choices).tap do |options|
-        options[:validation_options] = options.slice(*VALIDATION_OPTIONS)
-        options.reject!{|k,v| VALIDATION_OPTIONS.include?(k)}
-
-        options[:create_scopes] &= klass.respond_to?(:scope)
-
-        [:prefix, :suffix].each do |affix|
-          options[affix] = case options[affix]
-          when true then field.to_s
-          when false then nil
-          else options[affix].to_s
-          end
-        end
-
-        options[:constant] = case options[:create_constant]
-        when true then field.to_s.pluralize.upcase
-        when false then nil
-        else options[:create_constant].to_s
-        end
-
-        options[:formatted_choices] = choices.map do |choice|
-          formatted_choice = choice.to_s.underscore.parameterize('_')
-          formatted_choice.insert(0, options[:prefix] + '_') unless options[:prefix].blank?
-          formatted_choice << '_' + options[:suffix] unless options[:suffix].blank?
-          [formatted_choice, choice]
-        end
-      end
+      options[:message] ||= :invalid
+      validates field, :inclusion => options.merge(:in => choices)
     end
   end
 end
 
-ActiveRecord::Base.class_eval { include AttrEnumerator } if defined? ActiveRecord
+ActiveSupport.on_load(:active_record) { include AttrEnumerator }

data/spec/attr_enumerator_spec.rb

@@ -69,7 +69,7 @@ describe "AttrEnumerator" do
         instance.should_not be_valid
       end
 
-      it "should handle symbols as enumerations" do
+      it "should handle symbol enumerations distinctively from strings" do
         subject.attr_enumerator :choice, [:red, :blue]
 
         instance.choice = :red
@@ -78,6 +78,7 @@ describe "AttrEnumerator" do
 
         instance.choice = 'red'
         instance.should_not be_valid
+        instance.should_not be_choice_red
       end
     end
 
@@ -92,25 +93,15 @@ describe "AttrEnumerator" do
         subject::CHOICES.should be_frozen
       end
 
-      it "should allow for explicitly creating the default constant" do
-        subject.attr_enumerator :choice, ['red', 'blue'], :create_constant => true
-        subject::CHOICES.should == ['red', 'blue']
-      end
-
       it "should allow for a custom constant name using a symbol" do
-        subject.attr_enumerator :choice, ['red', 'blue'], :create_constant => :POSSIBLE_COLORS
+        subject.attr_enumerator :choice, ['red', 'blue'], :constant => :POSSIBLE_COLORS
         subject::POSSIBLE_COLORS.should == ['red', 'blue']
       end
 
       it "should allow for a custom constant name using a string" do
-        subject.attr_enumerator :choice, ['red', 'blue'], :create_constant => 'POSSIBLE_COLORS'
+        subject.attr_enumerator :choice, ['red', 'blue'], :constant => 'POSSIBLE_COLORS'
         subject::POSSIBLE_COLORS.should == ['red', 'blue']
       end
-
-      it "should allow for not creating a constant" do
-        subject.attr_enumerator :choice, ['red', 'blue'], :create_constant => false
-        subject.constants.should_not include('COLORS')
-      end
     end
 
     context "methods" do
@@ -135,26 +126,13 @@ describe "AttrEnumerator" do
           :ends_with_dot? => 'ends.with.dot.'
         }
 
-        subject.attr_enumerator :choice, enumerations.values, :prefix => false, :suffix => false
+        subject.attr_enumerator :choice, enumerations.values, :prefix => false
 
         enumerations.keys.each do |method_name|
           instance.should respond_to method_name
         end
       end
 
-      it "should allow for explicitly creating the default methods" do
-        subject.attr_enumerator :choice, ['red', 'blue'], :create_methods => true
-        instance.choice = 'red'
-
-        instance.should respond_to :choice_red?
-        instance.should be_choice_red
-      end
-
-      it "should allow for not creating methods" do
-        subject.attr_enumerator :choice, ['red', 'blue'], :create_methods => false
-        instance.should_not respond_to :choice_red?
-      end
-
       it "should allow for a custom prefix" do
         subject.attr_enumerator :choice, ['red', 'blue'], :prefix => 'colored'
         instance.choice = 'red'
@@ -166,34 +144,15 @@ describe "AttrEnumerator" do
         instance.should_not be_colored_blue
       end
 
-      it "should allow for explicitly using the default prefix" do
-        subject.attr_enumerator :choice, ['red', 'blue'], :prefix => true
-        instance.should respond_to :choice_red?
-      end
-
       it "should allow for no prefix" do
         subject.attr_enumerator :choice, ['red', 'blue'], :prefix => false
-        instance.should respond_to :red?
-      end
-
-      it "should not have a suffix by default" do
-        subject.attr_enumerator :choice, ['red', 'blue']
-        instance.should respond_to :choice_red?
-      end
-
-      it "should allow for explicitly having no suffix" do
-        subject.attr_enumerator :choice, ['red', 'blue'], :suffix => false
-        instance.should respond_to :choice_red?
-      end
+        instance.choice = 'red'
 
-      it "should use the field as a suffix when :suffix is true" do
-        subject.attr_enumerator :choice, ['red', 'blue'], :suffix => true
-        instance.should respond_to :choice_red_choice?
-      end
+        instance.should respond_to :red?
+        instance.should be_red
 
-      it "should allow for a custom suffix" do
-        subject.attr_enumerator :choice, ['red', 'blue'], :suffix => 'custom'
-        instance.should respond_to :choice_red_custom?
+        instance.should respond_to :blue?
+        instance.should_not be_blue
       end
     end
   end
@@ -210,19 +169,19 @@ describe "AttrEnumerator" do
     end
 
     describe "scopes" do
-      it "should create a scope for each enumeration by default" do
+      it "should create a scope for each enumeration" do
         subject.attr_enumerator :choice, ['red', 'blue']
         subject.choice_red.should be_a ActiveRecord::Relation
       end
 
-      it "should allow for explicitly creating scopes" do
-        subject.attr_enumerator :choice, ['red', 'blue'], :create_scopes => true
-        subject.choice_red.should be_a ActiveRecord::Relation
+      it "should create a scope for each enumeration with custom prefix " do
+        subject.attr_enumerator :choice, ['red', 'blue'], :prefix => 'colored'
+        subject.colored_red.should be_a ActiveRecord::Relation
       end
 
-      it "should allow for not creating scopes" do
-        subject.attr_enumerator :choice, ['red', 'blue'], :create_scopes => false
-        subject.should_not respond_to :choice_red
+      it "should create a scope for each enumeration without prefix " do
+        subject.attr_enumerator :choice, ['red', 'blue'], :prefix => false
+        subject.red.should be_a ActiveRecord::Relation
       end
     end
   end

data/spec/spec_helper.rb

@@ -1,13 +1,6 @@
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'rspec'
 require 'active_record'
 require 'attr_enumerator'
 
-# Requires supporting files with custom matchers and macros, etc,
-# in ./support/ and its subdirectories.
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
-
 class ActiveRecordModel < ActiveRecord::Base
   establish_connection(:adapter => 'sqlite3', :database => ':memory:')
   connection.execute("CREATE TABLE #{table_name} (#{primary_key} integer PRIMARY KEY AUTOINCREMENT)")

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: attr_enumerator
 version: !ruby/object:Gem::Version 
-  hash: 19
-  prerelease: false
+  hash: 15
+  prerelease: 
   segments: 
   - 0
-  - 3
+  - 4
   - 0
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Chris Baker
@@ -15,14 +15,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-25 00:00:00 -07:00
-default_executable: 
+date: 2011-05-06 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   type: :runtime
-  prerelease: false
-  name: activemodel
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -33,12 +30,12 @@ dependencies:
         - 0
         - 0
         version: 3.0.0
-  requirement: *id001
+  version_requirements: *id001
+  name: activemodel
+  prerelease: false
 - !ruby/object:Gem::Dependency 
   type: :runtime
-  prerelease: false
-  name: activesupport
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -49,12 +46,12 @@ dependencies:
         - 0
         - 0
         version: 3.0.0
-  requirement: *id002
+  version_requirements: *id002
+  name: activesupport
+  prerelease: false
 - !ruby/object:Gem::Dependency 
   type: :development
-  prerelease: false
-  name: activerecord
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -65,12 +62,12 @@ dependencies:
         - 0
         - 0
         version: 3.0.0
-  requirement: *id003
+  version_requirements: *id003
+  name: activerecord
+  prerelease: false
 - !ruby/object:Gem::Dependency 
   type: :development
-  prerelease: false
-  name: jeweler
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -79,12 +76,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id004
+  version_requirements: *id004
+  name: jeweler
+  prerelease: false
 - !ruby/object:Gem::Dependency 
   type: :development
-  prerelease: false
-  name: rspec
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -95,12 +92,12 @@ dependencies:
         - 5
         - 0
         version: 2.5.0
-  requirement: *id005
+  version_requirements: *id005
+  name: rspec
+  prerelease: false
 - !ruby/object:Gem::Dependency 
   type: :development
-  prerelease: false
-  name: ruby-debug
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -109,12 +106,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id006
+  version_requirements: *id006
+  name: ruby-debug
+  prerelease: false
 - !ruby/object:Gem::Dependency 
   type: :development
-  prerelease: false
-  name: sqlite3
-  version_requirements: &id007 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -123,12 +120,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id007
+  version_requirements: *id007
+  name: sqlite3
+  prerelease: false
 - !ruby/object:Gem::Dependency 
   type: :development
-  prerelease: false
-  name: watchr
-  version_requirements: &id008 !ruby/object:Gem::Requirement 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -137,9 +134,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id008
-description: Enumerated attributes for ActiveModel
-email: baker@socialvibe.com
+  version_requirements: *id008
+  name: watchr
+  prerelease: false
+description: A method for restricting an attribute to a set of choices
+email: baker.chris.3@gmail.com
 executables: []
 
 extensions: []
@@ -160,7 +159,6 @@ files:
 - spec/attr_enumerator_spec.rb
 - spec/spec_helper.rb
 - watchr.rb
-has_rdoc: true
 homepage: http://github.com/chrisb87/attr_enumerator
 licenses: 
 - MIT
@@ -190,10 +188,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
-summary: Enumerated attributes for ActiveModel
-test_files: 
-- spec/attr_enumerator_spec.rb
-- spec/spec_helper.rb
+summary: A method for restricting an attribute to a set of choices
+test_files: []
+