activeuuid-ps 0.1.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.swp
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in activeuuid.gemspec
+gemspec

data/README.mkd

@@ -0,0 +1,134 @@
+# activeuuid
+
+Add `binary(16)` UUIDs to ActiveRecord. 
+
+## Example
+
+### Create a Migration
+
+`activeuuid` adds the `uuid` type to your migrations. Example:
+
+```ruby
+class CreateEmails < ActiveRecord::Migration
+  def self.up
+    create_table :emails, :id => false  do |t|
+      t.uuid :id, :unique => true
+      t.uuid :sender_id  # belongs_to :sender
+
+      t.string :subject
+      t.text :body
+
+      t.timestamp :sent_at
+      t.timestamps
+    end
+    add_index :emails, :id
+  end
+
+  def self.down
+    drop_table :emails
+  end
+end
+```
+
+### include ActiveUUID::UUID in your model
+
+```ruby
+class Email < ActiveRecord::Base
+  include ActiveUUID::UUID
+  belongs_to :sender
+end
+```
+
+### use it:
+Here are some example specs:
+
+```ruby
+require 'spec_helper'
+
+describe Email do
+
+  context "when using uuid's as keys" do
+    before(:each) do
+      Email.delete_all
+      @guid = "1dd74dd0-d116-11e0-99c7-5ac5d975667e"
+      @e = Email.new(:subject => "hello", :body => "world") {|e| e.id = UUIDTools::UUID.parse(@guid) }
+      @e.save
+    end
+
+    it "the id guid should be equal to the uuid" do
+      @e.id.to_s.should eql(@guid)
+    end
+
+    it "should be able to find an email by the uuid" do
+      f = Email.find(UUIDTools::UUID.parse(@guid))
+      f.id.to_s.should eql(@guid)
+    end
+
+  end
+end
+```
+
+## Motivation
+
+From [2]:
+
+> [Here is a] UUID:  1e8ef774-581c-102c-bcfe-f1ab81872213
+> 
+> A UUID like the one above is 36 characters long, including dashes.  If you store this VARCHAR(36), you're going to decrease compare performance dramatically.  This is your primary key, you don't want it to be slow.
+> 
+> At its bit level, a UUID is 128 bits, which means it will fit into
+> 16 bytes, note this is not very human readable, but it will keep
+> storage low, and is only 4 times larger than a 32-bit int, or 2
+> times larger than a 64-bit int.
+
+Many of the existing examples of how to use UUIDs as primary keys
+in Rails use strings rather than bytes (e.g. [3]).
+
+However, this plugin stores the primary keys as bytes. To the
+application the keys are represented by a UUIDTools::UUID object.
+
+## Benefits of UUIDs as primary key
+
+* no id conflict during multi-master write
+* no locking due to auto-increment
+* with time-based UUIDs you can store a timestamp within your UUID
+* you can create natural keys (based on the SHA of model attributes)
+
+## Future work
+* more transparent support for natural and composite keys
+* support for MySQLs `INSERT ... ON DUPLICATE KEY UPDATE` syntax
+* support a primary column name other than `id`
+* work on other databases (Postgres, etc)
+* tests
+
+## Inspiration 
+James Golick's `friendly` is a great gem for NoSQL on MySQL. It's
+a great gateway drug to systems like Cassandra for teams that are
+already familiar with the ins-and-outs of MySQL.
+
+## Installation
+
+Add this to your `Gemfile`
+
+    gem "activeuuid"
+
+Or get the code here: https://github.com/jashmenn/activeuuid
+
+## References
+* [1] http://bret.appspot.com/entry/how-friendfeed-uses-mysql
+* [2] http://kekoav.com/blog/36-computers/58-uuids-as-primary-keys-in-mysql.html 
+* [3] https://gist.github.com/937739
+* [4] http://www.codinghorror.com/blog/2007/03/primary-keys-ids-versus-guids.html
+* [5] http://krow.livejournal.com/497839.html
+* [6] https://github.com/jamesgolick/friendly
+
+## Dependencies
+Rails ~> 3.1.0 - It uses the custom column serialization Aaron
+Patterson introduced in Rails 3.1.
+
+I'm using JRuby 1.9 (1.6.3) but this should work under MRI (YMMV).
+
+## Author
+
+Nate Murray <nate@xcombinator.com>
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/activeuuid.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "activeuuid/version"
+
+Gem::Specification.new do |s|
+  s.name        = "activeuuid-ps"
+  s.version     = Activeuuid::VERSION
+  s.authors     = ["Nate Murray, Ralf S. Bongiolo"]
+  s.email       = ["nate@natemurray.com, ralfsb2008@gmail.com"]
+  s.homepage    = "http://www.xcombinator.com"
+  s.summary     = %q{Add binary UUIDs to ActiveRecord in PostgreSQL}
+  s.description = %q{Add binary (not string) UUIDs to ActiveRecord in PostgreSQL}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # s.add_development_dependency "rspec"
+  s.add_runtime_dependency "uuidtools"
+end

data/lib/activeuuid.rb

@@ -0,0 +1,6 @@
+require "activeuuid/version"
+
+module ActiveUUID
+  require 'activeuuid/railtie' if defined?(Rails)
+  require 'activeuuid/uuid'
+end

data/lib/activeuuid/railtie.rb

@@ -0,0 +1,21 @@
+require 'activeuuid'
+require 'rails'
+
+module ActiveUUID
+  class Railtie < Rails::Railtie
+    railtie_name :activeuuid
+    initializer "activeuuid.configure_rails_initialization" do
+
+      module ActiveRecord::ConnectionAdapters
+        class TableDefinition
+          def uuid (*args)
+            options = args.extract_options!
+            column_names = args
+            column_names.each { |name| column(name, 'binary(16)', options) }
+          end                                                                     
+        end
+      end
+
+    end
+  end
+end

data/lib/activeuuid/uuid.rb

@@ -0,0 +1,107 @@
+module UUIDTools
+  class UUID
+    # monkey-patch Friendly::UUID to serialize UUIDs to MySQL
+    def quoted_id
+      s = raw.unpack("H*")[0]
+      "x'#{s}'"
+    end
+
+    # monkey-patch Friendly::UUID to serialize UUIDs to MySQL
+    def quoted_id_ps
+      s = raw.unpack("H*")[0]
+      "\x'#{s}'"
+    end
+
+    def as_json(options = nil)
+      hexdigest.upcase
+    end
+
+    def to_param
+      hexdigest.upcase
+    end
+  end
+end
+
+module Arel
+  module Visitors
+    class MySQL < Arel::Visitors::ToSql
+      def visit_UUIDTools_UUID(o)
+        o.quoted_id
+      end
+    end
+    class PostgreSQL < Arel::Visitors::ToSql
+      def visit_UUIDTools_UUID(o)
+        o.quoted_id_ps
+      end
+    end
+  end
+end
+
+module ActiveUUID
+  class UUIDSerializer
+    def load(binary)
+      case binary
+        when UUIDTools::UUID then binary
+        when nil then nil
+        else UUIDTools::UUID.parse_raw(binary)
+      end
+    end
+    def dump(uuid)
+      uuid ? uuid.raw : nil
+    end
+  end
+
+  module UUID
+    extend ActiveSupport::Concern
+
+    included do
+      before_create :generate_uuid_if_needed
+
+      set_primary_key "id"
+      serialize :id, ActiveUUID::UUIDSerializer.new
+      
+      def generate_uuid_if_needed
+        generate_uuid unless self.id
+      end
+
+      def to_param
+        id.to_param
+      end
+
+      def generate_uuid
+        if nka = self.class.natural_key_attributes
+          # TODO if all the attributes return nil you might want to warn about this
+          chained = nka.collect{|a| self.send(a).to_s}.join("-")
+          self.id = UUIDTools::UUID.sha1_create(UUIDTools::UUID_OID_NAMESPACE, chained)
+        else
+          self.id = UUIDTools::UUID.timestamp_create
+        end
+      end
+    end
+
+    module ClassMethods
+      def natural_key_attributes
+        @_activeuuid_natural_key_attributes
+      end
+
+      def natural_key(*attributes)
+        @_activeuuid_natural_key_attributes = attributes
+      end
+
+      def uuids(*attributes)
+       attributes.each do |attribute|
+          serialize attribute.intern, ActiveUUID::UUIDSerializer.new
+         #class_eval <<-eos
+         #  # def #{@association_name}
+         #  #   @_#{@association_name} ||= self.class.associations[:#{@association_name}].new_proxy(self)
+         #  # end
+         #eos
+       end
+      end
+    end
+
+    module InstanceMethods
+    end
+ 
+  end
+end

data/lib/activeuuid/version.rb

@@ -0,0 +1,3 @@
+module Activeuuid
+  VERSION = "0.1.1"
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: activeuuid-ps
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Nate Murray, Ralf S. Bongiolo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-28 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: uuidtools
+  requirement: &23679000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *23679000
+description: Add binary (not string) UUIDs to ActiveRecord in PostgreSQL
+email:
+- nate@natemurray.com, ralfsb2008@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.mkd
+- Rakefile
+- activeuuid.gemspec
+- lib/activeuuid.rb
+- lib/activeuuid/railtie.rb
+- lib/activeuuid/uuid.rb
+- lib/activeuuid/version.rb
+homepage: http://www.xcombinator.com
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: Add binary UUIDs to ActiveRecord in PostgreSQL
+test_files: []