druuid 1.0.0

data/druuid.rb

@@ -0,0 +1,43 @@
+require 'securerandom'
+
+# = Druuid
+#
+# Date-relative UUID generation.
+module Druuid
+
+  class << self
+
+    # The offset from which Druuid UUIDs are generated (in seconds).
+    attr_accessor :epoch
+
+    # Generates a time-sortable, 64-bit UUID.
+    #
+    # @example
+    #   Druuid.gen
+    #   # => 11142943683383068069
+    # @param [Time] time of UUID
+    # @param [Numeric] epoch offset
+    # @return [Bignum] UUID
+    def gen time = Time.now, epoch = epoch
+      ms = ((time.to_f - epoch.to_i) * 1e3).round
+      rand = (SecureRandom.random_number * 1e16).round
+      id = ms << (63 - 40)
+      id | rand % (2 ** (63 - 40))
+    end
+
+    # Determines when a given UUID was generated.
+    #
+    # @param [Numeric] uuid
+    # @param [Numeric] epoch offset
+    # @return [Time] when UUID was generated
+    # @example
+    #   Druuid.time 11142943683383068069
+    #   # => 2012-02-04 00:00:00 -0800
+    def time uuid, epoch = epoch
+      ms = uuid >> (63 - 40)
+      Time.at (ms / 1e3) + epoch.to_i
+    end
+
+  end
+
+end

data/spec/druuid_spec.rb

@@ -0,0 +1,57 @@
+require_relative '../druuid'
+
+describe Druuid do
+  describe '.gen' do
+    it 'generates a UUID' do
+      uuid = Druuid.gen
+      uuid.should be_instance_of Bignum
+      uuid.should_not eq Druuid.gen
+    end
+
+    let(:datetime) { Time.utc 2012, 2, 4, 8 }
+    let(:prefix) { '111429436833' }
+    context 'with a given time' do
+      it 'generates the UUID against the time' do
+        Druuid.gen(datetime).to_s[0, 12].should eq prefix
+      end
+    end
+
+    let(:offset) { 60 * 60 * 24 }
+    context 'with a given epoch' do
+      it 'generates the UUID against the offset' do
+        Druuid.gen(datetime + offset, offset).to_s[0, 12].should eq prefix
+      end
+    end
+
+    context 'with a default epoch' do
+      before { @old_epoch, Druuid.epoch = Druuid.epoch, offset }
+      it 'generates the UUID against the offset' do
+        Druuid.gen(datetime + offset).to_s[0, 12].should eq prefix
+      end
+      after { Druuid.epoch = @old_epoch }
+    end
+  end
+
+  describe '.time' do
+    let(:datetime) { Time.utc 2012, 2, 4, 8 }
+    let(:uuid) { 11142943683383068069 }
+    it 'determines when a UUID was generated' do
+      Druuid.time(uuid).should eq datetime
+    end
+
+    let(:offset) { 60 * 60 * 24 }
+    context 'with a given epoch' do
+      it 'determines UUID date against the offset' do
+        Druuid.time(uuid, offset).should eq datetime + offset
+      end
+    end
+
+    context 'with a default epoch' do
+      before { @old_epoch, Druuid.epoch = Druuid.epoch, offset }
+      it 'determines UUID date against the offest' do
+        Druuid.time(uuid).should eq datetime + offset
+      end
+      after { Druuid.epoch = @old_epoch }
+    end
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: druuid
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Stephen Celis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Druuid generates 64-bit, time-sortable UUIDs.
+email: stephen@recurly.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- druuid.rb
+- spec/druuid_spec.rb
+homepage: https://github.com/recurly/druuid
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- .
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Date-relative UUID generation
+test_files:
+- spec/druuid_spec.rb