attr_enumerator 0.4.1 → 0.5.0

data/README.rdoc

@@ -4,10 +4,10 @@ A method for restricting an attribute to a set of 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>)
+* a <b>class constant</b> containing all valid choices
+* a <b>validation</b> requiring the attribute's value to be one of the 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
 
 == Example
 
@@ -15,26 +15,30 @@ An invocation of <tt>attr_enumerator</tt> will create:
     attr_enumerator :color, ['red', 'blue']
   end
 
+  # constant
+  Car::COLORS           # => ['red', 'blue']
+
+  # validation
   car = Car.new
+  car.color = 'green'
+  car.valid?            # => false
+  car.errors            # => {:color => ["is invalid"]}
   car.color = 'red'
+  car.valid?            # => true
 
-  car.color_red?      # => true
-  car.color_blue?     # => false
-
-  Car::COLORS         # => ['red', 'blue']
+  # instance methods
+  car.red?              # => true
+  car.blue?             # => false
 
+  # scopes
   car.save
-  Car.color_red       # => [<#Car>]
-
-  car.color = 'green'
-  car.valid?          # => false
-  car.errors          # => #<OrderedHash {:color=>["is invalid"]}>
+  Car.red               # => [<#Car>]
 
 == 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.
+The <tt>AttrEnumerator</tt> module will be automatically included in <tt>ActiveRecord::Base</tt>, making the <tt>attr_enumerator</tt> method available 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.
+To include <tt>AttrEnumerator</tt> on a non-ActiveRecord model the class must also include <tt>ActiveModel::Validations</tt> and provide an accessor to the attribute. The model will have all the above functionality except no scopes will be generated.
 
   class Car
     include ActiveModel::Validations
@@ -46,17 +50,17 @@ To use <tt>attr_enumerator</tt> on a non-ActiveRecord model the class must inclu
 
 == Configuration
 
-An options hash may be passed as the last argument to <tt>attr_enumerator</tt> to configure its behavior. For example:
+Options 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'], :constant => :PAINT_COLORS, :prefix => :colored
+    attr_enumerator :color, ['red', 'blue'], :constant => :PAINT_COLORS, :prefix => :painted
   end
 
-  Car::PAINT_COLORS # => ['red', 'blue']
+  Car::PAINT_COLORS   # => ['red', 'blue']
 
   car = Car.new
   car.color = 'red'
-  car.colored_red?  # => true
+  car.painted_red?    # => true
 
 === Options
 
@@ -64,30 +68,22 @@ An options hash may be passed as the last argument to <tt>attr_enumerator</tt> t
 
   Set a custom constant name.
 
-* <tt>prefix</tt> (default: attribute name)
+* <tt>prefix</tt> (default: <tt>nil</tt>)
 
-  Set a custom prefix for methods and scopes. Set to <tt>false</tt> to disable.
+  Set a prefix for generated methods and scopes.
 
 * <tt>message</tt> (default: internationalized <tt>"is invalid"</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>)
+* <tt>allow_nil</tt> / <tt>allow_blank</tt> (default: <tt>false</tt>)
 
-  Allow the attribute to be <tt>nil</tt>.
+  Do not fail validation when the attribute is <tt>nil</tt> or blank.
 
-* <tt>allow_blank</tt> (default: <tt>false</tt>)
-
-  Allow the attribute to be blank.
-
-* <tt>if</tt> (default: unused)
+* <tt>if</tt> / <tt>unless</tt> (default: unused)
 
   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> (default: unused)
-
-  Set a method, proc or string to call to determine if the validation should <em>not</em> occur.
-
 == Contributing to attr_enumerator
 
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet

data/VERSION

@@ -1 +1 @@
-0.4.1
+0.5.0

data/attr_enumerator.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{attr_enumerator}
-  s.version = "0.4.1"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Chris Baker"]
-  s.date = %q{2011-05-06}
+  s.date = %q{2011-07-07}
   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 = [

data/lib/attr_enumerator.rb

@@ -5,27 +5,19 @@ module AttrEnumerator
   extend ActiveSupport::Concern
 
   module ClassMethods
-    def attr_enumerator(field, choices, options = {})
-      constant = options.delete(:constant) || field.to_s.pluralize.upcase
+    def attr_enumerator(attribute, choices, options = {})
+      constant = options.delete(:constant) || attribute.to_s.pluralize.upcase
+      prefix = options[:prefix] ? options.delete(:prefix).to_s + '_' : ''
+      options[:message] ||= :invalid
+      
       const_set(constant, choices).freeze
-
-      raw_prefix = options.delete(:prefix)
-
-      prefix = case raw_prefix
-      when false, '' then ''
-      when nil then field.to_s + '_'
-      else raw_prefix.to_s + '_'
-      end
+      validates_inclusion_of attribute, options.merge(:in => choices)
 
       choices.each do |choice|
-        formatted_choice = prefix + choice.to_s.underscore.parameterize('_')
-
-        define_method(formatted_choice + '?') { self.send(field) == choice }
-        scope formatted_choice, where(field => choice) if self.respond_to? :scope
+        choice_string = prefix + choice.to_s.underscore.parameterize('_')
+        define_method(choice_string + '?') { send(attribute) == choice }
+        scope choice_string, where(attribute => choice) if respond_to? :scope
       end
-
-      options[:message] ||= :invalid
-      validates field, :inclusion => options.merge(:in => choices)
     end
   end
 end

data/spec/attr_enumerator_spec.rb

@@ -1,119 +1,110 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe "AttrEnumerator" do
-  subject { TestModel }
-
-  def instance
-    @instance ||= subject.new
-  end
-
-  after(:each) do
-    begin
-      Object.send(:remove_const, :TestModel)
-    rescue NameError
-    end
-  end
+  let(:car)     { Car.new }
 
   context "without ActiveRecord" do
     before(:each) do
-      class TestModel
+      class Car
         include ActiveModel::Validations
         include AttrEnumerator
-        attr_accessor :choice
+        attr_accessor :color
       end
     end
+    
+    after(:each)  { Object.send(:remove_const, :Car) }
 
     context "validation" do
       it "should pass when the value is one of the choices" do
-        subject.attr_enumerator :choice, ['red', 'blue']
-        instance.choice = 'blue'
-        instance.should be_valid
+        Car.attr_enumerator :color, ['red', 'blue']
+        car.color = 'blue'
+        car.should be_valid
       end
 
       it "should fail when the value is not one of the choices" do
-        subject.attr_enumerator :choice, ['red', 'blue']
-        instance.choice = 'green'
-        instance.should_not be_valid
+        Car.attr_enumerator :color, ['red', 'blue']
+        car.color = 'green'
+        car.should_not be_valid
       end
 
       it "should have a default message" do
-        subject.attr_enumerator :choice, ['red', 'blue']
-        instance.valid?
-        instance.errors.should == {:choice => ['is invalid']}
+        Car.attr_enumerator :color, ['red', 'blue']
+        car.valid?
+        car.errors.should == {:color => ['is invalid']}
       end
 
       it "should allow for a custom message" do
-        subject.attr_enumerator :choice, ['red', 'blue'], :message => '%{value} is not a valid color'
-        instance.choice = 'green'
-        instance.valid?
-        instance.errors.should == {:choice => ['green is not a valid color']}
+        Car.attr_enumerator :color, ['red', 'blue'], :message => '%{value} is not a valid color'
+        car.color = 'green'
+        car.valid?
+        car.errors.should == {:color => ['green is not a valid color']}
       end
 
       it "should handle allow_blank" do
-        subject.attr_enumerator :choice, ['red', 'blue'], :allow_blank => true
+        Car.attr_enumerator :color, ['red', 'blue'], :allow_blank => true
 
-        instance.choice = nil
-        instance.should be_valid
+        car.color = nil
+        car.should be_valid
 
-        instance.choice = ''
-        instance.should be_valid
+        car.color = ''
+        car.should be_valid
       end
 
       it "should handle allow_nil" do
-        subject.attr_enumerator :choice, ['red', 'blue'], :allow_nil => true
+        Car.attr_enumerator :color, ['red', 'blue'], :allow_nil => true
 
-        instance.choice = nil
-        instance.should be_valid
+        car.color = nil
+        car.should be_valid
 
-        instance.choice = ''
-        instance.should_not be_valid
+        car.color = ''
+        car.should_not be_valid
       end
 
-      it "should handle symbol enumerations distinctively from strings" do
-        subject.attr_enumerator :choice, [:red, :blue]
+      it "should handle symbol choices distinctively from strings" do
+        Car.attr_enumerator :color, [:red, :blue]
 
-        instance.choice = :red
-        instance.should be_valid
-        instance.should be_choice_red
+        car.color = :red
+        car.should be_valid
+        car.should be_red
 
-        instance.choice = 'red'
-        instance.should_not be_valid
-        instance.should_not be_choice_red
+        car.color = 'red'
+        car.should_not be_valid
+        car.should_not be_red
       end
     end
 
     context "class constant" do
-      it "should create a constant by default" do
-        subject.attr_enumerator :choice, ['red', 'blue']
-        subject::CHOICES.should == ['red', 'blue']
+      it "should create a constant" do
+        Car.attr_enumerator :color, ['red', 'blue']
+        Car::COLORS.should == ['red', 'blue']
       end
 
-      it "should freeze the constant to prevent editing" do
-        subject.attr_enumerator :choice, ['red', 'blue']
-        subject::CHOICES.should be_frozen
+      it "should freeze the constant" do
+        Car.attr_enumerator :color, ['red', 'blue']
+        Car::COLORS.should be_frozen
       end
 
       it "should allow for a custom constant name using a symbol" do
-        subject.attr_enumerator :choice, ['red', 'blue'], :constant => :POSSIBLE_COLORS
-        subject::POSSIBLE_COLORS.should == ['red', 'blue']
+        Car.attr_enumerator :color, ['red', 'blue'], :constant => :POSSIBLE_COLORS
+        Car::POSSIBLE_COLORS.should == ['red', 'blue']
       end
 
       it "should allow for a custom constant name using a string" do
-        subject.attr_enumerator :choice, ['red', 'blue'], :constant => 'POSSIBLE_COLORS'
-        subject::POSSIBLE_COLORS.should == ['red', 'blue']
+        Car.attr_enumerator :color, ['red', 'blue'], :constant => 'POSSIBLE_COLORS'
+        Car::POSSIBLE_COLORS.should == ['red', 'blue']
       end
     end
 
     context "methods" do
-      it "should create methods for each enumeration by default" do
-        subject.attr_enumerator :choice, ['red', 'blue']
-        instance.choice = 'red'
+      it "should create methods for each choice" do
+        Car.attr_enumerator :color, ['red', 'blue']
+        car.color = 'red'
 
-        instance.should respond_to :choice_red?
-        instance.should be_choice_red
+        car.should respond_to :red?
+        car.should be_red
 
-        instance.should respond_to :choice_blue?
-        instance.should_not be_choice_blue
+        car.should respond_to :blue?
+        car.should_not be_blue
       end
 
       it "should create methods with friendly names" do
@@ -126,43 +117,35 @@ describe "AttrEnumerator" do
           :ends_with_dot? => 'ends.with.dot.'
         }
 
-        subject.attr_enumerator :choice, enumerations.values, :prefix => false
+        Car.attr_enumerator :color, enumerations.values
 
         enumerations.keys.each do |method_name|
-          instance.should respond_to method_name
+          car.should respond_to method_name
         end
       end
 
       it "should allow for a custom prefix" do
-        subject.attr_enumerator :choice, ['red', 'blue'], :prefix => 'colored'
-        instance.choice = 'red'
+        Car.attr_enumerator :color, ['red', 'blue'], :prefix => 'painted'
+        car.color = 'red'
 
-        instance.should respond_to :colored_red?
-        instance.should be_colored_red
+        car.should respond_to :painted_red?
+        car.should be_painted_red
 
-        instance.should respond_to :colored_blue?
-        instance.should_not be_colored_blue
-      end
-
-      it "should allow for no prefix" do
-        subject.attr_enumerator :choice, ['red', 'blue'], :prefix => false
-        instance.choice = 'red'
-
-        instance.should respond_to :red?
-        instance.should be_red
-
-        instance.should respond_to :blue?
-        instance.should_not be_blue
+        car.should respond_to :painted_blue?
+        car.should_not be_painted_blue
       end
     end
   end
 
   context "with ActiveRecord" do
     before(:each) do
-      class TestModel < ActiveRecordModel
-        attr_accessor :choice
+      class Car < ActiveRecord::Base
+        establish_connection(:adapter => 'sqlite3', :database => ':memory:')
+        attr_accessor :color
       end
     end
+    
+    after(:each)  { Object.send(:remove_const, :Car) }
 
     it "should automatically be included in ActiveRecord::Base" do
       ActiveRecord::Base.should respond_to :attr_enumerator
@@ -170,18 +153,13 @@ describe "AttrEnumerator" do
 
     describe "scopes" 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 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
+        Car.attr_enumerator :color, ['red', 'blue']
+        Car.red.should be_a ActiveRecord::Relation
       end
 
-      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
+      it "should allow for scopes with a custom prefix" do
+        Car.attr_enumerator :color, ['red', 'blue'], :prefix => 'painted'
+        Car.painted_red.should be_a ActiveRecord::Relation
       end
     end
   end

data/spec/spec_helper.rb

@@ -1,7 +1,2 @@
 require 'active_record'
 require 'attr_enumerator'
-
-class ActiveRecordModel < ActiveRecord::Base
-  establish_connection(:adapter => 'sqlite3', :database => ':memory:')
-  connection.execute("CREATE TABLE #{table_name} (#{primary_key} integer PRIMARY KEY AUTOINCREMENT)")
-end

data/watchr.rb

@@ -11,3 +11,5 @@ end
 watch( '^lib/(.*)\.rb'         ) { |m| run("spec/%s_spec.rb" % m[1]) }
 watch( '^spec/spec_helper\.rb' ) { run_all }
 watch( '^spec.*/.*_spec\.rb'   ) { |m| run(m[0]) }
+
+puts "watchr ready"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: attr_enumerator
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 11
   prerelease: 
   segments: 
   - 0
-  - 4
-  - 1
-  version: 0.4.1
+  - 5
+  - 0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Chris Baker
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-06 00:00:00 Z
+date: 2011-07-07 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   type: :runtime