ruby-ulid 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f33ff714eef2b217cb557fe4ae46087a77b834aa42c406e940f2f8a6630464c
-  data.tar.gz: ce004faa759110d8494f34a058230a90d7231af4a309c5c7bf66b0f0963bcf81
+  metadata.gz: a1179379859a437f04ff904c941372fffc4aa3027d550ae50c67f744e4899d9a
+  data.tar.gz: 71781ee8481373bb7229f10f88a1703b2653c11a4f18cbc7b50eb4adbec58908
 SHA512:
-  metadata.gz: d60377fcf5cd9523b09eb78be1feef0fb996b9f6ebf0e430db9bf3902899ee6e6e6d62518a9f33ecfb5d6786390e08bbf545d5a9b36f141fd4a95bc7ff8f6612
-  data.tar.gz: 981bafadfcbb63254a276a1ae9b201b2b636555416450ce421ffa0f4482e343072811623ae4856970904227ae0da0fe2f991ffc809556d4bc6a33a910446c7dd
+  metadata.gz: 6d48e489221851290a486ffe3a39847196e900bb54751fa7d0c808f7580c8838d1a6382b203da1b90ad4f74dd9e998239e0a6c996b06d99881c39489ff607697
+  data.tar.gz: fbef689db966901800b24e18820ee6744aeeaeb2476f14349b74d634ed1e5d359a4bff4abb3eb0eee94e4d0183f5db1420719d7e94afd3e803d21d62510087d7

data/lib/ulid.rb

@@ -3,11 +3,14 @@
 # Copyright (C) 2021 Kenichi Kamiya
 
 require 'securerandom'
-require 'singleton'
 require 'integer/base'
 require_relative 'ulid/version'
 
 # @see https://github.com/ulid/spec
+# @!attribute [r] milliseconds
+#   @return [Integer]
+# @!attribute [r] entropy
+#   @return [Integer]
 class ULID
   include Comparable
 
@@ -33,14 +36,13 @@ class ULID
   TIME_FORMAT_IN_INSPECT = '%Y-%m-%d %H:%M:%S.%3N %Z'
 
   class MonotonicGenerator
-    include Singleton
-
     attr_accessor :latest_milliseconds, :latest_entropy
 
     def initialize
       reset
     end
 
+    # @raise [OverflowError] if the entropy part is larger than the ULID limit in same milliseconds
     # @return [ULID]
     def generate
       milliseconds = ULID.current_milliseconds
@@ -65,15 +67,16 @@ class ULID
       self
     end
 
+    # @raise [TypeError] always raises exception and does not freeze self
     # @return [void]
     def freeze
       raise TypeError, "cannot freeze #{self.class}"
     end
   end
 
-  MONOTONIC_GENERATOR = MonotonicGenerator.instance
+  MONOTONIC_GENERATOR = MonotonicGenerator.new
 
-  private_constant :ENCODING_CHARS, :TIME_FORMAT_IN_INSPECT, :MonotonicGenerator
+  private_constant :ENCODING_CHARS, :TIME_FORMAT_IN_INSPECT
 
   # @param [Integer, Time] moment
   # @param [Integer] entropy
@@ -83,8 +86,17 @@ class ULID
     new milliseconds: milliseconds, entropy: entropy
   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
   # @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)
+    else
+      Warning.warn(warning)
+    end
+
     MONOTONIC_GENERATOR.generate
   end
 
@@ -106,6 +118,8 @@ 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
@@ -123,7 +137,6 @@ class ULID
     new milliseconds: milliseconds, entropy: entropy
   end
 
-  # @param [String] string
   # @return [Boolean]
   def self.valid?(string)
     parse(string)
@@ -135,6 +148,11 @@ class ULID
 
   attr_reader :milliseconds, :entropy
 
+  # @param [Integer] milliseconds
+  # @param [Integer] entropy
+  # @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
@@ -160,7 +178,7 @@ class ULID
 
   # @return [Integer, nil]
   def <=>(other)
-    other.kind_of?(self.class) ? (to_i <=> other.to_i) : nil
+    other.kind_of?(ULID) ? (to_i <=> other.to_i) : nil
   end
 
   # @return [String]
@@ -170,7 +188,7 @@ class ULID
 
   # @return [Boolean]
   def eql?(other)
-    other.equal?(self) || (other.kind_of?(self.class) && other.to_i == to_i)
+    other.equal?(self) || (other.kind_of?(ULID) && other.to_i == to_i)
   end
   alias_method :==, :eql?
 
@@ -195,21 +213,22 @@ class ULID
     @time ||= Time.at(0, @milliseconds, :millisecond).utc
   end
 
-  # @return [Array<Integer>]
+  # @return [Array(Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer)]
   def octets
     @octets ||= (time_octets + randomness_octets).freeze
   end
 
-  # @return [Array<Integer>]
+  # @return [Array(Integer, Integer, Integer, Integer, Integer, Integer)]
   def time_octets
     @time_octets ||= octets_from_integer(@milliseconds, length: TIME_OCTETS_LENGTH).freeze
   end
 
-  # @return [Array<Integer>]
+  # @return [Array(Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer)]
   def randomness_octets
     @randomness_octets ||= octets_from_integer(@entropy, length: RANDOMNESS_OCTETS_LENGTH).freeze
   end
 
+  # @raise [OverflowError] if the next entropy part is larger than the ULID limit
   # @return [ULID]
   def next
     @next ||= self.class.new(milliseconds: @milliseconds, entropy: @entropy + 1)

data/lib/ulid/version.rb

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

data/sig/ulid.rbs

@@ -2,22 +2,45 @@
 class ULID
   VERSION: String
   ENCODING_CHARS: Array[String]
-  TIME_PART_LENGTH: Integer
-  RANDOMNESS_PART_LENGTH: Integer
-  ENCODED_ID_LENGTH: Integer
-  TIME_OCTETS_LENGTH: Integer
-  RANDOMNESS_OCTETS_LENGTH: Integer
-  OCTETS_LENGTH: Integer
-  MAX_MILLISECONDS: Integer
-  MAX_ENTROPY: Integer
-  TIME_FORMAT_IN_INSPECT: String
+  TIME_PART_LENGTH: 10
+  RANDOMNESS_PART_LENGTH: 16
+  ENCODED_ID_LENGTH: 26
+  TIME_OCTETS_LENGTH: 6
+  RANDOMNESS_OCTETS_LENGTH: 10
+  OCTETS_LENGTH: 16
+  MAX_MILLISECONDS: 281474976710655
+  MAX_ENTROPY: 1208925819614629174706175
+  TIME_FORMAT_IN_INSPECT: '%Y-%m-%d %H:%M:%S.%3N %Z'
   MONOTONIC_GENERATOR: MonotonicGenerator
   include Comparable
+
+  class Error < StandardError
+  end
+
+  class OverflowError < Error
+  end
+
+  class ParserError < Error
+  end
+
+  class MonotonicGenerator
+    attr_accessor latest_milliseconds: Integer?
+    attr_accessor latest_entropy: Integer?
+    def initialize: -> void
+    def generate: -> ULID
+    def reset: -> void
+    def freeze: -> void
+  end
+
+  type octets = [Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer]
+  type time_octets = [Integer, Integer, Integer, Integer, Integer, Integer]
+  type randomness_octets = [Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer]
+
   @string: String
   @integer: Integer
-  @octets: Array[Integer]
-  @time_octets: Array[Integer]
-  @randomness_octets: Array[Integer]
+  @octets: octets
+  @time_octets: time_octets
+  @randomness_octets: randomness_octets
   @inspect: String
   @time: Time
   @next: ULID
@@ -33,43 +56,24 @@ class ULID
   attr_reader entropy: Integer
   def initialize: (milliseconds: Integer, entropy: Integer) -> void
   def to_str: -> String
-  def to_s: -> String
+  alias to_s to_str
   def to_i: -> Integer
-  def hash: -> Integer
-  def <=>: (untyped other) -> Integer?
+  alias hash to_i
+  def <=>: (ULID other) -> Integer
+         | (untyped other) -> Integer?
   def inspect: -> String
   def eql?: (untyped other) -> bool
-  def ==: (untyped other) -> bool
+  alias == eql?
   def ===: (untyped other) -> bool
   def to_time: -> Time
-  def octets: -> Array[Integer]
-  def time_octets: -> Array[Integer]
-  def randomness_octets: -> Array[Integer]
+  def octets: -> octets
+  def time_octets: -> time_octets
+  def randomness_octets: -> randomness_octets
   def next: -> ULID
-  def succ: -> ULID
+  alias succ next
   def freeze: -> self
 
   private
   def octets_from_integer: (Integer integer, length: Integer) -> Array[Integer]
   def inverse_of_digits: (Array[Integer] reversed_digits) -> Integer
-
-  class Error < StandardError
-  end
-
-  class OverflowError < Error
-  end
-
-  class ParserError < Error
-  end
-
-  class MonotonicGenerator
-    include Singleton
-
-    attr_accessor latest_milliseconds: Integer?
-    attr_accessor latest_entropy: Integer?
-    def initialize: -> void
-    def generate: -> ULID
-    def reset: -> void
-    def freeze: -> void
-  end
 end

metadata

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