enumerate_it 1.0.3 → 1.1.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    enumerate_it (1.0.3)
+    enumerate_it (1.1.0)
       activesupport (>= 3.0.0)
 
 GEM

data/README.rdoc

@@ -117,6 +117,22 @@ You can also create enumerations in the following ways:
      associate_values :married => 1, :single => 2
    end
 
+=== Defining a default sort mode
+
+When calling methods like `to_a` and `to_json`, the returned values will be sorted using the translation for each one of the enumeration values. If you want
+to overwrite the default sort mode, you can use the `sort_mode` class method.
+
+    class RelationshipStatus < EnumerateIt::Base
+      associate_values :married => 1, :single => 2
+
+      sort_by :value
+    end
+
+The `sort_by` methods accept one of the following values:
+
+* `:translation`: The default behavior, will sort the returned values based on translations.
+* `:value`: Will sort the returned values based on values.
+* `:name`: Will sort the returned values based on the name of each enumeration option.
 
 == Using enumerations
 
@@ -282,7 +298,7 @@ An interesting approach to use it in Rails apps is to create an app/enumerations
 
 There is also a Rails Generator that you can use to generate enumerations and their locale files. Take a look at how to use it running
 
-  rails generate enumerate_it --help
+  rails generate enumerate_it:enum --help
 
 == Why did you reinvent the wheel?
 

data/lib/enumerate_it/base.rb

@@ -3,6 +3,10 @@ module EnumerateIt
   class Base
     @@registered_enumerations = {}
 
+    class << self
+      attr_reader :sort_mode
+    end
+
     def self.associate_values(*args)
       values_hash = args.first.is_a?(Hash) ? args.first : args.inject({}) { |h, v| h[v] = v.to_s; h }
 
@@ -10,6 +14,10 @@ module EnumerateIt
       values_hash.each_pair { |value_name, attributes| define_enumeration_constant value_name, attributes[0] }
     end
 
+    def self.sort_by(sort_mode)
+      @sort_mode = sort_mode
+    end
+
     def self.list
       enumeration.values.map { |value| value[0] }.sort
     end
@@ -19,7 +27,7 @@ module EnumerateIt
     end
 
     def self.to_a
-      enumeration.values.map {|value| [translate(value[1]), value[0]] }.sort_by { |value| value[0] }
+      sorted_map.map { |k, v| [translate(v[1]), v[0]] }
     end
 
     def self.length
@@ -35,7 +43,7 @@ module EnumerateIt
     end
 
     def self.to_json
-      enumeration.values.collect {|value| { :value => value[0], :label => translate(value[1]) } }.to_json
+      sorted_map.map { |k, v| { :value => v[0], :label => translate(v[1]) } }.to_json
     end
 
     def self.t(value)
@@ -64,6 +72,19 @@ module EnumerateIt
     end
 
     private
+
+    def self.sorted_map
+      enumeration.sort_by { |k, v| sort_lambda.call(k, v) }
+    end
+
+    def self.sort_lambda
+      {
+        :value       => lambda { |k, v| v[0] },
+        :name        => lambda { |k, v| k },
+        :translation => lambda { |k, v| translate(v[1]) }
+      }[sort_mode || :translation]
+    end
+
     def self.translate(value)
       return value unless value.is_a? Symbol
 

data/lib/enumerate_it/version.rb

@@ -1,3 +1,3 @@
 module EnumerateIt
-  VERSION = "1.0.3"
+  VERSION = "1.1.0"
 end

data/lib/generators/enumerate_it/enum/USAGE

@@ -8,7 +8,7 @@ Example:
         app/enumerations/civil_status.rb with `associate_values :single, :married, :divorced, :widower, :concubinage, :separated, :stable`
         config/locales/civil_status.yml
 
-    rails g enumerate_it CivilStatus single:1 married:2 divorced:3 widower:4
+    rails g enumerate_it:enum CivilStatus single:1 married:2 divorced:3 widower:4
 
     This will create:
         app/enumerations/civil_status.rb with `associate_values :single => 1, :married => 2, :divorced => 2, :widower => 4`

data/spec/enumerate_it/base_spec.rb

@@ -0,0 +1,200 @@
+# encoding: utf-8
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+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 ".length" do
+    it "returns the length of the enumeration" do
+      TestEnumeration.length.should == 3
+    end
+  end
+
+  describe ".each_translation" do
+    it "yields each enumeration's value translation" do
+      translations = []
+      TestEnumeration.each_translation do |translation|
+        translations << translation
+      end
+      translations.should == ["Hey, I am 1!", "Hey, I am 2!", "Hey, I am 3!"]
+    end
+  end
+
+  describe ".each_value" do
+    it "yields each enumeration's value" do
+      values = []
+      TestEnumeration.each_value do |value|
+        values << value
+      end
+      values.should == TestEnumeration.list
+    end
+  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
+
+    it "translates the available values" do
+      TestEnumerationWithoutArray.to_a.should == [['First Value', '1'], ['Value Two', '2']]
+      I18n.locale = :pt
+      TestEnumerationWithoutArray.to_a.should == [['Primeiro Valor', '1'], ['Value Two', '2']]
+    end
+
+    it "can be extended from the enumeration class" do
+      TestEnumerationWithExtendedBehaviour.to_a.should == [['Second', '2'],['First','1']]
+    end
+  end
+
+  describe ".to_json" do
+    it "gives a valid json back" do
+      I18n.locale = :inexsistent
+      TestEnumerationWithoutArray.to_json.should == '[{"value":"1","label":"Value One"},{"value":"2","label":"Value Two"}]'
+    end
+
+    it "give translated values when available" do
+      I18n.locale = :pt
+      TestEnumerationWithoutArray.to_json.should == '[{"value":"1","label":"Primeiro Valor"},{"value":"2","label":"Value Two"}]'
+    end
+  end
+
+  describe ".t" do
+    it "translates a given value" do
+      I18n.locale = :pt
+      TestEnumerationWithoutArray.t('1').should == 'Primeiro Valor'
+    end
+  end
+
+  describe ".to_range" do
+    it "returns a Range object containing the enumeration's value interval" do
+      TestEnumeration.to_range.should == ("1".."3")
+    end
+  end
+
+  describe ".values_for" do
+    it "returns an array with the corresponding values for a string array representing some of the enumeration's values" do
+      TestEnumeration.values_for(%w(VALUE_1 VALUE_2)).should == [TestEnumeration::VALUE_1, TestEnumeration::VALUE_2]
+    end
+  end
+
+  describe ".value_for" do
+    it "returns the enumeration's value" do
+      TestEnumeration.value_for("VALUE_1").should == TestEnumeration::VALUE_1
+    end
+  end
+
+  describe ".keys" do
+    it "returns a list with the keys used to define the enumeration" do
+      TestEnumeration.keys.should == [:value_1, :value_2, :value_3]
+    end
+  end
+
+  describe ".key_for" do
+    it "returns the key for the given value inside the enumeration" do
+      TestEnumeration.key_for(TestEnumeration::VALUE_1).should == :value_1
+    end
+
+    it "returns nil if the enumeration does not have the given value" do
+      TestEnumeration.key_for("foo").should be_nil
+    end
+  end
+
+  context 'associate values with a list' do
+    it "creates constants for each enumeration value" do
+      TestEnumerationWithList::FIRST.should == "first"
+      TestEnumerationWithList::SECOND.should == "second"
+    end
+
+    it "returns an array with the values and human representations" do
+      TestEnumerationWithList.to_a.should == [['First', 'first'], ['Second', 'second']]
+    end
+  end
+
+  context "specifying a default sort mode" do
+    subject { create_enumeration_class_with_sort_mode(sort_mode).to_a }
+
+    context "by value" do
+      let(:sort_mode) { :value }
+
+      it { should == [["xyz", "1"], ["fgh", "2"], ["abc", "3"]] }
+    end
+
+    context "by name" do
+      let(:sort_mode) { :name }
+
+      it { should == [["fgh", "2"], ["xyz", "1"], ["abc", "3"]] }
+    end
+
+    context "by translation" do
+      let(:sort_mode) { :translation }
+
+      it { should == [["abc", "3"] ,["fgh", "2"], ["xyz", "1"]] }
+    end
+  end
+
+  context "when included in ActiveRecord::Base" do
+    before :each do
+      class ActiveRecordStub
+        attr_accessor :bla
+
+        class << self
+          def validates_inclusion_of(options); true; end
+          def validates_presence_of; true; end
+        end
+      end
+
+      ActiveRecordStub.stub!(:validates_inclusion_of).and_return(true)
+      ActiveRecordStub.extend 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
+
+    context "using the :required option" do
+      before :each do
+        ActiveRecordStub.stub!(:validates_presence_of).and_return(true)
+      end
+
+      it "creates a validation for presence" do
+        ActiveRecordStub.should_receive(:validates_presence_of)
+        class ActiveRecordStub
+          has_enumeration_for :bla, :with => TestEnumeration, :required => true
+        end
+      end
+
+      it "passes the given options to the validation method" do
+        ActiveRecordStub.should_receive(:validates_presence_of).with(:bla, :if => :some_method)
+        class ActiveRecordStub
+          has_enumeration_for :bla, :with => TestEnumeration, :required => { :if => :some_method }
+        end
+      end
+
+      it "do not require the attribute by default" do
+        ActiveRecordStub.should_not_receive(:validates_presence_of)
+        class ActiveRecordStub
+          has_enumeration_for :bla, :with => TestEnumeration
+        end
+      end
+    end
+  end
+end

data/spec/enumerate_it_spec.rb

@@ -1,46 +1,5 @@
 #encoding: utf-8
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-require 'active_record'
-
-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
-
-class TestEnumerationWithoutArray < EnumerateIt::Base
-  associate_values(
-    :value_one => '1',
-    :value_two => '2'
-  )
-end
-
-class TestEnumerationWithExtendedBehaviour < EnumerateIt::Base
-  associate_values(
-    :first => '1',
-    :second => '2'
-  )
-  def self.to_a
-    super.reverse
-  end
-end
-
-class TestEnumerationWithList < EnumerateIt::Base
-  associate_values :first, :second
-end
-
-class Foobar < EnumerateIt::Base
-  associate_values(
-    :bar => 'foo'
-  )
-end
-
-class BaseClass
-  extend EnumerateIt
-  has_enumeration_for :foobar, :with => TestEnumeration
-end
 
 describe EnumerateIt do
   before :each do
@@ -266,178 +225,3 @@ describe EnumerateIt do
   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 ".length" do
-    it "returns the length of the enumeration" do
-      TestEnumeration.length.should == 3
-    end
-  end
-
-  describe ".each_translation" do
-    it "yields each enumeration's value translation" do
-      translations = []
-      TestEnumeration.each_translation do |translation|
-        translations << translation
-      end
-      translations.should == ["Hey, I am 1!", "Hey, I am 2!", "Hey, I am 3!"]
-    end
-  end
-
-  describe ".each_value" do
-    it "yields each enumeration's value" do
-      values = []
-      TestEnumeration.each_value do |value|
-        values << value
-      end
-      values.should == TestEnumeration.list
-    end
-  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
-
-    it "translates the available values" do
-      TestEnumerationWithoutArray.to_a.should == [['First Value', '1'], ['Value Two', '2']]
-      I18n.locale = :pt
-      TestEnumerationWithoutArray.to_a.should == [['Primeiro Valor', '1'], ['Value Two', '2']]
-    end
-
-    it "can be extended from the enumeration class" do
-      TestEnumerationWithExtendedBehaviour.to_a.should == [['Second', '2'],['First','1']]
-    end
-  end
-
-  describe ".to_json" do
-    it "gives a valid json back" do
-      I18n.locale = :inexsistent
-      TestEnumerationWithoutArray.to_json.should == '[{"value":"1","label":"Value One"},{"value":"2","label":"Value Two"}]'
-    end
-
-    it "give translated values when available" do
-      I18n.locale = :pt
-      TestEnumerationWithoutArray.to_json.should == '[{"value":"1","label":"Primeiro Valor"},{"value":"2","label":"Value Two"}]'
-    end
-  end
-
-  describe ".t" do
-    it "translates a given value" do
-      I18n.locale = :pt
-      TestEnumerationWithoutArray.t('1').should == 'Primeiro Valor'
-    end
-  end
-
-  describe ".to_range" do
-    it "returns a Range object containing the enumeration's value interval" do
-      TestEnumeration.to_range.should == ("1".."3")
-    end
-  end
-
-  describe ".values_for" do
-    it "returns an array with the corresponding values for a string array representing some of the enumeration's values" do
-      TestEnumeration.values_for(%w(VALUE_1 VALUE_2)).should == [TestEnumeration::VALUE_1, TestEnumeration::VALUE_2]
-    end
-  end
-
-  describe ".value_for" do
-    it "returns the enumeration's value" do
-      TestEnumeration.value_for("VALUE_1").should == TestEnumeration::VALUE_1
-    end
-  end
-
-  describe ".keys" do
-    it "returns a list with the keys used to define the enumeration" do
-      TestEnumeration.keys.should == [:value_1, :value_2, :value_3]
-    end
-  end
-
-  describe ".key_for" do
-    it "returns the key for the given value inside the enumeration" do
-      TestEnumeration.key_for(TestEnumeration::VALUE_1).should == :value_1
-    end
-
-    it "returns nil if the enumeration does not have the given value" do
-      TestEnumeration.key_for("foo").should be_nil
-    end
-  end
-
-  context 'associate values with a list' do
-    it "creates constants for each enumeration value" do
-      TestEnumerationWithList::FIRST.should == "first"
-      TestEnumerationWithList::SECOND.should == "second"
-    end
-
-    it "returns an array with the values and human representations" do
-      TestEnumerationWithList.to_a.should == [['First', 'first'], ['Second', 'second']]
-    end
-  end
-
-  context "when included in ActiveRecord::Base" do
-    before :each do
-      class ActiveRecordStub
-        attr_accessor :bla
-
-        class << self
-          def validates_inclusion_of(options); true; end
-          def validates_presence_of; true; end
-        end
-      end
-
-      ActiveRecordStub.stub!(:validates_inclusion_of).and_return(true)
-      ActiveRecordStub.extend 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
-
-    context "using the :required option" do
-      before :each do
-        ActiveRecordStub.stub!(:validates_presence_of).and_return(true)
-      end
-
-      it "creates a validation for presence" do
-        ActiveRecordStub.should_receive(:validates_presence_of)
-        class ActiveRecordStub
-          has_enumeration_for :bla, :with => TestEnumeration, :required => true
-        end
-      end
-
-      it "passes the given options to the validation method" do
-        ActiveRecordStub.should_receive(:validates_presence_of).with(:bla, :if => :some_method)
-        class ActiveRecordStub
-          has_enumeration_for :bla, :with => TestEnumeration, :required => { :if => :some_method }
-        end
-      end
-
-      it "do not require the attribute by default" do
-        ActiveRecordStub.should_not_receive(:validates_presence_of)
-        class ActiveRecordStub
-          has_enumeration_for :bla, :with => TestEnumeration
-        end
-      end
-    end
-  end
-end

data/spec/spec_helper.rb

@@ -1,12 +1,15 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-require 'enumerate_it'
-require 'rspec'
-require 'rspec/autorun'
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+require "enumerate_it"
+require "rspec"
+require "rspec/autorun"
 
-require 'rubygems'
+require "rubygems"
 require "active_support"
+require "active_record"
 require "active_support/core_ext/string/inflections"
-require 'active_support/core_ext/object/to_json'
+require "active_support/core_ext/object/to_json"
 
-I18n.load_path = Dir['spec/i18n/*.yml']
+Dir["./spec/support/**/*.rb"].each { |f| require f }
+
+I18n.load_path = Dir["spec/i18n/*.yml"]

data/spec/support/test_classes.rb

@@ -0,0 +1,52 @@
+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
+
+class TestEnumerationWithoutArray < EnumerateIt::Base
+  associate_values(
+    :value_one => '1',
+    :value_two => '2'
+  )
+end
+
+class TestEnumerationWithExtendedBehaviour < EnumerateIt::Base
+  associate_values(
+    :first => '1',
+    :second => '2'
+  )
+  def self.to_a
+    super.reverse
+  end
+end
+
+class TestEnumerationWithList < EnumerateIt::Base
+  associate_values :first, :second
+end
+
+class Foobar < EnumerateIt::Base
+  associate_values(
+    :bar => 'foo'
+  )
+end
+
+class BaseClass
+  extend EnumerateIt
+  has_enumeration_for :foobar, :with => TestEnumeration
+end
+
+def create_enumeration_class_with_sort_mode(sort_mode)
+  Class.new(EnumerateIt::Base) do
+    sort_by sort_mode
+
+    associate_values(
+      :foo  => ["1", "xyz"],
+      :bar  => ["2", "fgh"],
+      :zomg => ["3", "abc"]
+    )
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: enumerate_it
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-13 00:00:00.000000000 Z
+date: 2013-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -137,11 +137,13 @@ files:
 - lib/generators/enumerate_it/install/USAGE
 - lib/generators/enumerate_it/install/install_generator.rb
 - lib/generators/enumerate_it/install/templates/enumerate_it_initializer.rb
+- spec/enumerate_it/base_spec.rb
 - spec/enumerate_it_spec.rb
 - spec/i18n/en.yml
 - spec/i18n/pt.yml
 - spec/spec.opts
 - spec/spec_helper.rb
+- spec/support/test_classes.rb
 homepage: http://github.com/cassiomarques/enumerate_it
 licenses: []
 post_install_message: 
@@ -156,7 +158,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1389146170184327843
+      hash: 1268518782242094131
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -165,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1389146170184327843
+      hash: 1268518782242094131
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -173,8 +175,10 @@ signing_key:
 specification_version: 3
 summary: Ruby Enumerations
 test_files:
+- spec/enumerate_it/base_spec.rb
 - spec/enumerate_it_spec.rb
 - spec/i18n/en.yml
 - spec/i18n/pt.yml
 - spec/spec.opts
 - spec/spec_helper.rb
+- spec/support/test_classes.rb