typeid 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9fd64508061798a1cd16f694ee4f865e35987096c1c9b730ed7979a0c6612196
+  data.tar.gz: 4e1e14a858b81f912145dca7824c77f54ac88414e917435d8854607d3a676bbe
+SHA512:
+  metadata.gz: 67b7c8af3ed8ff21c2b34c3d28b46081b09678929cf1e7137df00945bb87a934270f326caadb5027cbb4408733cb36c7aeacbfc83ff03e2307d9d01371fb149f
+  data.tar.gz: ce574ff07880c53102cd72290d7b6227a6708487cefa4756e7ec6cdb02ff73d4d68a3607bc25da0a74aed8b82c7b68ac845faee804cc6024c344a7bb9c6655e0

data/lib/typeid/uuid/base32.rb

@@ -0,0 +1,107 @@
+class TypeID < String
+  class UUID < String
+    module Base32
+      ALPHABET = "0123456789abcdefghjkmnpqrstvwxyz".freeze
+
+      DEC = [
+        0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+        0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+        0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+        0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+        0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0x00, 0x01,
+        0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0xFF, 0xFF,
+        0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+        0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+        0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+        0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0x0A, 0x0B, 0x0C,
+        0x0D, 0x0E, 0x0F, 0x10, 0x11, 0xFF, 0x12, 0x13, 0xFF, 0x14,
+        0x15, 0xFF, 0x16, 0x17, 0x18, 0x19, 0x1A, 0xFF, 0x1B, 0x1C,
+        0x1D, 0x1E, 0x1F, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+        0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+        0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+        0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+        0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+        0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+        0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+        0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+        0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+        0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+        0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+        0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+        0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+        0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+      ].freeze
+
+      # @param bytes [Array<Integer>]
+      # @return [String]
+      def self.encode(bytes)
+        encoded = Array.new(26, 0)
+
+        # 10 byte timestamp
+        encoded[0] = ALPHABET[(bytes[0]&224)>>5]
+        encoded[1] = ALPHABET[bytes[0]&31]
+        encoded[2] = ALPHABET[(bytes[1]&248)>>3]
+        encoded[3] = ALPHABET[((bytes[1]&7)<<2)|((bytes[2]&192)>>6)]
+        encoded[4] = ALPHABET[(bytes[2]&62)>>1]
+        encoded[5] = ALPHABET[((bytes[2]&1)<<4)|((bytes[3]&240)>>4)]
+        encoded[6] = ALPHABET[((bytes[3]&15)<<1)|((bytes[4]&128)>>7)]
+        encoded[7] = ALPHABET[(bytes[4]&124)>>2]
+        encoded[8] = ALPHABET[((bytes[4]&3)<<3)|((bytes[5]&224)>>5)]
+        encoded[9] = ALPHABET[bytes[5]&31]
+
+        # 16 bytes of entropy
+        encoded[10] = ALPHABET[(bytes[6]&248)>>3]
+        encoded[11] = ALPHABET[((bytes[6]&7)<<2)|((bytes[7]&192)>>6)]
+        encoded[12] = ALPHABET[(bytes[7]&62)>>1]
+        encoded[13] = ALPHABET[((bytes[7]&1)<<4)|((bytes[8]&240)>>4)]
+        encoded[14] = ALPHABET[((bytes[8]&15)<<1)|((bytes[9]&128)>>7)]
+        encoded[15] = ALPHABET[(bytes[9]&124)>>2]
+        encoded[16] = ALPHABET[((bytes[9]&3)<<3)|((bytes[10]&224)>>5)]
+        encoded[17] = ALPHABET[bytes[10]&31]
+        encoded[18] = ALPHABET[(bytes[11]&248)>>3]
+        encoded[19] = ALPHABET[((bytes[11]&7)<<2)|((bytes[12]&192)>>6)]
+        encoded[20] = ALPHABET[(bytes[12]&62)>>1]
+        encoded[21] = ALPHABET[((bytes[12]&1)<<4)|((bytes[13]&240)>>4)]
+        encoded[22] = ALPHABET[((bytes[13]&15)<<1)|((bytes[14]&128)>>7)]
+        encoded[23] = ALPHABET[(bytes[14]&124)>>2]
+        encoded[24] = ALPHABET[((bytes[14]&3)<<3)|((bytes[15]&224)>>5)]
+        encoded[25] = ALPHABET[bytes[15]&31]
+
+        encoded.join
+      end
+
+      # @param string [String]
+      # @return [Array<Integer>]
+      def self.decode(string)
+        bytes = string.bytes
+
+        raise "invalid length" unless bytes.length == 26
+        raise "invalid base32 character" if bytes.any? { |byte| DEC[byte] == 0xFF }
+
+        output = Array.new(16, 0)
+
+        # 6 bytes timestamp (48 bits)
+        output[0] = ((DEC[bytes[0]] << 5) | DEC[bytes[1]]) & 0xFF
+        output[1] = ((DEC[bytes[2]] << 3) | (DEC[bytes[3]] >> 2)) & 0xFF
+        output[2] = ((DEC[bytes[3]] << 6) | (DEC[bytes[4]] << 1) | (DEC[bytes[5]] >> 4)) & 0xFF
+        output[3] = ((DEC[bytes[5]] << 4) | (DEC[bytes[6]] >> 1)) & 0xFF
+        output[4] = ((DEC[bytes[6]] << 7) | (DEC[bytes[7]] << 2) | (DEC[bytes[8]] >> 3)) & 0xFF
+        output[5] = ((DEC[bytes[8]] << 5) | DEC[bytes[9]]) & 0xFF
+
+        # 10 bytes of entropy (80 bits)
+        output[6] = ((DEC[bytes[10]] << 3) | (DEC[bytes[11]] >> 2)) & 0xFF
+        output[7] = ((DEC[bytes[11]] << 6) | (DEC[bytes[12]] << 1) | (DEC[bytes[13]] >> 4)) & 0xFF
+        output[8] = ((DEC[bytes[13]] << 4) | (DEC[bytes[14]] >> 1)) & 0xFF
+        output[9] = ((DEC[bytes[14]] << 7) | (DEC[bytes[15]] << 2) | (DEC[bytes[16]] >> 3)) & 0xFF
+        output[10] = ((DEC[bytes[16]] << 5) | DEC[bytes[17]]) & 0xFF
+        output[11] = ((DEC[bytes[18]] << 3) | DEC[bytes[19]]>>2) & 0xFF
+        output[12] = ((DEC[bytes[19]] << 6) | (DEC[bytes[20]] << 1) | (DEC[bytes[21]] >> 4)) & 0xFF
+        output[13] = ((DEC[bytes[21]] << 4) | (DEC[bytes[22]] >> 1)) & 0xFF
+        output[14] = ((DEC[bytes[22]] << 7) | (DEC[bytes[23]] << 2) | (DEC[bytes[24]] >> 3)) & 0xFF
+        output[15] = ((DEC[bytes[24]] << 5) | DEC[bytes[25]]) & 0xFF
+
+        output
+      end
+    end
+  end
+end

data/lib/typeid/uuid.rb

@@ -0,0 +1,59 @@
+require "uuid7"
+require_relative "./uuid/base32.rb"
+
+class TypeID < String
+  class UUID < String
+    attr_reader :bytes
+
+    # @param timestamp [Integer]
+    # @return [TypeID::UUID]
+    def self.generate(timestamp: Process.clock_gettime(Process::CLOCK_REALTIME, :millisecond))
+      from_string(UUID7.generate(timestamp: timestamp))
+    end
+
+    # @param string [String]
+    # @return [TypeID::UUID]
+    def self.from_base32(string)
+      new(TypeID::UUID::Base32.decode(string))
+    end
+
+    # @param string [String]
+    # @return [TypeID::UUID]
+    def self.from_string(string)
+      bytes = string
+        .tr("-", "")
+        .chars
+        .each_slice(2)
+        .map { |pair| pair.join.to_i(16) }
+
+      new(bytes)
+    end
+
+    # @param bytes [Array<Integer>]
+    def initialize(bytes)
+      @bytes = bytes
+
+      super(string)
+    end
+
+    # @return [String]
+    def base32
+      TypeID::UUID::Base32.encode(bytes)
+    end
+
+    # @return [String]
+    def inspect
+      "#<#{self.class.name} #{to_s}>"
+    end
+
+    private
+
+    # @return [String]
+    def string
+      bytes
+        .map
+        .with_index { |byte, index| ([4, 6, 8, 10].include?(index) ? "-%02x" : "%02x") % byte }
+        .join
+    end
+  end
+end

data/lib/typeid/version.rb

@@ -0,0 +1,3 @@
+class TypeID < String
+  VERSION = "0.1.0".freeze
+end

data/lib/typeid.rb

@@ -0,0 +1,82 @@
+require_relative "./typeid/uuid.rb"
+
+class TypeID < String
+  SUFFIX_LENGTH = 26
+  MAX_PREFIX_LENGTH = 63
+
+  class Error < StandardError; end
+
+  attr_reader :prefix
+  attr_reader :suffix
+  alias type prefix
+
+  # @param string [String]
+  # @return [TypeID]
+  def self.from_string(string)
+    case string.split("_")
+    in [suffix] then from("", suffix)
+    in [prefix, suffix]
+      raise Error, "prefix cannot be empty when there's a separator" if prefix.empty?
+
+      from(prefix, suffix)
+    else raise Error, "invalid typeid: #{string}"
+    end
+  end
+
+  # @param prefix [String]
+  # @param uuid [String]
+  # @return [TypeID]
+  def self.from_uuid(prefix, uuid)
+    from(prefix, TypeID::UUID.from_string(uuid).base32)
+  end
+
+  # @param prefix [String]
+  # @param suffix [String]
+  # @return [TypeID]
+  def self.from(prefix, suffix)
+    new(prefix, suffix: suffix)
+  end
+
+  # @return [TypeID]
+  def self.nil
+    from("", "0" * SUFFIX_LENGTH)
+  end
+
+  # @param prefix [String]
+  # @param timestamp [Integer]
+  # @param suffix [String]
+  def initialize(
+    prefix,
+    timestamp: Process.clock_gettime(Process::CLOCK_REALTIME, :millisecond),
+    suffix: TypeID::UUID.generate(timestamp: timestamp).base32
+  )
+    raise Error, "prefix length cannot be greater than #{MAX_PREFIX_LENGTH}" if prefix.length > MAX_PREFIX_LENGTH
+    raise Error, "prefix must be lowercase ASCII characters" unless prefix.match?(/^[a-z]*$/)
+    raise Error, "suffix must be #{SUFFIX_LENGTH} characters" unless suffix.length == SUFFIX_LENGTH
+    raise Error, "suffix must only contain the letters in '#{TypeID::UUID::Base32::ALPHABET}'" unless suffix.chars.all? { |char| TypeID::UUID::Base32::ALPHABET.include?(char) }
+
+    @prefix = prefix
+    @suffix = suffix
+
+    super(string)
+  end
+
+  # @return [TypeID::UUID]
+  def uuid
+    TypeID::UUID.from_base32(suffix)
+  end
+
+  # @return [String]
+  def inspect
+    "#<#{self.class.name} #{self}>"
+  end
+
+  private
+
+  # @return [String]
+  def string
+    return suffix if prefix.empty?
+
+    "#{prefix}_#{suffix}"
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: typeid
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Booth
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: uuid7
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.2
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/typeid.rb
+- lib/typeid/uuid.rb
+- lib/typeid/uuid/base32.rb
+- lib/typeid/version.rb
+homepage: https://github.com/broothie/typeid-ruby
+licenses:
+- Apache
+metadata:
+  source_code_uri: https://github.com/broothie/typeid-ruby
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: A type-safe, K-sortable, globally unique identifier inspired by Stripe IDs
+test_files: []