cool_id 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d44c3207248595af232a200cf0e809224d74033d97d3cac52c6d06d5416b682
-  data.tar.gz: d221baeb8e79ea8ea8ca2b9503685e4bfa7cb8d57b53a3ba0e4d301138a08300
+  metadata.gz: cd52ffe11cf7b25bf473b06e879a7df67eb4aea3b9169b0961342fef30a6fce7
+  data.tar.gz: b92c14dd88880ad52de1884f8a1e2720915b5ee24b742c0db8a966071bd07196
 SHA512:
-  metadata.gz: 9ed700560671d811b0678c4fbe8f9e086c3ca0c9e8d04a54b7d40d586b20864e2add65adb9e5e53feb7915e472974dbfa6b31313dd6a64f4008aaf3f31503f70
-  data.tar.gz: df1cdc3098d9b4761a220fedeca362eeaeb5677d92ca7da594dc946223d814c81bb59db757ff08292fe72e3ce499dd95e1cc002ccf27c436aa097617bd14f2a9
+  metadata.gz: f41bf3c022796fdaf4e8f53af035b6515c6a6b5ac59b749c52a17247bb6710b7296424d2a86c20f484500cae15f7daec32ec1a3980717441a0fec186ad528945
+  data.tar.gz: c81557d5b123b122be77208ef6c74421d81c048dd409f289421ee1bfbaea075550621c77d0c6d92f5b11df393b4fd3be820e62cf2ef491a8e48958705e218d5c

data/README.md

@@ -1,6 +1,6 @@
-# cool_id
+# cool id
 
-a gem for rails that generates string primary key ids for active record models with a per-model prefix followed by a nanoid. this lets you create stripe style ids in your own rails app, and they'll be the same ids you see in your database.
+gem for rails apps to generates string ids with a prefix, followed by a [nanoid](https://zelark.github.io/nano-id-cc/). similar to the ids you see in stripe's api. also able to lookup any record by id, similar to rails' globalid.
 
 ```ruby
 class User < ActiveRecord::Base
@@ -12,7 +12,7 @@ User.create!(name: "...").id
 # => "usr_vktd1b5v84lr"
 ```
 
-it can also lookup records similar to global id:
+lookup any record by its id
 
 ```ruby
 CoolId.locate("usr_vktd1b5v84lr")
@@ -72,7 +72,7 @@ bundle add cool_id
 gem "cool_id"
 ```
 
-### using cool_id in one model
+### adding cool_id to a single model
 
 use string ids when creating a table
 

data/lib/cool_id/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CoolId
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

data/lib/cool_id.rb

@@ -5,7 +5,7 @@ require "nanoid"
 require "active_support/concern"
 
 module CoolId
-  class Error < StandardError; end
+  class NotConfiguredError < StandardError; end
 
   # defaults based on https://planetscale.com/blog/why-we-chose-nanoids-for-planetscales-api
   DEFAULT_SEPARATOR = "_"
@@ -110,7 +110,7 @@ module CoolId
         @cool_id_setup_required = true
       end
 
-      def skip_enforce_cool_id_for_descendants
+      def skip_enforce_cool_id
         @cool_id_setup_required = false
       end
 
@@ -134,7 +134,8 @@ module CoolId
 
       def ensure_cool_id_configured
         if self.class.cool_id_setup_required && self.class.cool_id_config.nil?
-          raise Error, "CoolId not configured for #{self.class}. Use 'cool_id' to configure or 'skip_enforce_cool_id_for_descendants' to opt out."
+          suggested_prefix = self.class.name.downcase[0..2]
+          raise NotConfiguredError, "CoolId not configured for #{self.class}. Use 'cool_id' to configure or 'skip_enforce_cool_id' to opt out.\n\ne.g.\n\nclass #{self.class} < ApplicationRecord\n  cool_id prefix: \"#{suggested_prefix}\"\nend"
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cool_id
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Peter Schilling
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-18 00:00:00.000000000 Z
+date: 2024-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nanoid