enumerate_it 1.2.8 → 1.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb3b17b959d068dd3925d4301baad53e1f6f75b6
-  data.tar.gz: b86f23a236963e182d2d50396f4b5a9281a9fd2e
+  metadata.gz: 5eea658aa82d9e739fafd57e5ce7f36aba85ec4e
+  data.tar.gz: f82979bf4a625cea197e51e08e18218b9a513a41
 SHA512:
-  metadata.gz: 54acd99e960d73beaff448a8d12f8f28585c8989f11c0d552d6f591fb86150369d80b4c98cac4cd29ded5db29cbdde41d01322101fa7be0cc1b61d071d99ce25
-  data.tar.gz: f7cf10a4f74e27f8bc1cf2d43e2883f7e4509a904148c0839094653e5e6435e12f26551aafb95c720aaeb349f19159f9d575a6b9fa8dd3ca080948fb018befc7
+  metadata.gz: 0fa1e1833a65794f76d022a9bc2a7398e193c08079c38abc8fb2ca5353ee036e511791d3a87557d5ff38cb4529e18fc71ab2ec5cc1c69ed3c6bf9fd1fc6696db
+  data.tar.gz: 98bf568bb99f96ad7e18a0488b532215f3ea19efc7493ce9be98c373282f4428911841212344e5cf7e80ab1809fb513c6ff120198ff348e7158fe84a5f8dbe1b

data/.gitignore

@@ -1,24 +1,3 @@
-## MAC OS
-.DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-tags
-
-## PROJECT::GENERAL
-coverage
-rdoc
-pkg
-
-## PROJECT::SPECIFIC
-enumerate_it-*.gem
-enumerate_it.gemspec
+/.bundle/
+/pkg/
+/gemfiles/*.lock

data/.travis.yml

@@ -1,3 +1,20 @@
 language: ruby
+
+sudo: false
+
+cache: bundler
+
 rvm:
   - 1.9.3
+  - 2.0.0
+  - 2.1.5
+  - 2.2.1
+  - 2.3.0
+
+gemfile:
+  - gemfiles/activesupport_3_0.gemfile
+  - gemfiles/activesupport_3_1.gemfile
+  - gemfiles/activesupport_3_2.gemfile
+  - gemfiles/activesupport_4_0.gemfile
+  - gemfiles/activesupport_4_1.gemfile
+  - gemfiles/activesupport_4_2.gemfile

data/Appraisals

@@ -0,0 +1,6 @@
+%w(3_0 3_1 3_2 4_0 4_1 4_2).each do |version|
+  appraise "activesupport_#{version}" do
+    gem 'activesupport', "~> #{version.gsub(/_/, '.')}.0"
+    gem 'activerecord',  "~> #{version.gsub(/_/, '.')}.0"
+  end
+end

data/CHANGELOG.md

@@ -0,0 +1 @@
+Changes are maintained under [Releases](https://github.com/lucascaton/enumerate_it/releases).

data/Gemfile.lock

@@ -1,53 +1,56 @@
 PATH
   remote: .
   specs:
-    enumerate_it (1.2.8)
+    enumerate_it (1.2.9)
       activesupport (>= 3.0.0)
 
 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)
+    activesupport (4.2.6)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    appraisal (2.1.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
     coderay (1.0.9)
-    diff-lcs (1.1.2)
-    i18n (0.5.0)
+    diff-lcs (1.2.5)
+    i18n (0.7.0)
+    json (1.8.3)
     method_source (0.8.1)
+    minitest (5.8.4)
     pry (0.9.12)
       coderay (~> 1.0.5)
       method_source (~> 0.8)
       slop (~> 3.4)
-    pry-nav (0.2.3)
-      pry (~> 0.9.10)
-    rake (0.9.2.2)
-    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)
+    rake (11.1.1)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
     slop (3.4.4)
-    tzinfo (0.3.24)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  activerecord (>= 3.0.5)
+  appraisal
   enumerate_it!
   pry
-  pry-nav
   rake
-  rspec (>= 2.5.0)
+  rspec (~> 2.14.1)
+
+BUNDLED WITH
+   1.11.2

data/{README.markdown → README.md}

@@ -1,9 +1,10 @@
 # EnumerateIt - Ruby Enumerations
 
-[![Build Status](https://travis-ci.org/cassiomarques/enumerate_it.png?branch=master)](https://travis-ci.org/cassiomarques/enumerate_it)
-[![Gem Version](https://badge.fury.io/rb/enumerate_it.png)](http://badge.fury.io/rb/enumerate_it)
+[![Build Status](https://travis-ci.org/lucascaton/enumerate_it.svg?branch=master)](https://travis-ci.org/lucascaton/enumerate_it)
+[![Gem Version](https://badge.fury.io/rb/enumerate_it.svg)](https://rubygems.org/gems/enumerate_it)
 
-Author: Cássio Marques - cassiommc at gmail
+* **Author:** Cássio Marques
+* **Maintainer:** Lucas Caton
 
 ## Description
 
@@ -44,25 +45,23 @@ mean when we say that someone or something is '2'?
 
 Enter EnumerateIt.
 
-## About versions compatibility
+## Changelog
 
-Versions 1.x.x are NOT backwards compatible with 0.x.x versions. The biggest
-difference is that on 1.0.0 you need to `extend` the EnumerateIt module inside
-classes that are going to have enumerated attributes, while in past versions
-you would use `include`.
+Changes are maintained under [Releases](https://github.com/lucascaton/enumerate_it/releases).
 
 ## 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 them anywhere in your
+application. In Rails applications, you should put them inside
+`app/enumerations` folder.
 
-``` ruby
+```ruby
 class RelationshipStatus < EnumerateIt::Base
   associate_values(
-    :single   => [1, 'Single'],
-    :married  => [2, 'Married'],
-    :widow    => [3, 'Widow'],
-    :divorced => [4, 'Divorced']
+    single:   [1, 'Single'],
+    married:  [2, 'Married'],
+    widow:    [3, 'Widow'],
+    divorced: [4, 'Divorced']
   )
 end
 ```
@@ -71,7 +70,7 @@ This will create some nice stuff:
 
 *   Each enumeration's value will turn into a constant:
 
-    ``` ruby
+    ```ruby
     RelationshipStatus::SINGLE
     #=> 1
 
@@ -81,7 +80,7 @@ This will create some nice stuff:
 
 *   You can retrieve a list with all the enumeration codes:
 
-    ``` ruby
+    ```ruby
     RelationshipStatus.list
     #=> [1, 2, 3, 4]
     ```
@@ -89,71 +88,70 @@ This will create some nice stuff:
 *   You can get an array of options, ready to use with the 'select',
     'select_tag', etc family of Rails helpers.
 
-    ``` ruby
+    ```ruby
     RelationshipStatus.to_a
     #=> [["Divorced", 4], ["Married", 2], ["Single", 1], ["Widow", 3]]
     ```
 
 *   You can retrieve a list with values for a group of enumeration constants.
 
-    ``` ruby
+    ```ruby
     RelationshipStatus.values_for %w(MARRIED SINGLE)
     #=> [2, 1]
     ```
 
 *   You can retrieve the value for a specific enumeration constant:
 
-    ``` ruby
+    ```ruby
     RelationshipStatus.value_for("MARRIED")
     #=> 2
     ```
 
 *   You can retrieve the symbol used to declare a specific enumeration value:
 
-    ``` ruby
+    ```ruby
     RelationshipStatus.key_for(RelationshipStatus::MARRIED)
     #=> :married
     ```
 
 *   You can iterate over the list of the enumeration's values:
 
-    ``` ruby
+    ```ruby
     RelationshipStatus.each_value { |value| ... }
     ```
 
 *   You can iterate over the list of the enumeration's translations:
 
-    ``` ruby
+    ```ruby
     RelationshipStatus.each_translation { |translation| ... }
     ```
 
 *   You can also retrieve all the translations of the enumeration:
 
-    ``` ruby
+    ```ruby
     RelationshipStatus.translations
     ```
 
 *   You can ask for the enumeration's length:
 
-    ``` ruby
+    ```ruby
     RelationshipStatus.length
     #=> 4
     ```
 
 *   You can manipulate the hash used to create the enumeration:
 
-    ``` ruby
+    ```ruby
     RelationshipStatus.enumeration
     #=> returns the exact hash used to define the enumeration
     ```
 
-
 You can also create enumerations in the following ways:
 
 *   Passing an array of symbols, so that the respective value for each symbol
     will be the stringified version of the symbol itself:
 
-    ``` ruby
+    ```ruby
     class RelationshipStatus < EnumerateIt::Base
       associate_values :married, :single
     end
@@ -166,13 +164,12 @@ You can also create enumerations in the following ways:
     translation. In this case, the I18n feature will be used (more on this
     below):
 
-    ``` ruby
+    ```ruby
     class RelationshipStatus < EnumerateIt::Base
-      associate_values :married => 1, :single => 2
+      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
@@ -180,9 +177,9 @@ 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_by` class
 method.
 
-``` ruby
+```ruby
 class RelationshipStatus < EnumerateIt::Base
-  associate_values :married => 1, :single => 2
+  associate_values married: 1, single: 2
 
   sort_by :value
 end
@@ -198,29 +195,28 @@ The `sort_by` methods accept one of the following values:
 *   `:none`: Will return values in order that was passed to associate_values
     call.
 
-
 ## Using enumerations
 
 The cool part is that you can use these enumerations with any class, be it an
 ActiveRecord instance or not.
 
-``` ruby
+```ruby
 class Person
   extend EnumerateIt
   attr_accessor :relationship_status
 
-  has_enumeration_for :relationship_status, :with => RelationshipStatus
+  has_enumeration_for :relationship_status, with: RelationshipStatus
 end
 ```
 
-The :with option is not required. If you ommit it, EnumerateIt will try to
+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:
 
 *   A humanized description for the values of the enumerated attribute:
 
-    ``` ruby
+    ```ruby
     p = Person.new
     p.relationship_status = RelationshipStatus::DIVORCED
     p.relationship_status_humanize
@@ -231,11 +227,11 @@ This will create:
     will use a 'humanized' version of the hash's key to humanize the
     attribute's value:
 
-    ``` ruby
+    ```ruby
     class RelationshipStatus < EnumerateIt::Base
       associate_values(
-        :married => 1,
-        :single => 2
+        married: 1,
+        single: 2
       )
     end
 
@@ -248,17 +244,17 @@ This will create:
 *   The associated enumerations can be retrieved with the 'enumerations' class
     method.
 
-    ``` ruby
+    ```ruby
     Person.enumerations[:relationship_status]
     #=> RelationshipStatus
     ```
 
-*   If you pass the :create_helpers option as 'true', it will create a helper
+*   If you pass the `:create_helpers` option as `true`, it will create a helper
     method for each enumeration option (this option defaults to false):
 
-    ``` ruby
+    ```ruby
     class Person < ActiveRecord::Base
-      has_enumeration_for :relationship_status, :with => RelationshipStatus, :create_helpers => true
+      has_enumeration_for :relationship_status, with: RelationshipStatus, create_helpers: true
     end
 
     p = Person.new
@@ -272,12 +268,13 @@ This will create:
     ```
 
 *   It's also possible to "namespace" the created helper methods, passing a
-    hash to the :create_helpers option. This can be useful when two or more of
+    hash to the `:create_helpers` option. This can be useful when two or more of
     the enumerations used share the same constants.
 
-    ``` ruby
+    ```ruby
     class Person < ActiveRecord::Base
-      has_enumeration_for :relationship_status, :with => RelationshipStatus, :create_helpers => { :prefix => true }
+      has_enumeration_for :relationship_status, with: RelationshipStatus,
+                                                create_helpers: { prefix: true }
     end
 
     p = Person.new
@@ -293,7 +290,7 @@ This will create:
 *   You can define polymorphic behavior for the enum values, so you can define
     a class for each of them:
 
-    ``` ruby
+    ```ruby
     class RelationshipStatus < EnumerateIt::Base
       associate_values :married, :single
 
@@ -311,7 +308,8 @@ This will create:
     end
 
     class Person < ActiveRecord::Base
-      has_enumeration_for :relationship_status, :with => RelationshipStatus, :create_helpers => { :polymorphic => true }
+      has_enumeration_for :relationship_status, with: RelationshipStatus,
+                                                create_helpers: { polymorphic: true }
     end
 
     p = Person.new
@@ -324,22 +322,23 @@ This will create:
     #=> "Party Hard!"
     ```
 
-    You can also change the suffix '_object', using the :suffix option:
+    You can also change the suffix '_object', using the `:suffix` option:
 
-    ``` ruby
+    ```ruby
     class Person < ActiveRecord::Base
-      has_enumeration_for :relationship_status, :with => RelationshipStatus, :create_helpers => { :polymorphic => { :suffix => "_mode" } }
+      has_enumeration_for :relationship_status, with: RelationshipStatus,
+                                                create_helpers: { polymorphic: { suffix: '_mode' } }
     end
 
     p.relationship_status_mode.saturday_night
     ```
 
-*   The :create_helpers also creates some mutator helper methods, that can be
+*   The `:create_helpers` also creates some mutator helper methods, that can be
     used to change the attribute's value.
 
-    ``` ruby
+    ```ruby
     class Person < ActiveRecord::Base
-      has_enumeration_for :relationship_status, :with => RelationshipStatus, :create_helpers => true
+      has_enumeration_for :relationship_status, with: RelationshipStatus, create_helpers: true
     end
 
     p = Person.new
@@ -352,39 +351,38 @@ This will create:
     #=> false
     ```
 
-*   If you pass the :create_scopes option as 'true', it will create a scope
+*   If you pass the `:create_scopes` option as `true`, it will create a scope
     method for each enumeration option (this option defaults to false):
 
-    ``` ruby
+    ```ruby
     class Person < ActiveRecord::Base
-      has_enumeration_for :relationship_status, :with => RelationshipStatus, :create_scopes => true
+      has_enumeration_for :relationship_status, with: RelationshipStatus, create_scopes: true
     end
 
     Person.married.to_sql
     #=> SELECT "people".* FROM "people" WHERE "people"."relationship_status" = 1
     ```
 
-    The :create_scopes also accepts :prefix option.
+    The `:create_scopes` also accepts :prefix option.
 
-    ``` ruby
+    ```ruby
     class Person < ActiveRecord::Base
-      has_enumeration_for :relationship_status, :with => RelationshipStatus, :create_scopes => { :prefix => true }
+      has_enumeration_for :relationship_status, with: RelationshipStatus,
+                                                create_scopes: { prefix: true }
     end
 
     Person.relationship_status_married.to_sql
     ```
 
-NOTE: The :create_scopes option can only be used for Rails.version >= 3.0.0.
-
 *   If your class can manage validations and responds to
     :validates_inclusion_of, it will create this validation:
 
-    ``` ruby
+    ```ruby
     class Person < ActiveRecord::Base
-      has_enumeration_for :relationship_status, :with => RelationshipStatus
+      has_enumeration_for :relationship_status, with: RelationshipStatus
     end
 
-    p = Person.new(:relationship_status => 6) # there is no '6' value in the enumeration
+    p = Person.new(relationship_status: 6) # there is no '6' value in the enumeration
     p.valid?
     #=> false
     p.errors[:relationship_status]
@@ -392,45 +390,44 @@ NOTE: The :create_scopes option can only be used for Rails.version >= 3.0.0.
     ```
 
 *   If your class can manage validations and responds to
-    :validates_presence_of, you can pass the :required options as true and
+    `:validates_presence_of`, you can pass the :required options as true and
     this validation will be created for you (this option defaults to false):
 
-    ``` ruby
+    ```ruby
     class Person < ActiveRecord::Base
-      has_enumeration_for :relationship_status, :required => true
+      has_enumeration_for :relationship_status, required: true
     end
 
-    p = Person.new :relationship_status => nil
+    p = Person.new relationship_status: nil
     p.valid?
     #=> false
     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 ActiveRecord::Base.
+Remember that you can add validations to any kind of class and not only to
+those derived from ActiveRecord::Base.
 
 ## I18n
 
 I18n lookup is provided on both `_humanized` and `Enumeration#to_a` methods,
 given the hash key is a Symbol. The I18n strings are located on
-enumerations.'enumeration_name'.'key' :
+`enumerations.<enumeration_name>.<key>`:
 
-``` yaml
-# your locale file
+```yaml
+# Your locale file
 pt:
   enumerations:
     relationship_status:
       married: Casado
 ```
 
-``` ruby
+```ruby
 class RelationshipStatus < EnumerateIt::Base
   associate_values(
-    :married => 1,
-    :single => 2,
-    :divorced => [3, "He's divorced"]
+    married: 1,
+    single: 2,
+    divorced: [3, "He's divorced"]
   )
 end
 
@@ -450,14 +447,14 @@ p.relationship_status_humanize # uses the provided string
 
 You can also translate specific values:
 
-``` ruby
+```ruby
 RelationshipStatus.t(1)
 #=> 'Casado'
 ```
 
 ## Installation
 
-``` bash
+```bash
 gem install enumerate_it
 ```
 
@@ -465,36 +462,30 @@ gem install enumerate_it
 
 *   Add the gem to your Gemfile:
 
-    ``` ruby
-    gem "enumerate_it"
+    ```ruby
+    gem 'enumerate_it'
     ```
 
 *   Run the install generator:
 
-    ``` bash
+    ```bash
     rails generate enumerate_it:install
     ```
 
-
 An interesting approach to use it in Rails apps is to create an
-app/enumerations folder and add it to your autoload path in
-config/application.rb:
-
-``` ruby
-module YourApp
-  class Application < Rails::Application
-    config.autoload_paths << "#{Rails.root}/app/enumerations"
-  end
-end
-```
+`app/enumerations` folder.
 
 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
+their locale files. Take a look at how to use it running:
 
-``` bash
+```bash
 rails generate enumerate_it:enum --help
 ```
 
+## Supported versions
+
+Check [travis config file](https://github.com/lucascaton/enumerate_it/blob/master/.travis.yml).
+
 ## Why did you reinvent the wheel?
 
 There are other similar solutions to the problem out there, but I could not
@@ -503,9 +494,9 @@ 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.
+* 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
 
@@ -513,11 +504,12 @@ codes. I had both situations in my legacy database.
 *   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
+*   Run the tests agaist all supported versions: `$ appraisal rake`.
+*   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.
+Copyright (c) 2010-2016 Cássio Marques and Lucas Caton. See LICENSE for details.