ulid 0.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ac96b57e8fb7ee4afc17adb9070d46828667155a
-  data.tar.gz: f06ece64720bd8d8b5323ee69583e8ae3340562d
+SHA256:
+  metadata.gz: c072f00beeac3732fbbee2fe32af5f95e14a4eb516e659f70e9e08c0bc525e01
+  data.tar.gz: f8d7ad8d5e714c142c0309a6e814be406c61519cc6e36adcaccae4982d94b96f
 SHA512:
-  metadata.gz: b28852c6c6e9ac75f331f6330338b9b49c36bc12f346e7d3cddc84f8704cfe7ced0c129c893222f9437855f97b829d1bb29573a94418c387f20afb1c8641dfde
-  data.tar.gz: d5d3ae42a1b1ed786ba3b87e1c9844fe6f89b41521a5e96782cda05a4beb8436c955ebb306517a1cf121f9eeb47a66822cbe91a8898653bdb5d08adfedd24335
+  metadata.gz: 0e7aaedb437ae82765ec74cf36ddbeb5b529948c9c65c077a0e648156c21ebb23dc26f2e85b3430434dd1babfaaa1b4b1d8bfd00c8dbf9f09f332bad33b93f97
+  data.tar.gz: 01f353360ca4b82534de75f8e715d872b9c976a85655a9f419dfc1a93b6e867d0bea342ad970a3b4653048f3484bba1bc8842f75980142869d13005d3fabc1e7

data/.github/FUNDING.yml

@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+github: [rafaelsales]

data/.github/workflows/ruby.yml

@@ -0,0 +1,20 @@
+name: Ruby
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - name: Build and test with Rake
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rake test

data/.rubocop.yml

@@ -0,0 +1,26 @@
+Style/Documentation:
+  Enabled: false
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+Metrics/AbcSize:
+  Enabled: false
+
+BlockLength:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Enabled: false
+
+Style/RescueStandardError:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+# 1.2.0
+
+- PR #20 - Use an array to improve speed / reduce memory allocations. Thanks, @jamescook
+
+# 1.1.1
+
+- PR #19 - Remove Timecop gem. Thanks, @bquorning
+
+- PR #18 - Remove Mocha gem. Thanks, @bquorning
+
+- PR #17 - Add post_install_message to install sysrandom gem
+
+- PR #16 - Remove circular require warning. Thanks, @pocke
+
+# 1.1.0
+
+- PR #14 - Ruby 2.5+ does not need sysrandom. Thanks, @sakuro
+
+# 1.0.0
+
+- PR #10 - Fix time encoding. Thanks, @dcuddeback

data/Gemfile

@@ -3,13 +3,12 @@ source 'https://rubygems.org'
 gemspec
 
 group :development, :test do
-  gem "rake", "~> 10.0"
-  gem "pry-byebug"
+  gem 'pry-byebug'
+  gem 'rake'
+  gem 'rubocop'
 end
 
 group :test do
-  gem "minitest"
-  gem "mocha"
-  gem "timecop"
-  gem "base32"
+  gem 'base32-crockford'
+  gem 'minitest'
 end

data/Gemfile.lock

@@ -1,43 +1,50 @@
 PATH
   remote: .
   specs:
-    ulid (0.1.0)
-      sysrandom (>= 1.0.0, < 2.0)
+    ulid (1.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    base32 (0.3.2)
-    byebug (9.0.5)
-    coderay (1.1.1)
-    metaclass (0.0.4)
-    method_source (0.8.2)
-    minitest (5.9.0)
-    mocha (1.1.0)
-      metaclass (~> 0.0.1)
-    pry (0.10.4)
+    ast (2.3.0)
+    base32-crockford (0.1.0)
+    byebug (9.1.0)
+    coderay (1.1.2)
+    method_source (0.9.0)
+    minitest (5.10.3)
+    parallel (1.12.0)
+    parser (2.4.0.0)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    pry (0.11.3)
       coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-    pry-byebug (3.4.0)
-      byebug (~> 9.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.5.1)
+      byebug (~> 9.1)
       pry (~> 0.10)
-    rake (10.5.0)
-    slop (3.6.0)
-    sysrandom (1.0.3)
-    timecop (0.8.1)
+    rainbow (2.2.2)
+      rake
+    rake (13.0.1)
+    rubocop (0.50.0)
+      parallel (~> 1.10)
+      parser (>= 2.3.3.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.3)
+    unicode-display_width (1.3.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  base32
+  base32-crockford
   minitest
-  mocha
   pry-byebug
-  rake (~> 10.0)
-  timecop
+  rake
+  rubocop
   ulid!
 
 BUNDLED WITH
-   1.12.5
+   2.0.1

data/README.md

@@ -1,6 +1,12 @@
+![Ruby](https://github.com/rafaelsales/ulid/workflows/Ruby/badge.svg)
+[![Gem Downloads](http://img.shields.io/gem/dt/ulid.svg)](https://rubygems.org/gems/ulid)
+[![GitHub License](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/rafaelsales/ulid)
+
 # ulid
 Universally Unique Lexicographically Sortable Identifier implementation for Ruby
 
+Official specification page: https://github.com/ulid/spec
+
 <h1 align="center">
 	<br>
 	<br>
@@ -10,9 +16,6 @@ Universally Unique Lexicographically Sortable Identifier implementation for Ruby
 	<br>
 </h1>
 
-[![Gem Downloads](http://img.shields.io/gem/dt/ulid.svg)](https://rubygems.org/gems/ulid)
-[![GitHub License](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/rafaelsales/ulid)
-
 # Universally Unique Lexicographically Sortable Identifier
 
 UUID can be suboptimal for many uses-cases because:
@@ -82,9 +85,9 @@ The components are encoded as 16 octets. Each component is encoded with the Most
 0                   1                   2                   3
  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-|                      32_bit_uint_time_low                     |
+|                      32_bit_uint_time_high                    |
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-|     16_bit_uint_time_high     |       16_bit_uint_random      |
+|     16_bit_uint_time_low      |       16_bit_uint_random      |
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 |                       32_bit_uint_random                      |
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
@@ -110,5 +113,4 @@ bundle exec rake test
 
 ### Credits and references:
 
-* https://github.com/alizain/ulid
-* https://github.com/ulid-org/spec
+* https://github.com/ulid/javascript

data/Rakefile

@@ -1,15 +1,15 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 require 'rake/testtask'
 require 'benchmark'
 require 'ulid'
 
 Rake::TestTask.new do |t|
-  t.libs += ["spec", "lib"]
+  t.libs += %w[spec lib]
   t.test_files = FileList['spec/**/*_spec.rb']
 end
 
-desc "Benchmark base32 ULID generation (default 100,000 iterations)"
-task :benchmark, [:iterations] do |t, args|
+desc 'Benchmark base32 ULID generation (default 100,000 iterations)'
+task :benchmark, [:iterations] do |_t, args|
   iterations = (args[:iterations] || 100_000).to_i
   Benchmark.bm do |b|
     b.report("#{iterations} iterations") { iterations.times { ULID.generate } }

data/lib/ulid.rb

@@ -1,4 +1,5 @@
-Dir.glob(File.join(File.dirname(__FILE__), "/**/*.rb")).sort.each { |f| require f }
+require 'ulid/version'
+require 'ulid/generator'
 
 module ULID
   extend Generator

data/lib/ulid/generator.rb

@@ -1,41 +1,70 @@
-require 'sysrandom'
+# frozen-string-literal: true
+
+if RUBY_VERSION >= '2.5'
+  require 'securerandom'
+else
+  require 'sysrandom/securerandom'
+end
 
 module ULID
   module Generator
-    ENCODING = '0123456789ABCDEFGHJKMNPQRSTVWXYZ' # Crockford's Base32
+    ENCODING = '0123456789ABCDEFGHJKMNPQRSTVWXYZ'.bytes.freeze # Crockford's Base32
     RANDOM_BYTES = 10
     ENCODED_LENGTH = 26
     BIT_LENGTH = 128
     BITS_PER_B32_CHAR = 5
+    ZERO = '0'.ord
 
     MASK = 0x1f
 
-    def generate
-      input = octo_word
-      (1..ENCODED_LENGTH).to_a.reduce("") do |s, n|
-        shift = BIT_LENGTH - BITS_PER_B32_CHAR * n
-        s + ENCODING[(input >> shift) & MASK]
-      end
+    def generate(time = Time.now)
+      input = octo_word(time)
+
+      encode(input, ENCODED_LENGTH)
     end
 
-    def generate_bytes
-      time_48bit + random_bytes
+    def generate_bytes(time = Time.now)
+      time_48bit(time) + random_bytes
     end
 
     private
 
-    def octo_word
-      (hi, lo) = generate_bytes.unpack("Q>Q>")
+    def encode(input, length)
+      e = Array.new(length, ZERO)
+      i = length - 1
+
+      while input > 0
+        e[i] = ENCODING[input & MASK]
+        input >>= 5
+        i -= 1
+      end
+
+      e.pack('c*')
+    end
+
+    def octo_word(time = Time.now)
+      (hi, lo) = generate_bytes(time).unpack('Q>Q>')
       (hi << 64) | lo
     end
 
-    def time_48bit
-      hundred_micro_time = Time.now_100usec
-      [hundred_micro_time].pack("Q>")[2..-1]
+    def time_48bit(time = Time.now)
+      # Avoid `time.to_f` since we want to accurately represent a whole number of milliseconds:
+      #
+      # > time = Time.new(2020, 1, 5, 7, 3, Rational(2, 1000))
+      # => 2020-01-05 07:03:00 +0000
+      # > (time.to_f * 1000).to_i
+      # => 1578207780001
+      #
+      # vs
+      #
+      # > (time.to_r * 1000).to_i
+      # => 1578207780002
+      time_ms = (time.to_r * 1000).to_i
+      [time_ms].pack('Q>')[2..-1]
     end
 
     def random_bytes
-      Sysrandom.random_bytes(RANDOM_BYTES)
+      SecureRandom.random_bytes(RANDOM_BYTES)
     end
   end
 end

data/lib/ulid/version.rb

@@ -1,3 +1,3 @@
 module ULID
-  VERSION = '0.1.0'
+  VERSION = '1.3.0'.freeze
 end

data/spec/lib/ulid_spec.rb

@@ -1,51 +1,71 @@
 require 'spec_helper'
-require 'timecop'
-require 'base32'
+require 'base32/crockford'
 
 describe ULID do
-  describe "textual representation" do
-    it "ensures it has 26 chars" do
+  describe 'textual representation' do
+    it 'ensures it has 26 chars' do
       ulid = ULID.generate
 
       ulid.length.must_equal 26
     end
 
-    it "is sortable" do
-      ulid_1, ulid_2 = nil
-      Timecop.freeze do
-        ulid_1 = ULID.generate
-        Timecop.travel Time.now + 1
-        ulid_2 = ULID.generate
-      end
-      assert ulid_2 > ulid_1
+    it 'is sortable' do
+      input_time = Time.now
+      ulid1 = ULID.generate(input_time)
+      ulid2 = ULID.generate(input_time + 1)
+      assert ulid2 > ulid1
     end
 
-    it "is valid Crockford Base32" do
-      Base32.table = ULID::Generator::ENCODING
+    it 'is valid Crockford Base32' do
       ulid = ULID.generate
-      decoded = Base32.decode(ulid)
-      encoded = Base32.encode(decoded)[0...26]
-      assert encoded == ulid
+      decoded = Base32::Crockford.decode(ulid)
+      encoded = Base32::Crockford.encode(decoded, length: 26)
+      assert_equal ulid, encoded
+    end
+
+    it 'encodes the timestamp in the first 10 characters' do
+      # test case taken from original ulid README:
+      # https://github.com/ulid/javascript#seed-time
+      #
+      # N.b. we avoid specifying the time as a float, since we lose precision:
+      #
+      # > Time.at(1_469_918_176.385).strftime("%F %T.%N")
+      # => "2016-07-30 23:36:16.384999990"
+      #
+      # vs the correct:
+      #
+      # > Time.at(1_469_918_176, 385, :millisecond).strftime("%F %T.%N")
+      # => "2016-07-30 23:36:16.385000000"
+      ulid = ULID.generate(Time.at(1_469_918_176, 385, :millisecond))
+      assert_equal '01ARYZ6S41', ulid[0...10]
     end
-  end
 
-  describe "underlying binary" do
+    it 'respects millisecond-precision order' do
+      ulids = Array.new(1000) do |millis|
+        time = Time.new(2020, 1, 2, 3, 4, Rational(millis, 10**3))
 
-    it "encodes the timestamp in the high 48 bits" do
-      Timecop.freeze do
-        now_100usec = Time.now_100usec
-        bytes = ULID.generate_bytes
-        ts = ("\x0\x0" + bytes[0...6]).unpack("Q>").first
-        assert ts == now_100usec
+        ULID.generate(time)
       end
-    end
 
-    it "encodes the remaining 80 bits as random" do
-      random_bytes = Sysrandom.random_bytes(ULID::Generator::RANDOM_BYTES)
-      ULID.stubs(:random_bytes).returns(random_bytes)
-      bytes = ULID.generate_bytes
-      assert bytes[6..-1] == random_bytes
+      assert_equal(ulids, ulids.sort)
     end
   end
 
+  describe 'underlying binary' do
+    it 'encodes the timestamp in the high 48 bits' do
+      input_time = Time.now.utc
+      bytes = ULID.generate_bytes(input_time)
+      (time_ms,) = "\x0\x0#{bytes[0...6]}".unpack('Q>')
+      encoded_time = Time.at(time_ms / 1000.0).utc
+      assert_in_delta input_time, encoded_time, 0.001
+    end
+
+    it 'encodes the remaining 80 bits as random' do
+      random_bytes = SecureRandom.random_bytes(ULID::Generator::RANDOM_BYTES)
+      ULID.stub(:random_bytes, random_bytes) do
+        bytes = ULID.generate_bytes
+        assert bytes[6..-1] == random_bytes
+      end
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,4 @@
 require 'pry'
 require 'minitest/autorun'
 require 'minitest/pride'
-require 'mocha/mini_test'
 require 'ulid'

data/ulid.gemspec

@@ -1,21 +1,23 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'ulid/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "ulid"
+  spec.name          = 'ulid'
   spec.version       = ULID::VERSION
-  spec.authors       = ["Rafael Sales"]
-  spec.email         = ["rafaelcds@gmail.com"]
-  spec.summary       = %q{Universally Unique Lexicographically Sortable Identifier implementation for Ruby}
-  spec.homepage      = "https://github.com/rafaelsales/ulid"
-  spec.license       = "MIT"
+  spec.authors       = ['Rafael Sales']
+  spec.email         = ['rafaelcds@gmail.com']
+  spec.summary       = 'Universally Unique Lexicographically Sortable Identifier implementation for Ruby'
+  spec.homepage      = 'https://github.com/rafaelsales/ulid'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "sysrandom", ">= 1.0.0", "< 2.0"
+  spec.post_install_message = '
+ulid gem needs to install sysrandom gem if you use Ruby 2.4 or older.
+Execute `gem install sysrandom` or add `gem "sysrandom"` to Gemfile.
+'
 end

metadata

@@ -1,49 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: ulid
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Rafael Sales
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-09-29 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: sysrandom
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-description: 
+date: 2021-03-01 00:00:00.000000000 Z
+dependencies: []
+description:
 email:
 - rafaelcds@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/FUNDING.yml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
-- lib/ext/time.rb
 - lib/ulid.rb
 - lib/ulid/generator.rb
 - lib/ulid/version.rb
@@ -55,7 +38,10 @@ homepage: https://github.com/rafaelsales/ulid
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: |2
+
+  ulid gem needs to install sysrandom gem if you use Ruby 2.4 or older.
+  Execute `gem install sysrandom` or add `gem "sysrandom"` to Gemfile.
 rdoc_options: []
 require_paths:
 - lib
@@ -70,9 +56,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Universally Unique Lexicographically Sortable Identifier implementation for
   Ruby

data/lib/ext/time.rb

@@ -1,5 +0,0 @@
-class Time
-  def self.now_100usec
-    (now.to_f * 10_000).to_i
-  end
-end