enumerate_it 0.1.0 → 0.2.0

data/.gitignore

@@ -19,3 +19,4 @@ rdoc
 pkg
 
 ## PROJECT::SPECIFIC
+enumerate_it-*.gem

data/README.rdoc

@@ -66,7 +66,7 @@ This will create some nice stuff:
 
 		RelationshipStatus.to_a # [["Divorced", 4],["Married", 2],["Single", 1],["Widow", 3]]
 
-* You can manipulate the has used to create the enumeration:
+* You can manipulate the hash used to create the enumeration:
 
 		RelationshipStatus.enumeration # returns the exact hash used to define the enumeration
 
@@ -90,16 +90,26 @@ This will create:
 		p.relationship_status = RelationshipStatus::DIVORCED
 		p.relationsip_status_humanize # => 'Divorced'
 
-* If your class can manage validations and responds to :validates_inclusion_of, it will create this
-validation:
+* If you pass the :create_helpers option as 'true', it will create a helper method for each enumeration option (this option defaults to false):
 
-  class Person < ActiveRecord::Base
-    has_enumeration_for :relationship_status, :with => RelationshipStatus
-  end
+	class Person < ActiveRecord::Base
+		has_enumeration_for :relationship_status, :with => RelationshipStatus, :create_helpers => true
+	end
+
+	p = Person.new
+	p.relationship_status = RelationshipStatus::MARRIED
+	p.married? #=> true
+	p.divorced? #=> false
+
+* If your class can manage validations and responds to :validates_inclusion_of, it will create this validation:
+
+	class Person < ActiveRecord::Base
+		has_enumeration_for :relationship_status, :with => RelationshipStatus
+	end
 
-  p = Person.new :relationship_status => 6 # => there is no '6' value in the enumeration
-  p.valid? # => false
-  p.errors[:relationship_status] # => "is not included in the list"
+	p = Person.new :relationship_status => 6 # => there is no '6' value in the enumeration
+	p.valid? # => false
+	p.errors[:relationship_status] # => "is not included in the list"
 
 Remember that in Rails 3 you can add validations to any kind of class and not only to those derived from 
 ActiveRecord::Base.

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/enumerate_it.gemspec

@@ -0,0 +1,55 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{enumerate_it}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["C\303\241ssio Marques"]
+  s.date = %q{2010-03-16}
+  s.description = %q{Have a legacy database and need some enumerations in your models to match those stupid '4 rows/2 columns' tables with foreign keys and stop doing joins just to fetch a simple description? Or maybe use some integers instead of strings as the code for each value of your enumerations? Here's EnumerateIt.}
+  s.email = %q{cassiommc@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "enumerate_it.gemspec",
+     "lib/enumerate_it.rb",
+     "spec/enumerate_it_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/cassiomarques/enumerate_it}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Ruby Enumerations}
+  s.test_files = [
+    "spec/enumerate_it_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/lib/enumerate_it.rb

@@ -89,6 +89,18 @@
 # p = Person.new
 # p.relationship_status = RelationshipStatus::DIVORCED
 # p.relationsip_status_humanize # => 'Divorced'
+#
+# - If you pass the :create_helpers option as 'true', it will create a helper method for each enumeration
+#  option (this option defaults to false):
+#
+#  class Person < ActiveRecord::Base
+#    has_enumeration_for :relationship_status, :with => RelationshipStatus, :create_helpers => true
+#  end
+#
+#  p = Person.new
+#  p.relationship_status = RelationshipStatus::MARRIED
+#  p.married? #=> true
+#  p.divorced? #=> false
 # 
 # - If your class can manage validations and responds to :validates_inclusion_of, it will create this
 # validation:
@@ -164,6 +176,9 @@ module EnumerateIt
         validates_inclusion_of attribute, :in => options[:with].list, :allow_blank => true
       end
       create_enumeration_humanize_method options[:with], attribute
+      if options[:create_helpers]
+        create_helper_methods options[:with], attribute
+      end
     end
 
     private
@@ -175,6 +190,16 @@ module EnumerateIt
         end
       end
     end    
+
+    def create_helper_methods(klass, attribute_name)
+      class_eval do
+        klass.enumeration.keys.each do |option|
+          define_method "#{option}?" do
+            self.send(attribute_name) == klass.enumeration[option].first
+          end
+        end
+      end
+    end
   end
 
   def self.included(receiver)

data/spec/enumerate_it_spec.rb

@@ -33,6 +33,24 @@ describe EnumerateIt do
       @target.foobar = nil
       @target.foobar_humanize.should be_nil
     end
+
+    it "defaults to not creating helper methods" do
+      @target.should_not respond_to(:value_1?)
+    end
+  end
+
+  context "using the option :create_helpers option" do
+    before :each do
+      class TestClass
+        has_enumeration_for :foobar, :with => TestEnumeration, :create_helpers => true
+      end
+    end
+
+    it "creates helpers methods with question marks for each enumeration option" do
+      target = TestClass.new(TestEnumeration::VALUE_2)
+      target.should be_value_2
+      target.should_not be_value_1
+    end
   end
 
   describe EnumerateIt::Base do

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - "C\xC3\xA1ssio Marques"
@@ -47,9 +47,9 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- enumerate_it.gemspec
 - lib/enumerate_it.rb
 - spec/enumerate_it_spec.rb
-- spec/renun_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 has_rdoc: true
@@ -84,5 +84,4 @@ specification_version: 3
 summary: Ruby Enumerations
 test_files: 
 - spec/enumerate_it_spec.rb
-- spec/renun_spec.rb
 - spec/spec_helper.rb

data/spec/renun_spec.rb

@@ -1,79 +0,0 @@
-#encoding: utf-8
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-
-class TestEnumeration < EnumerateIt::Base
-  associate_values(
-    :value_1 => ['1', 'Hey, I am 1!'],
-    :value_2 => ['2', 'Hey, I am 2!'],
-    :value_3 => ['3', 'Hey, I am 3!']
-  )
-end
-
-describe EnumerateIt do
-  before :each do
-    class TestClass
-      include EnumerateIt
-      attr_accessor :foobar
-      has_enumeration_for :foobar, :with => TestEnumeration
-
-      def initialize(foobar)
-        @foobar = foobar
-      end
-    end
-    
-    @target = TestClass.new(TestEnumeration::VALUE_2)
-  end
-
-  context "associating an enumeration with a class attribute" do
-    it "creates an humanized description for the attribute's value" do
-      @target.foobar_humanize.should == 'Hey, I am 2!'
-    end
-
-    it "if the attribute is blank, the humanize description is nil" do
-      @target.foobar = nil
-      @target.foobar_humanize.should be_nil
-    end
-  end
-
-  describe EnumerateIt::Base do
-    it "creates constants for each enumeration value" do
-      [TestEnumeration::VALUE_1, TestEnumeration::VALUE_2, TestEnumeration::VALUE_3].each_with_index do |constant, idx|
-        constant.should == (idx + 1).to_s
-      end
-    end
-
-    it "creates a method that returns the allowed values in the enumeration's class" do
-      TestEnumeration.list.should == ['1', '2', '3']
-    end
-
-    it "creates a method that returns the enumeration specification" do
-      TestEnumeration.enumeration.should == {
-        :value_1 => ['1', 'Hey, I am 1!'],
-        :value_2 => ['2', 'Hey, I am 2!'],
-        :value_3 => ['3', 'Hey, I am 3!']
-      }
-    end
-
-    describe ".to_a" do
-      it "returns an array with the values and human representations" do
-        TestEnumeration.to_a.should == [['Hey, I am 1!', '1'], ['Hey, I am 2!', '2'], ['Hey, I am 3!', '3']]
-      end
-    end
-
-    context "when included in ActiveRecord::Base" do
-      before :each do
-        class ActiveRecordStub; attr_accessor :bla; end
-        ActiveRecordStub.stub!(:respond_to?).with(:validates_inclusion_of).and_return(true)
-        ActiveRecordStub.stub!(:validates_inclusion_of).and_return(true)
-        ActiveRecordStub.send :include, EnumerateIt
-      end
-
-      it "creates a validation for inclusion" do
-        ActiveRecordStub.should_receive(:validates_inclusion_of).with(:bla, :in => TestEnumeration.list, :allow_blank => true)
-        class ActiveRecordStub
-          has_enumeration_for :bla, :with => TestEnumeration
-        end
-      end
-    end
-  end
-end