lexical_uuid 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 James Golick
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,26 @@
+= lexical_uuid
+
+UUIDs that are byte-ordered lamport clocks (timestamp, worker_id). Much simpler than type-1 UUID's crappy, weirdo layout.
+
+= Install
+  
+  sudo gem install lexical_uuid
+
+= Usage
+
+  ree-1.8.7-2010.02 > LexicalUUID.new
+  => #<LexicalUUID:0x1019400f0 @worker_id=2842420286492008582, @timestamp=1281991807929511>
+r ee-1.8.7-2010.02 > LexicalUUID.new.to_guid
+  => "00048df6-faef-2bb5-2772-4e30d6b86086" 
+r ee-1.8.7-2010.02 > LexicalUUID.new.to_bytes
+  => "\000\004\215\366\373\"\022\352'rN0\326\270206" 
+r ee-1.8.7-2010.02 > LexicalUUID.new(LexicalUUID.new.to_guid)
+  => #<LexicalUUID:0x101936118 @worker_id=2842420286492008582, @timestamp=1281991837642798> 
+r ee-1.8.7-2010.02 > LexicalUUID.new(LexicalUUID.new.to_bytes)
+  => #<LexicalUUID:0x101931690 @worker_id=2842420286492008582, @timestamp=1281991842330188> 
+r ee-1.8.7-2010.02 > LexicalUUID.new(Time.now)
+  => #<LexicalUUID:0x10192df18 @worker_id=2842420286492008582, @timestamp=1281991847641387> 
+
+== Copyright
+
+Copyright (c) 2010 James Golick. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "lexical_uuid"
+    gem.summary = %Q{UUIDs that are byte-ordered lamport clocks (timestamp, worker_id). Much simpler than type-1 UUID's crappy, weirdo layout.}
+    gem.description = %Q{UUIDs that are byte-ordered lamport clocks (timestamp, worker_id). Much simpler than type-1 UUID's crappy, weirdo layout.}
+    gem.email = "jamesgolick@gmail.com"
+    gem.homepage = "http://github.com/jamesgolick/lexical_uuid"
+    gem.authors = ["James Golick"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_dependency "RubyInline", "=3.8.4"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "lexical_uuid #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/lexical_uuid.rb

@@ -0,0 +1,113 @@
+require "rubygems"
+require "socket"
+require "inline"
+
+class String
+  inline :C do |builder|
+    builder.c <<-__END__
+      static long fnv1a() {
+        long hash = 0xcbf29ce484222325;
+        long i = 0;
+      
+        for(i = 0; i < RSTRING(self)->len; i++) {
+          hash ^= RSTRING(self)->ptr[i];
+          hash *= 0x100000001b3;
+        }
+
+        return hash;
+      }
+    __END__
+  end
+end
+
+# Borrowed from the SimpleUUID gem
+class Time
+  def self.stamp
+    Time.now.stamp
+  end
+  
+  def stamp
+    to_i * 1_000_000 + usec
+  end
+end
+
+class LexicalUUID
+  class << self
+    def worker_id
+      @worker_id ||= create_worker_id
+    end
+
+    private
+      def create_worker_id
+        Socket.gethostbyname(Socket.gethostname).first.fnv1a
+      end
+  end
+
+  attr_reader :worker_id, :timestamp
+
+  def initialize(timestamp = nil, worker_id = nil)
+    case timestamp
+    when Fixnum, Bignum
+      @timestamp = timestamp
+      @worker_id = worker_id || self.class.worker_id
+    when String
+      case timestamp.size
+      when 16
+        from_bytes(timestamp)
+      when 36
+        elements = timestamp.split("-")
+        from_bytes(elements.join.to_a.pack('H32'))
+      else
+        raise ArgumentError, 
+          "#{timestamp} was incorrectly sized. Must be 16 timestamp."
+      end
+    when Time
+      @timestamp = timestamp.stamp
+      @worker_id = self.class.worker_id
+    when nil
+      @worker_id = self.class.worker_id
+      @timestamp = Time.stamp
+    end
+  end
+
+  def to_bytes
+    [timestamp >> 32,
+      timestamp & 0xffffffff,
+      worker_id >> 32,
+      worker_id & 0xffffffff].pack("NNNN")
+  end
+
+  # Also borrowed from simple_uuid
+  def to_guid
+    elements     = to_bytes.unpack("NnnCCa6")
+    node         = elements[-1].unpack('C*')
+    elements[-1] = '%02x%02x%02x%02x%02x%02x' % node
+    "%08x-%04x-%04x-%02x%02x-%s" % elements
+  end
+
+  def <=>(other)
+    timestamp == other.timestamp ? 
+      worker_id <=> other.worker_id : timestamp <=> other.timestamp
+  end
+
+  def ==(other)
+    other.is_a?(LexicalUUID) &&
+      timestamp == other.timestamp &&
+        worker_id == other.worker_id
+  end
+
+  def eql?(other)
+    self == other
+  end
+
+  def hash
+    to_bytes.hash
+  end
+
+  private
+    def from_bytes(bytes)
+      time_high, time_low, worker_high, worker_low = bytes.unpack("NNNN")
+      @timestamp = (time_high << 32) | time_low
+      @worker_id = (worker_high << 32) | worker_low
+    end
+end

data/spec/lexical_uuid_spec.rb

@@ -0,0 +1,173 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "LexicalUUID" do
+  describe "creating a UUID with no parameters" do
+    before do
+      @uuid = LexicalUUID.new
+    end
+
+    it "has a worker id" do
+      @uuid.worker_id.should_not be_nil
+    end
+
+    it "has a timestamp in usecs" do
+      @uuid.timestamp.should < Time.stamp
+    end
+
+    it "serializes to bytes" do
+      expected_bytes = [@uuid.timestamp >> 32,
+                        @uuid.timestamp & 0xffffffff,
+                        @uuid.worker_id >> 32,
+                        @uuid.worker_id & 0xffffffff].pack("NNNN")
+      @uuid.to_bytes.should == expected_bytes
+    end
+  end
+
+  describe "reinitializing the uuid from bytes" do
+    describe "with a correctly sized byte array" do
+      before do
+        @bytes = [1234567890 >> 32,
+                  1234567890 & 0xffffffff,
+                  9876543210 >> 32,
+                  9876543210 & 0xffffffff].pack("NNNN")
+        @uuid  = LexicalUUID.new(@bytes)
+      end
+
+      it "correctly extracts the timestamp" do
+        @uuid.timestamp.should == 1234567890
+      end
+
+      it "correctly extracts the worker id" do
+        @uuid.worker_id.should == 9876543210
+      end
+    end
+    
+    describe "with a mis-sized byte array" do
+      it "raises ArgumentError" do
+        lambda {
+          LexicalUUID.new("asdf")
+        }.should raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe "initializing a uuid from a timestamp and worker_id" do
+    before do
+      @timestamp = 15463021018891620831
+      @worker_id = 9964740229835689317
+      @uuid      = LexicalUUID.new(@timestamp, @worker_id)
+    end
+
+    it "sets the timestamp" do
+      @uuid.timestamp.should == @timestamp
+    end
+
+    it "sets the worker_id" do
+      @uuid.worker_id.should == @worker_id
+    end
+  end
+
+  describe "converting a uuid in to a guid" do
+    before do
+      @uuid = LexicalUUID.new(15463021018891620831, 9964740229835689317)
+    end
+    
+    it "matches other uuid->guid implementations" do
+      @uuid.to_guid.should == "d697afb0-a96f-11df-8a49-de718e668d65"
+    end
+  end
+
+  describe "initializing from a guid" do
+    before do
+      @uuid = LexicalUUID.new("d697afb0-a96f-11df-8a49-de718e668d65")
+    end
+    
+    it "correctly initializes the timestamp" do
+      @uuid.timestamp.should == 15463021018891620831
+    end
+
+    it "correctly initializes the worker_id" do
+      @uuid.worker_id.should == 9964740229835689317
+    end
+  end
+
+  describe "initializing with a timestamp with no worker_id" do
+    before do
+      @uuid = LexicalUUID.new(12345)
+    end
+
+    it "sets the timestamp" do
+      @uuid.timestamp.should == 12345
+    end
+
+    it "uses the default worker_id" do
+      @uuid.worker_id.should == LexicalUUID.worker_id
+    end
+  end
+
+  describe "comparing uuids" do
+    it "compares first by timestamp" do
+      (LexicalUUID.new(123) <=> LexicalUUID.new(234)).should == -1
+      (LexicalUUID.new(223) <=> LexicalUUID.new(134)).should == 1
+    end
+
+    it "compares by worker_id if the timestamps are equal" do
+      (LexicalUUID.new(123, 1) <=> LexicalUUID.new(123, 2)).should == -1
+      (LexicalUUID.new(123, 2) <=> LexicalUUID.new(123, 1)).should == 1
+      (LexicalUUID.new(123, 1) <=> LexicalUUID.new(123, 1)).should == 0
+    end
+  end
+
+  describe "==" do
+    it "is equal when the timestamps and worker ids are equal" do
+      LexicalUUID.new(123, 123).should == LexicalUUID.new(123, 123)
+    end
+
+    it "is not equal when the timestamps are not equal" do
+      LexicalUUID.new(223, 123).should_not == LexicalUUID.new(123, 123)
+    end
+
+    it "is not equal when the worker_ids are not equal" do
+      LexicalUUID.new(123, 223).should_not == LexicalUUID.new(123, 123)
+    end
+  end
+
+  describe "eql?" do
+    it "is equal when the timestamps and worker ids are equal" do
+      LexicalUUID.new(123, 123).should eql(LexicalUUID.new(123, 123))
+    end
+
+    it "is not equal when the timestamps are not equal" do
+      LexicalUUID.new(223, 123).should_not eql(LexicalUUID.new(123, 123))
+    end
+
+    it "is not equal when the worker_ids are not equal" do
+      LexicalUUID.new(123, 223).should_not eql(LexicalUUID.new(123, 123))
+    end
+  end
+
+  describe "hash" do
+    it "has the same hash if the timestamp/worker_id are the same" do
+      LexicalUUID.new(123, 123).hash.should == LexicalUUID.new(123, 123).hash
+    end
+
+    it "has a different hash when the timestamps are different" do
+      LexicalUUID.new(223, 123).hash.should_not == LexicalUUID.new(123, 123).hash
+    end
+
+    it "has a different hash when the worker_ids are not equalc" do
+      LexicalUUID.new(123, 223).hash.should_not == LexicalUUID.new(123, 123).hash
+    end
+  end
+
+  describe "initializing with a time object" do
+    before do
+      @time = Time.now
+      @uuid = LexicalUUID.new(@time)
+    end
+
+    it "uses the time's stamp object" do
+      @uuid.timestamp.should == @time.stamp
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'lexical_uuid'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification 
+name: lexical_uuid
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- James Golick
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-16 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: RubyInline
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 47
+        segments: 
+        - 3
+        - 8
+        - 4
+        version: 3.8.4
+  type: :runtime
+  version_requirements: *id002
+description: UUIDs that are byte-ordered lamport clocks (timestamp, worker_id). Much simpler than type-1 UUID's crappy, weirdo layout.
+email: jamesgolick@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/lexical_uuid.rb
+- spec/lexical_uuid_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/jamesgolick/lexical_uuid
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: UUIDs that are byte-ordered lamport clocks (timestamp, worker_id). Much simpler than type-1 UUID's crappy, weirdo layout.
+test_files: 
+- spec/lexical_uuid_spec.rb
+- spec/spec_helper.rb