ruby-ulid 0.0.18 → 0.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b1641b0894c0140c3a9c6f59fa8abcfca386362ad1aaa92fe196f3bf5f75cf1
-  data.tar.gz: 932fa04dceb504330289d4236f9670fecd702989504bdd402873d60c0bb1c0e5
+  metadata.gz: 646d2a4b433ffbe28d4801483d3f1c43cfb5839bf5f80e759447304a1c8dad52
+  data.tar.gz: 1e4ddc37266eb09f3635ba5509e66e6ff93e15fad3e6574fb3b50e8ad9322b10
 SHA512:
-  metadata.gz: f073c7b240ef96b511c84c6bc5649c483fc97c62a3892f58531b6f36e8235e49dcd865433fe522eec48a3532c98c4deec8713f453a4b2a117157788eabddaf6b
-  data.tar.gz: a2486bbefd62d0d019c15044c9d67b6aabc33e370f4ee88239c1e2b33a40738c736fcc9221dd3ce457eabf83a3580be5dc501fef0c359345a453331bdd62d139
+  metadata.gz: 9a564dbad8c3c88b729353826c599e618cd8963806759ce8a6bf041a95aef60044c8f75873560129bcef7550eec226c3bf04bcfec339c4b07fb72c3372342811
+  data.tar.gz: 187c475f9332cb69827e2664193faa7f001cb14a5709b3c28600286ac9e6c1fb3176e14e3a7ae3a658d232af6157a3dea83ad992cee75db966ff80213c3a0e52

data/README.md

@@ -49,7 +49,7 @@ Should be installed!
 Add this line to your application/library's `Gemfile` is needed in basic use-case
 
 ```ruby
-gem 'ruby-ulid', '0.0.18'
+gem 'ruby-ulid', '0.0.19'
 ```
 
 ### Generator and Parser
@@ -271,7 +271,9 @@ ULID.parse('01BX5ZZKBK0000000000000000').pred.to_s #=> "01BX5ZZKBJZZZZZZZZZZZZZZ
 ULID.parse('00000000000000000000000000').pred #=> nil
 ```
 
-`ULID.sample` returns random ULIDs ignoring the generating time
+`ULID.sample` returns random ULIDs.
+
+Basically ignores generating time.
 
 ```ruby
 ULID.sample #=> ULID(2545-07-26 06:51:20.085 UTC: 0GGKQ45GMNMZR6N8A8GFG0ZXST)
@@ -287,6 +289,39 @@ ULID.sample(5)
 # ULID(2665-03-16 14:50:22.724 UTC: 0KYFW9DWM4CEGFNTAC6YFAVVJ6)]
 ```
 
+You can specify a range object for the timestamp restriction, see also `ULID.range`.
+
+```ruby
+ulid1 = ULID.parse('01F4A5Y1YAQCYAYCTC7GRMJ9AA') #=> ULID(2021-04-27 17:27:22.826 UTC: 01F4A5Y1YAQCYAYCTC7GRMJ9AA)
+ulid2 = ULID.parse('01F4PTVCSN9ZPFKYTY2DDJVRK4') #=> ULID(2021-05-02 15:23:48.917 UTC: 01F4PTVCSN9ZPFKYTY2DDJVRK4)
+ulids = ULID.sample(1000, period: ulid1..ulid2)
+ulids.uniq.size #=> 1000
+ulids.take(10)
+#=>
+#[ULID(2021-05-02 06:57:19.954 UTC: 01F4NXW02JNB8H0J0TK48JD39X),
+# ULID(2021-05-02 07:06:07.458 UTC: 01F4NYC372GVP7NS0YAYQGT4VZ),
+# ULID(2021-05-01 06:16:35.791 UTC: 01F4K94P6F6P68K0H64WRDSFKW),
+# ULID(2021-04-27 22:17:37.844 UTC: 01F4APHGSMFJZQTGXKZBFFBPJP),
+# ULID(2021-04-28 20:17:55.357 UTC: 01F4D231MXQJXAR8G2JZHEJNH3),
+# ULID(2021-04-30 07:18:54.307 UTC: 01F4GTA2332AS2VPHC4FMKC7R5),
+# ULID(2021-05-02 12:26:03.480 UTC: 01F4PGNXARG554Y3HYVBDW4T9S),
+# ULID(2021-04-29 09:52:15.107 UTC: 01F4EGP483ZX2747FQPWQNPPMW),
+# ULID(2021-04-29 03:18:24.152 UTC: 01F4DT4Z4RA0QV8WFQGRAG63EH),
+# ULID(2021-05-02 13:27:16.394 UTC: 01F4PM605ABF5SDVMEHBH8JJ9R)]
+ULID.sample(10, period: ulid1.to_time..ulid2.to_time)
+#=> 
+# [ULID(2021-04-29 06:44:41.513 UTC: 01F4E5YPD9XQ3MYXWK8ZJKY8SW),
+#  ULID(2021-05-01 00:35:06.629 UTC: 01F4JNKD85SVK1EAEYSJGF53A2),
+#  ULID(2021-05-02 12:45:28.408 UTC: 01F4PHSEYRG9BWBEWMRW1XE6WW),
+#  ULID(2021-05-01 03:06:09.130 UTC: 01F4JY7ZBABCBMX16XH2Q4JW4W),
+#  ULID(2021-04-29 21:38:58.109 UTC: 01F4FS45DX4049JEQK4W6TER6G),
+#  ULID(2021-04-29 17:14:14.116 UTC: 01F4F9ZDQ449BE8BBZFEHYQWG2),
+#  ULID(2021-04-30 16:18:08.205 UTC: 01F4HS5DPD1HWDVJNJ6YKJXKSK),
+#  ULID(2021-04-30 10:31:33.602 UTC: 01F4H5ATF2A1CSQF0XV5NKZ288),
+#  ULID(2021-04-28 16:49:06.484 UTC: 01F4CP4PDM214Q6H3KJP7DYJRR),
+#  ULID(2021-04-28 15:05:06.808 UTC: 01F4CG68ZRST94T056KRZ5K9S4)]
+```
+
 ### UUIDv4 converter for migration use-cases
 
 `ULID.from_uuidv4` and `ULID#to_uuidv4` is the converter.

data/lib/ulid.rb

@@ -15,15 +15,11 @@ class ULID
   class Error < StandardError; end
   class OverflowError < Error; end
   class ParserError < Error; end
-  class SetupError < ScriptError; end
 
-  # `Subset` of Crockford's Base32. Just excluded I, L, O, U, -.
-  # refs:
-  #   * https://www.crockford.com/base32.html
-  #   * https://github.com/ulid/spec/pull/57
-  #   * https://github.com/kachick/ruby-ulid/issues/57
-  encoding_string = '0123456789ABCDEFGHJKMNPQRSTVWXYZ'
-  encoding_chars = encoding_string.chars.map(&:freeze).freeze
+  # 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
@@ -34,25 +30,21 @@ class ULID
   MAX_MILLISECONDS = 281474976710655
   MAX_ENTROPY = 1208925819614629174706175
   MAX_INTEGER = 340282366920938463463374607431768211455
-  PATTERN = /(?<timestamp>[0-7][#{encoding_string}]{#{TIMESTAMP_ENCODED_LENGTH - 1}})(?<randomness>[#{encoding_string}]{#{RANDOMNESS_ENCODED_LENGTH}})/i.freeze
-  STRICT_PATTERN = /\A#{PATTERN.source}\z/i.freeze
+
+  # @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
+
+  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.
+  # This can't contain `\b` for considering UTF-8 (e.g. Japanese), so intentional `false negative` definition.
+  SCANNING_PATTERN = /[0-7][#{CROCKFORD_BASE32_ENCODING_STRING}]{#{TIMESTAMP_ENCODED_LENGTH - 1}}[#{CROCKFORD_BASE32_ENCODING_STRING}]{#{RANDOMNESS_ENCODED_LENGTH}}/i.freeze
 
   # Same as Time#inspect since Ruby 2.7, just to keep backward compatibility
   # @see https://bugs.ruby-lang.org/issues/15958
   TIME_FORMAT_IN_INSPECT = '%Y-%m-%d %H:%M:%S.%3N %Z'
 
-  UNDEFINED = BasicObject.new
-  # @return [String]
-  def UNDEFINED.to_s
-    'ULID::UNDEFINED'
-  end
-
-  # @return [String]
-  def UNDEFINED.inspect
-    to_s
-  end
-  Kernel.instance_method(:freeze).bind(UNDEFINED).call
-
   private_class_method :new
 
   # @param [Integer, Time] moment
@@ -82,28 +74,54 @@ class ULID
     MAX_MILLISECONDS.equal?(moment) ? MAX : generate(moment: moment, entropy: MAX_ENTROPY)
   end
 
-  # @param [Integer] number
-  # @return [ULID, Array<ULID>]
-  # @raise [ArgumentError] if the given number is lager than ULID spec limits or given negative number 
+  RANDOM_INTEGER_GENERATOR = -> {
+    SecureRandom.random_number(MAX_INTEGER)
+  }
+
+  # @param [Range<Time>, Range<nil>, Range[ULID], nil] period
+  # @overload sample(number, period: nil)
+  #   @param [Integer] number
+  #   @return [Array<ULID>]
+  #   @raise [ArgumentError] if the given number is lager than `ULID spec limits` or `Possibilities of given period`, or given negative number
+  # @overload sample(period: nil)
+  #   @return [ULID]
   # @note Major difference of `Array#sample` interface is below
   #   * Do not ensure the uniqueness
   #   * Do not take random generator for the arguments
   #   * Raising error instead of truncating elements for the given number
-  def self.sample(number=UNDEFINED)
-    if UNDEFINED.equal?(number)
-      from_integer(SecureRandom.random_number(MAX_INTEGER))
+  def self.sample(*args, period: nil)
+    int_generator = if period
+      ulid_range = range(period)
+      min, max, exclude_end = ulid_range.begin.to_i, ulid_range.end.to_i, ulid_range.exclude_end?
+
+      possibilities = (max - min) + (exclude_end ? 0 : 1)
+      raise ArgumentError, "given range `#{ulid_range.inspect}` does not have possibilities" unless possibilities.positive?
+
+      -> {
+        SecureRandom.random_number(possibilities) + min
+      }
     else
-      begin
-        int = number.to_int
-      rescue
-         # Can not use `number.to_s` and `number.inspect` for considering BasicObject here
-        raise TypeError, 'accepts no argument or integer only'
+      RANDOM_INTEGER_GENERATOR
+    end
+
+    case args.size
+    when 0
+      from_integer(int_generator.call)
+    when 1
+      number = args.first
+      raise ArgumentError, 'accepts no argument or integer only' unless Integer === number
+
+      if number > MAX_INTEGER || number.negative?
+        raise ArgumentError, "given number #{number} is larger than ULID limit #{MAX_INTEGER} or negative: #{number.inspect}"
       end
 
-      if int > MAX_INTEGER || int.negative?
-        raise ArgumentError, "given number is larger than ULID limit #{MAX_INTEGER} or negative: #{number.inspect}"
+      if period && (number > possibilities)
+        raise ArgumentError, "given number #{number} is larger than given possibilities #{possibilities}"
       end
-      int.times.map { from_integer(SecureRandom.random_number(MAX_INTEGER)) }
+
+      Array.new(number) { from_integer(int_generator.call) }
+    else
+      raise ArgumentError, "wrong number of arguments (given #{args.size}, expected 0..1)"
     end
   end
 
@@ -112,10 +130,11 @@ class ULID
   # @yieldparam [ULID] ulid
   # @yieldreturn [self]
   def self.scan(string)
-    string = string.to_str
+    string = String.try_convert(string)
+    raise ArgumentError, 'ULID.scan takes only strings' unless string
     return to_enum(__callee__, string) unless block_given?
-    string.scan(PATTERN) do |pair|
-      yield parse(pair.join)
+    string.scan(SCANNING_PATTERN) do |matched|
+      yield parse(matched)
     end
     self
   end
@@ -139,35 +158,40 @@ class ULID
     new milliseconds: milliseconds, entropy: entropy, integer: integer
   end
 
-  # @param [Range<Time>, Range<nil>] time_range
+  # @param [Range<Time>, Range<nil>, Range[ULID]] period
   # @return [Range<ULID>]
-  # @raise [ArgumentError] if the given time_range is not a `Range[Time]` or `Range[nil]`
-  def self.range(time_range)
-    raise argument_error_for_range_building(time_range) unless time_range.kind_of?(Range)
-    begin_time, end_time, exclude_end = time_range.begin, time_range.end, time_range.exclude_end?
+  # @raise [ArgumentError] if the given period is not a `Range[Time]` or `Range[nil]`
+  def self.range(period)
+    raise ArgumentError, 'ULID.range takes only `Range[Time]` or `Range[nil]`' unless Range === period
+    begin_element, end_element, exclude_end = period.begin, period.end, period.exclude_end?
+    return period if self === begin_element && self === end_element
 
-    case begin_time
+    case begin_element
     when Time
-      begin_ulid = min(moment: begin_time)
+      begin_ulid = min(moment: begin_element)
     when nil
       begin_ulid = MIN
+    when self
+      begin_ulid = begin_element
     else
-      raise argument_error_for_range_building(time_range)
+      raise ArgumentError, "ULID.range takes only `Range[Time]` or `Range[nil]`, given: #{period.inspect}"
     end
 
-    case end_time
+    case end_element
     when Time
       if exclude_end
-        end_ulid = min(moment: end_time)
+        end_ulid = min(moment: end_element)
       else
-        end_ulid = max(moment: end_time)
+        end_ulid = max(moment: end_element)
       end
     when nil
       # The end should be max and include end, because nil end means to cover endless ULIDs until the limit
       end_ulid = MAX
       exclude_end = false
+    when self
+      end_ulid = end_element
     else
-      raise argument_error_for_range_building(time_range)
+      raise ArgumentError, "ULID.range takes only `Range[Time]` or `Range[nil]`, given: #{period.inspect}"
     end
 
     begin_ulid.freeze
@@ -179,6 +203,8 @@ class ULID
   # @param [Time] time
   # @return [Time]
   def self.floor(time)
+    raise ArgumentError, 'ULID.floor takes only `Time` instance' unless Time === time
+
     if RUBY_VERSION >= '2.7'
       time.floor(3)
     else
@@ -192,10 +218,9 @@ class ULID
     milliseconds_from_time(Time.now)
   end
 
-  # @api private
   # @param [Time] time
   # @return [Integer]
-  def self.milliseconds_from_time(time)
+  private_class_method def self.milliseconds_from_time(time)
     (time.to_r * 1000).to_i
   end
 
@@ -203,7 +228,14 @@ class ULID
   # @param [Time, Integer] moment
   # @return [Integer]
   def self.milliseconds_from_moment(moment)
-    moment.kind_of?(Time) ? milliseconds_from_time(moment) : moment.to_int
+    case moment
+    when Integer
+      moment
+    when Time
+      milliseconds_from_time(moment)
+    else
+      raise ArgumentError, '`moment` should be a `Time` or `Integer as milliseconds`'
+    end
   end
 
   # @api private
@@ -212,84 +244,25 @@ class ULID
     SecureRandom.random_number(MAX_ENTROPY)
   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
-
-  # Currently supporting only for `subset for actual use-case`
-  # See below
-  #   * https://github.com/ulid/spec/pull/57
-  #   * https://github.com/kachick/ruby-ulid/issues/57
-  #   * https://github.com/kachick/ruby-ulid/issues/78
-  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
-  }.freeze
-
-  N32_CHAR_BY_CROCKFORD_BASE32_CHAR = encoding_chars.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
-
   # @param [String, #to_str] string
   # @return [ULID]
   # @raise [ParserError] if the given format is not correct for ULID specs
   def self.parse(string)
-    begin
-      string = string.to_str
-      raise "given argument does not match to `#{STRICT_PATTERN.inspect}`" unless STRICT_PATTERN.match?(string)
-    rescue => err
-      raise ParserError, "parsing failure as #{err.inspect} for given #{string.inspect}"
+    string = String.try_convert(string)
+    raise ArgumentError, 'ULID.parse 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
 
-    n32encoded = string.upcase.gsub(CROCKFORD_BASE32_CHAR_PATTERN, N32_CHAR_BY_CROCKFORD_BASE32_CHAR)
-    from_integer(n32encoded.to_i(32))
+    from_integer(CrockfordBase32.decode(string))
   end
 
+  # @param [String, #to_str] string
   # @return [Boolean]
   def self.valid?(string)
-    parse(string)
-  rescue Exception
-    false
-  else
-    true
-  end
-
-  # @api private
-  # @see The logics taken from https://bugs.ruby-lang.org/issues/14401, thanks!
-  # @param [Array<Integer>] reversed_digits
-  # @return [Integer]
-  def self.inverse_of_digits(reversed_digits)
-    base = 256
-    num = 0
-    reversed_digits.each do |digit|
-      num = (num * base) + digit
-    end
-    num
+    string = String.try_convert(string)
+    string ? STRICT_PATTERN_WITH_CROCKFORD_BASE32_SUBSET.match?(string) : false
   end
 
   # @api private
@@ -300,12 +273,6 @@ class ULID
     new milliseconds: generator.latest_milliseconds, entropy: generator.latest_entropy
   end
 
-  # @api private
-  # @return [ArgumentError]
-  private_class_method def self.argument_error_for_range_building(argument)
-    ArgumentError.new "ULID.range takes only `Range[Time]` or `Range[nil]`, given: #{argument.inspect}"
-  end
-
   attr_reader :milliseconds, :entropy
 
   # @api private
@@ -315,16 +282,16 @@ class ULID
   # @return [void]
   # @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 initialize(milliseconds:, entropy:, integer: UNDEFINED)
-    if UNDEFINED.equal?(integer)
+  def initialize(milliseconds:, entropy:, integer: nil)
+    if integer
+      @integer = integer
+    else
       milliseconds = milliseconds.to_int
       entropy = entropy.to_int
 
       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?
-    else
-      @integer = integer
     end
 
     @milliseconds = milliseconds
@@ -333,7 +300,7 @@ class ULID
 
   # @return [String]
   def to_s
-    @string ||= to_i.to_s(32).upcase.gsub(N32_CHAR_PATTERN, CROCKFORD_BASE32_CHAR_BY_N32_CHAR).rjust(ENCODED_LENGTH, '0').freeze
+    @string ||= CrockfordBase32.encode(to_i).freeze
   end
 
   # @return [Integer]
@@ -366,13 +333,9 @@ class ULID
   def ===(other)
     case other
     when ULID
-      self == other
+      to_i == other.to_i
     when String
-      begin
-        self == self.class.parse(other)
-      rescue Exception
-        false
-      end
+      to_s == other.upcase
     else
       false
     end
@@ -391,17 +354,21 @@ class ULID
 
   # @return [Array(Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer)]
   def octets
-    @octets ||= octets_from_integer(to_i).freeze
+    digits = to_i.digits(256)
+    (OCTETS_LENGTH - digits.size).times do
+      digits.push 0
+    end
+    digits.reverse!
   end
 
   # @return [Array(Integer, Integer, Integer, Integer, Integer, Integer)]
   def timestamp_octets
-    @timestamp_octets ||= octets.slice(0, TIMESTAMP_OCTETS_LENGTH).freeze
+    octets.slice(0, TIMESTAMP_OCTETS_LENGTH)
   end
 
   # @return [Array(Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer)]
   def randomness_octets
-    @randomness_octets ||= octets.slice(TIMESTAMP_OCTETS_LENGTH, RANDOMNESS_OCTETS_LENGTH).freeze
+    octets.slice(TIMESTAMP_OCTETS_LENGTH, RANDOMNESS_OCTETS_LENGTH)
   end
 
   # @return [String]
@@ -424,31 +391,33 @@ class ULID
     }
   end
 
-  # @deprecated Use {#patterns} instead. ref: https://github.com/kachick/ruby-ulid/issues/84
-  # @return [Regexp]
-  def pattern
-    patterns.fetch(:named_captures)
-  end
-
-  # @deprecated Use {#patterns} instead. ref: https://github.com/kachick/ruby-ulid/issues/84
-  # @return [Regexp]
-  def strict_pattern
-    patterns.fetch(:strict_named_captures)
-  end
-
   # @return [ULID, nil] when called on ULID as `7ZZZZZZZZZZZZZZZZZZZZZZZZZ`, returns `nil` instead of ULID
-  def next
-    next_int = to_i.next
-    return nil if next_int > MAX_INTEGER
-    @next ||= self.class.from_integer(next_int)
+  def succ
+    succ_int = to_i.succ
+    if succ_int >= MAX_INTEGER
+      if succ_int == MAX_INTEGER
+        MAX
+      else
+        nil
+      end
+    else
+      ULID.from_integer(succ_int)
+    end
   end
-  alias_method :succ, :next
+  alias_method :next, :succ
 
   # @return [ULID, nil] when called on ULID as `00000000000000000000000000`, returns `nil` instead of ULID
   def pred
-    pre_int = to_i.pred
-    return nil if pre_int.negative?
-    @pred ||= self.class.from_integer(pre_int)
+    pred_int = to_i.pred
+    if pred_int <= 0
+      if pred_int == 0
+        MIN
+      else
+        nil
+      end
+    else
+      ULID.from_integer(pred_int)
+    end
   end
 
   # @return [self]
@@ -460,34 +429,21 @@ class ULID
 
   private
 
-  # @param [Integer] integer
-  # @return [Array(Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer)]
-  def octets_from_integer(integer)
-    digits = integer.digits(256)
-    (OCTETS_LENGTH - digits.size).times do
-      digits.push 0
-    end
-    digits.reverse!
-  end
-
   # @return [void]
   def cache_all_instance_variables
     inspect
-    octets
-    to_i
-    succ
-    pred
     timestamp
     randomness
   end
 end
 
 require_relative 'ulid/version'
+require_relative 'ulid/crockford_base32'
 require_relative 'ulid/monotonic_generator'
 
 class ULID
   MIN = parse('00000000000000000000000000').freeze
   MAX = parse('7ZZZZZZZZZZZZZZZZZZZZZZZZZ').freeze
 
-  private_constant :TIME_FORMAT_IN_INSPECT, :MIN, :MAX, :CROCKFORD_BASE32_CHAR_PATTERN, :N32_CHAR_BY_CROCKFORD_BASE32_CHAR, :CROCKFORD_BASE32_CHAR_BY_N32_CHAR, :N32_CHAR_PATTERN, :UNDEFINED
+  private_constant :TIME_FORMAT_IN_INSPECT, :MIN, :MAX, :RANDOM_INTEGER_GENERATOR
 end

data/lib/ulid/crockford_base32.rb

@@ -0,0 +1,68 @@
+# coding: us-ascii
+# frozen_string_literal: true
+# Copyright (C) 2021 Kenichi Kamiya
+
+class ULID
+  # Currently supporting only for `subset` for actual use-case`
+  # Original decoding spec allows other characters.
+  # But I think ULID should allow `subset` of Crockford's Base32.
+  # See below
+  #   * https://github.com/ulid/spec/pull/57
+  #   * https://github.com/kachick/ruby-ulid/issues/57
+  #   * https://github.com/kachick/ruby-ulid/issues/78
+  module CrockfordBase32
+    class SetupError < ScriptError; 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
+    }.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
+
+    # @param [String] string
+    # @return [Integer]
+    def self.decode(string)
+      n32encoded = string.upcase.gsub(CROCKFORD_BASE32_CHAR_PATTERN, N32_CHAR_BY_CROCKFORD_BASE32_CHAR)
+      n32encoded.to_i(32)
+    end
+
+    # @param [Integer] integer
+    # @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')
+    end
+  end
+end

data/lib/ulid/monotonic_generator.rb

@@ -8,6 +8,7 @@ class ULID
     attr_accessor :latest_milliseconds, :latest_entropy
 
     def initialize
+      @mutex = Thread::Mutex.new
       reset
     end
 
@@ -19,14 +20,15 @@ class ULID
       milliseconds = ULID.milliseconds_from_moment(moment)
       raise ArgumentError, "milliseconds should not be negative: given: #{milliseconds}" if milliseconds.negative?
 
-      if @latest_milliseconds < milliseconds
-        @latest_milliseconds = milliseconds
-        @latest_entropy = ULID.reasonable_entropy
-      else
-        @latest_entropy += 1
+      @mutex.synchronize do
+        if @latest_milliseconds < milliseconds
+          @latest_milliseconds = milliseconds
+          @latest_entropy = ULID.reasonable_entropy
+        else
+          @latest_entropy += 1
+        end
+        ULID.from_monotonic_generator(self)
       end
-
-      ULID.from_monotonic_generator(self)
     end
 
     # @api private

data/lib/ulid/uuid.rb

@@ -15,15 +15,16 @@ class ULID
   # @return [ULID]
   # @raise [ParserError] if the given format is not correct for UUIDv4 specs
   def self.from_uuidv4(uuid)
-    begin
-      uuid = uuid.to_str
-      prefix_trimmed = uuid.sub(/\Aurn:uuid:/, '')
-      raise "given string is not matched to pattern #{UUIDV4_PATTERN.inspect}" unless UUIDV4_PATTERN.match?(prefix_trimmed)
-      normalized = prefix_trimmed.gsub(/[^0-9A-Fa-f]/, '')
-      from_integer(normalized.to_i(16))
-    rescue => err
-      raise ParserError, "parsing failure as #{err.inspect} for given #{uuid}"
+    uuid = String.try_convert(uuid)
+    raise ArgumentError, 'ULID.from_uuidv4 takes only strings' unless uuid
+
+    prefix_trimmed = uuid.sub(/\Aurn:uuid:/, '')
+    unless UUIDV4_PATTERN.match?(prefix_trimmed)
+      raise ParserError, "given `#{uuid}` does not match to `#{UUIDV4_PATTERN.inspect}`"
     end
+
+    normalized = prefix_trimmed.gsub(/[^0-9A-Fa-f]/, '')
+    from_integer(normalized.to_i(16))
   end
 
   # @return [String]

data/lib/ulid/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 class ULID
-  VERSION = '0.0.18'
+  VERSION = '0.0.19'
 end

data/sig/ulid.rbs

@@ -1,6 +1,7 @@
 # Classes
 class ULID
   VERSION: String
+  CROCKFORD_BASE32_ENCODING_STRING: String
   TIMESTAMP_ENCODED_LENGTH: 10
   RANDOMNESS_ENCODED_LENGTH: 16
   ENCODED_LENGTH: 26
@@ -11,16 +12,13 @@ class ULID
   MAX_ENTROPY: 1208925819614629174706175
   MAX_INTEGER: 340282366920938463463374607431768211455
   TIME_FORMAT_IN_INSPECT: '%Y-%m-%d %H:%M:%S.%3N %Z'
-  PATTERN: Regexp
-  STRICT_PATTERN: Regexp
+  RANDOM_INTEGER_GENERATOR: ^() -> Integer
+  PATTERN_WITH_CROCKFORD_BASE32_SUBSET: Regexp
+  STRICT_PATTERN_WITH_CROCKFORD_BASE32_SUBSET: Regexp
+  SCANNING_PATTERN: Regexp
   UUIDV4_PATTERN: Regexp
-  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
   MIN: ULID
   MAX: ULID
-  UNDEFINED: BasicObject
   include Comparable
 
   # The `moment` is a `Time` or `Intger of the milliseconds`
@@ -35,7 +33,17 @@ class ULID
   class ParserError < Error
   end
 
-  class SetupError < ScriptError
+  module CrockfordBase32
+    class SetupError < ScriptError
+    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
+
+    def self.encode: (Integer integer) -> String
+    def self.decode: (String string) -> Integer
   end
 
   class MonotonicGenerator
@@ -50,26 +58,22 @@ class ULID
   type octets = [Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer]
   type timestamp_octets = [Integer, Integer, Integer, Integer, Integer, Integer]
   type randomness_octets = [Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer]
+  type period = Range[Time] | Range[nil] | Range[ULID]
 
   @milliseconds: Integer
   @entropy: Integer
   @string: String?
   @integer: Integer?
-  @octets: octets?
-  @timestamp_octets: timestamp_octets?
-  @randomness_octets: randomness_octets?
   @timestamp: String?
   @randomness: String?
   @inspect: String?
   @time: Time?
-  @next: ULID?
 
   def self.generate: (?moment: moment, ?entropy: Integer) -> ULID
   def self.at: (Time time) -> ULID
   def self.current_milliseconds: -> Integer
-  def self.milliseconds_from_time: (Time time) -> Integer
   def self.milliseconds_from_moment: (moment moment) -> Integer
-  def self.range: (Range[Time] | Range[nil] time_range) -> Range[ULID]
+  def self.range: (period period) -> Range[ULID]
   def self.floor: (Time time) -> Time
   def self.reasonable_entropy: -> Integer
   def self.parse: (String string) -> ULID
@@ -77,13 +81,11 @@ class ULID
   def self.from_integer: (Integer integer) -> ULID
   def self.min: (?moment: moment) -> ULID
   def self.max: (?moment: moment) -> ULID
-  def self.sample: -> ULID
-                 | (Integer number) -> Array[ULID]
+  def self.sample: (?period: period) -> ULID
+                 | (Integer number, ?period: period) -> Array[ULID]
   def self.valid?: (untyped string) -> bool
   def self.scan:  (String string) -> Enumerator[ULID, singleton(ULID)]
                 | (String string) { (ULID ulid) -> void } -> singleton(ULID)
-  def self.octets_from_integer: (Integer integer) -> octets
-  def self.inverse_of_digits: (Array[Integer] reversed_digits) -> Integer
   def self.from_monotonic_generator: (MonotonicGenerator generator) -> ULID
   attr_reader milliseconds: Integer
   attr_reader entropy: Integer
@@ -101,8 +103,6 @@ class ULID
   def timestamp: -> String
   def randomness: -> String
   def patterns: -> Hash[Symbol, Regexp | String]
-  def pattern: -> Regexp
-  def strict_pattern: -> Regexp
   def octets: -> octets
   def timestamp_octets: -> timestamp_octets
   def randomness_octets: -> randomness_octets
@@ -113,6 +113,6 @@ class ULID
   def freeze: -> self
 
   private
-  def self.argument_error_for_range_building: (untyped argument) -> ArgumentError
+  def self.milliseconds_from_time: (Time time) -> Integer
   def cache_all_instance_variables: -> void
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-ulid
 version: !ruby/object:Gem::Version
-  version: 0.0.18
+  version: 0.0.19
 platform: ruby
 authors:
 - Kenichi Kamiya
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-07 00:00:00.000000000 Z
+date: 2021-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rbs
@@ -77,6 +77,7 @@ files:
 - LICENSE
 - README.md
 - lib/ulid.rb
+- lib/ulid/crockford_base32.rb
 - lib/ulid/monotonic_generator.rb
 - lib/ulid/uuid.rb
 - lib/ulid/version.rb