schema_plus_foreign_keys 0.1.6 → 1.0.0

data/spec/foreign_key_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe "Foreign Key" do
@@ -7,12 +9,12 @@ describe "Foreign Key" do
   context "created with table" do
     before(:each) do
       define_schema do
-        create_table :users, :force => true do |t|
+        create_table :users, force: true do |t|
           t.string :login
         end
-        create_table :comments, :force => true do |t|
-          t.integer :user_id
-          t.foreign_key :user_id, :users
+        create_table :comments, force: true do |t|
+          t.references :user
+          t.foreign_key :users, column: :user_id
         end
       end
       class User < ::ActiveRecord::Base ; end
@@ -34,21 +36,21 @@ describe "Foreign Key" do
 
     before(:each) do
       define_schema do
-        create_table :users, :force => true do |t|
+        create_table :users, force: true do |t|
           t.string :login
           t.datetime :deleted_at
         end
 
-        create_table :posts, :force => true do |t|
+        create_table :posts, force: true do |t|
           t.text :body
-          t.integer :user_id
-          t.integer :author_id
+          t.references :user
+          t.references :author
         end
 
-        create_table :comments, :force => true do |t|
+        create_table :comments, force: true do |t|
           t.text :body
-          t.integer :post_id
-          t.foreign_key :post_id, :posts
+          t.references :post
+          t.foreign_key :posts, column: :post_id
         end
       end
       class User < ::ActiveRecord::Base ; end
@@ -58,12 +60,12 @@ describe "Foreign Key" do
     end
 
 
-    context "works", :sqlite3 => :skip do
+    context "works", sqlite3: :skip do
 
       context "when is added", "posts(author_id)" do
 
         before(:each) do
-          add_foreign_key(:posts, :users, :column => :author_id, :on_update => :cascade, :on_delete => :restrict)
+          add_foreign_key(:posts, :users, column: :author_id, on_update: :cascade, on_delete: :restrict)
         end
 
         it "references users(id)" do
@@ -90,7 +92,7 @@ describe "Foreign Key" do
 
       context "when is dropped", "comments(post_id)" do
 
-        let(:foreign_key_name) { fk = Comment.foreign_keys.detect(&its.column == 'post_id') and fk.name }
+        let(:foreign_key_name) { fk = Comment.foreign_keys.detect { |it| it.column == 'post_id' } and fk.name }
 
         before(:each) do
           remove_foreign_key(:comments, name: foreign_key_name)
@@ -112,7 +114,7 @@ describe "Foreign Key" do
 
       context "when drop using hash", "comments(post_id)" do
 
-        let(:foreign_key_name) { fk = Comment.foreign_keys.detect(&its.column == 'post_id') and fk.name }
+        let(:foreign_key_name) { fk = Comment.foreign_keys.detect { |it| it.column == 'post_id' } and fk.name }
 
         it "finds by name" do
           remove_foreign_key(:comments, name: foreign_key_name)
@@ -131,7 +133,7 @@ describe "Foreign Key" do
         end
 
         it "does not error with :if_exists" do
-          expect{remove_foreign_key(:comments, "posts", column: "nonesuch", :if_exists => true)}.to_not raise_error
+          expect{remove_foreign_key(:comments, "posts", column: "nonesuch", if_exists: true)}.to_not raise_error
         end
       end
 
@@ -149,8 +151,8 @@ describe "Foreign Key" do
       context "when table name is a reserved word" do
         before(:each) do
           migration.suppress_messages do
-            migration.create_table :references, :force => true do |t|
-              t.integer :post_id, :foreign_key => false
+            migration.create_table :references, force: true do |t|
+              t.references :post, foreign_key: false
             end
           end
         end
@@ -168,11 +170,11 @@ describe "Foreign Key" do
 
     end
 
-    context "raises an exception", :sqlite3 => :only do
+    context "raises an exception", sqlite3: :only do
 
       it "when attempting to add" do
         expect {
-          add_foreign_key(:posts, :users, :column => :author_id, :on_update => :cascade, :on_delete => :restrict)
+          add_foreign_key(:posts, :users, column: :author_id, on_update: :cascade, on_delete: :restrict)
         }.to raise_error(NotImplementedError)
       end
 
@@ -186,18 +188,18 @@ describe "Foreign Key" do
   end
 
   protected
-  def add_foreign_key(*args)
+  def add_foreign_key(*args, **kwargs)
     migration.suppress_messages do
-      migration.add_foreign_key(*args)
+      migration.add_foreign_key(*args, **kwargs)
     end
     User.reset_column_information
     Post.reset_column_information
     Comment.reset_column_information
   end
 
-  def remove_foreign_key(*args)
+  def remove_foreign_key(*args, **kwargs)
     migration.suppress_messages do
-      migration.remove_foreign_key(*args)
+      migration.remove_foreign_key(*args, **kwargs)
     end
     User.reset_column_information
     Post.reset_column_information

data/spec/migration_spec.rb

@@ -1,27 +1,28 @@
 # encoding: utf-8
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe ActiveRecord::Migration do
-
   before(:each) do
     define_schema do
 
-      create_table :users, :force => true do |t|
-        t.string :login, :index => { :unique => true }
+      create_table :users, force: true do |t|
+        t.string :login, index: { unique: true }
       end
 
-      create_table :members, :force => true do |t|
+      create_table :members, force: true do |t|
         t.string :login
       end
 
-      create_table :comments, :force => true do |t|
+      create_table :comments, force: true do |t|
         t.string :content
         t.integer :user
-        t.integer :user_id
-        t.foreign_key :user_id, :users, :primary_key => :id
+        t.references :user
+        t.foreign_key :users, column: :user_id, primary_key: :id
       end
 
-      create_table :posts, :force => true do |t|
+      create_table :posts, force: true do |t|
         t.string :content
       end
     end
@@ -36,25 +37,25 @@ describe ActiveRecord::Migration do
       @model = Post
     end
 
-    it "should enable foreign keys", :sqlite3 => :only do
+    it "should enable foreign keys", sqlite3: :only do
       sql = []
       allow(@model.connection).to receive(:execute) { |str| sql << str }
       recreate_table(@model) do |t|
-        t.integer :user, :foreign_key => true
+        t.send :bigint, :user, foreign_key: true
       end
       expect(sql.join('; ')).to match(/PRAGMA FOREIGN_KEYS = ON.*CREATE TABLE "posts"/)
     end
 
     it "should create foreign key with default reference" do
       recreate_table(@model) do |t|
-        t.integer :user, :foreign_key => true
+        t.send :bigint, :user, foreign_key: true
       end
       expect(@model).to reference(:users, :id).on(:user)
     end
 
     it "should create foreign key with default column" do
       recreate_table(@model) do |t|
-        t.integer :user_id
+        t.references :user
         t.foreign_key :users
       end
       expect(@model).to reference(:users, :id).on(:user_id)
@@ -62,16 +63,16 @@ describe ActiveRecord::Migration do
 
     it "should create foreign key with different reference" do
       recreate_table(@model) do |t|
-        t.integer :author_id, :foreign_key => { :references => :users }
+        t.references :author, foreign_key: { references: :users }
       end
       expect(@model).to reference(:users, :id).on(:author_id)
     end
 
     it "should create foreign key without modifying input hash" do
-      hash = { :references => :users }
+      hash = { references: :users }
       hash_original = hash.dup
       recreate_table(@model) do |t|
-        t.integer :author_id, :foreign_key => hash
+        t.references :author, foreign_key: hash
       end
       expect(hash).to eq(hash_original)
     end
@@ -87,40 +88,40 @@ describe ActiveRecord::Migration do
 
     it "should create foreign key with different reference using shortcut" do
       recreate_table(@model) do |t|
-        t.integer :author_id, :references => :users
+        t.references :author, :references => :users
       end
       expect(@model).to reference(:users, :id).on(:author_id)
     end
 
     it "should create foreign key with default name" do
       recreate_table @model do |t|
-        t.integer :user_id, :foreign_key => true
+        t.references :user, :foreign_key => true
       end
-      expect(@model).to reference(:users, :id).with_name("fk_#{@model.table_name}_user_id")
+      expect(@model).to reference(:users, :id).with_name(/fk_rails_\w+/)
     end
 
     it "should create foreign key with specified name" do
       recreate_table @model do |t|
-        t.integer :user_id, :foreign_key => { :name => "wugga" }
+        t.references :user, :foreign_key => { :name => "wugga" }
       end
       expect(@model).to reference(:users, :id).with_name("wugga")
     end
 
     it "handles very long names" do
       table = ("ta"*15)
-      column = ("co"*15 + "_id")
+      column = ("co"*15)
       expect {
         ActiveRecord::Migration.create_table table do |t|
-          t.integer column, references: :members
+          t.references column, references: :members, index: false
         end
       }.not_to raise_error
-      expect(ActiveRecord::Base.connection.foreign_keys(table).first.column).to eq(column)
+      expect(ActiveRecord::Base.connection.foreign_keys(table).first.column).to eq(column + "_id")
     end
 
     it "should allow multiple foreign keys to be made" do
       recreate_table(@model) do |t|
-        t.integer :user_id, :references => :users
-        t.integer :updater_id, :references => :users
+        t.references :user, :references => :users
+        t.references :updater, :references => :users
       end
       expect(@model).to reference(:users, :id).on(:user_id)
       expect(@model).to reference(:users, :id).on(:updater_id)
@@ -128,14 +129,14 @@ describe ActiveRecord::Migration do
 
     it "should suppress foreign key" do
       recreate_table(@model) do |t|
-        t.integer :member_id, :foreign_key => false
+        t.references :member, :foreign_key => false
       end
       expect(@model).not_to reference.on(:member_id)
     end
 
     it "should suppress foreign key using shortcut" do
       recreate_table(@model) do |t|
-        t.integer :member_id, :references => nil
+        t.references :member, :references => nil
       end
       expect(@model).not_to reference.on(:member_id)
     end
@@ -177,7 +178,7 @@ describe ActiveRecord::Migration do
 
     it "should create foreign key to the same table on parent_id" do
       recreate_table(@model) do |t|
-        t.integer :parent_id, foreign_key: true
+        t.references :parent, foreign_key: true
       end
       expect(@model).to reference(@model.table_name, :id).on(:parent_id)
     end
@@ -195,14 +196,14 @@ describe ActiveRecord::Migration do
 
       it "should create and detect on_update #{action.inspect}", if_action_supported do
         recreate_table @model do |t|
-          t.integer :user_id,   :foreign_key => { :on_update => action }
+          t.references :user,   :foreign_key => { :on_update => action }
         end
         expect(@model).to reference.on(:user_id).on_update(action)
       end
 
       it "should create and detect on_update #{action.inspect} using shortcut", if_action_supported do
         recreate_table @model do |t|
-          t.integer :user_id,   :on_update => action
+          t.references :user,   :on_update => action
         end
         expect(@model).to reference.on(:user_id).on_update(action)
       end
@@ -210,21 +211,21 @@ describe ActiveRecord::Migration do
       it "should raise a not-implemented error for on_update => #{action}", if_action_unsupported do
         expect {
           recreate_table @model do |t|
-            t.integer :user_id, :foreign_key => { :on_update => action }
+            t.references :user, :foreign_key => { :on_update => action }
           end
         }.to raise_error(NotImplementedError)
       end
 
       it "should create and detect on_delete #{action.inspect}", if_action_supported do
         recreate_table @model do |t|
-          t.integer :user_id,   :foreign_key => { :on_delete => action }
+          t.references :user,   :foreign_key => { :on_delete => action }
         end
         expect(@model).to reference.on(:user_id).on_delete(action)
       end
 
       it "should create and detect on_delete #{action.inspect} using shortcut", if_action_supported do
         recreate_table @model do |t|
-          t.integer :user_id,   :on_delete => action
+          t.references :user,   :on_delete => action
         end
         expect(@model).to reference.on(:user_id).on_delete(action)
       end
@@ -232,7 +233,7 @@ describe ActiveRecord::Migration do
       it "should raise a not-implemented error for on_delete => #{action}", if_action_unsupported do
         expect {
           recreate_table @model do |t|
-            t.integer :user_id, :foreign_key => { :on_delete => action }
+            t.references :user, :foreign_key => { :on_delete => action }
           end
         }.to raise_error(NotImplementedError)
       end
@@ -242,7 +243,7 @@ describe ActiveRecord::Migration do
     [false, true, :initially_deferred].each do |status|
       it "should create and detect deferrable #{status.inspect}", :mysql => :skip do
         recreate_table @model do |t|
-          t.integer :user_id,   :on_delete => :cascade, :deferrable => status
+          t.references :user,   :on_delete => :cascade, :deferrable => status
         end
         expect(@model).to reference.on(:user_id).deferrable(status)
       end
@@ -251,7 +252,7 @@ describe ActiveRecord::Migration do
     it "should use default on_delete action" do
       with_fk_config(:on_delete => :cascade) do
         recreate_table @model do |t|
-          t.integer :user_id, foreign_key: true
+          t.references :user, foreign_key: true
         end
         expect(@model).to reference.on(:user_id).on_delete(:cascade)
       end
@@ -260,7 +261,7 @@ describe ActiveRecord::Migration do
     it "should override on_update action per table" do
       with_fk_config(:on_update => :cascade) do
         recreate_table @model, :foreign_keys => {:on_update => :restrict} do |t|
-          t.integer :user_id, foreign_key: true
+          t.references :user, foreign_key: true
         end
         expect(@model).to reference.on(:user_id).on_update(:restrict)
       end
@@ -269,7 +270,7 @@ describe ActiveRecord::Migration do
     it "should override on_delete action per table" do
       with_fk_config(:on_delete => :cascade) do
         recreate_table @model, :foreign_keys => {:on_delete => :restrict} do |t|
-          t.integer :user_id, foreign_key: true
+          t.references :user, foreign_key: true
         end
         expect(@model).to reference.on(:user_id).on_delete(:restrict)
       end
@@ -278,7 +279,7 @@ describe ActiveRecord::Migration do
     it "should override on_update action per column" do
       with_fk_config(:on_update => :cascade) do
         recreate_table @model, :foreign_keys => {:on_update => :restrict} do |t|
-          t.integer :user_id, :foreign_key => { :on_update => :nullify }
+          t.references :user, :foreign_key => { :on_update => :nullify }
         end
         expect(@model).to reference.on(:user_id).on_update(:nullify)
       end
@@ -287,7 +288,7 @@ describe ActiveRecord::Migration do
     it "should override on_delete action per column" do
       with_fk_config(:on_delete => :cascade) do
         recreate_table @model, :foreign_keys => {:on_delete => :restrict} do |t|
-          t.integer :user_id, :foreign_key => { :on_delete => :nullify }
+          t.references :user, :foreign_key => { :on_delete => :nullify }
         end
         expect(@model).to reference.on(:user_id).on_delete(:nullify)
       end
@@ -296,7 +297,7 @@ describe ActiveRecord::Migration do
     it "should raise an error for an invalid on_update action" do
       expect {
         recreate_table @model do |t|
-          t.integer :user_id, :foreign_key => { :on_update => :invalid }
+          t.references :user, :foreign_key => { :on_update => :invalid }
         end
       }.to raise_error(ArgumentError)
     end
@@ -304,7 +305,7 @@ describe ActiveRecord::Migration do
     it "should raise an error for an invalid on_delete action" do
       expect {
         recreate_table @model do |t|
-          t.integer :user_id, :foreign_key => { :on_delete => :invalid }
+          t.references :user, :foreign_key => { :on_delete => :invalid }
         end
       }.to raise_error(ArgumentError)
     end
@@ -315,12 +316,15 @@ describe ActiveRecord::Migration do
     before(:each) do
       @model = Post
     end
-    [false, true].each do |bulk|
+    # Disabling bulk tests on mysql since the mysql adapter does not implement it for add_foreign_key in rails 5.1+
+    bulk_tests = RSpec.configuration.exclusion_filter[:mysql] == :skip ? [false] : [true, false]
+
+    bulk_tests.each do |bulk|
       suffix = bulk ? ' with :bulk option' : ""
 
       it "should create a foreign key constraint"+suffix, :sqlite3 => :skip do
         change_table(@model, :bulk => bulk) do |t|
-          t.integer :user_id, foreign_key: true
+          t.references :user, foreign_key: true
         end
         expect(@model).to reference(:users, :id).on(:user_id)
       end
@@ -329,10 +333,10 @@ describe ActiveRecord::Migration do
         it "should remove a foreign key constraint"+suffix, :sqlite3 => :skip do
           Comment.reset_column_information
           expect(Comment).to reference(:users, :id).on(:user_id)
-          migration = Class.new ::ActiveRecord::Migration do
+          migration = Class.new ::ActiveRecord::Migration.latest_version do
             define_method(:change) {
               change_table("comments", :bulk => bulk) do |t|
-                t.integer :user_id, foreign_key: true
+                t.references :user, foreign_key: true
               end
             }
           end
@@ -346,7 +350,7 @@ describe ActiveRecord::Migration do
 
       it "should create a foreign key constraint using :references"+suffix, :sqlite3 => :skip do
         change_table(@model, :bulk => bulk) do |t|
-          t.references :user, foreign_key: true
+          t.send :bigint, :user_id, foreign_key: true
         end
         expect(@model).to reference(:users, :id).on(:user_id)
       end
@@ -367,19 +371,19 @@ describe ActiveRecord::Migration do
     end
 
     it "should create foreign key" do
-      add_column(:post_id, :integer, foreign_key: true) do
+      add_column(:post_id, :bigint, foreign_key: true) do
         expect(@model).to reference(:posts, :id).on(:post_id)
       end
     end
 
     it "should create foreign key to explicitly given table" do
-      add_column(:author_id, :integer, :foreign_key => { :references => :users }) do
+      add_column(:author_id, :bigint, :foreign_key => { :references => :users }) do
         expect(@model).to reference(:users, :id).on(:author_id)
       end
     end
 
     it "should create foreign key to explicitly given table using shortcut" do
-      add_column(:author_id, :integer, :references => :users) do
+      add_column(:author_id, :bigint, :references => :users) do
         expect(@model).to reference(:users, :id).on(:author_id)
       end
     end
@@ -391,14 +395,14 @@ describe ActiveRecord::Migration do
     end
 
     it "should create foreign key to the same table on parent_id" do
-      add_column(:parent_id, :integer, foreign_key: true) do
+      add_column(:parent_id, :bigint, foreign_key: true) do
         expect(@model).to reference(@model.table_name, :id).on(:parent_id)
       end
     end
 
     it "should use default on_update action" do
       SchemaPlus::ForeignKeys.config.on_update = :cascade
-      add_column(:post_id, :integer, foreign_key: true) do
+      add_column(:post_id, :bigint, foreign_key: true) do
         expect(@model).to reference.on(:post_id).on_update(:cascade)
       end
       SchemaPlus::ForeignKeys.config.on_update = nil
@@ -406,7 +410,7 @@ describe ActiveRecord::Migration do
 
     it "should use default on_delete action" do
       SchemaPlus::ForeignKeys.config.on_delete = :cascade
-      add_column(:post_id, :integer, foreign_key: true) do
+      add_column(:post_id, :bigint, foreign_key: true) do
         expect(@model).to reference.on(:post_id).on_delete(:cascade)
       end
       SchemaPlus::ForeignKeys.config.on_delete = nil
@@ -415,22 +419,22 @@ describe ActiveRecord::Migration do
     it "should allow to overwrite default actions" do
       SchemaPlus::ForeignKeys.config.on_delete = :cascade
       SchemaPlus::ForeignKeys.config.on_update = :restrict
-      add_column(:post_id, :integer, :foreign_key => { :on_update => :nullify, :on_delete => :nullify}) do
+      add_column(:post_id, :bigint, :foreign_key => { :on_update => :nullify, :on_delete => :nullify}) do
         expect(@model).to reference.on(:post_id).on_delete(:nullify).on_update(:nullify)
       end
       SchemaPlus::ForeignKeys.config.on_delete = nil
     end
 
     it "should create foreign key with default name" do
-      add_column(:post_id, :integer, foreign_key: true) do
-        expect(@model).to reference(:posts, :id).with_name("fk_#{@model.table_name}_post_id")
+      add_column(:post_id, :bigint, foreign_key: true) do
+        expect(@model).to reference(:posts, :id).with_name(/fk_rails_\w+/)
       end
     end
 
     protected
-    def add_column(column_name, *args)
+    def add_column(column_name, type, **options)
       table = @model.table_name
-      ActiveRecord::Migration.add_column(table, column_name, *args)
+      ActiveRecord::Migration.add_column(table, column_name, type, **options)
       @model.reset_column_information
       yield if block_given?
       ActiveRecord::Migration.remove_column(table, column_name)
@@ -456,7 +460,7 @@ describe ActiveRecord::Migration do
 
         before(:each) do
           recreate_table @model do |t|
-            t.integer :user_id, foreign_key: true
+            t.references :user, foreign_key: true
           end
         end
 
@@ -465,22 +469,22 @@ describe ActiveRecord::Migration do
         end
 
         it "should drop foreign key if it is no longer valid" do
-          change_column :user_id, :integer, :foreign_key => { :references => :members }
+          change_column :user_id, :bigint, :foreign_key => { :references => :members }
           expect(@model).not_to reference(:users)
         end
 
         it "should drop foreign key if requested to do so" do
-          change_column :user_id, :integer, :foreign_key => { :references => nil }
+          change_column :user_id, :bigint, :foreign_key => { :references => nil }
           expect(@model).not_to reference(:users)
         end
 
         it "should reference pointed table afterwards if new one is created" do
-          change_column :user_id, :integer, :foreign_key => { :references => :members }
+          change_column :user_id, :bigint, :foreign_key => { :references => :members }
           expect(@model).to reference(:members)
         end
 
         it "should maintain foreign key if it's unaffected by change" do
-          change_column :user_id, :integer, :default => 0
+          change_column :user_id, :bigint, :default => 0
           expect(@model).to reference(:users)
         end
 
@@ -489,10 +493,10 @@ describe ActiveRecord::Migration do
     end
 
     protected
-    def change_column(column_name, *args)
+    def change_column(column_name, type, **options)
       table = @model.table_name
       ActiveRecord::Migration.suppress_messages do
-        ActiveRecord::Migration.change_column(table, column_name, *args)
+        ActiveRecord::Migration.change_column(table, column_name, type, **options)
         @model.reset_column_information
       end
     end
@@ -503,7 +507,7 @@ describe ActiveRecord::Migration do
     before(:each) do
       @model = Comment
       recreate_table @model do |t|
-        t.integer :post_id, foreign_key: true
+        t.references :post, foreign_key: true
       end
     end
 
@@ -523,34 +527,13 @@ describe ActiveRecord::Migration do
     end
   end
 
-
-  context "when table is renamed" do
-
-    before(:each) do
-      @model = Comment
-      recreate_table @model do |t|
-        t.integer :user_id, foreign_key: true
-        t.integer :xyz, :index => true
-      end
-      ActiveRecord::Migration.suppress_messages do
-        ActiveRecord::Migration.rename_table @model.table_name, :newname
-      end
-    end
-
-    it "should rename foreign key constraints", :sqlite3 => :skip do
-      expect(ActiveRecord::Base.connection.foreign_keys(:newname).first.name).to match(/newname/)
-    end
-
-  end
-
-
   context "when table with more than one fk constraint is renamed", :sqlite3 => :skip do
 
     before(:each) do
       @model = Comment
       recreate_table @model do |t|
-        t.integer :user_id
-        t.integer :member_id
+        t.references :user
+        t.references :member
       end
       ActiveRecord::Migration.suppress_messages do
         ActiveRecord::Migration.rename_table @model.table_name, :newname
@@ -565,17 +548,16 @@ describe ActiveRecord::Migration do
 
   def recreate_table(model, opts={}, &block)
     ActiveRecord::Migration.suppress_messages do
-      ActiveRecord::Migration.create_table model.table_name, opts.merge(:force => true), &block
+      ActiveRecord::Migration.create_table model.table_name, **opts.merge(:force => true), &block
     end
     model.reset_column_information
   end
 
   def change_table(model, opts={}, &block)
     ActiveRecord::Migration.suppress_messages do
-      ActiveRecord::Migration.change_table model.table_name, opts, &block
+      ActiveRecord::Migration.change_table model.table_name, **opts, &block
     end
     model.reset_column_information
   end
 
 end
-