enumerate_it 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Cássio Marques
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,143 @@
+= EnumerateIt - Ruby Enumerations
+
+Author: Cássio Marques - cassiommc at gmail
+
+== Description
+
+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. 
+
+=== For example:
+
+	 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 
+
+
+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: 
+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, I put them inside models/. 
+
+  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...
+
+* You can retrieve a list with all the enumeration codes:
+
+		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]]
+
+* You can manipulate the has used to create 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
+
+    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'
+
+* 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"
+
+Remember that in Rails 3 you can add validations to any kind of class and not only to those derived from 
+ActiveRecord::Base.
+
+== Installation
+
+  gem install enumerate_it
+
+== Using with Rails
+
+* Create an initializer with the following code:
+
+  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)
+
+== 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. 
+
+== Why defining enumerations outside the class that use it?
+
+* I think it's cleaner.
+* You can add behaviour to the enumeration class.
+* 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
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Cássio Marques. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+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"
+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/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/enumerate_it.rb

@@ -0,0 +1,185 @@
+# encoding: utf-8
+
+# EnumerateIt - Ruby Enumerations
+#
+# Author: Cássio Marques - cassiommc at gmail
+#
+# = Description
+#
+# 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. 
+#
+# == For example:
+#
+#      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 
+#  
+# 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. More than this, referencing them in my code using magic numbers was terrible
+# and meaningless: What's 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, I put them inside models/. 
+#
+# 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...
+#
+# - You can retrieve a list with all the enumeration codes:
+#
+# 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]]
+#
+# - You can manipulate the has used to create 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
+#
+#   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'
+# 
+# - 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"
+#
+# Remember that in Rails 3 you can add validations to any kind of class and not only to those derived from 
+# ActiveRecord::Base.
+#
+# = Using with Rails/ActiveRecord
+# 
+# * Create an initializer with the following code:
+# 
+# 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)
+#
+# = 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. 
+#
+# = Why defining enumerations outside the class that used it?
+#
+# - I think it's cleaner.
+# - You can add behaviour to the enumeration class.
+# - You can reuse the enumeration inside other classes.
+# 
+module EnumerateIt
+  class Base
+    @@registered_enumerations = {}
+
+    def self.associate_values(values_hash)
+      register_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.register_enumeration(values_hash)
+      @@registered_enumerations[self] = values_hash
+    end
+
+    def self.define_enumeration_constant(name, value)
+      const_set name.to_s.upcase, value
+    end
+
+    def self.define_enumeration_list(values_hash)
+      def self.list 
+        @@registered_enumerations[self].values.map { |value| value[0] }.sort
+      end
+
+      def self.enumeration
+        @@registered_enumerations[self]
+      end
+
+      def self.to_a
+        @@registered_enumerations[self].values.map {|value| value.reverse }.sort_by { |value| value[0] }
+      end
+    end
+  end
+
+  module ClassMethods
+    def has_enumeration_for(attribute, options)
+      if self.respond_to? :validates_inclusion_of
+        validates_inclusion_of attribute, :in => options[:with].list, :allow_blank => true
+      end
+      create_enumeration_humanize_method options[:with], attribute
+    end
+
+    private
+    def create_enumeration_humanize_method(klass, attribute_name)
+      class_eval do
+        define_method "#{attribute_name}_humanize" do
+          values = klass.enumeration.values.detect { |v| v[0] == self.send(attribute_name) }
+          values ? values[1] : nil
+        end
+      end
+    end    
+  end
+
+  def self.included(receiver)
+    receiver.extend ClassMethods
+  end
+end
+
+

data/spec/enumerate_it_spec.rb

@@ -0,0 +1,79 @@
+#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

data/spec/renun_spec.rb

@@ -0,0 +1,79 @@
+#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

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'enumerate_it'
+require 'spec'
+require 'spec/autorun'
+
+require 'rubygems'
+require 'active_record'
+

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: enumerate_it
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- "C\xC3\xA1ssio Marques"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-16 00:00:00 -03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+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: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/enumerate_it.rb
+- spec/enumerate_it_spec.rb
+- spec/renun_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/cassiomarques/enumerate_it
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Ruby Enumerations
+test_files: 
+- spec/enumerate_it_spec.rb
+- spec/renun_spec.rb
+- spec/spec_helper.rb