enumerations 1.3.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 6c202450cd19bc9f524f6ef5756c44bd304a4ef6047d274abda8d165601b6e64
-  data.tar.gz: 61977fd20143ade7cb63242cc0b6098a981861783b412b62fa6b36e28b195f35
+SHA1:
+  metadata.gz: a75cec2684b73e9e83a7b60ddd48b95ac01fd991
+  data.tar.gz: 822d8484b921612c31deadd8491994ad1e22a66d
 SHA512:
-  metadata.gz: 60cb0a9f041e566e090e7b26b5a099f912e6a63a94a652a165b1e83f1d71fd5b7d280c25ebe13e1bca12d16c4dd0407f8db736ad7893ec2ed491a21ef199ffbc
-  data.tar.gz: 04f4aff2e90b826b5e47022083c919d28f561b9370963b9c37251c83eb1101c68b1500624c3ef0e4e039c88465da46a1afe707cd5cda15778dfb47a4bae16ed4
+  metadata.gz: 3df5039cf8d021b312058982c26edee6d8e24c56bd05a4f9cba6db2f55adef3f311d3181a544e774cd3607750d0c813e4935fcbf3079608eec3a7a142a546d4d
+  data.tar.gz: 04c31625eecf7f4276bf11d673aa66d2290ca086d49d728502cde004166a32c7a2ff051367356299feeee8399afc0b486551b00694b51fe47b69d1e72aaf05d1

data/Readme.md

@@ -1,9 +1,12 @@
 Enumerations
 ============
 
-Rails plugin for enumerations in ActiveRecord models.
+[![Gem Version](https://badge.fury.io/rb/enumerations.svg)](https://badge.fury.io/rb/enumerations)
+[![Code Climate](https://codeclimate.com/github/infinum/enumerations/badges/gpa.svg)](https://codeclimate.com/github/infinum/enumerations)
+[![Build Status](https://semaphoreci.com/api/v1/infinum/enumerations/branches/master/shields_badge.svg)](https://semaphoreci.com/infinum/enumerations)
+[![Test Coverage](https://codeclimate.com/github/infinum/enumerations/badges/coverage.svg)](https://codeclimate.com/github/infinum/enumerations/coverage)
 
-[![Build Status](https://travis-ci.org/infinum/enumerations.svg?branch=master)](https://travis-ci.org/infinum/enumerations)
+Rails plugin for enumerations in ActiveRecord models.
 
 Installation
 ============
@@ -17,10 +20,12 @@ gem 'enumerations'
 Usage
 =====
 
+## Defining enumerations
+
 Create a model for your enumerations:
 
 ```ruby
-class Status < Enumeration::Base
+class Status < Enumerations::Base
   values draft:           { id: 1, name: 'Draft' },
          review_pending:  { id: 2, name: 'Review pending' },
          published:       { id: 3, name: 'Published' }
@@ -30,7 +35,7 @@ end
 Or you can use `value` method for defining your enumerations:
 
 ```ruby
-class Status < Enumeration::Base
+class Status < Enumerations::Base
   value :draft,           id: 1, name: 'Draft'
   value :review_pending,  id: 2, name: 'Review pending'
   value :published,       id: 3, name: 'Published'
@@ -46,16 +51,21 @@ class Post < ActiveRecord::Base
 end
 ```
 
-You can pass attributes to specify which enumeratior and which column to use:
+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_id,   # specifies which column to use
+              class_name: Post::Status        # specifies the class of the enumerator
   validates :post_status_id, presence: true
 end
 ```
+Attribute `foreign_key` you can pass as a `String` or a `Symbol`. Attribute `class_name` can be set as a `String`, a `Symbol` or a `String`.
+
+
+
+## Setting enumeration value to objects
 
 Set enumerations, find enumerations by `symbol`:
 
@@ -71,20 +81,56 @@ Or you can set enumerations on this way:
 @post.status = Status.draft
 ```
 
+Also, you can set enumeration value like this:
+
+```ruby
+@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:
+
+```ruby
+class Post < ActiveRecord::Base
+  enumeration :status
+end
+
+@post.status_draft!
+```
+
+```ruby
+class User < ActiveRecord::Base
+  enumeration :role
+end
+
+@user.role_admin!
+```
+
+```ruby
+class User < ActiveRecord::Base
+  enumeration :type, class_name: Role
+end
+
+@user.type_editor!
+```
+
+
+
+## Finder methods
+
 Find enumerations by `id`:
 
 ```ruby
-@post.status = Status.find(2)               # => Review pending
+@post.status = Status.find(2)                  # => Review pending
 @post.save
 ```
 
 Compare enumerations:
 
 ```ruby
-@post.status == :published                  # => true
-@post.status == 3                           # => true
-@post.status == Status.find(:published)     # => true
-@post.status.published?                     # => true
+@post.status == :published                     # => true
+@post.status == 3                              # => true
+@post.status == Status.find(:published)        # => true
+@post.status.published?                        # => true
 ```
 
 Get all enumerations:
@@ -93,6 +139,43 @@ Get all enumerations:
 Status.all
 ```
 
+
+
+## Scopes on model
+
+With enumerations, you'll get scope for each enumeration value in the
+following format:
+
+```ruby
+with_#{enumeration_name}_#{enumeration_value_name}
+```
+
+Examples:
+
+```ruby
+class Post < ActiveRecord::Base
+  enumeration :status
+end
+
+Post.with_status_draft                        # => <#ActiveRecord::Relation []>
+Post.with_status_review_pending               # => <#ActiveRecord::Relation []>
+```
+
+```ruby
+class Post < ActiveRecord::Base
+  enumeration :my_status, class_name: Status
+end
+
+Post.with_my_status_draft                      # => <#ActiveRecord::Relation []>
+Post.with_my_status_review_pending             # => <#ActiveRecord::Relation []>
+```
+
+Each scope returns all records with specified enumeration value.
+
+
+
+## Forms usage
+
 Use in forms:
 
 ```ruby
@@ -108,7 +191,7 @@ Advance Usage
 Except `id` and `name` you can specify other attributes to your enumerations:
 
 ```ruby
-class Status < Enumeration::Base
+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'
@@ -118,8 +201,8 @@ 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`.
 
 ```ruby
-Status.review_pending.description             # => 'Some description...'
-Status.draft.description                      # => nil
+Status.review_pending.description              # => 'Some description...'
+Status.draft.description                       # => nil
 ```
 
 Author

data/enumerations.gemspec

@@ -2,9 +2,9 @@ require File.expand_path('../lib/enumerations/version', __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = 'enumerations'
-  s.version     = Enumeration::VERSION
-  s.date        = '2010-08-20'
-  s.summary     = "Enumerations for ActiveRecord!"
+  s.version     = Enumerations::VERSION
+  s.date        = '2016-08-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']
@@ -13,6 +13,9 @@ Gem::Specification.new do |s|
   s.add_dependency 'activerecord'
   s.add_dependency 'activesupport'
   s.add_development_dependency 'pry-byebug'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'codeclimate-test-reporter'
+  s.add_development_dependency 'sqlite3'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/enumerations.rb

@@ -7,8 +7,7 @@ require 'enumerations/version'
 require 'enumerations/base'
 require 'enumerations/reflection'
 
-# TODO: rename to Enumeration(s) in a major version change
-module Enumeration
+module Enumerations
   extend ActiveSupport::Concern
 
   included do
@@ -27,17 +26,15 @@ module Enumeration
     #   end
     #
     #  user.role_id = 1
-    #  user.role => #<Enumeration::Value:0x007fff45d7ec30 @base=Role, @symbol=:admin...>
+    #  user.role => #<Enumerations::Value: @base=Role, @symbol=:admin...>
     #
     #  user.role = Role.staff
     #  user.role_id => 2
     #
-    # TODO: add documentation for foreign_key and class_name
     def enumeration(name, options = {})
-      options[:foreign_key] ||= "#{name}_id".to_sym
-      options[:class_name] ||= name.to_s.camelize
+      reflection = Reflection.new(name, options)
 
-      add_enumeration(name, options)
+      add_enumeration(reflection)
     end
 
     # Output all the enumerations that this model has defined
@@ -47,8 +44,9 @@ module Enumeration
     # Example:
     #
     #   User.reflect_on_all_enumerations => # [
-    #      #<Enumeration::Reflection:0x007fe894724320 @name=:role...>,
-    #      #<Enumeration::Reflection:0x007fe89471d020 @name=:status...>]
+    #      #<Enumerations::Reflection: @name=:role...>,
+    #      #<Enumerations::Reflection: @name=:status...>
+    #   ]
     #
     def reflect_on_all_enumerations
       _enumerations
@@ -56,41 +54,75 @@ module Enumeration
 
     private
 
-    def add_enumeration(name, options)
-      # Getter for belongs_to
-      #
-      # Example:
-      #
-      #   user.role_id = 1
-      #   user.role => #<Enumeration::Value:0x007fff45d7ec30 @base=Role, @symbol=:admin...>
-      #
-      define_method name do
-        enumerator_class = if options[:class_name].is_a?(Class)
-                             options[:class_name]
-                           else
-                             options[:class_name].constantize
-                           end
+    def add_enumeration(reflection)
+      define_getter_method(reflection)
+      define_setter_method(reflection)
+      define_bang_methods(reflection)
+      define_scopes(reflection)
 
-        enumerator_class.find(send(options[:foreign_key]))
+      self._enumerations += [reflection]
+    end
+
+    # Getter for belongs_to
+    #
+    # Example:
+    #
+    #   user.role_id = 1
+    #   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))
+      end
+    end
+
+    # Setter for belongs_to
+    #
+    # 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)
       end
+    end
 
-      # Setter for belongs_to
-      #
-      # Example:
-      #
-      #   user.role = Role.admin
-      #   user.role_id => 1
-      #
-      define_method "#{name}=" do |other|
-        send("#{options[:foreign_key]}=", other.id)
+    # Add bang methods for setting all enumeration values.
+    # All methods are prefixed with enumeration name.
+    #
+    # Example:
+    #
+    #   user.role_admin!
+    #   user.role => #<Enumerations::Value: @base=Role, @symbol=:admin...>
+    #
+    def define_bang_methods(reflection)
+      reflection.enumerator_class.all.each do |enumeration|
+        define_method("#{reflection.name}_#{enumeration.to_sym}!") do
+          send("#{reflection.name}=", enumeration)
+        end
       end
+    end
 
-      self._enumerations += [Reflection.new(name, options)]
+    # Scopes for enumerated ActiveRecord model.
+    # Format of scope name is with_#{enumeration_name}_#{enumeration_value_name}.
+    #
+    # Example:
+    #
+    #   User.with_role_admin => <#ActiveRecord::Relation []>
+    #   User.with_role_editor => <#ActiveRecord::Relation []>
+    #
+    def define_scopes(reflection)
+      reflection.enumerator_class.all.each do |enumeration|
+        scope "with_#{reflection.name}_#{enumeration.symbol}",
+              -> { where(reflection.foreign_key => enumeration.id) }
+      end
     end
   end
 end
 
 # Extend ActiveRecord with Enumeration capabilites
 ActiveSupport.on_load(:active_record) do
-  include Enumeration
+  include Enumerations
 end

data/lib/enumerations/base.rb

@@ -1,8 +1,13 @@
 require 'active_support/core_ext/class/attribute'
 require 'active_support/core_ext/string/inflections'
+require 'enumerations/value'
+require 'enumerations/finder_methods'
 
-module Enumeration
+module Enumerations
   class Base
+    extend Enumerations::FinderMethods
+    include Enumerations::Value
+
     class_attribute :_values, :_symbol_index
     self._values = {}
     self._symbol_index = {}
@@ -13,13 +18,11 @@ module Enumeration
     #
     #   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.admin.id             => # 1
+    #   Role.find(:admin).name    => # "Admin"
+    #   Role.find(1).description  => # "Some description..."
     #
     def self.value(symbol, attributes)
-      # TODO: make this errors better if needed
-      # TODO: test this errors
       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])
@@ -31,8 +34,8 @@ module Enumeration
       #
       # Example:
       #
-      #    Role.admin => #<Enumeration::Value:0x007fff45d7ec30 @base=Role, @symbol=:admin...>
-      #    Role.staff => #<Enumeration::Value:0x007f980e9cb0a0 @base=Role, @symbol=:staff...>
+      #    Role.admin => #<Enumerations::Value: @base=Role, @symbol=:admin...>
+      #    Role.staff => #<Enumerations::Value: @base=Role, @symbol=:staff...>
       #
       singleton_class.send(:define_method, symbol) do
         find(symbol)
@@ -71,117 +74,21 @@ module Enumeration
     #
     # Example:
     #
-    #   Role.all => # [#<Enumeration::Value:0x007f8ed7f46100 @base=Role, @symbol=:admin...>,
-    #                  #<Enumeration::Value:0x007f8ed7f45de0 @base=Role, @symbol=:manager...>,
-    #                  #<Enumeration::Value:0x007f8ed7f45ae8 @base=Role, @symbol=:staff...>]
+    #   Role.all => # [#<Enumerations::Value: @base=Role, @symbol=:admin...>,
+    #                  #<Enumerations::Value: @base=Role, @symbol=:manager...>,
+    #                  #<Enumerations::Value: @base=Role, @symbol=:staff...>]
     #
     def self.all
       _values.values
     end
 
-    # Finds an enumeration by symbol, id or name
-    #
-    # Example:
-    #
-    #   Role.find(:admin)  => #<Enumeration::Value:0x007f8ed7f46100 @base=Role, @symbol=:admin...>
-    #   Role.find(2)       => #<Enumeration::Value:0x007f8ed7f45de0 @base=Role, @symbol=:manager...>
-    #   Role.find('2')     => #<Enumeration::Value:0x007f8ed7f45de0 @base=Role, @symbol=:manager...>
-    #   Role.find('staff') => #<Enumeration::Value:0x007f8ed7f45ae8 @base=Role, @symbol=:staff...>
-    #
-    def self.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 Integer then find_by_id(key)
-      end
-    end
-
-    # Finds an enumeration by defined attribute. Simmilar to AcriveRecord::FinderMethods#find_by
-    #
-    # Example:
-    #
-    #   Role.find_by(name: 'Admin')  => #<Enumeration::Value:0x007f8ed7f46100 @base=Role, @symbol=:admin...>
-    #
-    def self.find_by(**args)
-      _values.values.find { |value| args.map { |k, v| value.send(k) == v }.all? }
-    end
-
-    def self.find_by_key(key)
-      _values[key]
-    end
-
-    def self.find_by_id(id)
-      _values[_symbol_index.key(id)]
-    end
+    attr_reader :symbol
 
     def initialize(symbol, attributes)
       @symbol = symbol
       @attributes = attributes
-      create_instance_methods
-    end
 
-    attr_reader :symbol
-
-    def to_i
-      id
-    end
-
-    def to_s
-      name
-    end
-
-    def to_sym
-      @symbol
-    end
-
-    def to_param
-      id
-    end
-
-    # Comparison by id, 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 Integer then other == id
-      when Symbol then other == @symbol
-      else super
-      end
-    end
-
-    private
-
-    # Getters for all attributes
-    #
-    # Example:
-    #
-    #   Role.admin => #<Enumeration::Value:0x007fff45d7ec30 @base=Role, @symbol=:admin,
-    #                   @attributes={:id=>1, :name=>"Admin", :description=>"Some description..."}>
-    #   user.role.id => # 1
-    #   user.role.name => # "Admin"
-    #   user.role.description => # "Some description..."
-    #   user.role.admin? => # true
-    #   user.role.staff? => # false
-    #
-    def create_instance_methods
-      @attributes.each do |key, _|
-        self.class.send :define_method, key do
-          @attributes[key]
-        end
-      end
-
-      self.class.send :define_method, "#{@symbol}?" do
-        __callee__[0..-2].to_sym == @symbol
-      end
+      create_instance_methods
     end
   end
 end

data/lib/enumerations/finder_methods.rb

@@ -0,0 +1,38 @@
+module Enumerations
+  module FinderMethods
+    # Finds an enumeration by symbol, id 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
+    end
+
+    # Finds an enumeration by defined attribute. Similar to ActiveRecord::FinderMethods#find_by
+    #
+    # Example:
+    #
+    #   Role.find_by(name: 'Admin') => #<Enumerations::Value: @base=Role, @symbol=:admin...>
+    #
+    def find_by(**args)
+      _values.values.find { |value| args.map { |k, v| value.send(k) == v }.all? }
+    end
+
+    def find_by_key(key)
+      _values[key]
+    end
+
+    def find_by_id(id)
+      _values[_symbol_index.key(id)]
+    end
+  end
+end

data/lib/enumerations/reflection.rb

@@ -1,18 +1,22 @@
-module Enumeration
+module Enumerations
   class Reflection
     attr_reader :name
 
-    def initialize(name, options)
+    def initialize(name, options = {})
       @name = name
       @options = options
     end
 
     def class_name
-      @options[:class_name]
+      @class_name ||= (@options[:class_name] || name).to_s.camelize
     end
 
     def foreign_key
-      @options[:foreign_key]
+      @foreign_key ||= (@options[:foreign_key] || "#{name}_id").to_sym
+    end
+
+    def enumerator_class
+      @enumerator_class ||= class_name.constantize
     end
   end
 end

data/lib/enumerations/value.rb

@@ -0,0 +1,80 @@
+module Enumerations
+  module Value
+    def to_i
+      id
+    end
+
+    def to_s
+      name
+    end
+
+    def to_sym
+      symbol
+    end
+
+    def to_param
+      id
+    end
+
+    # Comparison by id, 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 Symbol then other == symbol
+      else super
+      end
+    end
+
+    private
+
+    def create_instance_methods
+      define_attributes_getters
+      define_value_checking_method
+    end
+
+    # Getters for all attributes
+    #
+    # Example:
+    #
+    #   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.description => # "Some description..."
+    #
+    def define_attributes_getters
+      @attributes.each do |key, _|
+        next if respond_to?(key)
+
+        self.class.send :define_method, key do
+          @attributes[key]
+        end
+      end
+    end
+
+    # Predicate methods for values
+    #
+    # Example:
+    #
+    #   user.role = Role.admin
+    #   user.role.admin? => # true
+    #   user.role.staff? => # false
+    #
+    def define_value_checking_method
+      self.class.send :define_method, "#{symbol}?" do
+        __callee__[0..-2].to_sym == symbol
+      end
+    end
+  end
+end

data/lib/enumerations/version.rb

@@ -1,3 +1,3 @@
-module Enumeration
-  VERSION = '1.3.2'
+module Enumerations
+  VERSION = '2.0.0'
 end

data/test/base_test.rb

@@ -13,6 +13,18 @@ class BaseTest < 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')
+
+    assert_equal :draft, status.symbol
+  end
+
   def test_find_by
     status = Status.find_by(name: 'Draft')
 
@@ -32,6 +44,19 @@ class BaseTest < Minitest::Test
     assert_equal statuses.first, Status.draft
   end
 
+  def test_symbols
+    status_symbols = Status.symbols
+
+    assert_equal 5, status_symbols.size
+    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' },
@@ -57,45 +82,17 @@ class BaseTest < Minitest::Test
     end
   end
 
-  def test_with_defined_custom_attributes_visible
-    status = Status.find(:none)
+  def test_enumerations_custom_instance_method
+    role = Role.find(:admin)
 
-    assert_equal true, status.visible
+    assert_equal 'user_Admin', role.my_custom_name
   end
 
-  def test_with_defined_custom_attributes_deleted
-    status = Status.find(:deleted)
-
-    assert_equal true, status.deleted
-  end
+  def test_all_enumerations_has_custom_instance_methods
+    roles = Role.all
 
-  def test_without_defined_custom_attributes
-    status = Status.find(:draft)
-
-    assert_equal nil, status.visible
-  end
-
-  def test_equal_by_id
-    status = Status.find(:draft)
-
-    assert_equal true, status == 1
-  end
-
-  def test_equal_by_symbol
-    status = Status.draft
-
-    assert_equal true, status == :draft
-  end
-
-  def test_equal_by_enumeration
-    status = Status.draft
-
-    assert_equal true, status == Status.draft
-  end
-
-  def test_not_equal_by_enumeration
-    status = Status.draft
-
-    assert_equal false, status == Status.published
+    assert_silent do
+      roles.map(&:my_custom_name)
+    end
   end
 end

data/test/database_helper.rb

@@ -0,0 +1,15 @@
+require 'logger'
+
+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
+  end
+
+  create_table :users, force: true do |t|
+    t.integer  :role_id
+    t.string   :status_id
+  end
+end

data/test/enumerations_test.rb

@@ -18,6 +18,20 @@ class EnumerationsTest < Minitest::Test
     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
+  end
+
+  def test_model_bang_assignment_with_custom_name
+    p = Post.new
+    p.different_status_draft!
+
+    assert_equal 'Draft', p.different_status.to_s
+  end
+
   def test_model_via_id_assignment
     p = Post.new
     p.some_other_status_id = Status.published.id
@@ -38,4 +52,37 @@ class EnumerationsTest < Minitest::Test
 
     assert_equal false, p.status.published?
   end
+
+  def test_multiple_enumerations_on_model
+    enumerations = User.reflect_on_all_enumerations
+
+    assert_equal 2, enumerations.size
+
+    assert_equal :role, enumerations.first.name
+    assert_equal :role_id, enumerations.first.foreign_key
+
+    assert_equal :status, enumerations[1].name
+    assert_equal :status_id, enumerations[1].foreign_key
+  end
+
+  def test_multiple_enumeration_assignments_on_model
+    u = User.new
+    u.role = Role.admin
+    u.status = Status.published
+
+    assert_equal 'Admin', u.role.to_s
+    assert_equal 'Published', u.status.to_s
+  end
+
+  def test_enumerated_class_has_scopes
+    Role.all do |role|
+      assert_respond_to User, ['with_role', role.name].join('_').to_sym
+    end
+  end
+
+  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
+  end
 end

data/test/reflection_test.rb

@@ -1,11 +1,38 @@
 require_relative 'test_helper'
 
 class ReflectionTest < Minitest::Test
-  def test_reflections
-    reflection = Enumeration::Reflection.new(:role, class_name: 'Role', foreign_key: :role_id)
+  def test_reflection_with_all_attributes
+    reflection = Enumerations::Reflection.new(:status, class_name: 'Status',
+                                                       foreign_key: :status_id)
 
-    assert_equal :role, reflection.name
-    assert_equal 'Role', reflection.class_name
-    assert_equal :role_id, reflection.foreign_key
+    assert_equal :status, reflection.name
+    assert_equal 'Status', reflection.class_name
+    assert_equal :status_id, 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
+  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
+  end
+
+  def test_reflection_with_class_name_as_constant
+    reflection = Enumerations::Reflection.new(:status, class_name: Status)
+
+    assert_equal 'Status', reflection.class_name
+    assert_equal ::Status, reflection.enumerator_class
   end
 end

data/test/test_helper.rb

@@ -1,14 +1,14 @@
-# TODO: improve tests
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
+
 require 'minitest/autorun'
 require 'enumerations'
+require 'active_record'
 require 'pry'
 
-# Faking ActiveRecord
-class MockActiveRecordBase
-  include Enumeration
-end
+require_relative 'database_helper'
 
-class Status < Enumeration::Base
+class Status < Enumerations::Base
   values draft:           { id: 1, name: 'Draft' },
          review_pending:  { id: 2, name: 'Review pending' },
          published:       { id: 3, name: 'Published' }
@@ -17,9 +17,26 @@ class Status < Enumeration::Base
   value :deleted, id: 5, deleted: true
 end
 
-class Post < MockActiveRecordBase
+class Role < Enumerations::Base
+  value :admin,   id: 1, name: 'Admin', admin: true
+  value :editor,  id: 2, name: 'Editor'
+  value :author,  id: 3, name: 'Author'
+
+  def my_custom_name
+    ['user', name].join('_')
+  end
+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'
 end
+
+class User < ActiveRecord::Base
+  attr_accessor :role_id, :status_id
+
+  enumeration :role
+  enumeration :status
+end

data/test/value_test.rb

@@ -0,0 +1,63 @@
+require_relative 'test_helper'
+
+class ValueTest < Minitest::Test
+  def test_equal_by_id
+    status = Status.find(:draft)
+
+    assert_equal true, status == 1
+  end
+
+  def test_equal_by_symbol
+    status = Status.draft
+
+    assert_equal true, status == :draft
+  end
+
+  def test_equal_by_enumeration
+    status = Status.draft
+
+    assert_equal true, status == Status.draft
+  end
+
+  def test_not_equal_by_enumeration
+    status = Status.draft
+
+    assert_equal false, status == Status.published
+  end
+
+  def test_with_defined_custom_attributes_visible
+    status = Status.find(:none)
+
+    assert_equal true, status.visible
+  end
+
+  def test_with_defined_custom_attributes_deleted
+    status = Status.find(:deleted)
+
+    assert_equal true, status.deleted
+  end
+
+  def test_without_defined_custom_attributes
+    status = Status.find(:draft)
+
+    assert_equal nil, status.visible
+  end
+
+  def test_enumeration_to_i
+    status = Status.find(:draft)
+
+    assert_equal status.to_i, 1
+  end
+
+  def test_enumeration_to_sym
+    status = Status.find(:draft)
+
+    assert_equal status.to_sym, :draft
+  end
+
+  def test_enumeration_to_param
+    status = Status.find(:draft)
+
+    assert_equal status.to_param, 1
+  end
+end

data/test/version_test.rb

@@ -2,6 +2,6 @@ require_relative 'test_helper'
 
 class VersionTest < Minitest::Test
   def test_version
-    assert_equal '1.3.0', Enumeration::VERSION
+    assert_equal '2.0.0', Enumerations::VERSION
   end
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: enumerations
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Tomislav Car
 - Nikica Jokic
 - Nikola Santic
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2010-08-20 00:00:00.000000000 Z
+date: 2016-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -54,6 +54,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Extends ActiveRecord with enumeration capabilites.
 email:
 - tomislav@infinum.hr
@@ -64,24 +106,27 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".travis.yml"
 - Gemfile
 - Rakefile
 - Readme.md
 - enumerations.gemspec
 - lib/enumerations.rb
 - lib/enumerations/base.rb
+- lib/enumerations/finder_methods.rb
 - lib/enumerations/reflection.rb
+- lib/enumerations/value.rb
 - lib/enumerations/version.rb
 - test/base_test.rb
+- test/database_helper.rb
 - test/enumerations_test.rb
 - test/reflection_test.rb
 - test/test_helper.rb
+- test/value_test.rb
 - test/version_test.rb
 homepage: https://github.com/infinum/enumerations
 licenses: []
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -96,13 +141,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key:
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
 specification_version: 4
 summary: Enumerations for ActiveRecord!
 test_files:
 - test/base_test.rb
+- test/database_helper.rb
 - test/enumerations_test.rb
 - test/reflection_test.rb
 - test/test_helper.rb
+- test/value_test.rb
 - test/version_test.rb

data/.travis.yml

@@ -1,5 +0,0 @@
-language: ruby
-rvm:
- - 2.1.0
- - 2.3.1
-script: rake