classy_enum 1.0.0 → 1.1.0

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.2

data/Gemfile

@@ -8,5 +8,5 @@ group :development do
   gem "rspec-rails", "~> 2.6.1"
   gem 'formtastic', '~> 1.2.4'
   gem 'sqlite3-ruby', :require => 'sqlite3'
-  gem 'ruby-debug'
+  gem 'ruby-debug19'
 end

data/Gemfile.lock

@@ -28,9 +28,10 @@ GEM
       activemodel (= 3.0.5)
       activesupport (= 3.0.5)
     activesupport (3.0.5)
+    archive-tar-minitar (0.5.2)
     arel (2.0.10)
     builder (2.1.2)
-    columnize (0.3.2)
+    columnize (0.3.4)
     diff-lcs (1.1.2)
     erubis (2.6.6)
       abstract (>= 1.0.0)
@@ -44,7 +45,8 @@ GEM
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
-    linecache (0.43)
+    linecache19 (0.5.12)
+      ruby_core_source (>= 0.1.4)
     mail (2.2.19)
       activesupport (>= 2.3.6)
       i18n (>= 0.4.0)
@@ -85,11 +87,16 @@ GEM
       activesupport (~> 3.0)
       railties (~> 3.0)
       rspec (~> 2.6.0)
-    ruby-debug (0.10.4)
-      columnize (>= 0.1)
-      ruby-debug-base (~> 0.10.4.0)
-    ruby-debug-base (0.10.4)
-      linecache (>= 0.3)
+    ruby-debug-base19 (0.11.25)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.5)
+      archive-tar-minitar (>= 0.5.2)
     sqlite3-ruby (1.3.1)
     thor (0.14.6)
     treetop (1.4.9)
@@ -105,5 +112,5 @@ DEPENDENCIES
   rails (~> 3.0.0)
   rcov
   rspec-rails (~> 2.6.1)
-  ruby-debug
+  ruby-debug19
   sqlite3-ruby

data/README.textile

@@ -2,11 +2,15 @@ h1. classy_enum
 
 ClassyEnum is a Ruby on Rails gem that adds class-based enumerator functionality to ActiveRecord attributes.
 
-h2. Requirements
+h2. Rails & Ruby Versions Supported
 
-*Rails:* 3.0.x. 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
+*Rails:*
 
-*Ruby:* Ruby 1.8.7 and 1.9.2.
+  * 3.1.0.rc: Mostly functional, known issue with using uniqueness validation with ClassyEnum attribute as a scope
+  * 3.0.0 - 3.0.9: Fully tested in a production application, no known issues
+  * 2.3.x: 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
+
+*Ruby:* Ruby 1.8.7 and 1.9.2 both tested and supported
 
 h2. Installation
 

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.0

data/classy_enum.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{classy_enum}
-  s.version = "1.0.0"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{Peter Brown}]
-  s.date = %q{2011-06-29}
+  s.date = %q{2011-07-25}
   s.description = %q{A utility that adds class based enum functionality to ActiveRecord attributes}
   s.email = %q{github@lette.us}
   s.extra_rdoc_files = [
@@ -18,6 +18,7 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     ".document",
+    ".rvmrc",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE",
@@ -27,7 +28,6 @@ Gem::Specification.new do |s|
     "classy_enum.gemspec",
     "init.rb",
     "lib/classy_enum.rb",
-    "lib/classy_enum/active_record.rb",
     "lib/classy_enum/attributes.rb",
     "lib/classy_enum/base.rb",
     "lib/classy_enum/class_methods.rb",
@@ -37,6 +37,7 @@ Gem::Specification.new do |s|
     "lib/generators/classy_enum/templates/enum.rb",
     "spec/active_record_spec.rb",
     "spec/classy_enum_attributes_spec.rb",
+    "spec/classy_enum_migration_spec.rb",
     "spec/classy_enum_semantic_form_builder_spec.rb",
     "spec/classy_enum_spec.rb",
     "spec/spec_helper.rb"
@@ -57,7 +58,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<rspec-rails>, ["~> 2.6.1"])
       s.add_development_dependency(%q<formtastic>, ["~> 1.2.4"])
       s.add_development_dependency(%q<sqlite3-ruby>, [">= 0"])
-      s.add_development_dependency(%q<ruby-debug>, [">= 0"])
+      s.add_development_dependency(%q<ruby-debug19>, [">= 0"])
     else
       s.add_dependency(%q<rails>, ["~> 3.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
@@ -65,7 +66,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<rspec-rails>, ["~> 2.6.1"])
       s.add_dependency(%q<formtastic>, ["~> 1.2.4"])
       s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
-      s.add_dependency(%q<ruby-debug>, [">= 0"])
+      s.add_dependency(%q<ruby-debug19>, [">= 0"])
     end
   else
     s.add_dependency(%q<rails>, ["~> 3.0.0"])
@@ -74,7 +75,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<rspec-rails>, ["~> 2.6.1"])
     s.add_dependency(%q<formtastic>, ["~> 1.2.4"])
     s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
-    s.add_dependency(%q<ruby-debug>, [">= 0"])
+    s.add_dependency(%q<ruby-debug19>, [">= 0"])
   end
 end
 

data/lib/classy_enum.rb

@@ -1,5 +1,8 @@
-require "classy_enum/active_record"
-require "classy_enum/base"
-require "classy_enum/class_methods"
-require "classy_enum/instance_methods"
-require "classy_enum/attributes"
+module ClassyEnum
+  autoload :Base, 'classy_enum/base'
+  autoload :InstanceMethods, 'classy_enum/instance_methods'
+  autoload :ClassMethods, 'classy_enum/class_methods'
+  autoload :Attributes, 'classy_enum/attributes'
+end
+
+ActiveRecord::Base.send :extend, ClassyEnum::Attributes

data/lib/classy_enum/attributes.rb

@@ -56,5 +56,3 @@ module ClassyEnum
 
   end
 end
-
-ActiveRecord::Base.send :extend, ClassyEnum::Attributes

data/lib/classy_enum/base.rb

@@ -1,52 +1,8 @@
 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.const_set("OPTIONS", options) unless self.const_defined? "OPTIONS"
-
-      self.extend ClassyEnum::ClassMethods
-      self.send(:include, ClassyEnum::InstanceMethods)
-      self.send(:include, Comparable)
-
-      options.each_with_index do |option, index|
-
-        klass = Class.new(self) do
-          @index = index + 1
-          @option = option
-
-          def initialize
-            @to_s = self.class.instance_variable_get('@option').to_s
-            @index = self.class.instance_variable_get('@index')
-          end
-
-          # Define methods to test member type (ie member.option?)
-          options.each do |o|
-            self.send(:define_method, "#{o}?", lambda { o == option })
-          end
-
-        end
-
-        klass_name = "#{self}#{option.to_s.camelize}"
-        Object.const_set(klass_name, klass) unless Object.const_defined? klass_name
-      end
-    end
+    extend ClassyEnum::ClassMethods
+    include ClassyEnum::InstanceMethods
+    include Comparable
+    include ActiveModel::AttributeMethods
   end
-
 end

data/lib/classy_enum/class_methods.rb

@@ -1,6 +1,47 @@
 module ClassyEnum
   module ClassMethods
 
+    # 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 enum_classes(*options)
+      self.const_set("OPTIONS", options) unless self.const_defined? "OPTIONS"
+
+      options.each_with_index do |option, index|
+
+        klass = Class.new(self) do
+          @index = index + 1
+          @option = option
+
+          # Use ActiveModel::AttributeMethods to define attribute? methods
+          attribute_method_suffix '?'
+          define_attribute_methods options
+
+          def initialize
+            @to_s = self.class.instance_variable_get('@option').to_s
+            @index = self.class.instance_variable_get('@index')
+          end
+
+        end
+
+        klass_name = "#{self}#{option.to_s.camelize}"
+        Object.const_set(klass_name, klass) unless Object.const_defined? klass_name
+      end
+    end
+
     # Build a new ClassyEnum child instance
     #
     # ==== Example

data/lib/classy_enum/instance_methods.rb

@@ -79,8 +79,20 @@ module ClassyEnum
       @index <=> other.index
     end
 
+    # Used by ActiveRecord::PredicateBuilder when building from a hash
+    def is_a?(klass)
+      return true if klass == ActiveRecord::Base
+      super(klass)
+    end
+
+    # Used by ActiveRecord::PredicateBuilder when building from a hash
+    def id
+      to_s
+    end
+
+  protected
+
     # Determine if the enum attribute is a particular member.
-    # Accepts a symbol or string representing a member
     #
     # ==== Example
     #  # Create an Enum with some elements
@@ -94,11 +106,17 @@ module ClassyEnum
     #  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
+    #  @dog.breed.snoop? # => true
+    #  @dog.breed.golden_retriever? # => false
+    def attribute?(attribute)
+      to_s == attribute
+    end
+
+  private
+
+    # Used by attribute methods
+    def attributes
+      []
     end
 
   end

data/spec/active_record_spec.rb

@@ -7,16 +7,29 @@ class ActiveDog < ActiveRecord::Base
     :presence => true,
     :uniqueness => { :scope => [:breed] }
 
+  scope :goldens, where(:breed => 'golden_retriever')
+
 end
 
 describe ActiveDog do
   before do
-    ActiveDog.create!(:name => 'Sebastian', :breed => :golden_retriever)
-    ActiveDog.create!(:name => 'Sirius', :breed => :husky)
+    ActiveDog.destroy_all
+    @golden = ActiveDog.create!(:name => 'Sebastian', :breed => :golden_retriever) 
+    @husky = ActiveDog.create!(:name => 'Sirius', :breed => :husky)
   end
 
   it 'should allow validation with classy enum scope' do
     dog = ActiveDog.new(:name => 'Sirius', :breed => :golden_retriever)
     dog.should be_valid
+    dog.breed.golden_retriever?.should be_true
+  end
+
+  it 'should know all dogs' do
+    ActiveDog.all.should include(@golden, @husky)
+  end
+
+  it 'should have a working scope' do
+    ActiveDog.goldens.should include(@golden)
+    ActiveDog.goldens.should_not include(@husky)
   end
 end

data/spec/classy_enum_spec.rb

@@ -56,21 +56,13 @@ describe "A ClassyEnum Descendent" do
 end
 
 describe "A collection of ClassyEnums" do
-  before(:each) do
-    @one = TestEnum.build(:one)
-    @two = TestEnum.build(:two)
-    @three = TestEnum.build(:three)
+  let(:one) { TestEnum.build(:one) }
+  let(:two) { TestEnum.build(:two) }
+  let(: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
+  subject { [one, three, two] }
+  its(:sort) { should eql([one, two, three]) }
+  its(:max) { should eql(three) }
 end
 
 describe "A ClassyEnum element" do
@@ -88,63 +80,24 @@ describe "A ClassyEnum element" do
 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 return true for is?(:one)" do
-    @enum.is?(:one).should be_true
-  end
-
-  it "should return true for is?('one')" do
-    @enum.is?('one').should be_true
-  end
-
-  it "should return true for one?" do
-    @enum.one?.should be_true
-  end
-
-  it "should return false for two?" do
-    @enum.two?.should be_false
-  end
-
-  it "should be a TestEnum" do
-    @enum.should be_a(TestEnum)
-  end
-
-  it "should have an index" do
-    @enum.index.should == 1
-  end
-
-  it "should index as to_i" do
-    @enum.to_i.should == 1
-  end
-
-  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
-
-  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
+  subject { TestEnum.build(:one) }
+
+  it { should be_a(TestEnum) }
+  its(:class) { should eql(TestEnumOne) }
+  its(:one?) { should be_true }
+  its(:two?) { should be_false }
+  its(:index) { should eql(1) }
+  its(:to_i) { should eql(1) }
+  its(:to_s) { should eql('one') }
+  its(:to_sym) { should be(:one) }
+  its(:name) { should eql('One') }
+  its(:test_instance_method?) { should be_false }
 end
 
-describe "An ClassyEnumValue" do
-  before(:each) { @enum = TestEnum.build(:two) }
+describe "A ClassyEnum that overrides values" do
+  subject { TestEnum.build(:two) }
 
-  it "should override the default instance methods" do
-    @enum.test_instance_method?.should be_true
-  end
+  its(:test_instance_method?) { should be_true }
 
   it "should override the default class methods" do
     TestEnumTwo.test_class_method?.should be_true

metadata

@@ -1,139 +1,103 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: classy_enum
-version: !ruby/object:Gem::Version 
-  hash: 23
+version: !ruby/object:Gem::Version
+  version: 1.1.0
   prerelease: 
-  segments: 
-  - 1
-  - 0
-  - 0
-  version: 1.0.0
 platform: ruby
-authors: 
+authors:
 - Peter Brown
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-06-29 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+date: 2011-07-25 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &2155094960 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        - 0
+      - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
-  requirement: *id001
   prerelease: false
-  name: rails
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2155094960
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2155094380 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 1
-        - 6
-        - 2
+      - !ruby/object:Gem::Version
         version: 1.6.2
   type: :development
-  requirement: *id002
   prerelease: false
-  name: jeweler
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2155094380
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &2155093860 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  requirement: *id003
   prerelease: false
-  name: rcov
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *2155093860
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: &2155093300 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 21
-        segments: 
-        - 2
-        - 6
-        - 1
+      - !ruby/object:Gem::Version
         version: 2.6.1
   type: :development
-  requirement: *id004
   prerelease: false
-  name: rspec-rails
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *2155093300
+- !ruby/object:Gem::Dependency
+  name: formtastic
+  requirement: &2155092680 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 2
-        - 4
+      - !ruby/object:Gem::Version
         version: 1.2.4
   type: :development
-  requirement: *id005
   prerelease: false
-  name: formtastic
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: *2155092680
+- !ruby/object:Gem::Dependency
+  name: sqlite3-ruby
+  requirement: &2155092060 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  requirement: *id006
   prerelease: false
-  name: sqlite3-ruby
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: *2155092060
+- !ruby/object:Gem::Dependency
+  name: ruby-debug19
+  requirement: &2155091460 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  requirement: *id007
   prerelease: false
-  name: ruby-debug
+  version_requirements: *2155091460
 description: A utility that adds class based enum functionality to ActiveRecord attributes
 email: github@lette.us
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE
 - README.textile
-files: 
+files:
 - .document
+- .rvmrc
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -143,7 +107,6 @@ files:
 - classy_enum.gemspec
 - init.rb
 - lib/classy_enum.rb
-- lib/classy_enum/active_record.rb
 - lib/classy_enum/attributes.rb
 - lib/classy_enum/base.rb
 - lib/classy_enum/class_methods.rb
@@ -153,41 +116,36 @@ files:
 - lib/generators/classy_enum/templates/enum.rb
 - spec/active_record_spec.rb
 - spec/classy_enum_attributes_spec.rb
+- spec/classy_enum_migration_spec.rb
 - spec/classy_enum_semantic_form_builder_spec.rb
 - spec/classy_enum_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/beerlington/classy_enum
-licenses: 
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -3853471588161721996
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
 rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: A class based enumerator utility for Ruby on Rails
 test_files: []
-

data/lib/classy_enum/active_record.rb

@@ -1,15 +0,0 @@
-module ActiveRecord # :nodoc: all
-  class PredicateBuilder
-    def build_from_hash_with_classy_enum(attributes, default_table)
-
-      # Convert classy enum values to strings
-      attributes.map do |column, value|
-        attributes[column] = value.to_s if value.is_a? ClassyEnum::Base
-      end
-
-      build_from_hash_without_classy_enum(attributes, default_table)
-    end
-
-    alias_method_chain :build_from_hash, :classy_enum
-  end
-end