classy_enum 0.8.0 → 0.8.1

data/README.textile

@@ -132,9 +132,9 @@ end
 
 h2. Model Validation
 
-An ActiveRecord validator @validates_inclusion_of :field, :in => ENUM.all, :allow_nil => true@ is automatically added to your model when you use @classy_enum_attr@. 
+An ActiveRecord validator @validates_inclusion_of :field, :in => ENUM.all@ is automatically added to your model when you use @classy_enum_attr@. 
 
-If your enum only has members low, mediume, and high, then the following validation behavior would be expected:
+If your enum only has members low, medium, and high, then the following validation behavior would be expected:
 
 <pre>
 @alarm = Alarm.new(:priority => :really_high)
@@ -143,6 +143,17 @@ If your enum only has members low, mediume, and high, then the following validat
 @alarm.valid? # => true
 </pre>
 
+To allow nil or blank values, you can pass in :allow_nil and :allow_blank as options to classy_enum_attr, like so:
+
+<pre>
+class Alarm < ActiveRecord::Base
+  classy_enum_attr :priority, :allow_nil => true
+end
+
+@alarm = Alarm.new(:priority => nil)
+@alarm.valid? # => true
+</pre>
+
 h2. Working with ClassyEnum outside of ActiveRecord
 
 While ClassyEnum was designed to be used directly with ActiveRecord, it can also be used outside of it. Here are some examples based on the enum class defined earlier in this document.
@@ -173,6 +184,8 @@ Formtastic::SemanticFormHelper.builder = ClassyEnum::SemanticFormBuilder
 
 Then in your Formtastic view forms, use this syntax: @<%= f.input :priority, :as => :enum_select %>@
 
+Note: ClassyEnum respects the @:allow_blank@ and @:allow_nil@ options and will include a blank select option in these cases
+
 h2. Copyright
 
 Copyright (c) 2011 Peter Brown. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.8.0
+0.8.1

data/classy_enum.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{classy_enum}
-  s.version = "0.8.0"
+  s.version = "0.8.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Peter Brown"]
-  s.date = %q{2011-03-24}
+  s.date = %q{2011-03-26}
   s.description = %q{A utility that adds class based enum functionality to ActiveRecord attributes}
   s.email = %q{github@lette.us}
   s.extra_rdoc_files = [
@@ -45,7 +45,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/beerlington/classy_enum}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.6.2}
+  s.rubygems_version = %q{1.6.1}
   s.summary = %q{A class based enumerator utility for Ruby on Rails}
   s.test_files = [
     "spec/classy_enum_attributes_spec.rb",

data/lib/classy_enum/attributes.rb

@@ -23,17 +23,16 @@ module ClassyEnum
 
       attribute = args[0]
       enum = options[:enum] || attribute
+      allow_blank = options[:allow_blank] || false
+      allow_nil = options[:allow_nil] || false
 
       klass = enum.to_s.camelize.constantize
 
       self.instance_eval do
 
-        # Store the enum class so it can be retrieved by Formtastic input builder
-        @classy_enums ||= {}
-        @classy_enums[attribute] = klass
-
         # Add ActiveRecord validation to ensure it won't be saved unless it's an option
-        validates_inclusion_of attribute, :in => klass.all, :message => "must be one of #{klass.valid_options}"
+        validates_inclusion_of attribute, :in => klass.all, :message => "must be one of #{klass.valid_options}",
+                                          :allow_blank => allow_blank, :allow_nil => allow_nil
 
         # Define getter method that returns a ClassyEnum instance
         define_method attribute do
@@ -42,7 +41,13 @@ module ClassyEnum
 
         # Define setter method that accepts either string or symbol for member
         define_method "#{attribute}=" do |value|
-          super(value.to_s)
+          value = value.to_s unless value.nil?
+          super(value)
+        end
+
+        # Store the enum options so it can be later retrieved by Formtastic
+        define_method "#{attribute}_options" do
+          {:enum => enum, :allow_blank => allow_blank}
         end
 
       end

data/lib/classy_enum/semantic_form_builder.rb

@@ -1,14 +1,14 @@
 module ClassyEnum
   class SemanticFormBuilder < Formtastic::SemanticFormBuilder # :nodoc: all
     def enum_select_input(method, options)
-      enum_class = object.class.instance_variable_get(:@classy_enums)[method]
+      raise Error.invalid_classy_enum_object(method) unless object.respond_to? "#{method}_options"
 
-      raise Error.invalid_classy_enum_object(method) if enum_class.nil?
+      enum_options = object.send("#{method}_options")
+      enum_class = enum_options[:enum].to_s.classify.constantize
 
       options[:collection] = enum_class.select_options
       options[:selected] = object.send(method).to_s
-
-      options[:include_blank] = false
+      options[:include_blank] = enum_options[:allow_blank]
 
       select_input(method, options)
     end

data/spec/classy_enum_attributes_spec.rb

@@ -12,6 +12,11 @@ describe "A Dog" do
     it "should be valid with a valid option" do
       @dog.should be_valid
     end
+
+    it "should have the right classy options for breed" do
+      options = {:enum => :breed, :allow_blank => false}
+      @dog.breed_options.should == options
+    end
   end
 
   it "should not be valid with a nil breed" do
@@ -37,6 +42,82 @@ describe "A Dog" do
 
 end
 
+describe "A ClassyEnum that allows blanks" do
+
+  context "with valid breed options" do
+    before { @dog = AllowBlankBreedDog.new(:breed => :golden_retriever) }
+
+    it "should be valid with a valid option" do
+      @dog.should be_valid
+    end
+
+    it "should have the right classy options for breed" do
+      options = {:enum => :breed, :allow_blank => true}
+      @dog.breed_options.should == options
+    end
+  end
+
+  it "should be valid with a nil breed" do
+    AllowBlankBreedDog.new(:breed => nil).should be_valid
+  end
+
+  it "should be valid with a blank breed" do
+    AllowBlankBreedDog.new(:breed => "").should be_valid
+  end
+
+  context "with invalid breed options" do
+    before { @dog = AllowBlankBreedDog.new(:breed => :fake_breed) }
+
+    it "should not be valid with an invalid option" do
+      @dog.should_not be_valid
+    end
+
+    it "should have an error message containing the right options" do
+      @dog.valid?
+      @dog.errors[:breed].should include("must be one of #{Breed.all.map(&:to_sym).join(', ')}")
+    end
+  end
+
+end
+
+describe "A ClassyEnum that allows nils" do
+
+  context "with valid breed options" do
+    before { @dog = AllowNilBreedDog.new(:breed => :golden_retriever) }
+
+    it "should be valid with a valid option" do
+      @dog.should be_valid
+    end
+
+    it "should have the right classy options for breed" do
+      options = {:enum => :breed, :allow_blank => false}
+      @dog.breed_options.should == options
+    end
+  end
+
+  it "should be valid with a nil breed" do
+    AllowNilBreedDog.new(:breed => nil).should be_valid
+  end
+
+  it "should not be valid with a blank breed" do
+    AllowNilBreedDog.new(:breed => "").should_not be_valid
+  end
+
+  context "with invalid breed options" do
+    before { @dog = AllowNilBreedDog.new(:breed => :fake_breed) }
+
+    it "should not be valid with an invalid option" do
+      @dog.should_not be_valid
+    end
+
+    it "should have an error message containing the right options" do
+      @dog.valid?
+      @dog.errors[:breed].should include("must be one of #{Breed.all.map(&:to_sym).join(', ')}")
+    end
+  end
+
+end
+
 describe "A ClassyEnum that has a different field name than the enum" do
   before { @dog = OtherDog.new(:other_breed => :snoop) }
 

data/spec/classy_enum_semantic_form_builder_spec.rb

@@ -5,86 +5,91 @@ describe 'using enum_select input' do
 
   Formtastic::SemanticFormHelper.builder = ClassyEnum::SemanticFormBuilder
 
-  # Copied from how formtastic tests its form helpers
-  before do
-    @output_buffer = ""
-  end
+  # Reset output buffer
+  before { @output_buffer = "" }
 
-  context "when building a form with a classy_enum select" do
-    context "with an object that has the enum set" do
-      before(:each) do
-        @output = semantic_form_for(Dog.new(:breed => :snoop), :url => "/") do |builder|
+  context 'when building a form with a classy_enum select' do
+    context 'with an object that has the enum set' do
+      let(:output) do
+        semantic_form_for(Dog.new(:breed => :snoop), :url => "/") do |builder|
           concat(builder.input(:breed, :as => :enum_select))
         end
       end
 
-      it "should produce an unselected option tag for Golden Retriever" do
-        regex = Regexp.new("<option value=\\\"golden_retriever\\\">Golden Retriever")
-        @output.should =~ regex
+      it 'should produce an unselected option tag for Golden Retriever' do
+        output.should =~ Regexp.new(%q{option value="golden_retriever">Golden Retriever})
       end
 
-      it "should produce a selected option tag for Snoop" do
-        regex = Regexp.new("<option value=\\\"snoop\\\" selected=\\\"selected\\\">Snoop")
-        @output.should =~ regex
+      it 'should produce a selected option tag for Snoop' do
+        output.should =~ Regexp.new(%q{<option value="snoop" selected="selected">Snoop})
       end
 
-      it "should not produce a blank selected option tag" do
-        regex = Regexp.new("<option value=\"\"><")
-        @output.should_not =~ regex
+      it 'should not produce a blank option tag' do
+        output.should_not =~ Regexp.new(%q{<option value=""><})
       end
     end
 
-    context "with an object that has a nil enum" do
-      before(:each) do
-        @output = semantic_form_for(Dog.new, :url => "/") do |builder|
+    context 'with an object that has a nil enum' do
+      let(:output) do
+        semantic_form_for(Dog.new, :url => "/") do |builder|
           concat(builder.input(:breed, :as => :enum_select))
         end
       end
 
-      it "should produce an unselected option tag for Golden Retriever" do
-        regex = Regexp.new("<option value=\\\"golden_retriever\\\">Golden Retriever")
-        @output.should =~ regex
+      it 'should produce an unselected option tag for Golden Retriever' do
+        output.should =~ Regexp.new(%q{<option value="golden_retriever">Golden Retriever})
       end
 
-      it "should not produce an selected option tag" do
-        regex = Regexp.new("selected")
-        @output.should_not =~ regex
+      it 'should not produce an selected option tag' do
+        output.should_not =~ Regexp.new("selected")
       end
-
     end
 
-    context "with an object with a different attribute name which requires the enum_class" do
-      before(:each) do
-        @output = semantic_form_for(OtherDog.new, :url => "/") do |builder|
-          concat(builder.input(:other_breed, :as => :enum_select))
+    context 'with an object that allows blank enums' do
+      let(:output) do
+        semantic_form_for(AllowBlankBreedDog.new, :url => "/") do |builder|
+          concat(builder.input(:breed, :as => :enum_select))
         end
       end
 
-      it "should produce an unselected option tag for Golden Retriever" do
-        regex = Regexp.new("<option value=\\\"golden_retriever\\\">Golden Retriever")
-        @output.should =~ regex
+      it 'should produce an unselected option tag for Golden Retriever' do
+        output.should =~ Regexp.new(%q{<option value="golden_retriever">Golden Retriever})
       end
 
-      it "should not produce an selected option tag" do
-        regex = Regexp.new("selected")
-        @output.should_not =~ regex
+      it 'should produce a blank option tag' do
+        output.should =~ Regexp.new(%q{<option value=""><})
       end
+    end
 
+    context 'with an object that allows nil enums' do
+      let(:output) do
+        semantic_form_for(AllowNilBreedDog.new, :url => "/") do |builder|
+          concat(builder.input(:breed, :as => :enum_select))
+        end
+      end
+
+      it 'should produce an unselected option tag for Golden Retriever' do
+        output.should =~ Regexp.new(%q{<option value="golden_retriever">Golden Retriever})
+      end
+
+      it 'should produce a blank option tag' do
+        output.should_not =~ Regexp.new(%q{<option value=""><})
+      end
     end
 
   end
 
-  it "should raise an error if the attribute is not a ClassyEnum object" do
+  it 'should raise an error if the attribute is not a ClassyEnum object' do
     lambda do
-      @output = semantic_form_for(Dog.new(:breed => :snoop), :url => "/") do |builder|
+      semantic_form_for(Dog.new(:breed => :snoop), :url => "/") do |builder|
         concat(builder.input(:id, :as => :enum_select))
       end
     end.should raise_error("id is not a ClassyEnum object. Make sure you've added 'classy_enum_attr :id' to your model")
   end
 
-  it "should raise an error if the attribute is not a ClassyEnum object and its value is nil" do
+  it 'should raise an error if the attribute is not a ClassyEnum object and its value is nil' do
     lambda do
-      @output = semantic_form_for(Dog.new, :url => "/") do |builder|
+      semantic_form_for(Dog.new, :url => "/") do |builder|
         concat(builder.input(:id, :as => :enum_select))
       end
     end.should raise_error("id is not a ClassyEnum object. Make sure you've added 'classy_enum_attr :id' to your model")

data/spec/spec_helper.rb

@@ -12,6 +12,10 @@ require 'classy_enum'
 
 ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
 
+RSpec.configure do |config|
+  config.color_enabled = true
+end
+
 ActiveRecord::Schema.define(:version => 1) do
   create_table :dogs, :force => true do |t|
     t.string :breed
@@ -21,6 +25,13 @@ ActiveRecord::Schema.define(:version => 1) do
     t.string :other_breed
   end
 
+  create_table :allow_blank_breed_dogs, :force => true do |t|
+    t.string :breed
+  end
+  
+  create_table :allow_nil_breed_dogs, :force => true do |t|
+    t.string :breed
+  end
 end
 
 class Breed < ClassyEnum::Base
@@ -31,6 +42,14 @@ class Dog < ActiveRecord::Base
   classy_enum_attr :breed
 end
 
+class AllowBlankBreedDog < ActiveRecord::Base
+  classy_enum_attr :breed, :allow_blank => true
+end
+
+class AllowNilBreedDog < ActiveRecord::Base
+  classy_enum_attr :breed, :allow_nil => true
+end
+
 class OtherDog < ActiveRecord::Base
   classy_enum_attr :other_breed, :enum => :breed
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: classy_enum
 version: !ruby/object:Gem::Version 
-  hash: 63
+  hash: 61
   prerelease: 
   segments: 
   - 0
   - 8
-  - 0
-  version: 0.8.0
+  - 1
+  version: 0.8.1
 platform: ruby
 authors: 
 - Peter Brown
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-24 00:00:00 -04:00
+date: 2011-03-26 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -156,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.6.1
 signing_key: 
 specification_version: 3
 summary: A class based enumerator utility for Ruby on Rails