schema_plus_foreign_keys 0.1.8 → 1.0.0

data/lib/schema_plus/foreign_keys/active_record/connection_adapters/postgresql_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SchemaPlus::ForeignKeys
   module ActiveRecord
     module ConnectionAdapters
@@ -61,12 +63,12 @@ module SchemaPlus::ForeignKeys
               on_update = ForeignKeyDefinition::ACTION_LOOKUP[on_update] || :no_action
               on_delete = ForeignKeyDefinition::ACTION_LOOKUP[on_delete] || :no_action
 
-              options = { :name => name,
-                          :on_delete => on_delete,
-                          :on_update => on_update,
-                          :column => columns,
-                          :primary_key => primary_keys,
-                          :deferrable => deferrable }
+              options = { name: name,
+                          on_delete: on_delete,
+                          on_update: on_update,
+                          column: columns,
+                          primary_key: primary_keys,
+                          deferrable: deferrable }
 
               foreign_keys << ::ActiveRecord::ConnectionAdapters::ForeignKeyDefinition.new(
                 from_table,

data/lib/schema_plus/foreign_keys/active_record/connection_adapters/sqlite3_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SchemaPlus::ForeignKeys
   module ActiveRecord
     module ConnectionAdapters
@@ -59,12 +61,12 @@ module SchemaPlus::ForeignKeys
               on_delete = ForeignKeyDefinition::ACTION_LOOKUP[on_delete] || :no_action
               deferrable = deferrable ? (initially_deferred ? :initially_deferred : true) : false
 
-              options = { :name => name,
-                          :on_update => on_update,
-                          :on_delete => on_delete,
-                          :column => columns,
-                          :primary_key => primary_keys,
-                          :deferrable => deferrable }
+              options = { name: name,
+                          on_update: on_update,
+                          on_delete: on_delete,
+                          column: columns,
+                          primary_key: primary_keys,
+                          deferrable: deferrable }
 
               foreign_keys << ::ActiveRecord::ConnectionAdapters::ForeignKeyDefinition.new(
                 from_table,

data/lib/schema_plus/foreign_keys/active_record/connection_adapters/table_definition.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SchemaPlus::ForeignKeys::ActiveRecord::ConnectionAdapters
 
   #
@@ -25,7 +27,7 @@ module SchemaPlus::ForeignKeys::ActiveRecord::ConnectionAdapters
   # definition, via:
   #
   #   create_table :widgets do |t|
-  #      t.string :name, :index => true
+  #      t.string :name, index: true
   #   end
   #
   # For details about the :index option (including unique and multi-column indexes), see the
@@ -36,15 +38,15 @@ module SchemaPlus::ForeignKeys::ActiveRecord::ConnectionAdapters
   #    create_table :posts do |t|  # not DRY
   #       t.references :author
   #    end
-  #    add_foreign_key :posts, :author_id, :references => :authors
+  #    add_foreign_key :posts, :author_id, references: :authors
   #
   #    create_table :posts do |t|  # DRYer
   #       t.references :author
-  #       t.foreign_key :author_id, :references => :authors
+  #       t.foreign_key :author_id, references: :authors
   #    end
   #
   #    create_table :posts do |t|  # Dryest
-  #       t.references :author, :foreign_key => true
+  #       t.references :author, foreign_key: true
   #    end
   #
   # <b>NOTE:</b> In the standard configuration, SchemaPlus::ForeignKeys automatically
@@ -59,7 +61,7 @@ module SchemaPlus::ForeignKeys::ActiveRecord::ConnectionAdapters
   # Finally, the configuration for foreign keys can be overriden on a per-table
   # basis by passing Config options to Migration::ClassMethods#create_table, such as
   #
-  #      create_table :students, :foreign_keys => {:auto_create => false} do
+  #      create_table :students, foreign_keys: {auto_create: false} do
   #         t.references :student
   #      end
   #
@@ -67,46 +69,5 @@ module SchemaPlus::ForeignKeys::ActiveRecord::ConnectionAdapters
 
     attr_accessor :schema_plus_foreign_keys_config #:nodoc:
 
-    if Gem::Requirement.new('= 4.2.0').satisfied_by?(::ActiveRecord.version)
-      def foreign_keys
-        @foreign_keys ||= []
-      end
-
-      def foreign_keys_for_table(*)
-        foreign_keys
-      end
-    elsif Gem::Requirement.new('< 4.2.6').satisfied_by?(::ActiveRecord.version)
-      def foreign_keys_for_table(table)
-        foreign_keys[table] ||= []
-      end
-    else
-      def foreign_keys_for_table(*)
-        foreign_keys
-      end
-    end
-
-    def foreign_key(*args) # (column_names, to_table, primary_key=nil, options=nil)
-      options = args.extract_options!
-      case args.length
-      when 1
-        to_table = args[0]
-        column_names = "#{to_table.to_s.singularize}_id"
-      when 2
-        column_names, to_table = args
-      when 3
-        ActiveSupport::Deprecation.warn "positional arg for foreign primary key is deprecated, use :primary_key option instead"
-        column_names, to_table, primary_key = args
-        options.merge!(:primary_key => primary_key)
-      else
-        raise ArgumentError, "wrong number of arguments (#{args.length}) for foreign_key(column_names, table_name, options)"
-      end
-
-      options.merge!(:column => column_names)
-      options.reverse_merge!(:name => ForeignKeyDefinition.default_name(self.name, column_names))
-      fk = ::ActiveRecord::ConnectionAdapters::ForeignKeyDefinition.new(self.name, AbstractAdapter.proper_table_name(to_table), options)
-      foreign_keys_for_table(fk.to_table) << fk
-      self
-    end
-
   end
 end

data/lib/schema_plus/foreign_keys/active_record/migration/command_recorder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SchemaPlus::ForeignKeys
   module ActiveRecord
     module Migration
@@ -6,7 +8,7 @@ module SchemaPlus::ForeignKeys
         attr_accessor :schema_plus_foreign_keys_config #:nodoc:
 
         # seems like this is fixing a rails bug:
-        #   change_table foo, :bulk => true { |t| t.references :bar }
+        #   change_table foo, bulk: true { |t| t.references :bar }
         # results in an 'unknown method :add_reference_sql' (with mysql2)
         #
         # should track it down separately and submit a patch/fix to rails
@@ -16,7 +18,7 @@ module SchemaPlus::ForeignKeys
           options[:references] = nil if polymorphic
           # ugh.  copying and pasting code from ::ActiveRecord::ConnectionAdapters::SchemaStatements#add_reference
           index_options = options.delete(:index)
-          add_column(table_name, "#{ref_name}_id", :integer, options)
+          add_column(table_name, "#{ref_name}_id", :integer, **options)
           add_column(table_name, "#{ref_name}_type", :string, polymorphic.is_a?(Hash) ? polymorphic : options) if polymorphic
           add_index(table_name, polymorphic ? %w[id type].map{ |t| "#{ref_name}_#{t}" } : "#{ref_name}_id", index_options.is_a?(Hash) ? index_options : {}) if index_options
 

data/lib/schema_plus/foreign_keys/middleware/dumper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SchemaPlus::ForeignKeys
   module Middleware
     module Dumper
@@ -37,7 +39,7 @@ module SchemaPlus::ForeignKeys
 
         # Ignore the foreign key dumps at the end of the schema; we'll put them in/near their tables
         def after(env)
-          env.dump.final.reject!(&it =~/foreign_key/)
+          env.dump.final.reject!{ |it| it =~/foreign_key/ }
         end
 
         private
@@ -66,7 +68,7 @@ module SchemaPlus::ForeignKeys
         def after(env)
           dumped = {}
           env.table.columns.each do |column|
-            if (foreign_key = env.dump.data.inline_fks[env.table.name].find(&its.column.to_s == column.name))
+            if (foreign_key = env.dump.data.inline_fks[env.table.name].find { |it| it.column.to_s == column.name })
               column.options[:foreign_key] = {references: foreign_key.to_table}.merge foreign_key.options_for_dump
               dumped[foreign_key] = true
             end

data/lib/schema_plus/foreign_keys/middleware/migration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SchemaPlus::ForeignKeys
   module Middleware
     module Migration
@@ -22,7 +24,13 @@ module SchemaPlus::ForeignKeys
           env.connection.foreign_keys(newname).each do |fk|
             begin
               env.connection.remove_foreign_key(newname, name: fk.name)
-              env.connection.add_foreign_key(newname, fk.to_table, :column => fk.column, :primary_key => fk.primary_key, :name => fk.name.sub(/#{oldname}/, newname), :on_update => fk.on_update, :on_delete => fk.on_delete, :deferrable => fk.deferrable)
+              env.connection.add_foreign_key(newname, fk.to_table,
+                                             column: fk.column,
+                                             primary_key: fk.primary_key,
+                                             name: fk.name.sub(/#{oldname}/, newname),
+                                             on_update: fk.on_update,
+                                             on_delete: fk.on_delete,
+                                             deferrable: fk.deferrable)
             rescue NotImplementedError
               # sqlite3 can't remote or add foreign keys, so just skip it
             end
@@ -123,9 +131,9 @@ module SchemaPlus::ForeignKeys
           references = fk_opts.delete(:references)
           case env.caller
           when ::ActiveRecord::ConnectionAdapters::TableDefinition
-            env.caller.foreign_key(env.column_name, references, fk_opts)
+            env.caller.foreign_key(references, **fk_opts)
           else
-            env.caller.add_foreign_key(env.table_name, references, fk_opts.merge(:column => env.column_name))
+            env.caller.add_foreign_key(env.table_name, references, **fk_opts)
           end
         end
 
@@ -134,6 +142,7 @@ module SchemaPlus::ForeignKeys
           return nil if opts.nil?
           return :none if opts == false
           opts = {} if opts == true
+          opts[:column] ||= env.column_name
           opts[:references] ||= default_table_name(env)
           opts[:on_update] ||= config.on_update
           opts[:on_delete] ||= config.on_delete
@@ -141,7 +150,7 @@ module SchemaPlus::ForeignKeys
         end
 
         def remove_foreign_key_if_exists(env)
-          env.caller.remove_foreign_key(env.table_name.to_s, column: env.column_name.to_s, :if_exists => true)
+          env.caller.remove_foreign_key(env.table_name.to_s, column: env.column_name.to_s, if_exists: true)
         end
 
         def default_table_name(env)
@@ -159,4 +168,3 @@ module SchemaPlus::ForeignKeys
     end
   end
 end
-

data/lib/schema_plus/foreign_keys/middleware/model.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SchemaPlus::ForeignKeys
   module Middleware
 

data/lib/schema_plus/foreign_keys/middleware/mysql.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SchemaPlus::ForeignKeys
   module Middleware
 
@@ -6,7 +8,7 @@ module SchemaPlus::ForeignKeys
         module DropTable
 
           def around(env)
-            if (env.options[:force] == :cascade)
+            if env.options[:force] == :cascade
               env.connection.reverse_foreign_keys(env.table_name).each do |foreign_key|
                 env.connection.remove_foreign_key(foreign_key.from_table, name: foreign_key.name)
               end

data/lib/schema_plus/foreign_keys/middleware/sql.rb

@@ -1,23 +1,9 @@
+# frozen_string_literal: true
+
 module SchemaPlus::ForeignKeys
   module Middleware
     module Sql
       module Table
-        if Gem::Requirement.new('< 5.0').satisfied_by?(::ActiveRecord.version)
-          def after(env)
-            foreign_keys = if env.table_definition.foreign_keys.is_a? Array
-                             env.table_definition.foreign_keys
-                           else
-                             env.table_definition.foreign_keys.values.tap { |v| v.flatten! }
-                           end
-
-            # create foreign key constraints inline in table definition
-            env.sql.body = ([env.sql.body] + foreign_keys.map(&:to_sql)).join(', ')
-
-            # prevents AR >= 4.2.1 from emitting add_foreign_key after the table
-            env.table_definition.foreign_keys.clear
-          end
-        end
-
         module SQLite3
           def before(env)
             env.connection.execute('PRAGMA FOREIGN_KEYS = ON') if env.table_definition.foreign_keys.any?

data/lib/schema_plus/foreign_keys/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module SchemaPlus
   module ForeignKeys
-    VERSION = "0.1.8"
+    VERSION = "1.0.0"
   end
 end

data/lib/schema_plus/foreign_keys.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 require 'schema_plus/core'
 require 'schema_plus_compatibility'
-require 'its-it'
 require 'valuable'
 
 require_relative 'foreign_keys/version'

data/lib/schema_plus_foreign_keys.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require_relative 'schema_plus/foreign_keys'

data/schema_dev.yml

@@ -1,12 +1,10 @@
 ruby:
-    - 2.3.1
+    - 2.5
+    - 2.7
+    - 3.0
 activerecord:
-    - 4.2.0
-    - 4.2.1
-    - 4.2.6
-    - 5.0
-    - 5.1
     - 5.2
+    - 6.0
 db:
     - mysql2
     - sqlite3

data/schema_plus_foreign_keys.gemspec

@@ -1,4 +1,6 @@
 # coding: utf-8
+# frozen_string_literal: true
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'schema_plus/foreign_keys/version'
@@ -18,16 +20,15 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency "activerecord", ">= 4.2", "< 5.3"
-  gem.add_dependency "schema_plus_core"
-  gem.add_dependency "schema_plus_compatibility", "~> 0.2"
+  gem.required_ruby_version = ">= 2.5.0"
+
+  gem.add_dependency "activerecord",  ">= 5.2", "< 6.1"
+  gem.add_dependency "schema_plus_core", "~> 3.0.0"
+  gem.add_dependency "schema_plus_compatibility", "~> 1.0.0"
   gem.add_dependency "valuable"
-  gem.add_dependency "its-it", "~> 1.2"
 
-  gem.add_development_dependency "bundler", "~> 1.7"
-  gem.add_development_dependency "rake", "~> 10.0"
+  gem.add_development_dependency "bundler"
+  gem.add_development_dependency "rake", "~> 13.0"
   gem.add_development_dependency "rspec", "~> 3.0"
-  gem.add_development_dependency "schema_dev", "~> 3.5"
-  gem.add_development_dependency "simplecov"
-  gem.add_development_dependency "simplecov-gem-profile"
+  gem.add_development_dependency "schema_dev", "~> 4.1"
 end

data/spec/deprecation_spec.rb

@@ -1,89 +1,11 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe 'Deprecations' do
 
   let(:migration) { ActiveRecord::Migration }
 
-  describe "on add_foreign_key", sqlite3: :skip do
-    before(:each) do
-      define_schema do
-        create_table :posts
-        create_table :comments do |t|
-          t.references :post
-        end
-      end
-      class Comment < ::ActiveRecord::Base ; end
-    end
-
-    it "deprecates 4-argument form" do
-      expect(ActiveSupport::Deprecation).to receive(:warn).with(/4-argument/)
-      migration.add_foreign_key "comments", "post_id", "posts", "id"
-      expect(Comment).to reference(:posts, :id).on(:post_id)
-    end
-
-  end
-
-  describe "on remove_foreign_key", sqlite3: :skip do
-    before(:each) do
-      define_schema do
-        create_table :posts
-        create_table :comments do |t|
-          t.references :post, foreign_key: true
-        end
-      end
-      class Comment < ::ActiveRecord::Base ; end
-    end
-
-    it "deprecates :column_names option" do
-      expect(ActiveSupport::Deprecation).to receive(:warn).with(/column_names/)
-      migration.remove_foreign_key "comments", "posts", column_names: "post_id"
-      Comment.reset_column_information
-      expect(Comment).to_not reference(:posts, :id).on(:post_id)
-    end
-
-    it "deprecates :references_column_names option" do
-      expect(ActiveSupport::Deprecation).to receive(:warn).with(/references_column_names.*primary_key/)
-      migration.remove_foreign_key "comments", "posts", references_column_names: "id"
-      Comment.reset_column_information
-      expect(Comment).to_not reference(:posts, :id).on(:post_id)
-    end
-
-    it "deprecates :references_table_name option" do
-      expect(ActiveSupport::Deprecation).to receive(:warn).with(/references_table_name.*to_table/)
-      migration.remove_foreign_key "comments", references_table_name: "posts"
-      Comment.reset_column_information
-      expect(Comment).to_not reference(:posts, :id).on(:post_id)
-    end
-
-    it "deprecates table-and-name form" do
-      Comment.reset_column_information
-      name = Comment.foreign_keys.first.name
-      expect(ActiveSupport::Deprecation).to receive(:warn).with(/name.*name: name/)
-      migration.remove_foreign_key "comments", name
-      Comment.reset_column_information
-      expect(Comment).to_not reference(:posts, :id).on(:post_id)
-    end
-
-    it "deprecates 3-argument form" do
-      expect(ActiveSupport::Deprecation).to receive(:warn).with(/3.*-argument/)
-      migration.remove_foreign_key "comments", "post_id", "posts"
-      Comment.reset_column_information
-      expect(Comment).to_not reference(:posts, :id).on(:post_id)
-    end
-
-    it "deprecates 4-argument form" do
-      expect(ActiveSupport::Deprecation).to receive(:warn).with(/4.*-argument/)
-      migration.remove_foreign_key "comments", "post_id", "posts", "id"
-      Comment.reset_column_information
-      expect(Comment).to_not reference(:posts, :id).on(:post_id)
-    end
-
-    it "raises error for 5 arguments" do
-      expect { migration.remove_foreign_key "zip", "a", "dee", "do", "da" }.to raise_error /Wrong number of arguments.*5/
-    end
-
-  end
-
   describe "on foreign key definition" do
     before(:each) do
       define_schema do
@@ -100,26 +22,6 @@ describe 'Deprecations' do
       Comment.foreign_keys.first
     }
 
-    it "deprecates column_names" do
-      expect(ActiveSupport::Deprecation).to receive(:warn).with(/column_names/)
-      expect(definition.column_names).to eq(["post_id"])
-    end
-
-    it "deprecates references_column_names" do
-      expect(ActiveSupport::Deprecation).to receive(:warn).with(/references_column_names.*primary_key/)
-      expect(definition.references_column_names).to eq(["id"])
-    end
-
-    it "deprecates references_table_name" do
-      expect(ActiveSupport::Deprecation).to receive(:warn).with(/references_table_name.*to_table/)
-      expect(definition.references_table_name).to eq("posts")
-    end
-
-    it "deprecates table_name" do
-      expect(ActiveSupport::Deprecation).to receive(:warn).with(/table_name.*from_table/)
-      expect(definition.table_name).to eq("comments")
-    end
-
     it "deprecates :set_null" do
       expect(ActiveSupport::Deprecation).to receive(:warn).with(/set_null.*nullify/)
       allow(ActiveSupport::Deprecation).to receive(:warn).with(/table_exists\? currently checks/)
@@ -135,17 +37,16 @@ describe 'Deprecations' do
   end
 
   describe "in table definition" do
-    it "deprecates 3-column form" do
-      expect(ActiveSupport::Deprecation).to receive(:warn).with(/positional arg.*primary_key/)
-      allow(ActiveSupport::Deprecation).to receive(:warn).with(/table_exists\? currently checks/)
-      define_schema do
-        create_table :posts, primary_key: :funky
-        create_table :comments do |t|
-          t.references :post
-          t.foreign_key :post_id, :posts, :funky
+    it "raises error for 3 arguments" do
+      expect {
+        define_schema do
+          create_table :posts, primary_key: :funky
+          create_table :comments do |t|
+            t.references :post
+            t.foreign_key :post_id, :posts, :funky
+          end
         end
-      end
-      expect(migration.foreign_keys("comments").first.primary_key).to eq("funky")
+      }.to raise_error /wrong number of arguments/i
     end
 
     it "raises error for 4 arguments" do

data/spec/foreign_key_definition_spec.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe "Foreign Key definition" do
 
   let(:definition) {
-    options = {:name => "posts_user_fkey", :column => :user, :primary_key => :id}
+    options = {name: "posts_user_fkey", column: :user, primary_key: :id}
     ::ActiveRecord::ConnectionAdapters::ForeignKeyDefinition.new(:posts, :users, options)
   }
 
@@ -12,13 +14,13 @@ describe "Foreign Key definition" do
   end
 
   it "dumps to sql with deferrable values" do
-    options = {:name => "posts_user_fkey", :column => :user, :primary_key => :id, :deferrable => true}
+    options = {name: "posts_user_fkey", column: :user, primary_key: :id, deferrable: true}
     deferred_definition = ::ActiveRecord::ConnectionAdapters::ForeignKeyDefinition.new(:posts, :users, options)
     expect(deferred_definition.to_sql).to eq(%Q{CONSTRAINT posts_user_fkey FOREIGN KEY (#{quote_column_name('user')}) REFERENCES #{quote_table_name('users')} (#{quote_column_name('id')}) DEFERRABLE})
   end
 
   it "dumps to sql with initially deferrable values" do
-    options = {:name => "posts_user_fkey", :column => :user, :primary_key => :id, :deferrable => :initially_deferred}
+    options = {name: "posts_user_fkey", column: :user, primary_key: :id, deferrable: :initially_deferred}
     initially_deferred_definition = ::ActiveRecord::ConnectionAdapters::ForeignKeyDefinition.new(:posts, :users, options)
     expect(initially_deferred_definition.to_sql).to eq(%Q{CONSTRAINT posts_user_fkey FOREIGN KEY (#{quote_column_name('user')}) REFERENCES #{quote_table_name('users')} (#{quote_column_name('id')}) DEFERRABLE INITIALLY DEFERRED})
   end