rubocop-migration 0.2.0 → 0.4.0

data/lib/rubocop/migration/cop_concerns/batch_processing.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Migration
+    module CopConcerns
+      module BatchProcessing
+        BATCH_PROCESSING_METHOD_NAMES = ::Set.new(
+          %i[
+            delete_all
+            update_all
+          ]
+        ).freeze
+
+        class << self
+          def included(klass)
+            super
+            klass.class_eval do
+              # @!method batch_processing?(node)
+              #   @param node [RuboCop::AST::SendNode]
+              #   @return [Boolean]
+              def_node_matcher :batch_processing?, <<~PATTERN
+                (send
+                  !nil?
+                  BATCH_PROCESSING_METHOD_NAMES
+                  ...
+                )
+              PATTERN
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/migration/cop_concerns/column_type_method.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Migration
+    module CopConcerns
+      module ColumnTypeMethod
+        COLUMN_TYPE_METHOD_NAMES = ::Set.new(
+          %i[
+            bigint
+            binary
+            blob
+            boolean
+            date
+            datetime
+            decimal
+            float
+            integer
+            numeric
+            primary_key
+            string
+            text
+            time
+          ]
+        ).freeze
+      end
+    end
+  end
+end

data/lib/rubocop/migration/cop_concerns/disable_ddl_transaction.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Migration
+    module CopConcerns
+      module DisableDdlTransaction
+        class << self
+          def included(klass)
+            super
+            klass.class_eval do
+              # @!method disable_ddl_transaction?(node)
+              #   @param node [RuboCop::AST::SendNode]
+              #   @return [Boolean]
+              def_node_matcher :disable_ddl_transaction?, <<~PATTERN
+                (send
+                  nil?
+                  :disable_ddl_transaction!
+                  ...
+                )
+              PATTERN
+            end
+          end
+        end
+
+        private
+
+        # @param corrector [RuboCop::Cop::Corrector]
+        # @param node [RuboCop::AST::SendNode]
+        # @return [void]
+        def insert_disable_ddl_transaction(
+          corrector,
+          node
+        )
+          corrector.insert_before(
+            node.each_ancestor(:def).first,
+            "disable_ddl_transaction!\n\n  "
+          )
+        end
+
+        # @param node [RuboCop::AST::SendNode]
+        # @return [Boolean]
+        def within_disable_ddl_transaction?(node)
+          node.each_ancestor(:def).first&.left_siblings&.any? do |sibling|
+            sibling.is_a?(::RuboCop::AST::SendNode) &&
+              disable_ddl_transaction?(sibling)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/migration/cop_concerns.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Migration
+    module CopConcerns
+      autoload :BatchProcessing, 'rubocop/migration/cop_concerns/batch_processing'
+      autoload :ColumnTypeMethod, 'rubocop/migration/cop_concerns/column_type_method'
+      autoload :DisableDdlTransaction, 'rubocop/migration/cop_concerns/disable_ddl_transaction'
+    end
+  end
+end

data/lib/rubocop/migration/rubocop_extension.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+require_relative 'config_loader'
+
+RuboCop::ConfigLoader.instance_variable_set(
+  :@default_configuration,
+  RuboCop::Migration::ConfigLoader.call(
+    path: ::File.expand_path(
+      '../../../config/default.yml',
+      __dir__
+    )
+  )
+)

data/lib/rubocop/migration/version.rb

@@ -1,5 +1,7 @@
-module RuboCop
+# frozen_string_literal: true
+
+module Rubocop
   module Migration
-    VERSION = "0.2.0"
+    VERSION = '0.4.0'
   end
 end

data/lib/rubocop/migration.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative 'migration/cop_concerns'
+require_relative 'migration/rubocop_extension'
+require_relative 'migration/version'
+
+require_relative 'cop/migration/add_check_constraint'
+require_relative 'cop/migration/add_column_with_default_value'
+require_relative 'cop/migration/add_foreign_key'
+require_relative 'cop/migration/add_index_columns_count'
+require_relative 'cop/migration/add_index_concurrently'
+require_relative 'cop/migration/add_index_duplicate'
+require_relative 'cop/migration/batch_in_batches'
+require_relative 'cop/migration/batch_in_transaction'
+require_relative 'cop/migration/batch_with_throttling'
+require_relative 'cop/migration/change_column'
+require_relative 'cop/migration/change_column_null'
+require_relative 'cop/migration/create_table_force'
+require_relative 'cop/migration/jsonb'
+require_relative 'cop/migration/remove_column'
+require_relative 'cop/migration/rename_column'
+require_relative 'cop/migration/rename_table'
+require_relative 'cop/migration/reserved_word_mysql'

data/rubocop-migration.gemspec

@@ -1,38 +1,32 @@
-# coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "rubocop/migration/version"
+# frozen_string_literal: true
 
-Gem::Specification.new do |spec|
-  spec.name          = "rubocop-migration"
-  spec.version       = RuboCop::Migration::VERSION
-  spec.authors       = ["Peter Graham"]
-  spec.email         = ["peter@wealthsimple.com"]
+require_relative 'lib/rubocop/migration/version'
 
-  spec.summary       = %q{RuboCop extension for ActiveRecord migrations.}
-  spec.description   = %q{RuboCop extension to catch common pitfalls in ActiveRecord migrations.}
-  spec.homepage      = "https://github.com/wealthsimple/rubocop-migration"
+Gem::Specification.new do |spec|
+  spec.name = 'rubocop-migration'
+  spec.version = Rubocop::Migration::VERSION
+  spec.authors = ['Ryo Nakamura']
+  spec.email = ['r7kamura@gmail.com']
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-  spec.license       = "MIT"
+  spec.summary = 'RuboCop extension focused on ActiveRecord migration.'
+  spec.homepage = 'https://github.com/r7kamura/rubocop-migration'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.7'
 
-  spec.required_ruby_version = ">= 2.3.0"
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/releases"
 
-  spec.add_dependency "activesupport", ">= 4"
-  spec.add_dependency "activerecord", ">= 4"
-  spec.add_dependency "strong_migrations", "~> 0.1"
-  spec.add_dependency "rubocop", ">= 0.48.0"
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.14"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rspec-its"
-  spec.add_development_dependency "rspec-collection_matchers"
-  spec.add_development_dependency "rspec_junit_formatter", "~> 0.2"
-  spec.add_development_dependency "pry"
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'rubocop', '>= 1.34'
+  spec.add_dependency 'rubocop-rails'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-migration
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
-- Peter Graham
+- Ryo Nakamura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-10 00:00:00.000000000 Z
+date: 2022-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,179 +16,92 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4'
-- !ruby/object:Gem::Dependency
-  name: activerecord
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
-- !ruby/object:Gem::Dependency
-  name: strong_migrations
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.48.0
+        version: '1.34'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.48.0
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.14'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '1.34'
 - !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rspec-its
-  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: rspec-collection_matchers
+  name: rubocop-rails
   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: rspec_junit_formatter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: RuboCop extension to catch common pitfalls in ActiveRecord migrations.
+description: 
 email:
-- peter@wealthsimple.com
+- r7kamura@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
+- LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
-- circle.yml
-- lib/rubocop-migration.rb
-- lib/rubocop/cop/migration/unsafe_migration.rb
-- lib/rubocop/migration/strong_migrations_checker.rb
+- config/default.yml
+- data/reserved_words_mysql.txt
+- lib/rubocop/cop/migration/add_check_constraint.rb
+- lib/rubocop/cop/migration/add_column_with_default_value.rb
+- lib/rubocop/cop/migration/add_foreign_key.rb
+- lib/rubocop/cop/migration/add_index_columns_count.rb
+- lib/rubocop/cop/migration/add_index_concurrently.rb
+- lib/rubocop/cop/migration/add_index_duplicate.rb
+- lib/rubocop/cop/migration/batch_in_batches.rb
+- lib/rubocop/cop/migration/batch_in_transaction.rb
+- lib/rubocop/cop/migration/batch_with_throttling.rb
+- lib/rubocop/cop/migration/change_column.rb
+- lib/rubocop/cop/migration/change_column_null.rb
+- lib/rubocop/cop/migration/create_table_force.rb
+- lib/rubocop/cop/migration/jsonb.rb
+- lib/rubocop/cop/migration/remove_column.rb
+- lib/rubocop/cop/migration/rename_column.rb
+- lib/rubocop/cop/migration/rename_table.rb
+- lib/rubocop/cop/migration/reserved_word_mysql.rb
+- lib/rubocop/migration.rb
+- lib/rubocop/migration/config_loader.rb
+- lib/rubocop/migration/cop_concerns.rb
+- lib/rubocop/migration/cop_concerns/batch_processing.rb
+- lib/rubocop/migration/cop_concerns/column_type_method.rb
+- lib/rubocop/migration/cop_concerns/disable_ddl_transaction.rb
+- lib/rubocop/migration/rubocop_extension.rb
 - lib/rubocop/migration/version.rb
 - rubocop-migration.gemspec
-- vendor/.gitkeep
-homepage: https://github.com/wealthsimple/rubocop-migration
+homepage: https://github.com/r7kamura/rubocop-migration
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/r7kamura/rubocop-migration
+  source_code_uri: https://github.com/r7kamura/rubocop-migration
+  changelog_uri: https://github.com/r7kamura/rubocop-migration/releases
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -197,16 +110,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
-summary: RuboCop extension for ActiveRecord migrations.
+summary: RuboCop extension focused on ActiveRecord migration.
 test_files: []

data/.gitignore

@@ -1,15 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status
-
-/vendor/rubocop
-*.gem

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "rubocop-migration"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/circle.yml

@@ -1,6 +0,0 @@
-machine:
-  ruby:
-    version: 2.3.0
-dependencies:
-  pre:
-    - git clone --depth 1 git://github.com/bbatsov/rubocop.git vendor/rubocop

data/lib/rubocop/cop/migration/unsafe_migration.rb

@@ -1,69 +0,0 @@
-module RuboCop
-  module Cop
-    module Migration
-      class UnsafeMigration < Cop
-        # List of all public methods that can be used within a migration method,
-        # like `add_index`, `rename_table`, etc.
-        SCHEMA_STATEMENTS = ActiveRecord::ConnectionAdapters::SchemaStatements
-          .public_instance_methods
-          .freeze
-        SCHEMA_STATEMENTS_PATTERN = SCHEMA_STATEMENTS.map { |s| ":#{s}" }.join(" ")
-
-        ERROR_NOTICE = "Ignore this warning by inserting `# rubocop:disable UnsafeMigration`\nabove your code and `# rubocop:enable UnsafeMigration` below code.".freeze
-
-        # Match `ActiveRecord::Migration` and `ActiveRecord::Migration[5.0]`
-        def_node_matcher :migration_class?, <<-PATTERN
-          {
-            (class
-              (const nil _)
-              (const
-                (const nil :ActiveRecord) :Migration) ...)
-
-            (class
-              (const nil _)
-              (send
-                (const
-                  (const nil :ActiveRecord) :Migration) :[] _) ...)
-          }
-        PATTERN
-
-        # `down` migrations can be ignored as they should not be run in
-        # production environments per:
-        # https://github.com/ankane/strong_migrations/commit/fcfbcb4b1bef6a1ed9ec4808268ed0e684ec4389
-        def_node_matcher :migration_method_match, <<-PATTERN
-          (def {:change :up} args $...)
-        PATTERN
-
-        def_node_search :schema_statement_match, <<-PATTERN
-          $(send nil ${#{SCHEMA_STATEMENTS_PATTERN}} $...)
-        PATTERN
-
-        def investigate(processed_source)
-          ast = processed_source.ast
-          return if !ast || !migration_class?(ast)
-          ast.each_child_node do |child_node|
-            migration_methods = migration_method_match(child_node)
-            migration_methods&.each { |method_node| investigate_migration_method(method_node) }
-          end
-        end
-
-        private
-
-        def investigate_migration_method(method_node)
-          schema_statement_match(method_node) do |statement_node, method_name, args_nodes|
-            # TODO: Better/safer way to do this?
-            args_source = "[#{args_nodes.map(&:source).join(', ')}]"
-            args = eval(args_source)
-
-            checker = RuboCop::Migration::StrongMigrationsChecker.new
-            error = checker.check_operation(method_name, *args)
-            if error
-              error += "\n#{ERROR_NOTICE}"
-              add_offense(statement_node, :expression, error)
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/rubocop/migration/strong_migrations_checker.rb

@@ -1,47 +0,0 @@
-module RuboCop
-  module Migration
-    class StrongMigrationsChecker
-      include StrongMigrations::Migration
-
-      # StrongMigrations raises errors for potentially unsafe code, and relies
-      # on the user to add a `safety_assured { }` block to supress this warning.
-      # These warnings are unsupported by rubocop-migration for now.
-      SAFETY_ASSURED_WARNINGS = [
-        :add_column_json,
-        :add_index_columns,
-        :change_table,
-        :execute,
-        :remove_column,
-      ].freeze
-
-      def version_safe?
-        false
-      end
-
-      def postgresql?
-        true
-      end
-
-      def check_operation(method_name, *args)
-        send(method_name, *args)
-      rescue StrongMigrations::UnsafeMigration => e
-        strip_wait_message(e.message)
-      rescue NoMethodError
-        # Do nothing, this method is unrecognized by StrongMigrations unsafe
-        # operations and is likely safe.
-      end
-
-      private
-
-      def raise_error(message_key)
-        return if SAFETY_ASSURED_WARNINGS.include?(message_key)
-        super(message_key)
-      end
-
-      # Strip large "WAIT!" ASCII art from the StrongMigrations error message.
-      def strip_wait_message(error_message)
-        error_message.split("\n\n", 2).last
-      end
-    end
-  end
-end