encoded_id 1.0.0.rc6 → 1.0.0.rc7

metadata

@@ -1,19 +1,33 @@
 --- !ruby/object:Gem::Specification
 name: encoded_id
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc6
+  version: 1.0.0.rc7
 platform: ruby
 authors:
 - Stephen Ierodiaconou
 bindir: exe
 cert_chain: []
-date: 2025-11-17 00:00:00.000000000 Z
-dependencies: []
+date: 2025-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sqids
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
 description: Encode your numerical IDs (eg record primary keys) into obfuscated strings
   that can be used in URLs. The obfuscated strings are reversible, so you can decode
   them back into the original numerical IDs. Supports encoding multiple IDs at once,
   and generating IDs with custom alphabets and separators to make the IDs easier to
-  read or share. Dependency free.
+  read or share. Uses Sqids by default, with HashIds as an alternative.
 email:
 - stevegeek@gmail.com
 executables: []
@@ -27,13 +41,16 @@ files:
 - lib/encoded_id.rb
 - lib/encoded_id/alphabet.rb
 - lib/encoded_id/blocklist.rb
-- lib/encoded_id/encoders/base.rb
-- lib/encoded_id/encoders/hash_id.rb
-- lib/encoded_id/encoders/hash_id_consistent_shuffle.rb
-- lib/encoded_id/encoders/hash_id_ordinal_alphabet_separator_guards.rb
-- lib/encoded_id/encoders/hash_id_salt.rb
+- lib/encoded_id/encoders/base_configuration.rb
+- lib/encoded_id/encoders/hashid.rb
+- lib/encoded_id/encoders/hashid_configuration.rb
+- lib/encoded_id/encoders/hashid_consistent_shuffle.rb
+- lib/encoded_id/encoders/hashid_ordinal_alphabet_separator_guards.rb
+- lib/encoded_id/encoders/hashid_salt.rb
 - lib/encoded_id/encoders/my_sqids.rb
 - lib/encoded_id/encoders/sqids.rb
+- lib/encoded_id/encoders/sqids_configuration.rb
+- lib/encoded_id/encoders/sqids_with_blocklist_mode.rb
 - lib/encoded_id/hex_representation.rb
 - lib/encoded_id/reversible_id.rb
 - lib/encoded_id/version.rb
@@ -61,5 +78,5 @@ requirements: []
 rubygems_version: 3.6.2
 specification_version: 4
 summary: EncodedId is a gem for creating reversible obfuscated IDs from numerical
-  IDs. It uses an implementation of Hash IDs under the hood.
+  IDs. It uses Sqids by default.
 test_files: []

data/lib/encoded_id/encoders/base.rb

@@ -1,71 +0,0 @@
-# frozen_string_literal: true
-
-# rbs_inline: enabled
-
-module EncodedId
-  module Encoders
-    class Base
-      # @rbs @min_hash_length: Integer
-      # @rbs @alphabet: Alphabet
-      # @rbs @salt: String
-      # @rbs @blocklist: Blocklist
-
-      # @rbs (String salt, ?Integer min_hash_length, ?Alphabet alphabet, ?Blocklist blocklist) -> void
-      def initialize(salt, min_hash_length = 0, alphabet = Alphabet.alphanum, blocklist = Blocklist.empty)
-        @min_hash_length = min_hash_length
-        @alphabet = alphabet
-        @salt = salt
-        @blocklist = blocklist
-      end
-
-      attr_reader :min_hash_length #: Integer
-      attr_reader :alphabet #: Alphabet
-      attr_reader :salt #: String
-      attr_reader :blocklist #: Blocklist
-
-      # Encode array of numbers into a string
-      # @rbs (Array[Integer] numbers) -> String
-      def encode(numbers)
-        raise NotImplementedError, "#{self.class} must implement #encode"
-      end
-
-      # Encode hexadecimal string(s) into a string
-      # @rbs (String str) -> String
-      def encode_hex(str)
-        return "" unless hex_string?(str)
-
-        numbers = str.scan(/[\w\W]{1,12}/).map do |num|
-          "1#{num}".to_i(16)
-        end
-
-        encode(numbers)
-      end
-
-      # Decode a string back into an array of numbers
-      # @rbs (String hash) -> Array[Integer]
-      def decode(hash)
-        raise NotImplementedError, "#{self.class} must implement #decode"
-      end
-
-      # Decode a string back into an array of hexadecimal strings
-      # @rbs (String hash) -> String
-      def decode_hex(hash)
-        numbers = decode(hash)
-        return "" if numbers.empty?
-
-        ret = numbers.map do |n|
-          n.to_s(16)[1..]
-        end
-
-        ret.join.upcase
-      end
-
-      private
-
-      # @rbs (String string) -> MatchData?
-      def hex_string?(string)
-        string.to_s.match(/\A[0-9a-fA-F]+\Z/)
-      end
-    end
-  end
-end