enumerate_it 0.7.3 → 0.7.4

data/.gitignore

@@ -0,0 +1,23 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+enumerate_it-*.gem
+enumerate_it.gemspec

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in eblood_compomat.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    enumerate_it (0.7.4)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.5)
+      activesupport (= 3.0.5)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.5)
+      activemodel (= 3.0.5)
+      activesupport (= 3.0.5)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.5)
+    arel (2.0.9)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    i18n (0.5.0)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+    tzinfo (0.3.24)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (= 3.0.5)
+  enumerate_it!
+  rspec (= 2.5.0)

data/README.rdoc

@@ -6,41 +6,41 @@ Author: Cássio Marques - cassiommc at gmail
 
 Ok, I know there are a lot of different solutions to this problem. But none of them solved my problem,
 so here's EnumerateIt. I needed to build a Rails application around a legacy database and this database was
-filled with those small, unchangeable tables used to create foreign key constraints everywhere. 
+filled with those small, unchangeable tables used to create foreign key constraints everywhere.
 
 === For example:
 
-	 Table "public.relationshipstatus"
-	Column     |     Type      | Modifiers 
-	-------------+---------------+-----------
-	 code        | character(1)  | not null
-	 description | character(11) | 
-	Indexes:
-		"relationshipstatus_pkey" PRIMARY KEY, btree (code)
+   Table "public.relationshipstatus"
+  Column     |     Type      | Modifiers
+  -------------+---------------+-----------
+   code        | character(1)  | not null
+   description | character(11) |
+  Indexes:
+    "relationshipstatus_pkey" PRIMARY KEY, btree (code)
 
-	select * from relationshipstatus;
-	code   |  description  
-	-------+--------------
-	1      | Single   
-	2      | Married     
-	3      | Widow
-	4      | Divorced 
+  select * from relationshipstatus;
+  code   |  description
+  -------+--------------
+  1      | Single
+  2      | Married
+  3      | Widow
+  4      | Divorced
 
 
-And then I had things like a people table with a 'relationship_status' column with a foreign key 
+And then I had things like a people table with a 'relationship_status' column with a foreign key
 pointing to the relationshipstatus table.
 
 While this is a good thing from the database normalization perspective, managing this values in
-my tests was very hard. Doing database joins just to get the description of some value was absurd. 
-And, more than this, referencing them in my code using magic numbers was terrible and meaningless: 
+my tests was very hard. Doing database joins just to get the description of some value was absurd.
+And, more than this, referencing them in my code using magic numbers was terrible and meaningless:
 What does it mean when we say that someone or something is '2'?
 
 Enter EnumerateIt.
 
 == Creating enumerations
 
-Enumerations are created as models, but you can put then anywhere in your application. In Rails 
-applications, you can put them inside models/. 
+Enumerations are created as models, but you can put then anywhere in your application. In Rails
+applications, you can put them inside models/.
 
    class RelationshipStatus < EnumerateIt::Base
      associate_values(
@@ -66,7 +66,7 @@ This will create some nice stuff:
 
    RelationshipStatus.to_a # [["Divorced", 4],["Married", 2],["Single", 1],["Widow", 3]]
 
-* You can retrieve a list with values for a group of enumeration constants. 
+* You can retrieve a list with values for a group of enumeration constants.
 
    RelationshipStatus.values_for %w(MARRIED SINGLE) # [2, 1]
 
@@ -86,9 +86,9 @@ or not.
      has_enumeration_for :relationship_status, :with => RelationshipStatus
    end
 
-The :with option is not required. If you ommit it, EnumerateIt will try to load an enumeration class based on the camelized attribute name. 
+The :with option is not required. If you ommit it, EnumerateIt will try to load an enumeration class based on the camelized attribute name.
 
-This will create: 
+This will create:
 
 * A humanized description for the values of the enumerated attribute:
 
@@ -102,13 +102,17 @@ This will create:
      associate_values(
        :married => 1,
        :single => 2
-     ) 
+     )
    end
 
    p = Person.new
    p.relationship_status = RelationshipStatus::MARRIED
    p.relationship_status_humanize # => 'Married'
 
+* The associated enumerations can be retrieved with the 'enumerations' class method.
+
+  Person.enumerations[:relationship_status] # => RelationshipStatus
+
 * 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
@@ -120,6 +124,17 @@ This will create:
    p.married? #=> true
    p.divorced? #=> false
 
+* The :create_helpers also creates some mutator helper methods, that can be used to change the attribute's value.
+
+   class Person < ActiveRecord::Base
+     has_enumeration_for :relationship_status, :with => RelationshipStatus, :create_helpers => true
+   end
+
+   p = Person.new
+   p.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
@@ -141,7 +156,7 @@ This will create:
    p.errors[:relationship_status] # => "can't be blank"
 
 
-Remember that in Rails 3 you can add validations to any kind of class and not only to those derived from 
+Remember that in Rails 3 you can add validations to any kind of class and not only to those derived from
 ActiveRecord::Base.
 
 == I18n
@@ -162,16 +177,16 @@ located on enumerations.'enumeration_name'.'key' :
     enumerations:
       relationship_status:
         married: Casado
-  
+
   p = Person.new
   p.relationship_status = RelationshipStatus::MARRIED
-  p.relationship_status_humanize # => 'Casado' 
-  
+  p.relationship_status_humanize # => 'Casado'
+
   p.relationship_status = RelationshipStatus::SINGLE
-  p.relationship_status_humanize # => 'Single' => nonexistent key 
-  
+  p.relationship_status_humanize # => 'Single' => nonexistent key
+
   p.relationship_status = RelationshipStatus::DIVORCED
-  p.relationship_status_humanize # => 'He's divorced' => uses the provided string 
+  p.relationship_status_humanize # => 'He's divorced' => uses the provided string
 
 You can also translate specific values:
 
@@ -185,7 +200,7 @@ You can also translate specific values:
 
 * Create an initializer with the following code:
 
-  ActiveRecord::Base.send :include, EnumerateIt 
+  ActiveRecord::Base.send :include, EnumerateIt
 
 * Add the 'enumerate_it' gem as a dependency in your environment.rb (Rails 2.3.x) or Gemfile (if you're using Bundler)
 
@@ -201,11 +216,24 @@ An interesting approach to use it in Rails apps is to create an app/models/enume
 
 EnumerateIt is fully compatible with Ruby 1.9.1 and 1.9.2 (all tests pass)
 
+* Note: on ruby 1.9.2, if you are using the enumerations in a separate folder like app/models/enumerations, and have to use the :with parameter, you have to clear the enum class namespace to a global scope by using ::EnumClass instead of EnumClass:
+
+   # 1.8.7
+   class Person < ActiveRecord::Base
+     has_enumeration_for :relationship_status, :with => EnumClass
+   end
+
+   # 1.9.2
+   class Person < ActiveRecord::Base
+     has_enumeration_for :relationship_status, :with => ::EnumClass
+   end
+
+
 == Why did you reinvent the wheel?
 
 There are other similar solutions to the problem out there, but I could not find one that
-worked both with strings and integers as the enumerations' codes. I had both situations in 
-my legacy database. 
+worked both with strings and integers as the enumerations' codes. I had both situations in
+my legacy database.
 
 == Why defining enumerations outside the class that use it?
 
@@ -214,7 +242,7 @@ my legacy database.
 * You can reuse the enumeration inside other classes.
 
 == Note on Patches/Pull Requests
- 
+
 * Fork the project.
 * Make your feature addition or bug fix.
 * Add tests for it. This is important so I don't break it in a

data/Rakefile

@@ -1,47 +1,12 @@
 # encoding: utf-8
 
-require 'rubygems'
-require 'rake'
+require 'bundler'
+Bundler::GemHelper.install_tasks
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "enumerate_it"
-    gem.summary = %Q{Ruby Enumerations}
-    gem.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.}
-    gem.email = "cassiommc@gmail.com"
-    gem.homepage = "http://github.com/cassiomarques/enumerate_it"
-    gem.authors = ["Cássio Marques"]
-    gem.add_development_dependency "rspec", ">= 1.2.9"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
 end
 
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
-end
-
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
-
-task :spec => :check_dependencies
-
 task :default => :spec
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "enumerate_it #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/enumerate_it.gemspec

@@ -1,36 +1,22 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "version"
 
 Gem::Specification.new do |s|
   s.name = %q{enumerate_it}
-  s.version = "0.7.3"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.version     = EnumerateIt::VERSION
+  s.platform    = Gem::Platform::RUBY
   s.authors = ["C\303\241ssio Marques"]
-  s.date = %q{2011-02-03}
   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.homepage = %q{http://github.com/cassiomarques/enumerate_it}
   s.extra_rdoc_files = [
     "LICENSE",
     "README.rdoc"
   ]
-  s.files = [
-    ".document",
-    "LICENSE",
-    "README.rdoc",
-    "Rakefile",
-    "VERSION",
-    "enumerate_it.gemspec",
-    "lib/enumerate_it.rb",
-    "spec/enumerate_it_spec.rb",
-    "spec/i18n/en.yml",
-    "spec/i18n/pt.yml",
-    "spec/spec.opts",
-    "spec/spec_helper.rb"
-  ]
-  s.homepage = %q{http://github.com/cassiomarques/enumerate_it}
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Ruby Enumerations}
@@ -39,17 +25,8 @@ Gem::Specification.new do |s|
     "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::VERSION) >= 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
+  s.add_development_dependency "rspec", "=2.5.0"
+  s.add_development_dependency "activerecord", "=3.0.5"
+  s.add_development_dependency "activerecord", "=3.0.5"
 end
 

data/lib/enumerate_it.rb

@@ -111,6 +111,9 @@
 #  p.relationship_status = RelationshipStatus::MARRIED
 #  p.relationship_status_humanize # => 'Married'
 #
+# - The associated enumerations can be retrieved with the 'enumerations' class method.
+#  Person.enumerations[:relationship_status] # => RelationshipStatus
+#
 # - If you pass the :create_helpers option as 'true', it will create a helper method for each enumeration
 #  option (this option defaults to false):
 #
@@ -229,13 +232,23 @@ module EnumerateIt
       define_enumeration_class attribute, options
       set_validations attribute, options
       create_enumeration_humanize_method options[:with], attribute
+      store_enumeration options[:with], attribute
       if options[:create_helpers]
-        create_helper_methods(options[:with], attribute) 
+        create_helper_methods(options[:with], attribute)
         create_mutator_methods(options[:with], attribute)
       end
     end
 
+    def enumerations
+      @@_enumerations ||= {}
+    end
+
     private
+
+    def store_enumeration(klass, attribute)
+      enumerations[attribute] = klass
+    end
+
     def create_enumeration_humanize_method(klass, attribute_name)
       class_eval do
         define_method "#{attribute_name}_humanize" do
@@ -267,7 +280,7 @@ module EnumerateIt
     end
 
     def define_enumeration_class(attribute, options)
-      if options[:with].blank?
+      if options[:with].nil?
         options[:with] = attribute.to_s.camelize.constantize
       end
     end

data/lib/version.rb

@@ -0,0 +1,4 @@
+module EnumerateIt
+  VERSION = "0.7.4"
+end
+

data/spec/enumerate_it_spec.rb

@@ -54,6 +54,10 @@ describe EnumerateIt do
       @target.should_not respond_to(:value_1?)
     end
 
+    it "stores the enumeration class in a class-level hash" do
+      TestClass.enumerations[:foobar].should == TestEnumeration
+    end
+
     context "passing the value of each option without the human string (just the value, without an array)" do
       before :each do
         class TestClassForEnumerationWithoutArray
@@ -116,7 +120,7 @@ describe EnumerateIt do
     it "creates a mutator method for each enumeration value" do
       [:value_1, :value_2, :value_3].each do |value|
         TestClass.new(TestEnumeration::VALUE_1).should respond_to(:"#{value}!")
-      end 
+      end
     end
 
     it "changes the attribute's value through mutator methods" do

data/spec/spec_helper.rb

@@ -1,10 +1,11 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'enumerate_it'
-require 'spec'
-require 'spec/autorun'
+require 'rspec'
+require 'rspec/autorun'
 
 require 'rubygems'
-require 'active_record'
+require "active_support"
+require "active_support/core_ext/string/inflections"
 
-I18n.load_path = Dir['spec/i18n/*.yml']
+I18n.load_path = Dir['spec/i18n/*.yml']

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: enumerate_it
 version: !ruby/object:Gem::Version 
-  hash: 5
-  prerelease: false
-  segments: 
-  - 0
-  - 7
-  - 3
-  version: 0.7.3
+  prerelease: 
+  version: 0.7.4
 platform: ruby
 authors: 
 - "C\xC3\xA1ssio Marques"
@@ -15,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-03 00:00:00 -02:00
+date: 2011-03-11 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -24,16 +19,33 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
-        hash: 13
-        segments: 
-        - 1
-        - 2
-        - 9
-        version: 1.2.9
+        version: 2.5.0
   type: :development
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 3.0.5
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 3.0.5
+  type: :development
+  version_requirements: *id003
 description: 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.
 email: cassiommc@gmail.com
 executables: []
@@ -45,12 +57,15 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - .document
+- .gitignore
+- Gemfile
+- Gemfile.lock
 - LICENSE
 - README.rdoc
 - Rakefile
-- VERSION
 - enumerate_it.gemspec
 - lib/enumerate_it.rb
+- lib/version.rb
 - spec/enumerate_it_spec.rb
 - spec/i18n/en.yml
 - spec/i18n/pt.yml
@@ -70,23 +85,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: Ruby Enumerations

data/VERSION

@@ -1 +0,0 @@
-0.7.3