schema_plus_foreign_keys 0.1.8 → 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|
+        create_table :comments, force: true do |t|
           t.references :user
-          t.foreign_key :user_id, :users
+          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.references :user
           t.references :author
         end
 
-        create_table :comments, :force => true do |t|
+        create_table :comments, force: true do |t|
           t.text :body
           t.references :post
-          t.foreign_key :post_id, :posts
+          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.references :post, :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,30 +1,28 @@
 # encoding: utf-8
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe ActiveRecord::Migration do
-  let(:column_type) {
-    Gem::Requirement.new('< 5.1').satisfied_by?(::ActiveRecord.version) ? :integer : :bigint
-  }
-
   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.references :user
-        t.foreign_key :user_id, :users, :primary_key => :id
+        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
@@ -39,18 +37,18 @@ 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.send column_type, :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.send column_type, :user, :foreign_key => true
+        t.send :bigint, :user, foreign_key: true
       end
       expect(@model).to reference(:users, :id).on(:user)
     end
@@ -65,16 +63,16 @@ describe ActiveRecord::Migration do
 
     it "should create foreign key with different reference" do
       recreate_table(@model) do |t|
-        t.references :author, :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.references :author, :foreign_key => hash
+        t.references :author, foreign_key: hash
       end
       expect(hash).to eq(hash_original)
     end
@@ -99,7 +97,7 @@ describe ActiveRecord::Migration do
       recreate_table @model do |t|
         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
@@ -352,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.send column_type, :user_id, foreign_key: true
+          t.send :bigint, :user_id, foreign_key: true
         end
         expect(@model).to reference(:users, :id).on(:user_id)
       end
@@ -373,19 +371,19 @@ describe ActiveRecord::Migration do
     end
 
     it "should create foreign key" do
-      add_column(:post_id, column_type, 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, column_type, :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, column_type, :references => :users) do
+      add_column(:author_id, :bigint, :references => :users) do
         expect(@model).to reference(:users, :id).on(:author_id)
       end
     end
@@ -397,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, column_type, 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, column_type, 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
@@ -412,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, column_type, 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
@@ -421,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, column_type, :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, column_type, 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)
@@ -471,22 +469,22 @@ describe ActiveRecord::Migration do
         end
 
         it "should drop foreign key if it is no longer valid" do
-          change_column :user_id, column_type, :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, column_type, :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, column_type, :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, column_type, :default => 0
+          change_column :user_id, :bigint, :default => 0
           expect(@model).to reference(:users)
         end
 
@@ -495,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
@@ -529,27 +527,6 @@ describe ActiveRecord::Migration do
     end
   end
 
-
-  context "when table is renamed" do
-
-    before(:each) do
-      @model = Comment
-      recreate_table @model do |t|
-        t.references :user, 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
@@ -571,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
-

data/spec/named_schemas_spec.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
-describe "with multiple schemas" do
+describe "with multiple schemas", sqlite3: :skip do
   def connection
     ActiveRecord::Base.connection
   end
@@ -22,7 +24,7 @@ describe "with multiple schemas" 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
     end
@@ -56,8 +58,8 @@ describe "with multiple schemas" do
     end
 
     it "should not find foreign keys in other schema" do
-      connection.create_table :comments, :force => true do |t|
-        t.references :user, :foreign_key => false
+      connection.create_table :comments, force: true do |t|
+        t.references :user, foreign_key: false
       end
       Comment.reset_column_information
       expect(Comment.foreign_keys.length).to eq(0)
@@ -66,8 +68,8 @@ describe "with multiple schemas" do
     end
 
     it "should find foreign keys in this schema" do
-      connection.create_table :comments, :force => true do |t|
-        t.references :user, :foreign_key => true
+      connection.create_table :comments, force: true do |t|
+        t.references :user, foreign_key: true
       end
       Comment.reset_column_information
       expect(Comment.foreign_keys.map(&:column).flatten).to eq(["user_id"])
@@ -80,13 +82,13 @@ describe "with multiple schemas" do
   context "foreign key migrations" do
     before(:each) do
       define_schema do
-        create_table "items", :force => true do |t|
+        create_table "items", force: true do |t|
         end
-        create_table "schema_plus_test2.groups", :force => true do |t|
+        create_table "schema_plus_test2.groups", force: true do |t|
         end
-        create_table "schema_plus_test2.members", :force => true do |t|
-          t.references :item, :foreign_key => true unless SchemaDev::Rspec::Helpers.mysql?
-          t.references :group, :foreign_key => { references: "schema_plus_test2.groups" }
+        create_table "schema_plus_test2.members", force: true do |t|
+          t.references :item, foreign_key: { name: 'fk_test2_members_items' } unless SchemaDev::Rspec::Helpers.mysql?
+          t.references :group, foreign_key: { name: 'fk_test2_members_groups', references: "schema_plus_test2.groups" }
         end
       end
       class Group < ::ActiveRecord::Base
@@ -122,13 +124,13 @@ describe "with multiple schemas" do
       expect(Member.foreign_keys.map(&:to_table)).to include "schema_plus_test2.groups"
     end
 
-    it "should reference table in default schema", :mysql => :skip do
+    it "should reference table in default schema", mysql: :skip do
       expect(Member.foreign_keys.map(&:to_table)).to include "items"
     end
 
     it "should include the schema in the constraint name" do
-      expected_names = ["fk_schema_plus_test2_members_group_id"]
-      expected_names << "fk_schema_plus_test2_members_item_id" unless SchemaDev::Rspec::Helpers.mysql?
+      expected_names = ["fk_test2_members_groups"]
+      expected_names << "fk_test2_members_items" unless SchemaDev::Rspec::Helpers.mysql?
       expect(Member.foreign_keys.map(&:name).sort).to match_array(expected_names.sort)
     end
   end

data/spec/schema_dumper_spec.rb

@@ -1,21 +1,21 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'stringio'
 
 describe "Schema dump" do
-  let(:column_type) { Gem::Requirement.new('< 5.1').satisfied_by?(::ActiveRecord.version) ? :integer : :bigint }
-
   before(:each) do
     ActiveRecord::Migration.suppress_messages do
       ActiveRecord::Schema.define do
         connection.tables_only.each do |table| drop_table table, force: :cascade end
 
-        create_table :users, :force => true do |t|
+        create_table :users, force: true do |t|
           t.string :login
           t.datetime :deleted_at
           t.references :first_post, index: { unique: true }
         end
 
-        create_table :posts, :force => true do |t|
+        create_table :posts, force: true do |t|
           t.text :body
           t.references :user
           t.references :first_comment
@@ -33,7 +33,7 @@ describe "Schema dump" do
           t.boolean :boolean_col
         end
 
-        create_table :comments, :force => true do |t|
+        create_table :comments, force: true do |t|
           t.text :body
           t.references :post
           t.references :commenter
@@ -59,7 +59,7 @@ describe "Schema dump" do
   end
 
   it "should include foreign_key name" do
-    with_foreign_key Post, :user_id, :users, :id, :name => "yippee" do
+    with_foreign_key Post, :user_id, :users, :id, name: "yippee" do
       expect(dump_posts).to match(/user_id.*foreign_key.*users.*:name=>"yippee"/)
     end
   end
@@ -72,7 +72,7 @@ describe "Schema dump" do
 
 
   it "should include foreign_key exactly once" do
-    with_foreign_key Post, :user_id, :users, :id, :name => "yippee" do
+    with_foreign_key Post, :user_id, :users, :id, name: "yippee" do
       expect(dump_posts.scan(/foreign_key.*yippee"/).length).to eq 1
     end
   end
@@ -98,7 +98,7 @@ describe "Schema dump" do
 
     it "should handle regexp in ignore_tables" do
       with_foreign_key Comment, :post_id, :posts, :id do
-        dump = dump_schema(:ignore => /post/)
+        dump = dump_schema(ignore: /post/)
         expect(dump).to match(/create_table "comments"/)
         expect(dump).not_to match(/create_table "posts"/)
       end
@@ -107,12 +107,12 @@ describe "Schema dump" do
   end
 
   it "should include foreign_key options" do
-    with_foreign_key Post, :user_id, :users, :id, :on_update => :cascade, :on_delete => :nullify do
-      expect(dump_posts).to match(%q[t.(integer|bigint)\s*"user_id",.*:foreign_key=>{:references=>"users", :name=>"fk_posts_user_id", :on_update=>:cascade, :on_delete=>:nullify}])
+    with_foreign_key Post, :user_id, :users, :id, on_update: :cascade, on_delete: :nullify do
+      expect(dump_posts).to match(%q[t.(integer|bigint)\s*"user_id",.*:foreign_key=>{:references=>"users", :name=>"fk_rails_\w+", :on_update=>:cascade, :on_delete=>:nullify}])
     end
   end
 
-  context "with cyclic foreign key constraints", :sqlite3 => :skip do
+  context "with cyclic foreign key constraints", sqlite3: :skip do
     before(:each) do
       ActiveRecord::Base.connection.add_foreign_key(Comment.table_name, User.table_name, column: :commenter_id)
       ActiveRecord::Base.connection.add_foreign_key(Comment.table_name, Post.table_name, column: :post_id)
@@ -216,12 +216,12 @@ describe "Schema dump" do
   def with_foreign_keys(model, columnsets)
     table_columns = model.columns.reject{|column| column.name == 'id'}
     ActiveRecord::Migration.suppress_messages do
-      ActiveRecord::Migration.create_table model.table_name, :force => true do |t|
+      ActiveRecord::Migration.create_table model.table_name, force: true do |t|
         table_columns.each do |column|
           t.column column.name, column.type, limit: column.limit
         end
         columnsets.each do |columns, referenced_table_name, referenced_columns, options|
-          t.foreign_key columns, referenced_table_name, (options||{}).merge(primary_key: referenced_columns)
+          t.foreign_key referenced_table_name, **(options||{}).merge(column: columns, primary_key: referenced_columns)
         end
       end
     end

data/spec/spec_helper.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require 'simplecov'
-require 'simplecov-gem-profile'
-SimpleCov.start "gem"
+
+SimpleCov.start
 
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))

data/spec/support/reference.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SchemaPlus::Matchers
 
   class Reference
@@ -22,7 +24,7 @@ module SchemaPlus::Matchers
       @result.keep_if {|fk| fk.on_update == @on_update } if @on_update
       @result.keep_if {|fk| fk.on_delete == @on_delete } if @on_delete
       @result.keep_if {|fk| fk.deferrable == @deferrable } if @deferrable
-      @result.keep_if {|fk| fk.name == @name } if @name
+      @result.keep_if {|fk| @name.is_a?(String) ? fk.name == @name : fk.name.match?(@name) } if @name
       !@result.empty?
     end
 
@@ -76,4 +78,3 @@ module SchemaPlus::Matchers
   end
 
 end
-