enumerations 2.5.4 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96fda6cfaff4da9dfd29920b976700cb73ac86717712db80e65f255188ee5c42
-  data.tar.gz: 2bc62be14144f04d162423d9d36f9949e397f6a325464d4e4fd5488e16688b83
+  metadata.gz: 1754e7d5747cf0444bf6b19ba7915f8517eecc6d847dc76af169442bb8d31aed
+  data.tar.gz: e00f367b9c16a09155ee517163a6803afbed756d6ae24ea2bf945c5b062cbc01
 SHA512:
-  metadata.gz: fd955f210f7747cfd692f7ee2f333e66aeca3a280ab20d1eee9fb96c9287505f95b438cc0576339b03ac171d7abbb362bef81de212bad37acb799f14a256d13c
-  data.tar.gz: c9b384db06f64b3b10e335416fbb7855949d0d859273776de100865ee5ed858d7efc80ff9daf69b827eaecd40831dc372014203bc9b82fa95215957c4fb357b0
+  metadata.gz: c43fe2bc75f47f1bd53c17f676a2648a2be94ea1598d42af96df85cb31add41db2cf0faf9a8b2bca47a3bb9fda2849f52be4076386fddbcacafe395e410a9cc2
+  data.tar.gz: 9a858dcb732e394343c0f323fcf41433a9caf695d9d6d300f813cdb98f4d5bb4574c9c60eb46fe9be8005f374c7eed67f2a7604a655aa046f83c4bb701a083cf

data/.github/workflows/test.yml

@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby: [2.6, 2.7, '3.0', 3.1]
+        ruby: ['3.0', 3.1, 3.2, 3.3, 3.4]
 
     steps:
       - uses: actions/checkout@v2

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Change Log
 
+## [v3.0.0](https://github.com/infinum/enumerations/tree/v3.0.0) (2026-01-16)
+[Full Changelog](https://github.com/infinum/enumerations/compare/v2.6.0...v3.0.0)
+
+**Breaking change:**
+
+- enumeration classes with overridden `to_s` method might not work as expected anymore
+(previously, overriding `to_s` would affect the value saved to the database, now it doesn't anymore)
+
+**Implemented enhancements:**
+
+- Drop support for ruby 2.6 and 2.7, only versions '>= 3.0' are now supported
+- Resolve `ActiveSupport::Multibyte::Chars` deprecation warning
+
+## [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)
 

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

@@ -1,4 +1,6 @@
-require File.expand_path('../lib/enumerations/version', __FILE__)
+# frozen_string_literal: true
+
+require File.expand_path('lib/enumerations/version', __dir__)
 
 Gem::Specification.new do |s|
   s.name        = 'enumerations'
@@ -8,8 +10,9 @@ Gem::Specification.new do |s|
   s.description = 'Extends ActiveRecord with enumeration capabilites.'
   s.homepage    = 'https://github.com/infinum/enumerations'
   s.license     = 'MIT'
+  s.required_ruby_version = '>= 3.0'
 
-  s.authors     = [
+  s.authors = [
     'Tomislav Car', 'Nikica Jokić', 'Nikola Santić', 'Stjepan Hadjić', 'Petar Ćurković'
   ]
 
@@ -24,7 +27,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

@@ -1,18 +1,21 @@
+# frozen_string_literal: true
+
 require 'active_support/core_ext/class/attribute'
 require 'active_support/core_ext/string/inflections'
 require 'enumerations/value'
 require 'enumerations/finder_methods'
 
 module Enumerations
-  class Base < ActiveSupport::Multibyte::Chars
+  class Base < String
     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 +111,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)
 
@@ -133,11 +164,5 @@ module Enumerations
 
       create_instance_methods
     end
-
-    private
-
-    def chars(string)
-      string
-    end
   end
 end

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,5 @@
+# frozen_string_literal: true
+
 module Enumerations
-  VERSION = '2.5.4'.freeze
+  VERSION = '3.0.0'
 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/enumerations_test.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require_relative 'helpers/test_helper'
 require 'enumerations/errors'
 
-class EnumerationsTest < Minitest::Test
+class EnumerationsTest < Minitest::Test # rubocop:disable Metrics/ClassLength
   def test_reflect_on_all_enumerations
     enumerations = Post.reflect_on_all_enumerations
 
@@ -157,4 +159,12 @@ class EnumerationsTest < Minitest::Test
     user = User.new(role: nil)
     assert_nil user.role
   end
+
+  def test_type_cast_when_saving_value_to_database
+    client = ApiClient.new(api_client_permission: ApiClientPermission.people_first_name)
+    client.save
+
+    # overriding to_s doesn't have an effect on the value saved to the database
+    assert_equal 'people_first_name', client[:api_client_permission]
+  end
 end

data/test/helpers/database_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'logger'
 
 ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
@@ -17,4 +19,12 @@ 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
+
+  create_table :api_clients, force: true do |t|
+    t.string :api_client_permission
+  end
 end

data/test/helpers/test_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'simplecov'
 SimpleCov.start
 
@@ -10,9 +12,9 @@ require_relative 'database_helper'
 require_relative 'locale_helper'
 
 class Status < Enumerations::Base
-  values draft:           { id: 1, name: 'Draft' },
-         review_pending:  { id: 2, name: 'Review pending' },
-         published:       { id: 3, name: 'Published' }
+  values draft: { id: 1, name: 'Draft' },
+         review_pending: { id: 2, name: 'Review pending' },
+         published: { id: 3, name: 'Published' }
 
   value :none,    id: 4, name: 'None', visible: true, deleted: false
   value :deleted, id: 5, deleted: true
@@ -29,6 +31,19 @@ class Role < Enumerations::Base
   end
 end
 
+class ApiClientPermission < Enumerations::Base
+  value :people_first_name, id: 'people.first_name'
+  value :people_last_name, id: 'people.last_name'
+
+  def to_s
+    id
+  end
+end
+
+class ApiClient < ActiveRecord::Base
+  enumeration :api_client_permission
+end
+
 class Post < ActiveRecord::Base
   enumeration :status
   enumeration :different_status, foreign_key: :some_other_status, class_name: 'Status'
@@ -40,3 +55,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.4
+  version: 3.0.0
 platform: ruby
 authors:
 - Tomislav Car
@@ -9,7 +9,6 @@ authors:
 - Nikola Santić
 - Stjepan Hadjić
 - Petar Ćurković
-autorequire:
 bindir: bin
 cert_chain: []
 date: 2017-09-08 00:00:00.000000000 Z
@@ -102,16 +101,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
@@ -160,7 +159,6 @@ homepage: https://github.com/infinum/enumerations
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -168,15 +166,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.5
-signing_key:
+rubygems_version: 3.6.4
 specification_version: 4
 summary: Enumerations for ActiveRecord!
 test_files: