ruby-ulid 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a390455a27395fd77ef398b0613e72b321b96d44e8454c8ab9346ae15eddfdc
-  data.tar.gz: 1150658ae26cc591f3946898ccb356ce1c6135292de0600ef0604aceb7a00554
+  metadata.gz: 01dca4f18f5bb3168b135847b6a1171d00a6ceb03b1d2ef68b6df212975cafc1
+  data.tar.gz: e1b0cb033ded88591d4817395507f517f46b7d3dd3d3a72021a216dcfef09d12
 SHA512:
-  metadata.gz: 4ffb5c69ec1327bacbb54b4afdd6718f8cc9b5afd450f739588d8e414c645eca9c1090c77efb464293f0e8e1b960cf4df75289785d3cd7b489404e31c24ecc8a
-  data.tar.gz: bf6a08216e0745d0727c356a5a239126bac8518f8fbb57f295b417e14ed0878c8f0c32774b83137b1feb58d8230140492cb469bb18dc9d5df5db5aa088410ffb
+  metadata.gz: c9c1a60687c05cfa99ce37f4e692938bff96dd15afa6b0adce40de5b897303b6e57301f069299c06d726bdd7a425e1ed581b7b60e15efc88d69abc417c577005
+  data.tar.gz: 71f333e7a6d6169f346b0e8fba65c9413fa24c32ce6799623e11b789544fb057fa0f67f83ed94a896cbac9df123ee4f9c9598735953217bd6fec332df659ee9f

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.1.4', '< 0.2.0'
+gem 'ruby-ulid', '>= 0.1.5', '< 0.2.0'
 ```
 
 ### Generator and Parser
@@ -192,7 +192,7 @@ ULID.floor(time) #=> 2000-01-01 00:00:00.123 UTC
 For rough operations, `ULID.scan` might be useful.
 
 ```ruby
-json =<<'EOD'
+json = <<'JSON'
 {
   "id": "01F4GNAV5ZR6FJQ5SFQC7WDSY3",
   "author": {
@@ -217,7 +217,7 @@ json =<<'EOD'
     }
   ]
 }
-EOD
+JSON
 
 ULID.scan(json).to_a
 #=>

data/lib/ulid.rb

@@ -1,5 +1,6 @@
 # coding: us-ascii
 # frozen_string_literal: true
+
 # Copyright (C) 2021 Kenichi Kamiya
 
 require 'securerandom'
@@ -60,6 +61,7 @@ class ULID
   # @return [ULID]
   def self.at(time)
     raise ArgumentError, 'ULID.at takes only `Time` instance' unless Time === time
+
     from_milliseconds_and_entropy(milliseconds: milliseconds_from_time(time), entropy: reasonable_entropy)
   end
 
@@ -91,19 +93,21 @@ class ULID
   #   * 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?
+    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?
+        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
-      RANDOM_INTEGER_GENERATOR
-    end
+        -> {
+          SecureRandom.random_number(possibilities) + min
+        }
+      else
+        RANDOM_INTEGER_GENERATOR
+      end
+    )
 
     case args.size
     when 0
@@ -134,6 +138,7 @@ class ULID
     string = String.try_convert(string)
     raise ArgumentError, 'ULID.scan takes only strings' unless string
     return to_enum(__callee__, string) unless block_given?
+
     string.scan(SCANNING_PATTERN) do |matched|
       yield parse(matched)
     end
@@ -156,7 +161,7 @@ class ULID
     milliseconds = n32encoded_timestamp.to_i(32)
     entropy = n32encoded_randomness.to_i(32)
 
-    new milliseconds: milliseconds, entropy: entropy, integer: integer
+    new(milliseconds: milliseconds, entropy: entropy, integer: integer)
   end
 
   # @param [Range<Time>, Range<nil>, Range[ULID]] period
@@ -164,6 +169,7 @@ class ULID
   # @raise [ArgumentError] if the given period is not a `Range[Time]`, `Range[nil]` or `Range[ULID]`
   def self.range(period)
     raise ArgumentError, 'ULID.range takes only `Range[Time]`, `Range[nil]` or `Range[ULID]`' 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
 
@@ -180,11 +186,7 @@ class ULID
 
     case end_element
     when Time
-      if exclude_end
-        end_ulid = min(end_element)
-      else
-        end_ulid = max(end_element)
-      end
+      end_ulid = exclude_end ? min(end_element) : max(end_element)
     when nil
       # The end should be max and include end, because nil end means to cover endless ULIDs until the limit
       end_ulid = MAX
@@ -335,7 +337,7 @@ class ULID
     n32encoded_randomness = entropy.to_s(32).rjust(RANDOMNESS_ENCODED_LENGTH, '0')
     integer = (n32encoded_timestamp + n32encoded_randomness).to_i(32)
 
-    new milliseconds: milliseconds, entropy: entropy, integer: integer
+    new(milliseconds: milliseconds, entropy: entropy, integer: integer)
   end
 
   attr_reader :milliseconds, :entropy
@@ -406,7 +408,7 @@ class ULID
   def octets
     digits = @integer.digits(256)
     (OCTETS_LENGTH - digits.size).times do
-      digits.push 0
+      digits.push(0)
     end
     digits.reverse!
   end
@@ -477,6 +479,20 @@ class ULID
     super
   end
 
+  # @api private
+  # @return [Integer]
+  def marshal_dump
+    @integer
+  end
+
+  # @api private
+  # @param [Integer] integer
+  # @return [void]
+  def marshal_load(integer)
+    unmarshaled = ULID.from_integer(integer)
+    initialize(integer: unmarshaled.to_i, milliseconds: unmarshaled.milliseconds, entropy: unmarshaled.entropy)
+  end
+
   # @return [self]
   def to_ulid
     self

data/lib/ulid/crockford_base32.rb

@@ -1,9 +1,12 @@
 # coding: us-ascii
 # frozen_string_literal: true
+
 # Copyright (C) 2021 Kenichi Kamiya
 
 class ULID
-  # Currently supporting only for `subset` for actual use-case`
+  # @see https://www.crockford.com/base32.html
+  #
+  # This module supporting only `subset of original crockford for actual use-case` in ULID context.
   # Original decoding spec allows other characters.
   # But I think ULID should allow `subset` of Crockford's Base32.
   # See below
@@ -46,18 +49,22 @@ class ULID
       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
 
-    VARIANT_BY_STANDARD = {
+    STANDARD_BY_VARIANT = {
       'L' => '1',
+      'l' => '1',
       'I' => '1',
+      'i' => '1',
       'O' => '0',
+      'o' => '0',
       '-' => ''
     }.freeze
-    VARIANT_PATTERN = /[#{VARIANT_BY_STANDARD.keys.join}]/.freeze
+    VARIANT_PATTERN = /[#{STANDARD_BY_VARIANT.keys.join}]/.freeze
 
     # @api private
     # @param [String] string
@@ -79,7 +86,7 @@ class ULID
     # @param [String] string
     # @return [String]
     def self.normalize(string)
-      string.upcase.gsub(VARIANT_PATTERN, VARIANT_BY_STANDARD)
+      string.gsub(VARIANT_PATTERN, STANDARD_BY_VARIANT)
     end
   end
 end

data/lib/ulid/monotonic_generator.rb

@@ -1,5 +1,6 @@
 # coding: us-ascii
 # frozen_string_literal: true
+
 # Copyright (C) 2021 Kenichi Kamiya
 
 class ULID
@@ -36,19 +37,23 @@ class ULID
 
         milliseconds = ULID.milliseconds_from_moment(moment)
 
-        ulid = if @prev.milliseconds < milliseconds
-          ULID.generate(moment: milliseconds)
-        else
-          ULID.from_milliseconds_and_entropy(milliseconds: @prev.milliseconds, entropy: @prev.entropy.succ)
-        end
+        ulid = (
+          if @prev.milliseconds < milliseconds
+            ULID.generate(moment: milliseconds)
+          else
+            ULID.from_milliseconds_and_entropy(milliseconds: @prev.milliseconds, entropy: @prev.entropy.succ)
+          end
+        )
 
         unless ulid > @prev
           base_message = "monotonicity broken from unexpected reasons # generated: #{ulid.inspect}, prev: #{@prev.inspect}"
-          additional_information = if Thread.list == [Thread.main]
-            '# NOTE: looks single thread only exist'
-          else
-            '# NOTE: ran on multi threads, so this might from concurrency issue'
-          end
+          additional_information = (
+            if Thread.list == [Thread.main]
+              '# NOTE: looks single thread only exist'
+            else
+              '# NOTE: ran on multi threads, so this might from concurrency issue'
+            end
+          )
 
           raise UnexpectedError, base_message + additional_information
         end

data/lib/ulid/uuid.rb

@@ -1,5 +1,6 @@
 # coding: us-ascii
 # frozen_string_literal: true
+
 # Copyright (C) 2021 Kenichi Kamiya
 
 # Extracted features around UUID from some reasons
@@ -8,7 +9,7 @@
 #  * https://github.com/kachick/ruby-ulid/issues/76
 class ULID
   # 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.freeze
+  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
   private_constant :UUIDV4_PATTERN
 
   # @param [String, #to_str] uuid

data/lib/ulid/version.rb

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

data/sig/ulid.rbs

@@ -43,7 +43,7 @@ class ULID < Object
     CROCKFORD_BASE32_CHAR_PATTERN: Regexp
     CROCKFORD_BASE32_CHAR_BY_N32_CHAR: Hash[String, String]
     N32_CHAR_PATTERN: Regexp
-    VARIANT_BY_STANDARD: Hash[String, String]
+    STANDARD_BY_VARIANT: Hash[String, String]
     VARIANT_PATTERN: Regexp
 
     # A pribate API. Should not be used in your code.
@@ -143,7 +143,7 @@ class ULID < Object
   #
   # 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
+  def self.generate: (?moment: moment, ?entropy: Integer) -> ULID
 
   # Shorthand of `ULID.generate(moment: Time)`
   # See also [ULID.generate](https://kachick.github.io/ruby-ulid/ULID.html#generate-class_method)
@@ -157,7 +157,7 @@ class ULID < Object
   # end
   # ulids.sort == ulids #=> true
   # ```
-  def self.at: (Time time) -> self
+  def self.at: (Time time) -> ULID
 
   # A pribate API. Should not be used in your code.
   def self.current_milliseconds: -> Integer
@@ -212,7 +212,7 @@ class ULID < Object
   # ulid = ULID.parse('01ARZ3NDEKTSV4RRFFQ69G5FAV')
   # #=> ULID(2016-07-30 23:54:10.259 UTC: 01ARZ3NDEKTSV4RRFFQ69G5FAV)
   # ```
-  def self.parse: (_ToStr string) -> self
+  def self.parse: (_ToStr string) -> ULID
 
   # ```ruby
   # # Currently experimental feature, so needed to load the extension.
@@ -226,7 +226,7 @@ class ULID < Object
   #
   # 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
+  def self.from_integer: (Integer integer) -> ULID
 
   # Returns termination values for ULID spec.
   #
@@ -318,8 +318,8 @@ class ULID < Object
   # #  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.sample: (?period: period) -> ULID
+                 | (Integer number, ?period: period) -> Array[ULID]
   def self.valid?: (untyped) -> bool
 
   # Returns normalized string
@@ -384,8 +384,8 @@ class ULID < Object
   # #  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
+                | (_ToStr string) { (ULID ulid) -> void } -> singleton(ULID)
+  def self.from_milliseconds_and_entropy: (milliseconds: Integer, entropy: Integer) -> ULID
   def self.try_convert: (_ToULID) -> ULID
                       | (untyped) -> nil
 
@@ -507,6 +507,12 @@ class ULID < Object
   def pred: -> ULID?
   def freeze: -> self
 
+  # A pribate API. Should not be used in your code.
+  def marshal_dump: -> Integer
+
+  # A pribate API. Should not be used in your code.
+  def marshal_load: (Integer integer) -> void
+
   # Returns `self`
   def to_ulid: -> self
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-ulid
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Kenichi Kamiya
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-17 00:00:00.000000000 Z
+date: 2021-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit
@@ -130,7 +130,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.8.4
+        version: 2.9.1
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'
@@ -140,7 +140,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.8.4
+        version: 2.9.1
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'
@@ -190,76 +190,100 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.14.0
+        version: 1.15.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.15.0
+        version: 1.16.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.14.0
+        version: 1.15.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.15.0
+        version: 1.16.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.11.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.11.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.12.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rubycw
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: rubocop-md
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
 description: |2
       The ULID(Universally Unique Lexicographically Sortable Identifier) 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.
@@ -270,7 +294,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- LICENSE
+- LICENSE.txt
 - README.md
 - lib/ulid.rb
 - lib/ulid/crockford_base32.rb
@@ -285,6 +309,7 @@ metadata:
   documentation_uri: https://kachick.github.io/ruby-ulid/
   homepage_uri: https://github.com/kachick/ruby-ulid
   source_code_uri: https://github.com/kachick/ruby-ulid
+  bug_tracker_uri: https://github.com/kachick/ruby-ulid/issues
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -303,5 +328,5 @@ requirements: []
 rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
-summary: A handy ULID library
+summary: Useful ULID library
 test_files: []