ruby-ulid 0.0.14 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa89ecbb2a09940666b57e690d43a985872bb85f40b2b1175c79a762d79c8e45
-  data.tar.gz: 2404fe5e1efa77899262fbf8979529fc474e44ffa0a8572ee3cf71eb1caf941a
+  metadata.gz: 6a620e80f82e91c778329ccf7da8cca96bda4b12e047610b9543768c5ec85d22
+  data.tar.gz: ea28469d63348758f52e1460b5330ce177ad2281e63060800a0669054758f3ee
 SHA512:
-  metadata.gz: 1a86224846b27985d641bf485f952583c73dafc87a0ca8f65744cfdfa35371a6f5cfedb4246e7839da6e51fdcfd53632f20057c399038f3399f2986a9bf20085
-  data.tar.gz: 24daff089a2b0564a2e7a93c34fef4d44420d1e0bbc6a054c5bcdfac02986c66204515bc085a7dc6499257692682217a888d8a04e04a7ae8de36e884cc182965
+  metadata.gz: acb07ae797c3a06a6626d34e15dc1056a30586e8bc151a3773770259d2f4047d0708593e702fbd67a7609758165f20a15f208fede068717a5555733535ed4bde
+  data.tar.gz: 57c9819d86f2a0f002cf3b9a7b76b3a36bc412fa874d50136ec296f1217fb905fa19feb52de2c9d5250547da384580cf882121f0e331054cd665bd113d1f10e3

data/README.md

@@ -2,9 +2,9 @@
 
 A handy `ULID` library
 
-The `ULID` spec is defined on [ulid/spec](https://github.com/ulid/spec).
+The `ULID` spec is defined on [ulid/spec](https://github.com/ulid/spec). It has useful specs for applications (e.g. `Database key`), especially possess all `uniqueness`, `randomness`, `extractable timestamps` and `sortable` features.
 This gem aims to provide the generator, monotonic generator, parser and handy manipulation features around the ULID.
-Also providing rbs signature files.
+Also providing [ruby/rbs](https://github.com/ruby/rbs) signature files.
 
 ---
 
@@ -28,7 +28,7 @@ Instead, herein is proposed ULID:
 - 1.21e+24 unique ULIDs per millisecond
 - Lexicographically sortable!
 - Canonically encoded as a 26 character string, as opposed to the 36 character UUID
-- Uses Crockford's base32 for better efficiency and readability (5 bits per character)
+- Uses [Crockford's base32](https://www.crockford.com/base32.html) for better efficiency and readability (5 bits per character) # See also exists issues in [Note](#note)
 - Case insensitive
 - No special characters (URL safe)
 - Monotonic sort order (correctly detects and handles the same millisecond)
@@ -98,19 +98,19 @@ ulids.uniq(&:to_time).size #=> 35 (the size is not fixed, might be changed in en
 ulids.sort == ulids #=> false
 ```
 
-If you want to prefer `sortable` rather than the `randomness`, Use `MonotonicGenerator` instead. It is called as [Monotonicity](https://github.com/ulid/spec/tree/d0c7170df4517939e70129b4d6462cc162f2d5bf#monotonicity) on the spec.
+If you want to ensure `sortable`, Use `MonotonicGenerator` instead. It is called as [Monotonicity](https://github.com/ulid/spec/tree/d0c7170df4517939e70129b4d6462cc162f2d5bf#monotonicity) on the spec.
 (Though it starts with new random value when changed the timestamp)
 
 ```ruby
 monotonic_generator = ULID::MonotonicGenerator.new
-monotonic_ulids = 10000.times.map do
+ulids = 10000.times.map do
   monotonic_generator.generate
 end
-sample_ulids_by_the_time = monotonic_ulids.uniq(&:to_time)
+sample_ulids_by_the_time = ulids.uniq(&:to_time)
 sample_ulids_by_the_time.size #=> 32 (the size is not fixed, might be changed in environment)
 
 # In same milliseconds creation, it just increments the end of randomness part
-monotonic_ulids.take(5) #=>
+ulids.take(5) #=>
 # [ULID(2021-05-02 15:23:48.917 UTC: 01F4PTVCSN9ZPFKYTY2DDJVRK4),
 #  ULID(2021-05-02 15:23:48.917 UTC: 01F4PTVCSN9ZPFKYTY2DDJVRK5),
 #  ULID(2021-05-02 15:23:48.917 UTC: 01F4PTVCSN9ZPFKYTY2DDJVRK6),
@@ -125,7 +125,7 @@ sample_ulids_by_the_time.take(5) #=>
 #  ULID(2021-05-02 15:23:48.920 UTC: 01F4PTVCSRBXN2H4P1EYWZ27AK),
 #  ULID(2021-05-02 15:23:48.921 UTC: 01F4PTVCSSK0ASBBZARV7013F8)]
 
-monotonic_ulids.sort == monotonic_ulids #=> true
+ulids.sort == ulids #=> true
 ```
 
 When filtering ULIDs by `Time`, we should consider to handle the precision.
@@ -209,11 +209,34 @@ ULID.parse('01BX5ZZKBK0000000000000000').pred.to_s #=> "01BX5ZZKBJZZZZZZZZZZZZZZ
 ULID.parse('00000000000000000000000000').pred #=> nil
 ```
 
-UUIDv4 converter for migration use-cases. (Of course the timestamp will be useless one. Sortable benefit is lost.)
+### UUIDv4 converter for migration use-cases
+
+`ULID.from_uuidv4` and `ULID#to_uuidv4` is the converter.
+The imported timestamp is meaningless. So ULID's benefit will lost
 
 ```ruby
-ULID.from_uuidv4('0983d0a2-ff15-4d83-8f37-7dd945b5aa39')
-#=> ULID(2301-07-10 00:28:28.821 UTC: 09GF8A5ZRN9P1RYDVXV52VBAHS)
+# Basically reversible 
+ulid = ULID.from_uuidv4('0983d0a2-ff15-4d83-8f37-7dd945b5aa39') #=> ULID(2301-07-10 00:28:28.821 UTC: 09GF8A5ZRN9P1RYDVXV52VBAHS)
+ulid.to_uuidv4 #=> "0983d0a2-ff15-4d83-8f37-7dd945b5aa39"
+
+uuid_v4s = 10000.times.map { SecureRandom.uuid }
+uuid_v4s.uniq.size == 10000 #=> Probably `true`
+
+ulids = uuid_v4s.map { |uuid_v4| ULID.from_uuidv4(uuid_v4) }
+ulids.map(&:to_uuidv4) == uuid_v4s #=> **Probably** `true` except below examples.
+
+# NOTE: Some boundary values are not reversible. See below.
+
+ULID.min.to_uuidv4 #=> "00000000-0000-4000-8000-000000000000"
+ULID.max.to_uuidv4 #=> "ffffffff-ffff-4fff-bfff-ffffffffffff"
+
+# These importing results are same as https://github.com/ahawker/ulid/tree/96bdb1daad7ce96f6db8c91ac0410b66d2e1c4c1 on CPython 3.9.4
+reversed_min = ULID.from_uuidv4('00000000-0000-4000-8000-000000000000') #=> ULID(1970-01-01 00:00:00.000 UTC: 00000000008008000000000000)
+reversed_max = ULID.from_uuidv4('ffffffff-ffff-4fff-bfff-ffffffffffff') #=> ULID(10889-08-02 05:31:50.655 UTC: 7ZZZZZZZZZ9ZZVZZZZZZZZZZZZ)
+
+# But they are not reversible! Need to consider this issue in https://github.com/kachick/ruby-ulid/issues/76
+ULID.min == reversed_min #=> false
+ULID.max == reversed_max #=> false
 ```
 
 ## References
@@ -221,5 +244,8 @@ ULID.from_uuidv4('0983d0a2-ff15-4d83-8f37-7dd945b5aa39')
 - [Repository](https://github.com/kachick/ruby-ulid)
 - [API documents](https://kachick.github.io/ruby-ulid/)
 - [ulid/spec](https://github.com/ulid/spec)
-- [Another choices are UUIDv6, UUIDv7, UUIDv8. But they are still in draft state](https://www.ietf.org/archive/id/draft-peabody-dispatch-new-uuid-format-01.html), I will track them in [ruby-ulid#37](https://github.com/kachick/ruby-ulid/issues/37)
-- Current parser/validator/matcher implementation aims `strict`, It might be changed in [ulid/spec#57](https://github.com/ulid/spec/pull/57) and [ruby-ulid#57](https://github.com/kachick/ruby-ulid/issues/57).
+
+## Note
+
+- Another choices for sortable and randomness IDs, [UUIDv6, UUIDv7, UUIDv8 might be the one. (But they are still in draft state)](https://www.ietf.org/archive/id/draft-peabody-dispatch-new-uuid-format-01.html), I will track them in [ruby-ulid#37](https://github.com/kachick/ruby-ulid/issues/37)
+- Current parser/validator/matcher aims to cover `subset of Crockford's base32`. Suggesting it in [ulid/spec#57](https://github.com/ulid/spec/pull/57). Be that as it may, I might provide special handler or converter for the exception in [ruby-ulid#57](https://github.com/kachick/ruby-ulid/issues/57) and/or [ruby-ulid#78](https://github.com/kachick/ruby-ulid/issues/78)

data/lib/ulid.rb

@@ -35,7 +35,7 @@ class ULID
   STRICT_PATTERN = /\A#{PATTERN.source}\z/i.freeze
 
   # Imported from https://stackoverflow.com/a/38191104/1212807, thank you!
-  UUIDV4_PATTERN = /\A[0-9A-F]{8}-[0-9A-F]{4}-[4][0-9A-F]{3}-[89AB][0-9A-F]{3}-[0-9A-F]{12}\z/i
+  UUIDV4_PATTERN = /\A[0-9A-F]{8}-[0-9A-F]{4}-[4][0-9A-F]{3}-[89AB][0-9A-F]{3}-[0-9A-F]{12}\z/i.freeze
 
   # Same as Time#inspect since Ruby 2.7, just to keep backward compatibility
   # @see https://bugs.ruby-lang.org/issues/15958
@@ -51,13 +51,13 @@ class ULID
   # @param [Integer, Time] moment
   # @return [ULID]
   def self.min(moment: 0)
-    generate(moment: moment, entropy: 0)
+    0.equal?(moment) ? MIN : generate(moment: moment, entropy: 0)
   end
 
   # @param [Integer, Time] moment
   # @return [ULID]
   def self.max(moment: MAX_MILLISECONDS)
-    generate(moment: moment, entropy: MAX_ENTROPY)
+    MAX_MILLISECONDS.equal?(moment) ? MAX : generate(moment: moment, entropy: MAX_ENTROPY)
   end
 
   # @deprecated This method actually changes class state. Use {ULID::MonotonicGenerator} instead.
@@ -121,10 +121,11 @@ class ULID
     new milliseconds: milliseconds, entropy: entropy
   end
 
-  # @param [Range<Time>] time_range
+  # @param [Range<Time>, Range<nil>] time_range
   # @return [Range<ULID>]
+  # @raise [ArgumentError] if the given time_range is not a `Range[Time]` or `Range[nil]`
   def self.range(time_range)
-    raise ArgumentError, 'ULID.range takes only Range[Time]' unless time_range.kind_of?(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?
 
     case begin_time
@@ -133,7 +134,7 @@ class ULID
     when nil
       begin_ulid = min
     else
-      raise ArgumentError, 'ULID.range takes only Range[Time]'
+      raise argument_error_for_range_building(time_range)
     end
 
     case end_time
@@ -148,9 +149,12 @@ class ULID
       end_ulid = max
       exclude_end = false
     else
-      raise ArgumentError, 'ULID.range takes only Range[Time]'
+      raise argument_error_for_range_building(time_range)
     end
 
+    begin_ulid.freeze
+    end_ulid.freeze
+
     Range.new(begin_ulid, end_ulid, exclude_end)
   end
 
@@ -241,6 +245,11 @@ class ULID
     num
   end
 
+  # @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
@@ -364,15 +373,21 @@ class ULID
     @pred ||= self.class.from_integer(pre_int)
   end
 
+  # @return [String]
+  def to_uuidv4
+    @uuidv4 ||= begin
+      # This code referenced https://github.com/ruby/ruby/blob/121fa24a3451b45c41ac0a661b64e9fc8600e589/lib/securerandom.rb#L221-L241
+      array = octets.pack('C*').unpack('NnnnnN')
+      array[2] = (array[2] & 0x0fff) | 0x4000
+      array[3] = (array[3] & 0x3fff) | 0x8000
+      ('%08x-%04x-%04x-%04x-%04x%08x' % array).freeze
+    end
+  end
+
   # @return [self]
   def freeze
-    # Evaluate all caching
-    inspect
-    octets
-    to_i
-    succ
-    pred
-    strict_pattern
+    # Need to cache before freezing, because frozen objects can't assign instance variables
+    cache_all_instance_variables
     super
   end
 
@@ -382,13 +397,26 @@ class ULID
   def matchdata
     @matchdata ||= STRICT_PATTERN.match(to_s).freeze
   end
+
+  # @return [void]
+  def cache_all_instance_variables
+    inspect
+    octets
+    to_i
+    succ
+    pred
+    strict_pattern
+    to_uuidv4
+  end
 end
 
 require_relative 'ulid/version'
 require_relative 'ulid/monotonic_generator'
 
 class ULID
+  MIN = parse('00000000000000000000000000').freeze
+  MAX = parse('7ZZZZZZZZZZZZZZZZZZZZZZZZZ').freeze
   MONOTONIC_GENERATOR = MonotonicGenerator.new
 
-  private_constant :ENCODING_CHARS, :TIME_FORMAT_IN_INSPECT, :UUIDV4_PATTERN
+  private_constant :ENCODING_CHARS, :TIME_FORMAT_IN_INSPECT, :UUIDV4_PATTERN, :MIN, :MAX
 end

data/lib/ulid/version.rb

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

data/sig/ulid.rbs

@@ -16,8 +16,11 @@ class ULID
   STRICT_PATTERN: Regexp
   UUIDV4_PATTERN: Regexp
   MONOTONIC_GENERATOR: MonotonicGenerator
+  MIN: ULID
+  MAX: ULID
   include Comparable
 
+  # The `moment` is a `Time` or `Intger of the milliseconds`
   type moment = Time | Integer
 
   class Error < StandardError
@@ -56,6 +59,7 @@ class ULID
   @next: ULID?
   @pattern: Regexp?
   @strict_pattern: Regexp?
+  @uuidv4: String?
   @matchdata: MatchData?
 
   def self.generate: (?moment: moment, ?entropy: Integer) -> ULID
@@ -63,7 +67,7 @@ class 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] time_range) -> Range[ULID]
+  def self.range: (Range[Time] | Range[nil] time_range) -> Range[ULID]
   def self.floor: (Time time) -> Time
   def self.reasonable_entropy: -> Integer
   def self.parse: (String string) -> ULID
@@ -96,11 +100,14 @@ class ULID
   def octets: -> octets
   def timestamp_octets: -> timestamp_octets
   def randomness_octets: -> randomness_octets
+  def to_uuidv4: -> String
   def next: -> ULID?
   alias succ next
   def pred: -> ULID?
   def freeze: -> self
 
   private
+  def self.argument_error_for_range_building: (untyped argument) -> ArgumentError
   def matchdata: -> MatchData
+  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.14
+  version: 0.0.15
 platform: ruby
 authors:
 - Kenichi Kamiya
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-03 00:00:00.000000000 Z
+date: 2021-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: integer-base
@@ -96,7 +96,6 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
-- Steepfile
 - lib/ulid.rb
 - lib/ulid/monotonic_generator.rb
 - lib/ulid/version.rb
@@ -123,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: A handy ULID library

data/Steepfile

@@ -1,7 +0,0 @@
-target :lib do
-  signature 'sig'
-
-  check 'lib'
-
-  library 'securerandom'
-end