classy_enum 0.6.1 → 0.7.0

data/README.textile

@@ -16,66 +16,84 @@ h2. Example Usage
 
 The most common use for ClassyEnum is to replace database lookup tables where the content and behavior is mostly static and has multiple "types". In this example, I have an ActiveRecord model called @Alarm@ with an attribute called @priority@. Priority is stored as a string (VARCHAR) type in the database and is converted to an enum value when requested. 
 
+h3. 1. Generate the Enum
+
 The fastest way to get up and running with ClassyEnum is to use the built-in Rails generator like so:
 
 Rails 2.3.x:
 
 <pre>
-script/generate classy_enum AlarmPriority low medium high
+script/generate classy_enum Priority low medium high
 </pre>
 
 Rails 3.x
 
 <pre>
-rails g classy_enum AlarmPriority low medium high
+rails g classy_enum Priority low medium high
 </pre>
 
-A new file will be created at app/enums/alarm_priority.rb that will look like:
+A new enum template file will be created at app/enums/priority.rb that will look like:
 
 <pre>
-class AlarmPriority < ClassyEnum::Base
+class Priority < ClassyEnum::Base
   enum_classes :low, :medium, :high
 end
 
-class AlarmPriorityLow
+class PriorityLow < Priority
 end
 
-class AlarmPriorityMedium
+class PriorityMedium < Priority
 end
 
-class AlarmPriorityHigh
+class PriorityHigh < Priority
 end
 </pre>
 
-That is the default setup, but can be changed to fit your needs, like so...
+The @enum_classes@ macro will add all the ClassyEnum behavior, which is described further down in this document.
+
+h3. 2. Customize the Enum
+
+The generator creates a default setup, but each enum member can be changed to fit your needs.
 
-Using the @enum_classes@ method, I have defined three priority levels: low, medium, and high. Each priority level can have different properties and methods associated with it. In my example, each enum class has a method called @email?@. By default this method returns false, but is overridden for high priority alarms and returns true.
+Using the @enum_classes@ method, I have defined three priority levels: low, medium, and high. Each priority level can have different properties and methods associated with it.
+
+I would like to add a method called @send_email?@ that all member subclasses respond to. By default this method will return false, but will be overridden for high priority alarms to return true.
 
 <pre>
-class AlarmPriority < ClassyEnum::Base
+class Priority < ClassyEnum::Base
   enum_classes :low, :medium, :high
-  
-  def email?
+
+  def send_email?
     false
   end
 end
 
-class AlarmPriorityHigh
-  def email?
+class PriorityHigh < Priority
+  def send_email?
     true
   end
 end
 </pre>
 
-Then in my ActiveRecord model, Alarm, I've added a line that calls @classy_enum_attr@. The first argument is required, and is the name of the class defined above. The second argument is optional and specifies which Alarm attribute will be used as an enumerable. 
+Note: Defining the subclasses within your enum file is only required when you will be overriding behavior and/or properties. The member subclasses still exist without being defined here because ClassyEnum.enum_classes automatically creates a class for each member. The generator only creates these subclass definitions for convenience, but they can be deleted as shown in this example.
+
+h3. 3. Setup the ActiveRecord model
+
+My ActiveRecord Alarm model needs a text field that will store a string representing the enum member. An example model schema might look something like:
+
+<pre>
+create_table "alarms", :force => true do |t|
+  t.string   "priority"
+end
+</pre>
 
-In this case, I am using the class AlarmPriority, but the name of my attribute is priority. By default, it will use the name of class as the attribute name. If I wanted to do @alarm.alarm_priority@, I would not have included the second argument.
+Then in my model I've added a line that calls @classy_enum_attr@ with a single argument representing the enum I want to associate with my model. I am also delegating the send_email? method to my Priority enum class.
 
 <pre>
 class Alarm < ActiveRecord::Base
-  classy_enum_attr :alarm_priority, :priority
-    
-  delegate :email?, :to => :priority
+  classy_enum_attr :priority
+
+  delegate :send_email?, :to => :priority
 end
 </pre>
 
@@ -83,14 +101,64 @@ With this setup, I can now do the following:
 
 <pre>
 @alarm = Alarm.create(:priority => :medium)
-  
-@alarm.priority => AlarmPriorityMedium
-  
-@alarm.email? => false
-  
-@alarm.update_attribute(:priority, :high)
-  
-@alarm.email? => true
+
+@alarm.priority  # => PriorityMedium
+@alarm.priority.is? :medium # => true
+@alarm.priority.to_s # => 'medium'
+@alarm.priority.name # => 'Medium'
+
+# Should this alarm send an email?
+@alarm.send_email? # => false
+@alarm.priority = :high
+@alarm.send_email? # => true
+</pre>
+
+The enum field works like any other model attribute. It can be mass-assigned using @update_attribute(s)@.
+
+h2. Special Cases
+
+What if your enum class name is not the same as your model's attribute name? No problem! Just use a second arugment in @classy_enum_attr@ to declare the attribute name. In this case, the model's attribute is called *alarm_priority*.
+
+<pre>
+class Alarm < ActiveRecord::Base
+  classy_enum_attr :priority, :alarm_priority
+end
+
+@alarm = Alarm.create(:alarm_priority => :medium)
+@alarm.alarm_priority  # => PriorityMedium
+</pre>
+
+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@. 
+
+If your enum only has members low, mediume, and high, then the following validation behavior would be expected:
+
+<pre>
+@alarm = Alarm.new(:priority => :really_high)
+@alarm.valid? # => false
+@alarm.priority = :high
+@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.
+
+Instantiate an enum member subclass *PriorityLow*
+
+<pre>
+# These statements are all equivalent
+low = Priority.build(:low)
+low = Priority.build('low)
+low = Priority.find(:low)
+low = PriorityLow.new
+</pre>
+
+Get a list of the valid enum options
+
+<pre>
+Priority.valid_options # => low, mediume, high
 </pre>
 
 h2. Formtastic Support
@@ -103,10 +171,6 @@ Formtastic::SemanticFormHelper.builder = ClassyEnum::SemanticFormBuilder
 
 Then in your Formtastic view forms, use this syntax: @<%= f.input :priority, :as => :enum_select %>@
 
-h2. Notes
-
-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@. 
-
 h2. Copyright
 
-Copyright (c) 2010 Peter Brown. See LICENSE for details.
+Copyright (c) 2011 Peter Brown. See LICENSE for details.

data/Rakefile

@@ -14,7 +14,7 @@ begin
     gem.add_development_dependency 'rspec-rails', '~> 2.0'
     gem.add_development_dependency 'formtastic', '~> 1.1'
     gem.add_development_dependency 'sqlite3-ruby'
-    gem.add_dependency "activerecord", ">= 2.3"
+    gem.add_development_dependency "activerecord", ">= 2.3"
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-0.6.1
+0.7.0

data/classy_enum.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{classy_enum}
-  s.version = "0.6.1"
+  s.version = "0.7.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Peter Brown"]
-  s.date = %q{2010-12-12}
+  s.date = %q{2011-01-29}
   s.description = %q{A utility that adds class based enum functionality to ActiveRecord attributes}
   s.email = %q{github@lette.us}
   s.extra_rdoc_files = [
@@ -42,7 +42,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.3.7}
+  s.rubygems_version = %q{1.4.2}
   s.summary = %q{A class based enumerator utility for Ruby on Rails}
   s.test_files = [
     "spec/classy_enum_attributes_spec.rb",
@@ -52,7 +52,6 @@ Gem::Specification.new do |s|
   ]
 
   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
@@ -60,7 +59,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<rspec-rails>, ["~> 2.0"])
       s.add_development_dependency(%q<formtastic>, ["~> 1.1"])
       s.add_development_dependency(%q<sqlite3-ruby>, [">= 0"])
-      s.add_runtime_dependency(%q<activerecord>, [">= 2.3"])
+      s.add_development_dependency(%q<activerecord>, [">= 2.3"])
     else
       s.add_dependency(%q<rspec>, ["~> 2.0"])
       s.add_dependency(%q<rspec-rails>, ["~> 2.0"])

data/generators/classy_enum_generator.rb

@@ -1,7 +1,7 @@
 class ClassyEnumGenerator < Rails::Generator::NamedBase
 
   def manifest
-    record do |m| 
+    record do |m|
       m.directory 'app/enums'
       m.template "enum.rb", "app/enums/#{file_name}.rb"
     end

data/generators/templates/enum.rb

@@ -2,6 +2,6 @@ class <%= class_name %> < ClassyEnum::Base
   enum_classes <%= args.map {|a| ":#{a}"}.join(", ") %>
 end
 <% args.each do |arg| %>
-class <%= class_name + arg.camelize %>
+class <%= class_name + arg.camelize %> < <%= class_name %>
 end
-<% end %> 
+<% end %>

data/lib/classy_enum.rb

@@ -1,13 +1,30 @@
 require "classy_enum/attributes"
 
 if Gem.available? 'formtastic'
-  require 'formtastic' 
+  require 'formtastic'
   require 'classy_enum/semantic_form_builder'
 end
 
 module ClassyEnum
 
   class Base
+
+    # Macro for defining enum members within a ClassyEnum class.
+    # Accepts an array of symbols or strings which are converted to
+    # ClassyEnum members as descents of their parent class.
+    #
+    # ==== Example
+    #  # Define an enum called Priority with three child classes
+    #  class Priority < ClassyEnum::Base
+    #    enum_classes :low, :medium, :high
+    #  end
+    #
+    #  The child classes will be defined with the following constants:
+    #  PriorityLow, PriorityMedium, and PriorityHigh
+    #
+    #  These child classes can be instantiated with either:
+    #  Priority.build(:low) or PriorityLow.new
+    #
     def self.enum_classes(*options)
       self.send(:attr_reader, :enum_classes)
 
@@ -18,6 +35,8 @@ module ClassyEnum
       options.each_with_index do |option, index|
 
         klass = Class.new(self) do
+          include InstanceMethods
+
           attr_reader :to_s, :to_sym, :index
 
           @index = index + 1
@@ -29,13 +48,6 @@ module ClassyEnum
             @index = self.class.instance_variable_get('@index')
           end
 
-          def name
-            @to_s.titleize
-          end
-
-          def <=> other
-            @index <=> other.index
-          end
         end
 
         klass_name = "#{self}#{option.to_s.camelize}"
@@ -45,29 +57,123 @@ module ClassyEnum
   end
 
   module ClassMethods
-      
+
+    # Build a new ClassyEnum child instance
+    #
+    # ==== Example
+    #  # Create an Enum with some elements
+    #  class Priority < ClassyEnum::Base
+    #    enum_classes :low, :medium, :high
+    #  end
+    #
+    #  Priority.build(:low) # => PriorityLow.new
     def build(option)
       return option if option.blank?
       return TypeError.new("Valid #{self} options are #{self.valid_options}") unless self::OPTIONS.include? option.to_sym
       Object.const_get("#{self}#{option.to_s.camelize}").new
     end
-    
-    # Alias of build
-    def find(option); build(option); end;
 
+    alias :find :build
+
+    # Returns an array of all instantiated enums
+    #
+    # ==== Example
+    #  # Create an Enum with some elements
+    #  class Priority < ClassyEnum::Base
+    #    enum_classes :low, :medium, :high
+    #  end
+    #
+    #  Priority.all # => [PriorityLow.new, PriorityMedium.new, PriorityHigh.new]
     def all
       self::OPTIONS.map {|e| build(e) }
     end
-    
-    # Uses the name field for select options
+
+    # Returns a 2D array for Rails select helper options.
+    # Also used internally for Formtastic support
+    #
+    # ==== Example
+    #  # Create an Enum with some elements
+    #  class Priority < ClassyEnum::Base
+    #    enum_classes :low, :really_high
+    #  end
+    #
+    #  Priority.select_options # => [["Low", "low"], ["Really High", "really_high"]]
     def select_options
       all.map {|e| [e.name, e.to_s] }
     end
-    
+
+    # Returns a comma separated list of valid enum options.
+    # Also used internally for ActiveRecord model validation error messages
+    #
+    # ==== Example
+    #  # Create an Enum with some elements
+    #  class Priority < ClassyEnum::Base
+    #    enum_classes :low, :medium, :high
+    #  end
+    #
+    #  Priority.valid_options # => "low, medium, high"
     def valid_options
       self::OPTIONS.map(&:to_s).join(', ')
     end
-  
+
+  end
+
+  module InstanceMethods
+    # Returns string representing enum in Rails titleize format
+    #
+    # ==== Example
+    #  # Create an Enum with some elements
+    #  class Priority < ClassyEnum::Base
+    #    enum_classes :low, :medium, :high, :really_high
+    #  end
+    #
+    #  @priority = Priority.build(:really_high)
+    #  @priority.name # => "Really High"
+    def name
+      @to_s.titleize
+    end
+
+    # Sort an array of elements based on the order they are defined
+    #
+    # ==== Example
+    #  # Create an Enum with some elements
+    #  class Priority < ClassyEnum::Base
+    #    enum_classes :low, :medium, :high
+    #  end
+    #
+    #  @low = Priority.build(:low)
+    #  @medium = Priority.build(:medium)
+    #  @high = Priority.build(:high)
+    #  priorities = [@low, @high, @medium]
+    #  priorities.sort # => [@low, @medium, @high]
+    #  priorities.max # => @high
+    #  priorities.min # => @low
+    def <=> other
+      @index <=> other.index
+    end
+
+    # Determine if the enum attribute is a particular member.
+    # Accepts a symbol or string representing a member
+    #
+    # ==== Example
+    #  # Create an Enum with some elements
+    #  class Breed < ClassyEnum::Base
+    #    enum_classes :golden_retriever, :snoop
+    #  end
+    #
+    #  # Create an ActiveRecord class using the Breed enum
+    #  class Dog < ActiveRecord::Base
+    #    classy_enum_attr :breed
+    #  end
+    #
+    #  @dog = Dog.new(:breed => :snoop)
+    #  @dog.breed.is? :snoop # => true
+    #  @dog.breed.is? 'snoop' # => true
+    #  @dog.breed.is? :golden_retriever # => false
+    def is?(obj)
+      obj.to_s == to_s
+    end
+
   end
 
 end

data/lib/classy_enum/attributes.rb

@@ -1,6 +1,23 @@
 module ClassyEnum
   module Attributes
 
+    # Class macro used to associate an enum with an attribute on an ActiveRecord model.
+    # This method is automatically added to all ActiveRecord models when the classy_enum gem
+    # is installed. Accepts an argument for the enum class to be associated with
+    # the model. If the enum class name is different than the field name, then an optional
+    # field name can be passed. ActiveRecord validation is automatically added to ensure
+    # that a value is one of its pre-defined enum members.
+    #
+    # ==== Example
+    #  # Associate an enum Priority with Alarm model's priority attribute
+    #  class Alarm < ActiveRecord::Base
+    #    classy_enum_attr :priority
+    #  end
+    #
+    #  # Associate an enum Priority with Alarm model's alarm_priority attribute
+    #  class Alarm < ActiveRecord::Base
+    #    classy_enum_attr :priority, :alarm_priority
+    #  end
     def classy_enum_attr(klass, method=nil)
 
       method ||= klass
@@ -14,12 +31,12 @@ module ClassyEnum
           record.errors.add(attr_name, "must be one of #{klass.all.map(&:to_sym).join(', ')}") unless klass.all.map(&:to_s).include? value.to_s
         end
 
-        # Define getter method
+        # Define getter method that returns a ClassyEnum instance
         define_method method do
           klass.build(super())
         end
 
-        # Define setter method
+        # Define setter method that accepts either string or symbol for member
         define_method "#{method}=" do |value|
           super(value.to_s)
         end

data/lib/classy_enum/semantic_form_builder.rb

@@ -1,5 +1,5 @@
 module ClassyEnum
-  class SemanticFormBuilder < Formtastic::SemanticFormBuilder
+  class SemanticFormBuilder < Formtastic::SemanticFormBuilder # :nodoc: all
     def enum_select_input(method, options)
       enum_class = object.send(method)
 
@@ -11,14 +11,14 @@ module ClassyEnum
         options[:collection] = enum_class.class.superclass.select_options
         options[:selected] = enum_class.to_s
       end
-      
+
       options[:include_blank] = false
-      
+
       select_input(method, options)
     end
   end
-  
-  module Error
+
+  module Error # :nodoc: all
     def self.invalid_classy_enum_object(method)
       raise "#{method} is not a ClassyEnum object"
     end

data/lib/generators/classy_enum/classy_enum_generator.rb

@@ -6,7 +6,7 @@ class ClassyEnumGenerator < Rails::Generators::NamedBase
 
   source_root File.expand_path("../templates", __FILE__)
 
-  def copy_files
+  def copy_files # :nodoc:
     empty_directory 'app/enums'
     template "enum.rb", "app/enums/#{file_name}.rb"
   end

data/lib/generators/classy_enum/templates/enum.rb

@@ -2,6 +2,6 @@ class <%= class_name %> < ClassyEnum::Base
   enum_classes <%= values.map {|a| ":#{a}"}.join(", ") %>
 end
 <% values.each do |arg| %>
-class <%= class_name + arg.camelize %>
+class <%= class_name + arg.camelize %> < <%= class_name %>
 end
-<% end %> 
+<% end %>

data/spec/classy_enum_attributes_spec.rb

@@ -14,9 +14,9 @@ describe "A Dog Collection" do
 end
 
 describe "A Dog" do
-  
+
   before(:each) { @dog = Dog.new(:breed => :golden_retriever) }
-  
+
   it "should have an enumerable breed" do
     @dog.breed.class.should == BreedGoldenRetriever
   end
@@ -25,13 +25,17 @@ describe "A Dog" do
     @dog.breed.should respond_to('enum_classes')
   end
 
+  it "should know which member the enum is" do
+    @dog.breed.is?(:golden_retriever).should be_true
+  end
+
   it "should be valid with a valid option" do
     @dog.should be_valid
   end
 
   context "with an invalid breed option" do
     before { @dog.breed = :golden_doodle }
-      
+
     it "should not be valid with an invalid option" do
       @dog.should_not be_valid
     end
@@ -40,17 +44,17 @@ describe "A Dog" do
       @dog.valid?
       @dog.errors.should include(:breed)
     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
 
 class Thing < ActiveRecord::Base
-  classy_enum_attr :breed, :dog_breed 
+  classy_enum_attr :breed, :dog_breed
 end
 
 describe "A Thing" do

data/spec/classy_enum_semantic_form_builder_spec.rb

@@ -1,8 +1,8 @@
 require "spec/spec_helper"
 
-describe 'using enum_select input' do 
+describe 'using enum_select input' do
   include FormtasticSpecHelper
-  
+
   Formtastic::SemanticFormHelper.builder = ClassyEnum::SemanticFormBuilder
 
   # Copied from how formtastic tests its form helpers
@@ -12,9 +12,9 @@ describe 'using enum_select input' do
 
   context "when building a form with a classy_enum select" do
     before(:each) do
-      @output = semantic_form_for(Dog.new(:breed => :snoop), :url => "/") do |builder| 
-        concat(builder.input(:breed, :as => :enum_select)) 
-      end 
+      @output = semantic_form_for(Dog.new(:breed => :snoop), :url => "/") do |builder|
+        concat(builder.input(:breed, :as => :enum_select))
+      end
     end
 
     it "should produce a form tag" do
@@ -34,9 +34,9 @@ describe 'using enum_select input' do
 
   context "when building a form with a classy_enum select, but the existing value is nil" do
     before(:each) do
-      @output = semantic_form_for(Dog.new, :url => "/") do |builder| 
-        concat(builder.input(:other_breed, :as => :enum_select, :enum_class => :breed)) 
-      end 
+      @output = semantic_form_for(Dog.new, :url => "/") do |builder|
+        concat(builder.input(:other_breed, :as => :enum_select, :enum_class => :breed))
+      end
     end
 
     it "should produce a form tag" do
@@ -56,9 +56,9 @@ describe 'using enum_select input' do
 
   context "when building a form with a classy_enum select, using the enum_attr option" do
     before(:each) do
-      @output = semantic_form_for(Dog.new, :url => "/") do |builder| 
-        concat(builder.input(:breed, :as => :enum_select)) 
-      end 
+      @output = semantic_form_for(Dog.new, :url => "/") do |builder|
+        concat(builder.input(:breed, :as => :enum_select))
+      end
     end
 
     it "should produce a form tag" do
@@ -78,19 +78,19 @@ describe 'using enum_select input' 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| 
-        concat(builder.input(:id, :as => :enum_select)) 
-      end 
+      @output = 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")
   end
 
   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| 
-        concat(builder.input(:id, :as => :enum_select)) 
-      end 
+      @output = 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")
   end
 
-end 
+end
 

data/spec/classy_enum_spec.rb

@@ -2,7 +2,7 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 class TestEnum < ClassyEnum::Base
   enum_classes :one, :two, :three
-  
+
   def self.test_class_method?
     false
   end
@@ -22,63 +22,80 @@ class TestEnumTwo
   end
 end
 
-describe TestEnum do
+describe "A ClassyEnum Descendent" do
 
   TestEnum::OPTIONS.each do |option|
    it "should define a TestEnum#{option.to_s.capitalize} class" do
      Object.const_defined?("TestEnum#{option.to_s.capitalize}").should be_true
    end
   end
-  
+
   it "should return an array of enums" do
     TestEnum.all.map(&:class).should == [TestEnumOne, TestEnumTwo, TestEnumThree]
   end
-  
+
   it "should return an array of enums for a select tag" do
     TestEnum.select_options.should == TestEnum::OPTIONS.map {|o| [TestEnum.build(o).name, TestEnum.build(o).to_s] }
   end
-  
+
   it "should return a type error when adding an invalid option" do
     TestEnum.build(:invalid_option).class.should == TypeError
   end
-  
-  context "with a collection of enums" do
-    before(:each) do
-      @one = TestEnum.build(:one)
-      @two = TestEnum.build(:two)
-      @three = TestEnum.build(:three)
-
-      @unordered = [@one, @three, @two]
-    end
-    
-    it "should sort the enums" do
-      @unordered.sort.should == [@one, @two, @three]
-    end
-
-    it "should find the max enum based on its order" do
-      @unordered.max.should == @three
-    end
-  end
-  
+
   it "should find an enum by symbol" do
     TestEnum.find(:one).class.should == TestEnumOne
   end
-  
+
   it "should find an enum by string" do
     TestEnum.find("one").class.should == TestEnumOne
   end
 
+  it "should create an instance with a string" do
+    TestEnum.build("one").should be_a(TestEnumOne)
+  end
+end
+
+describe "A collection of ClassyEnums" do
+  before(:each) do
+    @one = TestEnum.build(:one)
+    @two = TestEnum.build(:two)
+    @three = TestEnum.build(:three)
+
+    @unordered = [@one, @three, @two]
+  end
+
+  it "should sort the enums" do
+    @unordered.sort.should == [@one, @two, @three]
+  end
+
+  it "should find the max enum based on its order" do
+    @unordered.max.should == @three
+  end
+end
+
+describe "A ClassyEnum element" do
+  it "should instantiate a member" do
+    TestEnumOne.new.should be_a(TestEnumOne)
+  end
+
+  it "should inherit the default class methods" do
+    TestEnumOne.test_class_method?.should be_false
+  end
 end
 
 describe "A ClassyEnum instance" do
   before { @enum = TestEnum.build(:one) }
-  
+
   it "should build a TestEnum class" do
     @enum.class.should == TestEnumOne
   end
 
-  it "should instantiate a member" do
-    TestEnumOne.new.should be_a(TestEnumOne)
+  it "should return true for is_element?(:one)" do
+    @enum.is?(:one).should be_true
+  end
+
+  it "should return true for is_element?('one')" do
+    @enum.is?('one').should be_true
   end
 
   it "should be a TestEnum" do
@@ -88,7 +105,7 @@ describe "A ClassyEnum instance" do
   it "should convert to a string" do
     @enum.to_s.should == "one"
   end
-  
+
   it "should convert to a symbol" do
     @enum.to_sym.should == :one
   end
@@ -96,25 +113,15 @@ describe "A ClassyEnum instance" do
   it "should have a name" do
     @enum.name.should == "One"
   end
-  
+
   it "should inherit the default instance methods" do
     @enum.test_instance_method?.should be_false
   end
-
-  it "should inherit the default class methods" do
-    TestEnumOne.test_class_method?.should be_false
-  end
-  
-  it "should create the same instance with a string or symbol" do
-    @enum_string = TestEnum.build("one")
-    
-    @enum.class.should == @enum_string.class
-  end
 end
 
 describe "An ClassyEnumValue" do
   before(:each) { @enum = TestEnum.build(:two) }
-  
+
   it "should override the default instance methods" do
     @enum.test_instance_method?.should be_true
   end

data/spec/spec_helper.rb

@@ -51,7 +51,7 @@ module FormtasticSpecHelper
 
     end
   end
-  
+
 end
 
 module ActionView

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: classy_enum
 version: !ruby/object:Gem::Version 
-  hash: 5
-  prerelease: false
+  hash: 3
+  prerelease: 
   segments: 
   - 0
-  - 6
-  - 1
-  version: 0.6.1
+  - 7
+  - 0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Peter Brown
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-12 00:00:00 -05:00
+date: 2011-01-29 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -90,7 +90,7 @@ dependencies:
         - 2
         - 3
         version: "2.3"
-  type: :runtime
+  type: :development
   version_requirements: *id005
 description: A utility that adds class based enum functionality to ActiveRecord attributes
 email: github@lette.us
@@ -153,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.4.2
 signing_key: 
 specification_version: 3
 summary: A class based enumerator utility for Ruby on Rails