classy_enum 3.1.3 → 3.2.0

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # ClassyEnum Changelog
 
+## 3.2.0
+
+* Default values can now be specified within an ActiveRecord model
+
+```ruby
+class Alarm < ActiveRecord::Base
+  classy_enum_attr :priority, :default => 'medium'
+end
+
+class Alarm < ActiveRecord::Base
+  classy_enum_attr :priority, :default => lambda {|enum| enum.last }
+end
+```
+
+* Adding ClassyEnum::Base#last. It's not part of the enumerable module
+  but it makes sense in this case.
+
+```ruby
+Priority.last # => Priority::High
+```
+
 ## 3.1.3
 
 * Fixes saving and reloading ActiveRecord models that assign enum using
@@ -10,8 +31,10 @@
 * Allow enum property to be assigned using enum class. Previously it
   could only be assigned with an instance, string or symbol.
 
-      @alarm.priority = Priority::Medium
-      @alarm.priority.medium? # => true
+```ruby
+@alarm.priority = Priority::Medium
+@alarm.priority.medium? # => true
+```
 
 ## 3.1.1
 
@@ -33,8 +56,10 @@
 * Equality can now be determined using strings and symbols. The
   following will return true:
 
-      Priority::Low.new == :low  # => true
-      Priority::Low.new == 'low' # => true
+```ruby
+Priority::Low.new == :low  # => true
+Priority::Low.new == 'low' # => true
+```
 
 ## 3.0.0
 
@@ -62,9 +87,9 @@
 
 ## 2.1.0
 
-* Deprecating ClassyEnum::Base.enum_classes() (this is no longer needed)
-* Deprecating ClassyEnum::Base.valid_options()(use all.join(', ') instead)
-* Deprecating ClassEnum::Base.find() (use build() instead)
+* Deprecating ClassyEnum::Base.enum_classes (this is no longer needed)
+* Deprecating ClassyEnum::Base.valid_options (use all.join(', ') instead)
+* Deprecating ClassEnum::Base.find (use build() instead)
 
 ## 2.0.3
 

data/README.md

@@ -1,23 +1,26 @@
 # ClassyEnum
 
 [![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)
 
 ClassyEnum is a Ruby on Rails gem that adds class-based enumerator functionality to ActiveRecord attributes.
 
 ## README Topics
 
-* [Example Usage](https://github.com/beerlington/classy_enum#example-usage)
-* [Internationalization](https://github.com/beerlington/classy_enum#internationalization)
-* [Using Enum as a Collection](https://github.com/beerlington/classy_enum#using-enum-as-a-collection)
-* [Reference to Owning Object](https://github.com/beerlington/classy_enum#back-reference-to-owning-object)
-* [Serializing as JSON](https://github.com/beerlington/classy_enum#serializing-as-json)
-* [Special Cases](https://github.com/beerlington/classy_enum#special-cases)
-* [Built-in Model Validation](https://github.com/beerlington/classy_enum#model-validation)
-* [Formtastic Support](https://github.com/beerlington/classy_enum#formtastic-support)
+* [Example Usage](#example-usage)
+* [Internationalization](#internationalization)
+* [Using Enum as a Collection](#using-enum-as-a-collection)
+* [Default Enum Value](#default-enum-value)
+* [Reference to Owning Object](#back-reference-to-owning-object)
+* [Serializing as JSON](#serializing-as-json)
+* [Special Cases](#special-cases)
+* [Built-in Model Validation](#model-validation)
+* [Formtastic Support](#formtastic-support)
 
 ## Rails & Ruby Versions Supported
 
-*Rails:* 3.0.x - 3.2.x
+*Rails:* 3.0.x - 4.0.0.beta
 
 *Ruby:* 1.8.7, 1.9.2 and 1.9.3
 
@@ -187,6 +190,34 @@ Priority.each do |priority|
 end
 ```
 
+## Default Enum Value
+
+As with any ActiveRecord attribute, default values can be specified in
+the database table and will propagate to new instances. However, there
+may be times when you can't or don't want to set the default value in
+the database. For these occasions, a default value can be specified like
+so:
+
+```ruby
+class Alarm < ActiveRecord::Base
+  classy_enum_attr :priority, :default => 'medium'
+end
+
+Alarm.new.priority # => Priority::Medium
+```
+
+You may also use a Proc object to set the default value. The enum class
+is yielded to the block and can be used to determine the default at
+runtime.
+
+```ruby
+class Alarm < ActiveRecord::Base
+  classy_enum_attr :priority, :default => lambda {|enum| enum.max }
+end
+
+Alarm.new.priority # => Priority::High
+```
+
 ## Back reference to owning object
 
 In some cases you may want an enum class to reference the owning object

data/classy_enum.gemspec

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

data/lib/classy_enum/active_record.rb

@@ -1,4 +1,6 @@
 module ClassyEnum
+  class InvalidDefault < StandardError; end
+
   module ActiveRecord
 
     # Class macro used to associate an enum with an attribute on an ActiveRecord model.
@@ -21,11 +23,25 @@ module ClassyEnum
     #
     #  # Allow enum value to be blank
     #  classy_enum_attr :priority, :allow_blank => true
+    #
+    #  # Specifying a default enum value
+    #  classy_enum_attr :priority, :default => 'low'
     def classy_enum_attr(attribute, options={})
       enum              = (options[:enum] || attribute).to_s.camelize.constantize
       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
 
       # Add ActiveRecord validation to ensure it won't be saved unless it's an option
       validates_inclusion_of attribute,
@@ -35,7 +51,9 @@ module ClassyEnum
 
       # Define getter method that returns a ClassyEnum instance
       define_method attribute do
-        enum.build(read_attribute(attribute),
+        value = read_attribute(attribute) || default
+
+        enum.build(value,
                    :owner             => self,
                    :serialize_as_json => serialize_as_json,
                    :allow_blank       => (allow_blank || allow_nil)

data/lib/classy_enum/collection.rb

@@ -64,6 +64,22 @@ module ClassyEnum
         enum_options.each {|e| yield e.new }
       end
 
+      # Returns the last enum instance in the collection
+      #
+      # ==== Example
+      #  # Create an Enum with some elements
+      #  class Priority < ClassyEnum::Base
+      #  end
+      #
+      #  class Priority::Low < Priority; end
+      #  class Priority::Medium < Priority; end
+      #  class Priority::High < Priority; end
+      #
+      #  Priority.last # => Priority::High
+      def last
+        to_a.last
+      end
+
       # Finds an enum instance by symbol, string, or block.
       #
       # If a block is given, it passes each entry in enum to block, and returns

data/lib/classy_enum/version.rb

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

data/spec/classy_enum/active_record_spec.rb

@@ -1,5 +1,19 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :dogs, :force => true do |t|
+    t.string :breed
+    t.string :other_breed
+    t.string :color
+    t.string :name
+    t.integer :age
+  end
+
+  create_table :cats, :force => true do |t|
+    t.string :breed
+  end
+end
+
 class Breed < ClassyEnum::Base; end
 class Breed::GoldenRetriever < Breed; end
 class Breed::Snoop < Breed; end
@@ -22,29 +36,31 @@ class CatBreed::Bengal < CatBreed; end
 class CatBreed::Birman < CatBreed; end
 class CatBreed::Persian < CatBreed; end
 
-class Dog < ActiveRecord::Base
+class Dog < ActiveRecord::Base; end
+
+class DefaultDog < Dog
   classy_enum_attr :breed
 end
 
-class AllowBlankBreedDog < ActiveRecord::Base
+class AllowBlankBreedDog < Dog
   classy_enum_attr :breed, :allow_blank => true
 end
 
-class AllowNilBreedDog < ActiveRecord::Base
+class AllowNilBreedDog < Dog
   classy_enum_attr :breed, :allow_nil => true
 end
 
-class OtherDog < ActiveRecord::Base
+class OtherDog < Dog
   classy_enum_attr :other_breed, :enum => 'Breed'
 end
 
-describe Dog do
-  specify { Dog.new(:breed => nil).should_not be_valid }
-  specify { Dog.new(:breed => '').should_not be_valid }
+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|
-      subject { Dog.new(:breed => option) }
+      subject { DefaultDog.new(:breed => option) }
       it { should be_valid }
       its(:breed) { should be_a(Breed::GoldenRetriever) }
       its('breed.allow_blank') { should be_false }
@@ -58,7 +74,7 @@ describe Dog do
   end
 
   context "with invalid breed options" do
-    subject { Dog.new(:breed => :fake_breed) }
+    subject { DefaultDog.new(:breed => :fake_breed) }
     it { should_not be_valid }
     it { should have(1).error_on(:breed) }
   end
@@ -103,10 +119,10 @@ describe "A ClassyEnum that has a different field name than the enum" do
   its(:other_breed) { should be_a(Breed::Snoop) }
 end
 
-class ActiveDog < ActiveRecord::Base
+class ActiveDog < Dog
   classy_enum_attr :color
   validates_uniqueness_of :name, :scope => :color
-  scope :goldens, where(:breed => 'golden_retriever')
+  scope :goldens, lambda { where(:breed => 'golden_retriever') }
 end
 
 describe ActiveDog do
@@ -141,20 +157,47 @@ describe ActiveDog do
 
 end
 
+class DefaultValueDog < Dog
+  classy_enum_attr :breed, :default => :snoop
+end
+
+describe DefaultValueDog do
+  its(:breed) { should == :snoop }
+end
+
+class DynamicDefaultValueDog < Dog
+  classy_enum_attr :breed, :default => lambda { |enum| enum.max }
+end
+
+describe DynamicDefaultValueDog do
+  its(:breed) { should == :husky }
+end
+
+describe Dog, 'with invalid default value' do
+  it 'raises error with invalid default' do
+    expect {
+      Class.new(Dog) { classy_enum_attr :breed, :default => :nope }
+    }.to raise_error(ClassyEnum::InvalidDefault)
+  end
+end
+
 class Cat < ActiveRecord::Base
+end
+
+class DefaultCat < Cat
   classy_enum_attr :breed, :enum => 'CatBreed'
   attr_accessor :color
   delegate :breed_color, :to => :breed
 end
 
-class OtherCat < ActiveRecord::Base
+class OtherCat < Cat
   classy_enum_attr :breed, :enum => 'CatBreed', :serialize_as_json => true
   attr_accessor :color
   delegate :breed_color, :to => :breed
 end
 
-describe Cat do
-  let(:abyssian) { Cat.new(:breed => :abyssian, :color => 'black') }
+describe DefaultCat do
+  let(:abyssian) { DefaultCat.new(:breed => :abyssian, :color => 'black') }
   let(:persian) { OtherCat.new(:breed => :persian, :color => 'white') }
 
   it 'should delegate breed color to breed with an ownership reference' do

data/spec/classy_enum/collection_spec.rb

@@ -26,6 +26,12 @@ describe ClassyEnum::Collection do
     end
   end
 
+  context '.last' do
+    its(:last) { should == ClassyEnumCollection::Three.new }
+    its(:last) { should == :three }
+    its(:last) { should_not == :one }
+  end
+
   context '#<=> (equality)' do
     its(:first) { should == ClassyEnumCollection::One.new }
     its(:first) { should == :one }

data/spec/spec_helper.rb

@@ -13,36 +13,3 @@ ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":me
 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
-  end
-
-  create_table :other_dogs, :force => true do |t|
-    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
-
-  create_table :active_dogs, :force => true do |t|
-    t.string :breed
-    t.string :color
-    t.string :name
-    t.integer :age
-  end
-
-  create_table :cats, :force => true do |t|
-    t.string :breed
-  end
-
-  create_table :other_cats, :force => true do |t|
-    t.string :breed
-  end
-end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: classy_enum
 version: !ruby/object:Gem::Version
-  version: 3.1.3
+  version: 3.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-13 00:00:00.000000000 Z
+date: 2013-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.11.0
+        version: '2.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +42,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.11.0
+        version: '2.11'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -50,7 +50,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,7 +58,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +66,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.6.5
+        version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -74,7 +74,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.6.5
+        version: '1.6'
 description: A utility that adds class based enum functionality to ActiveRecord attributes
 email:
 - github@lette.us
@@ -126,7 +126,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4175373577725624230
+      hash: 3178964087580650038
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -135,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4175373577725624230
+      hash: 3178964087580650038
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24