leifcr-activeuuid 0.6.1

data/.travis.yml

@@ -0,0 +1,52 @@
+before_script:
+  - mysql -e 'create database activeuuid_test;'
+  - psql -c 'create database activeuuid_test;' -U postgres
+
+rvm:
+  - 2.3.6
+  - 2.4.3
+  - jruby-9.1.15.0
+
+gemfile:
+  - Gemfile
+  - gemfiles/Gemfile.rails-4-0
+  - gemfiles/Gemfile.rails-4-1
+  - gemfiles/Gemfile.rails-4-2
+  - gemfiles/Gemfile.rails-5-0
+  - gemfiles/Gemfile.rails-5-1
+  - gemfiles/Gemfile.rails-head
+
+env:
+  - DB=sqlite3
+  - DB=mysql
+  - DB=postgresql
+
+matrix:
+  allow_failures:
+    - gemfile: gemfiles/Gemfile.rails-head
+    - rvm: jruby-9.1.15.0
+      gemfile: Gemfile
+    - rvm: jruby-9.1.15.0
+      gemfile: gemfiles/Gemfile.rails-4-0
+    - rvm: jruby-9.1.15.0
+      gemfile: gemfiles/Gemfile.rails-4-1
+    - rvm: jruby-9.1.15.0
+      gemfile: gemfiles/Gemfile.rails-4-2
+    - rvm: jruby-9.1.15.0
+      gemfile: gemfiles/Gemfile.rails-5-0
+    - rvm: jruby-9.1.15.0
+      gemfile: gemfiles/Gemfile.rails-5-1
+  exclude:
+    - rvm: 2.3.6
+      gemfile: gemfiles/Gemfile.rails-3-1
+    - rvm: jruby
+      gemfile: gemfiles/Gemfile.rails-3-1
+      env: DB=postgresql
+    - rvm: 2.3.6
+      gemfile: gemfiles/Gemfile.rails-3-2
+    - rvm: 2.4.3
+      gemfile: gemfiles/Gemfile.rails-4-0
+    - rvm: 2.4.3
+      gemfile: gemfiles/Gemfile.rails-4-1
+    - rvm: 2.4.3
+      gemfile: gemfiles/Gemfile.rails-4-2

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in activeuuid.gemspec
+gemspec
+gem "activerecord", "~>5.0"
+gem "rake", "< 11.0"

data/LICENSE.md

@@ -0,0 +1,19 @@
+The MIT License (MIT)
+
+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.mkd

@@ -0,0 +1,167 @@
+[![Build Status](https://travis-ci.org/riboseinc/activeuuid.svg?branch=master)](https://travis-ci.org/riboseinc/activeuuid)
+[![Code Climate Quality](https://codeclimate.com/github/riboseinc/activeuuid/badges/gpa.svg)](https://codeclimate.com/github/riboseinc/activeuuid)
+[![Code Climate Coverage](https://codeclimate.com/github/riboseinc/activeuuid/badges/coverage.svg)](https://codeclimate.com/github/riboseinc/activeuuid/coverage)
+
+# activeuuid
+
+Add `binary(16)` UUIDs to ActiveRecord.
+
+Does not work with recently releaded version 1.0 of `pg` gem (yet).
+
+## 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, :primary_key => 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
+```
+
+### specify a natural key for generating the UUID based on one or more columns
+```ruby
+class Email < ActiveRecord::Base
+  include ActiveUUID::UUID
+  natural_key :sender_id, :received_at
+  belongs_to :sender
+end
+```
+
+`natural_key` generates a SHA1-based UUID in the ISO OID namespace by default. [7]
+
+### specify a custom UUID namespace for the natural key
+```ruby
+class Email < ActiveRecord::Base
+  include ActiveUUID::UUID
+  uuid_namespace "1dd74dd0-d116-11e0-99c7-5ac5d975667e"
+  natural_key :sender_id, :received_at
+  belongs_to :sender
+end
+```
+
+`uuid_namespace` can either be a UUID in string format, or a UUIDTools::UUID object.
+
+### use it:
+Here are some example specs:
+
+```ruby
+require 'spec_helper'
+
+describe Email do
+
+  context "when using uuid's as keys" do
+    let(:guid) { "1dd74dd0-d116-11e0-99c7-5ac5d975667e" }
+    let(:email) { Fabricate :email }
+
+    it "the id guid should be equal to the uuid" do
+      email.id.to_s.should eql(guid)
+    end
+
+    it "should be able to find an email by the uuid" do
+      Email.find(guid).id.to_s.should == 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`
+* 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/inbeom/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
+* [7] http://tools.ietf.org/html/rfc4122.html#appendix-C
+
+## Dependencies
+Rails >= 4.0.0
+
+## Authors
+
+- Nate Murray
+- pyromaniac
+- Andrew Kane
+- Devin Foley
+- Arkadiy Zabazhanov
+- Jean-Denis Koeck
+- Florian Staudacher
+- Schuyler Erle
+- Florian Schwab
+- Thomas Guillory
+- Daniel Blanco Rojas
+- Olivier Amblet
+

data/Rakefile

@@ -0,0 +1,15 @@
+require "bundler/gem_tasks"
+
+require "rspec/core"
+require "rspec/core/rake_task"
+
+module TempFixForRakeLastComment
+  def last_comment
+    last_description
+  end
+end
+Rake::Application.send :include, TempFixForRakeLastComment
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/activeuuid.gemspec

@@ -0,0 +1,40 @@
+# -*- encoding: utf-8 -*-
+
+$:.push File.expand_path("../lib", __FILE__)
+require "activeuuid/version"
+
+Gem::Specification.new do |s|
+  s.name        = "leifcr-activeuuid"
+  s.version     = Activeuuid::VERSION
+  s.authors     = ["Nate Murray"]
+  s.email       = ["nate@natemurray.com"]
+  s.homepage    = "https://github.com/jashmenn/activeuuid"
+  s.summary     = "Add binary UUIDs to ActiveRecord in MySQL"
+  s.description = "Add binary (not string) UUIDs to ActiveRecord in MySQL"
+
+  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 "activesupport"
+  s.add_development_dependency "database_cleaner"
+  s.add_development_dependency "fabrication"
+  s.add_development_dependency "forgery"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec", "~> 3.5.0"
+  s.add_development_dependency "rspec-its"
+
+  if RUBY_ENGINE == "jruby"
+    s.add_development_dependency "activerecord-jdbcmysql-adapter"
+    s.add_development_dependency "activerecord-jdbcpostgresql-adapter"
+    s.add_development_dependency "activerecord-jdbcsqlite3-adapter"
+  else
+    s.add_development_dependency "mysql2"
+    s.add_development_dependency "pg", "< 1.0"
+    s.add_development_dependency "sqlite3"
+  end
+
+  s.add_runtime_dependency "activerecord", ">= 4.0"
+  s.add_runtime_dependency "uuidtools"
+end

data/gemfiles/Gemfile.rails-4-0

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+gemspec path: '../'
+
+gem 'mysql2', '~> 0.3.21', '~> 0.3.21', platforms: [:mri, :rbx]
+gem 'activerecord', '~> 4.0.0'

data/gemfiles/Gemfile.rails-4-1

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+gemspec path: '../'
+
+gem 'mysql2', '~> 0.3.21', platforms: [:mri, :rbx]
+gem 'activerecord', '~> 4.1.0'

data/gemfiles/Gemfile.rails-4-2

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gemspec path: '../'
+
+gem 'activerecord', '~> 4.2.0'

data/gemfiles/Gemfile.rails-5-0

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gemspec path: '../'
+
+gem 'activerecord', '~> 5.0.0'

data/gemfiles/Gemfile.rails-5-1

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gemspec path: '../'
+
+gem 'activerecord', '~> 5.1.0'

data/gemfiles/Gemfile.rails-head

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gemspec path: '../'
+
+gem 'activerecord', github: 'rails/rails'

data/lib/activeuuid/patches.rb

@@ -0,0 +1,226 @@
+require "active_record"
+require "active_support/concern"
+
+if (ActiveRecord::VERSION::MAJOR == 4 && ActiveRecord::VERSION::MINOR == 2) ||
+    (ActiveRecord::VERSION::MAJOR == 5)
+  module ActiveRecord
+    module Type
+      class UUID < Binary # :nodoc:
+        def type
+          :uuid
+        end
+
+        def serialize(value)
+          return if value.nil?
+          UUIDTools::UUID.serialize(value)
+        end
+
+        def cast_value(value)
+          UUIDTools::UUID.serialize(value)
+        end
+
+        def cast(value)
+          cast_value value
+        end
+      end
+    end
+  end
+
+  module ActiveRecord
+    module ConnectionAdapters
+      module PostgreSQL
+        module OID # :nodoc:
+          class Uuid < Type::Value # :nodoc:
+            def type_cast_from_user(value)
+              UUIDTools::UUID.serialize(value) if value
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+module ActiveUUID
+  module Patches
+    module Migrations
+      def uuid(*column_names)
+        options = column_names.extract_options!
+        column_names.each do |name|
+          type = ActiveRecord::Base.connection.adapter_name.casecmp("postgresql").zero? ? "uuid" : "binary(16)"
+          column(name, "#{type}#{' PRIMARY KEY' if options.delete(:primary_key)}", options)
+        end
+      end
+    end
+
+    module Column
+      extend ActiveSupport::Concern
+
+      def self.prepended(_klass)
+        def type_cast(value)
+          return UUIDTools::UUID.serialize(value) if type == :uuid
+          super
+        end
+
+        def type_cast_code(var_name)
+          return "UUIDTools::UUID.serialize(#{var_name})" if type == :uuid
+          super
+        end
+
+        def simplified_type(field_type)
+          return :uuid if field_type == "binary(16)" || field_type == "binary(16,0)"
+          super
+        end
+      end
+    end
+
+    module MysqlJdbcColumn
+      extend ActiveSupport::Concern
+
+      included do
+        # This is a really hacky solution, but it's the only way to support the
+        # MySql JDBC adapter without breaking backwards compatibility.
+        # It would be a lot easier if AR had support for custom defined types.
+        #
+        # Here's the path of execution:
+        # (1) JdbcColumn calls ActiveRecord::ConnectionAdapters::Column super constructor
+        # (2) super constructor calls simplified_type from MysqlJdbcColumn, since it's redefined here
+        # (3) if it's not a uuid, it calls original_simplified_type from ArJdbc::MySQL::Column module
+        # (4)   if there's no match ArJdbc::MySQL::Column calls super (ActiveUUID::Column.simplified_type_with_uuid)
+        # (5)     Since it's no a uuid (see step 3), simplified_type_without_uuid is called,
+        #         which maps to AR::ConnectionAdapters::Column.simplified_type (which has no super call, so we're good)
+        #
+        alias_method :original_simplified_type, :simplified_type
+
+        def simplified_type(field_type)
+          return :uuid if field_type == "binary(16)" || field_type == "binary(16,0)"
+          original_simplified_type(field_type)
+        end
+      end
+    end
+
+    module PostgreSQLColumn
+      extend ActiveSupport::Concern
+
+      def self.prepended(_klass)
+        def type_cast(value)
+          return UUIDTools::UUID.serialize(value) if type == :uuid
+          super
+        end
+
+        def simplified_type(field_type)
+          return :uuid if field_type == "uuid"
+          super
+        end
+      end
+    end
+
+    module Quoting
+      extend ActiveSupport::Concern
+
+      def self.prepended(_klass)
+        def quote(value, column = nil)
+          value = UUIDTools::UUID.serialize(value) if column&.type == :uuid
+          case method(__method__).super_method.arity
+          when 1 then super(value)
+          else super
+          end
+        end
+
+        def type_cast(value, column = nil)
+          value = UUIDTools::UUID.serialize(value) if column&.type == :uuid
+          super
+        end
+
+        def native_database_types
+          super.merge(uuid: { name: "binary", limit: 16 })
+        end
+      end
+    end
+
+    module PostgreSQLQuoting
+      extend ActiveSupport::Concern
+
+      def self.prepended(_klass)
+        def quote(value, column = nil)
+          value = UUIDTools::UUID.serialize(value) if column&.type == :uuid
+          value = value.to_s if value.is_a? UUIDTools::UUID
+          case method(__method__).super_method.arity
+          when 1 then super(value)
+          else super
+          end
+        end
+
+        def type_cast(value, column = nil, *args)
+          value = UUIDTools::UUID.serialize(value) if column&.type == :uuid
+          value = value.to_s if value.is_a? UUIDTools::UUID
+          super
+        end
+
+        def native_database_types
+          super.merge(uuid: { name: "uuid" })
+        end
+      end
+    end
+
+    module PostgresqlTypeOverride
+      def deserialize(value)
+        UUIDTools::UUID.serialize(value) if value
+      end
+
+      alias_method :cast, :deserialize
+    end
+
+    module TypeMapOverride
+      def initialize_type_map(m)
+        super
+
+        register_class_with_limit m, /binary\(16(,0)?\)/i, ::ActiveRecord::Type::UUID
+      end
+    end
+
+    module MysqlTypeToSqlOverride
+      def type_to_sql(*args)
+        args.first.to_s == "uuid" ? "binary(16)" : super
+      end
+    end
+
+    module ConnectionHandling
+      def establish_connection(_ = nil)
+        super
+
+        aca = ActiveRecord::ConnectionAdapters
+
+        aca::Table.send           :include, Migrations if defined? aca::Table
+        aca::TableDefinition.send :include, Migrations if defined? aca::TableDefinition
+
+        if ActiveRecord::VERSION::MAJOR >= 5
+          if defined? aca::AbstractMysqlAdapter
+            aca::AbstractMysqlAdapter.prepend TypeMapOverride
+            aca::AbstractMysqlAdapter.prepend MysqlTypeToSqlOverride
+          end
+
+          aca::SQLite3Adapter.prepend        TypeMapOverride        if defined? aca::SQLite3Adapter
+          aca::PostgreSQL::OID::Uuid.prepend PostgresqlTypeOverride if defined? aca::PostgreSQLAdapter
+
+        elsif ActiveRecord::VERSION::MAJOR == 4 && ActiveRecord::VERSION::MINOR == 2
+          aca::Mysql2Adapter.prepend  TypeMapOverride if defined? aca::Mysql2Adapter
+          aca::SQLite3Adapter.prepend TypeMapOverride if defined? aca::SQLite3Adapter
+
+        else
+          aca::Column.send           :prepend, Column
+          aca::PostgreSQLColumn.send :prepend, PostgreSQLColumn if defined? aca::PostgreSQLColumn
+        end
+
+        aca::MysqlAdapter.send      :prepend, Quoting           if defined? aca::MysqlAdapter
+        aca::Mysql2Adapter.send     :prepend, Quoting           if defined? aca::Mysql2Adapter
+        aca::SQLite3Adapter.send    :prepend, Quoting           if defined? aca::SQLite3Adapter
+        aca::PostgreSQLAdapter.send :prepend, PostgreSQLQuoting if defined? aca::PostgreSQLAdapter
+      end
+    end
+
+    def self.apply!
+      ActiveRecord::Base.singleton_class.prepend ConnectionHandling
+    end
+  end
+end

data/lib/activeuuid/railtie.rb

@@ -0,0 +1,12 @@
+require "activeuuid"
+require "rails"
+
+module ActiveUUID
+  class Railtie < Rails::Railtie
+    railtie_name :activeuuid
+
+    config.to_prepare do
+      ActiveUUID::Patches.apply!
+    end
+  end
+end