sevencop 0.22.0 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2aff4e0e776ef3fa5b3f71ece7b7c83013caadaf829fc86827ab246f5f80382
-  data.tar.gz: 1889785ce282e4d530c7eef4a54afaa948181b1557e788425e9b30e831935b77
+  metadata.gz: 0f1682050c56b200417e16dfd5e9f90898838834b29609ef01548b40ab4d4700
+  data.tar.gz: f44e1c9e38ee48b6719e7df278d7858d9f6dc846c3469a96d11975b5a0d572b9
 SHA512:
-  metadata.gz: 386a275378516b205cbd1dc4d50226776d106dc98eb8c534973ff7379c39b59f0e49ae4985058f79254d2256a09ac459b6357e1c5d0f03a8e2d780ec8b1fc990
-  data.tar.gz: 91adea811d280655577fd88cdb4b861b3a9e04f4c89d9542a4ce38281f325cfe0be590cb45ce8937375b4d13e67970518e6381531f46087689e58f3b8d0c5156
+  metadata.gz: 5c3fe3df83f0a4aef3503cfe39d8d82262c1dfd3bdd5b8745922a2649991d56c208d9a6ccc8a6b2f87757e7cdb1423e33f97869a39f4172984c15b4941797df9
+  data.tar.gz: e9dc4ceaac5717391ba294a3995572e9cce89f3316104d2e2139af30fc994d60a9e13c0ee2eb864566b27b2e6d04ff634f0b714d1d93c0ce1f4d969294bf2da9

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sevencop (0.22.0)
+    sevencop (0.23.0)
       activesupport
       rubocop
 

data/README.md

@@ -38,22 +38,6 @@ Note that all cops are `Enabled: false` by default.
 - [Sevencop/MethodDefinitionOrdered](lib/rubocop/cop/sevencop/method_definition_ordered.rb)
 - [Sevencop/RailsBelongsToOptional](lib/rubocop/cop/sevencop/rails_belongs_to_optional.rb)
 - [Sevencop/RailsInferredSpecType](lib/rubocop/cop/sevencop/rails_inferred_spec_type.rb)
-- [Sevencop/RailsMigrationAddCheckConstraint](lib/rubocop/cop/sevencop/rails_migration_add_check_constraint.rb)
-- [Sevencop/RailsMigrationAddColumnWithDefaultValue](lib/rubocop/cop/sevencop/rails_migration_add_column_with_default_value.rb)
-- [Sevencop/RailsMigrationAddForeignKey](lib/rubocop/cop/sevencop/rails_migration_add_foreign_key.rb)
-- [Sevencop/RailsMigrationAddIndexConcurrently](lib/rubocop/cop/sevencop/rails_migration_add_index_concurrently.rb)
-- [Sevencop/RailsMigrationBatchInBatches](lib/rubocop/cop/sevencop/rails_migration_batch_in_batches.rb)
-- [Sevencop/RailsMigrationBatchInTransaction](lib/rubocop/cop/sevencop/rails_migration_batch_in_transaction.rb)
-- [Sevencop/RailsMigrationBatchWithThrottling](lib/rubocop/cop/sevencop/rails_migration_batch_with_throttling.rb)
-- [Sevencop/RailsMigrationChangeColumn](lib/rubocop/cop/sevencop/rails_migration_change_column.rb)
-- [Sevencop/RailsMigrationChangeColumnNull](lib/rubocop/cop/sevencop/rails_migration_change_column_null.rb)
-- [Sevencop/RailsMigrationCreateTableForce](lib/rubocop/cop/sevencop/rails_migration_create_table_force.rb)
-- [Sevencop/RailsMigrationJsonb](lib/rubocop/cop/sevencop/rails_migration_jsonb.rb)
-- [Sevencop/RailsMigrationRemoveColumn](lib/rubocop/cop/sevencop/rails_migration_remove_column.rb)
-- [Sevencop/RailsMigrationRenameColumn](lib/rubocop/cop/sevencop/rails_migration_rename_column.rb)
-- [Sevencop/RailsMigrationRenameTable](lib/rubocop/cop/sevencop/rails_migration_rename_table.rb)
-- [Sevencop/RailsMigrationReservedWordMysql](lib/rubocop/cop/sevencop/rails_migration_reserved_word_mysql.rb)
-- [Sevencop/RailsMigrationUniqueIndexColumnsCount](lib/rubocop/cop/sevencop/rails_migration_unique_index_columns_count.rb)
 - [Sevencop/RailsOrderField](lib/rubocop/cop/sevencop/rails_order_field.rb)
 - [Sevencop/RailsUniquenessValidatorExplicitCaseSensitivity](lib/rubocop/cop/sevencop/rails_uniqueness_validator_explicit_case_sensitivity.rb)
 - [Sevencop/RailsWhereNot](lib/rubocop/cop/sevencop/rails_where_not.rb)

data/config/default.yml

@@ -82,149 +82,6 @@ Sevencop/RailsInferredSpecType:
   Safe: false
   VersionAdded: '0.9'
 
-Sevencop/RailsMigrationAddCheckConstraint:
-  Description: |
-    Activate a check constraint in a separate migration in PostgreSQL.
-  Enabled: false
-  Safe: false
-  VersionAdded: '0.22'
-  Include:
-    - db/migrate/**/*.rb
-
-Sevencop/RailsMigrationAddColumnWithDefaultValue:
-  Description: |
-    Add the column without a default value then change the default.
-  Enabled: false
-  Safe: false
-  VersionAdded: '0.22'
-  Include:
-    - db/migrate/**/*.rb
-
-Sevencop/RailsMigrationAddForeignKey:
-  Description: |
-    Activate a foreign key validation in a separate migration in PostgreSQL.
-  Enabled: false
-  Safe: false
-  VersionAdded: '0.22'
-  Include:
-    - db/migrate/**/*.rb
-
-Sevencop/RailsMigrationAddIndexConcurrently:
-  Description: |
-    Use `algorithm: :concurrently` on adding indexes to existing tables in PostgreSQL.
-  Enabled: false
-  Safe: false
-  VersionAdded: '0.22'
-  Include:
-    - db/migrate/**/*.rb
-
-Sevencop/RailsMigrationBatchInBatches:
-  Description: |
-    Use `in_batches` in batch processing.
-  Enabled: false
-  Safe: false
-  VersionAdded: '0.22'
-  Include:
-    - db/migrate/**/*.rb
-
-Sevencop/RailsMigrationBatchInTransaction:
-  Description: |
-    Disable transaction in batch processing.
-  Enabled: false
-  Safe: false
-  VersionAdded: '0.22'
-  Include:
-    - db/migrate/**/*.rb
-
-Sevencop/RailsMigrationBatchWithThrottling:
-  Description: |
-    Use throttling in batch processing.
-  Enabled: false
-  Safe: false
-  VersionAdded: '0.22'
-  Include:
-    - db/migrate/**/*.rb
-
-Sevencop/RailsMigrationCreateTableForce:
-  Description: |
-    Create tables without `force: true` option.
-  Enabled: false
-  VersionAdded: '0.22'
-  Include:
-    - db/migrate/**/*.rb
-
-Sevencop/RailsMigrationJsonb:
-  Description: |
-    Prefer `jsonb` to `json`.
-  Enabled: false
-  Safe: false
-  VersionAdded: '0.22'
-  Include:
-    - db/migrate/**/*.rb
-
-Sevencop/RailsMigrationChangeColumn:
-  Description: |
-    Avoid changing column type that is in use.
-  Enabled: false
-  Safe: false
-  VersionAdded: '0.22'
-  Include:
-    - db/migrate/**/*.rb
-
-Sevencop/RailsMigrationChangeColumnNull:
-  Description: |
-    Avoid simply setting `NOT NULL` constraint on an existing column in PostgreSQL.
-  Enabled: false
-  Safe: false
-  VersionAdded: '0.22'
-  Include:
-    - db/migrate/**/*.rb
-
-Sevencop/RailsMigrationRemoveColumn:
-  Description: |
-    Add to `ignored_columns` and then remove the column.
-  Enabled: false
-  Safe: false
-  VersionAdded: '0.22'
-  Include:
-    - db/migrate/**/*.rb
-
-Sevencop/RailsMigrationRenameColumn:
-  Description: |
-    Avoid renaming columns that are in use.
-  Enabled: false
-  Safe: false
-  VersionAdded: '0.22'
-  Include:
-    - db/migrate/**/*.rb
-
-Sevencop/RailsMigrationRenameTable:
-  Description: |
-    Avoid removing tables that are in use.
-  Enabled: false
-  Safe: false
-  VersionAdded: '0.22'
-  Include:
-    - db/migrate/**/*.rb
-
-Sevencop/RailsMigrationReservedWordMysql:
-  Description: |
-    Avoid using MySQL reserved words as identifiers.
-  Enabled: false
-  Safe: false
-  VersionAdded: '0.20'
-  Include:
-    - db/migrate/**/*.rb
-
-Sevencop/RailsMigrationUniqueIndexColumnsCount:
-  Description: |
-    Keep unique index columns count less than a specified number.
-  Enabled: false
-  VersionAdded: '0.22'
-  MaxColumnsCount: 3
-  Include:
-    - db/migrate/**/*.rb
-
 Sevencop/RailsOrderField:
   Description: |
     Wrap safe SQL String by `Arel.sql`.

data/lib/sevencop/cop_concerns.rb

@@ -2,9 +2,6 @@
 
 module Sevencop
   module CopConcerns
-    autoload :BatchProcessing, 'sevencop/cop_concerns/batch_processing'
-    autoload :ColumnTypeMethod, 'sevencop/cop_concerns/column_type_method'
-    autoload :DisableDdlTransaction, 'sevencop/cop_concerns/disable_ddl_transaction'
     autoload :Ordered, 'sevencop/cop_concerns/ordered'
   end
 end

data/lib/sevencop/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sevencop
-  VERSION = '0.22.0'
+  VERSION = '0.23.0'
 end

data/lib/sevencop.rb

@@ -14,22 +14,6 @@ require_relative 'rubocop/cop/sevencop/method_definition_keyword_argument_ordere
 require_relative 'rubocop/cop/sevencop/method_definition_ordered'
 require_relative 'rubocop/cop/sevencop/rails_belongs_to_optional'
 require_relative 'rubocop/cop/sevencop/rails_inferred_spec_type'
-require_relative 'rubocop/cop/sevencop/rails_migration_add_check_constraint'
-require_relative 'rubocop/cop/sevencop/rails_migration_add_column_with_default_value'
-require_relative 'rubocop/cop/sevencop/rails_migration_add_foreign_key'
-require_relative 'rubocop/cop/sevencop/rails_migration_add_index_concurrently'
-require_relative 'rubocop/cop/sevencop/rails_migration_batch_in_batches'
-require_relative 'rubocop/cop/sevencop/rails_migration_batch_in_transaction'
-require_relative 'rubocop/cop/sevencop/rails_migration_batch_with_throttling'
-require_relative 'rubocop/cop/sevencop/rails_migration_change_column'
-require_relative 'rubocop/cop/sevencop/rails_migration_change_column_null'
-require_relative 'rubocop/cop/sevencop/rails_migration_create_table_force'
-require_relative 'rubocop/cop/sevencop/rails_migration_jsonb'
-require_relative 'rubocop/cop/sevencop/rails_migration_remove_column'
-require_relative 'rubocop/cop/sevencop/rails_migration_rename_column'
-require_relative 'rubocop/cop/sevencop/rails_migration_rename_table'
-require_relative 'rubocop/cop/sevencop/rails_migration_reserved_word_mysql'
-require_relative 'rubocop/cop/sevencop/rails_migration_unique_index_columns_count'
 require_relative 'rubocop/cop/sevencop/rails_order_field'
 require_relative 'rubocop/cop/sevencop/rails_uniqueness_validator_explicit_case_sensitivity'
 require_relative 'rubocop/cop/sevencop/rails_where_not'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sevencop
 version: !ruby/object:Gem::Version
-  version: 0.22.0
+  version: 0.23.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-16 00:00:00.000000000 Z
+date: 2022-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -66,22 +66,6 @@ files:
 - lib/rubocop/cop/sevencop/method_definition_ordered.rb
 - lib/rubocop/cop/sevencop/rails_belongs_to_optional.rb
 - lib/rubocop/cop/sevencop/rails_inferred_spec_type.rb
-- lib/rubocop/cop/sevencop/rails_migration_add_check_constraint.rb
-- lib/rubocop/cop/sevencop/rails_migration_add_column_with_default_value.rb
-- lib/rubocop/cop/sevencop/rails_migration_add_foreign_key.rb
-- lib/rubocop/cop/sevencop/rails_migration_add_index_concurrently.rb
-- lib/rubocop/cop/sevencop/rails_migration_batch_in_batches.rb
-- lib/rubocop/cop/sevencop/rails_migration_batch_in_transaction.rb
-- lib/rubocop/cop/sevencop/rails_migration_batch_with_throttling.rb
-- lib/rubocop/cop/sevencop/rails_migration_change_column.rb
-- lib/rubocop/cop/sevencop/rails_migration_change_column_null.rb
-- lib/rubocop/cop/sevencop/rails_migration_create_table_force.rb
-- lib/rubocop/cop/sevencop/rails_migration_jsonb.rb
-- lib/rubocop/cop/sevencop/rails_migration_remove_column.rb
-- lib/rubocop/cop/sevencop/rails_migration_rename_column.rb
-- lib/rubocop/cop/sevencop/rails_migration_rename_table.rb
-- lib/rubocop/cop/sevencop/rails_migration_reserved_word_mysql.rb
-- lib/rubocop/cop/sevencop/rails_migration_unique_index_columns_count.rb
 - lib/rubocop/cop/sevencop/rails_order_field.rb
 - lib/rubocop/cop/sevencop/rails_uniqueness_validator_explicit_case_sensitivity.rb
 - lib/rubocop/cop/sevencop/rails_where_not.rb
@@ -91,9 +75,6 @@ files:
 - lib/sevencop.rb
 - lib/sevencop/config_loader.rb
 - lib/sevencop/cop_concerns.rb
-- lib/sevencop/cop_concerns/batch_processing.rb
-- lib/sevencop/cop_concerns/column_type_method.rb
-- lib/sevencop/cop_concerns/disable_ddl_transaction.rb
 - lib/sevencop/cop_concerns/ordered.rb
 - lib/sevencop/rubocop_extension.rb
 - lib/sevencop/version.rb

data/lib/rubocop/cop/sevencop/rails_migration_add_check_constraint.rb

@@ -1,111 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module Sevencop
-      # Activate a check constraint in a separate migration in PostgreSQL.
-      #
-      # Adding a check constraint without `NOT VALID` blocks reads and writes in Postgres and
-      # blocks writes in MySQL and MariaDB while every row is checked.
-      #
-      # @safety
-      #   Only meaningful in PostgreSQL.
-      #
-      # @example
-      #   # bad
-      #   class AddCheckConstraintToOrdersPrice < ActiveRecord::Migration[7.0]
-      #     def change
-      #       add_check_constraint :orders, 'price > 0', name: 'orders_price_positive'
-      #     end
-      #   end
-      #
-      #   # good
-      #   class AddCheckConstraintToOrdersPriceWithoutValidation < ActiveRecord::Migration[7.0]
-      #     def change
-      #       add_check_constraint :orders, 'price > 0', name: 'orders_price_positive', validate: false
-      #     end
-      #   end
-      #
-      #   class ActivateCheckConstraintOnOrdersPrice < ActiveRecord::Migration[7.0]
-      #     def change
-      #       validate_check_constraint :orders, name: 'orders_price_positive'
-      #     end
-      #   end
-      class RailsMigrationAddCheckConstraint < RuboCop::Cop::Base
-        extend AutoCorrector
-
-        MSG = 'Activate a check constraint in a separate migration in PostgreSQL.'
-
-        RESTRICT_ON_SEND = %i[
-          add_check_constraint
-        ].freeze
-
-        # @param node [RuboCop::AST::SendNode]
-        # @return [void]
-        def on_send(node)
-          return unless bad?(node)
-
-          add_offense(node) do |corrector|
-            autocorrect(corrector, node)
-          end
-        end
-
-        private
-
-        # @!method add_check_constraint?(node)
-        #   @param node [RuboCop::AST::SendNode]
-        #   @return [Boolean]
-        def_node_matcher :add_check_constraint?, <<~PATTERN
-          (send
-            nil?
-            :add_check_constraint
-            ...
-          )
-        PATTERN
-
-        # @!method add_check_constraint_with_validate_false?(node)
-        #   @param node [RuboCop::AST::SendNode]
-        #   @return [Boolean]
-        def_node_matcher :add_check_constraint_with_validate_false?, <<~PATTERN
-          (send
-            nil?
-            :add_check_constraint
-            _
-            _
-            (hash
-              <
-                (pair
-                  (sym :validate)
-                  false
-                )
-                ...
-              >
-            )
-          )
-        PATTERN
-
-        # @param corrector [RuboCop::Cop::Corrector]
-        # @param node [RuboCop::AST::SendNode]
-        # @return [void]
-        def autocorrect(
-          corrector,
-          node
-        )
-          target = node.last_argument
-          target = target.pairs.last if target.hash_type?
-          corrector.insert_after(
-            target,
-            ', validate: false'
-          )
-        end
-
-        # @param node [RuboCop::AST::SendNode]
-        # @return [Boolean]
-        def bad?(node)
-          add_check_constraint?(node) &&
-            !add_check_constraint_with_validate_false?(node)
-        end
-      end
-    end
-  end
-end

data/lib/rubocop/cop/sevencop/rails_migration_add_column_with_default_value.rb

@@ -1,229 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module Sevencop
-      # Add the column without a default value then change the default.
-      #
-      # In earlier versions of Postgres, MySQL, and MariaDB,
-      # adding a column with a default value to an existing table causes the entire table to be rewritten.
-      # During this time, reads and writes are blocked in Postgres, and writes are blocked in MySQL and MariaDB.
-      #
-      # @safety
-      #   Only meaningful in earlier versions of Postgres, MySQL, and MariaDB.
-      #
-      # @example
-      #   # bad
-      #   class AddSomeColumnToUsers < ActiveRecord::Migration[7.0]
-      #     def change
-      #       add_column :users, :some_column, :string, default: 'some value'
-      #     end
-      #   end
-      #
-      #   # good
-      #   class AddSomeColumnToUsers < ActiveRecord::Migration[7.0]
-      #     def change
-      #       add_column :users, :some_column, :string
-      #       change_column_default :users, :some_column, 'some value'
-      #     end
-      #   end
-      class RailsMigrationAddColumnWithDefaultValue < RuboCop::Cop::Base
-        extend AutoCorrector
-
-        include RangeHelp
-        include ::Sevencop::CopConcerns::ColumnTypeMethod
-
-        MSG = 'Add the column without a default value then change the default.'
-
-        RESTRICT_ON_SEND = [
-          :add_column,
-          *COLUMN_TYPE_METHOD_NAMES
-        ].freeze
-
-        # @param node [RuboCop::AST::SendNode]
-        # @return [void]
-        def on_send(node)
-          return unless target_method?(node)
-
-          default_option_node = non_nil_default_option_node_from(node)
-          return unless default_option_node
-
-          add_offense(default_option_node) do |corrector|
-            autocorrect(
-              corrector,
-              default_option_node: default_option_node,
-              send_node: node
-            )
-          end
-        end
-
-        private
-
-        # @!method add_column?(node)
-        #   @param node [RuboCop::AST::SendNode]
-        #   @return [Boolean]
-        def_node_matcher :add_column?, <<~PATTERN
-          (send
-            nil?
-            :add_column
-            ...
-          )
-        PATTERN
-
-        # @!method column_type_method?(node)
-        #   @param node [RuboCop::AST::SendNode]
-        #   @return [Boolean]
-        def_node_matcher :column_type_method?, <<~PATTERN
-          (send
-            lvar
-            COLUMN_TYPE_METHOD_NAMES
-            ...
-          )
-        PATTERN
-
-        # @!method non_nil_default_option_node_from(node)
-        #   @param node [RuboCop::AST::SendNode]
-        #   @return [RuboCop::AST::PairNode, nil]
-        def_node_matcher :non_nil_default_option_node_from, <<~PATTERN
-          (send
-            _
-            _
-            ...
-            (hash
-              <
-                $(pair
-                  (sym :default)
-                  !nil
-                )
-              >
-              ...
-            )
-          )
-        PATTERN
-
-        # @param corrector [RuboCop::Cop::Corrector]
-        # @param default_option_node [RuboCop::AST::PairNode]
-        # @param send_node [RuboCop::AST::SendNode]
-        # @return [void]
-        def autocorrect(
-          corrector,
-          default_option_node:,
-          send_node:
-        )
-          remove_pair(
-            corrector,
-            default_option_node
-          )
-          insert_change_column_default(
-            corrector,
-            default_option_node: default_option_node,
-            send_node: send_node
-          )
-        end
-
-        # @param node [RuboCop::AST::SendNode]
-        # @return [RuboCop::AST::SymNode]
-        def find_column_node_from(node)
-          case node.method_name
-          when :add_column
-            node.arguments[1]
-          else
-            node.first_argument
-          end
-        end
-
-        # @param node [RuboCop::AST::SendNode]
-        # @return [RuboCop::AST::SendNode]
-        def find_insertion_target_node_from(node)
-          case node.method_name
-          when :add_column
-            node
-          else
-            node.each_ancestor(:block).first
-          end
-        end
-
-        # @param node [RuboCop::AST::SendNode]
-        # @return [RuboCop::AST::SymNode]
-        def find_table_node_from(node)
-          case node.method_name
-          when :add_column
-            node.first_argument
-          else
-            node.each_ancestor(:block).first.send_node.first_argument
-          end
-        end
-
-        # @param node [RuboCop::AST::SendNode]
-        # @return [Boolean]
-        def in_change_table?(node)
-          node.each_ancestor(:block).first&.method?(:change_table)
-        end
-
-        # @param corrector [RuboCop::Cop::Corrector]
-        # @param node [RuboCop::AST::Node]
-        # @param string [String]
-        def insert_after_with_same_indentation(
-          corrector,
-          node,
-          string
-        )
-          corrector.insert_after(
-            node,
-            format(
-              "\n%<indentation>s%<string>s",
-              indentation: ' ' * node.location.column,
-              string: string
-            )
-          )
-        end
-
-        # @param corrector [RuboCop::Cop::Corrector]
-        # @param default_option_node [RuboCop::AST::PairNode]
-        # @param send_node [RuboCop::AST::SendNode]
-        # @return [void]
-        def insert_change_column_default(
-          corrector,
-          default_option_node:,
-          send_node:
-        )
-          insert_after_with_same_indentation(
-            corrector,
-            find_insertion_target_node_from(send_node),
-            format(
-              'change_column_default %<table>s, %<column>s, %<default>s',
-              column: find_column_node_from(send_node).source,
-              default: default_option_node.value.source,
-              table: find_table_node_from(send_node).source
-            )
-          )
-        end
-
-        # @param corrector [RuboCop::Cop::Corrector]
-        # @param node [RuboCop::AST::Node]
-        # @return [void]
-        def remove_pair(
-          corrector,
-          node
-        )
-          corrector.remove(
-            range_with_surrounding_comma(
-              range_with_surrounding_space(
-                node.location.expression,
-                side: :left
-              ),
-              :left
-            )
-          )
-        end
-
-        # @param node [RuboCop::AST::SendNode]
-        # @return [Boolean]
-        def target_method?(node)
-          add_column?(node) ||
-            (column_type_method?(node) && in_change_table?(node))
-        end
-      end
-    end
-  end
-end