ruby-ulid 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d7356366d0184815a725d1947f4f685b3abba0320ae60800b5a015dc7c649e9
-  data.tar.gz: 04b55b6d92dbf02865a7803be352f5cd385f3417c061269f2ad197474202154d
+  metadata.gz: 82f48c45c124521403b04938ec4498a85bf292645357d75f32173cc2b9613618
+  data.tar.gz: 9c6269cbef649b57df980d120116687cdcc33e505cb45585b4566f4b16f3cdf2
 SHA512:
-  metadata.gz: aa826d204cbdc1e6850fbeab278dc72e5b683926db9af7ed477ec2e74837d32829dbfb468c1156d6dcf5be604f9fdeb8fd0a282999b47a627884152b2a2cd5d4
-  data.tar.gz: 0b1208e76af50f9952c8c4835d1410c7e1fd114313cc71d39a143c9bc04ac4f1a35ba49be88a49406606c441e4f4fa7cad5fc938d74fcecde0d612319a6890b3
+  metadata.gz: 817d5589c2967d8d1b787ce20c147483cd12769eba22a0489ade4002285e1edc31e06f9e5d8dd590d3cf2342d2875c388818e55b95cbd1d72921b1848287483f
+  data.tar.gz: 6bcacebe7955bb247127ddc64df1fec2cc776954e7c86530750c200da5420fd4cbb73d5fd2f0888cb37ff5f097987dd12f372ee591adccb8b35f35e03e4f0538

data/README.md

@@ -49,7 +49,7 @@ Should be installed!
 Add this line in your Gemfile.
 
 ```ruby
-gem('ruby-ulid', '~> 0.5.0')
+gem('ruby-ulid', '~> 0.6.0')
 ```
 
 ### How to use
@@ -58,33 +58,31 @@ gem('ruby-ulid', '~> 0.5.0')
 require 'ulid'
 
 ULID::VERSION
-# => "0.5.0"
+# => "0.6.0"
 ```
 
-### Basic Generator
+NOTE: This README includes info about development version. If you would see released version's one. [Look at the ref](https://github.com/kachick/ruby-ulid/tree/v0.6.0).
 
-The generated `ULID` is an object not just a string.
+### Generator and Parser
+
+`ULID.generate` returns `ULID` instance. It is not just a string.
 
 ```ruby
 ulid = ULID.generate #=> ULID(2021-04-27 17:27:22.826 UTC: 01F4A5Y1YAQCYAYCTC7GRMJ9AA)
 ```
 
-### Parser
-
-Get the objects from exists encoded ULIDs.
+`ULID.parse` returns `ULID` instance from exists encoded ULIDs.
 
 ```ruby
-ulid = ULID.parse('01ARZ3NDEKTSV4RRFFQ69G5FAV') #=> ULID(2016-07-30 23:54:10.259 UTC: 01ARZ3NDEKTSV4RRFFQ69G5FAV)
+ulid = ULID.parse('01F4A5Y1YAQCYAYCTC7GRMJ9AA') #=> ULID(2021-04-27 17:27:22.826 UTC: 01F4A5Y1YAQCYAYCTC7GRMJ9AA)
 ```
 
-### ULID object
-
-Extract timestamps and binary formats.
+It is helpful to inspect.
 
 ```ruby
-ulid = ULID.parse('01F4A5Y1YAQCYAYCTC7GRMJ9AA') #=> ULID(2021-04-27 17:27:22.826 UTC: 01F4A5Y1YAQCYAYCTC7GRMJ9AA)
 ulid.to_time #=> 2021-04-27 17:27:22.826 UTC
 ulid.milliseconds #=> 1619544442826
+ulid.encode #=> "01F4A5Y1YAQCYAYCTC7GRMJ9AA"
 ulid.to_s #=> "01F4A5Y1YAQCYAYCTC7GRMJ9AA"
 ulid.timestamp #=> "01F4A5Y1YA"
 ulid.randomness #=> "QCYAYCTC7GRMJ9AA"
@@ -92,6 +90,42 @@ ulid.to_i #=> 1957909092946624190749577070267409738
 ulid.octets #=> [1, 121, 20, 95, 7, 202, 187, 60, 175, 51, 76, 60, 49, 73, 37, 74]
 ```
 
+`ULID.generate` can take fixed `Time` instance. `ULID.at` is the shorthand.
+
+```ruby
+time = Time.at(946684800).utc #=> 2000-01-01 00:00:00 UTC
+ULID.generate(moment: time) #=> ULID(2000-01-01 00:00:00.000 UTC: 00VHNCZB00N018DCPJA4H9379P)
+ULID.generate(moment: time) #=> ULID(2000-01-01 00:00:00.000 UTC: 00VHNCZB006WQT3JTMN0T14EBP)
+ULID.at(time) #=> ULID(2000-01-01 00:00:00.000 UTC: 00VHNCZB002W5BGWWKN76N22H6)
+```
+
+Also `ULID.encode` and `ULID.decode_time` can be used to get primitive values for most usecases.  
+
+`ULID.encode` returns [normalized](#variants-of-format) String without ULID object creation.  
+It can take same arguments as `ULID.generate`.
+
+```ruby
+ULID.encode #=> "01G86M42Q6SJ9XQM2ZRM6JRDSF"
+ULID.encode(moment: Time.at(946684800).utc) #=> "00VHNCZB00SYG7RCEXZC9DA4E1"
+```
+
+`ULID.decode_time` returns Time. It can take `in` keyarg as same as `Time.at`.
+
+```ruby
+ULID.decode_time('00VHNCZB00SYG7RCEXZC9DA4E1') #=> 2000-01-01 00:00:00 UTC
+ULID.decode_time('00VHNCZB00SYG7RCEXZC9DA4E1', in: '+09:00') #=> 2000-01-01 09:00:00 +0900
+```
+
+This project does not prioritize the speed. However it actually works faster than others! :zap:
+
+Snapshot on 0.6.0 is below
+
+* Generator is 1.4x faster than - [ulid gem](https://github.com/rafaelsales/ulid)
+* Generator is 1.7x faster than - [ulid-ruby gem](https://github.com/abachman/ulid-ruby)
+* Parser is 2.6x faster than - [ulid-ruby gem](https://github.com/abachman/ulid-ruby)
+
+You can see further detail at [Benchmark](https://github.com/kachick/ruby-ulid/wiki/Benchmark).
+
 ### Sortable with the timestamp
 
 ULIDs are sortable when they are generated in different timestamp with milliseconds precision.
@@ -105,20 +139,6 @@ ulids.uniq(&:to_time).size #=> 1000
 ulids.sort == ulids #=> true
 ```
 
-`ULID.generate` can take fixed `Time` instance. The shorthand is `ULID.at`.
-
-```ruby
-time = Time.at(946684800).utc #=> 2000-01-01 00:00:00 UTC
-ULID.generate(moment: time) #=> ULID(2000-01-01 00:00:00.000 UTC: 00VHNCZB00N018DCPJA4H9379P)
-ULID.generate(moment: time) #=> ULID(2000-01-01 00:00:00.000 UTC: 00VHNCZB006WQT3JTMN0T14EBP)
-ULID.at(time) #=> ULID(2000-01-01 00:00:00.000 UTC: 00VHNCZB002W5BGWWKN76N22H6)
-
-ulids = 1000.times.map do |n|
-  ULID.at(time + n)
-end
-ulids.sort == ulids #=> true
-```
-
 Basic generator prefers `randomness`, it does not guarantee `sortable` for same milliseconds ULIDs.
 
 ```ruby
@@ -161,7 +181,7 @@ sample_ulids_by_the_time.take(5) #=>
 ulids.sort == ulids #=> true
 ```
 
-Same generator does not generate duplicated ULIDs even in multi threads environment. It is implemented with [Monitor](https://bugs.ruby-lang.org/issues/16255).
+Same instance of `ULID::MonotonicGenerator` does not generate duplicated ULIDs even in multi threads environment. It is implemented with [Monitor](https://bugs.ruby-lang.org/issues/16255).
 
 ### Filtering IDs with `Time`
 
@@ -277,7 +297,7 @@ ULID.max(time) #=> ULID(2000-01-01 00:00:00.123 UTC: 00VHNCZB3VZZZZZZZZZZZZZZZZ)
 `ULID#next` and `ULID#succ` returns next(successor) ULID.
 Especially `ULID#succ` makes it possible `Range[ULID]#each`.
 
-NOTE: However basically `Range[ULID]#each` should not be used. Iincrementing 128 bits IDs are not reasonable operation in most cases.
+NOTE: However basically `Range[ULID]#each` should not be used. Incrementing 128 bits IDs are not reasonable operation in most cases.
 
 ```ruby
 ULID.parse('01BX5ZZKBKZZZZZZZZZZZZZZZY').next.to_s #=> "01BX5ZZKBKZZZZZZZZZZZZZZZZ"

data/lib/ulid/crockford_base32.rb

@@ -15,63 +15,62 @@ class ULID
   #   * https://github.com/kachick/ruby-ulid/issues/57
   #   * https://github.com/kachick/ruby-ulid/issues/78
   module CrockfordBase32
-    class SetupError < UnexpectedError; end
-
-    n32_chars = [*'0'..'9', *'A'..'V'].map(&:freeze).freeze
-    raise(SetupError, 'obvious bug exists in the mapping algorithm') unless n32_chars.size == 32
-
-    n32_char_by_number = {}
-    n32_chars.each_with_index do |char, index|
-      n32_char_by_number[index] = char
-    end
-    n32_char_by_number.freeze
-
-    crockford_base32_mappings = {
-      'J' => 18,
-      'K' => 19,
-      'M' => 20,
-      'N' => 21,
-      'P' => 22,
-      'Q' => 23,
-      'R' => 24,
-      'S' => 25,
-      'T' => 26,
-      'V' => 27,
-      'W' => 28,
-      'X' => 29,
-      'Y' => 30,
-      'Z' => 31
+    # Excluded I, L, O, U, - from Base32
+    base32_to_crockford = {
+      '0' => '0',
+      '1' => '1',
+      '2' => '2',
+      '3' => '3',
+      '4' => '4',
+      '5' => '5',
+      '6' => '6',
+      '7' => '7',
+      '8' => '8',
+      '9' => '9',
+      'A' => 'A',
+      'B' => 'B',
+      'C' => 'C',
+      'D' => 'D',
+      'E' => 'E',
+      'F' => 'F',
+      'G' => 'G',
+      'H' => 'H',
+      'I' => 'J',
+      'J' => 'K',
+      'K' => 'M',
+      'L' => 'N',
+      'M' => 'P',
+      'N' => 'Q',
+      'O' => 'R',
+      'P' => 'S',
+      'Q' => 'T',
+      'R' => 'V',
+      'S' => 'W',
+      'T' => 'X',
+      'U' => 'Y',
+      'V' => 'Z'
     }.freeze
+    BASE32_TR_PATTERN = base32_to_crockford.keys.join.freeze
+    ENCODING_STRING = CROCKFORD_BASE32_TR_PATTERN = base32_to_crockford.values.freeze.join.freeze
 
-    N32_CHAR_BY_CROCKFORD_BASE32_CHAR = CROCKFORD_BASE32_ENCODING_STRING.chars.map(&:freeze).each_with_object({}) do |encoding_char, map|
-      if n = crockford_base32_mappings[encoding_char]
-        char_32 = n32_char_by_number.fetch(n)
-        map[encoding_char] = char_32
-      end
-    end.freeze
-    raise(SetupError, 'obvious bug exists in the mapping algorithm') unless N32_CHAR_BY_CROCKFORD_BASE32_CHAR.keys == crockford_base32_mappings.keys
-
-    CROCKFORD_BASE32_CHAR_PATTERN = /[#{N32_CHAR_BY_CROCKFORD_BASE32_CHAR.keys.join}]/.freeze
-
-    CROCKFORD_BASE32_CHAR_BY_N32_CHAR = N32_CHAR_BY_CROCKFORD_BASE32_CHAR.invert.freeze
-    N32_CHAR_PATTERN = /[#{CROCKFORD_BASE32_CHAR_BY_N32_CHAR.keys.join}]/.freeze
-
-    STANDARD_BY_VARIANT = {
+    normarized_by_variant = {
       'L' => '1',
       'l' => '1',
       'I' => '1',
       'i' => '1',
       'O' => '0',
-      'o' => '0',
-      '-' => ''
+      'o' => '0'
     }.freeze
-    VARIANT_PATTERN = /[#{STANDARD_BY_VARIANT.keys.join}]/.freeze
+    VARIANT_TR_PATTERN = normarized_by_variant.keys.join.freeze
+    NORMALIZED_TR_PATTERN = normarized_by_variant.values.join.freeze
+
+    # @note Avoid to depend regex as possible. `tr(string, string)` is almost 2x Faster than `gsub(regex, hash)` in Ruby 3.1
 
     # @api private
     # @param [String] string
     # @return [Integer]
     def self.decode(string)
-      n32encoded = string.upcase.gsub(CROCKFORD_BASE32_CHAR_PATTERN, N32_CHAR_BY_CROCKFORD_BASE32_CHAR)
+      n32encoded = string.upcase.tr(CROCKFORD_BASE32_TR_PATTERN, BASE32_TR_PATTERN)
       n32encoded.to_i(32)
     end
 
@@ -80,14 +79,21 @@ class ULID
     # @return [String]
     def self.encode(integer)
       n32encoded = integer.to_s(32)
-      n32encoded.upcase.gsub(N32_CHAR_PATTERN, CROCKFORD_BASE32_CHAR_BY_N32_CHAR).rjust(ENCODED_LENGTH, '0')
+      from_n32(n32encoded).rjust(ENCODED_LENGTH, '0')
     end
 
     # @api private
     # @param [String] string
     # @return [String]
     def self.normalize(string)
-      string.gsub(VARIANT_PATTERN, STANDARD_BY_VARIANT)
+      string.delete('-').tr(VARIANT_TR_PATTERN, NORMALIZED_TR_PATTERN)
+    end
+
+    # @api private
+    # @param [String] n32encoded
+    # @return [String]
+    def self.from_n32(n32encoded)
+      n32encoded.upcase.tr(BASE32_TR_PATTERN, CROCKFORD_BASE32_TR_PATTERN)
     end
   end
 end

data/lib/ulid/errors.rb

@@ -0,0 +1,10 @@
+# coding: us-ascii
+# frozen_string_literal: true
+# shareable_constant_value: literal
+
+class ULID
+  class Error < StandardError; end
+  class OverflowError < Error; end
+  class ParserError < Error; end
+  class UnexpectedError < Error; end
+end

data/lib/ulid/monotonic_generator.rb

@@ -10,7 +10,6 @@ class ULID
     #       However it is a C extention, I'm pending to use it for now.
     include(MonitorMixin)
 
-    # @dynamic prev
     # @return [ULID, nil]
     attr_reader(:prev)
 
@@ -25,7 +24,6 @@ class ULID
     def inspect
       "ULID::MonotonicGenerator(prev: #{@prev.inspect})"
     end
-    # @dynamic to_s
     alias_method(:to_s, :inspect)
 
     # @param [Time, Integer] moment
@@ -70,6 +68,12 @@ class ULID
       end
     end
 
+    # @param [Time, Integer] moment
+    # @return [String]
+    def encode(moment: ULID.current_milliseconds)
+      generate(moment: moment).encode
+    end
+
     undef_method(:freeze)
 
     # @raise [TypeError] always raises exception and does not freeze self

data/lib/ulid/version.rb

@@ -3,5 +3,5 @@
 # shareable_constant_value: literal
 
 class ULID
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

data/lib/ulid.rb

@@ -6,6 +6,11 @@
 
 require('securerandom')
 
+require_relative('ulid/version')
+require_relative('ulid/errors')
+require_relative('ulid/crockford_base32')
+require_relative('ulid/monotonic_generator')
+
 # @see https://github.com/ulid/spec
 # @!attribute [r] milliseconds
 #   @return [Integer]
@@ -14,16 +19,6 @@ require('securerandom')
 class ULID
   include(Comparable)
 
-  class Error < StandardError; end
-  class OverflowError < Error; end
-  class ParserError < Error; end
-  class UnexpectedError < Error; end
-
-  # Excluded I, L, O, U, -.
-  # This is the encoding patterns.
-  # The decoding issue is written in ULID::CrockfordBase32
-  CROCKFORD_BASE32_ENCODING_STRING = '0123456789ABCDEFGHJKMNPQRSTVWXYZ'
-
   TIMESTAMP_ENCODED_LENGTH = 10
   RANDOMNESS_ENCODED_LENGTH = 16
   ENCODED_LENGTH = 26
@@ -38,12 +33,12 @@ class ULID
 
   # @see https://github.com/ulid/spec/pull/57
   # Currently not used as a constant, but kept as a reference for now.
-  PATTERN_WITH_CROCKFORD_BASE32_SUBSET = /(?<timestamp>[0-7][#{CROCKFORD_BASE32_ENCODING_STRING}]{#{TIMESTAMP_ENCODED_LENGTH - 1}})(?<randomness>[#{CROCKFORD_BASE32_ENCODING_STRING}]{#{RANDOMNESS_ENCODED_LENGTH}})/i.freeze
+  PATTERN_WITH_CROCKFORD_BASE32_SUBSET = /(?<timestamp>[0-7][#{CrockfordBase32::ENCODING_STRING}]{#{TIMESTAMP_ENCODED_LENGTH - 1}})(?<randomness>[#{CrockfordBase32::ENCODING_STRING}]{#{RANDOMNESS_ENCODED_LENGTH}})/i.freeze
 
   STRICT_PATTERN_WITH_CROCKFORD_BASE32_SUBSET = /\A#{PATTERN_WITH_CROCKFORD_BASE32_SUBSET.source}\z/i.freeze
 
   # Optimized for `ULID.scan`, might be changed the definition with gathered `ULID.scan` spec changed.
-  SCANNING_PATTERN = /\b[0-7][#{CROCKFORD_BASE32_ENCODING_STRING}]{#{TIMESTAMP_ENCODED_LENGTH - 1}}[#{CROCKFORD_BASE32_ENCODING_STRING}]{#{RANDOMNESS_ENCODED_LENGTH}}\b/i.freeze
+  SCANNING_PATTERN = /\b[0-7][#{CrockfordBase32::ENCODING_STRING}]{#{TIMESTAMP_ENCODED_LENGTH - 1}}[#{CrockfordBase32::ENCODING_STRING}]{#{RANDOMNESS_ENCODED_LENGTH}}\b/i.freeze
 
   # Similar as Time#inspect since Ruby 2.7, however it is NOT same.
   # Time#inspect trancates needless digits. Keeping full milliseconds with "%3N" will fit for ULID.
@@ -60,6 +55,16 @@ class ULID
     from_milliseconds_and_entropy(milliseconds: milliseconds_from_moment(moment), entropy: entropy)
   end
 
+  # Almost same as [.generate] except directly returning String without needless object creation
+  #
+  # @param [Integer, Time] moment
+  # @param [Integer] entropy
+  # @return [String]
+  def self.encode(moment: current_milliseconds, entropy: reasonable_entropy)
+    n32_encoded = encode_n32(milliseconds: milliseconds_from_moment(moment), entropy: entropy)
+    CrockfordBase32.from_n32(n32_encoded)
+  end
+
   # Short hand of `ULID.generate(moment: time)`
   # @param [Time] time
   # @return [ULID]
@@ -166,7 +171,12 @@ class ULID
     milliseconds = n32encoded_timestamp.to_i(32)
     entropy = n32encoded_randomness.to_i(32)
 
-    new(milliseconds: milliseconds, entropy: entropy, integer: integer)
+    new(
+      milliseconds: milliseconds,
+      entropy: entropy,
+      integer: integer,
+      encoded: CrockfordBase32.from_n32(n32encoded).freeze
+    )
   end
 
   # @param [Range<Time>, Range<nil>, Range[ULID]] period
@@ -254,6 +264,17 @@ class ULID
     SecureRandom.random_number(MAX_ENTROPY)
   end
 
+  private_class_method def self.encode_n32(milliseconds:, entropy:)
+    raise(ArgumentError, 'milliseconds and entropy should be an `Integer`') unless Integer === milliseconds && Integer === entropy
+    raise(OverflowError, "timestamp overflow: given #{milliseconds}, max: #{MAX_MILLISECONDS}") unless milliseconds <= MAX_MILLISECONDS
+    raise(OverflowError, "entropy overflow: given #{entropy}, max: #{MAX_ENTROPY}") unless entropy <= MAX_ENTROPY
+    raise(ArgumentError, 'milliseconds and entropy should not be negative') if milliseconds.negative? || entropy.negative?
+
+    n32encoded_timestamp = milliseconds.to_s(32).rjust(TIMESTAMP_ENCODED_LENGTH, '0')
+    n32encoded_randomness = entropy.to_s(32).rjust(RANDOMNESS_ENCODED_LENGTH, '0')
+    "#{n32encoded_timestamp}#{n32encoded_randomness}"
+  end
+
   # @param [String, #to_str] string
   # @return [ULID]
   # @raise [ParserError] if the given format is not correct for ULID specs
@@ -279,6 +300,25 @@ class ULID
     parse(normalized_in_crockford)
   end
 
+  # Almost same as `ULID.parse(string).to_time` except directly returning Time instance without needless object creation
+  #
+  # @param [String, #to_str] string
+  # @return [Time]
+  # @raise [ParserError] if the given format is not correct for ULID specs
+  def self.decode_time(string, in: 'UTC')
+    in_for_time_at = binding.local_variable_get(:in) # Needed because `in` is a reserved word.
+    string = String.try_convert(string)
+    raise(ArgumentError, 'ULID.decode_time takes only strings') unless string
+
+    unless STRICT_PATTERN_WITH_CROCKFORD_BASE32_SUBSET.match?(string)
+      raise(ParserError, "given `#{string}` does not match to `#{STRICT_PATTERN_WITH_CROCKFORD_BASE32_SUBSET.inspect}`")
+    end
+
+    timestamp = string.slice(0, TIMESTAMP_ENCODED_LENGTH).freeze || raise(UnexpectedError)
+
+    Time.at(0, CrockfordBase32.decode(timestamp), :millisecond, in: in_for_time_at)
+  end
+
   # @param [String, #to_str] string
   # @return [String]
   # @raise [ParserError] if the given format is not correct for ULID specs, even if ignored `orthographical variants of the format`
@@ -303,7 +343,7 @@ class ULID
   # @param [String, #to_str] string
   # @return [Boolean]
   def self.valid_as_variant_format?(string)
-    normalize(string)
+    parse_variant_format(string)
   rescue Exception
     false
   else
@@ -378,37 +418,36 @@ class ULID
   # @raise [OverflowError] if the given value is larger than the ULID limit
   # @raise [ArgumentError] if the given milliseconds and/or entropy is negative number
   def self.from_milliseconds_and_entropy(milliseconds:, entropy:)
-    raise(ArgumentError, 'milliseconds and entropy should be an `Integer`') unless Integer === milliseconds && Integer === entropy
-    raise(OverflowError, "timestamp overflow: given #{milliseconds}, max: #{MAX_MILLISECONDS}") unless milliseconds <= MAX_MILLISECONDS
-    raise(OverflowError, "entropy overflow: given #{entropy}, max: #{MAX_ENTROPY}") unless entropy <= MAX_ENTROPY
-    raise(ArgumentError, 'milliseconds and entropy should not be negative') if milliseconds.negative? || entropy.negative?
-
-    n32encoded_timestamp = milliseconds.to_s(32).rjust(TIMESTAMP_ENCODED_LENGTH, '0')
-    n32encoded_randomness = entropy.to_s(32).rjust(RANDOMNESS_ENCODED_LENGTH, '0')
-    integer = (n32encoded_timestamp + n32encoded_randomness).to_i(32)
-
-    new(milliseconds: milliseconds, entropy: entropy, integer: integer)
+    n32_encoded = encode_n32(milliseconds: milliseconds, entropy: entropy)
+    new(
+      milliseconds: milliseconds,
+      entropy: entropy,
+      integer: n32_encoded.to_i(32),
+      encoded: CrockfordBase32.from_n32(n32_encoded).upcase.freeze
+    )
   end
 
-  # @dynamic milliseconds, entropy
   attr_reader(:milliseconds, :entropy)
 
   # @api private
   # @param [Integer] milliseconds
   # @param [Integer] entropy
   # @param [Integer] integer
+  # @param [String] encoded
   # @return [void]
-  def initialize(milliseconds:, entropy:, integer:)
+  def initialize(milliseconds:, entropy:, integer:, encoded:)
     # All arguments check should be done with each constructors, not here
     @integer = integer
+    @encoded = encoded
     @milliseconds = milliseconds
     @entropy = entropy
   end
 
   # @return [String]
-  def to_s
-    @string ||= CrockfordBase32.encode(@integer).freeze
+  def encode
+    @encoded
   end
+  alias_method(:to_s, :encode)
 
   # @return [Integer]
   def to_i
@@ -427,14 +466,13 @@ class ULID
 
   # @return [String]
   def inspect
-    @inspect ||= "ULID(#{to_time.strftime(TIME_FORMAT_IN_INSPECT)}: #{to_s})".freeze
+    @inspect ||= "ULID(#{to_time.strftime(TIME_FORMAT_IN_INSPECT)}: #{@encoded})".freeze
   end
 
   # @return [Boolean]
   def eql?(other)
     equal?(other) || (ULID === other && @integer == other.to_i)
   end
-  # @dynamic ==
   alias_method(:==, :eql?)
 
   # Return `true` for same value of ULID, variant formats of strings, same Time in ULID precision(msec).
@@ -449,11 +487,9 @@ class ULID
       @integer == other.to_i
     when String
       begin
-        normalized = ULID.normalize(other)
+        to_i == ULID.parse_variant_format(other).to_i
       rescue Exception
         false
-      else
-        to_s == normalized
       end
     when Time
       to_time == ULID.floor(other)
@@ -488,12 +524,12 @@ class ULID
 
   # @return [String]
   def timestamp
-    @timestamp ||= (to_s.slice(0, TIMESTAMP_ENCODED_LENGTH).freeze || raise(UnexpectedError))
+    @timestamp ||= (@encoded.slice(0, TIMESTAMP_ENCODED_LENGTH).freeze || raise(UnexpectedError))
   end
 
   # @return [String]
   def randomness
-    @randomness ||= (to_s.slice(TIMESTAMP_ENCODED_LENGTH, RANDOMNESS_ENCODED_LENGTH).freeze || raise(UnexpectedError))
+    @randomness ||= (@encoded.slice(TIMESTAMP_ENCODED_LENGTH, RANDOMNESS_ENCODED_LENGTH).freeze || raise(UnexpectedError))
   end
 
   # @note Providing for rough operations. The keys and values is not fixed.
@@ -519,7 +555,6 @@ class ULID
       ULID.from_integer(succ_int)
     end
   end
-  # @dynamic next
   alias_method(:next, :succ)
 
   # @return [ULID, nil] when called on ULID as `00000000000000000000000000`, returns `nil` instead of ULID
@@ -554,7 +589,7 @@ class ULID
   # @return [void]
   def marshal_load(integer)
     unmarshaled = ULID.from_integer(integer)
-    initialize(integer: unmarshaled.to_i, milliseconds: unmarshaled.milliseconds, entropy: unmarshaled.entropy)
+    initialize(integer: unmarshaled.to_i, milliseconds: unmarshaled.milliseconds, entropy: unmarshaled.entropy, encoded: unmarshaled.to_s)
   end
 
   # @return [self]
@@ -584,12 +619,9 @@ class ULID
   end
 end
 
-require_relative('ulid/version')
-require_relative('ulid/crockford_base32')
-require_relative('ulid/monotonic_generator')
 require_relative('ulid/ractor_unshareable_constants')
 
 class ULID
   # Do not write as `ULID.private_constant` for avoiding YARD warnings `[warn]: in YARD::Handlers::Ruby::PrivateConstantHandler: Undocumentable private constants:`
-  private_constant(:TIME_FORMAT_IN_INSPECT, :MIN, :MAX, :RANDOM_INTEGER_GENERATOR, :CROCKFORD_BASE32_ENCODING_STRING)
+  private_constant(:TIME_FORMAT_IN_INSPECT, :MIN, :MAX, :RANDOM_INTEGER_GENERATOR)
 end

data/sig/ulid.rbs

@@ -1,6 +1,5 @@
 class ULID < Object
   VERSION: String
-  CROCKFORD_BASE32_ENCODING_STRING: String
   TIMESTAMP_ENCODED_LENGTH: 10
   RANDOMNESS_ENCODED_LENGTH: 16
   ENCODED_LENGTH: 26
@@ -39,12 +38,11 @@ class ULID < Object
     class SetupError < UnexpectedError
     end
 
-    N32_CHAR_BY_CROCKFORD_BASE32_CHAR: Hash[String, String]
-    CROCKFORD_BASE32_CHAR_PATTERN: Regexp
-    CROCKFORD_BASE32_CHAR_BY_N32_CHAR: Hash[String, String]
-    N32_CHAR_PATTERN: Regexp
-    STANDARD_BY_VARIANT: Hash[String, String]
-    VARIANT_PATTERN: Regexp
+    ENCODING_STRING: String
+    CROCKFORD_BASE32_TR_PATTERN: String
+    BASE32_TR_PATTERN: String
+    VARIANT_TR_PATTERN: String
+    NORMALIZED_TR_PATTERN: String
 
     # A private API. Should not be used in your code.
     def self.encode: (Integer integer) -> String
@@ -54,6 +52,9 @@ class ULID < Object
 
     # A private API. Should not be used in your code.
     def self.normalize: (String string) -> String
+
+    # A private API. Should not be used in your code.
+    def self.from_n32: (String n32encoded) -> String
   end
 
   class MonotonicGenerator
@@ -78,6 +79,9 @@ class ULID < Object
     # The `Thread-safety` is implemented with [Monitor](https://bugs.ruby-lang.org/issues/16255)
     def generate: (?moment: moment) -> ULID
 
+    # Just providing similar api as `ULID.generate` and `ULID.encode` relation. No performance benefit exists in monotonic generator's one.
+    def encode: (?moment: moment) -> String
+
     # Returned value is `basically not` Thread-safety
     # If you want to keep Thread-safety, keep to call {#generate} only in same {#synchronize} block
     #
@@ -102,8 +106,8 @@ class ULID < Object
   type randomness_octets = [Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer] | Array[Integer]
   type period = Range[Time] | Range[nil] | Range[ULID]
 
-  @string: String?
   @integer: Integer
+  @encoded: String
   @timestamp: String?
   @randomness: String?
   @inspect: String?
@@ -145,6 +149,16 @@ class ULID < Object
   #
   def self.generate: (?moment: moment, ?entropy: Integer) -> ULID
 
+  # Retuns encoded and normalzied String.
+  # It has same arguments signatures as `.generate`. So can be used for just ID creation usecases without needless object creation.
+  #
+  # NOTE: Difference of ULID#encode, returned String is NOT frozen.
+  #
+  def self.encode: (?moment: moment, ?entropy: Integer) -> String
+
+  # A private API. Should not be used in your code.
+  def self.encode_n32: (milliseconds: Integer, entropy: Integer) -> String
+
   # Shorthand of `ULID.generate(moment: Time)`
   # See also [ULID.generate](https://kachick.github.io/ruby-ulid/ULID.html#generate-class_method)
   #
@@ -205,7 +219,7 @@ class ULID < Object
   # ```
   def self.floor: (Time time) -> Time
 
-  # Get ULID instance from encoded String.
+  # Return ULID instance from encoded String.
   #
   # ```ruby
   # ulid = ULID.parse('01ARZ3NDEKTSV4RRFFQ69G5FAV')
@@ -213,6 +227,17 @@ class ULID < Object
   # ```
   def self.parse: (_ToStr string) -> ULID
 
+  # Return Time instance from encoded String.
+  # See also `ULID.encode` for similar purpose.
+  #
+  # NOTE: Difference of ULID#to_time, returned Time is NOT frozen.
+  #
+  # ```ruby
+  # time = ULID.decode_time('01ARZ3NDEKTSV4RRFFQ69G5FAV')
+  # #=> 2016-07-30 23:54:10.259 UTC
+  # ```
+  def self.decode_time: (_ToStr string, ?in: String | Integer | nil) -> Time
+
   # Get ULID instance from unnormalized String that encoded in Crockford's base32.
   #
   # http://www.crockford.com/base32.html
@@ -430,9 +455,12 @@ class ULID < Object
   # ```ruby
   # ulid = ULID.generate
   # #=> ULID(2021-04-27 17:27:22.826 UTC: 01F4A5Y1YAQCYAYCTC7GRMJ9AA)
-  # ulid.to_s #=> "01F4A5Y1YAQCYAYCTC7GRMJ9AA"
+  # ulid.encode #=> "01F4A5Y1YAQCYAYCTC7GRMJ9AA"
+  # ulid.encode.frozen? #=> true
+  # ulid.encode.equal?(ulid.to_s) #=> true
   # ```
-  def to_s: -> String
+  def encode: -> String
+  alias to_s encode
 
   # ```ruby
   # ulid = ULID.generate
@@ -581,9 +609,6 @@ class ULID < Object
 
   private
 
-  # A private API. Should not be used in your code.
-  def self.new: (milliseconds: Integer, entropy: Integer, integer: Integer) -> ULID
-
   # A private API. Should not be used in your code.
   def self.reasonable_entropy: -> Integer
 
@@ -594,7 +619,7 @@ class ULID < Object
   def self.safe_get_class_name: (untyped object) -> String
 
   # A private API. Should not be used in your code.
-  def initialize: (milliseconds: Integer, entropy: Integer, integer: Integer) -> void
+  def initialize: (milliseconds: Integer, entropy: Integer, integer: Integer, encoded: String) -> void
 
   # A private API. Should not be used in your code.
   def cache_all_instance_variables: -> void

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-ulid
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Kenichi Kamiya
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-03 00:00:00.000000000 Z
+date: 2022-07-18 00:00:00.000000000 Z
 dependencies: []
 description: "    generator, optional monotonicity, parser and tools for ULID (RBS
   included)\n"
@@ -23,6 +23,7 @@ files:
 - lib/ruby-ulid.rb
 - lib/ulid.rb
 - lib/ulid/crockford_base32.rb
+- lib/ulid/errors.rb
 - lib/ulid/monotonic_generator.rb
 - lib/ulid/ractor_unshareable_constants.rb
 - lib/ulid/uuid.rb