ruby-ulid 0.0.14 → 0.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa89ecbb2a09940666b57e690d43a985872bb85f40b2b1175c79a762d79c8e45
-  data.tar.gz: 2404fe5e1efa77899262fbf8979529fc474e44ffa0a8572ee3cf71eb1caf941a
+  metadata.gz: 646d2a4b433ffbe28d4801483d3f1c43cfb5839bf5f80e759447304a1c8dad52
+  data.tar.gz: 1e4ddc37266eb09f3635ba5509e66e6ff93e15fad3e6574fb3b50e8ad9322b10
 SHA512:
-  metadata.gz: 1a86224846b27985d641bf485f952583c73dafc87a0ca8f65744cfdfa35371a6f5cfedb4246e7839da6e51fdcfd53632f20057c399038f3399f2986a9bf20085
-  data.tar.gz: 24daff089a2b0564a2e7a93c34fef4d44420d1e0bbc6a054c5bcdfac02986c66204515bc085a7dc6499257692682217a888d8a04e04a7ae8de36e884cc182965
+  metadata.gz: 9a564dbad8c3c88b729353826c599e618cd8963806759ce8a6bf041a95aef60044c8f75873560129bcef7550eec226c3bf04bcfec339c4b07fb72c3372342811
+  data.tar.gz: 187c475f9332cb69827e2664193faa7f001cb14a5709b3c28600286ac9e6c1fb3176e14e3a7ae3a658d232af6157a3dea83ad992cee75db966ff80213c3a0e52

data/README.md

@@ -1,10 +1,10 @@
 # ruby-ulid
 
-A handy `ULID` library
+## Overview
 
-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,21 +28,31 @@ 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)
 
-## Install
+## Usage
+
+### Install
 
 Require Ruby 2.6 or later
 
+This command will install the latest version into your environment
+
 ```console
 $ gem install ruby-ulid
-#=> Installed
+Should be installed!
 ```
 
-## Usage
+Add this line to your application/library's `Gemfile` is needed in basic use-case
+
+```ruby
+gem 'ruby-ulid', '0.0.19'
+```
+
+### Generator and Parser
 
 The generated `ULID` is an object not just a string.
 It means easily get the timestamps and binary formats.
@@ -52,9 +62,12 @@ require 'ulid'
 
 ulid = ULID.generate #=> 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.to_s #=> "01F4A5Y1YAQCYAYCTC7GRMJ9AA"
+ulid.timestamp #=> "01F4A5Y1YA"
+ulid.randomness #=> "QCYAYCTC7GRMJ9AA"
+ulid.to_i #=> 1957909092946624190749577070267409738
 ulid.octets #=> [1, 121, 20, 95, 7, 202, 187, 60, 175, 51, 76, 60, 49, 73, 37, 74]
-ulid.pattern #=> /(?<timestamp>01F4A5Y1YA)(?<randomness>QCYAYCTC7GRMJ9AA)/i
 ```
 
 You can get the objects from exists encoded ULIDs
@@ -64,6 +77,8 @@ ulid = ULID.parse('01ARZ3NDEKTSV4RRFFQ69G5FAV') #=> ULID(2016-07-30 23:54:10.259
 ulid.to_time #=> 2016-07-30 23:54:10.259 UTC
 ```
 
+### Sortable with the timestamp
+
 ULIDs are sortable when they are generated in different timestamp with milliseconds precision
 
 ```ruby
@@ -71,19 +86,20 @@ ulids = 1000.times.map do
   sleep(0.001)
   ULID.generate
 end
-ulids.sort == ulids #=> true
 ulids.uniq(&:to_time).size #=> 1000
+ulids.sort == ulids #=> true
 ```
 
-`ULID.generate` can take fixed `Time` instance
+`ULID.generate` can take fixed `Time` instance. The shorthand is `ULID.at`
 
 ```ruby
-time = Time.at(946684800, in: 'UTC') #=> 2000-01-01 00:00:00 UTC
+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.generate(moment: time + n)
+  ULID.at(time + n)
 end
 ulids.sort == ulids #=> true
 ```
@@ -98,19 +114,21 @@ 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.
+### How to keep `Sortable` even if in same timestamp
+
+If you want to prefer `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,23 +143,50 @@ 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.
-So this gem provides `ULID.range` to generate `Range[ULID]` from given `Range[Time]`
+### Filtering IDs with `Time`
+
+`ULID` can be element of the `Range`. If you generated the IDs in monotonic generator, ID based filtering is easy and reliable
+
+```ruby
+include_end = ulid1..ulid2
+exclude_end = ulid1...ulid2
+
+ulids.grep(one_of_the_above)
+ulids.grep_v(one_of_the_above)
+```
+
+When want to filter ULIDs with `Time`, we should consider to handle the precision.
+So this gem provides `ULID.range` to generate reasonable `Range[ULID]` from `Range[Time]`
 
 ```ruby
 # Both of below, The begin of `Range[ULID]` will be the minimum in the floored milliseconds of the time1
 include_end = ULID.range(time1..time2) #=> The end of `Range[ULID]` will be the maximum in the floored milliseconds of the time2
 exclude_end = ULID.range(time1...time2) #=> The end of `Range[ULID]` will be the minimum in the floored milliseconds of the time2
 
+# Below patterns are acceptable
+pinpointing = ULID.range(time1..time1) #=> This will match only for all IDs in `time1`
+until_the_end = ULID.range(..time1) #=> This will match only for all IDs upto `time1` (The `nil` starting `Range` can be used since Ruby 2.7)
+until_the_end = ULID.range(ULID.min.to_time..time1) #=> This is same as above for Ruby 2.6
+until_the_ulid_limit = ULID.range(time1..) # This will match only for all IDs from `time1` to max value of the ULID limit
+
 # So you can use the generated range objects as below
-ulids.grep(include_end)
-ulids.grep(exclude_end)
+ulids.grep(one_of_the_above)
+ulids.grep_v(one_of_the_above)
 #=> I hope the results should be actually you want!
 ```
 
+If you want to manually handle the Time objects, `ULID.floor` returns new `Time` with truncating excess precisions in ULID spec.
+
+```ruby
+time = Time.at(946684800, Rational('123456.789')).utc #=> 2000-01-01 00:00:00.123456789 UTC
+ULID.floor(time) #=> 2000-01-01 00:00:00.123 UTC
+```
+
+### Scanner for string (e.g. `JSON`)
+
 For rough operations, `ULID.scan` might be useful.
 
 ```ruby
@@ -174,14 +219,28 @@ EOD
 
 ULID.scan(json).to_a
 #=>
-[ULID(2021-04-30 05:51:57.119 UTC: 01F4GNAV5ZR6FJQ5SFQC7WDSY3),
- ULID(2021-04-30 05:52:32.641 UTC: 01F4GNBXW1AM2KWW52PVT3ZY9X),
- ULID(2021-04-30 05:52:56.707 UTC: 01F4GNCNC3CH0BCRZBPPDEKBKS),
- ULID(2021-04-30 05:52:32.641 UTC: 01F4GNBXW1AM2KWW52PVT3ZY9X),
- ULID(2021-04-30 05:53:04.852 UTC: 01F4GNCXAMXQ1SGBH5XCR6ZH0M),
- ULID(2021-04-30 05:53:12.478 UTC: 01F4GND4RYYSKNAADHQ9BNXAWJ)]
+# [ULID(2021-04-30 05:51:57.119 UTC: 01F4GNAV5ZR6FJQ5SFQC7WDSY3),
+#  ULID(2021-04-30 05:52:32.641 UTC: 01F4GNBXW1AM2KWW52PVT3ZY9X),
+#  ULID(2021-04-30 05:52:56.707 UTC: 01F4GNCNC3CH0BCRZBPPDEKBKS),
+#  ULID(2021-04-30 05:52:32.641 UTC: 01F4GNBXW1AM2KWW52PVT3ZY9X),
+#  ULID(2021-04-30 05:53:04.852 UTC: 01F4GNCXAMXQ1SGBH5XCR6ZH0M),
+#  ULID(2021-04-30 05:53:12.478 UTC: 01F4GND4RYYSKNAADHQ9BNXAWJ)]
 ```
 
+`ULID#patterns` is a util for text based operations.
+The results and spec are not fixed. Should not be used except snippets/console operation
+
+```ruby
+ULID.parse('01F4GNBXW1AM2KWW52PVT3ZY9X').patterns
+#=> returns like a fallowing Hash
+{
+  named_captures: /(?<timestamp>01F4GNBXW1)(?<randomness>AM2KWW52PVT3ZY9X)/i,
+  strict_named_captures: /\A(?<timestamp>01F4GNBXW1)(?<randomness>AM2KWW52PVT3ZY9X)\z/i
+}
+```
+
+### Some methods to help manipulations
+
 `ULID.min` and `ULID.max` return termination values for ULID spec.
 
 ```ruby
@@ -193,7 +252,10 @@ ULID.min(moment: time) #=> ULID(2000-01-01 00:00:00.123 UTC: 00VHNCZB3V000000000
 ULID.max(moment: time) #=> ULID(2000-01-01 00:00:00.123 UTC: 00VHNCZB3VZZZZZZZZZZZZZZZZ)
 ```
 
-`ULID#next` and `ULID#succ` returns next(successor) ULID
+`ULID#next` and `ULID#succ` returns next(successor) ULID.
+Especially `ULID#succ` makes it possible `Range[ULID]#each`.
+
+NOTE: But basically `Range[ULID]#each` should not be used, incrementing 128 bits IDs are not reasonable operation in most case
 
 ```ruby
 ULID.parse('01BX5ZZKBKZZZZZZZZZZZZZZZY').next.to_s #=> "01BX5ZZKBKZZZZZZZZZZZZZZZZ"
@@ -209,17 +271,141 @@ 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.)
+`ULID.sample` returns random ULIDs.
+
+Basically ignores generating time.
 
 ```ruby
-ULID.from_uuidv4('0983d0a2-ff15-4d83-8f37-7dd945b5aa39')
-#=> ULID(2301-07-10 00:28:28.821 UTC: 09GF8A5ZRN9P1RYDVXV52VBAHS)
+ULID.sample #=> ULID(2545-07-26 06:51:20.085 UTC: 0GGKQ45GMNMZR6N8A8GFG0ZXST)
+ULID.sample #=> ULID(5098-07-26 21:31:06.946 UTC: 2SSBNGGYA272J7BMDCG4Z6EEM5)
+ULID.sample(0) #=> []
+ULID.sample(1) #=> [ULID(2241-04-16 03:31:18.440 UTC: 07S52YWZ98AZ8T565MD9VRYMQH)]
+ULID.sample(5)
+#=>
+#[ULID(5701-04-29 12:41:19.647 UTC: 3B2YH2DV0ZYDDATGTYSKMM1CMT),
+# ULID(2816-08-01 01:21:46.612 UTC: 0R9GT6RZKMK3RG02Q2HAFVKEY2),
+# ULID(10408-10-05 17:06:27.848 UTC: 7J6CPTEEC86Y24EQ4F1Y93YYN0),
+# ULID(2741-09-02 16:24:18.803 UTC: 0P4Q4V34KKAJW46QW47WQB5463),
+# 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.
+The imported timestamp is meaningless. So ULID's benefit will lost.
+
+```ruby
+# Currently experimental feature, so needed to load the extension.
+require 'ulid/uuid'
+
+# 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
+```
+
+## How to migrate from other gems
+
+As far as I know, major prior arts are below
+
+### [ulid gem](https://rubygems.org/gems/ulid) - [rafaelsales/ulid](https://github.com/rafaelsales/ulid)
+
+It is just providing basic `String` generator only.
+So you can replace the code as below
+
+```diff
+-ULID.generate
++ULID.generate.to_s
+```
+
+NOTE: It had crucial issue for handling precision, in version before `1.3.0`, when you extract timestamps from old generated ULIDs, it might be not accurate value.
+
+1. [Sort order does not respect millisecond ordering](https://github.com/rafaelsales/ulid/issues/22)
+1. [Fixed in this PR](https://github.com/rafaelsales/ulid/pull/23)
+1. [Released in 1.3.0](https://github.com/rafaelsales/ulid/compare/1.2.0...v1.3.0)
+
+### [ulid-ruby gem](https://rubygems.org/gems/ulid-ruby) - [abachman/ulid-ruby](https://github.com/abachman/ulid-ruby)
+
+It is providing basic generator(except monotonic generator) and parser.
+Major methods can be replaced as below.
+
+```diff
+-ULID.generate
++ULID.generate.to_s
+-ULID.at(time)
++ULID.at(time).to_s
+-ULID.time(string)
++ULID.parse(string).to_time
+-ULID.min_ulid_at(time)
++ULID.min(moment: time).to_s
+-ULID.max_ulid_at(time)
++ULID.max(moment: time).to_s
+```
+
+NOTE: It is still having precision issue similar as `ulid gem` in the both generator and parser. I sent PRs.
+
+1. [Parsed time object has more than milliseconds](https://github.com/abachman/ulid-ruby/issues/3)
+1. [Fix to handle timestamp precision in parser](https://github.com/abachman/ulid-ruby/pull/5)
+1. [Fix to handle timestamp precision in generator](https://github.com/abachman/ulid-ruby/pull/4)
+
 ## References
 
 - [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

@@ -3,7 +3,6 @@
 # Copyright (C) 2021 Kenichi Kamiya
 
 require 'securerandom'
-require 'integer/base'
 
 # @see https://github.com/ulid/spec
 # @!attribute [r] milliseconds
@@ -17,30 +16,37 @@ class ULID
   class OverflowError < Error; end
   class ParserError < Error; end
 
-  encoding_string = '0123456789ABCDEFGHJKMNPQRSTVWXYZ'
-  # Crockford's Base32. Excluded I, L, O, U.
-  # @see https://www.crockford.com/base32.html
-  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_PART_LENGTH = 10
-  RANDOMNESS_PART_LENGTH = 16
-  ENCODED_ID_LENGTH = TIMESTAMP_PART_LENGTH + RANDOMNESS_PART_LENGTH
+  TIMESTAMP_ENCODED_LENGTH = 10
+  RANDOMNESS_ENCODED_LENGTH = 16
+  ENCODED_LENGTH = TIMESTAMP_ENCODED_LENGTH + RANDOMNESS_ENCODED_LENGTH
   TIMESTAMP_OCTETS_LENGTH = 6
   RANDOMNESS_OCTETS_LENGTH = 10
   OCTETS_LENGTH = TIMESTAMP_OCTETS_LENGTH + RANDOMNESS_OCTETS_LENGTH
   MAX_MILLISECONDS = 281474976710655
   MAX_ENTROPY = 1208925819614629174706175
   MAX_INTEGER = 340282366920938463463374607431768211455
-  PATTERN = /(?<timestamp>[0-7][#{encoding_string}]{#{TIMESTAMP_PART_LENGTH - 1}})(?<randomness>[#{encoding_string}]{#{RANDOMNESS_PART_LENGTH}})/i.freeze
-  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
+  # @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'
 
+  private_class_method :new
+
   # @param [Integer, Time] moment
   # @param [Integer] entropy
   # @return [ULID]
@@ -48,30 +54,75 @@ class ULID
     new milliseconds: milliseconds_from_moment(moment), entropy: entropy
   end
 
-  # @param [Integer, Time] moment
+  # Short hand of `ULID.generate(moment: time)`
+  # @param [Time] time
   # @return [ULID]
-  def self.min(moment: 0)
-    generate(moment: moment, entropy: 0)
+  def self.at(time)
+    raise ArgumentError, 'ULID.at takes only `Time` instance' unless Time === time
+    new milliseconds: milliseconds_from_time(time), entropy: reasonable_entropy
   end
 
   # @param [Integer, Time] moment
   # @return [ULID]
-  def self.max(moment: MAX_MILLISECONDS)
-    generate(moment: moment, entropy: MAX_ENTROPY)
+  def self.min(moment: 0)
+    0.equal?(moment) ? MIN : generate(moment: moment, entropy: 0)
   end
 
-  # @deprecated This method actually changes class state. Use {ULID::MonotonicGenerator} instead.
-  # @raise [OverflowError] if the entropy part is larger than the ULID limit in same milliseconds
+  # @param [Integer, Time] moment
   # @return [ULID]
-  def self.monotonic_generate
-    warning = "`ULID.monotonic_generate` actually changes class state. Use `ULID::MonotonicGenerator` instead."
-    if RUBY_VERSION >= '3.0'
-      Warning.warn(warning, category: :deprecated)
+  def self.max(moment: MAX_MILLISECONDS)
+    MAX_MILLISECONDS.equal?(moment) ? MAX : generate(moment: moment, entropy: MAX_ENTROPY)
+  end
+
+  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(*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
-      Warning.warn(warning)
+      RANDOM_INTEGER_GENERATOR
     end
 
-    MONOTONIC_GENERATOR.generate
+    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 period && (number > possibilities)
+        raise ArgumentError, "given number #{number} is larger than given possibilities #{possibilities}"
+      end
+
+      Array.new(number) { from_integer(int_generator.call) }
+    else
+      raise ArgumentError, "wrong number of arguments (given #{args.size}, expected 0..1)"
+    end
   end
 
   # @param [String, #to_str] string
@@ -79,84 +130,81 @@ 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
 
-  # @param [String, #to_str] uuid
-  # @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}"
-    end
-  end
-
   # @param [Integer, #to_int] integer
   # @return [ULID]
   # @raise [OverflowError] if the given integer is larger than the ULID limit
   # @raise [ArgumentError] if the given integer is negative number
-  # @todo Need optimized for performance
   def self.from_integer(integer)
     integer = integer.to_int
     raise OverflowError, "integer overflow: given #{integer}, max: #{MAX_INTEGER}" unless integer <= MAX_INTEGER
     raise ArgumentError, "integer should not be negative: given: #{integer}" if integer.negative?
 
-    octets = octets_from_integer(integer, length: OCTETS_LENGTH).freeze
-    time_octets = octets.slice(0, TIMESTAMP_OCTETS_LENGTH).freeze
-    randomness_octets = octets.slice(TIMESTAMP_OCTETS_LENGTH, RANDOMNESS_OCTETS_LENGTH).freeze
-    milliseconds = inverse_of_digits(time_octets)
-    entropy = inverse_of_digits(randomness_octets)
+    n32encoded = integer.to_s(32).rjust(ENCODED_LENGTH, '0')
+    n32encoded_timestamp = n32encoded.slice(0, TIMESTAMP_ENCODED_LENGTH)
+    n32encoded_randomness = n32encoded.slice(TIMESTAMP_ENCODED_LENGTH, RANDOMNESS_ENCODED_LENGTH)
+
+    milliseconds = n32encoded_timestamp.to_i(32)
+    entropy = n32encoded_randomness.to_i(32)
 
-    new milliseconds: milliseconds, entropy: entropy
+    new milliseconds: milliseconds, entropy: entropy, integer: integer
   end
 
-  # @param [Range<Time>] time_range
+  # @param [Range<Time>, Range<nil>, Range[ULID]] period
   # @return [Range<ULID>]
-  def self.range(time_range)
-    raise ArgumentError, 'ULID.range takes only Range[Time]' 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
+      begin_ulid = MIN
+    when self
+      begin_ulid = begin_element
     else
-      raise ArgumentError, 'ULID.range takes only Range[Time]'
+      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
+      end_ulid = MAX
       exclude_end = false
+    when self
+      end_ulid = end_element
     else
-      raise ArgumentError, 'ULID.range takes only Range[Time]'
+      raise ArgumentError, "ULID.range takes only `Range[Time]` or `Range[nil]`, given: #{period.inspect}"
     end
 
+    begin_ulid.freeze
+    end_ulid.freeze
+
     Range.new(begin_ulid, end_ulid, exclude_end)
   end
 
   # @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
@@ -164,6 +212,7 @@ class ULID
     end
   end
 
+  # @api private
   # @return [Integer]
   def self.current_milliseconds
     milliseconds_from_time(Time.now)
@@ -171,16 +220,25 @@ class ULID
 
   # @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
 
+  # @api private
   # @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
   # @return [Integer]
   def self.reasonable_entropy
     SecureRandom.random_number(MAX_ENTROPY)
@@ -189,56 +247,30 @@ class ULID
   # @param [String, #to_str] string
   # @return [ULID]
   # @raise [ParserError] if the given format is not correct for ULID specs
-  # @raise [OverflowError] if the given value is larger than the ULID limit
   def self.parse(string)
-    begin
-      string = string.to_str
-      unless string.size == ENCODED_ID_LENGTH
-        raise "parsable string must be #{ENCODED_ID_LENGTH} characters, but actually given #{string.size} characters"
-      end
-      timestamp = string.slice(0, TIMESTAMP_PART_LENGTH)
-      randomness = string.slice(TIMESTAMP_PART_LENGTH, RANDOMNESS_PART_LENGTH)
-      milliseconds = Integer::Base.parse(timestamp, ENCODING_CHARS)
-      entropy = Integer::Base.parse(randomness, ENCODING_CHARS)
-    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
-  
-    new milliseconds: milliseconds, entropy: entropy
+
+    from_integer(CrockfordBase32.decode(string))
   end
 
+  # @param [String, #to_str] string
   # @return [Boolean]
   def self.valid?(string)
-    parse(string)
-  rescue Exception
-    false
-  else
-    true
+    string = String.try_convert(string)
+    string ? STRICT_PATTERN_WITH_CROCKFORD_BASE32_SUBSET.match?(string) : false
   end
 
   # @api private
-  # @param [Integer] integer
-  # @param [Integer] length
-  # @return [Array<Integer>]
-  def self.octets_from_integer(integer, length:)
-    digits = integer.digits(256)
-    (length - digits.size).times do
-      digits.push 0
-    end
-    digits.reverse!
-  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
+  # @param [MonotonicGenerator] generator
+  # @return [ULID]
+  def self.from_monotonic_generator(generator)
+    raise ArgumentError, 'this method provided only for MonotonicGenerator' unless MonotonicGenerator === generator
+    new milliseconds: generator.latest_milliseconds, entropy: generator.latest_entropy
   end
 
   attr_reader :milliseconds, :entropy
@@ -246,15 +278,21 @@ class ULID
   # @api private
   # @param [Integer] milliseconds
   # @param [Integer] entropy
+  # @param [Integer] integer
   # @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:)
-    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?
+  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?
+    end
 
     @milliseconds = milliseconds
     @entropy = entropy
@@ -262,18 +300,22 @@ class ULID
 
   # @return [String]
   def to_s
-    @string ||= Integer::Base.string_for(to_i, ENCODING_CHARS).rjust(ENCODED_ID_LENGTH, '0').upcase.freeze
+    @string ||= CrockfordBase32.encode(to_i).freeze
   end
 
   # @return [Integer]
   def to_i
-    @integer ||= self.class.inverse_of_digits(octets)
+    @integer ||= begin
+      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).to_i(32)
+    end
   end
   alias_method :hash, :to_i
 
   # @return [Integer, nil]
   def <=>(other)
-    other.kind_of?(ULID) ? (to_i <=> other.to_i) : nil
+    (ULID === other) ? (to_i <=> other.to_i) : nil
   end
 
   # @return [String]
@@ -283,7 +325,7 @@ class ULID
 
   # @return [Boolean]
   def eql?(other)
-    other.equal?(self) || (other.kind_of?(ULID) && other.to_i == to_i)
+    equal?(other) || (ULID === other && to_i == other.to_i)
   end
   alias_method :==, :eql?
 
@@ -291,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
@@ -316,79 +354,96 @@ class ULID
 
   # @return [Array(Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer)]
   def octets
-    @octets ||= (timestamp_octets + randomness_octets).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 ||= self.class.octets_from_integer(@milliseconds, length: 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 ||= self.class.octets_from_integer(@entropy, length: RANDOMNESS_OCTETS_LENGTH).freeze
+    octets.slice(TIMESTAMP_OCTETS_LENGTH, RANDOMNESS_OCTETS_LENGTH)
   end
 
   # @return [String]
   def timestamp
-    @timestamp ||= matchdata[:timestamp].freeze
+    @timestamp ||= to_s.slice(0, TIMESTAMP_ENCODED_LENGTH).freeze
   end
 
   # @return [String]
   def randomness
-    @randomness ||= matchdata[:randomness].freeze
-  end
-
-  # @return [Regexp]
-  def pattern
-    @pattern ||= /(?<timestamp>#{timestamp})(?<randomness>#{randomness})/i.freeze
+    @randomness ||= to_s.slice(TIMESTAMP_ENCODED_LENGTH, RANDOMNESS_ENCODED_LENGTH).freeze
   end
 
-  # @return [Regexp]
-  def strict_pattern
-    @strict_pattern ||= /\A#{pattern.source}\z/i.freeze
+  # @note Providing for rough operations. The keys and values is not fixed.
+  # @return [Hash{Symbol => Regexp, String}]
+  def patterns
+    named_captures = /(?<timestamp>#{timestamp})(?<randomness>#{randomness})/i.freeze
+    {
+      named_captures: named_captures,
+      strict_named_captures: /\A#{named_captures.source}\z/i.freeze
+    }
   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]
   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
 
   private
 
-  # @return [MatchData]
-  def matchdata
-    @matchdata ||= STRICT_PATTERN.match(to_s).freeze
+  # @return [void]
+  def cache_all_instance_variables
+    inspect
+    timestamp
+    randomness
   end
 end
 
 require_relative 'ulid/version'
+require_relative 'ulid/crockford_base32'
 require_relative 'ulid/monotonic_generator'
 
 class ULID
-  MONOTONIC_GENERATOR = MonotonicGenerator.new
+  MIN = parse('00000000000000000000000000').freeze
+  MAX = parse('7ZZZZZZZZZZZZZZZZZZZZZZZZZ').freeze
 
-  private_constant :ENCODING_CHARS, :TIME_FORMAT_IN_INSPECT, :UUIDV4_PATTERN
+  private_constant :TIME_FORMAT_IN_INSPECT, :MIN, :MAX, :RANDOM_INTEGER_GENERATOR
 end