encoded_id 0.4.0 → 1.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5cc2ba3de20b77f871eacb0820fb0ab151281bf6ff6281c992f9e47dc8657138
-  data.tar.gz: 22e9cc3a0dcaecaf34aea73b25681651efe8a4528b4cb70d01ea0aa5fdb73b57
+  metadata.gz: a860b12577a70042f6d17a1788cb8557f3ab5ab477441a44c3be037b70165ded
+  data.tar.gz: bd9d57c92ada9e47a1080ea5b4d04cb3069a055a213305b698f1a2c7c424297f
 SHA512:
-  metadata.gz: 04f9083352c9559df93ef8418397f43b9360b070025ba75e1ad4ba116fced9635f479939ca9cc55f9b9e594d380e8c4fa503834c85e1ef1994c187de0f5ce3a0
-  data.tar.gz: b2527e2301ad455b22d8ce1a5c652a6814485a703b032af635834ba145b904050ea3b15f3cb9d189b0e3a3a1361e5dce4c4fdbf662f819c56bbbcd212c8f7008
+  metadata.gz: e78405858e31da61d3361c3e42f999591e68f2053f1b58944c1f07616f5a57a599a174708eda301d52743d9dabaae8e76bf50442936401a9e943699589e0ad5c
+  data.tar.gz: a4e9ee6327f0d0e0d68eab43af5f21126e5ccef888b7478e07e14ade2a1532f618ac95ddb80e3406956ed7e505fda76c577e63368d376955024ab65df5084aa0

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 ## [Unreleased]
 
+## [1.0.0] - 2023-08-06
+
+- Improved RBS definitions
+- Improved test coverage
+
+## [0.4.0] - 2022-12-04
+
+- Support custom split character which must not be in the alphabet
+- Ability to provide a custom character equivalences mapping
+
+## [0.3.0] - 2022-10-12
+
+- Fix splitting of encoded ID string
+- Checks that integer values to be encoded are positive
+- Experimental support for encoding hex strings
+
 ## [0.1.0] - 2022-10-11
 
 - Initial release

data/Gemfile

@@ -9,6 +9,6 @@ gem "rake", "~> 13.0"
 
 gem "minitest", "~> 5.0"
 
-gem "standard", "~> 1.3"
+gem "standard", "~> 1.25"
 
-gem "steep", "~> 1.2"
+gem "steep", "~> 1.5"

data/README.md

@@ -33,8 +33,7 @@ coder.decode("z2j7-Odmw") # (note the capital 'o' instead of zero)
 
 ## Features
 
-* encoded IDs are reversible (uses with https://hashids.org)
-* supports slugged IDs (eg `beef-tenderloins-prime--p5w9-z27j`)
+* encoded IDs are reversible (uses with https://hashids.org))
 * supports multiple IDs encoded in one encoded string (eg `7aq6-0zqw` decodes to `[78, 45]`)
 * supports encoding of hex strings (eg UUIDs), including multiple IDs encoded in one string **(experimental)**
 * supports custom alphabets for the encoded string (at least 16 characters needed)
@@ -276,6 +275,21 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git 
 commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+### Type check
+
+First install dependencies:
+
+```bash
+rbs collection install
+```
+
+Then run:
+
+```bash
+steep check
+```
+
+
 ## See also
 
 - https://hashids.org

data/lib/encoded_id/alphabet.rb

@@ -2,29 +2,10 @@
 
 module EncodedId
   class Alphabet
-    def initialize(characters, equivalences = nil)
-      unless (characters.is_a?(Array) || characters.is_a?(String)) && characters.size > 0
-        raise InvalidAlphabetError, "Alphabet must be a string or array"
-      end
-      unique_alphabet = (characters.is_a?(Array) ? characters : characters.chars).uniq
-      raise InvalidAlphabetError, "Alphabet must be at least 16 unique characters" if unique_alphabet.size < 16
-      @characters = unique_alphabet.join
-
-      # Equivalences is a hash of characters to their equivalent character.
-      # Characters to be mapped must not be in the alphabet, and must map to a character that is in the alphabet.
-      raise InvalidConfigurationError, "Character equivalences must be a hash or nil" unless equivalences.nil? || equivalences.is_a?(Hash)
-      valid_equivalences = equivalences.nil? || (unique_alphabet & equivalences.keys).empty? && (equivalences.values - unique_alphabet).empty?
-      raise InvalidConfigurationError unless valid_equivalences
-      @equivalences = equivalences
-    end
-
-    attr_reader :characters, :equivalences
+    MIN_UNIQUE_CHARACTERS = 16
 
     class << self
       def modified_crockford
-        # Note we downcase first, so mappings are only for lower case. Also Crockford suggests i==1,
-        # but here i==j is used.
-
         new(
           "0123456789abcdefghjkmnpqrstuvwxyz",
           {
@@ -35,5 +16,50 @@ module EncodedId
         )
       end
     end
+
+    def initialize(characters, equivalences = nil)
+      raise_invalid_alphabet! unless valid_input_characters?(characters)
+      unique_characters = unique_character_alphabet(characters)
+      raise_character_set_too_small! unless sufficient_characters?(unique_characters.size)
+      raise_invalid_equivalences! unless valid_equivalences?(equivalences, unique_characters)
+
+      @characters = unique_characters.join
+      @equivalences = equivalences
+    end
+
+    attr_reader :characters, :equivalences
+
+    private
+
+    def valid_input_characters?(characters)
+      (characters.is_a?(Array) || characters.is_a?(String)) && characters.size > 0
+    end
+
+    def unique_character_alphabet(characters)
+      (characters.is_a?(Array) ? characters : characters.chars).uniq
+    end
+
+    def sufficient_characters?(size)
+      size >= MIN_UNIQUE_CHARACTERS
+    end
+
+    def valid_equivalences?(equivalences, unique_characters)
+      return true if equivalences.nil?
+      return false unless equivalences.is_a?(Hash)
+
+      (unique_characters & equivalences.keys).empty? && (equivalences.values - unique_characters).empty?
+    end
+
+    def raise_invalid_alphabet!
+      raise InvalidAlphabetError, "Alphabet must be a string or array."
+    end
+
+    def raise_character_set_too_small!
+      raise InvalidAlphabetError, "Alphabet must contain at least #{MIN_UNIQUE_CHARACTERS} unique characters."
+    end
+
+    def raise_invalid_equivalences!
+      raise InvalidConfigurationError, "Character equivalences must be a hash or nil."
+    end
   end
 end

data/lib/encoded_id/hex_representation.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module EncodedId
+  class HexRepresentation
+    def initialize(hex_digit_encoding_group_size)
+      @hex_digit_encoding_group_size = validate_hex_digit_encoding_group_size(hex_digit_encoding_group_size)
+    end
+
+    def hex_as_integers(hexs)
+      integer_representation(hexs)
+    end
+
+    def integers_as_hex(integers)
+      integers_to_hex_strings(integers)
+    end
+
+    private
+
+    # Number of hex digits to encode in each group, larger values will result in shorter hashes for longer inputs.
+    # Vice versa for smaller values, ie a smaller value will result in smaller hashes for small inputs.
+    def validate_hex_digit_encoding_group_size(hex_digit_encoding_group_size)
+      if !hex_digit_encoding_group_size.is_a?(Integer) || hex_digit_encoding_group_size < 1 || hex_digit_encoding_group_size > 32
+        raise InvalidConfigurationError, "hex_digit_encoding_group_size must be > 0 and <= 32"
+      end
+      hex_digit_encoding_group_size
+    end
+
+    # Convert hex strings to integer representations
+    def integer_representation(hexs)
+      inputs = Array(hexs).map(&:to_s)
+      digits_to_encode = []
+
+      inputs.map { |hex_string| hex_string_as_integer_representation(hex_string) }.each do |integer_groups|
+        digits_to_encode.concat(integer_groups)
+        digits_to_encode << hex_string_separator
+      end
+
+      # Remove the last marker
+      digits_to_encode.pop unless digits_to_encode.empty?
+      digits_to_encode
+    end
+
+    # Convert integer representations to hex strings
+    def integers_to_hex_strings(integers)
+      hex_strings = []
+      hex_string = []
+      add_leading = false
+
+      integers.reverse_each do |integer|
+        if integer == hex_string_separator # Marker to separate hex strings, so start a new one
+          hex_strings << hex_string.join
+          hex_string = []
+          add_leading = false
+        else
+          hex_string << (add_leading ? "%.#{@hex_digit_encoding_group_size}x" % integer : integer.to_s(16))
+          add_leading = true
+        end
+      end
+
+      # Add the last hex string
+      hex_strings << hex_string.join unless hex_string.empty?
+      hex_strings.reverse
+    end
+
+    def hex_string_as_integer_representation(hex_string)
+      cleaned = remove_non_hex_characters(hex_string)
+      convert_to_integer_groups(cleaned)
+    end
+
+    # Marker to separate hex strings, must be greater than largest value encoded
+    def hex_string_separator
+      @hex_string_separator ||= 2.pow(@hex_digit_encoding_group_size * 4)
+    end
+
+    def remove_non_hex_characters(hex_string)
+      hex_string.gsub(/[^0-9a-f]/i, "")
+    end
+
+    def convert_to_integer_groups(hex_string_cleaned)
+      groups = []
+      hex_string_cleaned.chars.reverse.each_with_index do |char, i|
+        group_id = i / @hex_digit_encoding_group_size
+        groups[group_id] ||= []
+        groups[group_id].unshift(char)
+      end
+      groups.map { |c| c.join.to_i(16) }
+    end
+  end
+end

data/lib/encoded_id/reversible_id.rb

@@ -9,29 +9,12 @@ require "hashids"
 module EncodedId
   class ReversibleId
     def initialize(salt:, length: 8, split_at: 4, split_with: "-", alphabet: Alphabet.modified_crockford, hex_digit_encoding_group_size: 4)
-      raise InvalidAlphabetError, "alphabet must be an instance of Alphabet" unless alphabet.is_a?(Alphabet)
-      @alphabet = alphabet
-
-      raise InvalidConfigurationError, "Salt must be a string and longer that 3 characters" unless salt.is_a?(String) && salt.size > 3
-      @salt = salt
-      # Target length of the encoded string (the minimum but not maximum length)
-      raise InvalidConfigurationError, "Length must be an integer greater than 0" unless length.is_a?(Integer) && length > 0
-      @length = length
-      # Split the encoded string into groups of this size
-      unless (split_at.is_a?(Integer) && split_at > 0) || split_at.nil?
-        raise InvalidConfigurationError, "Split at must be an integer greater than 0 or nil"
-      end
-      @split_at = split_at
-      unless split_with.is_a?(String) && !alphabet.characters.include?(split_with)
-        raise InvalidConfigurationError, "Split with must be a string and not part of the alphabet"
-      end
-      @split_with = split_with
-      # Number of hex digits to encode in each group, larger values will result in shorter hashes for longer inputs.
-      # Vice versa for smaller values, ie a smaller value will result in smaller hashes for small inputs.
-      if hex_digit_encoding_group_size < 1 || hex_digit_encoding_group_size > 32
-        raise InvalidConfigurationError, "hex_digit_encoding_group_size must be > 0 and <= 32"
-      end
-      @hex_digit_encoding_group_size = hex_digit_encoding_group_size
+      @alphabet = validate_alphabet(alphabet)
+      @salt = validate_salt(salt)
+      @length = validate_length(length)
+      @split_at = validate_split_at(split_at)
+      @split_with = validate_split_with(split_with, alphabet)
+      @hex_represention_encoder = HexRepresentation.new(hex_digit_encoding_group_size)
     end
 
     # Encode the input values into a hash
@@ -44,7 +27,7 @@ module EncodedId
 
     # Encode hex strings into a hash
     def encode_hex(hexs)
-      encode(integer_representation(hexs))
+      encode(hex_represention_encoder.hex_as_integers(hexs))
     end
 
     # Decode the hash to original array
@@ -57,7 +40,7 @@ module EncodedId
     # Decode hex strings from a hash
     def decode_hex(str)
       integers = encoded_id_generator.decode(convert_to_hash(str))
-      integers_to_hex_strings(integers)
+      hex_represention_encoder.integers_as_hex(integers)
     end
 
     private
@@ -67,7 +50,38 @@ module EncodedId
       :alphabet,
       :split_at,
       :split_with,
-      :hex_digit_encoding_group_size
+      :hex_represention_encoder
+
+    def validate_alphabet(alphabet)
+      raise InvalidAlphabetError, "alphabet must be an instance of Alphabet" unless alphabet.is_a?(Alphabet)
+      alphabet
+    end
+
+    def validate_salt(salt)
+      raise InvalidConfigurationError, "Salt must be a string and longer than 3 characters" unless salt.is_a?(String) && salt.size > 3
+      salt
+    end
+
+    # Target length of the encoded string (the minimum but not maximum length)
+    def validate_length(length)
+      raise InvalidConfigurationError, "Length must be an integer greater than 0" unless length.is_a?(Integer) && length > 0
+      length
+    end
+
+    # Split the encoded string into groups of this size
+    def validate_split_at(split_at)
+      unless (split_at.is_a?(Integer) && split_at > 0) || split_at.nil?
+        raise InvalidConfigurationError, "Split at must be an integer greater than 0 or nil"
+      end
+      split_at
+    end
+
+    def validate_split_with(split_with, alphabet)
+      unless split_with.is_a?(String) && !alphabet.characters.include?(split_with)
+        raise InvalidConfigurationError, "Split with must be a string and not part of the alphabet"
+      end
+      split_with
+    end
 
     def prepare_input(value)
       inputs = value.is_a?(Array) ? value.map(&:to_i) : [value.to_i]
@@ -99,53 +113,5 @@ module EncodedId
         cleaned.tr(from, to)
       end
     end
-
-    # TODO: optimize this
-    def integer_representation(hexs)
-      inputs = hexs.is_a?(Array) ? hexs.map(&:to_s) : [hexs.to_s]
-      inputs.map! do |hex_string|
-        cleaned = hex_string.gsub(/[^0-9a-f]/i, "")
-        # Convert to groups of integers. Process least significant hex digits first
-        groups = []
-        cleaned.chars.reverse.each_with_index do |char, i|
-          group_id = i / hex_digit_encoding_group_size.to_i
-          groups[group_id] ||= []
-          groups[group_id].unshift(char)
-        end
-        groups.map { |c| c.join.to_i(16) }
-      end
-      digits_to_encode = []
-      inputs.each_with_object(digits_to_encode) do |hex_digits, digits|
-        digits.concat(hex_digits)
-        digits << hex_string_separator
-      end
-      digits_to_encode.pop unless digits_to_encode.empty? # Remove the last marker
-      digits_to_encode
-    end
-
-    # Marker to separate hex strings, must be greater than largest value encoded
-    def hex_string_separator
-      @hex_string_separator ||= 2.pow(hex_digit_encoding_group_size * 4)
-    end
-
-    # TODO: optimize this
-    def integers_to_hex_strings(integers)
-      hex_strings = []
-      hex_string = []
-      add_leading = false
-      # Digits are encoded in least significant digit first order, but string is most significant first, so reverse
-      integers.reverse_each do |integer|
-        if integer == hex_string_separator # Marker to separate hex strings, so start a new one
-          hex_strings << hex_string.join
-          hex_string = []
-          add_leading = false
-        else
-          hex_string << (add_leading ? "%.#{hex_digit_encoding_group_size}x" % integer : integer.to_s(16))
-          add_leading = true
-        end
-      end
-      hex_strings << hex_string.join unless hex_string.empty? # Add the last hex string
-      hex_strings.reverse # Reverse final values to get the original order (the encoding process also reverses the encoded value order)
-    end
   end
 end

data/lib/encoded_id/version.rb

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

data/lib/encoded_id.rb

@@ -2,6 +2,7 @@
 
 require_relative "encoded_id/version"
 require_relative "encoded_id/alphabet"
+require_relative "encoded_id/hex_representation"
 require_relative "encoded_id/reversible_id"
 
 module EncodedId

data/rbs_collection.yaml

@@ -9,8 +9,6 @@ sources:
 path: .gem_rbs_collection
 
 gems:
-  - name: encoded_id
-    ignore: true
   # Skip loading rbs gem's RBS.
   # It's unnecessary if you don't use rbs as a library.
   - name: rbs

data/sig/encoded_id.rbs

@@ -1,25 +1,65 @@
 module EncodedId
+  VERSION: ::String
+
+  InvalidConfigurationError: ::StandardError
   EncodedIdFormatError: ::ArgumentError
   InvalidAlphabetError: ::ArgumentError
   InvalidInputError: ::ArgumentError
 
   class Alphabet
+    MIN_UNIQUE_CHARACTERS: ::Integer
+
     def initialize: (String, ?::Hash[::String, ::String]) -> void
 
-    attr_reader alphabet: String
+    attr_reader characters: String
     attr_reader equivalences: ::Hash[::String, ::String]
 
     def self.modified_crockford: () -> Alphabet
+
+    private
+
+    def valid_input_characters?: ((::Array[::String] | ::String) characters) -> bool
+
+    def sufficient_characters?: (::Integer size) -> bool
+
+    def unique_character_alphabet: ((::Array[::String] | ::String) characters) -> ::Array[::String]
+
+    def valid_equivalences?: (::Hash[::String, ::String] equivalences, ::Array[::String] unique_characters) -> bool
+
+    def raise_character_set_too_small!: -> untyped
+
+    def raise_invalid_alphabet!: -> void
+
+    def raise_invalid_equivalences!: -> void
+  end
+
+  type encodeableValue = ::Array[::String | ::Integer] | ::String | ::Integer
+  type encodeableHexValue = ::Array[::String] | ::String
+
+  class HexRepresentation
+    def initialize: (::Integer) -> void
+    def hex_as_integers: (encodeableHexValue) -> ::Array[::Integer]
+    def integers_as_hex: (::Array[::Integer]) -> ::Array[::String]
+
+    private
+
+    def validate_hex_digit_encoding_group_size: (::Integer) -> ::Integer
+    def integer_representation: (encodeableHexValue) -> ::Array[::Integer]
+    def integers_to_hex_strings: (::Array[::Integer]) -> ::Array[::String]
+    def hex_string_as_integer_representation: (::String) -> ::Array[::Integer]
+    def hex_string_separator: -> ::Integer
+    def remove_non_hex_characters: (::String) -> ::String
+    def convert_to_integer_groups: (::String) -> ::Array[::Integer]
   end
 
   class ReversibleId
     def initialize: (salt: ::String, ?length: ::Integer, ?split_at: ::Integer, ?split_with: ::String, ?alphabet: Alphabet, ?hex_digit_encoding_group_size: ::Integer) -> void
 
     # Encode the input values into a hash
-    def encode: (untyped values) -> ::String
+    def encode: (encodeableValue values) -> ::String
 
     # Encode hex strings into a hash
-    def encode_hex: (untyped hexs) -> ::String
+    def encode_hex: (encodeableHexValue hexs) -> ::String
 
     # Decode the hash to original array
     def decode: (::String str) -> ::Array[::Integer]
@@ -42,7 +82,14 @@ module EncodedId
     attr_reader split_at: ::Integer | nil
     attr_reader split_with: ::String
 
-    attr_reader hex_digit_encoding_group_size: ::Integer
+    attr_reader hex_represention_encoder: HexRepresentation
+
+    def validate_alphabet: (Alphabet) -> Alphabet
+    def validate_salt: (::String) -> ::String
+    def validate_length: (::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
 
     def prepare_input: (untyped value) -> ::Array[::Integer]
 
@@ -55,11 +102,5 @@ module EncodedId
     def convert_to_hash: (::String str) -> ::String
 
     def map_equivalent_characters: (::String str) -> ::String
-
-    def integer_representation: (untyped hexs) -> ::Array[::Integer]
-
-    def integers_to_hex_strings: (::Array[::Integer] integers) -> ::Array[::String]
-
-    def hex_string_separator: () -> ::Integer
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: encoded_id
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.0.0.rc1
 platform: ruby
 authors:
 - Stephen Ierodiaconou
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-04 00:00:00.000000000 Z
+date: 2023-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashids
@@ -43,6 +43,7 @@ files:
 - Steepfile
 - lib/encoded_id.rb
 - lib/encoded_id/alphabet.rb
+- lib/encoded_id/hex_representation.rb
 - lib/encoded_id/reversible_id.rb
 - lib/encoded_id/version.rb
 - rbs_collection.yaml
@@ -66,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: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: EncodedId is a gem for creating reversible obfuscated IDs from numerical