gold-record 0.1.0

data/HISTORY.rdoc

@@ -0,0 +1,7 @@
+=== Version 0.1.0 (git)
+
+This is the first preview release of GoldRecord, an extension for ActiveRecord that implements unobtrusive support for binary UUIDs.
+
+* Currently requires MySQL.
+* Basic gem + project framework.
+* Extracted and renamed from UniversalRecord to GoldRecord.

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright © 2009 Randy Reddig
+
+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,93 @@
+= GoldRecord
+
+* http://github.com/ydnar/gold-record
+* http://gemcutter.org/gems/gold-record
+* mailto:randy@shaderlab.com
+
+== DESCRIPTION
+
+GoldRecord is an extension for ActiveRecord that implements unobtrusive binary UUIDs[http://en.wikipedia.org/wiki/Universally_Unique_Identifier] in MySQL.
+
+== FEATURES
+
+* Uses space-efficient 16-byte binary representation for UUIDs.
+* Works with associations, migrations and ActiveRecord::SchemaDumper.
+* Transparently converts to/from hex-encoded UUIDs in #to_param and #find.
+
+GoldRecord supports SchemaDumper by not declaring the <tt>id</tt> column a <tt>PRIMARY KEY</tt>. The odds of a random UUID collision are documented here[http://en.wikipedia.org/wiki/Universally_Unique_Identifier#Random_UUID_probability_of_duplicates].
+
+== SYNOPSIS
+
+  class Blog < ActiveRecord::Base
+    acts_as_gold_record
+    has_many :posts
+  end
+  
+  class Post < ActiveRecord::Base
+    acts_as_gold_record
+  end
+  
+=== Or, for the exceptionally paranoid:
+  
+  class LargeHadron < ActiveRecord::Base
+    acts_as_gold_record
+    set_primary_key :lottery_number
+    validates_uniqueness_of :lottery_number, :on => :create
+  end
+
+== MIGRATIONS
+
+  class MakeGoldRecords < ActiveRecord::Migration
+    def self.up
+      # Change each int(11) id column to binary(16).
+      # This preserves the column’s original value as a right-padded 16-byte string.
+      [:labels, :record_stores].each do |table|
+        change_integer_primary_key_to_uuid(table)
+        add_index table, :id
+      end
+
+      # Change association columns to binary(16).
+      [
+        [:artists, :label_id, :id],
+        [:labels_record_stores, :label_id, false],
+        [:labels_record_stores, :record_store_id, false],
+        [:artists_record_stores, :record_store_id, false],
+      ].each do |table, column, primary_key|
+        change_integer_to_uuid(table, column, primary_key)
+      end
+    end
+
+  
+    # Down migration designed to be run immediately after an up migration
+    # in the event of some failure. Running this after generating any UUIDs
+    # will produce unpredictable results.
+
+    def self.down
+      # Change each binary(16) id column to int(11).
+      # MySQL casts the string value to an integer.
+      [:labels, :record_stores].each do |table|
+        remove_index table, :id
+        change_uuid_to_integer_primary_key(table)
+      end
+
+      # Change association columns to int(11).
+      [
+        [:artists, :label_id, :id],
+        [:labels_record_stores, :label_id, false],
+        [:labels_record_stores, :record_store_id, false],
+        [:artists_record_stores, :record_store_id, false],
+      ].each do |table, column|
+        change_uuid_to_integer(table, column, primary_key)
+      end
+    end
+  end
+
+== INSTALL
+
+=== As a gem:
+
+  [sudo] gem install gold-record
+
+=== As a Rails plugin:
+
+Clone/copy to <tt>vendor/plugins/gold_record</tt>.

data/Rakefile

@@ -0,0 +1,138 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+
+require File.join(File.dirname(__FILE__), 'lib', 'gold_record', 'version')
+require File.expand_path(File.dirname(__FILE__)) + '/test/config'
+
+PKG_BUILD     = ENV['PKG_BUILD'] ? '.' + ENV['PKG_BUILD'] : ''
+PKG_NAME      = 'gold-record'
+PKG_VERSION   = GoldRecord::VERSION::STRING + PKG_BUILD
+PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
+
+GEM_SPEC_NAME = File.join(File.dirname(__FILE__), "#{PKG_NAME}-#{PKG_VERSION}.gemspec")
+GEM_NAME      = File.join(File.dirname(__FILE__), "#{PKG_NAME}-#{PKG_VERSION}.gem")
+
+RELEASE_NAME  = "REL #{PKG_VERSION}"
+
+RUBY_FORGE_PROJECT = "gold-record"
+RUBY_FORGE_USER    = "ydnar"
+
+MYSQL_DB_USER = 'root'
+
+PKG_FILES = FileList[
+    "lib/**/*", "test/**/*", "doc/**/*", "[A-Z]*",
+    "HISTORY.rdoc", "README.rdoc",
+    "Rakefile"
+]
+
+desc 'Run unit tests by default'
+task :default => :test
+
+Rake::TestTask.new(:test) { |t|
+  t.libs << 'test'
+  t.test_files = Dir.glob( "test/cases/**/*_test.rb" ).sort
+  t.verbose = true
+}
+
+namespace :mysql do
+  desc 'Build the MySQL test databases'
+  task :build_databases do
+    %x( echo "create DATABASE gold_record_test DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_unicode_ci " | mysql --user=#{MYSQL_DB_USER})
+  end
+
+  desc 'Drop the MySQL test databases'
+  task :drop_databases do
+    %x( mysqladmin --user=#{MYSQL_DB_USER} -f drop gold_record_test )
+  end
+
+  desc 'Rebuild the MySQL test databases'
+  task :rebuild_databases => [:drop_databases, :build_databases]
+end
+
+task :build_mysql_databases => 'mysql:build_databases'
+task :drop_mysql_databases => 'mysql:drop_databases'
+task :rebuild_mysql_databases => 'mysql:rebuild_databases'
+
+
+# Generate the RDoc documentation
+
+Rake::RDocTask.new { |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title    = "GoldRecord -- Object-relation mapping put on rails"
+  rdoc.options << '--line-numbers' << '--inline-source' << '-A cattr_accessor=object'
+  rdoc.options << '--charset' << 'utf-8'
+  rdoc.template = ENV['template'] ? "#{ENV['template']}.rb" : '../doc/template/horo'
+  rdoc.rdoc_files.include('README.txt', 'HISTORY.rdoc', 'LICENSE.txt')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+}
+
+
+# Create compressed packages
+
+dist_dirs = [ "lib", "test" ]
+
+spec = Gem::Specification.new do |s|
+  s.name = PKG_NAME
+  s.version = PKG_VERSION
+  s.summary = "Binary UUID support for ActiveRecord"
+  s.description = "Unobtrusive binary UUID support for ActiveRecord. Supports migrations, reflections, assocations and SchemaDumper."
+  s.author = "Randy Reddig"
+  s.email = "randy@shaderlab.com"
+  s.homepage = "http://github.com/ydnar/gold-record"
+  s.rubyforge_project = "gold-record"
+  
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+
+  s.extra_rdoc_files = ["HISTORY.rdoc", "LICENSE.txt", "README.rdoc"]
+  s.files = [ "Rakefile", "LICENSE.txt", "README.rdoc", "HISTORY.rdoc" ]
+  dist_dirs.each do |dir|
+    s.files = s.files + Dir.glob( "#{dir}/**/*" )
+  end
+  
+  s.has_rdoc = true
+  s.rdoc_options.concat ["--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.3.5"
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, [">= 2.3.4"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 2.3.4"])
+      s.add_runtime_dependency(%q<uuidtools>, [">= 2.0.0"])
+    else
+      s.add_dependency(%q<activerecord>, [">= 2.3.4"])
+      s.add_dependency(%q<activesupport>, [">= 2.3.4"])
+      s.add_dependency(%q<uuidtools>, [">= 2.0.0"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, [">= 2.3.4"])
+    s.add_dependency(%q<activesupport>, [">= 2.3.4"])
+    s.add_dependency(%q<uuidtools>, [">= 2.0.0"])
+  end
+end
+
+namespace :gem do
+  desc "Print gemspec"
+  task :spec do
+    open GEM_SPEC_NAME, "wb" do |file|
+      file.write(spec.to_ruby)
+    end
+  end
+  
+  desc "Build gem with Gemcutter"
+  task :build => :spec do
+    system "gem build #{GEM_SPEC_NAME}"
+  end
+  
+  desc "Push gem to Gemcutter"
+  task :push => :build do
+    system "gem push #{GEM_NAME}"
+  end
+end

data/lib/gold-record.rb

@@ -0,0 +1 @@
+require 'gold_record'

data/lib/gold_record.rb

@@ -0,0 +1,26 @@
+#--
+# Copyright (c) 2009 Randy Reddig
+#
+# 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.
+#++
+
+require 'gold_record/base'
+require 'gold_record/fixtures'
+require 'gold_record/connection_adapters/mysql_adapter'

data/lib/gold_record/base.rb

@@ -0,0 +1,57 @@
+require 'uuidtools'
+
+module GoldRecord
+  module ClassMethods
+    def gold_record?
+      true
+    end
+    
+    def coerce_id(id)
+      if id.is_a?(String) && id.size == 16
+        id
+      else
+        UUIDTools::UUID.parse(id).raw rescue nil
+      end
+    end
+
+    def find_one_with_uuid(id, options)
+      find_one_without_uuid(coerce_id(id), options)
+    end
+
+    def find_some_with_uuid(ids, options)
+      ids = ids.map { |id| coerce_id(id) }
+      ids = ids.uniq # must do this after coercion
+      find_some_without_uuid(ids, options)
+    end
+  end
+
+  module InstanceMethods
+    def to_uuid
+      UUIDTools::UUID.parse_raw(id) rescue nil
+    end
+
+    def to_param_with_uuid
+      uuid = to_uuid
+      uuid ? uuid.to_param : nil
+    end
+
+    def generate_id!
+      self[self.class.primary_key] ||= UUIDTools::UUID.random_create.raw
+    end
+  end
+
+  module ActMethods
+    def acts_as_gold_record
+      extend ClassMethods
+      class << self
+        alias_method_chain :find_one, :uuid
+        alias_method_chain :find_some, :uuid
+      end
+      include InstanceMethods
+      alias_method_chain :to_param, :uuid
+      before_create :generate_id!
+    end
+  end
+end
+
+ActiveRecord::Base.extend GoldRecord::ActMethods

data/lib/gold_record/connection_adapters/mysql_adapter.rb

@@ -0,0 +1,65 @@
+require 'active_record/connection_adapters/mysql_adapter'
+
+module ActiveRecord
+  module ConnectionAdapters
+    class MysqlAdapter < AbstractAdapter
+      
+      # MySQL can store UUIDs in binary(16) instead of a blob column.
+      def type_to_sql(type, limit = nil, precision = nil, scale = nil)
+        # New functionality to handle limit on binary columns
+        return "binary(#{limit})" if type.to_s == 'binary' && !limit.blank?
+
+        # Exact implementation from ActiveRecord 2.3.4
+        return super unless type.to_s == 'integer'
+
+        case limit
+        when 1; 'tinyint'
+        when 2; 'smallint'
+        when 3; 'mediumint'
+        when nil, 4, 11; 'int(11)'  # compatibility with MySQL default
+        when 5..8; 'bigint'
+        else raise(ActiveRecordError, "No integer type has byte size #{limit}")
+        end
+      end
+      
+      def change_integer_primary_key_to_uuid(table, column = :id)
+        table = table.to_s
+        column = column.to_s
+        execute "ALTER TABLE #{table} ADD COLUMN #{column}_new BINARY(16) FIRST"
+        execute "UPDATE #{table} SET #{column}_new = #{column}"
+        execute "ALTER TABLE #{table} DROP COLUMN #{column}"
+        execute "ALTER TABLE #{table} CHANGE COLUMN #{column}_new #{column} BINARY(16) FIRST"
+      end
+
+      def change_uuid_to_integer_primary_key(table, column = :id)
+        table = table.to_s
+        column = column.to_s
+        execute "ALTER TABLE #{table} CHANGE COLUMN #{column} #{column}_old BINARY(16)"
+        execute "ALTER TABLE #{table} ADD COLUMN #{column} int(11)"
+        execute "UPDATE #{table} SET #{column} = #{column}_old"
+        execute "ALTER TABLE #{table} DROP COLUMN #{column}_old"
+        execute "ALTER TABLE #{table} CHANGE COLUMN #{column} #{column} #{NATIVE_DATABASE_TYPES[:primary_key]} FIRST"
+      end
+
+      def change_integer_to_uuid(table, column = :id, primary_key = :id)
+        table = table.to_s
+        column = column.to_s
+        after_clause = primary_key ? "AFTER #{primary_key}" : ""
+        execute "ALTER TABLE #{table} ADD COLUMN #{column}_new BINARY(16)"
+        execute "UPDATE #{table} SET #{column}_new = #{column}"
+        execute "ALTER TABLE #{table} DROP COLUMN #{column}"
+        execute "ALTER TABLE #{table} CHANGE COLUMN #{column}_new #{column} BINARY(16) #{after_clause}"
+      end
+
+      def change_uuid_to_integer(table, column = :id, primary_key = :id)
+        table = table.to_s
+        column = column.to_s
+        after_clause = primary_key ? "AFTER #{primary_key}" : ""
+        execute "ALTER TABLE #{table} CHANGE COLUMN #{column} #{column}_old BINARY(16)"
+        execute "ALTER TABLE #{table} ADD COLUMN #{column} int(11) #{after_clause}"
+        execute "UPDATE #{table} SET #{column} = #{column}_old"
+        execute "ALTER TABLE #{table} DROP COLUMN #{column}_old"
+      end
+    end
+  end
+end

data/lib/gold_record/fixtures.rb

@@ -0,0 +1,15 @@
+module GoldRecord
+  module Fixtures
+    def self.included(base)
+      base.class_eval do
+        class << self
+          # Patch Fixtures.identify for binary UUIDs.
+          def identify_with_padding(label)
+            ("%-16d" % identify_without_padding(label)).tr(" ", "\0")
+          end
+          alias_method_chain :identify, :padding
+        end
+      end
+    end
+  end
+end

data/lib/gold_record/version.rb

@@ -0,0 +1,9 @@
+module GoldRecord
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/test/cases/aaa_create_tables_test.rb

@@ -0,0 +1,11 @@
+# The filename begins with "aaa" to ensure this is the first test.
+require 'cases/helper'
+
+class AAACreateTablesTest < ActiveRecord::TestCase
+  self.use_transactional_fixtures = false
+
+  def test_load_schema
+    eval(File.read(SCHEMA_ROOT + "/schema.rb"))
+    assert true
+  end
+end