identifiable 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f13f950aecd88db7423e77dda8c4bb98b9ec3513fc1b6e2e636fa18abc9f5459
-  data.tar.gz: 54e93ff16ebc2fb3a8f2d6668777da9c5e62595aea7c2913b3ba20a9b8f36d47
+  metadata.gz: e229c2c8c0e8206c88cdbd14e66472bb7e16a65ab0d0db94e4e312622224fca1
+  data.tar.gz: 6898197f22c73a31ea84585076b2638427dbc184b5a60ae8e3ba7cc5d9309782
 SHA512:
-  metadata.gz: db32c493be43afad1d670af0c3474bb2e50eca36b66c3e215ae84645295e9da41d12ad8b438408d406c12fe17509e2ed56f3335cb265c674379a2bd71f6f4ec2
-  data.tar.gz: 0fc43e2b34c4659bc910367da1eb87f41caba8d28c6a1e9ccd93783402b00fe459717685f9cf2ee9f3ac51f31f60e07a536e2996609b01f85fe508dcd3ca12df
+  metadata.gz: 462f3c632763996b78500c622433e2e058914ee0136b9c6a4478085f09270ae9f604dea0e6c1f31f9a11fda4366f018ba1d755617c9a12431f5ff9757f6fab47
+  data.tar.gz: 715519049734d87cce4399ab2e5c510e88b4bbe4626b53986a4e21ed9d68e6cbfa3e110c6829c71b369765e5e3efd3b648c747f49207818b04cfaa19db5a92ad

data/.github/workflows/ci.yml

@@ -5,14 +5,14 @@ jobs:
     name: 'Test Suite'
     strategy:
       matrix:
-        ruby: [2.7.6, 3.0.4, 3.1.2]
+        ruby: [3.2.8, 3.3.8, 3.4.4]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-      - uses: actions/cache@v1
+      - uses: actions/cache@v4
         with:
           path: vendor/bundle
           key: bundle-${{ matrix.ruby }}-${{ hashFiles('**/*.gemspec') }}
@@ -26,11 +26,11 @@ jobs:
       - uses: actions/checkout@v2
       - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.7.0
-      - uses: actions/cache@v1
+          ruby-version: 3.2.8
+      - uses: actions/cache@v4
         with:
           path: vendor/bundle
-          key: bundle-2.7.0-${{ hashFiles('**/*.gemspec') }}
-          restore-keys: bundle-2.7.0
+          key: bundle-3.2.8-${{ hashFiles('**/*.gemspec') }}
+          restore-keys: bundle-3.2.8
       - run: bundle install --jobs 4 --retry 3 --path vendor/bundle
       - run: bundle exec rubocop

data/.rubocop.yml

@@ -1,12 +1,20 @@
 AllCops:
   NewCops: enable
+  SuggestExtensions: false
 
 Gemspec/RequiredRubyVersion:
   Enabled: false
 
+Gemspec/DevelopmentDependencies:
+  Enabled: false
+
 Style/Documentation:
   Enabled: false
 
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
 Layout/LineLength:
   Enabled: false
 

data/.tool-versions

@@ -1 +1 @@
-ruby 2.7.0
+ruby 3.2.0

data/CHANGELOG.md

@@ -0,0 +1,39 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## Unreleased
+
+*Nothing yet*
+
+## 1.0.0 - Released June 22, 2025
+
+### Added
+- **Configuration system**: Use `Identifiable.configure` to set the `overwrite_to_key` and `overwrite_to_param` options that control whether Identifiable overrides Rails' `to_key` and `to_param` model methods. Both options default to `true` to maintain backward compatibility.
+- Support for Ruby version 3.2, 3.3, and 3.4.
+
+### Changed
+- This is now considered a stable 1.0 release.
+
+### Removed
+- Support for Ruby 2.7, 3.0, and 3.1. The new minimum supported Ruby version is 3.2.
+- Support for Rails versions below 7.0. The new minimum supported Rails version is 7.0.
+
+### Fixed
+- Configuration options resolve compatibility issues with other gems like Devise (#7).
+
+## 0.2.0 - Released October 16, 2022
+
+### Added
+- Support for Ruby versions 3.0 and 3.1.
+- Models that include identifiable will now use Identifiable's public ID for the `#to_key` and `#to_param` methods, meaning that you can now use Rails helpers like `dom_id(@order)` and `order_path(@order)`, and they'll use public IDs instead of the database primary key.
+
+### Removed
+- Support for Ruby 2.5 and 2.6. The new minimum supported Ruby version is 2.7.
+
+### Fixed
+- A migration will no longer fail if the model has identifiable but the table doesn't exist yet.
+
+## 0.1.0 - Released November 15, 2020
+
+This is the early, initial release of Identifiable.

data/Gemfile

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec

data/Gemfile.lock

@@ -1,67 +1,99 @@
 PATH
   remote: .
   specs:
-    identifiable (0.2.0)
-      activerecord (> 5.2)
+    identifiable (1.0.0)
+      activerecord (> 7)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (7.0.3.1)
-      activesupport (= 7.0.3.1)
-    activerecord (7.0.3.1)
-      activemodel (= 7.0.3.1)
-      activesupport (= 7.0.3.1)
-    activesupport (7.0.3.1)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+    activemodel (8.0.2)
+      activesupport (= 8.0.2)
+    activerecord (8.0.2)
+      activemodel (= 8.0.2)
+      activesupport (= 8.0.2)
+      timeout (>= 0.4.0)
+    activesupport (8.0.2)
+      base64
+      benchmark (>= 0.3)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
       minitest (>= 5.1)
-      tzinfo (~> 2.0)
-    ast (2.4.2)
-    concurrent-ruby (1.1.10)
-    diff-lcs (1.5.0)
-    i18n (1.11.0)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
+    ast (2.4.3)
+    base64 (0.3.0)
+    benchmark (0.4.1)
+    bigdecimal (3.2.2)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.3)
+    diff-lcs (1.6.2)
+    drb (2.2.3)
+    i18n (1.14.7)
       concurrent-ruby (~> 1.0)
-    minitest (5.16.2)
-    parallel (1.22.1)
-    parser (3.1.2.0)
+    json (2.12.2)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    logger (1.7.0)
+    mini_portile2 (2.8.9)
+    minitest (5.25.5)
+    parallel (1.27.0)
+    parser (3.3.8.0)
       ast (~> 2.4.1)
+      racc
+    prism (1.4.0)
+    racc (1.8.1)
     rainbow (3.1.1)
     rake (12.3.3)
-    regexp_parser (2.3.0)
-    rexml (3.2.5)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
+    regexp_parser (2.10.0)
+    rspec (3.13.1)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.4)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.1)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    rubocop (1.28.1)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.4)
+    rubocop (1.77.0)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.17.0, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.45.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.17.0)
-      parser (>= 3.1.1.0)
-    ruby-progressbar (1.11.0)
-    sqlite3 (1.4.2)
-    tzinfo (2.0.4)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.45.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    ruby-progressbar (1.13.0)
+    securerandom (0.4.1)
+    sqlite3 (2.7.0)
+      mini_portile2 (~> 2.8.0)
+    sqlite3 (2.7.0-arm64-darwin)
+    timeout (0.4.3)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.1.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+    uri (1.0.3)
 
 PLATFORMS
-  ruby
+  arm64-darwin-25
+  x84_64-linux
 
 DEPENDENCIES
   identifiable!
@@ -71,4 +103,4 @@ DEPENDENCIES
   sqlite3
 
 BUNDLED WITH
-   2.1.2
+   2.4.1

data/README.md

@@ -112,6 +112,36 @@ end
 
 The `length` parameter is ignored if you're using `style: :uuid`, because UUIDs already have a fixed length. The `length` parameter also needs be an Integer, and can't be less than `4` or greater than `128`. If any of these constraints are broken, Identifiable will raise an error letting you know.
 
+## Configuration
+
+By default, Identifiable overrides Rails' `to_key` and `to_param` methods so that your URLs and DOM IDs will use your public IDs instead of your database IDs.
+
+This can break other gems that rely on the default behavior of Rails' `to_key` and `to_param` methods, like devise! You can configure Identifiable to not override these methods if you'd like:
+
+```ruby
+# In config/initializers/identifiable.rb
+Identifiable.configure do |config|
+  config.overwrite_to_key = false
+  config.overwrite_to_param = false
+end
+```
+
+The `overwrite_to_key` option controls whether Rails helpers like `dom_id` use your public ID or your database ID. The default value is `true`.
+
+The `overwrite_to_param` option controls whether URL helpers use your public ID or your database ID in routes. The default value is `true`.
+
+If you disable both options, your application will behave like this:
+
+```ruby
+@order = Order.last
+@order.id # => 14
+@order.public_id # => "87133275"
+orders_url(@order) # => https://example.app/orders/14
+
+# But you can still create URLs using the public ID
+orders_url(@order.public_id) # => https://example.app/orders/87133275
+```
+
 ## Alternatives
 
 I built Identifiable because I never could quite get the other gems that do similar things quite the way that I liked them. You might have the same experience with Identifiable, so if you try Identifiable and find that it's not quite to your tastes, try out some of these alternatives:

data/Rakefile

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 

data/bin/console

@@ -1,8 +1,8 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'bundler/setup'
-require 'identifiable'
+require "bundler/setup"
+require "identifiable"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -11,5 +11,5 @@ require 'identifiable'
 # require "pry"
 # Pry.start
 
-require 'irb'
+require "irb"
 IRB.start(__FILE__)

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+                                           Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/rubocop

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")

data/identifiable.gemspec

@@ -1,31 +1,31 @@
 # frozen_string_literal: true
 
-require_relative 'lib/identifiable/version'
+require_relative "lib/identifiable/version"
 
 Gem::Specification.new do |spec|
   spec.version       = Identifiable::VERSION
-  spec.name          = 'identifiable'
-  spec.authors       = ['Tom Pritchard']
-  spec.email         = ['tom@tpritc.com']
+  spec.name          = "identifiable"
+  spec.authors       = ["Tom Pritchard"]
+  spec.email         = ["tom@tpritc.com"]
 
-  spec.summary       = 'A quick and easy way to add random, customizable, public-facing IDs to your models.'
-  spec.homepage      = 'https://github.com/tpritc/identifiable'
-  spec.license       = 'MIT'
-  spec.required_ruby_version = '>= 2.7.0'
+  spec.summary       = "A quick and easy way to add random, customizable, public-facing IDs to your models."
+  spec.homepage      = "https://github.com/tpritc/identifiable"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 3.2.0"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = 'exe'
+  spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
+  spec.require_paths = ["lib"]
 
-  spec.add_dependency 'activerecord', '> 5.2'
-  spec.add_development_dependency 'rake', '~> 12.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 1.3'
-  spec.add_development_dependency 'sqlite3'
-  spec.metadata['rubygems_mfa_required'] = 'true'
+  spec.add_dependency "activerecord", "> 7"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 1.3"
+  spec.add_development_dependency "sqlite3"
+  spec.metadata["rubygems_mfa_required"] = "true"
 end

data/lib/identifiable/configuration.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Identifiable
+  class Configuration
+    attr_accessor :overwrite_to_key, :overwrite_to_param
+
+    def initialize
+      @overwrite_to_key = true
+      @overwrite_to_param = true
+    end
+  end
+end

data/lib/identifiable/errors.rb

@@ -4,7 +4,7 @@ module Identifiable
   module Errors
     class ColumnMustBeASymbolError < StandardError
       def initialize(column_value)
-        column_value_string = column_value.to_s || 'nil'
+        column_value_string = column_value.to_s
         column_value_class = column_value.class.to_s
         super("The identifiable's column must be a symbol. You passed in #{column_value_string}, which was a #{column_value_class}.")
       end
@@ -12,51 +12,51 @@ module Identifiable
 
     class ColumnCannotBeIdError < StandardError
       def initialize
-        super('The identifiable\'s column cannot be :id, since that\'s your primary key. You should create another index column in your table with a name like :public_id.')
+        super("The identifiable's column cannot be :id, since that's your primary key. You should create another index column in your table with a name like :public_id.")
       end
     end
 
     class ColumnMustExistInTheTableError < StandardError
       def initialize(column_value, valid_columns:)
-        column_value_string = column_value.to_s || 'nil'
+        column_value_string = column_value.to_s
         super("The identifiable's column must exist on the table for this model. You passed in #{column_value_string}, but the valid columns are: #{valid_columns}")
       end
     end
 
     class StyleMustBeAValidStyleError < StandardError
       def initialize(style_value)
-        style_value_string = style_value.to_s || 'nil'
-        super("The identifiable\'s style must be a valid stylist. You passed in #{style_value_string}, but the valid options are: #{Identifiable::Stylist::VALID_STYLES}")
+        style_value_string = style_value.to_s
+        super("The identifiable's style must be a valid stylist. You passed in #{style_value_string}, but the valid options are: #{Identifiable::Stylist::VALID_STYLES}")
       end
     end
 
     class LengthMustBeAnIntegerError < StandardError
       def initialize
-        super('The identifiable\'s length must be an Integer.')
+        super("The identifiable's length must be an Integer.")
       end
     end
 
     class LengthIsTooShortError < StandardError
       def initialize
-        super('The identifiable\'s length must be at least 4.')
+        super("The identifiable's length must be at least 4.")
       end
     end
 
     class LengthIsTooLongError < StandardError
       def initialize
-        super('The identifiable\'s length cannot be more than 128.')
+        super("The identifiable's length cannot be more than 128.")
       end
     end
 
     class LengthMustBeNilIfStyleIsUuidError < StandardError
       def initialize
-        super('The identifiable\'s length cannot be set if you\'re using the :uuid style, because UUIDs have a fixed length. You should remove the length parameter.')
+        super("The identifiable's length cannot be set if you're using the :uuid style, because UUIDs have a fixed length. You should remove the length parameter.")
       end
     end
 
     class RanOutOfAttemptsToSetPublicIdError < StandardError
       def initialize
-        super('We tried 100 times to find an unused public ID, but we could not find one. You should increase the length parameter of the public ID.')
+        super("We tried 100 times to find an unused public ID, but we could not find one. You should increase the length parameter of the public ID.")
       end
     end
   end

data/lib/identifiable/model.rb

@@ -125,6 +125,8 @@ module Identifiable
     # such as `dom_id` will use the public ID instead of the regular ID when
     # identifying the record.
     def to_key
+      return super unless Identifiable.configuration.overwrite_to_key
+
       [self[self.class.identifiable_column]]
     end
 
@@ -132,6 +134,8 @@ module Identifiable
     # such as the `link_to` helpers will default to using the public ID
     # instead of the regular ID when identifying the record.
     def to_param
+      return super unless Identifiable.configuration.overwrite_to_param
+
       self[self.class.identifiable_column]
     end
   end

data/lib/identifiable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Identifiable
-  VERSION = '0.2.0'
+  VERSION = "1.0.0"
 end

data/lib/identifiable.rb

@@ -3,15 +3,26 @@
 module Identifiable
   module Stylists
   end
+
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+  end
 end
 
-require 'active_record'
-require 'identifiable/stylist'
-require 'identifiable/stylists/alphanumeric'
-require 'identifiable/stylists/numeric'
-require 'identifiable/stylists/uuid'
-require 'identifiable/errors'
-require 'identifiable/model'
-require 'identifiable/version'
+require "active_record"
+require "identifiable/configuration"
+require "identifiable/stylist"
+require "identifiable/stylists/alphanumeric"
+require "identifiable/stylists/numeric"
+require "identifiable/stylists/uuid"
+require "identifiable/errors"
+require "identifiable/model"
+require "identifiable/version"
 
 ActiveRecord::Base.include Identifiable::Model

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: identifiable
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Tom Pritchard
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-16 00:00:00.000000000 Z
+date: 2025-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -92,6 +92,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".tool-versions"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -99,9 +100,12 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/rspec
+- bin/rubocop
 - bin/setup
 - identifiable.gemspec
 - lib/identifiable.rb
+- lib/identifiable/configuration.rb
 - lib/identifiable/errors.rb
 - lib/identifiable/model.rb
 - lib/identifiable/stylist.rb
@@ -122,14 +126,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: A quick and easy way to add random, customizable, public-facing IDs to your