classy_enum 3.2.0 → 3.2.1

data/.travis.yml

@@ -7,3 +7,8 @@ gemfile:
   - gemfiles/Gemfile.rails-3.0.x
   - gemfiles/Gemfile.rails-3.1.x
   - gemfiles/Gemfile.rails-3.2.x
+  - gemfiles/Gemfile.rails-4.0.x
+matrix:
+  exclude:
+    - rvm: 1.8.7
+      gemfile: gemfiles/Gemfile.rails-4.0.x

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # ClassyEnum Changelog
 
+## 3.2.1
+
+* Better support for using `default` and `allow_*` options together
+* Fixes bug when using `default` option and explicitly setting value to
+  nil if `allow_nil: true` option is not used.
+* Fixes bug when chaining `count` onto scope that uses enum object in
+  query condition.
+
 ## 3.2.0
 
 * Default values can now be specified within an ActiveRecord model

data/Gemfile

@@ -1,3 +1,3 @@
-source :rubygems
+source 'https://rubygems.org'
 
 gemspec

data/README.md

@@ -3,6 +3,7 @@
 [![Build Status](https://secure.travis-ci.org/beerlington/classy_enum.png?branch=master)](http://travis-ci.org/beerlington/classy_enum)
 [![Gem Version](https://badge.fury.io/rb/classy_enum.png)](http://badge.fury.io/rb/classy_enum)
 [![Code Climate](https://codeclimate.com/github/beerlington/classy_enum.png)](https://codeclimate.com/github/beerlington/classy_enum)
+[![Dependency Status](https://gemnasium.com/beerlington/classy_enum.png)](https://gemnasium.com/beerlington/classy_enum)
 
 ClassyEnum is a Ruby on Rails gem that adds class-based enumerator functionality to ActiveRecord attributes.
 
@@ -20,9 +21,9 @@ ClassyEnum is a Ruby on Rails gem that adds class-based enumerator functionality
 
 ## Rails & Ruby Versions Supported
 
-*Rails:* 3.0.x - 4.0.0.beta
+*Rails:* 3.0.x - 4.0.0.rc1
 
-*Ruby:* 1.8.7, 1.9.2 and 1.9.3
+*Ruby:* 1.8.7, 1.9.2, 1.9.3 and 2.0.0
 
 If you need support for Rails 2.3.x, please install [version 0.9.1](https://rubygems.org/gems/classy_enum/versions/0.9.1).
 Note: This branch is no longer maintained and will not get bug fixes or new features.

data/Rakefile

@@ -2,5 +2,8 @@
 require "bundler/gem_tasks"
 require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.ruby_opts = "-w"
+end
+
 task :default => :spec

data/classy_enum.gemspec

@@ -16,8 +16,9 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency('rails', '>= 3.0')
 
-  gem.add_development_dependency('rspec-rails', '~> 2.11')
-  gem.add_development_dependency('sqlite3', '~> 1.3')
-  gem.add_development_dependency('json', '~> 1.6')
+  gem.add_development_dependency('rspec-rails', '>= 2.11')
+  gem.add_development_dependency('sqlite3', '>= 1.3')
+  gem.add_development_dependency('json', '>= 1.6')
+  gem.add_development_dependency('debugger')
 
 end

data/gemfiles/Gemfile.rails-4.0.x

@@ -0,0 +1,6 @@
+source :rubygems
+
+gem 'rails', '4.0.0.rc1'
+gem 'rspec-rails', '~> 2.11'
+gem 'sqlite3'
+gem 'json', '~> 1.7'

data/lib/classy_enum/active_record.rb

@@ -1,6 +1,32 @@
 module ClassyEnum
   class InvalidDefault < StandardError; end
 
+  def self._normalize_value(value, default=nil, allow_blank=false) # :nodoc:
+    if value.class == Class && value < ClassyEnum::Base
+      value = value.new.to_s
+    elsif value.present?
+      value = value.to_s
+    elsif value.blank? && allow_blank
+      value
+    else
+      default
+    end
+  end
+
+  def self._normalize_default(value, enum_class) # :nodoc:
+    if value.present?
+      if value.is_a? Proc
+        value = value.call(enum_class)
+      end
+
+      unless enum_class.include? value
+        raise InvalidDefault, "must be one of [#{enum_class.to_a.join(',')}]"
+      end
+    end
+
+    value
+  end
+
   module ActiveRecord
 
     # Class macro used to associate an enum with an attribute on an ActiveRecord model.
@@ -31,17 +57,7 @@ module ClassyEnum
       allow_blank       = options[:allow_blank] || false
       allow_nil         = options[:allow_nil] || false
       serialize_as_json = options[:serialize_as_json] || false
-      default           = options[:default]
-
-      if default.present?
-        if default.is_a? Proc
-          default = default.call(enum)
-        end
-
-        unless enum.include? default
-          raise InvalidDefault, "must be one of [#{enum.to_a.join(',')}]"
-        end
-      end
+      default           = ClassyEnum._normalize_default(options[:default], enum)
 
       # Add ActiveRecord validation to ensure it won't be saved unless it's an option
       validates_inclusion_of attribute,
@@ -51,7 +67,8 @@ module ClassyEnum
 
       # Define getter method that returns a ClassyEnum instance
       define_method attribute do
-        value = read_attribute(attribute) || default
+        value = read_attribute(attribute)
+        value ||= default unless allow_nil
 
         enum.build(value,
                    :owner             => self,
@@ -62,12 +79,7 @@ module ClassyEnum
 
       # Define setter method that accepts string, symbol, instance or class for member
       define_method "#{attribute}=" do |value|
-        if value.class == Class && value < ClassyEnum::Base
-          value = value.new.to_s
-        elsif value.present?
-          value = value.to_s
-        end
-
+        value = ClassyEnum._normalize_value(value, default, (allow_nil || allow_blank))
         super(value)
       end
     end

data/lib/classy_enum/base.rb

@@ -1,5 +1,5 @@
 module ClassyEnum
-  class SubclassNameError < Exception; end
+  class SubclassNameError < StandardError; end
 
   class Base
     include Comparable
@@ -29,8 +29,14 @@ module ClassyEnum
           # database value for validation scopes. A fix will be released in Rails 4, but
           # this will remain until Rails 3.x is no longer prevalent.
           if defined?(Arel::Visitors::ToSql)
+            visitor_method = "visit_#{klass.name.split('::').join('_')}"
+
             Arel::Visitors::ToSql.class_eval do
-              define_method "visit_#{klass.name.split('::').join('_')}", lambda {|value| quote(value.to_s) }
+              define_method visitor_method, lambda {|value| quote(value.to_s) }
+            end
+
+            Arel::Visitors::DepthFirst.class_eval do
+              define_method visitor_method, lambda {|value| terminal(value.to_s) }
             end
           end
 
@@ -62,13 +68,11 @@ module ClassyEnum
         object = find(value)
 
         if object.nil? || (options[:allow_blank] && object.nil?)
-          return value unless value.blank?
-
-          # Subclass the base class and make it behave like the value that it is
-          object = Class.new(base_class) {
-            instance_variable_set(:@option, value)
-            delegate :blank?, :nil?, :to => :option
-          }.new
+          if value.blank?
+            object = build_null_object(value)
+          else
+            return value
+          end
         end
 
         object.owner = options[:owner]
@@ -93,6 +97,17 @@ module ClassyEnum
       def owner(owner)
         define_method owner, lambda { @owner }
       end
+
+      private
+
+      # Subclass the base class and make it behave like the value that it is
+      def build_null_object(value)
+        Class.new(base_class) {
+          @option = value
+          @index = 0
+          delegate :blank?, :nil?, :to => :option
+        }.new
+      end
     end
 
   end

data/lib/classy_enum/version.rb

@@ -1,3 +1,3 @@
 module ClassyEnum
-  VERSION = "3.2.0"
+  VERSION = "3.2.1"
 end

data/spec/classy_enum/active_record_spec.rb

@@ -11,6 +11,8 @@ ActiveRecord::Schema.define(:version => 1) do
 
   create_table :cats, :force => true do |t|
     t.string :breed
+    t.string :other_breed
+    t.string :another_breed
   end
 end
 
@@ -58,8 +60,8 @@ describe DefaultDog do
   specify { DefaultDog.new(:breed => nil).should_not be_valid }
   specify { DefaultDog.new(:breed => '').should_not be_valid }
 
-  context "with valid breed options" do
-    [:golden_retriever, 'golden_retriever', Breed::GoldenRetriever.new, Breed::GoldenRetriever].each do |option|
+  [:golden_retriever, 'golden_retriever', Breed::GoldenRetriever.new, Breed::GoldenRetriever].each do |option|
+    context "with a valid breed option" do
       subject { DefaultDog.new(:breed => option) }
       it { should be_valid }
       its(:breed) { should be_a(Breed::GoldenRetriever) }
@@ -122,7 +124,7 @@ end
 class ActiveDog < Dog
   classy_enum_attr :color
   validates_uniqueness_of :name, :scope => :color
-  scope :goldens, lambda { where(:breed => 'golden_retriever') }
+  scope :goldens, lambda { where(:breed => Breed.build('golden_retriever')) }
 end
 
 describe ActiveDog do
@@ -153,6 +155,10 @@ describe ActiveDog do
       ActiveDog.goldens.should include(golden)
       ActiveDog.goldens.should_not include(husky)
     end
+
+    it 'should have a working scope with count' do
+      ActiveDog.goldens.size.should == 1
+    end
   end
 
 end
@@ -186,12 +192,15 @@ end
 
 class DefaultCat < Cat
   classy_enum_attr :breed, :enum => 'CatBreed'
+  classy_enum_attr :other_breed, :enum => 'CatBreed', :default => 'persian'
   attr_accessor :color
   delegate :breed_color, :to => :breed
 end
 
 class OtherCat < Cat
   classy_enum_attr :breed, :enum => 'CatBreed', :serialize_as_json => true
+  classy_enum_attr :other_breed, :enum => 'CatBreed', :default => 'persian', :allow_nil => true
+  classy_enum_attr :another_breed, :enum => 'CatBreed', :default => 'persian', :allow_blank => true
   attr_accessor :color
   delegate :breed_color, :to => :breed
 end
@@ -204,4 +213,29 @@ describe DefaultCat do
     abyssian.breed_color { should eql('black Abyssian') }
     persian.breed_color { should eql('white Persian') }
   end
+
+  it 'uses the default if explictly set to nil and does not allow nil' do
+    abyssian.update_attributes!(:other_breed => nil)
+    DefaultCat.where(:other_breed => nil).count.should be_zero
+    DefaultCat.last.other_breed.should == 'persian'
+  end
+
+  it 'uses the default if explictly set to blank and does not allow blank' do
+    abyssian.update_attributes!(:other_breed => '')
+    DefaultCat.where(:other_breed => '').count.should be_zero
+    DefaultCat.last.other_breed.should == 'persian'
+  end
+
+  it 'allows nil even with a default' do
+    persian.update_attributes!(:other_breed => nil)
+    OtherCat.where(:other_breed => nil).count.should eql(1)
+    OtherCat.last.other_breed.should be_nil
+  end
+
+  it 'allows blank even with a default' do
+    persian.update_attributes!(:another_breed => '')
+    OtherCat.where(:another_breed => '').count.should eql(1)
+    OtherCat.last.another_breed.should be_blank
+    OtherCat.last.another_breed.should_not be_nil
+  end
 end

data/spec/classy_enum_inheritance_spec.rb

@@ -14,8 +14,8 @@ end
 
 describe 'Classy Enum inheritance' do
   it 'should inherit from the previous class' do
-    ProjectTier::One.inherited_properties.should == [1,2,3]
-    ProjectTier::Two.inherited_properties.should == [1,2,3,4,5,6]
+    ProjectTier::One.inherited_properties.should eql([1,2,3])
+    ProjectTier::Two.inherited_properties.should eql([1,2,3,4,5,6])
   end
 
   it 'should instantiate the subclass' do

data/spec/classy_enum_spec.rb

@@ -0,0 +1,65 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+class Normalize < ClassyEnum::Base; end
+class Normalize::One < Normalize; end
+
+describe ClassyEnum do
+  context '._normalize_value' do
+    it 'converts an enum to a string' do
+      value = ClassyEnum._normalize_value(Normalize::One)
+      value.should == 'one'
+    end
+
+    it 'converts a symbol to a string' do
+      value = ClassyEnum._normalize_value(:one)
+      value.should == 'one'
+    end
+
+    it 'leaves a string as a string' do
+      value = ClassyEnum._normalize_value('one')
+      value.should == 'one'
+    end
+
+    it 'does not convert nil' do
+      value = ClassyEnum._normalize_value(nil)
+      value.should be_nil
+    end
+
+    it 'does not convert an empty string if allowed' do
+      value = ClassyEnum._normalize_value('', nil, true)
+      value.should eql('')
+    end
+
+    it 'uses the default value if blank and does not allow blank' do
+      value = ClassyEnum._normalize_value(nil, 'one')
+      value.should eql('one')
+    end
+  end
+
+  context '._normalize_default' do
+    let(:enum) { Normalize }
+
+    it 'returns a string when provided' do
+      default = ClassyEnum._normalize_default('one', enum)
+      default.should eql('one')
+    end
+
+    it 'allows a proc' do
+      value = lambda {|enum| enum.max }
+      default = ClassyEnum._normalize_default(value, enum)
+      default.should == enum.max
+    end
+
+    it 'raises an exception if not an enum value' do
+      expect { ClassyEnum._normalize_default('two', enum) }.to raise_error(ClassyEnum::InvalidDefault)
+    end
+
+    it 'returns nil if nil is provided' do
+      ClassyEnum._normalize_default(nil, enum).should be_nil
+    end
+
+    it 'returns empty string if provided' do
+      ClassyEnum._normalize_default('', enum).should eql('')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -2,6 +2,7 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
 require 'rubygems'
+require 'rails'
 require 'active_record'
 require 'action_view'
 require 'action_controller'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: classy_enum
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-08 00:00:00.000000000 Z
+date: 2013-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -32,7 +32,7 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '2.11'
   type: :development
@@ -40,7 +40,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '2.11'
 - !ruby/object:Gem::Dependency
@@ -48,7 +48,7 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
@@ -56,7 +56,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
@@ -64,7 +64,7 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
@@ -72,9 +72,25 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A utility that adds class based enum functionality to ActiveRecord attributes
 email:
 - github@lette.us
@@ -93,6 +109,7 @@ files:
 - gemfiles/Gemfile.rails-3.0.x
 - gemfiles/Gemfile.rails-3.1.x
 - gemfiles/Gemfile.rails-3.2.x
+- gemfiles/Gemfile.rails-4.0.x
 - init.rb
 - lib/classy_enum.rb
 - lib/classy_enum/active_record.rb
@@ -111,6 +128,7 @@ files:
 - spec/classy_enum/predicate_spec.rb
 - spec/classy_enum/translation_spec.rb
 - spec/classy_enum_inheritance_spec.rb
+- spec/classy_enum_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/beerlington/classy_enum
 licenses: []
@@ -126,7 +144,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3178964087580650038
+      hash: 633185140317949872
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -135,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3178964087580650038
+      hash: 633185140317949872
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -150,4 +168,5 @@ test_files:
 - spec/classy_enum/predicate_spec.rb
 - spec/classy_enum/translation_spec.rb
 - spec/classy_enum_inheritance_spec.rb
+- spec/classy_enum_spec.rb
 - spec/spec_helper.rb