ulid 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ac96b57e8fb7ee4afc17adb9070d46828667155a
-  data.tar.gz: f06ece64720bd8d8b5323ee69583e8ae3340562d
+  metadata.gz: 05e031d4a39689363080536ace29cba73abcd17f
+  data.tar.gz: fc7499bb1b9cd0d83e59837d11870b00ad125ad5
 SHA512:
-  metadata.gz: b28852c6c6e9ac75f331f6330338b9b49c36bc12f346e7d3cddc84f8704cfe7ced0c129c893222f9437855f97b829d1bb29573a94418c387f20afb1c8641dfde
-  data.tar.gz: d5d3ae42a1b1ed786ba3b87e1c9844fe6f89b41521a5e96782cda05a4beb8436c955ebb306517a1cf121f9eeb47a66822cbe91a8898653bdb5d08adfedd24335
+  metadata.gz: 3a7616e25abef1433f0d455be7343f21ffd78dcaefc71e953bbc0e1320d1d8d7379b2e76aebf6b284d9b499840fcdce41c4c17c8cca3098f11f93e7d1bc2998b
+  data.tar.gz: 3e79b136fa36bf5e713676ff86ef65e2e035e1176c4a4a0d3419d0aa2b188f25f569b6ae353e266115812cac7f4d5f3206f5b5e2c8147e49b1318a16771baf88

data/.rubocop.yml

@@ -0,0 +1,23 @@
+Style/Documentation:
+  Enabled: false
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: comma
+
+Metrics/AbcSize:
+  Enabled: false
+
+BlockLength:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Enabled: false
+
+Lint/RescueWithoutErrorClass:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 1.0.0
+
+- PR #110 - Fix time encoding by @dcuddeback

data/Gemfile

@@ -3,13 +3,14 @@ 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'
+  gem 'mocha'
+  gem 'timecop'
 end

data/Gemfile.lock

@@ -1,43 +1,58 @@
 PATH
   remote: .
   specs:
-    ulid (0.1.0)
+    ulid (1.0.0)
       sysrandom (>= 1.0.0, < 2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    base32 (0.3.2)
-    byebug (9.0.5)
-    coderay (1.1.1)
+    ast (2.3.0)
+    base32-crockford (0.1.0)
+    byebug (9.1.0)
+    coderay (1.1.2)
     metaclass (0.0.4)
-    method_source (0.8.2)
-    minitest (5.9.0)
-    mocha (1.1.0)
+    method_source (0.9.0)
+    minitest (5.10.3)
+    mocha (1.3.0)
       metaclass (~> 0.0.1)
-    pry (0.10.4)
+    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)
+    rainbow (2.2.2)
+      rake
     rake (10.5.0)
-    slop (3.6.0)
-    sysrandom (1.0.3)
-    timecop (0.8.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)
+    sysrandom (1.0.5)
+    timecop (0.9.1)
+    unicode-display_width (1.3.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  base32
+  base32-crockford
   minitest
   mocha
   pry-byebug
-  rake (~> 10.0)
+  rake
+  rubocop
   timecop
   ulid!
 
 BUNDLED WITH
-   1.12.5
+   1.16.0

data/README.md

@@ -82,9 +82,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                      |
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
@@ -111,4 +111,3 @@ bundle exec rake test
 ### Credits and references:
 
 * https://github.com/alizain/ulid
-* https://github.com/ulid-org/spec

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,4 @@
-Dir.glob(File.join(File.dirname(__FILE__), "/**/*.rb")).sort.each { |f| require f }
+Dir.glob(File.join(File.dirname(__FILE__), '/**/*.rb')).sort.each { |f| require f }
 
 module ULID
   extend Generator

data/lib/ulid/generator.rb

@@ -2,7 +2,7 @@ require 'sysrandom'
 
 module ULID
   module Generator
-    ENCODING = '0123456789ABCDEFGHJKMNPQRSTVWXYZ' # Crockford's Base32
+    ENCODING = '0123456789ABCDEFGHJKMNPQRSTVWXYZ'.freeze # Crockford's Base32
     RANDOM_BYTES = 10
     ENCODED_LENGTH = 26
     BIT_LENGTH = 128
@@ -10,28 +10,39 @@ module ULID
 
     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(n, length)
+      e = '0' * length
+      i = length - 1
+
+      while n > 0
+        e[i] = ENCODING[n & MASK]
+        n >>= 5
+        i -= 1
+      end
+
+      e
+    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)
+      time_ms = (time.to_f * 1000).to_i
+      [time_ms].pack('Q>')[2..-1]
     end
 
     def random_bytes

data/lib/ulid/version.rb

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

data/spec/lib/ulid_spec.rb

@@ -1,51 +1,58 @@
 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
+    it 'is sortable' do
+      ulid1, ulid2 = nil
       Timecop.freeze do
-        ulid_1 = ULID.generate
+        ulid1 = ULID.generate
         Timecop.travel Time.now + 1
-        ulid_2 = ULID.generate
+        ulid2 = ULID.generate
       end
-      assert ulid_2 > ulid_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
-  end
 
-  describe "underlying binary" do
+    it 'encodes the timestamp in the first 10 characters' do
+      # test case taken from original ulid README:
+      # https://github.com/alizain/ulid#seed-time
+      Timecop.freeze(Time.at(1_469_918_176.385)) do
+        ulid = ULID.generate(Time.at(1_469_918_176.385))
+        assert_equal '01ARYZ6S41', ulid[0...10]
+      end
+    end
+  end
 
-    it "encodes the timestamp in the high 48 bits" do
-      Timecop.freeze do
-        now_100usec = Time.now_100usec
+  describe 'underlying binary' do
+    it 'encodes the timestamp in the high 48 bits' do
+      input_time = Time.now.utc
+      Timecop.freeze(input_time) do
         bytes = ULID.generate_bytes
-        ts = ("\x0\x0" + bytes[0...6]).unpack("Q>").first
-        assert ts == now_100usec
+        (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
     end
 
-    it "encodes the remaining 80 bits as random" do
+    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
     end
   end
-
 end

data/ulid.gemspec

@@ -1,21 +1,21 @@
-# coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $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.add_dependency 'sysrandom', '>= 1.0.0', '< 2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ulid
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Rafael Sales
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-29 00:00:00.000000000 Z
+date: 2017-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sysrandom
@@ -38,12 +38,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".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
@@ -71,7 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Universally Unique Lexicographically Sortable Identifier implementation for

data/lib/ext/time.rb

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