dwilkie-foreigner 0.3 → 0.4.0

data/README

@@ -27,7 +27,10 @@ Install as a plugin:
 
 Install as a gem by adding the following to environment.rb:
 
-  config.gem "dwilkie-foreigner", :lib => "foreigner"
+  config.gem "dwilkie-foreigner", :lib => "foreigner", :source => "http://gemcutter.org"
+
+
+  sudo rake gems:install
 
 API
 ---

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

@@ -2,7 +2,7 @@ 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
@@ -16,73 +16,32 @@ module Foreigner
     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) }
+          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
     
-        # 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
+          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
-      
-        private
-          def foreign_keys
-            @foreign_keys ||= []
-          end
       end
     end
 
@@ -105,6 +64,8 @@ module Foreigner
         #  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
@@ -138,7 +99,7 @@ module Foreigner
           polymorphic = options[:polymorphic]
           fk_options = options.delete(:foreign_key)
 
-          references_without_foreign_keys(*(args << options))
+          references_without_foreign_keys(*(args.dup << options))
 
           if fk_options && !polymorphic
             fk_options = {} if fk_options == true

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

@@ -43,6 +43,9 @@ module Foreigner
       #   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]

data/lib/foreigner/connection_adapters/mysql_adapter.rb

@@ -1,14 +1,22 @@
-require 'foreigner/connection_adapters/sql_2003'
-
 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.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)
-        foreign_keys = []
         fk_info = select_all %{
           SELECT fk.referenced_table_name as 'to_table'
+                ,fk.referenced_column_name as 'primary_key'
                 ,fk.column_name as 'column'
                 ,fk.constraint_name as 'name'
           FROM information_schema.key_column_usage fk
@@ -19,8 +27,9 @@ module Foreigner
 
         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']}
+        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
@@ -28,10 +37,8 @@ module Foreigner
               options[:dependent] = :nullify
             end
           end
-          foreign_keys << ForeignKeyDefinition.new(table_name, row['to_table'], options)
+          ForeignKeyDefinition.new(table_name, row['to_table'], options)
         end
-      
-        foreign_keys
       end
     end
   end

data/lib/foreigner/connection_adapters/postgresql_adapter.rb

@@ -1,36 +1,46 @@
-require 'foreigner/connection_adapters/sql_2003'
-
 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.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
+          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}'
+          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']}
+        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
-          foreign_keys << ForeignKeyDefinition.new(table_name, row['to_table'], options)
+          ForeignKeyDefinition.new(table_name, row['to_table'], options)
         end
       end
     end

data/lib/foreigner/connection_adapters/sql_2003.rb

@@ -8,34 +8,20 @@ module Foreigner
       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_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])
+          "FOREIGN KEY (#{quote_column_name(column)}) " +
+          "REFERENCES #{quote_table_name(ActiveRecord::Migrator.proper_table_name(to_table))}(#{primary_key})"
 
-        sql = "FOREIGN KEY (#{quote_column_name(column)}) REFERENCES #{quote_table_name(to_table)}(id)"
         sql << " #{dependency}" unless dependency.blank?
-        sql
+      
+        execute(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]

data/lib/foreigner/schema_dumper.rb

@@ -33,8 +33,14 @@ module Foreigner
             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[: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

data/lib/foreigner.rb

@@ -1,5 +1,6 @@
 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 ActiveRecord
@@ -13,8 +14,12 @@ module ActiveRecord
   end
 
   Base.class_eval do
-    if ['MySQL', 'PostgreSQL', 'SQLite'].include? connection.adapter_name
-      require "foreigner/connection_adapters/#{connection.adapter_name.downcase}_adapter"
+    if %w(SQLite).include? connection.adapter_name
+      require "foreigner/connection_adapters/#{connection_adapter_name.downcase}_adapter"
+    end
+    if %w(mysql postgresql).include? connection_pool.spec.config[:adapter].downcase
+      require "foreigner/connection_adapters/#{connection_pool.spec.config[:adapter].downcase}_adapter"
     end
   end
-end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dwilkie-foreigner
 version: !ruby/object:Gem::Version 
-  version: "0.3"
+  version: 0.4.0
 platform: ruby
 authors: 
 - David Wilkie
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-16 00:00:00 -07:00
+date: 2010-02-01 00:00:00 +07:00
 default_executable: 
 dependencies: []
 
@@ -26,9 +26,7 @@ files:
 - 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
@@ -37,9 +35,10 @@ files:
 - lib/foreigner/connection_adapters/abstract/schema_statements.rb
 - test/helper.rb
 - test/mysql_adapter_test.rb
-has_rdoc: false
+has_rdoc: true
 homepage: http://github.com/dwilkie/foreigner/tree/master
-licenses: 
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --line-numbers