cool_id 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b8bf372b8ba519b55df6abcae1fa6de344364a77ca7c9d6f69e86257debac10
-  data.tar.gz: bfe555391aca0355a559243dc3e9ebd96bf02ee39ab141152941ee613d0cbdce
+  metadata.gz: e34a657a23c3321adf021f9ab101a6cee1f792a3e8b71c11702663dd92ac6883
+  data.tar.gz: f364193fe7ec136a8a436032a5de7b16a7db6b32b4901baa72f3eaa4a39267ea
 SHA512:
-  metadata.gz: e0d61a8a41f45d8e204a5690e07f8be25a05463783d52ef289e3bfe4f98614159e682d79d2fc889719efe983a2f7cc57db901f3111d89005bfdf50f3322dcc04
-  data.tar.gz: ea9cf71b9c7fc2296eb48e1bf7c80f278ddbcf5113d08e6e1e7de113b1419a7889af698fe9a19427bf22ca89762ece47295f89ad3dc0b31d2affa5e6882ce578
+  metadata.gz: 54f60190090f171c8c9f3df697378ad65fb9224551b208fadaddf0b4e2da37818126cbb52127a79e32ede2156f9e59cfe81eedfd20a7bd50dcac83371056806e
+  data.tar.gz: eb277e15108b217785785803a854d6f88405d2e9fd2b8bcf84583890fbb1fb8a48b2392c2b2a9aa20567d547f92fd5ccd2bce946636acc8ccb1e7781d8985e87

data/lib/cool_id/version.rb

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

data/lib/cool_id.rb

@@ -3,29 +3,46 @@
 require_relative "cool_id/version"
 require "nanoid"
 require "active_support/concern"
-require "active_record"
 
 module CoolId
   class Error < StandardError; end
 
+  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
     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 = "_"
+  # 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
@@ -36,43 +53,40 @@ module CoolId
       @registry[prefix] = model_class
     end
 
-    def find_model(prefix)
-      @registry[prefix]
-    end
-
-    def find_record(id)
-      prefix, _ = id.split(CoolId.separator, 2)
-      model_class = find_model(prefix)
-      model_class&.find_by(id: id)
+    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(id)
+    def parse(id)
+      prefix, key = id.split(CoolId.separator, 2)
+      model_class = @registry[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 consist only of whitespace" if value.strip.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
 
@@ -82,18 +96,13 @@ module CoolId
     class_methods do
       attr_reader :cool_id_config
 
-      def cool_id(options = {})
-        register_cool_id(options)
-      end
-
-      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
     end
 
@@ -108,11 +117,11 @@ module CoolId
     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.2
 platform: ruby
 authors:
 - Peter Schilling
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-16 00:00:00.000000000 Z
+date: 2024-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nanoid