matthuhiggins-foreigner 0.2.0 → 0.2.1

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

@@ -1,133 +1,149 @@
 module Foreigner
-  class ForeignKeyDefinition < Struct.new(:from_table, :to_table, :options) #:nodoc:
-  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
+  module ConnectionAdapters
+    class ForeignKeyDefinition < Struct.new(:from_table, :to_table, :options) #:nodoc:
     end
 
-    def self.included(base)
-      base.class_eval do
-        include InstanceMethods
-        alias_method_chain :references, :foreign_keys
-        alias_method_chain :to_sql, :foreign_keys
+    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 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 options[:foreign_key] == true
-          args.each { |to_table| foreign_key(to_table, fk_options) }
+  
+    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
 
-        references_without_foreign_keys(*(args << options))
+      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
     
-      # 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 = {})
-        to_table = to_table.to_s.pluralize if ActiveRecord::Base.pluralize_table_names
-        foreign_keys << ForeignKey.new(@base, to_table, options)
-      end
-      
-      def to_sql_with_foreign_keys
-        sql = to_sql_without_foreign_keys
-        sql << ', ' << (foreign_keys * ', ') if foreign_keys.present?
-        sql
-      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
       
-      private
-        def foreign_keys
-          @foreign_keys ||= []
+        def to_sql_with_foreign_keys
+          sql = to_sql_without_foreign_keys
+          sql << ', ' << (foreign_keys * ', ') if foreign_keys.present?
+          sql
         end
-    end
-  end
-
-  module Table
-    def self.included(base)
-      base.class_eval do
-        include InstanceMethods
-        alias_method_chain :references, :foreign_keys
+      
+        private
+          def foreign_keys
+            @foreign_keys ||= []
+          end
       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)
+    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
+        # 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)
+        # 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))
+          references_without_foreign_keys(*(args << options))
 
-        if fk_options && !polymorphic
-          fk_options = {} if options[:foreign_key] == true
-          args.each { |to_table| foreign_key(to_table, fk_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

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

@@ -1,62 +1,72 @@
 module Foreigner
-  module AdapterMethods
-    def supports_foreign_keys?
-      false
+  module ConnectionAdapters
+    module SchemaStatements
+      def self.included(base)
+        base::AbstractAdapter.class_eval do
+          include Foreigner::ConnectionAdapters::AbstractAdapter
+        end
+      end
     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)
-      []
+    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/postgresql_adapter.rb

@@ -6,8 +6,6 @@ module Foreigner
       include Foreigner::ConnectionAdapters::Sql2003
       
       def foreign_keys(table_name)
-        foreign_keys = []
-
         fk_info = select_all %{
           select tc.constraint_name as name
                 ,ccu.table_name as to_table
@@ -15,17 +13,11 @@ module Foreigner
                 ,rc.delete_rule as dependency
           from information_schema.table_constraints tc
           join information_schema.key_column_usage kcu
-            on tc.constraint_catalog = kcu.constraint_catalog
-           and tc.constraint_schema = kcu.constraint_schema
-           and tc.constraint_name = kcu.constraint_name
+          using (constraint_catalog, constraint_schema, constraint_name)
           join information_schema.referential_constraints rc
-            on tc.constraint_catalog = rc.constraint_catalog
-           and tc.constraint_schema = rc.constraint_schema
-           and tc.constraint_name = rc.constraint_name
+          using (constraint_catalog, constraint_schema, constraint_name)
           join information_schema.constraint_column_usage ccu
-            on tc.constraint_catalog = ccu.constraint_catalog
-           and tc.constraint_schema = ccu.constraint_schema
-           and tc.constraint_name = ccu.constraint_name
+          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}'

data/lib/foreigner.rb

@@ -4,17 +4,8 @@ require 'foreigner/schema_dumper'
 
 module ActiveRecord
   module ConnectionAdapters
-    AbstractAdapter.class_eval do
-      include Foreigner::AdapterMethods
-    end
-
-    TableDefinition.class_eval do
-      include Foreigner::TableDefinition
-    end
-
-    Table.class_eval do
-      include Foreigner::Table
-    end
+    include Foreigner::ConnectionAdapters::SchemaStatements
+    include Foreigner::ConnectionAdapters::SchemaDefinitions
   end
   
   SchemaDumper.class_eval do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: matthuhiggins-foreigner
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - Matthew Higgins
@@ -38,6 +38,7 @@ files:
 - test/mysql_adapter_test.rb
 has_rdoc: false
 homepage: http://github.com/matthuhiggins/foreigner/tree/master
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --line-numbers
@@ -60,7 +61,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: foreigner
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 1
 summary: Foreign keys for Rails migrations