ulid 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9a2e09c0725c50d9cdce66e66ca46f2c7fbdcf5b
-  data.tar.gz: 203d9b4b4c466561af9733512d1b3c118e77b851
+  metadata.gz: ac96b57e8fb7ee4afc17adb9070d46828667155a
+  data.tar.gz: f06ece64720bd8d8b5323ee69583e8ae3340562d
 SHA512:
-  metadata.gz: e94a295f1b71498c1c21381f99e9b3ec888ba2a51acee99618985eecc35f6e94eff14baae6a459c54088bea252833ba0a11ff66f9b663fb9ac4a614b1260a52f
-  data.tar.gz: fc48c4ab0975c5d4a72d36c013bef2ebf3910574d42f2cea42a0e781ca7cfb6b3f60bff217e79b110bfcf38edc7f1dccd5c8e3520c460c6fb73432a8e3851658
+  metadata.gz: b28852c6c6e9ac75f331f6330338b9b49c36bc12f346e7d3cddc84f8704cfe7ced0c129c893222f9437855f97b829d1bb29573a94418c387f20afb1c8641dfde
+  data.tar.gz: d5d3ae42a1b1ed786ba3b87e1c9844fe6f89b41521a5e96782cda05a4beb8436c955ebb306517a1cf121f9eeb47a66822cbe91a8898653bdb5d08adfedd24335

data/Gemfile

@@ -10,4 +10,6 @@ end
 group :test do
   gem "minitest"
   gem "mocha"
+  gem "timecop"
+  gem "base32"
 end

data/Gemfile.lock

@@ -1,12 +1,13 @@
 PATH
   remote: .
   specs:
-    ulid (0.0.2)
+    ulid (0.1.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)
     metaclass (0.0.4)
@@ -23,16 +24,19 @@ GEM
       pry (~> 0.10)
     rake (10.5.0)
     slop (3.6.0)
-    sysrandom (1.0.2)
+    sysrandom (1.0.3)
+    timecop (0.8.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  base32
   minitest
   mocha
   pry-byebug
   rake (~> 10.0)
+  timecop
   ulid!
 
 BUNDLED WITH

data/Rakefile

@@ -1,7 +1,17 @@
 require "bundler/gem_tasks"
 require 'rake/testtask'
+require 'benchmark'
+require 'ulid'
 
 Rake::TestTask.new do |t|
   t.libs += ["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|
+  iterations = (args[:iterations] || 100_000).to_i
+  Benchmark.bm do |b|
+    b.report("#{iterations} iterations") { iterations.times { ULID.generate } }
+  end
+end

data/lib/ext/time.rb

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

data/lib/ulid.rb

@@ -1,7 +1,5 @@
+Dir.glob(File.join(File.dirname(__FILE__), "/**/*.rb")).sort.each { |f| require f }
+
 module ULID
-  def self.generate
-    Generator.new.generate
-  end
+  extend Generator
 end
-
-Dir.glob(File.join(File.dirname(__FILE__), "/ulid/**/*.rb")).sort.each { |f| require f }

data/lib/ulid/generator.rb

@@ -1,36 +1,41 @@
 require 'sysrandom'
 
 module ULID
-  class Generator
+  module Generator
     ENCODING = '0123456789ABCDEFGHJKMNPQRSTVWXYZ' # Crockford's Base32
-    TIME_LENGTH = 10
-    RANDOM_LENGTH = 16
+    RANDOM_BYTES = 10
+    ENCODED_LENGTH = 26
+    BIT_LENGTH = 128
+    BITS_PER_B32_CHAR = 5
+
+    MASK = 0x1f
 
     def generate
-      encode_time(milliseconds_since_epoch, TIME_LENGTH) + encode_random(RANDOM_LENGTH)
+      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
     end
 
-    private
+    def generate_bytes
+      time_48bit + random_bytes
+    end
 
-    def encode_time(now, length)
-      length.times.reduce('') do |output|
-        mod = now % ENCODING.length
-        now = (now - mod) / ENCODING.length
+    private
 
-        output << ENCODING[mod]
-      end.reverse
+    def octo_word
+      (hi, lo) = generate_bytes.unpack("Q>Q>")
+      (hi << 64) | lo
     end
 
-    def encode_random(length)
-      length.times.reduce("") do |output|
-        random = Sysrandom.random_number(ENCODING.length)
-
-        output << ENCODING[random]
-      end.reverse
+    def time_48bit
+      hundred_micro_time = Time.now_100usec
+      [hundred_micro_time].pack("Q>")[2..-1]
     end
 
-    def milliseconds_since_epoch
-      (Time.now.to_f * 1000).to_i
+    def random_bytes
+      Sysrandom.random_bytes(RANDOM_BYTES)
     end
   end
 end

data/lib/ulid/version.rb

@@ -1,3 +1,3 @@
 module ULID
-  VERSION = '0.0.3'
+  VERSION = '0.1.0'
 end

data/spec/lib/ulid_spec.rb

@@ -1,17 +1,51 @@
 require 'spec_helper'
+require 'timecop'
+require 'base32'
 
 describe ULID do
-  it "ensures it has 26 chars" do
-    ulid = ULID.generate
+  describe "textual representation" do
+    it "ensures it has 26 chars" do
+      ulid = ULID.generate
 
-    ulid.length.must_equal 26
+      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
+    end
+
+    it "is valid Crockford Base32" do
+      Base32.table = ULID::Generator::ENCODING
+      ulid = ULID.generate
+      decoded = Base32.decode(ulid)
+      encoded = Base32.encode(decoded)[0...26]
+      assert encoded == ulid
+    end
   end
 
-  it "is sortable" do
-    ulid_1 = ULID.generate
-    ulid_2 = ULID.generate
+  describe "underlying binary" do
+
+    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
+      end
+    end
 
-    assert ulid_2 > ulid_1
+    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
 
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ulid
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Rafael Sales
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-05 00:00:00.000000000 Z
+date: 2016-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sysrandom
@@ -43,6 +43,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- lib/ext/time.rb
 - lib/ulid.rb
 - lib/ulid/generator.rb
 - lib/ulid/version.rb