dwilkie-foreigner 0.3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [name of plugin creator]
+
+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,73 @@
+Foreigner
+=========
+
+Adds limited SQLite support for Matt Higgins Foreigner.
+
+Allows you to do the following in your migration files
+  t.foreign_key :posts
+
+Which will generate the following SQL:
+  FOREIGN KEY ("post_id") REFERENCES "posts"(id)
+
+To enforce the constraint use the genfkey tool included with SQLite:
+  rake db:migrate
+  sqlite3 db/development.sqlite3
+  .genfkey --exec
+
+For more info see
+http://www.sqlite.org/cvstrac/fileview?f=sqlite/tool/genfkey.README
+
+
+Installation
+------------
+
+Install as a plugin:
+
+  ruby script/plugin install git://github.com/dwilkie/foreigner.git
+
+Install as a gem by adding the following to environment.rb:
+
+  config.gem "dwilkie-foreigner", :lib => "foreigner"
+
+API
+---
+  t.foreign_key(options)
+  foreign_keys(table_name)
+
+  Since SQLite does not have complete ALTER TABLE support
+  you cannot use the following for an SQLite database
+
+  add_foreign_key(from_table, to_table, options)
+  remove_foreign_key(from_table, options)
+
+
+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:
+
+  t.foreign_key :posts
+
+If the column is named article_id instead of post_id, use the :column option:
+
+  t.foreign_key(:posts, :column => 'article_id')
+
+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 fighting Rails!
+
+Copyright (c) 2009 David Wilkie, released under the MIT license
+

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+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/lib/foreigner/connection_adapters/abstract/schema_definitions.rb

@@ -0,0 +1,151 @@
+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
+      class ForeignKey < Struct.new(:base, :to_table, :options)
+        def to_sql
+          base.foreign_key_definition(to_table, options)
+        end
+        alias to_s :to_sql
+      end
+
+      def self.included(base)
+        base.class_eval do
+          include InstanceMethods
+          alias_method_chain :references, :foreign_keys
+          alias_method_chain :to_sql, :foreign_keys
+        end
+      end
+    
+      module InstanceMethods
+        # 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.
+        # Note: If no name is specified, the database driver creates one for you!
+        def references_with_foreign_keys(*args)
+          options = args.extract_options!
+          fk_options = options.delete(:foreign_key)
+
+          if fk_options && !options[:polymorphic]
+            fk_options = {} if fk_options == true
+            args.each { |to_table| foreign_key(to_table, fk_options) }
+          end
+
+          references_without_foreign_keys(*(args << options))
+        end
+    
+        # Defines a foreign key for 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')
+        def foreign_key(to_table, options = {})
+          if @base.supports_foreign_keys?
+            to_table = to_table.to_s.pluralize if ActiveRecord::Base.pluralize_table_names
+            foreign_keys << ForeignKey.new(@base, to_table, options)
+          end
+        end
+      
+        def to_sql_with_foreign_keys
+          sql = to_sql_without_foreign_keys
+          sql << ', ' << (foreign_keys * ', ') if foreign_keys.present?
+          sql
+        end
+      
+        private
+          def foreign_keys
+            @foreign_keys ||= []
+          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')
+        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 << 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,72 @@
+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>.
+      # [: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,46 @@
+require 'foreigner/connection_adapters/sql_2003'
+
+module Foreigner
+  module ConnectionAdapters
+    module MysqlAdapter
+      include Foreigner::ConnectionAdapters::Sql2003
+      
+      def foreign_keys(table_name)
+        foreign_keys = []
+        fk_info = select_all %{
+          SELECT fk.referenced_table_name as 'to_table'
+                ,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.each do |row|
+          options = {:column => row['column'], :name => row['name']}
+          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
+          foreign_keys << ForeignKeyDefinition.new(table_name, row['to_table'], options)
+        end
+      
+        foreign_keys
+      end
+    end
+  end
+end
+
+module ActiveRecord
+  module ConnectionAdapters
+    MysqlAdapter.class_eval do
+      include Foreigner::ConnectionAdapters::MysqlAdapter
+    end
+  end
+end

data/lib/foreigner/connection_adapters/postgresql_adapter.rb

@@ -0,0 +1,46 @@
+require 'foreigner/connection_adapters/sql_2003'
+
+module Foreigner
+  module ConnectionAdapters
+    module PostgreSQLAdapter
+      include Foreigner::ConnectionAdapters::Sql2003
+      
+      def foreign_keys(table_name)
+        fk_info = select_all %{
+          select tc.constraint_name as name
+                ,ccu.table_name as to_table
+                ,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.inject([]) do |foreign_keys, row|
+          options = {:column => row['column'], :name => row['name']}
+          if row['dependency'] == 'CASCADE'
+            options[:dependent] = :delete
+          elsif row['dependency'] == 'SET NULL'
+            options[:dependent] = :nullify
+          end
+          foreign_keys << ForeignKeyDefinition.new(table_name, row['to_table'], options)
+        end
+      end
+    end
+  end
+end
+
+module ActiveRecord
+  module ConnectionAdapters
+    PostgreSQLAdapter.class_eval do
+      include Foreigner::ConnectionAdapters::PostgreSQLAdapter
+    end
+  end
+end

data/lib/foreigner/connection_adapters/sql_2003.rb

@@ -0,0 +1,57 @@
+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)
+
+        sql =
+          "ALTER TABLE #{quote_table_name(from_table)} " +
+          "ADD CONSTRAINT #{quote_column_name(foreign_key_name)} " +
+          foreign_key_definition(to_table, options)
+      
+        execute(sql)
+      end
+    
+      def foreign_key_definition(to_table, options = {})
+        column  = options[:column] || "#{to_table.to_s.singularize}_id"
+        dependency = dependency_sql(options[:dependent])
+
+        sql = "FOREIGN KEY (#{quote_column_name(column)}) REFERENCES #{quote_table_name(to_table)}(id)"
+        sql << " #{dependency}" unless dependency.blank?
+        sql
+      end
+
+      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.singularize}_id")
+        end
+
+        execute "ALTER TABLE #{quote_table_name(table)} DROP FOREIGN KEY #{quote_column_name(foreign_key_name)}"
+      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/connection_adapters/sqlite_adapter.rb

@@ -0,0 +1,38 @@
+require 'foreigner/connection_adapters/sql_2003'
+
+module Foreigner
+  module ConnectionAdapters
+    module SQLiteAdapter
+      include Foreigner::ConnectionAdapters::Sql2003
+
+      def foreign_keys(table_name)
+        foreign_keys = []
+        create_table_info = select_value %{
+SELECT sql
+FROM sqlite_master
+WHERE sql LIKE '%FOREIGN KEY%'
+AND name = '#{table_name}'
+}
+      if !create_table_info.nil?
+        fk_columns = create_table_info.scan(/FOREIGN KEY\s*\(\"([^\"]+)\"\)/)
+        fk_tables = create_table_info.scan(/REFERENCES\s*\"([^\"]+)\"/)
+        if fk_columns.size == fk_tables.size
+          fk_columns.each_with_index do |fk_column, index|
+            foreign_keys << ForeignKeyDefinition.new(table_name, fk_tables[index][0], :column => fk_column[0])
+          end
+        end
+      end
+      foreign_keys
+      end
+    end
+  end
+end
+
+module ActiveRecord
+  module ConnectionAdapters
+    SQLiteAdapter.class_eval do
+      include Foreigner::ConnectionAdapters::SQLiteAdapter
+    end
+  end
+end
+

data/lib/foreigner/schema_dumper.rb

@@ -0,0 +1,147 @@
+module Foreigner
+  module SchemaDumper
+    def self.included(base)
+      base.class_eval do
+        include InstanceMethods
+        alias_method_chain :tables, :foreign_keys
+        alias_method_chain :table,  :foreign_keys
+      end
+    end
+
+    module InstanceMethods
+      def tables_with_foreign_keys(stream)
+        tables_without_foreign_keys(stream)
+        if @connection.class != ActiveRecord::ConnectionAdapters::SQLite3Adapter
+          @connection.tables.sort.each do |table|
+            foreign_keys(table, stream)
+          end
+        end
+      end
+
+      def table_with_foreign_keys(table, stream)
+        if @connection.class == ActiveRecord::ConnectionAdapters::SQLite3Adapter
+          foreign_key_table(table, stream)
+        else
+          table_without_foreign_keys(table, stream)
+        end
+      end
+
+      private
+        def foreign_keys(table_name, stream)
+          debugger
+          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) ]
+              statement_parts << foreign_key.to_table.inspect
+              statement_parts << (':column => ' + foreign_key.options[:column].inspect)
+              statement_parts << (':name => ' + foreign_key.options[:name].inspect)
+              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
+
+        # This is a direct copy from
+        # active_record/schema.dumper
+        def foreign_key_table(table, stream)
+          columns = @connection.columns(table)
+          begin
+            tbl = StringIO.new
+
+            # first dump primary key column
+            if @connection.respond_to?(:pk_and_sequence_for)
+              pk, pk_seq = @connection.pk_and_sequence_for(table)
+            elsif @connection.respond_to?(:primary_key)
+              pk = @connection.primary_key(table)
+            end
+            pk ||= 'id'
+
+            tbl.print "  create_table #{table.inspect}"
+            if columns.detect { |c| c.name == pk }
+              if pk != 'id'
+                tbl.print %Q(, :primary_key => "#{pk}")
+              end
+            else
+              tbl.print ", :id => false"
+            end
+            tbl.print ", :force => true"
+            tbl.puts " do |t|"
+
+            # then dump all non-primary key columns
+            column_specs = columns.map do |column|
+              raise StandardError, "Unknown type '#{column.sql_type}' for column '#{column.name}'" if @types[column.type].nil?
+              next if column.name == pk
+              spec = {}
+              spec[:name]      = column.name.inspect
+              spec[:type]      = column.type.to_s
+              spec[:limit]     = column.limit.inspect if column.limit != @types[column.type][:limit] && column.type != :decimal
+              spec[:precision] = column.precision.inspect if !column.precision.nil?
+              spec[:scale]     = column.scale.inspect if !column.scale.nil?
+              spec[:null]      = 'false' if !column.null
+              spec[:default]   = default_string(column.default) if column.has_default?
+              (spec.keys - [:name, :type]).each{ |k| spec[k].insert(0, "#{k.inspect} => ")}
+              spec
+            end.compact
+
+            # find all migration keys used in this table
+            keys = [:name, :limit, :precision, :scale, :default, :null] & column_specs.map(&:keys).flatten
+
+            # figure out the lengths for each column based on above keys
+            lengths = keys.map{ |key| column_specs.map{ |spec| spec[key] ? spec[key].length + 2 : 0 }.max }
+
+            # the string we're going to sprintf our values against, with standardized column widths
+            format_string = lengths.map{ |len| "%-#{len}s" }
+
+            # find the max length for the 'type' column, which is special
+            type_length = column_specs.map{ |column| column[:type].length }.max
+
+            # add column type definition to our format string
+            format_string.unshift "    t.%-#{type_length}s "
+
+            format_string *= ''
+
+            column_specs.each do |colspec|
+              values = keys.zip(lengths).map{ |key, len| colspec.key?(key) ? colspec[key] + ", " : " " * len }
+              values.unshift colspec[:type]
+              tbl.print((format_string % values).gsub(/,\s*$/, ''))
+              tbl.puts
+            end
+
+            add_foreign_keys(table, tbl)
+
+            tbl.puts "  end"
+            tbl.puts
+
+            indexes(table, tbl)
+
+            tbl.rewind
+            stream.print tbl.read
+          rescue => e
+            stream.puts "# Could not dump table #{table.inspect} because of following #{e.class}"
+            stream.puts "#   #{e.message}"
+            stream.puts
+          end
+
+          stream
+        end
+
+        def add_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 = ["  t.foreign_key " + foreign_key.to_table.inspect]
+              statement_parts << (':column => ' + foreign_key.options[:column].inspect)
+              '  ' + statement_parts.join(', ')
+            end
+
+            stream.puts add_foreign_key_statements.sort.join("\n")
+          end
+        end
+    end
+  end
+end

data/lib/foreigner.rb

@@ -0,0 +1,20 @@
+require 'foreigner/connection_adapters/abstract/schema_statements'
+require 'foreigner/connection_adapters/abstract/schema_definitions'
+require 'foreigner/schema_dumper'
+
+module ActiveRecord
+  module ConnectionAdapters
+    include Foreigner::ConnectionAdapters::SchemaStatements
+    include Foreigner::ConnectionAdapters::SchemaDefinitions
+  end
+
+  SchemaDumper.class_eval do
+    include Foreigner::SchemaDumper
+  end
+
+  Base.class_eval do
+    if ['MySQL', 'PostgreSQL', 'SQLite'].include? connection.adapter_name
+      require "foreigner/connection_adapters/#{connection.adapter_name.downcase}_adapter"
+    end
+  end
+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,83 @@
+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_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_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

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: dwilkie-foreigner
+version: !ruby/object:Gem::Version 
+  version: "0.3"
+platform: ruby
+authors: 
+- David Wilkie
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-16 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Foreign keys for Rails migrations with limited SQLite support
+email: dwilkie@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- MIT-LICENSE
+- Rakefile
+- README
+- lib/foreigner.rb
+- lib/foreigner
+- lib/foreigner/schema_dumper.rb
+- lib/foreigner/connection_adapters
+- lib/foreigner/connection_adapters/sql_2003.rb
+- lib/foreigner/connection_adapters/mysql_adapter.rb
+- lib/foreigner/connection_adapters/postgresql_adapter.rb
+- lib/foreigner/connection_adapters/sqlite_adapter.rb
+- lib/foreigner/connection_adapters/abstract/schema_definitions.rb
+- lib/foreigner/connection_adapters/abstract/schema_statements.rb
+- test/helper.rb
+- test/mysql_adapter_test.rb
+has_rdoc: false
+homepage: http://github.com/dwilkie/foreigner/tree/master
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: foreigner
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 1
+summary: Foreign keys for Rails migrations with limited SQLite support
+test_files: []
+