cool_id 0.1.5 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5284982eed15e82c55f1e8a1c853c83feb97d76d7e04fb247b74e6edcbfdcf0e
-  data.tar.gz: 21f44586d37a4a27474dcc984179cc6b8e927ae43da371e5d80874c82a314d43
+  metadata.gz: cd52ffe11cf7b25bf473b06e879a7df67eb4aea3b9169b0961342fef30a6fce7
+  data.tar.gz: b92c14dd88880ad52de1884f8a1e2720915b5ee24b742c0db8a966071bd07196
 SHA512:
-  metadata.gz: 9f8a012d217a3435e87f9df231fce5e850e92cc7ded853fff79cca4f721058f0175912aab2a25c8671defb208453e137884c59a9ec8041a8d1d2aad2f032cb74
-  data.tar.gz: ad7af3d92a6f4b5a067fe535020d9cdd44d53ddd6584ba89555a74bcc83a4cc6a959f7e4cfb857c1961d85dbfe55bd5d0395afe1aed65680d2ae3dab34ab5688
+  metadata.gz: f41bf3c022796fdaf4e8f53af035b6515c6a6b5ac59b749c52a17247bb6710b7296424d2a86c20f484500cae15f7daec32ec1a3980717441a0fec186ad528945
+  data.tar.gz: c81557d5b123b122be77208ef6c74421d81c048dd409f289421ee1bfbaea075550621c77d0c6d92f5b11df393b4fd3be820e62cf2ef491a8e48958705e218d5c

data/LICENSE

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) Peter Schilling
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.

data/README.md

@@ -1,6 +1,6 @@
-# cool_id
+# cool id
 
-a gem for rails that generates string ids for active record models with a per-model prefix followed by a nanoid.
+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
@@ -10,26 +10,18 @@ end
 
 User.create!(name: "...").id
 # => "usr_vktd1b5v84lr"
-
-class Customer < ActiveRecord::Base
-  include CoolId::Model
-  cool_id prefix: "cus", alphabet: "ABCDEFGHIJKLMNOPQRSTUVWXYZ", length: 8
-end
-
-Customer.create!(name: "...").id
-# => "cus_UHNYBINU"
 ```
 
-it can also lookup records by ids, similar to global id:
+lookup any record by its id
 
 ```ruby
-user = User.create!(name: "John Doe")
-# => #<User id: "usr_vktd1b5v84lr", name: "John Doe">
-
 CoolId.locate("usr_vktd1b5v84lr")
 # => #<User id: "usr_vktd1b5v84lr", name: "John Doe">
+```
 
-# You can also parse the id without fetching the record
+and parse ids
+
+```ruby
 parsed = CoolId.parse("usr_vktd1b5v84lr")
 # => #<struct CoolId::Id key="vktd1b5v84lr", prefix="usr", id="usr_vktd1b5v84lr", model_class=User>
 
@@ -37,8 +29,41 @@ parsed.model_class
 # => User
 ```
 
+and generate ids without creating a record
+
+```ruby
+# generate an id, e.g. for batch inserts or upserts
+User.generate_cool_id
+# => "usr_vktd1b5v84lr"
+
+```
+
+it takes parameters to change the alphabet or length
+
+```ruby
+class Customer < ActiveRecord::Base
+  include CoolId::Model
+  cool_id prefix: "cus", alphabet: "ABCDEFGHIJKLMNOPQRSTUVWXYZ", length: 8
+end
+
+Customer.create!(name: "...").id
+# => "cus_UHNYBINU"
+```
+
+and these can be configured globally
+
+```ruby
+CoolId.configure do |config|
+  config.separator = "-"
+  config.alphabet = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
+  config.length = 8
+end
+```
+
 ## installation
 
+add cool_id to your Gemfile:
+
 ```bash
 bundle add cool_id
 ```
@@ -47,7 +72,7 @@ bundle add cool_id
 gem "cool_id"
 ```
 
-### per-model
+### adding cool_id to a single model
 
 use string ids when creating a table
 
@@ -66,9 +91,9 @@ class User < ActiveRecord::Base
 end
 ```
 
-### all models
+### using cool_id on all models
 
-use string ids on all new generated migrations
+you have drank the coolaid. setup rails to use string ids on all new generated migrations
 
 ```ruby
 # config/initializers/generators.rb
@@ -77,7 +102,7 @@ Rails.application.config.generators do |g|
 end
 ```
 
-setup `ApplicationRecord` to include cool id and ensure it's setup in classes that inherit from it
+then setup `ApplicationRecord` to include cool id and ensure it's setup in classes that inherit from it
 
 ```ruby
 # app/models/application_record.rb
@@ -87,3 +112,21 @@ class ApplicationRecord < ActiveRecord::Base
   enforce_cool_id_for_descendants
 end
 ```
+
+### graphql
+
+if you use the graphql ruby node interface, you can implement [object identification](https://graphql-ruby.org/schema/object_identification)
+
+
+```ruby
+# app/graphql/app_schema.rb
+class AppSchema < GraphQL::Schema
+  def self.id_from_object(object, type_definition, query_ctx)
+    object.id
+  end
+
+  def self.object_from_id(id, query_ctx)
+    CoolId.locate(id)
+  end
+end
+```

data/lib/cool_id/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CoolId
-  VERSION = "0.1.5"
+  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.5
+  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
@@ -76,13 +76,15 @@ files:
 - ".rspec"
 - ".standard.yml"
 - CHANGELOG.md
+- LICENSE
 - README.md
 - Rakefile
 - lib/cool_id.rb
 - lib/cool_id/version.rb
 - sig/cool_id.rbs
 homepage: https://github.com/schpet/cool_id
-licenses: []
+licenses:
+- ISC
 metadata:
   homepage_uri: https://github.com/schpet/cool_id
   source_code_uri: https://github.com/schpet/cool_id