cool_id 0.1.2 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e34a657a23c3321adf021f9ab101a6cee1f792a3e8b71c11702663dd92ac6883
-  data.tar.gz: f364193fe7ec136a8a436032a5de7b16a7db6b32b4901baa72f3eaa4a39267ea
+  metadata.gz: 5284982eed15e82c55f1e8a1c853c83feb97d76d7e04fb247b74e6edcbfdcf0e
+  data.tar.gz: 21f44586d37a4a27474dcc984179cc6b8e927ae43da371e5d80874c82a314d43
 SHA512:
-  metadata.gz: 54f60190090f171c8c9f3df697378ad65fb9224551b208fadaddf0b4e2da37818126cbb52127a79e32ede2156f9e59cfe81eedfd20a7bd50dcac83371056806e
-  data.tar.gz: eb277e15108b217785785803a854d6f88405d2e9fd2b8bcf84583890fbb1fb8a48b2392c2b2a9aa20567d547f92fd5ccd2bce946636acc8ccb1e7781d8985e87
+  metadata.gz: 9f8a012d217a3435e87f9df231fce5e850e92cc7ded853fff79cca4f721058f0175912aab2a25c8671defb208453e137884c59a9ec8041a8d1d2aad2f032cb74
+  data.tar.gz: ad7af3d92a6f4b5a067fe535020d9cdd44d53ddd6584ba89555a74bcc83a4cc6a959f7e4cfb857c1961d85dbfe55bd5d0395afe1aed65680d2ae3dab34ab5688

data/README.md

@@ -1,31 +1,89 @@
-# CoolId
+# cool_id
 
-TODO: Delete this and the text below, and describe your gem
+a gem for rails that generates string ids for active record models with a per-model prefix followed by a nanoid.
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/cool_id`. To experiment with that code, run `bin/console` for an interactive prompt.
+```ruby
+class User < ActiveRecord::Base
+  include CoolId::Model
+  cool_id prefix: "usr"
+end
 
-## Installation
+User.create!(name: "...").id
+# => "usr_vktd1b5v84lr"
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+class Customer < ActiveRecord::Base
+  include CoolId::Model
+  cool_id prefix: "cus", alphabet: "ABCDEFGHIJKLMNOPQRSTUVWXYZ", length: 8
+end
 
-Install the gem and add to the application's Gemfile by executing:
+Customer.create!(name: "...").id
+# => "cus_UHNYBINU"
+```
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+it can also lookup records by ids, similar to global id:
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+```ruby
+user = User.create!(name: "John Doe")
+# => #<User id: "usr_vktd1b5v84lr", name: "John Doe">
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+CoolId.locate("usr_vktd1b5v84lr")
+# => #<User id: "usr_vktd1b5v84lr", name: "John Doe">
 
-## Usage
+# You can also parse the id without fetching the record
+parsed = CoolId.parse("usr_vktd1b5v84lr")
+# => #<struct CoolId::Id key="vktd1b5v84lr", prefix="usr", id="usr_vktd1b5v84lr", model_class=User>
 
-TODO: Write usage instructions here
+parsed.model_class
+# => User
+```
 
-## Development
+## installation
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```bash
+bundle add cool_id
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```ruby
+gem "cool_id"
+```
 
-## Contributing
+### per-model
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/cool_id.
+use string ids when creating a table
+
+```ruby
+create_table :users, id: :string do |t|
+  t.string :name
+end
+```
+
+include the `CoolId::Model` concern in the active record model and set up a prefix
+
+```ruby
+class User < ActiveRecord::Base
+  include CoolId::Model
+  cool_id prefix: "usr"
+end
+```
+
+### all models
+
+use string ids on all new generated migrations
+
+```ruby
+# config/initializers/generators.rb
+Rails.application.config.generators do |g|
+  g.orm :active_record, primary_key_type: :string
+end
+```
+
+setup `ApplicationRecord` to include cool id and ensure it's setup in classes that inherit from it
+
+```ruby
+# app/models/application_record.rb
+class ApplicationRecord < ActiveRecord::Base
+  include CoolId::Model
+  primary_abstract_class
+  enforce_cool_id_for_descendants
+end
+```

data/lib/cool_id/version.rb

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

data/lib/cool_id.rb

@@ -7,6 +7,7 @@ require "active_support/concern"
 module CoolId
   class Error < StandardError; end
 
+  # defaults based on https://planetscale.com/blog/why-we-chose-nanoids-for-planetscales-api
   DEFAULT_SEPARATOR = "_"
   DEFAULT_ALPHABET = "0123456789abcdefghijklmnopqrstuvwxyz"
   DEFAULT_LENGTH = 12
@@ -27,7 +28,7 @@ module CoolId
     end
 
     def registry
-      @registry ||= Registry.new
+      @prefix_map ||= Registry.new
     end
 
     def generate_id(config)
@@ -39,18 +40,17 @@ module CoolId
     end
   end
 
-  # defaults based on https://planetscale.com/blog/why-we-chose-nanoids-for-planetscales-api
   self.separator = DEFAULT_SEPARATOR
   self.alphabet = DEFAULT_ALPHABET
   self.length = DEFAULT_LENGTH
 
   class Registry
     def initialize
-      @registry = {}
+      @prefix_map = {}
     end
 
     def register(prefix, model_class)
-      @registry[prefix] = model_class
+      @prefix_map[prefix] = model_class
     end
 
     def locate(id)
@@ -60,7 +60,7 @@ module CoolId
 
     def parse(id)
       prefix, key = id.split(CoolId.separator, 2)
-      model_class = @registry[prefix]
+      model_class = @prefix_map[prefix]
       return nil unless model_class
       Id.new(key, prefix, id, model_class)
     end
@@ -79,7 +79,7 @@ module CoolId
 
     def validate_prefix(value)
       raise ArgumentError, "Prefix cannot be nil" if value.nil?
-      raise ArgumentError, "Prefix cannot consist only of whitespace" if value.strip.empty?
+      raise ArgumentError, "Prefix cannot be empty" if value.empty?
       value
     end
 
@@ -94,7 +94,8 @@ module CoolId
     extend ActiveSupport::Concern
 
     class_methods do
-      attr_reader :cool_id_config
+      attr_accessor :cool_id_config
+      attr_accessor :cool_id_setup_required
 
       def cool_id(options)
         @cool_id_config = Config.new(**options)
@@ -104,16 +105,38 @@ module CoolId
       def generate_cool_id
         CoolId.generate_id(@cool_id_config)
       end
+
+      def enforce_cool_id_for_descendants
+        @cool_id_setup_required = true
+      end
+
+      def skip_enforce_cool_id_for_descendants
+        @cool_id_setup_required = false
+      end
+
+      def inherited(subclass)
+        super
+        if @cool_id_setup_required && !subclass.instance_variable_defined?(:@cool_id_setup_required)
+          subclass.instance_variable_set(:@cool_id_setup_required, true)
+        end
+      end
     end
 
     included do
       before_create :set_cool_id
+      after_initialize :ensure_cool_id_configured
 
       private
 
       def set_cool_id
         self.id = self.class.generate_cool_id if id.blank?
       end
+
+      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."
+        end
+      end
     end
   end
 

metadata

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