enumerations 2.2.3 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6bff6ddbd1cfb803b3463c11796daf3c81f1c741
-  data.tar.gz: 20a258a2ed4129ed92b044f2933fb366d45aba6e
+  metadata.gz: ce06adb418c77b2cfe89af486bff75362b4183bc
+  data.tar.gz: e65afcbf46c76d46625443de26b52445a7a12a29
 SHA512:
-  metadata.gz: 584c186148b1038d4aadbdd1ee4cb230ee32b40332aca1888933a2ac2813ad61dd356eb548701ab52a10a9e426122ba70e6022cc6254001431b3fd2e51c3d198
-  data.tar.gz: 7048a1acf02560a3311d3956d09ce76d25651a631bf7b4a169d7513d28f4f656142ec93a0f44fff6667022d8651f07cdc81104b2eab969c5dabb0468c65bc72e
+  metadata.gz: 168a363ddbbcf47dbe58f2024d455c6b5aae795360b92ad947d77f396ca25a4714067e4affb7e283d72ba80539d42f573d83cec68e68d2ba3d8334721f1e346e
+  data.tar.gz: d09864e055364e4415870471d0ed16f2f00a7a2afbda0604f4d8dd37c65d165054de7524a5ac62f5173d71bd4c8eca4a626d6993ff06d4d6fa15d7ee1cab125f

data/.rubocop.yml

@@ -0,0 +1,8 @@
+LineLength:
+  Max: 100
+
+Documentation:
+  Enabled: False
+
+Style/SymbolArray:
+  Enabled: False

data/Readme.md

@@ -6,7 +6,7 @@ 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)
 
-Rails plugin for enumerations in ActiveRecord models.
+Rails plugin for Enumerations in ActiveRecord models.
 
 Installation
 ============
@@ -83,6 +83,8 @@ Or you can set enumerations by `symbol`:
 @post.status = Status.find(:draft)
 ```
 
+> If you try to set value that is not an Enumeration value (except `nil`), you will get an `Enumerations::InvalidValueError` exception.
+
 Also, you can set enumeration value like this:
 
 ```ruby
@@ -175,6 +177,14 @@ following format:
 
 ```ruby
 with_#{enumeration_name}_#{enumeration_value_name}
+without_#{enumeration_name}_#{enumeration_value_name}
+```
+
+or you can use the following scope and pass an array of enumerations:
+
+```ruby
+with_#{enumeration_name}(enumeration, ...)
+without_#{enumeration_name}(enumeration, ...)
 ```
 
 Examples:
@@ -185,7 +195,13 @@ class Post < ActiveRecord::Base
 end
 
 Post.with_status_draft                        # => <#ActiveRecord::Relation []>
-Post.with_status_review_pending               # => <#ActiveRecord::Relation []>
+Post.without_status_review_pending            # => <#ActiveRecord::Relation []>
+Post.with_status(:draft)                      # => <#ActiveRecord::Relation []>
+Post.without_status(:draft)                   # => <#ActiveRecord::Relation []>
+Post.with_status(Status.draft)                # => <#ActiveRecord::Relation []>
+Post.with_status(:draft, :review_pending)     # => <#ActiveRecord::Relation []>
+Post.with_status(Status.draft, 'published')   # => <#ActiveRecord::Relation []>
+Post.with_status([:draft, :review_pending])   # => <#ActiveRecord::Relation []>
 ```
 
 ```ruby
@@ -195,6 +211,8 @@ end
 
 Post.with_my_status_draft                      # => <#ActiveRecord::Relation []>
 Post.with_my_status_review_pending             # => <#ActiveRecord::Relation []>
+Post.with_my_status(:draft)                    # => <#ActiveRecord::Relation []>
+Post.without_my_status(:draft)                 # => <#ActiveRecord::Relation []>
 ```
 
 Each scope returns all records with specified enumeration value.
@@ -219,7 +237,7 @@ Except `name` you can specify any other attributes to your enumerations:
 
 ```ruby
 class Status < Enumerations::Base
-  value :draft,           id: 1, name: 'Draft'
+  value :draft,           id: 1, name: 'Draft', published: false
   value :review_pending,  id: 2, name: 'Review pending', description: 'Some description...'
   value :published,       id: 3, name: 'Published', published: true
   value :other                                 # passing no attributes is also allowed
@@ -234,6 +252,16 @@ Status.review_pending.description              # => 'Some description...'
 Status.draft.description                       # => nil
 ```
 
+For each attribute, you have predicate method. Predicate methods are actually calling `present?`
+method on attribute value:
+
+```ruby
+Status.draft.name?                             # => true
+Status.draft.published?                        # => false
+Status.published.published?                    # => true
+Status.other.name?                             # => false
+```
+
 Translations
 =====
 
@@ -291,7 +319,7 @@ If you set enumeration as:
 ```ruby
 enumeration :status
 ```
-then model should have `status`column (as `String` type).
+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.
 
@@ -323,6 +351,17 @@ post = Post.new
 post.status = Status.draft      # => post.status_id = 1
 ```
 
+If you want to configure primary key per enumeration class, you can use `primary_key=` class method:
+
+```ruby
+class Status < Enumerations::Base
+  self.primary_key = :id
+
+  value :draft,           id: 1, name: 'Draft'
+  value :review_pending,  id: 2, name: 'Review pending'
+end
+```
+
 Database Enumerations
 =====================
 

data/enumerations.gemspec

@@ -3,7 +3,7 @@ require File.expand_path('../lib/enumerations/version', __FILE__)
 Gem::Specification.new do |s|
   s.name        = 'enumerations'
   s.version     = Enumerations::VERSION
-  s.date        = '2016-09-20'
+  s.date        = '2017-09-08'
   s.summary     = 'Enumerations for ActiveRecord!'
   s.description = 'Extends ActiveRecord with enumeration capabilites.'
   s.homepage    = 'https://github.com/infinum/enumerations'

data/lib/enumerations.rb

@@ -7,7 +7,7 @@ require 'enumerations/configuration'
 require 'enumerations/version'
 require 'enumerations/base'
 require 'enumerations/reflection'
-require 'enumerations/enumerations_error'
+require 'enumerations/errors'
 
 module Enumerations
   extend ActiveSupport::Concern
@@ -58,7 +58,8 @@ module Enumerations
       define_getter_method(reflection)
       define_setter_method(reflection)
       define_bang_methods(reflection)
-      define_scopes(reflection)
+      define_scopes_for_each_enumeration_value(reflection)
+      define_enumeration_scope(reflection)
 
       self._enumerations += [reflection]
     end
@@ -86,9 +87,11 @@ module Enumerations
       define_method("#{reflection.name}=") do |other|
         enumeration_value = reflection.enumerator_class.find(other)
 
+        raise Enumerations::InvalidValueError if other.present? && enumeration_value.nil?
+
         self[reflection.foreign_key] =
           enumeration_value &&
-          enumeration_value.send(Enumerations.configuration.primary_key || :symbol)
+          enumeration_value.send(reflection.enumerator_class.primary_key || :symbol)
       end
     end
 
@@ -116,12 +119,44 @@ module Enumerations
     #   User.with_role_admin => <#ActiveRecord::Relation []>
     #   User.with_role_editor => <#ActiveRecord::Relation []>
     #
-    def define_scopes(reflection)
+    def define_scopes_for_each_enumeration_value(reflection)
       reflection.enumerator_class.all.each do |enumeration|
-        foreign_key = enumeration.send(Enumerations.configuration.primary_key || :symbol)
+        foreign_key = enumeration.send(reflection.enumerator_class.primary_key || :symbol)
+
+        scope("with_#{reflection.name}_#{enumeration.symbol}",
+              -> { where(reflection.foreign_key => foreign_key) })
+
+        scope("without_#{reflection.name}_#{enumeration.symbol}",
+              -> { where.not(reflection.foreign_key => foreign_key) })
+      end
+    end
+
+    # Scope for enumerated ActiveRecord model.
+    # Format of scope name is with_#{enumeration_name}(*enumerations).
+    #
+    # Example:
+    #
+    #   User.with_role(:admin) => <#ActiveRecord::Relation []>
+    #   User.with_role(:admin, Role.editor) => <#ActiveRecord::Relation []>
+    #
+    def define_enumeration_scope(reflection)
+      scope("with_#{reflection.name}",
+            lambda do |*symbols|
+              where(reflection.foreign_key => fetch_foreign_key_values(reflection, symbols))
+            end)
+
+      scope("without_#{reflection.name}",
+            lambda do |*symbols|
+              where.not(reflection.foreign_key => fetch_foreign_key_values(reflection, symbols))
+            end)
+    end
+
+    def fetch_foreign_key_values(reflection, *symbols)
+      symbols.flatten.map do |symbol|
+        enumeration_value = reflection.enumerator_class.find(symbol)
 
-        scope "with_#{reflection.name}_#{enumeration.symbol}",
-              -> { where(reflection.foreign_key => foreign_key) }
+        enumeration_value &&
+          enumeration_value.send(reflection.enumerator_class.primary_key || :symbol)
       end
     end
   end

data/lib/enumerations/base.rb

@@ -8,10 +8,11 @@ module Enumerations
     extend Enumerations::FinderMethods
     include Enumerations::Value
 
-    class_attribute :_values, :_symbol_index
+    class_attribute :_values, :_symbol_index, :_primary_key
 
     self._values = {}
     self._symbol_index = {}
+    self._primary_key = nil
 
     # Adding new value to enumeration
     #
@@ -79,16 +80,45 @@ module Enumerations
       _values.values
     end
 
+    # Sets primary key for enumeration class.
+    #
+    # Example:
+    #
+    #   class Status < Enumeration::Base
+    #     primary_key = :id
+    #   end
+    #
+    def self.primary_key=(key)
+      self._primary_key = key && key.to_sym
+    end
+
+    # Gets primary key for enumeration class.
+    #
+    # Example:
+    #
+    #   Status.primary_key  => # nil
+    #
+    #   class Status < Enumeration::Base
+    #     primary_key = :id
+    #   end
+    #
+    #   Status.primary_key  => # :id
+    #
+    def self.primary_key
+      _primary_key || Enumerations.configuration.primary_key
+    end
+
     def self.validate_symbol_and_primary_key(symbol, attributes)
-      raise EnumerationsError, "Duplicate symbol #{symbol}" if find(symbol)
+      raise Enumerations::DuplicatedSymbolError if find(symbol)
 
-      primary_key = Enumerations.configuration.primary_key
       return if primary_key.nil?
 
-      raise EnumerationsError, 'Enumeration primary key is required' if attributes[primary_key].nil?
-      raise EnumerationsError, "Duplicate primary key #{attributes[primary_key]}" if find(attributes[primary_key])
+      primary_key_value = attributes[primary_key]
+
+      raise Enumerations::MissingPrimaryKeyError if primary_key_value.nil?
+      raise Enumerations::DuplicatedPrimaryKeyError if find(primary_key_value)
 
-      self._symbol_index = _symbol_index.merge(symbol => attributes[primary_key])
+      self._symbol_index = _symbol_index.merge(symbol => primary_key_value)
     end
 
     private_class_method :validate_symbol_and_primary_key

data/lib/enumerations/errors.rb

@@ -0,0 +1,7 @@
+module Enumerations
+  class Error < StandardError; end
+  class DuplicatedSymbolError < Error; end
+  class MissingPrimaryKeyError < Error; end
+  class DuplicatedPrimaryKeyError < Error; end
+  class InvalidValueError < Error; end
+end

data/lib/enumerations/reflection.rb

@@ -1,6 +1,6 @@
 module Enumerations
   class Reflection
-    attr_reader :name
+    attr_reader :name, :options
 
     def initialize(name, options = {})
       @name = name
@@ -8,11 +8,11 @@ module Enumerations
     end
 
     def class_name
-      @class_name ||= (@options[:class_name] || name).to_s.camelize
+      @class_name ||= (options[:class_name] || name).to_s.camelize
     end
 
     def foreign_key
-      @foreign_key ||= (@options[:foreign_key] || default_foreign_key_name).to_sym
+      @foreign_key ||= (options[:foreign_key] || default_foreign_key_name).to_sym
     end
 
     def enumerator_class

data/lib/enumerations/value.rb

@@ -39,6 +39,7 @@ module Enumerations
     def create_instance_methods
       define_attributes_getters
       define_value_checking_method
+      define_predicate_methods_for_attributes
     end
 
     # Getters for all attributes
@@ -83,5 +84,28 @@ module Enumerations
         __callee__[0..-2].to_sym == symbol
       end
     end
+
+    # Predicate methods for all attributes
+    #
+    # Example:
+    #
+    #   class Role < Enumerations::Base
+    #     value :admin, name: 'Administrator', active: false
+    #   end
+    #
+    #   user.role.name?       => # true
+    #   user.role.admin?      => # false
+    #
+    def define_predicate_methods_for_attributes
+      @attributes.each do |key, _|
+        method_name = "#{key}?"
+
+        next if respond_to?(method_name.to_sym)
+
+        self.class.send :define_method, method_name do
+          @attributes[key].present?
+        end
+      end
+    end
   end
 end

data/lib/enumerations/version.rb

@@ -1,3 +1,3 @@
 module Enumerations
-  VERSION = '2.2.3'.freeze
+  VERSION = '2.3.1'.freeze
 end

data/test/base_test.rb

@@ -16,7 +16,7 @@ class BaseTest < Minitest::Test
   end
 
   def test_duplicated_symbol
-    assert_raises EnumerationsError, 'Duplicate symbol draft' do
+    assert_raises Enumerations::DuplicatedSymbolError do
       obj = Class.new(Enumerations::Base)
 
       obj.value :draft, id: 1, name: 'Draft'

data/test/configuration/custom_configuration_test.rb

@@ -0,0 +1,27 @@
+module Configuration
+  ::CustomConfigurationEnum = Class.new(Enumerations::Base)
+
+  CustomConfigurationEnum.primary_key = :id
+  CustomConfigurationEnum.value :draft, id: 1
+
+  ::CustomConfigurationModel = Class.new(ActiveRecord::Base)
+  CustomConfigurationModel.table_name = :custom_models
+  CustomConfigurationModel.enumeration :custom_configuration_enum, foreign_key: :custom_enum_id
+
+  class CustomConfigurationTest < Minitest::Test
+    def test_primary_key_value
+      assert_equal :id, CustomConfigurationEnum.primary_key
+    end
+
+    def test_primary_key_value_is_not_set_in_configuration
+      assert_nil Enumerations.configuration.primary_key
+    end
+
+    def test_value_set_for_custom_foreign_key_config
+      model = CustomConfigurationModel.new
+      model.custom_configuration_enum = :draft
+
+      assert_equal :draft, model.custom_configuration_enum.symbol
+    end
+  end
+end

data/test/configuration_test.rb

@@ -37,7 +37,7 @@ class ConfigurationTest < Minitest::Test
   def test_required_primary_key_when_primary_key_configured
     Enumerations.configure { |config| config.primary_key = :id }
 
-    assert_raises EnumerationsError, 'Enumeration primary key is required' do
+    assert_raises Enumerations::MissingPrimaryKeyError, 'Enumeration primary key is required' do
       Class.new(Enumerations::Base).value :draft, name: 'Draft'
     end
   end
@@ -45,7 +45,7 @@ class ConfigurationTest < Minitest::Test
   def test_duplicated_primary_key_when_primary_key_configured
     Enumerations.configure { |config| config.primary_key = :id }
 
-    assert_raises EnumerationsError, 'Duplicate primary key 1' do
+    assert_raises Enumerations::DuplicatedPrimaryKeyError, 'Duplicate primary key 1' do
       Class.new(Enumerations::Base).values draft: { id: 1, name: 'Draft' },
                                            test:  { id: 1, name: 'Draft' }
     end

data/test/enumerations_test.rb

@@ -1,5 +1,5 @@
 require_relative 'helpers/test_helper'
-require 'enumerations/enumerations_error'
+require 'enumerations/errors'
 
 class EnumerationsTest < Minitest::Test
   def test_reflect_on_all_enumerations
@@ -75,21 +75,62 @@ class EnumerationsTest < Minitest::Test
     assert_equal 'published', u.status.to_s
   end
 
+  def test_enumerated_class_has_enumeration_scope
+    assert_respond_to User, :with_role
+  end
+
   def test_enumerated_class_has_scopes
     Role.all.each do |role|
       assert_respond_to User, ['with_role', role.to_s].join('_').to_sym
     end
   end
 
-  def test_enumerated_class_scope_hash_value
+  def test_enumerated_class_enumeration_scope_hash_value
+    query_hash = User.with_role(:admin).where_values_hash.symbolize_keys
+
+    assert_equal query_hash, role: :admin
+  end
+
+  def test_enumerated_class_enumeration_without_scope_results
+    User.create(role: :admin)
+    User.create(role: :editor)
+
+    results = User.without_role(:admin)
+
+    assert_equal results, User.where.not(role: :admin)
+  end
+
+  def test_enumerated_class_enumeration_scope_hash_value_for_multiple_enums
+    query_hash = User.with_role(:admin, Role.author, 'editor').where_values_hash.symbolize_keys
+
+    assert_equal query_hash, role: [:admin, :author, :editor]
+  end
+
+  def test_enumerated_class_enumeration_scope_hash_value_for_multiple_enums_as_array
+    query_hash = User.with_role([:admin, Role.author, 'editor']).where_values_hash.symbolize_keys
+
+    assert_equal query_hash, role: [:admin, :author, :editor]
+  end
+
+  def test_enumerated_class_without_scope_hash_value
     query_hash = User.with_role_admin.where_values_hash.symbolize_keys
 
     assert_equal query_hash, role: :admin
   end
 
+  def test_enumerated_class_without_scope_results
+    User.create(role: :admin)
+    User.create(role: :editor)
+
+    results = User.without_role_admin
+
+    assert_equal results, User.where.not(role: :admin)
+  end
+
   def test_nonexistent_value_assignment
-    user = User.new(role: :nonexistent_value)
-    assert_nil user.role
+    assert_raises Enumerations::InvalidValueError do
+      User.new(role: :nonexistent_value)
+    end
   end
 
   def test_on_nil_value_assignment

data/test/value_test.rb

@@ -68,4 +68,18 @@ class ValueTest < Minitest::Test
 
     assert_equal role.type, 'croatist'
   end
+
+  def test_enumeration_attribute_predicate_methods
+    status = Status.none
+
+    assert_equal status.name?, true
+    assert_equal status.visible?, true
+    assert_equal status.deleted?, false
+  end
+
+  def test_enumeration_attribute_predicate_method_on_undefined_attribute
+    status = Status.deleted
+
+    assert_equal status.name?, false
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: enumerations
 version: !ruby/object:Gem::Version
-  version: 2.2.3
+  version: 2.3.1
 platform: ruby
 authors:
 - Tomislav Car
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-20 00:00:00.000000000 Z
+date: 2017-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -124,6 +124,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - Gemfile
 - Migrate.md
 - Rakefile
@@ -132,13 +133,14 @@ files:
 - lib/enumerations.rb
 - lib/enumerations/base.rb
 - lib/enumerations/configuration.rb
-- lib/enumerations/enumerations_error.rb
+- lib/enumerations/errors.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/custom_configuration_test.rb
 - test/configuration/enumerations_test.rb
 - test/configuration/finder_test.rb
 - test/configuration_test.rb
@@ -170,13 +172,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Enumerations for ActiveRecord!
 test_files:
 - test/base_test.rb
 - test/configuration/configuration.rb
+- test/configuration/custom_configuration_test.rb
 - test/configuration/enumerations_test.rb
 - test/configuration/finder_test.rb
 - test/configuration_test.rb

data/lib/enumerations/enumerations_error.rb

@@ -1,2 +0,0 @@
-class EnumerationsError < RuntimeError
-end