classy_enum 1.1.0 → 1.2.0

data/.travis.yml

@@ -0,0 +1,3 @@
+rvm:
+  - 1.8.7
+  - 1.9.2

data/Gemfile

@@ -4,9 +4,7 @@ gem 'rails', '~> 3.0.0'
 
 group :development do
   gem "jeweler", "~> 1.6.2"
-  gem "rcov", ">= 0"
   gem "rspec-rails", "~> 2.6.1"
   gem 'formtastic', '~> 1.2.4'
   gem 'sqlite3-ruby', :require => 'sqlite3'
-  gem 'ruby-debug19'
 end

data/Gemfile.lock

@@ -28,10 +28,8 @@ 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.4)
     diff-lcs (1.1.2)
     erubis (2.6.6)
       abstract (>= 1.0.0)
@@ -41,19 +39,17 @@ GEM
       i18n (~> 0.4)
     git (1.2.5)
     i18n (0.6.0)
-    jeweler (1.6.2)
+    jeweler (1.6.4)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
-    linecache19 (0.5.12)
-      ruby_core_source (>= 0.1.4)
     mail (2.2.19)
       activesupport (>= 2.3.6)
       i18n (>= 0.4.0)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
     mime-types (1.16)
-    polyglot (0.3.1)
+    polyglot (0.3.2)
     rack (1.2.3)
     rack-mount (0.6.14)
       rack (>= 1.0.0)
@@ -73,7 +69,6 @@ GEM
       rake (>= 0.8.7)
       thor (~> 0.14.4)
     rake (0.9.2)
-    rcov (0.9.9)
     rspec (2.6.0)
       rspec-core (~> 2.6.0)
       rspec-expectations (~> 2.6.0)
@@ -87,19 +82,10 @@ GEM
       activesupport (~> 3.0)
       railties (~> 3.0)
       rspec (~> 2.6.0)
-    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)
+    treetop (1.4.10)
+      polyglot
       polyglot (>= 0.3.1)
     tzinfo (0.3.29)
 
@@ -110,7 +96,5 @@ DEPENDENCIES
   formtastic (~> 1.2.4)
   jeweler (~> 1.6.2)
   rails (~> 3.0.0)
-  rcov
   rspec-rails (~> 2.6.1)
-  ruby-debug19
   sqlite3-ruby

data/README.textile

@@ -1,7 +1,9 @@
-h1. classy_enum
+h1. classy_enum "!https://secure.travis-ci.org/beerlington/classy_enum.png?branch=master!":http://travis-ci.org/beerlington/classy_enum
 
 ClassyEnum is a Ruby on Rails gem that adds class-based enumerator functionality to ActiveRecord attributes.
 
+!http://dl.dropbox.com/u/1934677/classy.jpg!
+
 h2. Rails & Ruby Versions Supported
 
 *Rails:*
@@ -82,6 +84,7 @@ My ActiveRecord Alarm model needs a text field that will store a string represen
 <pre>
 create_table "alarms", :force => true do |t|
   t.string   "priority"
+  t.boolean  "enabled"
 end
 </pre>
 
@@ -113,6 +116,38 @@ With this setup, I can now do the following:
 
 The enum field works like any other model attribute. It can be mass-assigned using @update_attribute(s)@.
 
+h2. Back reference to owning object
+
+In some cases you may want an enum class to be able to reference the owning object (an instance of the active record model). Think of it as a @belongs_to@ relationship, where the enum can reference its owning object.
+
+In order to create the back reference, you must declare how you wish to refer to the owner using the @owner@ class method.
+
+For example:
+
+<pre>
+class Priority < ClassyEnum::Base
+  enum_classes :low, :medium, :high
+  owner :alarm
+end
+
+class PriorityHigh < Priority
+  def send_email?
+    alarm.enabled?
+  end
+end
+</pre>
+
+In the above example, high priority alarms are only emailed if the owning alarm is enabled.
+
+<pre>
+@alarm = Alarm.create(:priority => :high, :enabled => true)
+
+# Should this alarm send an email?
+@alarm.send_email? # => true
+@alarm.enabled = false
+@alarm.send_email? # => false
+</pre>
+
 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*.

data/Rakefile

@@ -31,11 +31,6 @@ RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = FileList['spec/**/*_spec.rb']
 end
 
-RSpec::Core::RakeTask.new(:rcov) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
-
 task :default => :spec
 
 require 'rake/rdoctask'

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.2.0

data/classy_enum.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{classy_enum}
-  s.version = "1.1.0"
+  s.version = "1.2.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-07-25}
+  s.date = %q{2011-08-14}
   s.description = %q{A utility that adds class based enum functionality to ActiveRecord attributes}
   s.email = %q{github@lette.us}
   s.extra_rdoc_files = [
@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
     ".rvmrc",
+    ".travis.yml",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE",
@@ -37,7 +38,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_owner_reference_spec.rb",
     "spec/classy_enum_semantic_form_builder_spec.rb",
     "spec/classy_enum_spec.rb",
     "spec/spec_helper.rb"
@@ -45,7 +46,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/beerlington/classy_enum}
   s.licenses = [%q{MIT}]
   s.require_paths = [%q{lib}]
-  s.rubygems_version = %q{1.8.5}
+  s.rubygems_version = %q{1.8.6}
   s.summary = %q{A class based enumerator utility for Ruby on Rails}
 
   if s.respond_to? :specification_version then
@@ -54,28 +55,22 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<rails>, ["~> 3.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.6.2"])
-      s.add_development_dependency(%q<rcov>, [">= 0"])
       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-debug19>, [">= 0"])
     else
       s.add_dependency(%q<rails>, ["~> 3.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
-      s.add_dependency(%q<rcov>, [">= 0"])
       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-debug19>, [">= 0"])
     end
   else
     s.add_dependency(%q<rails>, ["~> 3.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
-    s.add_dependency(%q<rcov>, [">= 0"])
     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-debug19>, [">= 0"])
   end
 end
 

data/lib/classy_enum/attributes.rb

@@ -36,7 +36,7 @@ module ClassyEnum
 
         # Define getter method that returns a ClassyEnum instance
         define_method attribute do
-          klass.build(super())
+          klass.build(super(), self)
         end
 
         # Define setter method that accepts either string or symbol for member

data/lib/classy_enum/class_methods.rb

@@ -17,10 +17,10 @@ module ClassyEnum
     #  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"
+    def enum_classes(*enums)
+      self.const_set("OPTIONS", enums) unless self.const_defined? "OPTIONS"
 
-      options.each_with_index do |option, index|
+      enums.each_with_index do |option, index|
 
         klass = Class.new(self) do
           @index = index + 1
@@ -28,7 +28,7 @@ module ClassyEnum
 
           # Use ActiveModel::AttributeMethods to define attribute? methods
           attribute_method_suffix '?'
-          define_attribute_methods options
+          define_attribute_methods enums
 
           def initialize
             @to_s = self.class.instance_variable_get('@option').to_s
@@ -51,10 +51,13 @@ module ClassyEnum
     #  end
     #
     #  Priority.build(:low) # => PriorityLow.new
-    def build(option)
+    def build(option, owner = nil)
       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
+
+      object = Object.const_get("#{self}#{option.to_s.camelize}").new
+      object.instance_variable_set(:@owner,owner) unless owner.nil?
+      object
     end
 
     alias :find :build
@@ -100,5 +103,12 @@ module ClassyEnum
       self::OPTIONS.map(&:to_s).join(', ')
     end
 
+  private
+
+    # DSL setter method for reference to enum owner
+    def owner(owner)
+      define_method owner, lambda { @owner }
+    end
+
   end
 end

data/spec/classy_enum_attributes_spec.rb

@@ -3,20 +3,11 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 describe "A Dog" do
 
   context "with valid breed options" do
-    before { @dog = Dog.new(:breed => :golden_retriever) }
+    subject { Dog.new(:breed => :golden_retriever) }
 
-    it "should have a classy enum breed" do
-      @dog.breed.should be_a(BreedGoldenRetriever)
-    end
-
-    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
+    it { should be_valid }
+    its(:breed) { should be_a(BreedGoldenRetriever) }
+    its(:breed_options) { should eql({:enum => :breed, :allow_blank => false}) }
   end
 
   it "should not be valid with a nil breed" do
@@ -28,15 +19,13 @@ describe "A Dog" do
   end
 
   context "with invalid breed options" do
-    before { @dog = Dog.new(:breed => :fake_breed) }
+    let(:dog) { Dog.new(:breed => :fake_breed) }
+    subject { dog }
+    it { should_not be_valid }
 
-    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(', ')}")
+    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
 
@@ -45,16 +34,10 @@ end
 describe "A ClassyEnum that allows blanks" do
 
   context "with valid breed options" do
-    before { @dog = AllowBlankBreedDog.new(:breed => :golden_retriever) }
+    subject { 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
+    it { should be_valid }
+    its(:breed_options) { should eql({:enum => :breed, :allow_blank => true}) }
   end
 
   it "should be valid with a nil breed" do
@@ -66,15 +49,13 @@ describe "A ClassyEnum that allows blanks" do
   end
 
   context "with invalid breed options" do
-    before { @dog = AllowBlankBreedDog.new(:breed => :fake_breed) }
+    let(:dog) { AllowBlankBreedDog.new(:breed => :fake_breed) }
+    subject { dog }
+    it { should_not be_valid }
 
-    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(', ')}")
+    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
 
@@ -83,16 +64,10 @@ end
 describe "A ClassyEnum that allows nils" do
 
   context "with valid breed options" do
-    before { @dog = AllowNilBreedDog.new(:breed => :golden_retriever) }
+    subject { 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
+    it { should be_valid }
+    its(:breed_options) { should eql({:enum => :breed, :allow_blank => false}) }
   end
 
   it "should be valid with a nil breed" do
@@ -104,24 +79,19 @@ describe "A ClassyEnum that allows nils" do
   end
 
   context "with invalid breed options" do
-    before { @dog = AllowNilBreedDog.new(:breed => :fake_breed) }
+    let(:dog) { AllowNilBreedDog.new(:breed => :fake_breed) }
+    subject { dog }
+    it { should_not be_valid }
 
-    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(', ')}")
+    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) }
-
-  it "should have a classy enum breed" do
-    @dog.other_breed.should be_a(BreedSnoop)
-  end
+  subject { OtherDog.new(:other_breed => :snoop) }
+  its(:other_breed) { should be_a(BreedSnoop) }
 end

data/spec/classy_enum_owner_reference_spec.rb

@@ -0,0 +1,27 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+class CatBreed < ClassyEnum::Base
+  enum_classes :abyssian, :bengal, :birman, :persian
+  owner :cat
+
+  def breed_color
+    "#{cat.color} #{name}"
+  end
+end
+
+class Cat < ActiveRecord::Base
+  classy_enum_attr :breed, :enum => :cat_breed
+  attr_accessor :color
+  delegate :breed_color, :to => :breed
+end
+
+describe Cat do
+  let(:abyssian) { Cat.new(:breed => :abyssian, :color => 'black') }
+  let(:persian) { Cat.new(:breed => :persian, :color => 'white') }
+
+  it 'should delegate breed color to breed with an ownership reference' do
+    abyssian.breed_color { should eql('black Abyssian') }
+    persian.breed_color { should eql('white Persian') }
+
+  end
+end

data/spec/spec_helper.rb

@@ -39,6 +39,10 @@ ActiveRecord::Schema.define(:version => 1) do
     t.string :name
     t.integer :age
   end
+
+  create_table :cats, :force => true do |t|
+    t.string :breed
+  end
 end
 
 class Breed < ClassyEnum::Base

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: classy_enum
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-07-25 00:00:00.000000000Z
+date: 2011-08-14 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &2155094960 !ruby/object:Gem::Requirement
+  requirement: &70096296990640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *2155094960
+  version_requirements: *70096296990640
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2155094380 !ruby/object:Gem::Requirement
+  requirement: &70096296990120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,21 +32,10 @@ dependencies:
         version: 1.6.2
   type: :development
   prerelease: false
-  version_requirements: *2155094380
-- !ruby/object:Gem::Dependency
-  name: rcov
-  requirement: &2155093860 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *2155093860
+  version_requirements: *70096296990120
 - !ruby/object:Gem::Dependency
   name: rspec-rails
-  requirement: &2155093300 !ruby/object:Gem::Requirement
+  requirement: &70096296989520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +43,10 @@ dependencies:
         version: 2.6.1
   type: :development
   prerelease: false
-  version_requirements: *2155093300
+  version_requirements: *70096296989520
 - !ruby/object:Gem::Dependency
   name: formtastic
-  requirement: &2155092680 !ruby/object:Gem::Requirement
+  requirement: &70096296988940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,21 +54,10 @@ dependencies:
         version: 1.2.4
   type: :development
   prerelease: false
-  version_requirements: *2155092680
+  version_requirements: *70096296988940
 - !ruby/object:Gem::Dependency
   name: sqlite3-ruby
-  requirement: &2155092060 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *2155092060
-- !ruby/object:Gem::Dependency
-  name: ruby-debug19
-  requirement: &2155091460 !ruby/object:Gem::Requirement
+  requirement: &70096296988260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2155091460
+  version_requirements: *70096296988260
 description: A utility that adds class based enum functionality to ActiveRecord attributes
 email: github@lette.us
 executables: []
@@ -98,6 +76,7 @@ extra_rdoc_files:
 files:
 - .document
 - .rvmrc
+- .travis.yml
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -116,7 +95,7 @@ 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_owner_reference_spec.rb
 - spec/classy_enum_semantic_form_builder_spec.rb
 - spec/classy_enum_spec.rb
 - spec/spec_helper.rb
@@ -135,7 +114,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3853471588161721996
+      hash: -109022732353583855
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -144,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.5
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: A class based enumerator utility for Ruby on Rails