enumerations 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e9193bf66247b09a32a3a72da1257fe97890da52
-  data.tar.gz: b005aaba38109c814c7020e7053d31a56a6f98a3
+  metadata.gz: 7e452f81340fb7e16689b456cab621d4cd84f787
+  data.tar.gz: 154907cc77af681118cb5639fe0a7e68b3281525
 SHA512:
-  metadata.gz: 2003c66e3f930f5b3fafd9eea13036159a0583694384a1c644566ca49150485516186dffa0a2191feac09064602f3a89af31607d7b3c7dab6adea3a589b71d02
-  data.tar.gz: de534b1cab979f08d362ce42ab61fbe2bf4851fb32da2adc4e1e1abd31a7274dd92b261488cb38402eee36ab4220fde052a357ba289fba2491be50879fa3627c
+  metadata.gz: a8070503f33e094a8344c95a5103cbd71505345efb89ee4d61e5ac84163b0f541cbbc7e1e319a695b1c39eeafd2140b0ef9d4a4895db27bf69cf7cdcb5af1e85
+  data.tar.gz: a45c4d87770db1b4730094acbfe20abe84cb7f92499b9b42e0eb555e9934d0513353f2ef0670c961c57f867d0d668b2c76369d122de05e6710e5fe521107142f

data/.gitignore

@@ -1,3 +1,4 @@
 .DS_Store
 *.gem
 Gemfile.lock
+.todo

data/Readme.md

@@ -26,9 +26,9 @@ Create a model for your enumerations:
 
 ```ruby
 class Status < Enumerations::Base
-  values draft:           { id: 1, name: 'Draft' },
-         review_pending:  { id: 2, name: 'Review pending' },
-         published:       { id: 3, name: 'Published' }
+  values draft:           { name: 'Draft' },
+         review_pending:  { name: 'Review pending' },
+         published:       { name: 'Published' }
 end
 ```
 
@@ -36,9 +36,9 @@ Or you can use `value` method for defining your enumerations:
 
 ```ruby
 class Status < Enumerations::Base
-  value :draft,           id: 1, name: 'Draft'
-  value :review_pending,  id: 2, name: 'Review pending'
-  value :published,       id: 3, name: 'Published'
+  value :draft,           name: 'Draft'
+  value :review_pending,  name: 'Review pending'
+  value :published,       name: 'Published'
 end
 ```
 
@@ -48,7 +48,7 @@ Include enumerations for integer fields in other models:
 class Post < ActiveRecord::Base
   enumeration :status
 
-  validates :status, presence: true           # You can validate either :status or :status_id
+  validates :status, presence: true
 end
 ```
 
@@ -57,8 +57,8 @@ You can pass attributes to specify which enumeration and which column to use:
 ```ruby
 class Post < ActiveRecord::Base
   enumeration :status,
-              foreign_key: :post_status_id,   # specifies which column to use
-              class_name: Post::Status        # specifies the class of the enumerator
+              foreign_key: :post_status,   # specifies which column to use
+              class_name: Post::Status     # specifies the class of the enumerator
 
   validates :post_status, presence: true
 end
@@ -69,18 +69,18 @@ Attribute `foreign_key` you can pass as a `String` or a `Symbol`. Attribute `cla
 
 ## Setting enumeration value to objects
 
-Set enumerations, find enumerations by `symbol`:
+Set enumerations:
 
 ```ruby
 @post = Post.first
-@post.status = Status.find(:draft)
+@post.status = Status.draft
 @post.save
 ```
 
-Or you can set enumerations on this way:
+Or you can set enumerations by `symbol`:
 
 ```ruby
-@post.status = Status.draft
+@post.status = Status.find(:draft)
 ```
 
 Also, you can set enumeration value like this:
@@ -89,7 +89,8 @@ Also, you can set enumeration value like this:
 @post.status_draft!
 ```
 
-> When you include enumerations into your model, you'll get methods for setting each enumeration value. Each method name is consists from enumeration name and enumeration value name with **!** at the end. Examples:
+> When you include enumerations into your model, you'll get methods for setting each enumeration value.
+Each method name is consists from enumeration name and enumeration value name with **!** at the end. Examples:
 
 ```ruby
 class Post < ActiveRecord::Base
@@ -129,10 +130,10 @@ Find enumerations by `id`:
 Other finding methods:
 
 ```ruby
-# Find by id as a String
-Status.find('2')                              # => Review pending
+# Find by key as a Symbol
+Status.find(:review_pending)                  # => Review pending
 
-# Find by symbol as a String
+# Find by key as a String
 Status.find('draft')                          # => Draft
 
 # Find by multiple attributes
@@ -143,8 +144,8 @@ Compare enumerations:
 
 ```ruby
 @post.status == :published                    # => true
-@post.status == 3                             # => true
-@post.status == Status.find(:published)       # => true
+@post.status == 'published'                   # => true
+@post.status == Status.published              # => true
 @post.status.published?                       # => true
 ```
 
@@ -206,25 +207,26 @@ Use in forms:
 
 ```ruby
 %p
-  = f.label :status_id
+  = f.label :status
   %br
-  = f.collection_select :status_id, Status.all, :id, :name
+  = f.collection_select :status, Status.all, :symbol, :name
 ```
 
-Advance Usage
+Advanced Usage
 =====
 
-Except `id` and `name` you can specify other attributes to your enumerations:
+Except `name` you can specify any other attributes to your enumerations:
 
 ```ruby
 class Status < Enumerations::Base
   value :draft,           id: 1, name: 'Draft'
   value :review_pending,  id: 2, name: 'Review pending', description: 'Some description...'
-  value :published,       id: 3, name: 'Published'
+  value :published,       id: 3, name: 'Published', published: true
 end
 ```
 
-Every enumeration has `id`, `name` and `description` methods. If you call method that is not in attribute list for enumeration, it will return `nil`.
+Every enumeration has `id`, `name`, `description` and `published` methods.
+If you call method that is not in attribute list for enumeration, it will return `nil`.
 
 ```ruby
 Status.review_pending.description              # => 'Some description...'
@@ -261,7 +263,105 @@ en:
 I18n.load_path += Dir[Rails.root.join('config', 'locales', 'enumerations', '*.yml')]
 ```
 
-Author
-======
+Configuration
+=============
+
+Basically no configuration is needed.
+
+**Enumerations** has two configuration options.
+You can customize primary key and foreign key suffix.
+Just add initializer file to `config/initializers/enumerations.rb`.
+
+Example of configuration:
+
+```ruby
+# config/initializers/enumerations.rb
+
+Enumerations.configure do |config|
+  config.primary_key        = :id
+  config.foreign_key_suffix = :id
+end
+```
+
+By default, `primary_key` and `foreign_key_suffix` are set to `nil`.
+
+By default model enumeration value is saved to column with same name as enumeration.
+If you set enumeration as:
+```ruby
+enumeration :status
+```
+then model should have `status`column (as `String` type).
+If you want save an `ID` to this column, you can set `foreign_key_suffix` to `id`.
+Then model should have `status_id` column.
+
+If you set `primary_key` then you need provide this attribute for all enumerations values.
+Also, value from `primary_key` attribute will be stored to model as enumeration value.
+
+For example:
+
+```ruby
+# with default configuration
+
+post = Post.new
+post.status = Status.draft      # => post.status = 'draft'
+
+# with configured primary_key and foreign_key_suffix:
+
+Enumerations.configure do |config|
+  config.primary_key        = :id
+  config.foreign_key_suffix = :id
+end
+
+class Status < Enumerations::Base
+  value :draft,           id: 1, name: 'Draft'
+  value :review_pending,  id: 2, name: 'Review pending',
+  value :published,       id: 3, name: 'Published', published: true
+end
+
+post = Post.new
+post.status = Status.draft      # => post.status_id = 1
+```
+
+Database Enumerations
+=====================
+
+By default, enumeration values are saved to database as `String`.
+If you want, you can define `Enum` type in database:
+
+```sql
+CREATE TYPE status AS ENUM ('draft', 'review_pending', 'published');
+```
+
+Then you'll have enumeration as type in database and you can use it in database migrations:
+
+```ruby
+add_column :posts, :status, :status, index: true
+```
+
+With configuration option `primary_key`, you can store any type you want (e.g. `Integer`).
+
+Also, for performance reasons, you should add indices to enumeration column.
+
+[Here](https://www.postgresql.org/docs/9.1/static/datatype-enum.html) you can find more informations about ENUM types.
+
+
+
+Contributing
+============
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+Credits
+=======
+**Enumerations** is maintained and sponsored by [Infinum](https://infinum.co)
+
+Copyright © 2016 Infinum Ltd.
+
+License
+=======
 
-Copyright © 2010 Tomislav Car, Infinum Ltd.
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/enumerations.gemspec

@@ -3,13 +3,20 @@ require File.expand_path('../lib/enumerations/version', __FILE__)
 Gem::Specification.new do |s|
   s.name        = 'enumerations'
   s.version     = Enumerations::VERSION
-  s.date        = '2016-08-15'
+  s.date        = '2016-09-15'
   s.summary     = 'Enumerations for ActiveRecord!'
   s.description = 'Extends ActiveRecord with enumeration capabilites.'
-  s.authors     = ['Tomislav Car', 'Nikica Jokic', 'Nikola Santic']
-  s.email       = ['tomislav@infinum.hr', 'nikica.jokic@infinum.hr', 'nikola.santic@infinum.hr']
   s.homepage    = 'https://github.com/infinum/enumerations'
 
+  s.authors     = [
+    'Tomislav Car', 'Nikica Jokić', 'Nikola Santić', 'Stjepan Hadjić', 'Petar Ćurković'
+  ]
+
+  s.email = [
+    'tomislav@infinum.hr', 'nikica.jokic@infinum.hr', 'nikola.santic@infinum.hr',
+    'stjepan.hadjic@infinum.hr', 'petar.curkovic@infinum.hr'
+  ]
+
   s.add_dependency 'activerecord'
   s.add_dependency 'activesupport'
   s.add_dependency 'i18n'

data/lib/enumerations.rb

@@ -3,6 +3,7 @@ require 'active_support/concern'
 require 'active_support/core_ext/class/attribute'
 require 'active_support/core_ext/string/inflections'
 
+require 'enumerations/configuration'
 require 'enumerations/version'
 require 'enumerations/base'
 require 'enumerations/reflection'
@@ -25,11 +26,9 @@ module Enumerations
     #     enumeration :role
     #   end
     #
-    #  user.role_id = 1
     #  user.role => #<Enumerations::Value: @base=Role, @symbol=:admin...>
     #
     #  user.role = Role.staff
-    #  user.role_id => 2
     #
     def enumeration(name, options = {})
       reflection = Reflection.new(name, options)
@@ -67,12 +66,12 @@ module Enumerations
     #
     # Example:
     #
-    #   user.role_id = 1
+    #   user.role = Role.admin
     #   user.role => #<Enumerations::Value: @base=Role, @symbol=:admin...>
     #
     def define_getter_method(reflection)
       define_method(reflection.name) do
-        reflection.enumerator_class.find(send(reflection.foreign_key))
+        reflection.enumerator_class.find(self[reflection.foreign_key])
       end
     end
 
@@ -81,11 +80,13 @@ module Enumerations
     # Example:
     #
     #   user.role = Role.admin
-    #   user.role_id => 1
     #
     def define_setter_method(reflection)
       define_method("#{reflection.name}=") do |other|
-        send("#{reflection.foreign_key}=", other.id)
+        enumeration_value = reflection.enumerator_class.find(other)
+
+        self[reflection.foreign_key] =
+          enumeration_value.send(Enumerations.configuration.primary_key || :symbol)
       end
     end
 
@@ -115,8 +116,10 @@ module Enumerations
     #
     def define_scopes(reflection)
       reflection.enumerator_class.all.each do |enumeration|
+        foreign_key = enumeration.send(Enumerations.configuration.primary_key || :symbol)
+
         scope "with_#{reflection.name}_#{enumeration.symbol}",
-              -> { where(reflection.foreign_key => enumeration.id) }
+              -> { where(reflection.foreign_key => foreign_key) }
       end
     end
   end

data/lib/enumerations/base.rb

@@ -9,6 +9,7 @@ module Enumerations
     include Enumerations::Value
 
     class_attribute :_values, :_symbol_index
+
     self._values = {}
     self._symbol_index = {}
 
@@ -18,17 +19,13 @@ module Enumerations
     #
     #   value :admin, id: 1, name: 'Admin', description: 'Some description...'
     #
-    #   Role.admin.id             => # 1
-    #   Role.find(:admin).name    => # "Admin"
-    #   Role.find(1).description  => # "Some description..."
+    #   Role.find(:admin).name          => # "Admin"
+    #   Role.find(:admin).description   => # "Some description..."
     #
     def self.value(symbol, attributes)
-      raise 'Enumeration id is required' if attributes[:id].nil?
-      raise "Duplicate symbol #{symbol}" if find(symbol)
-      raise "Duplicate id #{attributes[:id]}" if find(attributes[:id])
+      validate_symbol_and_primary_key(symbol, attributes)
 
       self._values = _values.merge(symbol => new(symbol, attributes))
-      self._symbol_index = _symbol_index.merge(symbol => attributes[:id])
 
       # Adds name base finder methods
       #
@@ -50,9 +47,9 @@ module Enumerations
     #          manager:         { id: 2, name: 'Manager' },
     #          staff:           { id: 3, name: 'Staff', description: 'Some description...' }
     #
-    #   Role.admin.id => # 1
-    #   Role.find(:manager).name => # "Manager"
-    #   Role.find(3).description => # "Some description..."
+    #   Role.admin.id                     => # 1
+    #   Role.find(:manager).name          => # "Manager"
+    #   Role.find(:manager).description   => # "Some description..."
     #
     def self.values(values)
       values.each do |symbol, attributes|
@@ -82,6 +79,20 @@ module Enumerations
       _values.values
     end
 
+    def self.validate_symbol_and_primary_key(symbol, attributes)
+      raise "Duplicate symbol #{symbol}" if find(symbol)
+
+      primary_key = Enumerations.configuration.primary_key
+      return if primary_key.nil?
+
+      raise 'Enumeration primary key is required' if attributes[primary_key].nil?
+      raise "Duplicate primary key #{attributes[primary_key]}" if find(attributes[primary_key])
+
+      self._symbol_index = _symbol_index.merge(symbol => attributes[primary_key])
+    end
+
+    private_class_method :validate_symbol_and_primary_key
+
     attr_reader :symbol, :attributes
 
     def initialize(symbol, attributes)

data/lib/enumerations/configuration.rb

@@ -0,0 +1,25 @@
+module Enumerations
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  def self.restore_default_configuration
+    self.configuration = nil
+    configure {}
+  end
+
+  class Configuration
+    attr_accessor :primary_key
+    attr_accessor :foreign_key_suffix
+
+    def initialize
+      @primary_key        = nil
+      @foreign_key_suffix = nil
+    end
+  end
+end

data/lib/enumerations/finder_methods.rb

@@ -1,20 +1,16 @@
 module Enumerations
   module FinderMethods
-    # Finds an enumeration by symbol, id or name
+    # Finds an enumeration by symbol or name
     #
     # Example:
     #
     #   Role.find(:admin)  => #<Enumerations::Value: @base=Role, @symbol=:admin...>
-    #   Role.find(2)       => #<Enumerations::Value: @base=Role, @symbol=:manager...>
-    #   Role.find('2')     => #<Enumerations::Value: @base=Role, @symbol=:manager...>
     #   Role.find('staff') => #<Enumerations::Value: @base=Role, @symbol=:staff...>
     #
     def find(key)
       case key
-      when Symbol then find_by_key(key)
-      when String then find_by_key(key.to_sym) || find_by_id(key.to_i)
-      when Fixnum then find_by_id(key)
-      end
+      when Symbol, String, Enumerations::Base then find_by_key(key.to_sym)
+      end || find_by_primary_key(key)
     end
 
     # Finds all enumerations which meets given attributes.
@@ -42,8 +38,14 @@ module Enumerations
       _values[key]
     end
 
-    def find_by_id(id)
-      _values[_symbol_index.key(id)]
+    def find_by_primary_key(primary_key)
+      value_from_symbol_index(primary_key) || value_from_symbol_index(primary_key.to_s.to_i)
+    end
+
+    private
+
+    def value_from_symbol_index(key)
+      _values[_symbol_index.key(key)]
     end
   end
 end

data/lib/enumerations/reflection.rb

@@ -12,11 +12,17 @@ module Enumerations
     end
 
     def foreign_key
-      @foreign_key ||= (@options[:foreign_key] || "#{name}_id").to_sym
+      @foreign_key ||= (@options[:foreign_key] || default_foreign_key_name).to_sym
     end
 
     def enumerator_class
       @enumerator_class ||= class_name.constantize
     end
+
+    private
+
+    def default_foreign_key_name
+      [name, Enumerations.configuration.foreign_key_suffix].compact.join('_')
+    end
   end
 end

data/lib/enumerations/value.rb

@@ -1,36 +1,34 @@
 module Enumerations
   module Value
     def to_i
-      id
+      _values.keys.index(symbol) + 1
     end
 
     def to_s
-      name
+      symbol.to_s
     end
 
-    def to_sym
-      symbol
+    def to_param
+      to_s
     end
 
-    def to_param
-      id
+    def to_sym
+      symbol
     end
 
-    # Comparison by id, symbol or object
+    # Comparison by symbol or object
     #
     # Example:
     #
-    #   Role.admin == 1           => true
     #   Role.admin == :admin      => true
     #   Role.admin == Role.admin  => true
-    #   Role.admin == 2           => false
     #   Role.admin == :staff      => false
     #   Role.admin == Role.staff  => false
     #
     # TODO: test if case..when is working with this
     def ==(other)
       case other
-      when Fixnum then other == id
+      when String then other == to_s
       when Symbol then other == symbol
       else super
       end
@@ -49,8 +47,8 @@ module Enumerations
     #
     #   Role.admin => #<Enumerations::Value:0x007fff45d7ec30 @base=Role, @symbol=:admin,
     #                   @attributes={:id=>1, :name=>"Admin", :description=>"Some description..."}>
-    #   user.role.id => # 1
-    #   user.role.name => # "Admin"
+    #   user.role.id          => # 1
+    #   user.role.name        => # "Admin"
     #   user.role.description => # "Some description..."
     #
     def define_attributes_getters

data/lib/enumerations/version.rb

@@ -1,3 +1,3 @@
 module Enumerations
-  VERSION = '2.1.0'
+  VERSION = '2.2.0'.freeze
 end

data/test/base_test.rb

@@ -1,4 +1,4 @@
-require_relative 'test_helper'
+require_relative 'helpers/test_helper'
 
 class BaseTest < Minitest::Test
   def test_all
@@ -15,22 +15,9 @@ class BaseTest < Minitest::Test
     assert_equal status_symbols.first, Status.draft.to_sym
   end
 
-  def test_required_id
-    assert_raises 'Enumeration id is required' do
-      Class.new.value draft: { name: 'Draft' }
-    end
-  end
-
-  def test_duplicated_id
-    assert_raises 'Duplicate id 1' do
-      Class.new.values draft: { id: 1, name: 'Draft' },
-                       test:  { id: 1, name: 'Draft' }
-    end
-  end
-
   def test_duplicated_symbol
     assert_raises 'Duplicate symbol draft' do
-      obj = Class.new
+      obj = Class.new(Enumerations::Base)
 
       obj.value :draft, id: 1, name: 'Draft'
       obj.value :draft, id: 2, name: 'Draft Again'

data/test/configuration/configuration.rb

@@ -0,0 +1,18 @@
+module Configuration
+  Enumerations.configure do |config|
+    config.primary_key        = :id
+    config.foreign_key_suffix = :id
+  end
+
+  ::CustomEnum = Class.new(Enumerations::Base)
+
+  CustomEnum.values draft:      { id: 1, name: 'Draft' },
+                    review:     { id: 2, name: 'Review' },
+                    published:  { id: 3, name: 'Published', published: true }
+
+  ::CustomModel = Class.new(ActiveRecord::Base)
+
+  CustomModel.enumeration :custom_enum
+
+  Enumerations.restore_default_configuration
+end

data/test/configuration/enumerations_test.rb

@@ -0,0 +1,51 @@
+require_relative '../helpers/test_helper'
+require_relative 'configuration'
+
+module Configuration
+  class EnumerationsTest < Minitest::Test
+    def setup
+      Enumerations.configure do |config|
+        config.primary_key        = :id
+        config.foreign_key_suffix = :id
+      end
+    end
+
+    def teardown
+      Enumerations.restore_default_configuration
+    end
+
+    def test_model_enumeration_assignment
+      model = CustomModel.new
+      model.custom_enum = CustomEnum.draft
+
+      assert_equal 'draft', model.custom_enum.to_s
+    end
+
+    def test_model_bang_assignment
+      model = CustomModel.new
+      model.custom_enum_draft!
+
+      assert_equal 'draft', model.custom_enum.to_s
+    end
+
+    def test_model_via_symbol_assignment
+      model = CustomModel.new
+      model.custom_enum = CustomEnum.published.symbol
+
+      assert_equal 'published', model.custom_enum.to_s
+    end
+
+    def test_model_via_foreign_key_assignment
+      model = CustomModel.new
+      model.custom_enum_id = CustomEnum.published.id
+
+      assert_equal 'published', model.custom_enum.to_s
+    end
+
+    def test_enumerated_class_scope_hash_value
+      query_hash = CustomModel.with_custom_enum_draft.where_values_hash.symbolize_keys
+
+      assert_equal query_hash, custom_enum_id: 1
+    end
+  end
+end

data/test/configuration/finder_test.rb

@@ -0,0 +1,41 @@
+require_relative '../helpers/test_helper'
+require_relative 'configuration'
+
+module Configuration
+  class FinderTest < Minitest::Test
+    def setup
+      Enumerations.configure do |config|
+        config.primary_key        = :id
+        config.foreign_key_suffix = :id
+      end
+    end
+
+    def teardown
+      Enumerations.restore_default_configuration
+    end
+
+    def test_lookup_by_key
+      enum = CustomEnum.find(:draft)
+
+      assert_equal :draft, enum.symbol
+    end
+
+    def test_lookup_by_string_key
+      enum = CustomEnum.find('draft')
+
+      assert_equal :draft, enum.symbol
+    end
+
+    def test_lookup_by_primary_key
+      enum = CustomEnum.find(1)
+
+      assert_equal :draft, enum.symbol
+    end
+
+    def test_lookup_by_primary_key_as_string
+      enum = CustomEnum.find('1')
+
+      assert_equal :draft, enum.symbol
+    end
+  end
+end

data/test/configuration_test.rb

@@ -0,0 +1,53 @@
+require_relative 'helpers/test_helper'
+
+class ConfigurationTest < Minitest::Test
+  def setup
+    Enumerations.restore_default_configuration
+  end
+
+  def teardown
+    Enumerations.restore_default_configuration
+  end
+
+  def test_default_configuration
+    assert_equal nil, Enumerations.configuration.primary_key
+    assert_equal nil, Enumerations.configuration.foreign_key_suffix
+  end
+
+  def test_custom_configuration
+    Enumerations.configure do |config|
+      config.primary_key        = :id
+      config.foreign_key_suffix = :id
+    end
+
+    assert_equal :id, Enumerations.configuration.primary_key
+    assert_equal :id, Enumerations.configuration.foreign_key_suffix
+  end
+
+  def test_reflection_with_configured_foreign_key_suffix
+    Enumerations.configure { |config| config.foreign_key_suffix = :id }
+
+    reflection = Enumerations::Reflection.new(:status)
+
+    assert_equal 'Status',   reflection.class_name
+    assert_equal ::Status,   reflection.enumerator_class
+    assert_equal :status_id, reflection.foreign_key
+  end
+
+  def test_required_primary_key_when_primary_key_configured
+    Enumerations.configure { |config| config.primary_key = :id }
+
+    assert_raises 'Enumeration primary key is required' do
+      Class.new(Enumerations::Base).value draft: { name: 'Draft' }
+    end
+  end
+
+  def test_duplicated_primary_key_when_primary_key_configured
+    Enumerations.configure { |config| config.primary_key = :id }
+
+    assert_raises 'Duplicate primary key 1' do
+      Class.new(Enumerations::Base).values draft: { id: 1, name: 'Draft' },
+                                           test:  { id: 1, name: 'Draft' }
+    end
+  end
+end

data/test/enumerations_test.rb

@@ -1,4 +1,4 @@
-require_relative 'test_helper'
+require_relative 'helpers/test_helper'
 
 class EnumerationsTest < Minitest::Test
   def test_reflect_on_all_enumerations
@@ -8,35 +8,35 @@ class EnumerationsTest < Minitest::Test
     assert_equal :status, enumerations.first.name
     assert_equal 'Status', enumerations.first.class_name
 
-    assert_equal :some_other_status_id, enumerations[1].foreign_key
+    assert_equal :some_other_status, enumerations[1].foreign_key
   end
 
   def test_model_enumeration_assignment
     p = Post.new
     p.status = Status.draft
 
-    assert_equal 'Draft', p.status.to_s
+    assert_equal 'draft', p.status.to_s
   end
 
   def test_model_bang_assignment
     p = Post.new
     p.status_draft!
 
-    assert_equal 'Draft', p.status.to_s
+    assert_equal 'draft', p.status.to_s
   end
 
   def test_model_bang_assignment_with_custom_name
     p = Post.new
     p.different_status_draft!
 
-    assert_equal 'Draft', p.different_status.to_s
+    assert_equal 'draft', p.different_status.to_s
   end
 
-  def test_model_via_id_assignment
+  def test_model_via_symbol_assignment
     p = Post.new
-    p.some_other_status_id = Status.published.id
+    p.some_other_status = Status.published.symbol
 
-    assert_equal 'Published', p.different_status.to_s
+    assert_equal 'published', p.some_other_status.to_s
   end
 
   def test_boolean_lookup
@@ -59,10 +59,10 @@ class EnumerationsTest < Minitest::Test
     assert_equal 2, enumerations.size
 
     assert_equal :role, enumerations.first.name
-    assert_equal :role_id, enumerations.first.foreign_key
+    assert_equal :role, enumerations.first.foreign_key
 
     assert_equal :status, enumerations[1].name
-    assert_equal :status_id, enumerations[1].foreign_key
+    assert_equal :status, enumerations[1].foreign_key
   end
 
   def test_multiple_enumeration_assignments_on_model
@@ -70,8 +70,8 @@ class EnumerationsTest < Minitest::Test
     u.role = Role.admin
     u.status = Status.published
 
-    assert_equal 'Admin', u.role.to_s
-    assert_equal 'Published', u.status.to_s
+    assert_equal 'admin', u.role.to_s
+    assert_equal 'published', u.status.to_s
   end
 
   def test_enumerated_class_has_scopes
@@ -83,6 +83,6 @@ class EnumerationsTest < Minitest::Test
   def test_enumerated_class_scope_hash_value
     query_hash = User.with_role_admin.where_values_hash.symbolize_keys
 
-    assert_equal query_hash, role_id: 1
+    assert_equal query_hash, role: :admin
   end
 end

data/test/finder_test.rb

@@ -1,4 +1,4 @@
-require_relative 'test_helper'
+require_relative 'helpers/test_helper'
 
 class FinderTest < Minitest::Test
   def test_lookup_by_symbol
@@ -13,12 +13,6 @@ class FinderTest < Minitest::Test
     refute_same :published, status.symbol
   end
 
-  def test_lookup_by_string_id
-    status = Status.find('1')
-
-    assert_equal :draft, status.symbol
-  end
-
   def test_lookup_by_string_key
     status = Status.find('draft')
 

data/test/helpers/database_helper.rb

@@ -4,12 +4,17 @@ ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:'
 
 ActiveRecord::Schema.define do
   create_table :posts, force: true do |t|
-    t.integer  :status_id
-    t.integer  :some_other_status_id
+    t.string :status
+    t.string :some_other_status
   end
 
   create_table :users, force: true do |t|
-    t.integer  :role_id
-    t.string   :status_id
+    t.string :role
+    t.string :status
+  end
+
+  create_table :custom_models, force: true do |t|
+    t.integer :custom_enum_id
+    t.integer :custom_enum
   end
 end

data/test/{test_helper.rb → helpers/test_helper.rb}

@@ -6,8 +6,10 @@ require 'enumerations'
 require 'active_record'
 require 'pry'
 
-require_relative 'helpers/database_helper'
-require_relative 'helpers/locale_helper'
+require_relative 'database_helper'
+require_relative 'locale_helper'
+
+Enumerations.configure { |_| }
 
 class Status < Enumerations::Base
   values draft:           { id: 1, name: 'Draft' },
@@ -19,9 +21,9 @@ class Status < Enumerations::Base
 end
 
 class Role < Enumerations::Base
-  value :admin,   id: 1, name: 'Admin',  admin: true, active: true
-  value :editor,  id: 2, name: 'Editor', admin: true, active: false, description: 'Edits newspapers'
-  value :author,  id: 3, name: 'Author'
+  value :admin,   name: 'Admin',  admin: true, active: true
+  value :editor,  name: 'Editor', admin: true, active: false, description: 'Edits newspapers'
+  value :author,  name: 'Author'
 
   def my_custom_name
     ['user', name].join('_')
@@ -29,15 +31,11 @@ class Role < Enumerations::Base
 end
 
 class Post < ActiveRecord::Base
-  attr_accessor :status_id, :some_other_status_id
-
   enumeration :status
-  enumeration :different_status, foreign_key: :some_other_status_id, class_name: 'Status'
+  enumeration :different_status, foreign_key: :some_other_status, class_name: 'Status'
 end
 
 class User < ActiveRecord::Base
-  attr_accessor :role_id, :status_id
-
   enumeration :role
   enumeration :status
 end

data/test/reflection_test.rb

@@ -1,32 +1,32 @@
-require_relative 'test_helper'
+require_relative 'helpers/test_helper'
 
 class ReflectionTest < Minitest::Test
   def test_reflection_with_all_attributes
     reflection = Enumerations::Reflection.new(:status, class_name: 'Status',
-                                                       foreign_key: :status_id)
+                                                       foreign_key: :status)
 
-    assert_equal :status, reflection.name
+    assert_equal :status,  reflection.name
     assert_equal 'Status', reflection.class_name
-    assert_equal :status_id, reflection.foreign_key
+    assert_equal :status,  reflection.foreign_key
     assert_equal ::Status, reflection.enumerator_class
   end
 
   def test_reflection_without_class_name_and_foreign_key
     reflection = Enumerations::Reflection.new(:status)
 
-    assert_equal :status, reflection.name
-    assert_equal 'Status', reflection.class_name
-    assert_equal :status_id, reflection.foreign_key
-    assert_equal ::Status, reflection.enumerator_class
+    assert_equal :status,   reflection.name
+    assert_equal 'Status',  reflection.class_name
+    assert_equal :status,   reflection.foreign_key
+    assert_equal ::Status,  reflection.enumerator_class
   end
 
   def test_reflection_with_custom_name_and_without_foreign_key
     reflection = Enumerations::Reflection.new(:my_status, class_name: 'Status')
 
-    assert_equal :my_status, reflection.name
-    assert_equal 'Status', reflection.class_name
-    assert_equal :my_status_id, reflection.foreign_key
-    assert_equal ::Status, reflection.enumerator_class
+    assert_equal :my_status,  reflection.name
+    assert_equal 'Status',    reflection.class_name
+    assert_equal :my_status,  reflection.foreign_key
+    assert_equal ::Status,    reflection.enumerator_class
   end
 
   def test_reflection_with_class_name_as_constant

data/test/translation_test.rb

@@ -1,4 +1,4 @@
-require_relative 'test_helper'
+require_relative 'helpers/test_helper'
 
 class TranslationTest < Minitest::Test
   def test_translated_value_with_default_locale

data/test/value_test.rb

@@ -1,16 +1,16 @@
-require_relative 'test_helper'
+require_relative 'helpers/test_helper'
 
 class ValueTest < Minitest::Test
-  def test_equal_by_id
-    status = Status.find(:draft)
+  def test_equal_by_symbol
+    status = Status.draft
 
-    assert_equal true, status == 1
+    assert_equal true, status == :draft
   end
 
-  def test_equal_by_symbol
+  def test_equal_by_string
     status = Status.draft
 
-    assert_equal true, status == :draft
+    assert_equal true, status == 'draft'
   end
 
   def test_equal_by_enumeration
@@ -43,10 +43,12 @@ class ValueTest < Minitest::Test
     assert_equal nil, status.visible
   end
 
-  def test_enumeration_to_i
-    status = Status.find(:draft)
+  def test_enumeration_to_i_return_ordinal
+    first_status = Status.find(:draft)
+    second_status = Status.find(:review_pending)
 
-    assert_equal status.to_i, 1
+    assert_equal first_status.to_i, 1
+    assert_equal second_status.to_i, 2
   end
 
   def test_enumeration_to_sym
@@ -58,6 +60,6 @@ class ValueTest < Minitest::Test
   def test_enumeration_to_param
     status = Status.find(:draft)
 
-    assert_equal status.to_param, 1
+    assert_equal status.to_param, 'draft'
   end
 end

metadata

@@ -1,16 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: enumerations
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Tomislav Car
-- Nikica Jokic
-- Nikola Santic
+- Nikica Jokić
+- Nikola Santić
+- Stjepan Hadjić
+- Petar Ćurković
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-15 00:00:00.000000000 Z
+date: 2016-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -115,6 +117,8 @@ email:
 - tomislav@infinum.hr
 - nikica.jokic@infinum.hr
 - nikola.santic@infinum.hr
+- stjepan.hadjic@infinum.hr
+- petar.curkovic@infinum.hr
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -126,21 +130,25 @@ files:
 - enumerations.gemspec
 - lib/enumerations.rb
 - lib/enumerations/base.rb
+- lib/enumerations/configuration.rb
 - lib/enumerations/finder_methods.rb
 - lib/enumerations/reflection.rb
 - lib/enumerations/value.rb
 - lib/enumerations/version.rb
 - test/base_test.rb
+- test/configuration/configuration.rb
+- test/configuration/enumerations_test.rb
+- test/configuration/finder_test.rb
+- test/configuration_test.rb
 - test/enumerations_test.rb
 - test/finder_test.rb
 - test/helpers/database_helper.rb
 - test/helpers/locale_helper.rb
+- test/helpers/test_helper.rb
 - test/locales/hr.yml
 - test/reflection_test.rb
-- test/test_helper.rb
 - test/translation_test.rb
 - test/value_test.rb
-- test/version_test.rb
 homepage: https://github.com/infinum/enumerations
 licenses: []
 metadata: {}
@@ -166,13 +174,16 @@ specification_version: 4
 summary: Enumerations for ActiveRecord!
 test_files:
 - test/base_test.rb
+- test/configuration/configuration.rb
+- test/configuration/enumerations_test.rb
+- test/configuration/finder_test.rb
+- test/configuration_test.rb
 - test/enumerations_test.rb
 - test/finder_test.rb
 - test/helpers/database_helper.rb
 - test/helpers/locale_helper.rb
+- test/helpers/test_helper.rb
 - test/locales/hr.yml
 - test/reflection_test.rb
-- test/test_helper.rb
 - test/translation_test.rb
 - test/value_test.rb
-- test/version_test.rb

data/test/version_test.rb

@@ -1,7 +0,0 @@
-require_relative 'test_helper'
-
-class VersionTest < Minitest::Test
-  def test_version
-    assert_equal '2.1.0', Enumerations::VERSION
-  end
-end