rails-bigint-pk 0.0.2

data/.gitignore

@@ -0,0 +1,8 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+/tmp
+/tags
+/gems.tags
+/bin

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--debugger

data/.rvmrc

@@ -0,0 +1 @@
+rvm --create 1.9.3

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - "1.9.3"

data/.vim/snippets/rspec.snippets

@@ -0,0 +1,4 @@
+snippet t
+	they '${1}' do
+		${2}
+	end

data/.vimrc

@@ -0,0 +1,2 @@
+set wildignore+=**/tmp/**
+set tags+=./gems.tags

data/Changelog

@@ -0,0 +1,11 @@
+## 0.0.2	(19 February 2013)
+
+Bug Fixes:
+
+	- `references` uses 64bit keys for `change_table` now.
+	- work with polymorphic associations (@Bishop, #12)
+	
+
+## 0.0.1 	(19 November 2012)
+
+Initial version.

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,20 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', cli: '--tag ~integration' do
+  watch('spec/spec_helper.rb'){ 'spec' }
+  watch(%r{spec/support/*}){ 'spec' }
+  watch(%r{^spec/(?!integration/).+_spec\.rb})
+
+  watch(%r{^lib/bigint_pk\.rb}){ 'spec/monkey_patch/connection_adapters_spec.rb' }
+end
+
+guard 'bundler' do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end
+
+guard 'ctags-bundler', :src_path => ["lib", "spec/support"] do
+  watch(/^(app|lib|spec\/support)\/.*\.rb$/)
+  watch('Gemfile.lock')
+end

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2012 VerticalResponse Inc.
+
+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/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new :spec
+
+task default: :spec

data/Readme.md

@@ -0,0 +1,61 @@
+## rails-bigint-pk [![Build Status](https://secure.travis-ci.org/VerticalResponse/rails-bigint-pk.png?branch=master)](https://travis-ci.org/VerticalResponse/rails-bigint-pk)
+
+### Overview
+
+rails-bigint-pk aims to be a simple, transparent way to use 64bit primary keys
+in mysql and postgres.
+
+### Requirements
+
+rails-bigint-pk has been tested with rails 3.2.12, which at the time of writing
+is the latest patch version for 3.2.  If you use a higher patch version, it is
+recommended to run the test suite against your version of rails and activerecord.
+
+### Installation & Usage
+
+* Add the following to your `Gemfile`
+  `gem 'rails-bigint-pk', git: 'https://github.com/VerticalResponse/rails-bigint-pk.git'`
+
+* Run the generator
+  `rails generate bigint_pk:install`
+
+This will create an initializer that enables 64 bit primary and foreign keys by
+changing the default primary key type, and using `limit: 8` for foreign keys
+created via `references`.
+
+It will also create a migration to update all existing primary and foreign keys.
+
+
+### Gotchas
+
+When adding foreign key columns, be sure to use `references` and not
+`add_column`.
+
+```ruby
+change_table :my_table do |t|
+  t.references :other_table
+end
+
+# Doing this will not use 64bit ints
+add_column :my_table, :other_table_id, :int
+```
+
+
+### Running Tests Against Later Versions of Rails
+
+```bash
+git clone git://github.com/VerticalResponse/rails-bigint-pk.git
+cd rails-bigint-pk
+
+# edit rails-bigint-pk.gemspec or Gemfile to set the version of activerecord to
+# the one you are using
+
+bundle install
+
+# verify that Gemfile.lock's entry for activerecord matches the version you want
+# to test against.
+
+# This will run integration specs against all supported database types, and
+# requires running servers for postgres and mysql.
+rake spec
+```

data/lib/bigint_pk.rb

@@ -0,0 +1,92 @@
+require 'active_support/all'
+require 'bigint_pk/version'
+
+module BigintPk
+  mattr_accessor :enabled
+
+  autoload :Generators, 'generators/bigint_pk'
+
+  def self.setup
+    yield self
+  end
+
+  def self.enabled= value
+    install_patches! if value
+  end
+
+
+  def self.update_primary_key table_name, key_name
+    update_key table_name, key_name, true
+  end
+
+  def self.update_foreign_key table_name, key_name
+    update_key table_name, key_name, false
+  end
+
+  private
+
+  def self.install_patches!
+    install_primary_key_patches!
+    install_foreign_key_patches!
+  end
+
+  def self.install_primary_key_patches!
+    ActiveRecord::Base.establish_connection
+    ca = ActiveRecord::ConnectionAdapters
+
+    if ca.const_defined? :PostgreSQLAdapter
+      ca::PostgreSQLAdapter::NATIVE_DATABASE_TYPES[:primary_key] = 'bigserial primary key'
+    end
+
+    if ca.const_defined? :AbstractMysqlAdapter
+      ca::AbstractMysqlAdapter::NATIVE_DATABASE_TYPES[:primary_key] = 
+        'bigint(20) DEFAULT NULL auto_increment PRIMARY KEY'
+    end
+  end
+
+  def self.install_foreign_key_patches!
+    [   ActiveRecord::ConnectionAdapters::TableDefinition,
+        ActiveRecord::ConnectionAdapters::Table].each do |abstract_table_type|
+
+      abstract_table_type.class_eval do
+        def references_with_default_bigint_fk *args
+          options = args.extract_options!
+          options.reverse_merge! limit: 8
+          # Limit shouldn't affect "#{col}_type" column in polymorphic reference.
+          # But don't change value if it isn't simple 'true'.
+          # Examples:
+          #   t.references :subject, null: false, polymorphic: true ==> t.integer :subject_id, limit: 8, null: false
+          #                                                             t.string  :subject_type, null: false
+          #   t.references :subject, polymorphic: { limit: 120 }    ==> t.integer :subject_id, limit: 8
+          #                                                             t.string  :subject_type, limit: 120
+          options[:polymorphic] = options.except(:polymorphic, :limit) if options[:polymorphic] == true 
+          references_without_default_bigint_fk( *args, options )
+        end
+        alias_method_chain :references, :default_bigint_fk
+      end
+    end
+  end
+
+
+  def self.update_key table_name, key_name, is_primary_key
+    c = ActiveRecord::Base.connection
+    case c.adapter_name
+    when 'PostgreSQL'
+      c.execute %Q{
+        ALTER TABLE #{c.quote_table_name table_name}
+        ALTER COLUMN #{c.quote_column_name key_name}
+        TYPE bigint
+      }.gsub(/\s+/, ' ').strip
+    when /^MySQL/i
+      c.execute %Q{
+        ALTER TABLE #{c.quote_table_name table_name}
+        MODIFY COLUMN #{c.quote_column_name key_name}
+        bigint(20) DEFAULT NULL #{'auto_increment' if is_primary_key}
+      }.gsub(/\s+/, ' ').strip
+    when 'SQLite'
+      # noop; sqlite always has 64bit pkeys
+    else
+      raise "Unsupported adapter '#{c.adapter_name}'"
+    end
+  end
+end

data/lib/bigint_pk/version.rb

@@ -0,0 +1,3 @@
+module BigintPk
+  VERSION = "0.0.2"
+end

data/lib/generators/bigint_pk.rb

@@ -0,0 +1,5 @@
+module BigintPk
+  module Generators
+    autoload :InstallGenerator, 'generators/bigint_pk/install_generator'
+  end
+end

data/lib/generators/bigint_pk/install_generator.rb

@@ -0,0 +1,21 @@
+require 'rails/generators'
+
+module BigintPk
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path '../templates', __FILE__
+
+      desc 'Creates BigintPk initializer'
+
+
+      def create_initializer_file
+        template 'bigint_pk.rb', 'config/initializers/bigint_pk.rb'
+      end
+
+      def create_migration
+        version = Time.now.utc.strftime '%Y%m%d%H%M%S'
+        template "migration.rb", "db/migrate/#{version}_change_keys_to_bigint.rb"
+      end
+    end
+  end
+end

data/lib/generators/bigint_pk/templates/bigint_pk.rb

@@ -0,0 +1,9 @@
+require 'bigint_pk'
+
+BigintPk.setup do |config|
+  # Remove this line or set config.enabled to false to prevent future migrations
+  # from defaulting to 64bit ints.  This does not affect the initial migration
+  # created during installation.
+  #
+  config.enabled = true
+end

data/lib/generators/bigint_pk/templates/migration.rb

@@ -0,0 +1,20 @@
+# This file is auto-generated when running `rails generate bigint_pk:install`
+# by the gem rails-bigint-pk (https://github.com/VerticalResponse/rails-bigint-pk).
+
+class ChangeKeysToBigint < ActiveRecord::Migration
+  def change
+    Rails.application.eager_load!
+    ActiveRecord::Base.subclasses.select do |type|
+      connection.table_exists? type.table_name
+    end.each do |type|
+      BigintPk.update_primary_key type.table_name, type.primary_key
+
+      type.reflect_on_all_associations.select do |association|
+        ( association.macro == :belongs_to ) &&
+          connection.column_exists?( type.table_name, association.foreign_key )
+      end.each do |belongs_to_association|
+        BigintPk.update_foreign_key type.table_name, belongs_to_association.foreign_key
+      end
+    end
+  end
+end

data/rails-bigint-pk.gemspec

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "bigint_pk/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rails-bigint-pk"
+  s.version     = BigintPk::VERSION
+  s.authors     = ["David J. Hamilton"]
+  s.email       = ["dhamilton@verticalresponse.com"]
+  s.homepage    = "https://github.com/VerticalResponse/rails-bigint-pk"
+  s.summary     = %q{Easily use 64-bit primary keys in rails}
+  s.description = %q{Easily use 64-bit primary keys in rails.}
+
+  s.rubyforge_project = "rails-bigint-pk"
+
+  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_runtime_dependency "activerecord", '~> 3.2.0'
+  s.add_runtime_dependency "railties", '~> 3.2.0'
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "travis-lint"
+  s.add_development_dependency "rails"
+  s.add_development_dependency "debugger"
+  s.add_development_dependency "mysql2", '~> 0.3.10'
+  s.add_development_dependency "mysql", '~> 2.8.1'
+  s.add_development_dependency "pg", '~> 0.11'
+  s.add_development_dependency "sqlite3", '~> 1.3.6'
+  s.add_development_dependency "guard"
+  s.add_development_dependency "guard-rspec"
+  s.add_development_dependency "guard-bundler"
+  s.add_development_dependency "guard-ctags-bundler"
+  s.add_development_dependency "rb-fsevent"
+end

data/spec/fixtures/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'rails', '3.2.8'
+
+gem 'pg', '~> 0.11'
+gem 'mysql', '~> 2.8.1'
+gem 'mysql2', '~> 0.3.10'
+gem 'sqlite3', '~> 1.3.6'

data/spec/fixtures/mysql_database.yml

@@ -0,0 +1,13 @@
+common: &common
+  database: test_rails_app
+  adapter: mysql2
+  encoding: utf8
+  reconnect: false
+  pool: 5
+  host: localhost
+
+development:
+  <<: *common
+
+test:
+  <<: *common

data/spec/fixtures/postgresql_database.yml

@@ -0,0 +1,12 @@
+common: &common
+  adapter: postgresql
+  database: test_rails_app
+  username: postgres
+  password: 
+  host: localhost
+
+development:
+  <<: *common
+
+test:
+  <<: *common

data/spec/fixtures/sqlite3_database.yml

@@ -0,0 +1,11 @@
+common: &common
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *common
+
+test:
+  <<: *common

data/spec/fixtures/test_rails_app/app/models/empire.rb

@@ -0,0 +1,2 @@
+class Empire < ActiveRecord::Base
+end

data/spec/fixtures/test_rails_app/app/models/ruler.rb

@@ -0,0 +1,4 @@
+class Ruler < ActiveRecord::Base
+  belongs_to :empire
+  has_one :favourite_ruler, class_name: :Ruler
+end

data/spec/fixtures/test_rails_app/db/migrate/19000101100000_create_empires_and_rulers.rb

@@ -0,0 +1,10 @@
+class CreateEmpiresAndRulers < ActiveRecord::Migration
+  def change
+    create_table :empires do |t|
+    end
+
+    create_table :rulers do |t|
+      t.references :empire
+    end
+  end
+end

data/spec/fixtures/test_rails_app/db/migrate/19000102100000_update_rulers_add_favourite_ruler.rb

@@ -0,0 +1,7 @@
+class UpdateRulersAddFavouriteRuler < ActiveRecord::Migration
+  def change
+    change_table :rulers do |t|
+      t.references :favourite_ruler
+    end
+  end
+end

data/spec/integration/generator_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe BigintPk::Generators::InstallGenerator, :integration do
+  before do
+    in_directory( RailsDir ) do
+      run 'rails generate bigint_pk:install' do |stdout, stderr|
+        expect( stdout.read ).to_not include 'Could not find generator'
+      end
+    end
+  end
+
+  it 'creates a bigint_pk initializer' do
+    expect( File.exists? "#{RailsDir}/config/initializers/bigint_pk.rb").to be_true
+  end
+
+  it 'creates a bigint_pk migration' do
+    expect( Dir["#{RailsDir}/db/migrate/*change_keys_to_bigint.rb"].size ).to eq 1
+  end
+
+  context "when migrations are created after bigint-pk is installed" do
+    before do
+      in_directory ( RailsDir ) do
+        run 'rails g migration test_migration_after'
+        run 'rails g bigint_pk:install'
+      end
+    end
+
+    it "creates migration files in the correct order" do
+      Dir["#{RailsDir}/db/migrate/*rb"].sort.map do |migration_file|
+        File.basename( migration_file ).gsub(/^\d+_/, '')
+      end.should == %w[
+        create_empires_and_rulers.rb
+        update_rulers_add_favourite_ruler.rb
+        change_keys_to_bigint.rb
+        test_migration_after.rb
+        change_keys_to_bigint.rb
+      ]
+    end
+  end
+end