matthuhiggins-foreigner 0.3.0 → 0.5.0

data/README

@@ -14,9 +14,13 @@ Install as a plugin:
 
   ruby script/plugin install git://github.com/matthuhiggins/foreigner.git
 
-Install as a gem by adding the following to environment.rb:
+In Rails 2, install as a gem by adding the following to config/environment.rb:
 
-  config.gem "matthuhiggins-foreigner", :lib => "foreigner", :source => http://gemcutter.org
+  config.gem "matthuhiggins-foreigner", :lib => "foreigner"
+
+In Rails 3, install as a gem by adding the following to your Gemfile:
+
+  gem 'matthuhiggins-foreigner', :require => 'foreigner'
 
 API
 ---
@@ -61,14 +65,7 @@ Lastly, a name can be specified for the foreign key constraint:
 Create/Change Table Shorthand
 -----------------------------
 
-Foreigner adds extra behavior to create_table and change_table, which lets you define foreign keys using shorthand.
-
-Create the comments table with a foreign key to posts:
-
-create_table :comments do |t|
-  t.integer :post_id
-  t.foreign_key :posts
-end
+Foreigner adds extra behavior to change_table, which lets you define foreign keys using shorthand.
 
 Add a missing foreign key to comments:
 
@@ -85,7 +82,7 @@ Additional t.references option
 Foreigner extends table.references with the :foreign_key option. Pass true, and the default
 foreign key options are used:
 
-create_table :comments do |t|
+change_table :comments do |t|
   t.references :post, :foreign_key => true
 end
 
@@ -101,6 +98,6 @@ 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!
+This allows you to use foreign keys without switching to the :sql schema.
 
 Copyright (c) 2009 Matthew Higgins, released under the MIT license

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,75 +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')
-        # ====== 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
-            foreign_keys << ForeignKey.new(@base, to_table, options)
-          end
+          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
-      
-        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
 
@@ -142,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/sql_2003.rb

@@ -8,23 +8,18 @@ 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"
-        primary_key = options[:primary_key] || "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)}(#{primary_key})"
         sql << " #{dependency}" unless dependency.blank?
-        sql
+      
+        execute(sql)
       end
 
       private

data/lib/foreigner.rb

@@ -3,19 +3,55 @@ require 'foreigner/connection_adapters/abstract/schema_definitions'
 require 'foreigner/connection_adapters/sql_2003'
 require 'foreigner/schema_dumper'
 
-module ActiveRecord
-  module ConnectionAdapters
-    include Foreigner::ConnectionAdapters::SchemaStatements
-    include Foreigner::ConnectionAdapters::SchemaDefinitions
-  end
+module Foreigner
+  mattr_accessor :adapters
+  self.adapters = {}
+
+  class << self
+    def register(adapter_name, file_name)
+      adapters[adapter_name] = file_name
+    end
   
-  SchemaDumper.class_eval do
-    include Foreigner::SchemaDumper
+    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 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
-  
-  Base.class_eval do
-    if %w(MySQL PostgreSQL).include? connection.adapter_name
-      require "foreigner/connection_adapters/#{connection.adapter_name.downcase}_adapter"
+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

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: matthuhiggins-foreigner
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  prerelease: false
+  segments: 
+  - 0
+  - 5
+  - 0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Matthew Higgins
@@ -9,11 +14,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-07 00:00:00 -07:00
+date: 2010-04-02 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
-description: Foreign keys for Rails migrations
+description: Adds helpers to migrations and correctly dumps foreign keys to schema.rb
 email: developer@matthewhiggins.com
 executables: []
 
@@ -35,34 +40,38 @@ files:
 - test/helper.rb
 - test/mysql_adapter_test.rb
 has_rdoc: true
-homepage: http://github.com/matthuhiggins/foreigner/tree/master
+homepage: http://github.com/matthuhiggins/foreigner
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --line-numbers
-- --main
-- README
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+      segments: 
+      - 1
+      - 8
+      - 6
+      version: 1.8.6
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
 requirements: []
 
-rubyforge_project: 
-rubygems_version: 1.3.5
+rubyforge_project: matthuhiggins-foreigner
+rubygems_version: 1.3.6
 signing_key: 
-specification_version: 1
-summary: Foreign keys for Rails migrations
+specification_version: 3
+summary: Foreign keys for Rails
 test_files: []