ruby-ulid 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9517a4c0fe5e9feec91b2d8e19366baed6b8f1c1ccb42640389c1ad11066854
-  data.tar.gz: 24344ffd2549f7eae76f6f344169eb74baf3168e05499a9d7577a18fea63fc4d
+  metadata.gz: 04b50bb9543b78d03a0e1676b988060b3e34348c0785979fde52c46e414be1d8
+  data.tar.gz: bf070ba0522e8ce743c67bcfa225bf5b49009ae4ecd6532eef19484d51eb14ce
 SHA512:
-  metadata.gz: 5420da3cddc622a02a9d84ba398c17f59c733eea62d122aef0e5fb39dfade8e76cb3e4608814a0afb5c2e0251c6ebbbb2a10c6b27ea68b4ff8e32ad9f2e31ee3
-  data.tar.gz: 7bb4f8f941ed3f3ec2d5ebef03b4559b1ba2b07eaf5a9970ee3936ba6157bf5ff818eabc63847ba973536910bd6e8b8c65ae3382b74a368af85e228fec6524dd
+  metadata.gz: 4ad79f68c4903f775750417085676a98e810cae71b635b0b0e3e5547dd8b652a6bd89b01cb452510054f400a9bfef7ae26e308456d46a7571be10cb7ef1f334f
+  data.tar.gz: 88769b682521bb83b3775784e808b4e08636313d2055c7afe1f6b3a966e211237c597e0c354e0a6a6a26e227246c96845671f24cd7ebb8bf9d93014d043147f0

data/README.md

@@ -10,7 +10,7 @@ Also providing [ruby/rbs](https://github.com/ruby/rbs) signature files.
 
 ![ULIDlogo](https://raw.githubusercontent.com/kachick/ruby-ulid/main/logo.png)
 
-![Build Status](https://github.com/kachick/ruby-ulid/actions/workflows/test.yml/badge.svg?branch=main)
+![Build Status](https://github.com/kachick/ruby-ulid/actions/workflows/test_behaviors.yml/badge.svg?branch=main)
 [![Gem Version](https://badge.fury.io/rb/ruby-ulid.png)](http://badge.fury.io/rb/ruby-ulid)
 
 ## Universally Unique Lexicographically Sortable Identifier
@@ -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.1.1', '< 0.2.0'
+gem 'ruby-ulid', '>= 0.1.2', '< 0.2.0'
 ```
 
 ### Generator and Parser
@@ -170,7 +170,7 @@ exclude_end = ULID.range(time1...time2) #=> The end of `Range[ULID]` will be the
 
 # 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(..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
 
@@ -313,7 +313,7 @@ ulids.take(10)
 # 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),
@@ -335,7 +335,7 @@ The imported timestamp is meaningless. So ULID's benefit will lost.
 # Currently experimental feature, so needed to load the extension.
 require 'ulid/uuid'
 
-# Basically reversible 
+# 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"
 
@@ -403,81 +403,11 @@ NOTE: It is still having precision issue similar as `ulid gem` in the both gener
 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)
 
-### Generating benchmarks
-
-This runs rough benchmarks
-
-```console
-$ rake benchmark_with_other_gems
-(Do not use `bundle exec`!)
-```
-
-<details>
-<summary>One of the result at 2021/05/10 on my machine</summary>
-
-```plaintext
-#### rafaelsales - ulid
-cd ./benchmark/compare_with_othergems/rafaelsales && bundle install --quiet && bundle exec ruby -v ./generate.rb
-ruby 3.0.1p64 (2021-04-05 revision 0fb782ee38) [x86_64-darwin20]
-Warming up --------------------------------------
-       ULID.generate     5.560k i/100ms
-Calculating -------------------------------------
-       ULID.generate     52.655k (±11.0%) i/s -    261.320k in   5.029719s
-"`ulid gem - 1.3.0` generated products: 371927 - sample: [\"01F59Y97807D2S67KE6X7ATK7Z\", \"01F59Y9AVRQJFAT5M2N7Z72BVF\", \"01F59Y95Z1042X4Z1K9729BSE3\", \"01F59Y95ZMVDFKD63Y8TT145GQ\", \"01F59Y94YQEZ3PH5STZ8PS1JPG\"]"
-------------------------------------------------------------------------
-#### abachman - ulid-ruby
-cd ./benchmark/compare_with_othergems/abachman && bundle install --quiet && bundle exec ruby -v ./generate.rb
-ruby 3.0.1p64 (2021-04-05 revision 0fb782ee38) [x86_64-darwin20]
-Warming up --------------------------------------
-       ULID.generate     3.862k i/100ms
-Calculating -------------------------------------
-       ULID.generate     38.415k (±13.1%) i/s -    189.238k in   5.025788s
-"`ulid-ruby gem - 1.0.0` generated products: 260625 - sample: [\"01F59Y9H9V17EPXTYNZDCXB9EZ\", \"01F59Y9J4S4XZ68MF5DJDWHTAC\", \"01F59Y9J8887VC8E850QSBDCDX\", \"01F59Y9JEJPD088EYXVHB86W3N\", \"01F59Y9GGAZFXGCB92EQD695CZ\"]"
-------------------------------------------------------------------------
-#### kachick - ruby-ulid(This one)
-cd ./benchmark/compare_with_othergems/kachick && bundle install --quiet && bundle exec ruby -v ./generate.rb
-ruby 3.0.1p64 (2021-04-05 revision 0fb782ee38) [x86_64-darwin20]
-Warming up --------------------------------------
-  ULID.generate.to_s     3.185k i/100ms
-Calculating -------------------------------------
-  ULID.generate.to_s     31.934k (± 9.1%) i/s -    159.250k in   5.030707s
-"`ruby-ulid gem (this one) - 0.1.0` generated products: 223867 - sample: [\"01F59Y9SPZHM6JCTYP50CHGVAX\", \"01F59Y9VB7X0SX32MMKF78KJR3\", \"01F59Y9W0C83RYCNYVH84R4JG3\", \"01F59Y9V218Q3D4YP3W74ET3EW\", \"01F59Y9X6DD8NX99WBGCR7RNXF\"]"
-```
+### Compare performance with them
 
-In another execution, Changed as below. So there doesn't seem to be a big difference.
-
-```plaintext
-#### rafaelsales - ulid
-cd ./benchmark/compare_with_othergems/rafaelsales && bundle install --quiet && bundle exec ruby -v ./generate.rb
-ruby 3.0.1p64 (2021-04-05 revision 0fb782ee38) [x86_64-darwin20]
-Warming up --------------------------------------
-       ULID.generate     2.473k i/100ms
-Calculating -------------------------------------
-       ULID.generate     24.101k (±15.9%) i/s -    118.704k in   5.066190s
-"`ulid gem - 1.3.0` generated products: 164763 - sample: [\"01F59YEGPFMXXZWC1YQ49TSK8Y\", \"01F59YEFF7VX5WAW91VTCSE2N9\", \"01F59YEEZ5P9428SDYEDYW8D27\", \"01F59YEHVK56DZBJSNSQK6V1W6\", \"01F59YEHE07M98PVV97ABBAKHM\"]"
-------------------------------------------------------------------------
-#### abachman - ulid-ruby
-cd ./benchmark/compare_with_othergems/abachman && bundle install --quiet && bundle exec ruby -v ./generate.rb
-ruby 3.0.1p64 (2021-04-05 revision 0fb782ee38) [x86_64-darwin20]
-Warming up --------------------------------------
-       ULID.generate     2.620k i/100ms
-Calculating -------------------------------------
-       ULID.generate     27.571k (±14.2%) i/s -    136.240k in   5.056272s
-"`ulid-ruby gem - 1.0.0` generated products: 186683 - sample: [\"01F59YEVX6GC9TC0RCZ74RC6Z3\", \"01F59YESJXWYGZ61TXHKRVKS97\", \"01F59YEVQ4QQKBED5T49RTV1MA\", \"01F59YEPJ6MMZY1N63DNW7C4SN\", \"01F59YEQK52K8TKTP1ESC6VC5X\"]"
-------------------------------------------------------------------------
-#### kachick - ruby-ulid(This one)
-cd ./benchmark/compare_with_othergems/kachick && bundle install --quiet && bundle exec ruby -v ./generate.rb
-ruby 3.0.1p64 (2021-04-05 revision 0fb782ee38) [x86_64-darwin20]
-Warming up --------------------------------------
-  ULID.generate.to_s     3.014k i/100ms
-Calculating -------------------------------------
-  ULID.generate.to_s     31.612k (±10.1%) i/s -    156.728k in   5.013432s
-"`ruby-ulid gem (this one) - 0.1.0` generated products: 212293 - sample: [\"01F59YF1WP49TT4GQPDN3E9JTJ\", \"01F59YF1MW1ZDQW93NX4J6RG4G\", \"01F59YF0KRX2CZKHDQQSN5HXHW\", \"01F59YEZVNH8YHP4ZHDK2ZRWSR\", \"01F59YF1J0FV3CVV099SHA2Q9A\"]"
-```
+See [Benchmark](https://github.com/kachick/ruby-ulid/wiki/Benchmark).
 
-I have an excuse, This gem does not aim `faster than other`.
-So I think the results are acceptable.
-</details>
+The results are not something to be proud of.
 
 ## References
 

data/lib/ulid.rb

@@ -259,10 +259,9 @@ class ULID
     from_integer(CrockfordBase32.decode(string))
   end
 
-  # @param [String, #to_str] string
   # @return [Boolean]
-  def self.valid?(string)
-    string = String.try_convert(string)
+  def self.valid?(object)
+    string = String.try_convert(object)
     string ? STRICT_PATTERN_WITH_CROCKFORD_BASE32_SUBSET.match?(string) : false
   end
 

data/lib/ulid/crockford_base32.rb

@@ -51,6 +51,7 @@ class ULID
     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
 
+    # @api private
     # @param [String] string
     # @return [Integer]
     def self.decode(string)
@@ -58,6 +59,7 @@ class ULID
       n32encoded.to_i(32)
     end
 
+    # @api private
     # @param [Integer] integer
     # @return [String]
     def self.encode(integer)

data/lib/ulid/uuid.rb

@@ -18,7 +18,7 @@ class ULID
     uuid = String.try_convert(uuid)
     raise ArgumentError, 'ULID.from_uuidv4 takes only strings' unless uuid
 
-    prefix_trimmed = uuid.sub(/\Aurn:uuid:/, '')
+    prefix_trimmed = uuid.delete_prefix('urn:uuid:')
     unless UUIDV4_PATTERN.match?(prefix_trimmed)
       raise ParserError, "given `#{uuid}` does not match to `#{UUIDV4_PATTERN.inspect}`"
     end

data/lib/ulid/version.rb

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

data/sig/ulid.rbs

@@ -1,5 +1,4 @@
-# Classes
-class ULID
+class ULID < Object
   VERSION: String
   CROCKFORD_BASE32_ENCODING_STRING: String
   TIMESTAMP_ENCODED_LENGTH: 10
@@ -45,21 +44,28 @@ class ULID
     CROCKFORD_BASE32_CHAR_BY_N32_CHAR: Hash[String, String]
     N32_CHAR_PATTERN: Regexp
 
+    # A pribate API. Should not be used in your code.
     def self.encode: (Integer integer) -> String
+
+    # A pribate API. Should not be used in your code.
     def self.decode: (String string) -> Integer
   end
 
   class MonotonicGenerator
     @mutex: Thread::Mutex
     attr_reader prev: ULID | nil
+
+    # A pribate API. Should not be used in your code.
     def initialize: -> void
+
+    # See [How to keep `Sortable` even if in same timestamp](https://github.com/kachick/ruby-ulid#how-to-keep-sortable-even-if-in-same-timestamp)
     def generate: (?moment: moment) -> ULID
     def inspect: -> String
     alias to_s inspect
     def freeze: -> void
   end
 
-  interface _ULID
+  interface _ToULID
     def to_ulid: () -> ULID
   end
 
@@ -75,57 +81,409 @@ class ULID
   @inspect: String?
   @time: Time?
 
+  # Retuns a ULID
+  #
+  # They are sortable when generated in different timestamp with milliseconds precision
+  #
+  # ```ruby
+  # ulids = 1000.times.map do
+  #   sleep(0.001)
+  #   ULID.generate
+  # end
+  # ulids.uniq(&:to_time).size #=> 1000
+  # ulids.sort == ulids #=> true
+  # ```
+  #
+  # `ULID.generate` can take fixed `Time` instance.
+  #  See also the short hand [ULID.at](https://kachick.github.io/ruby-ulid/ULID.html#at-class_method)
+  #
+  # ```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)
+  # ```
+  #
+  # The basic generator prefers `randomness`, it does not guarantee `sortable` for same milliseconds ULIDs.
+  #
+  # ```ruby
+  # ulids = 10000.times.map do
+  #   ULID.generate
+  # end
+  # ulids.uniq(&:to_time).size #=> 35 (the size is not fixed, might be changed in environment)
+  # ulids.sort == ulids #=> false
+  # ```
+  #
+  # If you want to keep sortable even if in same timestamp, See also [ULID::MonotonicGenerator](https://github.com/kachick/ruby-ulid#how-to-keep-sortable-even-if-in-same-timestamp)
+  #
   def self.generate: (?moment: moment, ?entropy: Integer) -> self
+
+  # Shorthand of `ULID.generate(moment: Time)`
+  # See also [ULID.generate](https://kachick.github.io/ruby-ulid/ULID.html#generate-class_method)
+  #
+  # ```ruby
+  # time = Time.at(946684800).utc #=> 2000-01-01 00:00:00 UTC
+  # 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
+  # ```
   def self.at: (Time time) -> self
+
+  # A pribate API. Should not be used in your code.
   def self.current_milliseconds: -> Integer
+
+  # A pribate API. Should not be used in your code.
   def self.milliseconds_from_moment: (moment moment) -> Integer
+
+  # `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(one_of_the_above)
+  # ulids.grep_v(one_of_the_above)
+  # #=> I hope the results should be actually you want!
+  # ```
+  #
   def self.range: (period period) -> Range[ULID]
+
+  # 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
+  # ```
   def self.floor: (Time time) -> Time
-  def self.parse: (String string) -> self
+
+  # Get ULID instance from encoded String.
+  #
+  # ```ruby
+  # ulid = ULID.parse('01ARZ3NDEKTSV4RRFFQ69G5FAV')
+  # #=> ULID(2016-07-30 23:54:10.259 UTC: 01ARZ3NDEKTSV4RRFFQ69G5FAV)
+  # ```
+  def self.parse: (_ToStr string) -> self
+
+  # ```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"
+  # ```
+  #
+  # See also [Why this is experimental?](https://github.com/kachick/ruby-ulid/issues/76)
   def self.from_uuidv4: (String uuid) -> ULID
   def self.from_integer: (Integer integer) -> self
+
+  # Returns termination values for ULID spec.
+  #
+  # ```ruby
+  # ULID.min
+  # #=> ULID(1970-01-01 00:00:00.000 UTC: 00000000000000000000000000)
+  # ```
+  #
+  # It can take `Time` instance as an optional argument.
+  # Then returns ULID that has minimum value of randomness part in the timestamp.
+  #
+  # ```ruby
+  # time = Time.at(946684800, Rational('123456.789')).utc
+  # #=> 2000-01-01 00:00:00.123456789 UTC
+  # ULID.min(time)
+  # #=> ULID(2000-01-01 00:00:00.123 UTC: 00VHNCZB3V0000000000000000)
+  # ```
+  #
+  # See also [ULID.max](https://kachick.github.io/ruby-ulid/ULID.html#max-class_method)
   def self.min: (?moment moment) -> ULID
+
+  # Returns termination values for ULID spec.
+  #
+  # ```ruby
+  # ULID.max
+  # #=> ULID(10889-08-02 05:31:50.655 UTC: 7ZZZZZZZZZZZZZZZZZZZZZZZZZ)
+  # ```
+  #
+  # It can take `Time` instance as an optional argument.
+  # Then returns ULID that has maximum value of randomness part in the timestamp.
+  #
+  # ```ruby
+  # time = Time.at(946684800, Rational('123456.789')).utc
+  # #=> 2000-01-01 00:00:00.123456789 UTC
+  # ULID.max(time)
+  # #=> ULID(2000-01-01 00:00:00.123 UTC: 00VHNCZB3VZZZZZZZZZZZZZZZZ)
+  # ```
+  #
+  # See also [ULID.min](https://kachick.github.io/ruby-ulid/ULID.html#min-class_method)
   def self.max: (?moment moment) -> ULID
+
+  # Returns random ULIDs.
+  #
+  # Basically ignores generating time.
+  #
+  # ```ruby
+  # 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](https://kachick.github.io/ruby-ulid/ULID.html#range-class_method).
+  #
+  # ```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)]
+  # ```
   def self.sample: (?period: period) -> self
                  | (Integer number, ?period: period) -> Array[self]
-  def self.valid?: (untyped string) -> bool
-  def self.scan:  (String string) -> Enumerator[self, singleton(ULID)]
-                | (String string) { (self ulid) -> void } -> singleton(ULID)
+  def self.valid?: (untyped) -> bool
+
+  # Returns parsed ULIDs from given String for rough operations.
+  #
+  # ```ruby
+  # json =<<'EOD'
+  # {
+  #   "id": "01F4GNAV5ZR6FJQ5SFQC7WDSY3",
+  #   "author": {
+  #     "id": "01F4GNBXW1AM2KWW52PVT3ZY9X",
+  #     "name": "kachick"
+  #   },
+  #   "title": "My awesome blog post",
+  #   "comments": [
+  #     {
+  #       "id": "01F4GNCNC3CH0BCRZBPPDEKBKS",
+  #       "commenter": {
+  #         "id": "01F4GNBXW1AM2KWW52PVT3ZY9X",
+  #         "name": "kachick"
+  #       }
+  #     },
+  #     {
+  #       "id": "01F4GNCXAMXQ1SGBH5XCR6ZH0M",
+  #       "commenter": {
+  #         "id": "01F4GND4RYYSKNAADHQ9BNXAWJ",
+  #         "name": "pankona"
+  #       }
+  #     }
+  #   ]
+  # }
+  # 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)]
+  # ```
+  def self.scan:  (_ToStr string) -> Enumerator[self, singleton(ULID)]
+                | (_ToStr string) { (self ulid) -> void } -> singleton(ULID)
   def self.from_milliseconds_and_entropy: (milliseconds: Integer, entropy: Integer) -> self
-  def self.try_convert: (_ULID) -> self
+  def self.try_convert: (_ToULID) -> ULID
                       | (untyped) -> nil
+
+  # ```ruby
+  # ulid = ULID.generate
+  # #=> ULID(2021-04-27 17:27:22.826 UTC: 01F4A5Y1YAQCYAYCTC7GRMJ9AA)
+  # ulid.milliseconds #=> 1619544442826
+  # ```
   attr_reader milliseconds: Integer
   attr_reader entropy: Integer
-  def initialize: (milliseconds: Integer, entropy: Integer, integer: Integer) -> void
+
+  # ```ruby
+  # ulid = ULID.generate
+  # #=> ULID(2021-04-27 17:27:22.826 UTC: 01F4A5Y1YAQCYAYCTC7GRMJ9AA)
+  # ulid.to_s #=> "01F4A5Y1YAQCYAYCTC7GRMJ9AA"
+  # ```
   def to_s: -> String
+
+  # ```ruby
+  # ulid = ULID.generate
+  # #=> ULID(2021-04-27 17:27:22.826 UTC: 01F4A5Y1YAQCYAYCTC7GRMJ9AA)
+  # ulid.to_i #=> 1957909092946624190749577070267409738
+  # ```
   def to_i: -> Integer
   alias hash to_i
+
+  # Basically same as String based sort.
+  #
+  # ```ruby
+  # ulids = ULID.sample(10000); nil
+  # ulids.map(&:to_s).sort == ulids.sort.map(&:to_s)
+  # #=> true
+  # ```
+  #
+  # To be precise, this sorting unaffected with `case sensitive or not` and might handle [ulid/spec#57](https://github.com/ulid/spec/pull/57) in future. So preferable than `lexicographically sortable` in actual case.
+  #
   def <=>: (ULID other) -> Integer
          | (untyped other) -> nil
+
+  # ```ruby
+  # ulid = ULID.generate
+  # ulid.inspect #=> "ULID(2021-04-27 17:27:22.826 UTC: 01F4A5Y1YAQCYAYCTC7GRMJ9AA)"
+  # ```
   def inspect: -> String
+
+  # ```ruby
+  # ULID.parse('4NNB20D9C1ME2NGMTX51ERZJX0') == ULID.parse('4nnb20d9c1me2ngmtx51erzjx0')
+  # #=> true
+  # ```
   def eql?: (untyped other) -> bool
   alias == eql?
   def ===: (untyped other) -> bool
+
+  # ```ruby
+  # ulid = ULID.generate
+  # #=> ULID(2021-04-27 17:27:22.826 UTC: 01F4A5Y1YAQCYAYCTC7GRMJ9AA)
+  # ulid.to_time #=> 2021-04-27 17:27:22.826 UTC
+  # ```
   def to_time: -> Time
+
+  # ```ruby
+  # ulid = ULID.generate
+  # #=> ULID(2021-04-27 17:27:22.826 UTC: 01F4A5Y1YAQCYAYCTC7GRMJ9AA)
+  # ulid.timestamp #=> "01F4A5Y1YA"
+  # ```
   def timestamp: -> String
+
+  # ```ruby
+  # ulid = ULID.generate
+  # #=> ULID(2021-04-27 17:27:22.826 UTC: 01F4A5Y1YAQCYAYCTC7GRMJ9AA)
+  # ulid.randomness #=> "QCYAYCTC7GRMJ9AA"
+  # ```
   def randomness: -> String
+
+  # Intentionally avoiding to use `Record type` ref: https://github.com/ruby/rbs/blob/4fb4c33b2325d1a73d79ff7aaeb49f21cec1e0e5/docs/syntax.md#record-type
+  # Because the returning values are not fixed.
   def patterns: -> Hash[Symbol, Regexp | String]
   def octets: -> octets
   def timestamp_octets: -> timestamp_octets
   def randomness_octets: -> randomness_octets
+
+  # ```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"
+  # ```
+  #
+  # See also [Why this is experimental?](https://github.com/kachick/ruby-ulid/issues/76)
   def to_uuidv4: -> String
-  def next: -> ULID?
-  alias succ next
+
+  # 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"
+  # ULID.parse('01BX5ZZKBKZZZZZZZZZZZZZZZZ').next.to_s #=> "01BX5ZZKBM0000000000000000"
+  # ULID.parse('7ZZZZZZZZZZZZZZZZZZZZZZZZZ').next #=> nil
+  # ```
+  #
+  # See also [ULID#pred](https://kachick.github.io/ruby-ulid/ULID.html#pred-instance_method)
+  def succ: -> ULID?
+  alias next succ
+
+  # Returns predecessor ULID.
+  #
+  # ```ruby
+  # ULID.parse('01BX5ZZKBK0000000000000001').pred.to_s #=> "01BX5ZZKBK0000000000000000"
+  # ULID.parse('01BX5ZZKBK0000000000000000').pred.to_s #=> "01BX5ZZKBJZZZZZZZZZZZZZZZZ"
+  # ULID.parse('00000000000000000000000000').pred #=> nil
+  # ```
+  #
+  # See also [ULID#succ](https://kachick.github.io/ruby-ulid/ULID.html#succ-instance_method)
   def pred: -> ULID?
   def freeze: -> self
+
+  # Returns `self`
   def to_ulid: -> self
+
+  # Returns `self`. Not a new instance.
   def dup: -> self
-  # Same as https://github.com/ruby/rbs/blob/4fb4c33b2325d1a73d79ff7aaeb49f21cec1e0e5/core/object.rbs#L79
+
+  # Same API as [Object#clone](https://github.com/ruby/rbs/blob/4fb4c33b2325d1a73d79ff7aaeb49f21cec1e0e5/core/object.rbs#L79)
+  # But actually returns `self`. Not a new instance.
   def clone: (?freeze: bool) -> self
 
   private
+
+  # A pribate API. Should not be used in your code.
+  def self.new: (milliseconds: Integer, entropy: Integer, integer: Integer) -> self
+
+  # A pribate API. Should not be used in your code.
   def self.reasonable_entropy: -> Integer
+
+  # A pribate API. Should not be used in your code.
   def self.milliseconds_from_time: (Time time) -> Integer
+
+  # A pribate API. Should not be used in your code.
   def self.safe_get_class_name: (untyped object) -> String
+
+  # A pribate API. Should not be used in your code.
+  def initialize: (milliseconds: Integer, entropy: Integer, integer: Integer) -> void
+
+  # A pribate API. Should not be used in your code.
   def cache_all_instance_variables: -> void
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-ulid
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Kenichi Kamiya