enumerations 2.5.3 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7415435429c08e2093220592c091dffca83b50fd26f6d71836873594da483778
-  data.tar.gz: 63538f83e93d43926f2401297c213a03c814efb667d96259f8f86cfa241072e3
+  metadata.gz: 2d4e5a6f8e18a9d70f988c555ea97c303467d965a1cf55a9e02f0406ddebdb85
+  data.tar.gz: 7cdec6ecd8e4ad23732ea23a5b41185b2ad1deb6cd44cedc96d73f2a28136925
 SHA512:
-  metadata.gz: dfcb47a129cd32afa78c25897aa681bef271266c878ba9fc077df12ed15543ebdab1f97e71c580adb9e19523bbf3287b3ec0a46a52b247f42030c4f9ade31b1d
-  data.tar.gz: 2dbce2808dcadd1cb3e0b16193b9f66e567846c8d9dca89478d30edc6c1b583e8b8b9e8443e08ec162e7e30dc78423cf7b90edf5de41de2b64722b664785a1d2
+  metadata.gz: 29193d63c19d102f702ecdbe16f9c1031cdd43a6a33768c977992749b6a722c7b3aaaa1e6011786c5bd9be7d20543b37b6611d930d1a205119984a9a91d6f2cc
+  data.tar.gz: 20b7ed5790969bb7b9ef820cc9ff89968cfef42560e46f3dbbc83b765a48bd4cef82b1d0092496ea7709db92aa4e0749d05d8b516b2d20a591807982f8c31f51

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Change Log
 
+## [v2.6.0](https://github.com/infinum/enumerations/tree/v2.6.0) (2024-10-22)
+[Full Changelog](https://github.com/infinum/enumerations/compare/v2.5.4...v2.6.0)
+
+**Implemented enhancements:**
+
+- Add ability to specify foreign key suffix on enum class.
+
+## [v2.5.4](https://github.com/infinum/enumerations/tree/v2.5.4) (2023-01-09)
+[Full Changelog](https://github.com/infinum/enumerations/compare/v2.5.3...v2.5.4)
+
+**Implemented enhancements:**
+
+- Add MIT license file.
+
 ## [v2.5.3](https://github.com/infinum/enumerations/tree/v2.5.3) (2022-02-02)
 [Full Changelog](https://github.com/infinum/enumerations/compare/v2.5.2...v2.5.3)
 

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Infinum
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -379,11 +379,12 @@ 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:
+If you want to configure primary key or foreign key suffix per enumeration class, you can use `primary_key=` and `foreign_key_suffix=` class method:
 
 ```ruby
 class Status < Enumerations::Base
   self.primary_key = :id
+  self.foreign_key_suffix = :id
 
   value :draft,           id: 1, name: 'Draft'
   value :review_pending,  id: 2, name: 'Review pending'

data/enumerations.gemspec

@@ -7,6 +7,7 @@ Gem::Specification.new do |s|
   s.summary     = 'Enumerations for ActiveRecord!'
   s.description = 'Extends ActiveRecord with enumeration capabilites.'
   s.homepage    = 'https://github.com/infinum/enumerations'
+  s.license     = 'MIT'
 
   s.authors     = [
     'Tomislav Car', 'Nikica Jokić', 'Nikola Santić', 'Stjepan Hadjić', 'Petar Ćurković'
@@ -23,7 +24,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'pry-byebug'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'simplecov'
-  s.add_development_dependency 'sqlite3', '~> 1.4.0'
+  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/base.rb

@@ -8,11 +8,12 @@ module Enumerations
     extend Enumerations::FinderMethods
     include Enumerations::Value
 
-    class_attribute :_values, :_symbol_index, :_primary_key
+    class_attribute :_values, :_symbol_index, :_primary_key, :_foreign_key_suffix
 
     self._values = {}
     self._symbol_index = {}
     self._primary_key = nil
+    self._foreign_key_suffix = nil
 
     # Adding new value to enumeration
     #
@@ -108,6 +109,34 @@ module Enumerations
       _primary_key || Enumerations.configuration.primary_key
     end
 
+    # Sets foreign key suffix for enumeration class.
+    #
+    # Example:
+    #
+    #   class Status < Enumeration::Base
+    #     foreign_key_suffix = :id
+    #   end
+
+    def self.foreign_key_suffix=(suffix)
+      self._foreign_key_suffix = suffix && suffix.to_sym
+    end
+
+    # Gets foreign key suffix for enumeration class.
+    #
+    # Example:
+    #
+    #   Status.foreign_key_suffix  => # nil
+    #
+    #   class Status < Enumeration::Base
+    #     foreign_key_suffix = :id
+    #   end
+    #
+    #   Status.foreign_key_suffix  => # :id
+    #
+    def self.foreign_key_suffix
+      _foreign_key_suffix || Enumerations.configuration.foreign_key_suffix
+    end
+
     def self.validate_symbol_and_primary_key(symbol, attributes)
       raise Enumerations::DuplicatedSymbolError if find(symbol)
 

data/lib/enumerations/reflection.rb

@@ -22,7 +22,7 @@ module Enumerations
     private
 
     def default_foreign_key_name
-      [name, Enumerations.configuration.foreign_key_suffix].compact.join('_')
+      [name, enumerator_class.foreign_key_suffix].compact.join('_')
     end
   end
 end

data/lib/enumerations/version.rb

@@ -1,3 +1,3 @@
 module Enumerations
-  VERSION = '2.5.3'.freeze
+  VERSION = '2.6.0'.freeze
 end

data/test/configuration/enumerations_test.rb

@@ -47,5 +47,15 @@ module Configuration
 
       assert_equal query_hash, custom_enum_id: 1
     end
+
+    def test_enumerations_overrides
+      assert_equal :id, OverridableStatus.primary_key
+      assert_equal :id, OverridableStatus.foreign_key_suffix
+
+      model = OverridableModel.new
+      model.overridable_status = OverridableStatus.draft
+
+      assert_equal 1, model.overridable_status_id
+    end
   end
 end

data/test/helpers/database_helper.rb

@@ -17,4 +17,8 @@ ActiveRecord::Schema.define do
     t.integer :custom_enum_id
     t.integer :custom_enum
   end
+
+  create_table :overridable_models, force: true do |t|
+    t.integer :overridable_status_id
+  end
 end

data/test/helpers/test_helper.rb

@@ -40,3 +40,14 @@ class User < ActiveRecord::Base
   enumeration :role
   enumeration :status
 end
+
+class OverridableStatus < Enumerations::Base
+  self.primary_key = :id
+  self.foreign_key_suffix = :id
+
+  value :draft, id: 1
+end
+
+class OverridableModel < ActiveRecord::Base
+  enumeration :overridable_status
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: enumerations
 version: !ruby/object:Gem::Version
-  version: 2.5.3
+  version: 2.6.0
 platform: ruby
 authors:
 - Tomislav Car
@@ -9,7 +9,7 @@ authors:
 - Nikola Santić
 - Stjepan Hadjić
 - Petar Ćurković
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
 date: 2017-09-08 00:00:00.000000000 Z
@@ -102,16 +102,16 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: '0'
 description: Extends ActiveRecord with enumeration capabilites.
 email:
 - tomislav@infinum.hr
@@ -128,6 +128,7 @@ files:
 - ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
+- LICENSE
 - MIGRATE.md
 - README.md
 - Rakefile
@@ -156,9 +157,10 @@ files:
 - test/translation_test.rb
 - test/value_test.rb
 homepage: https://github.com/infinum/enumerations
-licenses: []
+licenses:
+- MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -173,8 +175,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
-signing_key:
+rubygems_version: 3.5.15
+signing_key: 
 specification_version: 4
 summary: Enumerations for ActiveRecord!
 test_files: []