encoded_id 1.0.0.rc7 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c94c4fae6354b78328fed94361c666d7df2cf7e797cd1523db2db6e7a57e3d81
-  data.tar.gz: d65c032660d6894da1c81bec5156a9f733ea02d56631b6cc199ed82dcdd1eb24
+  metadata.gz: ccfa7987d3a108bfce0268467b8ae40793226e98f01fa2c331bc1f642026f47b
+  data.tar.gz: b4cb2429a8031f0e576f242550397b4683e302a184d57f0c85b870da502e181e
 SHA512:
-  metadata.gz: 6c6a510d660bc34709dc4442dcfd14d63320b79b79f595de8dea225d21379cd859d7473ecab83e137c557fca0f3bf3ceaf0c3074efe98434c5743bb3d0d8387a
-  data.tar.gz: f7724cf6109b4dfd25729bf7c974c496864525e46de58141bba0bf74ae69ce165d8c6549a6a0ab23325dd0c0fbd6386d40815573be3cfc5ca59dd3fa50a83dc6
+  metadata.gz: db4ae0c6d8477ea3ab5ada1bcbd959b18420c1aa1be54ec747898d298f16e6dd6a2090ff4a18008fe1711d3641c158bf9a8c1da23a33663be7fbc17a68079409
+  data.tar.gz: 4e731df7f992cf6935012cabffc7c6d4923de5db46059c123780d0f6a1dfbe329844ddf074580c67ec1a16101afb9c315175049045bcf5375e6666ae2707fa0b

data/CHANGELOG.md

@@ -2,12 +2,17 @@
 
 - nothing yet
 
-## [1.0.0] - unreleased
+## [1.0.0] - 2025-11-21
 
 - First stable release!
 
 **Important!!: `:sqids` are not compatible with `:hashids`, DO NOT CHANGE FROM ONE TO THE OTHER AFTER GOING LIVE.**
 
+### Fixed (Rails integration)
+
+- Ensure finder methods correctly override their ActiveRecord counterparts 
+- Warn when ActiveRecord integration used in model that doesn't use `id` as primary key
+
 ## [1.0.0.rc7] - 2025-11-19
 
 ### Breaking changes

data/lib/encoded_id/encoders/base_configuration.rb

@@ -7,20 +7,16 @@ module EncodedId
     # Base configuration class for encoder-specific settings
     # This provides common parameters shared across all encoders
     class BaseConfiguration
-      # @rbs @min_length: Integer
-      # @rbs @alphabet: Alphabet
-      # @rbs @split_at: Integer?
-      # @rbs @split_with: String?
-      # @rbs @hex_digit_encoding_group_size: Integer
-      # @rbs @max_length: Integer?
-      # @rbs @max_inputs_per_id: Integer
-      # @rbs @blocklist: Blocklist
-      # @rbs @blocklist_mode: Symbol
-      # @rbs @blocklist_max_length: Integer
-
-      attr_reader :min_length, :alphabet, :split_at, :split_with,
-        :hex_digit_encoding_group_size, :max_length,
-        :max_inputs_per_id, :blocklist, :blocklist_mode, :blocklist_max_length
+      attr_reader :min_length #: Integer
+      attr_reader :alphabet #: Alphabet
+      attr_reader :split_at #: Integer?
+      attr_reader :split_with #: String?
+      attr_reader :hex_digit_encoding_group_size #: Integer
+      attr_reader :max_length #: Integer?
+      attr_reader :max_inputs_per_id #: Integer
+      attr_reader :blocklist #: Blocklist
+      attr_reader :blocklist_mode #: Symbol
+      attr_reader :blocklist_max_length #: Integer
 
       # @rbs (?min_length: Integer, ?alphabet: Alphabet, ?split_at: Integer?, ?split_with: String?, ?hex_digit_encoding_group_size: Integer, ?max_length: Integer?, ?max_inputs_per_id: Integer, ?blocklist: Blocklist | Array[String] | Set[String] | nil, ?blocklist_mode: Symbol, ?blocklist_max_length: Integer) -> void
       def initialize(
@@ -49,12 +45,7 @@ module EncodedId
         validate_blocklist_collision_risk
       end
 
-      # @rbs () -> Symbol
-      def encoder_type
-        raise NotImplementedError, "Subclasses must implement encoder_type"
-      end
-
-      # @rbs () -> untyped
+      # @rbs () -> (Hashid | Sqids)
       def create_encoder
         raise NotImplementedError, "Subclasses must implement create_encoder"
       end

data/lib/encoded_id/encoders/hashid_configuration.rb

@@ -7,9 +7,7 @@ module EncodedId
     # Configuration for Hashids encoder
     # Hashids requires a salt for encoding/decoding
     class HashidConfiguration < BaseConfiguration
-      # @rbs @salt: String
-
-      attr_reader :salt
+      attr_reader :salt #: String
 
       # @rbs (salt: String, **untyped options) -> void
       def initialize(salt:, **options)
@@ -17,11 +15,6 @@ module EncodedId
         super(**options)
       end
 
-      # @rbs () -> Symbol
-      def encoder_type
-        :hashids
-      end
-
       # Create the Hashid encoder instance
       # @rbs () -> Hashid
       def create_encoder

data/lib/encoded_id/encoders/sqids.rb

@@ -6,10 +6,7 @@ module EncodedId
   module Encoders
     # Encoder implementation using the Sqids algorithm for encoding/decoding IDs.
     class Sqids
-      # @rbs @sqids: untyped
-      # @rbs @min_hash_length: Integer
-      # @rbs @alphabet: Alphabet
-      # @rbs @blocklist: Blocklist
+      # @rbs @sqids: SqidsWithBlocklistMode
       # @rbs @blocklist_mode: Symbol
       # @rbs @blocklist_max_length: Integer
 

data/lib/encoded_id/encoders/sqids_configuration.rb

@@ -7,11 +7,6 @@ module EncodedId
     # Configuration for Sqids encoder
     # Sqids does not use a salt - it shuffles the alphabet deterministically
     class SqidsConfiguration < BaseConfiguration
-      # @rbs () -> Symbol
-      def encoder_type
-        :sqids
-      end
-
       # Create the Sqids encoder instance
       # @rbs () -> Sqids
       def create_encoder

data/lib/encoded_id/encoders/sqids_with_blocklist_mode.rb

@@ -44,10 +44,8 @@ class SqidsWithBlocklistMode < MySqids
       true
     when :length_threshold
       id.length <= @blocklist_max_length
-    when :raise_if_likely
-      # This mode raises at configuration time, so if we get here, we check
-      true
     else
+      # If :raise_if_likely mode it raises at configuration time, so if we get here, we check
       true
     end
   end

data/lib/encoded_id/reversible_id.rb

@@ -10,10 +10,6 @@ module EncodedId
   #   type encodeableValue = Array[String | Integer] | String | Integer
 
   class ReversibleId
-    # @rbs @config: Encoders::BaseConfiguration
-    # @rbs @hex_represention_encoder: HexRepresentation
-    # @rbs @encoder: untyped
-
     # Factory method to create a Hashid-based reversible ID
     # @rbs (salt: String, **untyped options) -> ReversibleId
     def self.hashid(salt:, **options)
@@ -40,40 +36,13 @@ module EncodedId
       @encoder = create_encoder
     end
 
-    # @rbs () -> String?
-    def salt
-      config = @config
-      return config.salt if config.is_a?(Encoders::HashidConfiguration)
-      nil
-    end
-
-    def min_length
-      @config.min_length
-    end
-
-    def alphabet
-      @config.alphabet
-    end
-
-    def split_at
-      @config.split_at
-    end
-
-    def split_with
-      @config.split_with
-    end
-
-    attr_reader :hex_represention_encoder
-
-    def max_length
-      @config.max_length
-    end
-
-    def blocklist
-      @config.blocklist
-    end
+    # The configuration object for this encoder instance.
+    # Returns either an Encoders::HashidConfiguration or Encoders::SqidsConfiguration.
+    # Useful for introspecting settings like alphabet, min_length, blocklist, etc.
+    attr_reader :config #: Encoders::BaseConfiguration
 
-    attr_reader :encoder #: untyped
+    attr_reader :hex_represention_encoder #: HexRepresentation
+    attr_reader :encoder #: Encoders::Hashid | Encoders::Sqids
 
     # Encode the input values into a hash
     # @rbs (encodeableValue values) -> String
@@ -122,7 +91,7 @@ module EncodedId
       inputs
     end
 
-    # @rbs () -> untyped
+    # @rbs () -> (Encoders::Hashid | Encoders::Sqids)
     def create_encoder
       @config.create_encoder
     end
@@ -150,7 +119,8 @@ module EncodedId
     # Reverses humanize_length transformation: removes separators and optionally downcases
     # @rbs (String str, bool downcase) -> String
     def convert_to_hash(str, downcase)
-      str = str.gsub(@config.split_with, "") if @config.split_with
+      split_with = @config.split_with
+      str = str.gsub(split_with, "") if split_with
       str = str.downcase if downcase
       map_equivalent_characters(str)
     end
@@ -169,9 +139,10 @@ module EncodedId
 
     # @rbs (String str) -> bool
     def max_length_exceeded?(str)
-      return false if @config.max_length.nil?
+      max_len = @config.max_length
+      return false unless max_len
 
-      str.length > @config.max_length
+      str.length > max_len
     end
   end
 end

data/lib/encoded_id/version.rb

@@ -3,5 +3,5 @@
 # rbs_inline: enabled
 
 module EncodedId
-  VERSION = "1.0.0.rc7"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: encoded_id
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc7
+  version: 1.0.0
 platform: ruby
 authors:
 - Stephen Ierodiaconou
 bindir: exe
 cert_chain: []
-date: 2025-11-20 00:00:00.000000000 Z
+date: 2025-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sqids