encoded_id 1.0.0.rc3 → 1.0.0.rc5

data/sig/encoded_id.rbs

@@ -7,6 +7,78 @@ module EncodedId
   InvalidAlphabetError: ::ArgumentError
   InvalidInputError: ::ArgumentError
 
+  class HashId
+    MIN_ALPHABET_LENGTH: ::Integer
+
+    SEP_DIV: ::Float
+
+    GUARD_DIV: ::Float
+
+    DEFAULT_SEPS: ::String
+
+    DEFAULT_ALPHABET: ::String
+
+    attr_reader salt: ::String
+
+    attr_reader min_hash_length: ::Integer
+
+    @alphabet: ::String
+
+    attr_reader alphabet: ::String
+
+    attr_reader seps: ::String | ::Array[::String]
+
+    attr_reader guards: untyped
+
+    def initialize: (?::String salt, ?::Integer min_hash_length, ?untyped alphabet) -> void
+
+    def encode: (*(Array[::Integer] | ::Integer) numbers) -> ::String
+
+    def encode_hex: (::String str) -> ::String
+
+    def decode: (::String hash) -> ::Array[::Integer]
+
+    def decode_hex: (::String hash) -> ::Array[::Integer]
+
+    # protected
+
+    def internal_encode: (untyped numbers) -> untyped
+
+    def internal_decode: (untyped hash, untyped alphabet) -> untyped
+
+    def consistent_shuffle: (::Array[::String] chars, ::String salt1, ::String ?salt2, ::Integer salt1_length) -> untyped
+
+    def hash: (untyped input, untyped alphabet) -> untyped
+
+    def unhash: (untyped input, untyped alphabet) -> untyped
+
+    private
+
+    def setup_alphabet: () -> untyped
+
+    def setup_seps: () -> untyped
+
+    def setup_guards: () -> untyped
+
+    SaltError: ArgumentError
+
+    MinLengthError: ArgumentError
+
+    AlphabetError: ArgumentError
+
+    InputError: ArgumentError
+
+    def validate_attributes: () -> untyped
+
+    def validate_alphabet: () -> (untyped | nil)
+
+    def hex_string?: (untyped string) -> untyped
+
+    def pick_characters: (untyped array, untyped index) -> untyped
+
+    def uniq_characters: (untyped string) -> untyped
+  end
+
   class Alphabet
     MIN_UNIQUE_CHARACTERS: ::Integer
 
@@ -59,7 +131,7 @@ module EncodedId
   end
 
   class ReversibleId
-    def initialize: (salt: ::String, ?length: ::Integer, ?split_at: ::Integer, ?split_with: ::String, ?alphabet: Alphabet, ?hex_digit_encoding_group_size: ::Integer, ?max_length: ::Integer) -> void
+    def initialize: (salt: ::String, ?length: ::Integer, ?split_at: ::Integer, ?split_with: ::String, ?alphabet: Alphabet, ?hex_digit_encoding_group_size: ::Integer, ?max_length: ::Integer, ?max_inputs_per_id: ::Integer) -> void
 
     # Encode the input values into a hash
     def encode: (encodeableValue values) -> ::String
@@ -75,7 +147,7 @@ module EncodedId
 
     private
 
-    @encoded_id_generator: ::Hashids
+    @encoded_id_generator: HashId
     @split_regex: ::Regexp
     @hex_string_separator: ::Integer
 
@@ -95,20 +167,21 @@ module EncodedId
     def validate_salt: (::String) -> ::String
     def validate_length: (::Integer) -> ::Integer
     def validate_max_length: (::Integer | nil) -> (::Integer | nil)
+    def validate_max_input: (::Integer) -> ::Integer
     def validate_split_at: (::Integer | nil) -> (::Integer | nil)
-    def validate_split_with: (::String, Alphabet) -> ::String
+    def validate_split_with: (::String, Alphabet) -> (::String | nil)
     def validate_hex_digit_encoding_group_size: (::Integer) -> ::Integer
     def valid_integer_option?: (::Integer | nil) -> bool
 
     def prepare_input: (untyped value) -> ::Array[::Integer]
 
-    def encoded_id_generator: () -> ::Hashids
+    def encoded_id_generator: () -> HashId
 
     def split_regex: () -> ::Regexp
 
     def humanize_length: (::String hash) -> ::String
 
-    def convert_to_hash: (::String str) -> ::String
+    def convert_to_hash: (::String str, bool) -> ::String
 
     def map_equivalent_characters: (::String str) -> ::String
     def max_length_exceeded?: (::String str) -> bool

metadata

@@ -1,54 +1,50 @@
 --- !ruby/object:Gem::Specification
 name: encoded_id
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc3
+  version: 1.0.0.rc5
 platform: ruby
 authors:
 - Stephen Ierodiaconou
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-23 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: hashids
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
 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.
+  read or share. Dependency free.
 email:
 - stevegeek@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".devcontainer/Dockerfile"
+- ".devcontainer/compose.yml"
+- ".devcontainer/devcontainer.json"
+- ".standard.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - Steepfile
+- ext/encoded_id/extconf.rb
+- ext/encoded_id/extension.c
+- ext/encoded_id/hashids.c
+- ext/encoded_id/hashids.h
 - lib/encoded_id.rb
 - lib/encoded_id/alphabet.rb
+- lib/encoded_id/hash_id.rb
+- lib/encoded_id/hash_id_consistent_shuffle.rb
+- lib/encoded_id/hash_id_salt.rb
 - lib/encoded_id/hex_representation.rb
+- lib/encoded_id/ordinal_alphabet_separator_guards.rb
 - lib/encoded_id/reversible_id.rb
 - lib/encoded_id/version.rb
 - rbs_collection.yaml
 - sig/encoded_id.rbs
-- sig/hash_ids.rbs
 homepage: https://github.com/stevegeek/encoded_id
 licenses:
 - MIT
@@ -56,10 +52,10 @@ metadata:
   homepage_uri: https://github.com/stevegeek/encoded_id
   source_code_uri: https://github.com/stevegeek/encoded_id
   changelog_uri: https://github.com/stevegeek/encoded_id/blob/master/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
+- ext
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -67,13 +63,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.4.20
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: EncodedId is a gem for creating reversible obfuscated IDs from numerical
-  IDs. It uses Hash IDs under the hood.
+  IDs. It uses an implementation of Hash IDs under the hood.
 test_files: []

data/sig/hash_ids.rbs

@@ -1,70 +0,0 @@
-class Hashids
-  MIN_ALPHABET_LENGTH: ::Integer
-
-  SEP_DIV: ::Float
-
-  GUARD_DIV: ::Float
-
-  DEFAULT_SEPS: ::String
-
-  DEFAULT_ALPHABET: ::String
-
-  attr_reader salt: ::String
-
-  attr_reader min_hash_length: ::Integer
-
-  attr_reader alphabet: ::String
-
-  attr_reader seps: ::String
-
-  attr_reader guards: untyped
-
-  def initialize: (?::String salt, ?::Integer min_hash_length, ?untyped alphabet) -> void
-
-  def encode: (*(Array[::Integer] | ::Integer) numbers) -> ::String
-
-  def encode_hex: (::String str) -> ::String
-
-  def decode: (::String hash) -> ::Array[::Integer]
-
-  def decode_hex: (::String hash) -> ::Array[::Integer]
-
-  # protected
-
-  def internal_encode: (untyped numbers) -> untyped
-
-  def internal_decode: (untyped hash, untyped alphabet) -> untyped
-
-  def consistent_shuffle: (untyped alphabet, untyped salt) -> untyped
-
-  def hash: (untyped input, untyped alphabet) -> untyped
-
-  def unhash: (untyped input, untyped alphabet) -> untyped
-
-  private
-
-  def setup_alphabet: () -> untyped
-
-  def setup_seps: () -> untyped
-
-  def setup_guards: () -> untyped
-
-  SaltError: ArgumentError
-
-  MinLengthError: ArgumentError
-
-  AlphabetError: ArgumentError
-
-  InputError: ArgumentError
-
-  def validate_attributes: () -> untyped
-
-  def validate_alphabet: () -> (untyped | nil)
-
-  def hex_string?: (untyped string) -> untyped
-
-  def pick_characters: (untyped array, untyped index) -> untyped
-
-  def uniq_characters: (untyped string) -> untyped
-end
-