enumerate_it 4.1.0 → 4.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e0e2aa1d31c14c5e310f50feb06824c19e7bffa49d08ab1f29d8f3a9b45e32d
-  data.tar.gz: a6e1642362885b5e306c713dd54c859452c2392bb17c012e039c84bd8878f9e9
+  metadata.gz: 30af25c92670f35f261f3d6ad6dca3f302d3553d6a9a1adf0a91495402f11718
+  data.tar.gz: 5f8324535f04dc5553a4ef359cb0429294aa3257a23e3a9b7d2a9a08c344919e
 SHA512:
-  metadata.gz: ea12eb1fe75185a0525f0580906391e37d5b540bcc09f273a2cac96c7e168994b184f549c54cd04af9940452355fd159d449c199db5855cdf0b0b03c209dd8f6
-  data.tar.gz: f2793a073ffb559e162970e069bc5136d08b03e74dd77f885c1f27d041c48c7d25fb83de9c982bcfb4e1105149635272db5ef8ee4d86c228666c87318baae765
+  metadata.gz: 72f81a09f56ad298a98e21c4aa817e36f41b435ec747fb5f717b1004708877a2eef813aedf1127831126e1e7d6131f385bc9e1e39fcefb2aae3356f63d86c4ba
+  data.tar.gz: 993ecdc71d85a9c13eefef4f7129bf179de1d8af96694239691294f862427eeaffc28493b4e90457f6eaafff4744cce8c107a1ceb9c9cde6ab36a22ca2f4fe6d

data/.github/workflows/ci.yml

@@ -9,11 +9,12 @@ jobs:
 
       matrix:
         ruby:
-          - 3.0
-          - 3.1
-          - 3.2
-          - 3.3
-          - 3.4
+          - "3.0"
+          - "3.1"
+          - "3.2"
+          - "3.3"
+          - "3.4"
+          - "4.0"
         gemfile:
           - gemfiles/rails_6.0.gemfile
           - gemfiles/rails_6.1.gemfile
@@ -21,12 +22,27 @@ jobs:
           - gemfiles/rails_7.1.gemfile
           - gemfiles/rails_7.2.gemfile
           - gemfiles/rails_8.0.gemfile
+          - gemfiles/rails_8.1.gemfile
         exclude:
-          # Rails 8 requires Ruby 3.2 or newer
+          # Rails 7.2+ requires Ruby 3.1 or newer
+          - ruby: 3.0
+            gemfile: gemfiles/rails_7.2.gemfile
+          # Rails 8+ requires Ruby 3.2 or newer
           - ruby: 3.0
             gemfile: gemfiles/rails_8.0.gemfile
+          - ruby: 3.0
+            gemfile: gemfiles/rails_8.1.gemfile
           - ruby: 3.1
             gemfile: gemfiles/rails_8.0.gemfile
+          - ruby: 3.1
+            gemfile: gemfiles/rails_8.1.gemfile
+          # Rails 6.x and 7.0 are EOL and don't support Ruby 4+
+          - ruby: 4.0
+            gemfile: gemfiles/rails_6.0.gemfile
+          - ruby: 4.0
+            gemfile: gemfiles/rails_6.1.gemfile
+          - ruby: 4.0
+            gemfile: gemfiles/rails_7.0.gemfile
 
     env:
       BUNDLE_GEMFILE: "${{ matrix.gemfile }}"
@@ -35,7 +51,7 @@ jobs:
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v4
+      uses: actions/checkout@v7
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
@@ -43,7 +59,7 @@ jobs:
         bundler-cache: true
 
     - name: Rubocop
-      if: ${{ matrix.ruby == '3.4' }}
+      if: ${{ matrix.ruby == '4.0' }}
       run: "bundle exec rubocop"
 
     - name: Tests

data/.prettierrc.json

@@ -0,0 +1,4 @@
+{
+  "printWidth": 80,
+  "proseWrap": "always"
+}

data/.rubocop.yml

@@ -8,7 +8,7 @@ inherit_mode:
 
 AllCops:
   NewCops: enable
-  TargetRubyVersion: 3.4
+  TargetRubyVersion: 3.0 # Keep in sync with `required_ruby_version` in the gemspec.
 
   Exclude:
     - 'lib/generators/enumerate_it/enum/templates/**/*'
@@ -67,7 +67,11 @@ Style/HashTransformKeys:
 Style/HashTransformValues:
   Enabled: true
 
-Naming/PredicateName:
+Style/OneClassPerFile:
+  Exclude:
+    - 'spec/support//**/*'
+
+Naming/PredicatePrefix:
   Exclude:
     - 'lib/enumerate_it/class_methods.rb'
 

data/Appraisals

@@ -4,7 +4,7 @@ require 'json'
 rails_versions = JSON.parse(Net::HTTP.get(URI('https://rubygems.org/api/v1/versions/rails.json')))
   .group_by { |version| version['number'] }.keys.grep_v(/rc|racecar|alpha|beta|pre/)
 
-%w[6.0 6.1 7.0 7.1 7.2 8.0].each do |rails_version|
+%w[6.0 6.1 7.0 7.1 7.2 8.0 8.1].each do |rails_version|
   appraise "rails_#{rails_version}" do
     current_version = rails_versions
       .select { |key| key.match(/\A#{rails_version}/) }
@@ -19,6 +19,9 @@ rails_versions = JSON.parse(Net::HTTP.get(URI('https://rubygems.org/api/v1/versi
       gem 'sqlite3', '< 2' # Rails 6.x and 7.0 require sqlite3 v1.x
     end
 
+    # Rails versions before 8.1 pass the removed quirks_mode option to JSON 3.
+    gem 'json', '< 3' if Gem::Version.new(rails_version) < Gem::Version.new('8.1')
+
     # The following is likely necessary due to this issue (or something related):
     # https://stackoverflow.com/a/79385484/1445184
     if Gem::Version.new(rails_version) < Gem::Version.new(7.1)

data/Gemfile.lock

@@ -1,26 +1,26 @@
 PATH
   remote: .
   specs:
-    enumerate_it (4.1.0)
+    enumerate_it (4.2.1)
       activesupport (>= 6.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (8.0.2)
-      activesupport (= 8.0.2)
-    activerecord (8.0.2)
-      activemodel (= 8.0.2)
-      activesupport (= 8.0.2)
+    activemodel (8.1.4)
+      activesupport (= 8.1.4)
+    activerecord (8.1.4)
+      activemodel (= 8.1.4)
+      activesupport (= 8.1.4)
       timeout (>= 0.4.0)
-    activesupport (8.0.2)
+    activesupport (8.1.4)
       base64
-      benchmark (>= 0.3)
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.3.1)
       connection_pool (>= 2.2.5)
       drb
       i18n (>= 1.6, < 2)
+      json
       logger (>= 1.4.2)
       minitest (>= 5.1)
       securerandom (>= 0.3)
@@ -31,80 +31,86 @@ GEM
       rake
       thor (>= 0.14.0)
     ast (2.4.3)
-    base64 (0.2.0)
-    benchmark (0.4.0)
-    bigdecimal (3.1.9)
+    base64 (0.3.0)
+    bigdecimal (4.1.3)
     coderay (1.1.3)
-    concurrent-ruby (1.3.5)
-    connection_pool (2.5.3)
-    diff-lcs (1.6.1)
-    drb (2.2.1)
-    i18n (1.14.7)
+    concurrent-ruby (1.3.8)
+    connection_pool (3.0.2)
+    diff-lcs (1.6.2)
+    drb (2.2.3)
+    i18n (1.15.2)
       concurrent-ruby (~> 1.0)
-    json (2.11.3)
-    language_server-protocol (3.17.0.4)
+    io-console (0.9.4)
+    json (3.0.2)
+    language_server-protocol (3.17.0.6)
     lint_roller (1.1.0)
     logger (1.7.0)
     method_source (1.1.0)
-    mini_portile2 (2.8.8)
-    minitest (5.25.5)
-    parallel (1.27.0)
-    parser (3.3.8.0)
+    mini_portile2 (2.8.9)
+    minitest (6.0.6)
+      drb (~> 2.0)
+      prism (~> 1.5)
+    parallel (2.3.0)
+    parser (3.3.12.0)
       ast (~> 2.4.1)
       racc
-    prism (1.4.0)
-    pry (0.15.2)
+    prism (1.9.0)
+    pry (0.16.0)
       coderay (~> 1.1)
       method_source (~> 1.0)
+      reline (>= 0.6.0)
     racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.2.1)
-    regexp_parser (2.10.0)
-    rspec (3.13.0)
+    rake (13.4.2)
+    regexp_parser (2.13.1)
+    reline (0.7.0)
+      io-console (~> 0.5)
+    rspec (3.13.2)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.3)
+    rspec-core (3.13.6)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.3)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.2)
+    rspec-mocks (3.13.8)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.2)
-    rubocop (1.75.4)
-      json (~> 2.3)
+    rspec-support (3.13.7)
+    rubocop (1.92.0)
+      json (>= 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
-      parallel (~> 1.10)
+      parallel (>= 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 2.9.3, < 3.0)
-      rubocop-ast (>= 1.44.0, < 2.0)
+      regexp_parser (>= 2.11.3, < 3.0)
+      rubocop-ast (>= 1.49.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.44.1)
+    rubocop-ast (1.50.0)
       parser (>= 3.3.7.2)
-      prism (~> 1.4)
+      prism (~> 1.7)
     rubocop-rake (0.7.1)
       lint_roller (~> 1.1)
       rubocop (>= 1.72.1)
-    rubocop-rspec (3.6.0)
+    rubocop-rspec (3.10.2)
       lint_roller (~> 1.1)
-      rubocop (~> 1.72, >= 1.72.1)
+      regexp_parser (>= 2.0)
+      rubocop (~> 1.86, >= 1.86.2)
     ruby-progressbar (1.13.0)
     securerandom (0.4.1)
-    sqlite3 (1.7.3)
+    sqlite3 (2.9.6)
       mini_portile2 (~> 2.8.0)
-    thor (1.3.2)
-    timeout (0.4.3)
+    thor (1.5.0)
+    timeout (0.6.1)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (3.1.4)
-      unicode-emoji (~> 4.0, >= 4.0.4)
-    unicode-emoji (4.0.4)
-    uri (1.0.3)
+    unicode-display_width (3.3.0)
+      unicode-emoji (~> 4.3)
+    unicode-emoji (4.3.0)
+    uri (1.1.2)
 
 PLATFORMS
   ruby
@@ -120,7 +126,59 @@ DEPENDENCIES
   rubocop
   rubocop-rake
   rubocop-rspec
-  sqlite3 (< 2)
+  sqlite3
+
+CHECKSUMS
+  activemodel (8.1.4) sha256=9a0906c127bd118aa5f06157db12b8f750da83dccee72db2f658547a0ae7a0e8
+  activerecord (8.1.4) sha256=3b4957ea7f246c9231bd7faa909312eac03a9101aaf87977b6c52733ff00b04f
+  activesupport (8.1.4) sha256=891dd3fe43c4fc8391934b237b1189bb1f661c932a84a840043db9d46a4e80df
+  appraisal (2.5.0) sha256=36989221be127913b0dba8d114da2001e6b2dceea7bd4951200eaba764eed3ce
+  ast (2.4.3) sha256=954615157c1d6a382bc27d690d973195e79db7f55e9765ac7c481c60bdb4d383
+  base64 (0.3.0) sha256=27337aeabad6ffae05c265c450490628ef3ebd4b67be58257393227588f5a97b
+  bigdecimal (4.1.3) sha256=61ebe1e5e559bdc3cc6f2c0ee7f427321fc838f59611c294356eb04d6e21cf66
+  bundler (4.0.22) sha256=d8d5ec84c8555e0af71db63ed7aee4d1a8fb839ec46d84212d61979242a5d75a
+  coderay (1.1.3) sha256=dc530018a4684512f8f38143cd2a096c9f02a1fc2459edcfe534787a7fc77d4b
+  concurrent-ruby (1.3.8) sha256=b2f1be836e968ccc78ccfce277ea79c72a88633f22306782c16ff23fb415d1e1
+  connection_pool (3.0.2) sha256=33fff5ba71a12d2aa26cb72b1db8bba2a1a01823559fb01d29eb74c286e62e0a
+  diff-lcs (1.6.2) sha256=9ae0d2cba7d4df3075fe8cd8602a8604993efc0dfa934cff568969efb1909962
+  drb (2.2.3) sha256=0b00d6fdb50995fe4a45dea13663493c841112e4068656854646f418fda13373
+  enumerate_it (4.2.1)
+  i18n (1.15.2) sha256=00f9eb62412fe593b2a65a97daa75300d37abb8f7202ec748e94b6d46a9dd1b5
+  io-console (0.9.4) sha256=a403304f32928ee85e56d457b4612ca43f2703b561a3258844992bd24085fbb1
+  json (3.0.2) sha256=8e6d7e7b11384c21230430cef90b71f14849a34a1f4452796670f7c981bd19df
+  language_server-protocol (3.17.0.6) sha256=5ef2c0c138f8267e1bc631d3328347d354f96724b0af22f2c79516120443b7f0
+  lint_roller (1.1.0) sha256=2c0c845b632a7d172cb849cc90c1bce937a28c5c8ccccb50dfd46a485003cc87
+  logger (1.7.0) sha256=196edec7cc44b66cfb40f9755ce11b392f21f7967696af15d274dde7edff0203
+  method_source (1.1.0) sha256=181301c9c45b731b4769bc81e8860e72f9161ad7d66dd99103c9ab84f560f5c5
+  mini_portile2 (2.8.9) sha256=0cd7c7f824e010c072e33f68bc02d85a00aeb6fce05bb4819c03dfd3c140c289
+  minitest (6.0.6) sha256=153ea36d1d987a62942382b61075745042a2b3123b1cd48f4c3675af9cc7d6f1
+  parallel (2.3.0) sha256=f75a3e904101ce6a1ccb6b8dc800cbafd42166d83330192438dcf29395167a6f
+  parser (3.3.12.0) sha256=21a6d7f755d5a24dfbdc6e6b772e4e879a52e7631a88bc5a3a134606052c9828
+  prism (1.9.0) sha256=7b530c6a9f92c24300014919c9dcbc055bf4cdf51ec30aed099b06cd6674ef85
+  pry (0.16.0) sha256=d76c69065698ed1f85e717bd33d7942c38a50868f6b0673c636192b3d1b6054e
+  racc (1.8.1) sha256=4a7f6929691dbec8b5209a0b373bc2614882b55fc5d2e447a21aaa691303d62f
+  rainbow (3.1.1) sha256=039491aa3a89f42efa1d6dec2fc4e62ede96eb6acd95e52f1ad581182b79bc6a
+  rake (13.4.2) sha256=cb825b2bd5f1f8e91ca37bddb4b9aaf345551b4731da62949be002fa89283701
+  regexp_parser (2.13.1) sha256=5aedb6b7c35688f51e86eef17a15374dfd287c83f4ca644b2c5f3ec50a33b44b
+  reline (0.7.0) sha256=5b012d8e55dbf9d450f12bde2cf7d15ff546ae80b3f8f3b30e570d431815583d
+  rspec (3.13.2) sha256=206284a08ad798e61f86d7ca3e376718d52c0bc944626b2349266f239f820587
+  rspec-core (3.13.6) sha256=a8823c6411667b60a8bca135364351dda34cd55e44ff94c4be4633b37d828b2d
+  rspec-expectations (3.13.5) sha256=33a4d3a1d95060aea4c94e9f237030a8f9eae5615e9bd85718fe3a09e4b58836
+  rspec-mocks (3.13.8) sha256=086ad3d3d17533f4237643de0b5c42f04b66348c28bf6b9c2d3f4a3b01af1d47
+  rspec-support (3.13.7) sha256=0640e5570872aafefd79867901deeeeb40b0c9875a36b983d85f54fb7381c47c
+  rubocop (1.92.0) sha256=2af68041fb2e70bd9321d0479b49fad07f8008a3d0758c83347b4917128c56e0
+  rubocop-ast (1.50.0) sha256=b9ca88300da0803ee222ad20cdb30494c0a784eed06fdc35d254b06d662788db
+  rubocop-rake (0.7.1) sha256=3797f2b6810c3e9df7376c26d5f44f3475eda59eb1adc38e6f62ecf027cbae4d
+  rubocop-rspec (3.10.2) sha256=0b3e2ecc592cd10ecbf0095bb58d1e357905276e069643523cc19eb7495f65e2
+  ruby-progressbar (1.13.0) sha256=80fc9c47a9b640d6834e0dc7b3c94c9df37f08cb072b7761e4a71e22cff29b33
+  securerandom (0.4.1) sha256=cc5193d414a4341b6e225f0cb4446aceca8e50d5e1888743fac16987638ea0b1
+  sqlite3 (2.9.6) sha256=956fe606956420d04ac7157d3ace620c8caba2135b2e05c76e483493da24d08e
+  thor (1.5.0) sha256=e3a9e55fe857e44859ce104a84675ab6e8cd59c650a49106a05f55f136425e73
+  timeout (0.6.1) sha256=78f57368a7e7bbadec56971f78a3f5ecbcfb59b7fcbb0a3ed6ddc08a5094accb
+  tzinfo (2.0.6) sha256=8daf828cc77bcf7d63b0e3bdb6caa47e2272dcfaf4fbfe46f8c3a9df087a829b
+  unicode-display_width (3.3.0) sha256=4b7aa66a4b11db50f6f7e98411215cd0dd10eaecb665d36eec5bcacb3fa0b613
+  unicode-emoji (4.3.0) sha256=11c02fa73290378c066bb0562cd4c87d8e1b706fbbe0059ca12746a4244de8ce
+  uri (1.1.2) sha256=89292e98eabbef6248b0a0ed5e7e398e152f83f17560023a6d94a7f492b169fb
 
 BUNDLED WITH
-   2.6.6
+  4.0.22

data/README.md

@@ -17,6 +17,32 @@ This means you can add it to any **Ruby** project! Secondly, you can
 [define your enumerations in classes](#creating-enumerations), allowing you to
 **add behavior** and **reuse** them! 😀
 
+At a glance:
+
+```ruby
+class RelationshipStatus < EnumerateIt::Base
+  associate_values :single, :married, :divorced
+
+  custom_helpers do
+    def ever_married?(value)
+      [MARRIED, DIVORCED].include?(value)
+    end
+  end
+end
+
+class Person < ApplicationRecord
+  has_enumeration_for :relationship_status, create_helpers: true, create_scopes: true
+end
+
+person = Person.new(relationship_status: RelationshipStatus::MARRIED)
+
+person.married? #=> true
+person.ever_married? #=> true
+person.relationship_status_humanize #=> 'Married'
+Person.married.to_sql #=> SELECT "people".* FROM "people" WHERE "people"."relationship_status" = "married"
+RelationshipStatus.to_a #=> [['Divorced', 'divorced'], ['Married', 'married'], ['Single', 'single']]
+```
+
 ---
 
 <!-- Tocer[start]: Auto-generated, don't remove. -->
@@ -206,10 +232,13 @@ class Person
 end
 ```
 
-> **Note:** If the enumeration class name differs from the attribute name, use
-> the `with` option:
+<!-- prettier-ignore -->
+> [!NOTE]
+> If the enumeration class name differs from the attribute name, use the `with` option:
 >
-> `has_enumeration_for :relationship_status, with: RelationshipStatus`
+> ```ruby
+> has_enumeration_for :relationship_status, with: RelationshipStatus
+> ```
 
 This will create:
 
@@ -229,7 +258,7 @@ This will create:
   p = Person.new
   p.relationship_status = RelationshipStatus::DIVORCED
   p.relationship_status_humanize
-  #=> 'Divorciado'
+  #=> 'Divorciado' # with a pt-BR locale loaded
   ```
 
 - The associated enumerations, which can be retrieved with the `enumerations`
@@ -335,6 +364,63 @@ This will create:
   #=> true
   ```
 
+  <!-- prettier-ignore -->
+  > [!IMPORTANT]
+  > On ActiveRecord objects, mutator methods like `married!` call `save!`
+  > immediately, running callbacks and raising on validation failure. They are
+  > not pure setters.
+
+  You can also define custom helper methods on the enumeration class using
+  a `custom_helpers` block:
+
+  ```ruby
+  class RelationshipStatus < EnumerateIt::Base
+    associate_values :single, :married, :divorced
+
+    custom_helpers do
+      def ever_married?(value)
+        [MARRIED, DIVORCED].include?(value)
+      end
+    end
+  end
+  ```
+
+  These become class methods on the enumeration:
+
+  ```ruby
+  RelationshipStatus.ever_married?(RelationshipStatus::MARRIED)  #=> true
+  RelationshipStatus.ever_married?(RelationshipStatus::DIVORCED) #=> true
+  RelationshipStatus.ever_married?(RelationshipStatus::SINGLE)   #=> false
+  ```
+
+  When `create_helpers: true` is used, they also become instance methods on the
+  model:
+
+  ```ruby
+  class Person < ApplicationRecord
+    has_enumeration_for :relationship_status, with: RelationshipStatus, create_helpers: true
+  end
+
+  person = Person.new(relationship_status: RelationshipStatus::DIVORCED)
+  person.ever_married? #=> true
+  ```
+
+  The `prefix` option also applies to custom helpers:
+
+  ```ruby
+  class Person < ApplicationRecord
+    has_enumeration_for :relationship_status,
+      with: RelationshipStatus, create_helpers: { prefix: true }
+  end
+
+  person = Person.new(relationship_status: RelationshipStatus::DIVORCED)
+  person.relationship_status_ever_married? #=> true
+  ```
+
+  Custom helper methods return `nil` when the attribute is `nil`. If a method
+  name collides with an already-defined class method on the enumeration, an
+  `ArgumentError` is raised at load time.
+
 - A scope method for each enumeration option if you pass the `create_scopes`
   option as `true`:
 
@@ -344,7 +430,7 @@ This will create:
   end
 
   Person.married.to_sql
-  #=> SELECT "users".* FROM "users" WHERE "users"."relationship_status" = "married"
+  #=> SELECT "people".* FROM "people" WHERE "people"."relationship_status" = "married"
   ```
 
   The `:create_scopes` also accepts `prefix` option.
@@ -401,6 +487,12 @@ This will create:
   #=> true
   ```
 
+  <!-- prettier-ignore -->
+  > [!NOTE]
+  > `skip_validation: true` disables all validations added by EnumerateIt,
+  > including the presence validation from `required: true`. If both are
+  > passed, `skip_validation` wins and `required` is silently ignored.
+
 Remember that you can add validations to any kind of class and not only
 `ActiveRecord` ones.
 
@@ -431,7 +523,7 @@ Yes,
 
 ## I18n
 
-I18n lookup is provided for both `_humanized` and `Enumeration#to_a` methods,
+I18n lookup is provided for both `_humanize` and `Enumeration#to_a` methods,
 given the hash key is a Symbol. The I18n strings are located on
 `enumerations.<enumeration_name>.<key>`:
 
@@ -453,11 +545,11 @@ end
 
 p = Person.new
 p.relationship_status = RelationshipStatus::MARRIED
-p.relationship_status_humanize # Existent key
+p.relationship_status_humanize # Key found in the locale file
 #=> 'Casado'
 
 p.relationship_status = RelationshipStatus::SINGLE
-p.relationship_status_humanize # Non-existent key
+p.relationship_status_humanize # Key missing, falls back to the humanized name
 #=> 'Single'
 ```
 
@@ -550,12 +642,12 @@ you can see them on the [releases page](../../releases).
 - Add tests for it. This is important so we don't break it in a future version
   unintentionally.
 - [Optional] Run the tests against a specific Gemfile:
-  `bundle exec appraisal rails_8.0 rake spec`.
+  `bundle exec appraisal rails_8.1 rake spec`.
 - Run the tests against all supported versions: `bundle exec rake`
 - Commit, but please do not mess with `Rakefile`, version, or history.
 - Send a Pull Request. Bonus points for topic branches.
 
 ## Copyright
 
-Copyright (c) 2010-2025 Cássio Marques and Lucas Caton. See `LICENSE` file for
+Copyright (c) 2010-2026 Cássio Marques and Lucas Caton. See `LICENSE` file for
 details.

data/enumerate_it.gemspec

@@ -31,5 +31,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rubocop'
   gem.add_development_dependency 'rubocop-rake'
   gem.add_development_dependency 'rubocop-rspec'
-  gem.add_development_dependency 'sqlite3', '< 2'
+  gem.add_development_dependency 'sqlite3'
 end

data/gemfiles/rails_6.0.gemfile

@@ -6,6 +6,7 @@ gem 'activerecord', '~> 6.0.6.1'
 gem 'activesupport', '~> 6.0.6.1'
 gem 'base64'
 gem 'bigdecimal'
+gem 'json', '< 3'
 gem 'mutex_m'
 gem 'sqlite3', '< 2'
 

data/gemfiles/rails_6.1.gemfile

@@ -6,6 +6,7 @@ gem 'activerecord', '~> 6.1.7.10'
 gem 'activesupport', '~> 6.1.7.10'
 gem 'base64'
 gem 'bigdecimal'
+gem 'json', '< 3'
 gem 'mutex_m'
 gem 'sqlite3', '< 2'
 

data/gemfiles/rails_7.0.gemfile

@@ -2,10 +2,11 @@
 
 source 'https://rubygems.org'
 
-gem 'activerecord', '~> 7.0.8.7'
-gem 'activesupport', '~> 7.0.8.7'
+gem 'activerecord', '~> 7.0.10'
+gem 'activesupport', '~> 7.0.10'
 gem 'base64'
 gem 'bigdecimal'
+gem 'json', '< 3'
 gem 'mutex_m'
 gem 'sqlite3', '< 2'
 

data/gemfiles/rails_7.1.gemfile

@@ -2,8 +2,9 @@
 
 source 'https://rubygems.org'
 
-gem 'activerecord', '~> 7.1.5.1'
-gem 'activesupport', '~> 7.1.5.1'
+gem 'activerecord', '~> 7.1.6'
+gem 'activesupport', '~> 7.1.6'
+gem 'json', '< 3'
 gem 'sqlite3'
 
 gemspec path: '../'

data/gemfiles/rails_7.2.gemfile

@@ -2,8 +2,9 @@
 
 source 'https://rubygems.org'
 
-gem 'activerecord', '~> 7.2.2.1'
-gem 'activesupport', '~> 7.2.2.1'
+gem 'activerecord', '~> 7.2.4'
+gem 'activesupport', '~> 7.2.4'
+gem 'json', '< 3'
 gem 'sqlite3'
 
 gemspec path: '../'

data/gemfiles/rails_8.0.gemfile

@@ -2,8 +2,9 @@
 
 source 'https://rubygems.org'
 
-gem 'activerecord', '~> 8.0.2'
-gem 'activesupport', '~> 8.0.2'
+gem 'activerecord', '~> 8.0.5.1'
+gem 'activesupport', '~> 8.0.5.1'
+gem 'json', '< 3'
 gem 'sqlite3'
 
 gemspec path: '../'

data/gemfiles/rails_8.1.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 8.1.4'
+gem 'activesupport', '~> 8.1.4'
+gem 'sqlite3'
+
+gemspec path: '../'

data/lib/enumerate_it/base.rb

@@ -28,7 +28,7 @@ module EnumerateIt
       end
 
       def to_h
-        sorted_map.transform_values(&:first)
+        sorted_map.to_h.transform_values(&:first)
       end
 
       def enumeration
@@ -51,8 +51,8 @@ module EnumerateIt
         list.map { |value| t(value) }
       end
 
-      def each_value(&)
-        list.each(&)
+      def each_value(&block)
+        list.each(&block)
       end
 
       def to_json(options = nil)
@@ -95,6 +95,25 @@ module EnumerateIt
         I18n.t("enumerations.#{name.underscore}.#{value.to_s.underscore}", default: default)
       end
 
+      def custom_helpers(&block)
+        @custom_helper_methods ||= []
+
+        mod = Module.new(&block)
+        methods = mod.instance_methods(false)
+        collisions = methods & singleton_class.instance_methods
+
+        raise ArgumentError, <<~MESSAGE.chomp if collisions.any?
+          Custom helper(s) '#{collisions.join(', ')}' would override existing EnumerateIt::Base methods
+        MESSAGE
+
+        @custom_helper_methods.concat(methods)
+        extend mod
+      end
+
+      def custom_helper_methods
+        @custom_helper_methods || []
+      end
+
       private
 
       def sorted_map
@@ -134,9 +153,7 @@ module EnumerateIt
       def values_hash(args)
         return args.first if args.first.is_a?(Hash)
 
-        args.each_with_object({}) do |value, hash|
-          hash[value] = value.to_s
-        end
+        args.to_h { |value| [value, value.to_s] }
       end
     end
   end

data/lib/enumerate_it/class_methods.rb

@@ -1,5 +1,5 @@
 module EnumerateIt
-  module ClassMethods
+  module ClassMethods # rubocop:disable Metrics/ModuleLength
     def has_enumeration_for(attribute, options = {})
       self.enumerations = enumerations.dup
 
@@ -17,7 +17,8 @@ module EnumerateIt
       set_validations(attribute, options) unless options[:skip_validation]
 
       if options[:create_helpers]
-        %w[create_helper_methods create_mutator_methods create_polymorphic_methods].each do |method|
+        %w[create_helper_methods create_mutator_methods create_polymorphic_methods
+           create_custom_helper_methods].each do |method|
           send(method, options[:with], attribute, options[:create_helpers])
         end
       end
@@ -100,12 +101,27 @@ module EnumerateIt
       end
     end
 
+    def create_custom_helper_methods(klass, attribute_name, helpers)
+      return unless klass.custom_helper_methods.any?
+
+      prefix_name = "#{attribute_name}_" if helpers.is_a?(Hash) && helpers[:prefix]
+
+      class_eval do
+        klass.custom_helper_methods.each do |method_name|
+          define_method "#{prefix_name}#{method_name}" do
+            value = send(attribute_name)
+            klass.public_send(method_name, value) unless value.nil?
+          end
+        end
+      end
+    end
+
     def define_enumeration_class(attribute, options)
       return if options[:with]
 
       inner_enum_class_name = attribute.to_s.camelize.to_sym
 
-      options[:with] = if constants.include?(inner_enum_class_name)
+      options[:with] = if const_defined?(inner_enum_class_name)
         const_get(inner_enum_class_name)
       else
         attribute.to_s.camelize.constantize

data/lib/enumerate_it/version.rb

@@ -1,3 +1,3 @@
 module EnumerateIt
-  VERSION = '4.1.0'.freeze
+  VERSION = '4.2.1'.freeze
 end

data/spec/enumerate_it/base_spec.rb

@@ -135,6 +135,15 @@ describe EnumerateIt::Base do
     it 'returns a hash' do
       expect(TestEnumerationWithoutArray.to_h).to eq(value_one: '1', value_two: '2')
     end
+
+    context 'specifying a sort mode' do
+      subject(:enumeration) { create_enumeration_class_with_sort_mode(:name) }
+
+      it 'returns a hash sorted by the given mode' do
+        expect(enumeration.to_h).to eq(bar: '2', bra: '4', foo: '1', omg: '3', zomg: '0')
+        expect(enumeration.to_h.keys).to eq(%i[bar bra foo omg zomg])
+      end
+    end
   end
 
   describe '.to_json' do
@@ -228,6 +237,55 @@ describe EnumerateIt::Base do
     end
   end
 
+  describe '.custom_helpers' do
+    context 'when methods are defined inside the block' do
+      it 'become class methods on the enum' do
+        expect(TestEnumerationWithCustomHelpers.lookup('1')).to eq(:one)
+        expect(TestEnumerationWithCustomHelpers.lookup('2')).to eq(:two)
+        expect(TestEnumerationWithCustomHelpers.boolean?('1')).to be(true)
+        expect(TestEnumerationWithCustomHelpers.boolean?('2')).to be(false)
+      end
+    end
+
+    context 'when a custom helper name collides with a built-in method' do
+      let(:build_colliding_enum) do
+        proc do
+          Class.new(EnumerateIt::Base) do
+            associate_values :collision
+
+            custom_helpers do
+              def list
+                '...'
+              end
+            end
+          end
+        end
+      end
+
+      it 'raises an ArgumentError' do
+        expect(&build_colliding_enum).to raise_error(
+          ArgumentError,
+          "Custom helper(s) 'list' would override existing EnumerateIt::Base methods"
+        )
+      end
+    end
+  end
+
+  describe '.custom_helper_methods' do
+    context 'when methods are defined inside custom_helpers block' do
+      it 'returns the registered names' do
+        expect(TestEnumerationWithCustomHelpers.custom_helper_methods)
+          .to match_array(%i[lookup boolean?])
+      end
+    end
+
+    context 'when there is no .custom_helpers block on an enum' do
+      it 'returns an empty array' do
+        expect(TestEnumeration.custom_helper_methods).to eq([])
+      end
+    end
+  end
+
   context 'associate values with a list' do
     it 'creates constants for each enumeration value' do
       expect(TestEnumerationWithList::FIRST).to  eq('first')
@@ -289,11 +347,11 @@ describe EnumerateIt::Base do
         attr_accessor :bla
 
         class << self
-          def validates_inclusion_of(_attribute, _options)
+          def validates_inclusion_of(_attribute, _options) # rubocop:disable Naming/PredicateMethod
             true
           end
 
-          def validates_presence_of
+          def validates_presence_of # rubocop:disable Naming/PredicateMethod
             true
           end
         end

data/spec/enumerate_it_spec.rb

@@ -4,6 +4,7 @@ describe EnumerateIt do
   let :test_class do
     Class.new do
       extend EnumerateIt
+
       attr_accessor :foobar
 
       has_enumeration_for :foobar, with: TestEnumeration
@@ -41,6 +42,15 @@ describe EnumerateIt do
       expect(target).not_to respond_to(:value_1?)
     end
 
+    it 'defaults to not creating custom helper methods' do
+      klass = Class.new do
+        extend EnumerateIt
+
+        has_enumeration_for :foobar, with: TestEnumerationWithCustomHelpers
+      end
+      expect(klass.new).not_to respond_to(:lookup)
+    end
+
     it 'stores the enumeration class in a class-level hash' do
       expect(test_class.enumerations[:foobar]).to eq(TestEnumeration)
     end
@@ -71,6 +81,7 @@ describe EnumerateIt do
       let :test_class_for_enumeration_without_array do
         Class.new do
           extend EnumerateIt
+
           attr_accessor :foobar
 
           has_enumeration_for :foobar, with: TestEnumerationWithoutArray
@@ -102,6 +113,7 @@ describe EnumerateIt do
       let :foo_bar_class do
         Class.new do
           extend EnumerateIt
+
           attr_accessor :test_enumeration
 
           has_enumeration_for :test_enumeration
@@ -121,15 +133,13 @@ describe EnumerateIt do
       context 'when using a nested class as the enumeration' do
         let :class_with_nested_enum do
           Class.new do
-            # rubocop:disable Lint/ConstantDefinitionInBlock
-            # rubocop:disable RSpec/LeakyConstantDeclaration
+            # rubocop:disable-next Lint/ConstantDefinitionInBlock, RSpec/LeakyConstantDeclaration
             class NestedEnum < EnumerateIt::Base
-              associate_values foo: %w[1 Blerrgh], bar: ['2' => 'Blarghhh']
+              associate_values foo: %w[1 Blerrgh], bar: [{ '2' => 'Blarghhh' }]
             end
-            # rubocop:enable RSpec/LeakyConstantDeclaration
-            # rubocop:enable Lint/ConstantDefinitionInBlock
 
             extend EnumerateIt
+
             attr_accessor :nested_enum
 
             has_enumeration_for :nested_enum
@@ -151,6 +161,7 @@ describe EnumerateIt do
     let :test_class_with_helper do
       Class.new do
         extend EnumerateIt
+
         attr_accessor :foobar
 
         has_enumeration_for :foobar, with: TestEnumeration, create_helpers: true
@@ -192,6 +203,7 @@ describe EnumerateIt do
       let :test_class_with_prefixed_helper do
         Class.new do
           extend EnumerateIt
+
           attr_accessor :foobar
 
           has_enumeration_for :foobar, with: TestEnumeration, create_helpers: { prefix: true }
@@ -234,6 +246,7 @@ describe EnumerateIt do
       let :polymorphic_class do
         Class.new do
           extend EnumerateIt
+
           attr_accessor :foo
 
           has_enumeration_for :foo, with: PolymorphicEnum, create_helpers: { polymorphic: true }
@@ -260,6 +273,7 @@ describe EnumerateIt do
         let :polymorphic_class_with_suffix do
           Class.new do
             extend EnumerateIt
+
             attr_accessor :foo
 
             has_enumeration_for :foo, with: PolymorphicEnum,
@@ -280,6 +294,62 @@ describe EnumerateIt do
         end
       end
     end
+
+    context 'with custom_helpers defined on the enumeration' do
+      context 'creates methods that delegates to the enum' do
+        let :test_class_with_custom_helpers do
+          Class.new do
+            extend EnumerateIt
+
+            attr_accessor :foobar
+
+            has_enumeration_for :foobar, with: TestEnumerationWithCustomHelpers,
+              create_helpers: true
+
+            def initialize(foobar)
+              @foobar = foobar
+            end
+          end
+        end
+
+        it 'returns value respective to attribute value' do
+          target = test_class_with_custom_helpers.new(TestEnumerationWithCustomHelpers::VALUE_ONE)
+          expect(target.lookup).to eq(:one)
+          expect(target.boolean?).to be(true)
+        end
+
+        it 'returns nil when attribute is nil' do
+          target = test_class_with_custom_helpers.new(nil)
+          expect(target.lookup).to be_nil
+          expect(target.boolean?).to be_nil
+        end
+      end
+
+      context 'create methods with prefix that delegates to the enum' do
+        let :test_class_with_prefixed_custom_helpers do
+          Class.new do
+            extend EnumerateIt
+
+            attr_accessor :foobar
+
+            has_enumeration_for :foobar, with: TestEnumerationWithCustomHelpers,
+              create_helpers: { prefix: true }
+
+            def initialize(foobar)
+              @foobar = foobar
+            end
+          end
+        end
+
+        it 'method is prefixed with the attribute name' do
+          target = test_class_with_prefixed_custom_helpers.new(TestEnumerationWithCustomHelpers::VALUE_ONE)
+          expect(target.foobar_lookup).to eq(:one)
+          expect(target.foobar_boolean?).to be(true)
+          expect(target).not_to respond_to(:lookup)
+          expect(target).not_to respond_to(:boolean?)
+        end
+      end
+    end
   end
 
   describe 'using the :create_scopes option' do

data/spec/support/test_classes.rb

@@ -78,3 +78,17 @@ def create_enumeration_class_with_sort_mode(sort_mode)
     )
   end
 end
+
+class TestEnumerationWithCustomHelpers < EnumerateIt::Base
+  associate_values value_one: '1', value_two: '2'
+
+  custom_helpers do
+    def lookup(value)
+      { '1' => :one, '2' => :two }[value]
+    end
+
+    def boolean?(value)
+      value == '1'
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: enumerate_it
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.2.1
 platform: ruby
 authors:
 - Cássio Marques
@@ -154,16 +154,16 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '0'
 description: Enumerations for Ruby with some magic powers!
 executables: []
 extensions: []
@@ -172,6 +172,7 @@ files:
 - ".github/dependabot.yml"
 - ".github/workflows/ci.yml"
 - ".gitignore"
+- ".prettierrc.json"
 - ".rspec"
 - ".rubocop.yml"
 - Appraisals
@@ -188,6 +189,7 @@ files:
 - gemfiles/rails_7.1.gemfile
 - gemfiles/rails_7.2.gemfile
 - gemfiles/rails_8.0.gemfile
+- gemfiles/rails_8.1.gemfile
 - lib/enumerate_it.rb
 - lib/enumerate_it/base.rb
 - lib/enumerate_it/class_methods.rb
@@ -223,7 +225,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.8
+rubygems_version: 4.0.17
 specification_version: 4
 summary: Ruby Enumerations
 test_files: []