brianjlandau-foreigner 0.7.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Matthew Higgins, Brian Landau
+
+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

@@ -0,0 +1,103 @@
+Foreigner
+=========
+
+Rails does not come with methods to add foreign keys. Foreigner introduces a few
+methods to your migrations for adding and removing foreign key constraints.
+
+Since each adapter implements the API, migrations using Foreigner will continue to
+work on databases that do not support foreign keys, such as sqlite3.
+
+Installation
+------------
+
+Install as a plugin:
+
+  ruby script/plugin install git://github.com/brianjlandau/foreigner.git
+
+In Rails 2, install as a gem by adding the following to config/environment.rb:
+
+  config.gem "brianjlandau-foreigner", :lib => "foreigner"
+
+In Rails 3, install as a gem by adding the following to your Gemfile:
+
+  gem 'brianjlandau-foreigner', :require => 'foreigner'
+
+API
+---
+
+An adapter implementing the Foreigner API implements three methods.
+(Options are documented in connection_adapters/abstract/schema_definitions.rb):
+
+  add_foreign_key(from_table, to_table, options)
+  remove_foreign_key(from_table, options)
+  foreign_keys(table_name)
+
+Example
+-------
+
+The most common use of foreign keys is to reference a table that a model belongs to.
+For example, given the following model:
+
+  class Comment < ActiveRecord::Base
+    belongs_to :post
+  end
+  
+  class Post < ActiveRecord::Base
+    has_many :comments, :dependent => :delete_all
+  end
+  
+You should add a foreign key in your migration:
+
+  add_foreign_key(:comments, :posts)
+
+The :dependent option can be moved from the has_many definition to the foreign key:
+
+  add_foreign_key(:comments, :posts, :dependent => :delete)
+
+If the column is named article_id instead of post_id, use the :column option:
+
+  add_foreign_key(:comments, :posts, :column => 'article_id')
+  
+Lastly, a name can be specified for the foreign key constraint:
+
+  add_foreign_key(:comments, :posts, :name => 'comment_article_foreign_key')
+
+Create/Change Table Shorthand
+-----------------------------
+
+Foreigner adds extra behavior to change_table, which lets you define foreign keys using shorthand.
+
+Add a missing foreign key to comments:
+
+change_table :comments do |t|
+  t.foreign_key :posts, :dependent => :delete
+end
+
+t.foreign_key accepts the same options as add_foreign_key.
+
+
+Additional t.references option
+------------------------------
+
+Foreigner extends table.references with the :foreign_key option. Pass true, and the default
+foreign key options are used:
+
+change_table :comments do |t|
+  t.references :post, :foreign_key => true
+end
+
+An options hash can also be passed. It accepts the same options as add_foreign_key:
+
+change_table :comments do |t|
+  t.references :author, :foreign_key => {:dependent => :destroy}
+end
+
+By default, t.references will not generate a foreign key.
+
+schema.rb
+---------
+
+Similar to indexes, the foreign keys in your database are automatically dumped to schema.rb.
+This allows you to use foreign keys without switching to the :sql schema.
+
+Copyright (c) 2009 Matthew Higgins, Brian Landau, released under the MIT license

data/Rakefile

@@ -0,0 +1,39 @@
+begin
+  require 'jeweler'
+
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "brianjlandau-foreigner"
+    gemspec.summary = "Foreign keys for Rails"
+    gemspec.description = "Adds helpers to migrations and correctly dumps foreign keys to schema.rb"
+    gemspec.email = "brianjlandau@gmail.com"
+    gemspec.homepage = "http://github.com/brianjlandau/foreigner"
+    gemspec.authors = ["Matthew Higgins", "Brian Landau"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available."
+  puts "Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the foreigner plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the foreigner plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Foreigner'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.7.0

data/brianjlandau-foreigner.gemspec

@@ -0,0 +1,58 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{brianjlandau-foreigner}
+  s.version = "0.7.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Matthew Higgins", "Brian Landau"]
+  s.date = %q{2010-06-23}
+  s.description = %q{Adds helpers to migrations and correctly dumps foreign keys to schema.rb}
+  s.email = %q{brianjlandau@gmail.com}
+  s.extra_rdoc_files = [
+    "README"
+  ]
+  s.files = [
+    "MIT-LICENSE",
+     "README",
+     "Rakefile",
+     "VERSION",
+     "brianjlandau-foreigner.gemspec",
+     "init.rb",
+     "install.rb",
+     "lib/foreigner.rb",
+     "lib/foreigner/connection_adapters/abstract/schema_definitions.rb",
+     "lib/foreigner/connection_adapters/abstract/schema_statements.rb",
+     "lib/foreigner/connection_adapters/mysql_adapter.rb",
+     "lib/foreigner/connection_adapters/postgresql_adapter.rb",
+     "lib/foreigner/connection_adapters/sql_2003.rb",
+     "lib/foreigner/schema_dumper.rb",
+     "tasks/foreigner_tasks.rake",
+     "test/helper.rb",
+     "test/mysql_adapter_test.rb",
+     "uninstall.rb"
+  ]
+  s.homepage = %q{http://github.com/brianjlandau/foreigner}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Foreign keys for Rails}
+  s.test_files = [
+    "test/helper.rb",
+     "test/mysql_adapter_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/init.rb

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

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/foreigner/connection_adapters/abstract/schema_definitions.rb

@@ -0,0 +1,112 @@
+module Foreigner
+  module ConnectionAdapters
+    class ForeignKeyDefinition < Struct.new(:from_table, :to_table, :options) #:nodoc:
+    end
+    
+    module SchemaDefinitions
+      def self.included(base)
+        base::TableDefinition.class_eval do
+          include Foreigner::ConnectionAdapters::TableDefinition
+        end
+        
+        base::Table.class_eval do
+          include Foreigner::ConnectionAdapters::Table
+        end
+      end
+    end
+  
+    module TableDefinition
+      def self.included(base)
+        base.class_eval do
+          include InstanceMethods
+          alias_method_chain :references, :foreign_keys
+        end
+      end
+    
+      module InstanceMethods
+        def references_with_foreign_keys(*args)
+          options = args.extract_options!
+          if options[:foreign_key].present?
+            ActiveSupport::Deprecation.warn(
+              ':foreign_key option is deprecated inside create_table. ' +
+              'to add a foreign key, use add_foreign_key', caller[0,10]
+            )
+          end
+
+          references_without_foreign_keys(*(args << options))
+        end
+    
+        def foreign_key(to_table, options = {})
+          ActiveSupport::Deprecation.warn(
+            'adding a foreign key inside create_table is deprecated. ' +
+            'to add a foreign key, use add_foreign_key', caller[0,10]
+          )
+        end
+      end
+    end
+
+    module Table
+      def self.included(base)
+        base.class_eval do
+          include InstanceMethods
+          alias_method_chain :references, :foreign_keys
+        end
+      end
+
+      module InstanceMethods
+        # Adds a new foreign key to the table. +to_table+ can be a single Symbol, or
+        # an Array of Symbols. See SchemaStatements#add_foreign_key
+        #
+        # ===== Examples
+        # ====== Creating a simple foreign key
+        #  t.foreign_key(:people)
+        # ====== Defining the column
+        #  t.foreign_key(:people, :column => :sender_id)
+        # ====== Creating a named foreign key
+        #  t.foreign_key(:people, :column => :sender_id, :name => 'sender_foreign_key')
+        # ====== Defining the column of the +to_table+.
+        #  t.foreign_key(:people, :column => :sender_id, :primary_key => :person_id)
+        def foreign_key(to_table, options = {})
+          @base.add_foreign_key(@table_name, to_table, options)
+        end
+    
+        # Remove the given foreign key from the table.
+        #
+        # ===== Examples
+        # ====== Remove the suppliers_company_id_fk in the suppliers table.
+        #   t.remove_foreign_key :companies
+        # ====== Remove the foreign key named accounts_branch_id_fk in the accounts table.
+        #   remove_foreign_key :column => :branch_id
+        # ====== Remove the foreign key named party_foreign_key in the accounts table.
+        #   remove_index :name => :party_foreign_key
+        def remove_foreign_key(options = {})
+          @base.remove_foreign_key(@table_name, options)
+        end
+      
+        # Adds a :foreign_key option to TableDefinition.references.
+        # If :foreign_key is true, a foreign key constraint is added to the table.
+        # You can also specify a hash, which is passed as foreign key options.
+        # 
+        # ===== Examples
+        # ====== Add goat_id column and a foreign key to the goats table.
+        #  t.references(:goat, :foreign_key => true)
+        # ====== Add goat_id column and a cascading foreign key to the goats table.
+        #  t.references(:goat, :foreign_key => {:dependent => :delete})
+        # 
+        # Note: No foreign key is created if :polymorphic => true is used.
+        def references_with_foreign_keys(*args)
+          options = args.extract_options!
+          polymorphic = options[:polymorphic]
+          fk_options = options.delete(:foreign_key)
+
+          references_without_foreign_keys(*(args.dup << options))
+
+          if fk_options && !polymorphic
+            fk_options = {} if fk_options == true
+            args.each { |to_table| foreign_key(to_table, fk_options) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/foreigner/connection_adapters/abstract/schema_statements.rb

@@ -0,0 +1,75 @@
+module Foreigner
+  module ConnectionAdapters
+    module SchemaStatements
+      def self.included(base)
+        base::AbstractAdapter.class_eval do
+          include Foreigner::ConnectionAdapters::AbstractAdapter
+        end
+      end
+    end
+    
+    module AbstractAdapter
+      def supports_foreign_keys?
+        false
+      end
+
+      # Adds a new foreign key to the +from_table+, referencing the primary key of +to_table+
+      #
+      # The foreign key will be named after the from and to tables unless you pass
+      # <tt>:name</tt> as an option.
+      #
+      # ===== Examples
+      # ====== Creating a foreign key
+      #  add_foreign_key(:comments, :posts)
+      # generates
+      #  ALTER TABLE `comments` ADD CONSTRAINT
+      #     `comments_post_id_fk` FOREIGN KEY (`post_id`) REFERENCES `posts` (`id`)
+      # 
+      # ====== Creating a named foreign key
+      #  add_foreign_key(:comments, :posts, :name => 'comments_belongs_to_posts')
+      # generates
+      #  ALTER TABLE `comments` ADD CONSTRAINT
+      #     `comments_belongs_to_posts` FOREIGN KEY (`post_id`) REFERENCES `posts` (`id`)
+      # 
+      # ====== Creating a cascading foreign_key on a custom column
+      #  add_foreign_key(:people, :people, :column => 'best_friend_id', :dependent => :nullify)
+      # generates
+      #  ALTER TABLE `people` ADD CONSTRAINT
+      #     `people_best_friend_id_fk` FOREIGN KEY (`best_friend_id`) REFERENCES `people` (`id`)
+      #     ON DELETE SET NULL
+      # 
+      # === Supported options
+      # [:column]
+      #   Specify the column name on the from_table that references the to_table. By default this is guessed
+      #   to be the singular name of the to_table with "_id" suffixed. So a to_table of :posts will use "post_id"
+      #   as the default <tt>:column</tt>.
+      # [:primary_key]
+      #   Specify the column name on the to_table that is referenced by this foreign key. By default this is
+      #   assumed to be "id".
+      # [:name]
+      #   Specify the name of the foreign key constraint. This defaults to use from_table and foreign key column.
+      # [:dependent]
+      #   If set to <tt>:delete</tt>, the associated records in from_table are deleted when records in to_table table are deleted.
+      #   If set to <tt>:nullify</tt>, the foreign key column is set to +NULL+.
+      def add_foreign_key(from_table, to_table, options = {})
+      end
+
+      # Remove the given foreign key from the table.
+      #
+      # ===== Examples
+      # ====== Remove the suppliers_company_id_fk in the suppliers table.
+      #   remove_foreign_key :suppliers, :companies
+      # ====== Remove the foreign key named accounts_branch_id_fk in the accounts table.
+      #   remove_foreign_key :accounts, :column => :branch_id
+      # ====== Remove the foreign key named party_foreign_key in the accounts table.
+      #   remove_foreign_key :accounts, :name => :party_foreign_key
+      def remove_foreign_key(from_table, options)
+      end
+
+      # Return the foreign keys for the schema_dumper
+      def foreign_keys(table_name)
+        []
+      end
+    end
+  end
+end

data/lib/foreigner/connection_adapters/mysql_adapter.rb

@@ -0,0 +1,67 @@
+module Foreigner
+  module ConnectionAdapters
+    module MysqlAdapter
+      include Foreigner::ConnectionAdapters::Sql2003
+      
+      def remove_foreign_key(table, options)
+        if Hash === options
+          foreign_key_name = foreign_key_name(table, options[:column], options)
+        else
+          foreign_key_name = foreign_key_name(table, "#{options.to_s.gsub(/^\w+\./, '').singularize}_id")
+        end
+
+        execute "ALTER TABLE #{quote_table_name(table)} DROP FOREIGN KEY #{quote_column_name(foreign_key_name)}"
+      end
+      
+      def foreign_keys(table_name)
+        fk_info = select_all %{
+          SELECT fk.referenced_table_name as 'to_table'
+                ,fk.referenced_table_schema as 'to_database'
+                ,fk.referenced_column_name as 'primary_key'
+                ,fk.column_name as 'column'
+                ,fk.constraint_name as 'name'
+          FROM information_schema.key_column_usage fk
+          WHERE fk.referenced_column_name is not null
+            AND fk.table_schema = '#{@config[:database]}'
+            AND fk.table_name = '#{table_name}'
+        }
+
+        create_table_info = select_one("SHOW CREATE TABLE #{quote_table_name(table_name)}")["Create Table"]
+
+        fk_info.map do |row|
+          options = {:column => row['column'], :name => row['name'], :primary_key => row['primary_key']}
+
+          if create_table_info =~ /CONSTRAINT #{quote_column_name(row['name'])} FOREIGN KEY .* REFERENCES .* ON DELETE (CASCADE|SET NULL)/
+            if $1 == 'CASCADE'
+              options[:dependent] = :delete
+            elsif $1 == 'SET NULL'
+              options[:dependent] = :nullify
+            end
+          end
+          
+          if row['to_database'] != @config[:database]
+            options[:database] = row['to_database']
+          end
+          
+          ForeignKeyDefinition.new(table_name, row['to_table'], options)
+        end
+      end
+    end
+  end
+end
+
+module ActiveRecord
+  module ConnectionAdapters
+    if defined? MysqlAdapter
+      MysqlAdapter.class_eval do
+        include Foreigner::ConnectionAdapters::MysqlAdapter
+      end
+    end
+
+    if defined? JdbcAdapter
+      JdbcAdapter.class_eval do
+        include Foreigner::ConnectionAdapters::MysqlAdapter
+      end
+    end
+  end
+end

data/lib/foreigner/connection_adapters/postgresql_adapter.rb

@@ -0,0 +1,64 @@
+module Foreigner
+  module ConnectionAdapters
+    module PostgreSQLAdapter
+      include Foreigner::ConnectionAdapters::Sql2003
+
+      def remove_foreign_key(table, options)
+        if Hash === options
+          foreign_key_name = foreign_key_name(table, options[:column], options)
+        else
+          foreign_key_name = foreign_key_name(table, "#{options.to_s.gsub(/^\w+\./, '').singularize}_id")
+        end
+
+        execute "ALTER TABLE #{quote_table_name(table)} DROP CONSTRAINT #{quote_column_name(foreign_key_name)}"
+      end
+      
+      def foreign_keys(table_name)
+        fk_info = select_all %{
+          SELECT tc.constraint_name as name
+                ,ccu.table_name as to_table
+                ,ccu.column_name as primary_key
+                ,kcu.column_name as column
+                ,rc.delete_rule as dependency
+          FROM information_schema.table_constraints tc
+          JOIN information_schema.key_column_usage kcu
+          USING (constraint_catalog, constraint_schema, constraint_name)
+          JOIN information_schema.referential_constraints rc
+          USING (constraint_catalog, constraint_schema, constraint_name)
+          JOIN information_schema.constraint_column_usage ccu
+          USING (constraint_catalog, constraint_schema, constraint_name)
+          WHERE tc.constraint_type = 'FOREIGN KEY'
+            AND tc.constraint_catalog = '#{@config[:database]}'
+            AND tc.table_name = '#{table_name}'
+        }
+        
+        fk_info.map do |row|
+          options = {:column => row['column'], :name => row['name'], :primary_key => row['primary_key']}
+
+          if row['dependency'] == 'CASCADE'
+            options[:dependent] = :delete
+          elsif row['dependency'] == 'SET NULL'
+            options[:dependent] = :nullify
+          end
+          ForeignKeyDefinition.new(table_name, row['to_table'], options)
+        end
+      end
+    end
+  end
+end
+
+module ActiveRecord
+  module ConnectionAdapters
+    if defined? PostgreSQLAdapter
+      PostgreSQLAdapter.class_eval do
+        include Foreigner::ConnectionAdapters::PostgreSQLAdapter
+      end
+    end
+
+    if defined? JdbcAdapter
+      JdbcAdapter.class_eval do
+        include Foreigner::ConnectionAdapters::PostgreSQLAdapter
+      end
+    end
+  end
+end

data/lib/foreigner/connection_adapters/sql_2003.rb

@@ -0,0 +1,42 @@
+module Foreigner
+  module ConnectionAdapters
+    module Sql2003
+      def supports_foreign_keys?
+        true
+      end
+    
+      def add_foreign_key(from_table, to_table, options = {})
+        column  = options[:column] || "#{to_table.to_s.singularize}_id"
+        foreign_key_name = foreign_key_name(from_table, column, options)
+        primary_key = options[:primary_key] || "id"
+        dependency = dependency_sql(options[:dependent])
+
+        sql =
+          "ALTER TABLE #{quote_table_name(from_table)} " +
+          "ADD CONSTRAINT #{quote_column_name(foreign_key_name)} " +
+          "FOREIGN KEY (#{quote_column_name(column)}) " +
+          "REFERENCES #{quote_table_name(ActiveRecord::Migrator.proper_table_name(to_table))}(#{primary_key})"
+        sql << " #{dependency}" if dependency.present?
+      
+        execute(sql)
+      end
+
+      private
+        def foreign_key_name(table, column, options = {})
+          if options[:name]
+            options[:name]
+          else
+            "#{table}_#{column}_fk"
+          end
+        end
+
+        def dependency_sql(dependency)
+          case dependency
+            when :nullify then "ON DELETE SET NULL"
+            when :delete  then "ON DELETE CASCADE"
+            else ""
+          end
+        end
+    end
+  end
+end

data/lib/foreigner/schema_dumper.rb

@@ -0,0 +1,49 @@
+module Foreigner
+  module SchemaDumper
+    def self.included(base)
+      base.class_eval do
+        include InstanceMethods
+        alias_method_chain :tables, :foreign_keys
+      end
+    end
+    
+    module InstanceMethods
+      def tables_with_foreign_keys(stream)
+        tables_without_foreign_keys(stream)
+        @connection.tables.sort.each do |table|
+          foreign_keys(table, stream)
+        end
+      end
+      
+      private
+        def foreign_keys(table_name, stream)
+          if (foreign_keys = @connection.foreign_keys(table_name)).any?
+            add_foreign_key_statements = foreign_keys.map do |foreign_key|
+              statement_parts = [ ('add_foreign_key ' + foreign_key.from_table.inspect) ]
+              if options[:database].present?
+                statement_parts << %Q["#{options[:database]}.#{foreign_key.to_table.to_s}"]
+              else
+                statement_parts << foreign_key.to_table.inspect
+              end
+              statement_parts << (':name => ' + foreign_key.options[:name].inspect)
+              
+              if foreign_key.options[:column] != "#{foreign_key.to_table.singularize}_id"
+                statement_parts << (':column => ' + foreign_key.options[:column].inspect)
+              end
+              if foreign_key.options[:primary_key] != 'id'
+                statement_parts << (':primary_key => ' + foreign_key.options[:primary_key].inspect)
+              end
+              if foreign_key.options[:dependent].present?
+                statement_parts << (':dependent => ' + foreign_key.options[:dependent].inspect)
+              end
+
+              '  ' + statement_parts.join(', ')
+            end
+
+            stream.puts add_foreign_key_statements.sort.join("\n")
+            stream.puts
+          end
+        end
+    end
+  end
+end

data/lib/foreigner.rb

@@ -0,0 +1,57 @@
+require 'foreigner/connection_adapters/abstract/schema_statements'
+require 'foreigner/connection_adapters/abstract/schema_definitions'
+require 'foreigner/connection_adapters/sql_2003'
+require 'foreigner/schema_dumper'
+
+module Foreigner
+  mattr_accessor :adapters
+  self.adapters = {}
+
+  class << self
+    def register(adapter_name, file_name)
+      adapters[adapter_name] = file_name
+    end
+  
+    def load_adapter!
+      if adapters.key?(configured_adapter)
+        require adapters[configured_adapter]
+      end
+    end
+    
+    def configured_adapter
+      ActiveRecord::Base.connection.adapter_name.downcase
+    end
+    
+    def on_load(&block)
+      if defined?(Rails) && Rails.version >= '3.0'
+        ActiveSupport.on_load :active_record do
+          unless ActiveRecord::Base.connected?
+            ActiveRecord::Base.configurations = Rails.application.config.database_configuration
+            ActiveRecord::Base.establish_connection
+          end
+          block.call
+        end
+      else
+        yield
+      end
+    end
+  end
+end
+
+Foreigner.register 'mysql', 'foreigner/connection_adapters/mysql_adapter'
+Foreigner.register 'postgresql', 'foreigner/connection_adapters/postgresql_adapter'
+
+Foreigner.on_load do
+  module ActiveRecord
+    module ConnectionAdapters
+      include Foreigner::ConnectionAdapters::SchemaStatements
+      include Foreigner::ConnectionAdapters::SchemaDefinitions
+    end
+
+    SchemaDumper.class_eval do
+      include Foreigner::SchemaDumper
+    end
+  end
+  
+  Foreigner.load_adapter!  
+end

data/tasks/foreigner_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :foreigner do
+#   # Task goes here
+# end

data/test/helper.rb

@@ -0,0 +1,8 @@
+require 'test/unit'
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'
+require 'active_record'
+require 'active_record/test_case'
+require 'active_record/connection_adapters/mysql_adapter'
+require 'foreigner'

data/test/mysql_adapter_test.rb

@@ -0,0 +1,97 @@
+require File.dirname(__FILE__) + '/helper'
+
+class MysqlAdapterTest < ActiveRecord::TestCase
+  include Foreigner::MysqlAdapter
+
+  def test_add_without_options
+    assert_equal(
+      "ALTER TABLE `employees` ADD CONSTRAINT `employees_company_id_fk` FOREIGN KEY (`company_id`) REFERENCES `companies`(id)",
+      add_foreign_key(:employees, :companies)
+    )
+  end
+  
+  def test_add_without_options_with_database
+    assert_equal(
+      "ALTER TABLE `employees` ADD CONSTRAINT `employees_company_id_fk` FOREIGN KEY (`company_id`) REFERENCES `other_db`.`companies`(id)",
+      add_foreign_key(:employees, 'other_db.companies')
+    )
+  end
+  
+  def test_add_with_name
+    assert_equal(
+      "ALTER TABLE `employees` ADD CONSTRAINT `favorite_company_fk` FOREIGN KEY (`company_id`) REFERENCES `companies`(id)",
+      add_foreign_key(:employees, :companies, :name => 'favorite_company_fk')
+    )
+  end
+  
+  def test_add_with_column
+    assert_equal(
+      "ALTER TABLE `employees` ADD CONSTRAINT `employees_last_employer_id_fk` FOREIGN KEY (`last_employer_id`) REFERENCES `companies`(id)",
+      add_foreign_key(:employees, :companies, :column => 'last_employer_id')
+    ) 
+  end
+  
+  def test_add_with_column_and_name
+    assert_equal(
+      "ALTER TABLE `employees` ADD CONSTRAINT `favorite_company_fk` FOREIGN KEY (`last_employer_id`) REFERENCES `companies`(id)",
+      add_foreign_key(:employees, :companies, :column => 'last_employer_id', :name => 'favorite_company_fk')
+    )
+  end
+  
+  def test_add_with_delete_dependency
+    assert_equal(
+      "ALTER TABLE `employees` ADD CONSTRAINT `employees_company_id_fk` FOREIGN KEY (`company_id`) REFERENCES `companies`(id) " +
+      "ON DELETE CASCADE",
+      add_foreign_key(:employees, :companies, :dependent => :delete)
+    )
+  end
+  
+  def test_add_with_nullify_dependency
+    assert_equal(
+      "ALTER TABLE `employees` ADD CONSTRAINT `employees_company_id_fk` FOREIGN KEY (`company_id`) REFERENCES `companies`(id) " +
+      "ON DELETE SET NULL",
+      add_foreign_key(:employees, :companies, :dependent => :nullify)
+    )
+  end
+  
+  def test_remove_by_table
+    assert_equal(
+      "ALTER TABLE `suppliers` DROP FOREIGN KEY `suppliers_company_id_fk`",
+      remove_foreign_key(:suppliers, :companies)
+    )
+  end
+  
+  def test_remove_by_table_with_database
+    assert_equal(
+      "ALTER TABLE `suppliers` DROP FOREIGN KEY `suppliers_company_id_fk`",
+      remove_foreign_key(:suppliers, 'other_db.companies')
+    )
+  end
+  
+  def test_remove_by_name
+    assert_equal(
+      "ALTER TABLE `suppliers` DROP FOREIGN KEY `belongs_to_supplier`",
+      remove_foreign_key(:suppliers, :name => "belongs_to_supplier")
+    )
+  end
+  
+  def test_remove_by_column
+    assert_equal(
+      "ALTER TABLE `suppliers` DROP FOREIGN KEY `suppliers_ship_to_id_fk`",
+      remove_foreign_key(:suppliers, :column => "ship_to_id")
+    )
+  end
+  
+  private
+    def execute(sql, name = nil)
+      sql
+    end
+  
+    def quote_column_name(name)
+      "`#{name}`"
+    end
+    
+    def quote_table_name(name)
+      quote_column_name(name).gsub('.', '`.`')
+    end
+end

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: brianjlandau-foreigner
+version: !ruby/object:Gem::Version 
+  hash: 3
+  prerelease: false
+  segments: 
+  - 0
+  - 7
+  - 0
+  version: 0.7.0
+platform: ruby
+authors: 
+- Matthew Higgins
+- Brian Landau
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-23 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Adds helpers to migrations and correctly dumps foreign keys to schema.rb
+email: brianjlandau@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- MIT-LICENSE
+- README
+- Rakefile
+- VERSION
+- brianjlandau-foreigner.gemspec
+- init.rb
+- install.rb
+- lib/foreigner.rb
+- lib/foreigner/connection_adapters/abstract/schema_definitions.rb
+- lib/foreigner/connection_adapters/abstract/schema_statements.rb
+- lib/foreigner/connection_adapters/mysql_adapter.rb
+- lib/foreigner/connection_adapters/postgresql_adapter.rb
+- lib/foreigner/connection_adapters/sql_2003.rb
+- lib/foreigner/schema_dumper.rb
+- tasks/foreigner_tasks.rake
+- test/helper.rb
+- test/mysql_adapter_test.rb
+- uninstall.rb
+has_rdoc: true
+homepage: http://github.com/brianjlandau/foreigner
+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: Foreign keys for Rails
+test_files: 
+- test/helper.rb
+- test/mysql_adapter_test.rb