foreigner 1.6.1 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6267757603fa3cc7daf2d7c9fb0cd5c3c0b5de57
-  data.tar.gz: 59ba0f7366cbfbbc9c315c6a4f3141c7ccefd887
+  metadata.gz: 7afaa93e891d1a95c671e0703a70c4fbae46eb84
+  data.tar.gz: 8eb8278d682088f6b57aef3962abb224bc4b8727
 SHA512:
-  metadata.gz: 0692abaca90f8bf9afe7a1b034062741d1cb6288816f7491aac15e566392121338dab6814bd94adf3dabb0a1acd0262d1f62af938cc34030947be52ca26f3736
-  data.tar.gz: 17fd7783a3127006a0a2284f4c82ea4960fd81115c6a56c9fff3a2159952cf18b8aac1f7f8da1842e8f514308f87b38c6b0acc2e3e5b4dac7421e25fab3da8b6
+  metadata.gz: 254c861fe2c7299e1157dc186f25e0649a4724095e6eebde0dcf94b223169f08e4ea3730d97cdca6d67308640138c3f2e92bf07b84d87c67b8a30490236e2133
+  data.tar.gz: a6f39ca36faf91a20d61b76326c47b360891b98adbc3685c02be6d3f52ec070bc74006f84d3d261b0f472462de44e1dd465b2dd7ecea7780ecb6cdfd91fcf60b

data/README.md

@@ -13,46 +13,46 @@ The following adapters are supported:
 
 Add the following to your Gemfile:
 ```ruby
-  gem 'foreigner'
+gem 'foreigner'
 ```
 ## API Examples
 
 Foreigner adds two methods to migrations.
 
 * `add_foreign_key(from_table, to_table, options)`
-* `remove_foreign_key(from_table, options)`
+* `remove_foreign_key(from_table, to_table, options)`
 
 (Options are documented in `connection_adapters/abstract/schema_statements.rb`):
 
 For example, given the following model:
 ```ruby
-  class Comment < ActiveRecord::Base
-    belongs_to :post
-  end
+class Comment < ActiveRecord::Base
+  belongs_to :post
+end
 
-  class Post < ActiveRecord::Base
-    has_many :comments, dependent: :delete_all
-  end
+class Post < ActiveRecord::Base
+  has_many :comments, dependent: :delete_all
+end
 ```  
 You should add a foreign key in your migration:
 ```ruby
-  add_foreign_key(:comments, :posts)
+add_foreign_key(:comments, :posts)
 ```
 The `:dependent` option can be moved from the `has_many` definition to the foreign key:
 ```ruby
-  add_foreign_key(:comments, :posts, dependent: :delete)
+add_foreign_key(:comments, :posts, dependent: :delete)
 ```
 If the column is named `article_id` instead of `post_id`, use the `:column` option:
 ```ruby
-  add_foreign_key(:comments, :posts, column: 'article_id')
+add_foreign_key(:comments, :posts, column: 'article_id')
 ```
 A name can be specified for the foreign key constraint:
 ```ruby
-  add_foreign_key(:comments, :posts, name: 'comment_article_foreign_key')
+add_foreign_key(:comments, :posts, name: 'comment_article_foreign_key')
 ```
 The `:column` and `:name` options create a foreign key with a custom name. In order to remove it you need to specify `:name`:
 ```ruby
-  remove_foreign_key(:comments, name: 'comment_article_foreign_key')
+remove_foreign_key(:comments, name: 'comment_article_foreign_key')
 ```
 ## Change Table Methods
 
@@ -60,29 +60,29 @@ Foreigner adds extra methods to `create_table` and `change_table`.
 
 Create a new table with a foreign key:
 ```ruby
-  create_table :products do |t|
-    t.string :name
-    t.integer :factory_id
-    t.foreign_key :factories
-  end
+create_table :products do |t|
+  t.string :name
+  t.integer :factory_id
+  t.foreign_key :factories
+end
 ```
 Add a missing foreign key to comments:
 ```ruby
-  change_table :comments do |t|
-    t.foreign_key :posts, dependent: :delete
-  end
+change_table :comments do |t|
+  t.foreign_key :posts, dependent: :delete
+end
 ```
 Remove an unwanted foreign key:
 ```ruby
-  change_table :comments do |t|
-    t.remove_foreign_key :users
-  end
+change_table :comments do |t|
+  t.remove_foreign_key :users
+end
 ```
 ## Database-specific options
 
 Database-specific options will never be supported by foreigner. You can add them using `:options`:
 ```ruby
-  add_foreign_key(:comments, :posts, options: 'ON UPDATE DEFERRED')
+add_foreign_key(:comments, :posts, options: 'ON UPDATE DEFERRED')
 ```
 ## Foreigner Add-ons
 

data/lib/foreigner.rb

@@ -28,6 +28,7 @@ Foreigner::Adapter.register 'mysql', 'foreigner/connection_adapters/mysql_adapte
 Foreigner::Adapter.register 'mysql2', 'foreigner/connection_adapters/mysql2_adapter'
 Foreigner::Adapter.register 'jdbcmysql', 'foreigner/connection_adapters/mysql2_adapter'
 Foreigner::Adapter.register 'postgresql', 'foreigner/connection_adapters/postgresql_adapter'
+Foreigner::Adapter.register 'postgis', 'foreigner/connection_adapters/postgresql_adapter'
 Foreigner::Adapter.register 'jdbcpostgresql', 'foreigner/connection_adapters/postgresql_adapter'
 Foreigner::Adapter.register 'sqlite3', 'foreigner/connection_adapters/noop_adapter'
 

data/lib/foreigner/connection_adapters/mysql2_adapter.rb

@@ -26,12 +26,13 @@ module Foreigner
         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|RESTRICT)/
-            options[:dependent] = case $1
+          if create_table_info =~ /CONSTRAINT #{quote_column_name(row['name'])} FOREIGN KEY .* REFERENCES .*\)( ON DELETE (CASCADE|SET NULL|RESTRICT))? ?(.*)$/
+            options[:dependent] = case $2
               when 'CASCADE'  then :delete
               when 'SET NULL' then :nullify
               when 'RESTRICT' then :restrict
             end
+            options[:options] = $3 # e.g. ON UPDATE ...
           end
           ForeignKeyDefinition.new(table_name, row['to_table'], options)
         end

data/lib/foreigner/connection_adapters/postgresql_adapter.rb

@@ -3,9 +3,19 @@ module Foreigner
     module PostgreSQLAdapter
       include Foreigner::ConnectionAdapters::Sql2003
 
+      DEPENDENCY_CODE_ACTIONS = {'c' => 'CASCADE', 'n' => 'SET NULL', 'r' => 'RESTRICT', 'd' => 'SET DEFAULT'}
+
       def foreign_keys(table_name)
         fk_info = select_all %{
-          SELECT t2.relname AS to_table, a1.attname AS column, a2.attname AS primary_key, c.conname AS name, c.confdeltype AS dependency
+          SELECT t2.relname AS to_table
+               , a1.attname AS column
+               , a2.attname AS primary_key
+               , c.conname AS name
+               , c.confdeltype AS dependency
+               , c.confupdtype AS update_dependency
+               , c.condeferrable AS deferrable
+               , c.condeferred AS deferred
+            #{", c.convalidated AS valid" if postgresql_version >= 90100}
           FROM pg_constraint c
           JOIN pg_class t1 ON c.conrelid = t1.oid
           JOIN pg_class t2 ON c.confrelid = t2.oid
@@ -22,11 +32,23 @@ module Foreigner
           options = {column: row['column'], name: row['name'], primary_key: row['primary_key']}
 
           options[:dependent] = case row['dependency']
+            # NO ACTION is the default
+            # SET DEFAULT is handled below, since it is postgres-specific
             when 'c' then :delete
             when 'n' then :nullify
             when 'r' then :restrict
           end
 
+          extras = []
+          extras << "ON DELETE SET DEFAULT"      if row['dependency'] == 'd'
+          if update_action = DEPENDENCY_CODE_ACTIONS[row['update_dependency']]
+            extras << "ON UPDATE #{update_action}"
+          end
+          extras << 'DEFERRABLE'                 if row['deferrable'] == 't'
+          extras << 'INITIALLY DEFERRED'         if row['deferred'] == 't'
+          extras << 'NOT VALID'                  if row['valid'] == 'f'
+          options[:options] = extras.join(" ")
+
           ForeignKeyDefinition.new(table_name, row['to_table'], options)
         end
       end
@@ -35,4 +57,4 @@ module Foreigner
 end
 
 Foreigner::Adapter.safe_include :JdbcAdapter, Foreigner::ConnectionAdapters::PostgreSQLAdapter
-Foreigner::Adapter.safe_include :PostgreSQLAdapter, Foreigner::ConnectionAdapters::PostgreSQLAdapter
+Foreigner::Adapter.safe_include :PostgreSQLAdapter, Foreigner::ConnectionAdapters::PostgreSQLAdapter

data/lib/foreigner/connection_adapters/sql2003.rb

@@ -8,20 +8,19 @@ module Foreigner
       def drop_table(*args)
         options = args.extract_options!
         if options[:force]
-          disable_referential_integrity { super }
+          disable_referential_integrity { super(*(args.dup << options)) }
         else
-          super
+          super(*(args.dup << options))
         end
       end
 
       def foreign_key_exists?(from_table, options)
         foreign_key_name = decipher_foreign_key_name(from_table, options)
-
         foreign_keys(from_table).any? { |fk| fk.name == foreign_key_name }
       end
 
       def add_foreign_key(from_table, to_table, options = {})
-        sql = "ALTER TABLE #{quote_table_name(from_table)} #{add_foreign_key_sql(from_table, to_table, options)}"
+        sql = "ALTER TABLE #{quote_proper_table_name(from_table)} #{add_foreign_key_sql(from_table, to_table, options)}"
         execute(sql)
       end
 
@@ -31,28 +30,35 @@ module Foreigner
         primary_key = options[:primary_key] || "id"
         dependency = dependency_sql(options[:dependent])
 
-        proper_name = proper_table_name(to_table)
-
         sql =
           "ADD CONSTRAINT #{quote_column_name(foreign_key_name)} " +
           "FOREIGN KEY (#{quote_column_name(column)}) " +
-          "REFERENCES #{quote_table_name(proper_name)}(#{primary_key})"
+          "REFERENCES #{quote_proper_table_name(to_table)}(#{primary_key})"
         sql << " #{dependency}" if dependency.present?
         sql << " #{options[:options]}" if options[:options]
 
         sql
       end
 
-      def proper_table_name(to_table)
+      def quote_proper_table_name(table)
+        quote_table_name(proper_table_name(table))
+      end
+
+      def proper_table_name(table)
+        # This will normally be a no-op, but prevents the table from being wrapped twice:
+        table = Foreigner::SchemaDumper::ClassMethods.remove_prefix_and_suffix(table)
         if ActiveRecord::Migration.instance_methods(false).include? :proper_table_name
-          ActiveRecord::Migration.new.proper_table_name(to_table)
+          ActiveRecord::Migration.new.proper_table_name(table, options = {
+            table_name_prefix: ActiveRecord::Base.table_name_prefix,
+            table_name_suffix: ActiveRecord::Base.table_name_suffix
+          })
         else
-          ActiveRecord::Migrator.proper_table_name(to_table)
+          ActiveRecord::Migrator.proper_table_name(table)
         end
       end
 
       def remove_foreign_key(table, options)
-        execute "ALTER TABLE #{quote_table_name(table)} #{remove_foreign_key_sql(table, options)}"
+        execute "ALTER TABLE #{quote_proper_table_name(table)} #{remove_foreign_key_sql(table, options)}"
       end
 
       def remove_foreign_key_sql(table, options)

data/lib/foreigner/schema_dumper.rb

@@ -21,13 +21,23 @@ module Foreigner
         if foreign_key.options[:dependent].present?
           statement_parts << ('dependent: ' + foreign_key.options[:dependent].inspect)
         end
+        if foreign_key.options[:options].present?
+          statement_parts << ('options: ' + foreign_key.options[:options].inspect)
+        end
 
         statement_parts.join(', ')
       end
 
-      def remove_prefix_and_suffix(table)
-        table.gsub(/^(#{ActiveRecord::Base.table_name_prefix})(.+)(#{ActiveRecord::Base.table_name_suffix})$/,  "\\2")
+      def remove_prefix_and_suffix(table_name)
+        table_name = table_name.to_s
+        pre, suff = ActiveRecord::Base.table_name_prefix, ActiveRecord::Base.table_name_suffix
+        if table_name.start_with?(pre) && table_name.end_with?(suff)
+          table_name[pre.size..-(suff.size + 1)]
+        else
+          table_name
+        end
       end
+      module_function :remove_prefix_and_suffix
     end
 
     def tables_with_foreign_keys(stream)

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

@@ -7,7 +7,7 @@ class Foreigner::ConnectionAdapters::TableDefinitionsTest < ActiveSupport::TestC
 
   test "foreign_key used once" do
     definition = TestDefinition.new
-    definition.foreign_key :poops, and: :one;
+    definition.foreign_key :poops, and: :one
     assert_equal [{ and: :one }], definition.foreign_keys[:poops]
   end
 
@@ -18,4 +18,4 @@ class Foreigner::ConnectionAdapters::TableDefinitionsTest < ActiveSupport::TestC
     assert_equal [{ column: :from_id }, { column: :to_id }],
       definition.foreign_keys[:nodes]
   end
-end
+end

data/test/foreigner/connection_adapters/mysql_adapter_test.rb

@@ -2,9 +2,10 @@ require 'helper'
 
 class Foreigner::MysqlAdapterTest < Foreigner::UnitTest
   test 'warning' do
+    skip unless respond_to?(:capture) # < not available until 3.1.x
     output = capture(:stdout) do
       require 'foreigner/connection_adapters/mysql_adapter'
     end
     assert_match /WARNING: Please upgrade to mysql2. The old mysql adapter is not supported by foreigner./, output
   end
-end
+end

data/test/foreigner/connection_adapters/sql2003_test.rb

@@ -10,6 +10,16 @@ class Foreigner::Sql2003Test < Foreigner::UnitTest
     @adapter = TestAdapter.new
   end
 
+  teardown do
+    ActiveRecord::Base.table_name_prefix = ''
+    ActiveRecord::Base.table_name_suffix = ''
+  end
+
+  def add_table_prefix_and_suffix
+    ActiveRecord::Base.table_name_prefix = 'pre_'
+    ActiveRecord::Base.table_name_suffix = '_suff'
+  end
+
   test 'drop_table without force' do
     @adapter.drop_table 'shoes'
     assert !@adapter.instance_variable_get(:@disable_referential_integrity)
@@ -39,6 +49,14 @@ class Foreigner::Sql2003Test < Foreigner::UnitTest
     )
   end
 
+  test 'add_without_options with prefix and suffix' do
+    add_table_prefix_and_suffix
+    assert_equal(
+      "ALTER TABLE `pre_employees_suff` ADD CONSTRAINT `employees_company_id_fk` FOREIGN KEY (`company_id`) REFERENCES `pre_companies_suff`(id)",
+      @adapter.add_foreign_key(:employees, :companies)
+    )
+  end
+
   test 'add_with_name' do
     assert_equal(
       "ALTER TABLE `employees` ADD CONSTRAINT `favorite_company_fk` FOREIGN KEY (`company_id`) REFERENCES `companies`(id)",
@@ -60,6 +78,14 @@ class Foreigner::Sql2003Test < Foreigner::UnitTest
     )
   end
 
+  test 'add_with_column_and_name with prefix and suffix' do
+    add_table_prefix_and_suffix
+    assert_equal(
+      "ALTER TABLE `pre_employees_suff` ADD CONSTRAINT `favorite_company_fk` FOREIGN KEY (`last_employer_id`) REFERENCES `pre_companies_suff`(id)",
+      @adapter.add_foreign_key(:employees, :companies, column: 'last_employer_id', name: 'favorite_company_fk')
+    )
+  end
+
   test 'add_with_delete_dependency' do
     assert_equal(
       "ALTER TABLE `employees` ADD CONSTRAINT `employees_company_id_fk` FOREIGN KEY (`company_id`) REFERENCES `companies`(id) " +
@@ -99,6 +125,14 @@ class Foreigner::Sql2003Test < Foreigner::UnitTest
     )
   end
 
+  test 'remove_by_table with prefix and suffix' do
+    add_table_prefix_and_suffix
+    assert_equal(
+      "ALTER TABLE `pre_suppliers_suff` DROP CONSTRAINT `suppliers_company_id_fk`",
+      @adapter.remove_foreign_key(:suppliers, :companies)
+    )
+  end
+
   test 'remove_by_name' do
     assert_equal(
       "ALTER TABLE `suppliers` DROP CONSTRAINT `belongs_to_supplier`",
@@ -112,4 +146,4 @@ class Foreigner::Sql2003Test < Foreigner::UnitTest
       @adapter.remove_foreign_key(:suppliers, column: "ship_to_id")
     )
   end
-end
+end

data/test/foreigner/migration/command_recorder_test.rb

@@ -1,11 +1,20 @@
 require 'helper'
 
-ActiveRecord::Migration::CommandRecorder.class_eval do
-  include ::Foreigner::Migration::CommandRecorder
+if defined?(ActiveRecord::Migration::CommandRecorder)
+  ActiveRecord::Migration::CommandRecorder.class_eval do
+    include ::Foreigner::Migration::CommandRecorder
+  end
 end
 
 class Foreigner::CommandRecorderTest < Foreigner::UnitTest
+
+  def revert_exists?
+    defined?(ActiveRecord::Migration::CommandRecorder) &&
+      ActiveRecord::Migration::CommandRecorder.instance_methods.include?(:revert)
+  end
+
   setup do
+    skip unless revert_exists?
     @recorder = ActiveRecord::Migration::CommandRecorder.new
   end
 
@@ -48,4 +57,4 @@ class Foreigner::CommandRecorderTest < Foreigner::UnitTest
       # @recorder.inverse
     # end
   end
-end
+end

data/test/foreigner/schema_dumper_test.rb

@@ -32,6 +32,7 @@ class Foreigner::SchemaDumperTest < Foreigner::UnitTest
     assert_dump "add_foreign_key \"foos\", \"bars\", name: \"lulz\", primary_key: \"uuid\"", Foreigner::ConnectionAdapters::ForeignKeyDefinition.new('foos', 'bars', column: 'bar_id', primary_key: 'uuid', name: 'lulz')
     assert_dump "add_foreign_key \"foos\", \"bars\", name: \"lulz\", dependent: :delete", Foreigner::ConnectionAdapters::ForeignKeyDefinition.new('foos', 'bars', column: 'bar_id', primary_key: 'id', name: 'lulz', dependent: :delete)
     assert_dump "add_foreign_key \"foos\", \"bars\", name: \"lulz\", column: \"mamma_id\"", Foreigner::ConnectionAdapters::ForeignKeyDefinition.new('foos', 'bars', column: 'mamma_id', primary_key: 'id', name: 'lulz')
+    assert_dump "add_foreign_key \"foos\", \"bars\", name: \"lulz\", options: \"YOLO MAYBE DB-SPECIFIC!\"", Foreigner::ConnectionAdapters::ForeignKeyDefinition.new('foos', 'bars', column: 'bar_id', primary_key: 'id', name: 'lulz', options: "YOLO MAYBE DB-SPECIFIC!")
   end
 
   test 'all tables' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreigner
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 1.7.0
 platform: ruby
 authors:
 - Matthew Higgins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-06 00:00:00.000000000 Z
+date: 2014-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -24,6 +24,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Adds helpers to migrations and dumps foreign keys to schema.rb
 email: developer@matthewhiggins.com
 executables: []
@@ -60,7 +88,8 @@ files:
 - test/foreigner/schema_dumper_test.rb
 - test/helper.rb
 homepage: http://github.com/matthuhiggins/foreigner
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -78,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.5
 requirements: []
 rubyforge_project: foreigner
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Foreign Keys for Rails