cool_id 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b8bf372b8ba519b55df6abcae1fa6de344364a77ca7c9d6f69e86257debac10
-  data.tar.gz: bfe555391aca0355a559243dc3e9ebd96bf02ee39ab141152941ee613d0cbdce
+  metadata.gz: 6a61d8d06c3414dcec52ecd9a3f28696d0fafb683b2b206e025c33a1deb03de9
+  data.tar.gz: bc13a903ed6d5239eae6ee216f5da45699a525d755e914f9f9c2b81b6e33d26c
 SHA512:
-  metadata.gz: e0d61a8a41f45d8e204a5690e07f8be25a05463783d52ef289e3bfe4f98614159e682d79d2fc889719efe983a2f7cc57db901f3111d89005bfdf50f3322dcc04
-  data.tar.gz: ea9cf71b9c7fc2296eb48e1bf7c80f278ddbcf5113d08e6e1e7de113b1419a7889af698fe9a19427bf22ca89762ece47295f89ad3dc0b31d2affa5e6882ce578
+  metadata.gz: 77aac33c12253962d7beabffc5d7101379f40d991b580c67ea0a306cd82f8d2befda21b23fbd3c3735a516863ef4c3565b18084f67ed001172b7a395527f3f4a
+  data.tar.gz: d3c269343bd10098fdd902424c10c22e676a0cea67d5dff404628863ea4d085319017b31d6c602364da024d36c30a470e1bd3ade7b687379bbbd3f011a72191c

data/lib/cool_id/version.rb

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

data/lib/cool_id.rb

@@ -3,76 +3,90 @@
 require_relative "cool_id/version"
 require "nanoid"
 require "active_support/concern"
-require "active_record"
 
 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
+
+  Id = Struct.new(:key, :prefix, :id, :model_class)
+
   class << self
-    attr_accessor :separator
+    attr_accessor :separator, :alphabet, :length
 
     def configure
       yield self
     end
 
+    def reset_configuration
+      self.separator = DEFAULT_SEPARATOR
+      self.alphabet = DEFAULT_ALPHABET
+      self.length = DEFAULT_LENGTH
+    end
+
     def registry
-      @registry ||= Registry.new
+      @prefix_map ||= Registry.new
     end
 
     def generate_id(config)
-      id = Nanoid.generate(size: config.length, alphabet: config.alphabet)
-      [config.prefix, id].reject(&:empty?).join(@separator)
+      alphabet = config.alphabet || @alphabet
+      length = config.length || @length
+      id = Nanoid.generate(size: length, alphabet: alphabet)
+
+      "#{config.prefix}#{separator}#{id}"
     end
   end
 
-  self.separator = "_"
+  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 find_model(prefix)
-      @registry[prefix]
+    def locate(id)
+      parsed = parse(id)
+      parsed&.model_class&.find_by(id: id)
     end
 
-    def find_record(id)
-      prefix, _ = id.split(CoolId.separator, 2)
-      model_class = find_model(prefix)
-      model_class&.find_by(id: id)
-    end
-
-    def find_record!(id)
-      prefix, _ = id.split(CoolId.separator, 2)
-      model_class = find_model(prefix)
-      model_class&.find(id)
+    def parse(id)
+      prefix, key = id.split(CoolId.separator, 2)
+      model_class = @prefix_map[prefix]
+      return nil unless model_class
+      Id.new(key, prefix, id, model_class)
     end
   end
 
   class Config
     attr_reader :prefix, :length, :alphabet
 
-    def initialize(prefix: "", length: 12, alphabet: "0123456789abcdefghijklmnopqrstuvwxyz")
-      @prefix = prefix
+    def initialize(prefix:, length: nil, alphabet: nil)
       @length = length
-      self.alphabet = alphabet
-    end
-
-    def alphabet=(value)
-      validate_alphabet(value)
-      @alphabet = value
+      @prefix = validate_prefix(prefix)
+      @alphabet = validate_alphabet(alphabet)
     end
 
     private
 
+    def validate_prefix(value)
+      raise ArgumentError, "Prefix cannot be nil" if value.nil?
+      raise ArgumentError, "Prefix cannot be empty" if value.empty?
+      value
+    end
+
     def validate_alphabet(value)
-      if value.include?(CoolId.separator)
-        raise ArgumentError, "Alphabet cannot include the separator '#{CoolId.separator}'"
-      end
+      return nil if value.nil?
+      raise ArgumentError, "Alphabet cannot include the separator '#{CoolId.separator}'" if value.include?(CoolId.separator)
+      value
     end
   end
 
@@ -80,39 +94,57 @@ module CoolId
     extend ActiveSupport::Concern
 
     class_methods do
-      attr_reader :cool_id_config
-
-      def cool_id(options = {})
-        register_cool_id(options)
-      end
+      attr_accessor :cool_id_config
+      attr_accessor :cool_id_setup_required
 
-      def register_cool_id(options = {})
-        raise ArgumentError, "Prefix cannot be empty" if options[:prefix] && options[:prefix].empty?
+      def cool_id(options)
         @cool_id_config = Config.new(**options)
         CoolId.registry.register(options[:prefix], self)
       end
 
       def generate_cool_id
-        CoolId.generate_id(@cool_id_config || Config.new)
+        CoolId.generate_id(@cool_id_config)
+      end
+
+      def ensure_cool_id_setup
+        @cool_id_setup_required = true
+      end
+
+      def skip_cool_id_setup
+        @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_cool_id_setup' to opt out."
+        end
+      end
     end
   end
 
-  def self.find(id)
-    registry.find_record(id)
+  def self.locate(id)
+    registry.locate(id)
   end
 
-  def self.find!(id)
-    registry.find_record!(id)
+  def self.parse(id)
+    registry.parse(id)
   end
 end

metadata

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