matthuhiggins-foreigner 0.2.1 → 0.3.0

data/README

@@ -16,7 +16,7 @@ Install as a plugin:
 
 Install as a gem by adding the following to environment.rb:
 
-  config.gem "matthuhiggins-foreigner", :lib => "foreigner"
+  config.gem "matthuhiggins-foreigner", :lib => "foreigner", :source => http://gemcutter.org
 
 API
 ---

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

@@ -66,6 +66,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 = {})
           if @base.supports_foreign_keys?
             to_table = to_table.to_s.pluralize if ActiveRecord::Base.pluralize_table_names
@@ -105,6 +107,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

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

@@ -19,23 +19,14 @@ module Foreigner
     
       def foreign_key_definition(to_table, options = {})
         column  = options[:column] || "#{to_table.to_s.singularize}_id"
+        primary_key = options[:primary_key] || "id"
         dependency = dependency_sql(options[:dependent])
 
-        sql = "FOREIGN KEY (#{quote_column_name(column)}) REFERENCES #{quote_table_name(to_table)}(id)"
+        sql = "FOREIGN KEY (#{quote_column_name(column)}) REFERENCES #{quote_table_name(to_table)}(#{primary_key})"
         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]

data/lib/foreigner/schema_dumper.rb

@@ -21,8 +21,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,7 +14,7 @@ module ActiveRecord
   end
   
   Base.class_eval do
-    if ['MySQL', 'PostgreSQL'].include? connection.adapter_name
+    if %w(MySQL PostgreSQL).include? connection.adapter_name
       require "foreigner/connection_adapters/#{connection.adapter_name.downcase}_adapter"
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: matthuhiggins-foreigner
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors: 
 - Matthew Higgins
@@ -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
@@ -36,9 +34,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/matthuhiggins/foreigner/tree/master
-licenses: 
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --line-numbers
@@ -60,7 +59,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: foreigner
+rubyforge_project: 
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 1