foreigner 1.2.1 → 1.3.0

data/README.rdoc

@@ -52,7 +52,15 @@ A name can be specified for the foreign key constraint:
 
 == Change Table Methods
 
-Foreigner adds extra methods to change_table.
+Foreigner adds extra methods to create_table and change_table.
+
+Create a new table with a foreign key:
+  
+  create_table :products do |t|
+    t.string :name
+    t.integer :factory_id
+    t.foreign_key :factories
+  end
 
 Add a missing foreign key to comments:
 

data/lib/foreigner.rb

@@ -13,6 +13,8 @@ module Foreigner
       autoload :ForeignKeyDefinition
       autoload :SchemaDefinitions
       autoload :SchemaStatements
+      autoload :Table
+      autoload :TableDefinition
     end
   end
 

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

@@ -5,62 +5,10 @@ module Foreigner
         base::Table.class_eval do
           include Foreigner::ConnectionAdapters::Table
         end
-      end
-    end
-  
-    module Table
-      extend ActiveSupport::Concern
-
-      included do
-        alias_method_chain :references, :foreign_keys
-      end
 
-      # 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')
-      # ====== 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
-  
-      # Remove the given foreign key from the table.
-      #
-      # ===== Examples
-      # ====== Remove the suppliers_company_id_fk in the suppliers table.
-      #   change_table :suppliers do |t|
-      #     t.remove_foreign_key :companies
-      #   end
-      # ====== Remove the foreign key named accounts_branch_id_fk in the accounts table.
-      #   change_table :accounts do |t|
-      #     t.remove_foreign_key column: :branch_id
-      #   end
-      # ====== Remove the foreign key named party_foreign_key in the accounts table.
-      #   change_table :accounts do |t|
-      #     t.remove_index name: :party_foreign_key
-      #   end
-      def remove_foreign_key(options)
-        @base.remove_foreign_key(@table_name, options)
-      end
-    
-      # Deprecated
-      def references_with_foreign_keys(*args)
-        options = args.extract_options!
-
-        if fk_options = options.delete(:foreign_key)
-          p ActiveSupport::Deprecation.send(:deprecation_message, caller,
-            ":foreign_key in t.references is deprecated. " \
-            "Use t.foreign_key instead")
+        base::TableDefinition.class_eval do
+          include Foreigner::ConnectionAdapters::TableDefinition
         end
-
-        references_without_foreign_keys(*(args.dup << options))
       end
     end
   end

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

@@ -9,6 +9,15 @@ module Foreigner
     end
     
     module AbstractAdapter
+      def create_table(table_name, *args, &block)
+        definition = nil
+        super do |td|
+          definition = td # This is my trick to get the definition
+          block.call(td)
+        end
+        definition.foreign_keys.each { |c,o| add_foreign_key table_name, c, o }
+      end
+
       def supports_foreign_keys?
         false
       end

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

@@ -0,0 +1,59 @@
+module Foreigner
+  module ConnectionAdapters    
+    module Table
+      extend ActiveSupport::Concern
+
+      included do
+        alias_method_chain :references, :foreign_keys
+      end
+
+      # 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')
+      # ====== 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
+
+      # Remove the given foreign key from the table.
+      #
+      # ===== Examples
+      # ====== Remove the suppliers_company_id_fk in the suppliers table.
+      #   change_table :suppliers do |t|
+      #     t.remove_foreign_key :companies
+      #   end
+      # ====== Remove the foreign key named accounts_branch_id_fk in the accounts table.
+      #   change_table :accounts do |t|
+      #     t.remove_foreign_key column: :branch_id
+      #   end
+      # ====== Remove the foreign key named party_foreign_key in the accounts table.
+      #   change_table :accounts do |t|
+      #     t.remove_foreign_key name: :party_foreign_key
+      #   end
+      def remove_foreign_key(options)
+        @base.remove_foreign_key(@table_name, options)
+      end
+
+      # Deprecated
+      def references_with_foreign_keys(*args)
+        options = args.extract_options!
+
+        if fk_options = options.delete(:foreign_key)
+          p ActiveSupport::Deprecation.send(:deprecation_message, caller,
+            ":foreign_key in t.references is deprecated. " \
+            "Use t.foreign_key instead")
+        end
+
+        references_without_foreign_keys(*(args.dup << options))
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Foreigner
+  module ConnectionAdapters    
+    module TableDefinition
+      def foreign_key(to_table, options = {})
+        foreign_keys[to_table] = options
+      end
+
+      def foreign_keys
+        @foreign_keys ||= {}
+      end
+    end
+  end
+end

data/test/foreigner/connection_adapters/abstract/schema_statements_test.rb

@@ -0,0 +1,5 @@
+require 'helper'
+
+class Foreigner::ConnectionAdapters::SchemaStatementsTest < ActiveSupport::TestCase
+
+end

data/test/foreigner/connection_adapters/abstract/table_definition_test.rb

@@ -0,0 +1,13 @@
+require 'helper'
+
+class Foreigner::ConnectionAdapters::TableDefinitionsTest < ActiveSupport::TestCase
+  class TestDefinition
+    include Foreigner::ConnectionAdapters::TableDefinition
+  end
+
+  test "foreign_key" do
+    definition = TestDefinition.new
+    definition.foreign_key :poops, and: :one;
+    assert_equal definition.foreign_keys[:poops], and: :one
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foreigner
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,40 +9,40 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-09 00:00:00.000000000 Z
+date: 2013-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
+  prerelease: false
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
+    none: false
   type: :runtime
-  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
+    none: false
 - !ruby/object:Gem::Dependency
   name: activerecord
+  prerelease: false
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.1.0
+    none: false
   type: :development
-  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.1.0
+    none: false
 description: Adds helpers to migrations and dumps foreign keys to schema.rb
 email: developer@matthewhiggins.com
 executables: []
@@ -57,6 +57,8 @@ files:
 - lib/foreigner/connection_adapters/abstract/foreign_key_definition.rb
 - lib/foreigner/connection_adapters/abstract/schema_definitions.rb
 - lib/foreigner/connection_adapters/abstract/schema_statements.rb
+- lib/foreigner/connection_adapters/abstract/table.rb
+- lib/foreigner/connection_adapters/abstract/table_definition.rb
 - lib/foreigner/connection_adapters/mysql2_adapter.rb
 - lib/foreigner/connection_adapters/mysql_adapter.rb
 - lib/foreigner/connection_adapters/noop_adapter.rb
@@ -68,6 +70,8 @@ files:
 - lib/foreigner/schema_dumper.rb
 - lib/foreigner.rb
 - test/foreigner/adapter_test.rb
+- test/foreigner/connection_adapters/abstract/schema_statements_test.rb
+- test/foreigner/connection_adapters/abstract/table_definition_test.rb
 - test/foreigner/connection_adapters/mysql2_adapter_test.rb
 - test/foreigner/connection_adapters/mysql_adapter_test.rb
 - test/foreigner/connection_adapters/postgresql_adapter_test.rb
@@ -82,17 +86,17 @@ rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: 1.8.7
-required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: 1.3.5
+  none: false
 requirements: []
 rubyforge_project: foreigner
 rubygems_version: 1.8.24