enumerate_it 0.2.0 → 0.3.0

data/README.rdoc

@@ -42,74 +42,87 @@ Enter EnumerateIt.
 Enumerations are created as models, but you can put then anywhere in your application. In Rails 
 applications, I put them inside models/. 
 
-  class RelationshipStatus < EnumerateIt::Base
-    associate_values(
-      :single   => [1, 'Single'],
-      :married  => [2, 'Married'],
-      :widow    => [3, 'Widow'],
-      :divorced => [4, 'Divorced'],
-    )
-  end
+   class RelationshipStatus < EnumerateIt::Base
+     associate_values(
+       :single   => [1, 'Single'],
+       :married  => [2, 'Married'],
+       :widow    => [3, 'Widow'],
+       :divorced => [4, 'Divorced'],
+     )
+   end
 
 This will create some nice stuff:
 
 * Each enumeration's value will turn into a constant:
 
-		RelationshipsStatus::SINGLE # returns 1
-		RelationshipStatus::MARRIED # returns 2 and so on...
+   RelationshipsStatus::SINGLE # returns 1
+   RelationshipStatus::MARRIED # returns 2 and so on...
 
 * You can retrieve a list with all the enumeration codes:
 
-		RelationshipStatus.list # [1,2,3,4]
+   RelationshipStatus.list # [1,2,3,4]
 
 * You can get an array of options, ready to use with the 'select', 'select_tag', etc family of Rails helpers.
 
-		RelationshipStatus.to_a # [["Divorced", 4],["Married", 2],["Single", 1],["Widow", 3]]
+   RelationshipStatus.to_a # [["Divorced", 4],["Married", 2],["Single", 1],["Widow", 3]]
 
 * You can manipulate the hash used to create the enumeration:
 
-		RelationshipStatus.enumeration # returns the exact hash used to define the enumeration
+   RelationshipStatus.enumeration # returns the exact hash used to define the enumeration
 
 == Using enumerations
 
 The cool part is that you can use these enumerations with any class, be it an ActiveRecord instance
 or not.
 
-  class Person
-    include EnumerateIt
-    attr_accessor :relationship_status
+   class Person
+     include EnumerateIt
+     attr_accessor :relationship_status
 
-    has_enumeration_for :relationship_status, :with => RelationshipStatus
-  end
+     has_enumeration_for :relationship_status, :with => RelationshipStatus
+   end
 
 This will create: 
 
 * A humanized description for the values of the enumerated attribute:
 
-		p = Person.new
-		p.relationship_status = RelationshipStatus::DIVORCED
-		p.relationsip_status_humanize # => 'Divorced'
+   p = Person.new
+   p.relationship_status = RelationshipStatus::DIVORCED
+   p.relationsip_status_humanize # => 'Divorced'
+
+* If you don't supply a humanized string to represent an option, EnumerateIt will use a 'humanized' version of the hash's key to humanize the attribute's value:
+
+   class RelationshipStatus < EnumerateIt::Base
+     associate_values(
+       :married => 1,
+       :single => 2
+     ) 
+   end
+
+   p = Person.new
+   p.relationship_status = RelationshipStatus::MARRIED
+   p.relationship_status_humanize # => 'Married'
 
 * 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
+   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
+   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
+   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.
@@ -126,6 +139,10 @@ ActiveRecord::Base.
 
 * Add the 'enumerate_it' gem as a dependency in your environment.rb (Rails 2.3.x) or Gemfile (if you're using Bundler)
 
+== Ruby 1.9
+
+EnumerateIt is fully compatible with Ruby 1.9.1 (all tests pass)
+
 == Why did you reinvent the wheel?
 
 There are other similar solutions to the problem out there, but I could not find one that

data/Rakefile

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'rubygems'
 require 'rake'
 

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/enumerate_it.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{enumerate_it}
-  s.version = "0.2.0"
+  s.version = "0.3.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.authors = ["Cássio Marques"]
+  s.date = %q{2010-03-22}
   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 = [

data/lib/enumerate_it.rb

@@ -88,7 +88,21 @@
 #
 # p = Person.new
 # p.relationship_status = RelationshipStatus::DIVORCED
-# p.relationsip_status_humanize # => 'Divorced'
+# p.relationship_status_humanize # => 'Divorced'
+#
+# - If you don't supply a humanized string to represent an option, EnumerateIt will use a 'humanized' 
+# version of the hash's key to humanize the attribute's value
+#
+#  class RelationshipStatus < EnumerateIt::Base
+#    associate_values(
+#      :married => 1,
+#      :single => 2
+#    ) 
+#  end
+#
+#  p = Person.new
+#  p.relationship_status = RelationshipStatus::MARRIED
+#  p.relationship_status_humanize # => 'Married'
 #
 # - If you pass the :create_helpers option as 'true', it will create a helper method for each enumeration
 #  option (this option defaults to false):
@@ -101,7 +115,7 @@
 #  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:
 #
@@ -141,12 +155,21 @@ module EnumerateIt
     @@registered_enumerations = {}
 
     def self.associate_values(values_hash)
-      register_enumeration values_hash
+      register_enumeration normalize_enumeration(values_hash)
       values_hash.each_pair { |value_name, attributes| define_enumeration_constant value_name, attributes[0] }
       define_enumeration_list values_hash
     end 
 
     private
+    def self.normalize_enumeration(values_hash)
+      values_hash.each_pair do |key, value| 
+        unless value.is_a? Array
+          values_hash[key] = [value, key.to_s.gsub(/_/, ' ').split.map(&:capitalize).join(' ')] 
+        end
+      end
+      values_hash
+    end
+
     def self.register_enumeration(values_hash)
       @@registered_enumerations[self] = values_hash
     end

data/spec/enumerate_it_spec.rb

@@ -9,6 +9,13 @@ class TestEnumeration < EnumerateIt::Base
   )
 end
 
+class TestEnumerationWithoutArray < EnumerateIt::Base
+  associate_values(
+    :value_one => '1',
+    :value_two => '2'
+  )
+end
+
 describe EnumerateIt do
   before :each do
     class TestClass
@@ -16,9 +23,7 @@ describe EnumerateIt do
       attr_accessor :foobar
       has_enumeration_for :foobar, :with => TestEnumeration
 
-      def initialize(foobar)
-        @foobar = foobar
-      end
+      def initialize(foobar); @foobar = foobar; end
     end
     
     @target = TestClass.new(TestEnumeration::VALUE_2)
@@ -37,6 +42,24 @@ describe EnumerateIt do
     it "defaults to not creating helper methods" do
       @target.should_not respond_to(:value_1?)
     end
+
+    context "passing the value of each option without the human string (just the value, without an array)" do
+      before :each do
+        class TestClassForEnumerationWithoutArray
+          include EnumerateIt
+          attr_accessor :foobar
+          has_enumeration_for :foobar, :with => TestEnumerationWithoutArray
+
+          def initialize(foobar); @foobar = foobar; end          
+        end
+
+        @target = TestClassForEnumerationWithoutArray.new(TestEnumerationWithoutArray::VALUE_TWO)
+      end
+
+      it "humanizes the respective hash key" do
+        @target.foobar_humanize.should == 'Value Two'
+      end
+    end
   end
 
   context "using the option :create_helpers option" do

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - "C\xC3\xA1ssio Marques"
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-16 00:00:00 -03:00
+date: 2010-03-22 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency