cool_id 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e34a657a23c3321adf021f9ab101a6cee1f792a3e8b71c11702663dd92ac6883
-  data.tar.gz: f364193fe7ec136a8a436032a5de7b16a7db6b32b4901baa72f3eaa4a39267ea
+  metadata.gz: 6a61d8d06c3414dcec52ecd9a3f28696d0fafb683b2b206e025c33a1deb03de9
+  data.tar.gz: bc13a903ed6d5239eae6ee216f5da45699a525d755e914f9f9c2b81b6e33d26c
 SHA512:
-  metadata.gz: 54f60190090f171c8c9f3df697378ad65fb9224551b208fadaddf0b4e2da37818126cbb52127a79e32ede2156f9e59cfe81eedfd20a7bd50dcac83371056806e
-  data.tar.gz: eb277e15108b217785785803a854d6f88405d2e9fd2b8bcf84583890fbb1fb8a48b2392c2b2a9aa20567d547f92fd5ccd2bce946636acc8ccb1e7781d8985e87
+  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.2"
+  VERSION = "0.1.3"
 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 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
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cool_id
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 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