encoded_id 1.0.0.rc3 → 1.0.0.rc4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44375d994a7eabe8245cf6bcb0e889e4d9de13f3e67feb98ee77959bc8f076a5
-  data.tar.gz: 4e6db397ee9564375ae7387d57f341266f22fd58214ccecc890b7fb68d8cc4ab
+  metadata.gz: '0844f07baeecd48a70bf0b2564dfb9f02998b002279b44bf75bd0172ccc265be'
+  data.tar.gz: 0bcd81de8a4ea7e034097a92dff9ba82478d92f87f7820dda872a9f35b5294d3
 SHA512:
-  metadata.gz: aade9242ac4d6fffd5ea3957af76a065d14143e547e31b4e7fda5203dcb2aa27f05166e5e803a8677f874bb443fc136196f0ce3bdd78b514606f251721f95d27
-  data.tar.gz: fa4cc2385cbb6a726fc00bdbb5e70d1546abe46b86ba020243327942f32886a4928b8b65bc7a76c9e134bb162c17f4c69798a5e0080c43bf2e7802f92dfa580f
+  metadata.gz: 4dcf3c99891f8a3a195d188656d1c45c9471760dfbc715fe994fac4c4145a086d9573b663c5a4a79894c71c4e3a15bf68ff0d30b20e44b8fe661c68f1707c065
+  data.tar.gz: 8edb3675d565ff7be88441fcdb2a55783415f170fcd8d9102c6bb0fff8cc6fa0d22f1af19e72dd5558dedb37ba2af23c29fd6171d12da2032a0e2ce187bedeca

data/CHANGELOG.md

@@ -6,6 +6,10 @@
 
 - `ReversibleId` now no longer downcases the encodedid input string by default on decode, ie the `decode` option `downcase` is now `false`. In a future release the `downcase` option will be removed.
 
+## [1.0.0.rc4] - unreleased
+
+- Add an optional `max_inputs_per_id` argument to `ReversibleId`, thanks to [@avcwisesa](https://github.com/avcwisesa)
+
 ## [1.0.0.rc3] - 2023-10-23
 
 - Add an optional `max_length` argument to `ReversibleId`, thanks to [@jugglebird](https://github.com/jugglebird)

data/README.md

@@ -137,6 +137,15 @@ the maximum input length that will be decoded. If the encoded string exceeds `ma
 `EncodedIdLengthError` will be raised. If the input exceeds `max_length` then a `InvalidInputError` will
 be raised. If `max_length` is set to `nil`, then no validation, even using the default will be performed.
 
+### `max_inputs_per_id`
+
+`max_inputs_per_id`: the maximum amount of IDs to be encoded together. The default is 32.
+
+This maximum amount is used to limit:
+- the length of array input passed to `encode`
+- the length of integer array encoded in hex string(s) passed to `encode_hex` function.
+`InvalidInputError` wil be raised when array longer than `max_inputs_per_id` is provided.
+
 ### `alphabet`
 
 `alphabet`: the alphabet used in the encoded string. By default, it uses a variation of the Crockford reduced character set (https://www.crockford.com/base32.html).

data/lib/encoded_id/reversible_id.rb

@@ -8,7 +8,7 @@ require "hashids"
 # Note hashIds already has a built in profanity limitation algorithm
 module EncodedId
   class ReversibleId
-    def initialize(salt:, length: 8, split_at: 4, split_with: "-", alphabet: Alphabet.modified_crockford, hex_digit_encoding_group_size: 4, max_length: 128)
+    def initialize(salt:, length: 8, split_at: 4, split_with: "-", alphabet: Alphabet.modified_crockford, hex_digit_encoding_group_size: 4, max_length: 128, max_inputs_per_id: 32)
       @alphabet = validate_alphabet(alphabet)
       @salt = validate_salt(salt)
       @length = validate_length(length)
@@ -16,13 +16,14 @@ module EncodedId
       @split_with = validate_split_with(split_with, alphabet)
       @hex_represention_encoder = HexRepresentation.new(hex_digit_encoding_group_size)
       @max_length = validate_max_length(max_length)
+      @max_inputs_per_id = validate_max_input(max_inputs_per_id)
     end
 
     # Encode the input values into a hash
     def encode(values)
       inputs = prepare_input(values)
       encoded_id = encoded_id_generator.encode(inputs)
-      encoded_id = humanize_length(encoded_id) unless split_at.nil?
+      encoded_id = humanize_length(encoded_id) unless split_with.nil? || split_at.nil?
 
       raise EncodedIdLengthError if max_length_exceeded?(encoded_id)
 
@@ -80,6 +81,11 @@ module EncodedId
       raise InvalidConfigurationError, "Max length must be an integer greater than 0"
     end
 
+    def validate_max_input(max_inputs_per_id)
+      return max_inputs_per_id if valid_integer_option?(max_inputs_per_id)
+      raise InvalidConfigurationError, "Max inputs per ID must be an integer greater than 0"
+    end
+
     # Split the encoded string into groups of this size
     def validate_split_at(split_at)
       return split_at if valid_integer_option?(split_at) || split_at.nil?
@@ -87,8 +93,8 @@ module EncodedId
     end
 
     def validate_split_with(split_with, alphabet)
-      return split_with if split_with.is_a?(String) && !alphabet.characters.include?(split_with)
-      raise InvalidConfigurationError, "Split with must be a string and not part of the alphabet"
+      return split_with if split_with.nil? || (split_with.is_a?(String) && !alphabet.characters.include?(split_with))
+      raise InvalidConfigurationError, "Split with must be a string and not part of the alphabet or nil"
     end
 
     def valid_integer_option?(value)
@@ -99,6 +105,8 @@ module EncodedId
       inputs = value.is_a?(Array) ? value.map(&:to_i) : [value.to_i]
       raise ::EncodedId::InvalidInputError, "Integer IDs to be encoded can only be positive" if inputs.any?(&:negative?)
 
+      raise ::EncodedId::InvalidInputError, "%d integer IDs provided, maximum amount of IDs is %d" % [inputs.length, @max_inputs_per_id] if inputs.length > @max_inputs_per_id
+
       inputs
     end
 

data/lib/encoded_id/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EncodedId
-  VERSION = "1.0.0.rc3"
+  VERSION = "1.0.0.rc4"
 end

data/sig/encoded_id.rbs

@@ -59,7 +59,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
@@ -95,6 +95,7 @@ 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_hex_digit_encoding_group_size: (::Integer) -> ::Integer
@@ -108,7 +109,7 @@ module EncodedId
 
     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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: encoded_id
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc3
+  version: 1.0.0.rc4
 platform: ruby
 authors:
 - Stephen Ierodiaconou
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-23 00:00:00.000000000 Z
+date: 2024-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashids
@@ -67,11 +67,11 @@ 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
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: EncodedId is a gem for creating reversible obfuscated IDs from numerical