identifiable 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 490257eea4bca942162766045db54e9cac0b3cdbedcea08a418e3b659cc209ec
-  data.tar.gz: e3cfa1004c351eac0170b1740e291b9f3a878c72a450b9cc7c787ae999b33d83
+  metadata.gz: f13f950aecd88db7423e77dda8c4bb98b9ec3513fc1b6e2e636fa18abc9f5459
+  data.tar.gz: 54e93ff16ebc2fb3a8f2d6668777da9c5e62595aea7c2913b3ba20a9b8f36d47
 SHA512:
-  metadata.gz: e54d72207095067e3b7fea091a5bb41665525d43c5ececa51c228f5ee824d1fc7f55c5c2ca5aac177504456508b60bef7a7d61a27757cc3a801be269cc2b4f0c
-  data.tar.gz: e685fb908d6122fc2e4ce52cb0957bfb50c813705a9acecfe64ddb5ec7fea09dbbddacb346ec70d83de2c4b73107189edc53b5ae0554d58cafc68eed24189da3
+  metadata.gz: db32c493be43afad1d670af0c3474bb2e50eca36b66c3e215ae84645295e9da41d12ad8b438408d406c12fe17509e2ed56f3335cb265c674379a2bd71f6f4ec2
+  data.tar.gz: 0fc43e2b34c4659bc910367da1eb87f41caba8d28c6a1e9ccd93783402b00fe459717685f9cf2ee9f3ac51f31f60e07a536e2996609b01f85fe508dcd3ca12df

data/.github/workflows/ci.yml

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

data/.rubocop.yml

@@ -1,6 +1,9 @@
 AllCops:
   NewCops: enable
 
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
 Style/Documentation:
   Enabled: false
 

data/.tool-versions

@@ -1 +1 @@
-ruby 2.7.1
+ruby 2.7.0

data/Gemfile.lock

@@ -1,67 +1,64 @@
 PATH
   remote: .
   specs:
-    identifiable (0.1.0)
-      activerecord (> 4.2)
+    identifiable (0.2.0)
+      activerecord (> 5.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.0.3.4)
-      activesupport (= 6.0.3.4)
-    activerecord (6.0.3.4)
-      activemodel (= 6.0.3.4)
-      activesupport (= 6.0.3.4)
-    activesupport (6.0.3.4)
+    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)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
-    ast (2.4.1)
-    concurrent-ruby (1.1.7)
-    diff-lcs (1.4.4)
-    i18n (1.8.5)
+      i18n (>= 1.6, < 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)
       concurrent-ruby (~> 1.0)
-    minitest (5.14.2)
-    parallel (1.20.0)
-    parser (2.7.2.0)
+    minitest (5.16.2)
+    parallel (1.22.1)
+    parser (3.1.2.0)
       ast (~> 2.4.1)
-    rainbow (3.0.0)
+    rainbow (3.1.1)
     rake (12.3.3)
-    regexp_parser (1.8.2)
-    rexml (3.2.4)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.0)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.0)
+    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)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.0)
-    rubocop (1.3.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.28.1)
       parallel (~> 1.10)
-      parser (>= 2.7.1.5)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8)
+      regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.1.1)
+      rubocop-ast (>= 1.17.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.1.1)
-      parser (>= 2.7.1.5)
-    ruby-progressbar (1.10.1)
+      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)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.7.0)
-    zeitwerk (2.4.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
 
 PLATFORMS
   ruby
@@ -74,4 +71,4 @@ DEPENDENCIES
   sqlite3
 
 BUNDLED WITH
-   2.1.4
+   2.1.2

data/README.md

@@ -13,10 +13,10 @@ Identifiable makes it really simple to generate and use random public-facing IDs
 
 ```ruby
 # Before:
-orders_url(id: @order.id) # → https://example.app/orders/14
+orders_url(@order) # → https://example.app/orders/14
 
 # After:
-orders_url(id: @order.public_id) # → https://example.app/orders/87133275
+orders_url(@order) # → https://example.app/orders/87133275
 ```
 
 ## Installation
@@ -72,7 +72,7 @@ While Identifiable strives to have useful defaults, you may want to customize yo
 
 ### Different public ID styles
 
-By default, Identifiable will generate numeric public IDs, with each character between 0 and 9, but it can also generate alphanumeric public IDs and UUID public ids. To chose your public ID style, simply pass it in as a parameter to `identifiable` on your model.
+By default, Identifiable will generate numeric public IDs, with each character between 0 and 9, but it can also generate alphanumeric public IDs and UUID public IDs. To choose your public ID style, simply pass it in as a parameter to `identifiable` on your model.
 
 ```ruby
 class Order < ApplicationRecord
@@ -112,14 +112,17 @@ 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.
 
+## 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:
+
+* [**Hashid Rails**](https://github.com/jcypret/hashid-rails) uses [hashids](http://hashids.org/ruby) to seamlessly create hex strings for your primary keys. It's nice because it doesn't require an extra column in your database, but it's limited in what it can do.
+* [**Public UID**](https://github.com/equivalent/public_uid) is a real power-users public ID gem, and until I made this it was the main way I would build public ID features into the apps I was working on, but I found it too heavy for what I wanted 90% of the time, which is why Identifiable is customizable, but not _too_ customizable. If you find Identifiable isn't customizable or powerful enough for your needs, give Public UID a go!
+
 ## Contributing
 
-Bug reports and pull requests are welcome on [GitHub](https://github.com/tpritc/identifiable). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/tpritc/identifiable/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on [GitHub](https://github.com/tpritc/identifiable). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/tpritc/identifiable/blob/main/CODE_OF_CONDUCT.md) while interacting in the project's codebases, issue trackers, chat rooms, and mailing lists.
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). If you or your organization need a custom, commercial license for any reason, [send me an email](mailto:hi@tpritc.com) and I'll be happy to set something up for you.
-
-## Code of Conduct
-
-Everyone interacting in the Identifiable project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/tpritc/identifiable/blob/main/CODE_OF_CONDUCT.md).

data/identifiable.gemspec

@@ -6,12 +6,12 @@ Gem::Specification.new do |spec|
   spec.version       = Identifiable::VERSION
   spec.name          = 'identifiable'
   spec.authors       = ['Tom Pritchard']
-  spec.email         = ['hi@tpritc.com']
+  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.5.0'
+  spec.required_ruby_version = '>= 2.7.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.
@@ -22,9 +22,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'activerecord', '> 4.2'
+  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'
 end

data/lib/identifiable/model.rb

@@ -25,7 +25,7 @@ module Identifiable
       end
 
       def find_by_public_id(public_id)
-        where(Hash[identifiable_column, public_id]).first
+        where({ identifiable_column => public_id }).first
       end
 
       def find_by_public_id!(public_id)
@@ -54,11 +54,17 @@ module Identifiable
       # The column parameter must be in the model's table, so check that the
       # column corresponds to a column in the model's table, and raise an error
       # if it is not.
+      #
+      # We suppress ActiveRecord::StatmentInvalid errors just in case the table
+      # does not exist yet.
+      # rubocop:disable Lint/SuppressedException
       def _identifiable_validate_column_must_be_in_the_table
         return if column_names.include? @identifiable_column.to_s
 
         raise Identifiable::Errors::ColumnMustExistInTheTableError.new(@identifiable_column, valid_columns: column_names)
+      rescue ActiveRecord::StatementInvalid
       end
+      # rubocop:enable Lint/SuppressedException
 
       # We can only use valid styles, so check that the style parameter is a
       # valid style, and raise an error if it is not.
@@ -114,5 +120,19 @@ module Identifiable
       # If we got this far, we've got a new valid public ID, time to set it!
       self[self.class.identifiable_column] = new_public_id
     end
+
+    # By overriding ActiveRecord's `#to_key`, this means that Rails' helpers,
+    # such as `dom_id` will use the public ID instead of the regular ID when
+    # identifying the record.
+    def to_key
+      [self[self.class.identifiable_column]]
+    end
+
+    # By overriding ActiveRecord's `#to_param`, this means that Rails' helpers,
+    # 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
+      self[self.class.identifiable_column]
+    end
   end
 end

data/lib/identifiable/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: identifiable
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Tom Pritchard
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-15 00:00:00.000000000 Z
+date: 2022-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -82,7 +82,7 @@ dependencies:
         version: '0'
 description:
 email:
-- hi@tpritc.com
+- tom@tpritc.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -112,7 +112,8 @@ files:
 homepage: https://github.com/tpritc/identifiable
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -121,7 +122,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="