sevencop 0.22.0 → 0.23.0

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

@@ -1,166 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module Sevencop
-      # Activate foreign key validation in a separate migration in PostgreSQL.
-      #
-      # To avoid blocking writes on both tables.
-      #
-      # @safety
-      #   Only meaningful in PostgreSQL.
-      #
-      # @example
-      #   # bad
-      #   class AddForeignKeyFromArticlesToUsers < ActiveRecord::Migration[7.0]
-      #     def change
-      #       add_foreign_key :articles, :users
-      #     end
-      #   end
-      #
-      #   # good
-      #   class AddForeignKeyFromArticlesToUsersWithoutValidation < ActiveRecord::Migration[7.0]
-      #     def change
-      #       add_foreign_key :articles, :users, validate: false
-      #     end
-      #   end
-      #
-      #   class ActivateForeignKeyValidationFromArticlesToUsers < ActiveRecord::Migration[7.0]
-      #     def change
-      #       validate_foreign_key :articles, :users
-      #     end
-      #   end
-      class RailsMigrationAddForeignKey < RuboCop::Cop::Base
-        extend AutoCorrector
-
-        include RangeHelp
-
-        MSG = 'Activate foreign key validation in a separate migration in PostgreSQL.'
-
-        RESTRICT_ON_SEND = %i[
-          add_foreign_key
-          add_reference
-        ].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_foreign_key_without_validate_option?(node)
-        #   @param node [RuboCop::AST::SendNode]
-        #   @return [Boolean]
-        def_node_matcher :add_foreign_key_without_validate_option?, <<~PATTERN
-          (send
-            nil?
-            :add_foreign_key
-            _
-            _
-            (hash
-              (pair
-                !(sym :validate)
-                _
-              )*
-            )?
-          )
-        PATTERN
-
-        # @!method option_validate_true_value_node_from_add_foreign_key(node)
-        #   @param node [RuboCop::AST::SendNode]
-        #   @return [RuboCop::AST::PairNode]
-        def_node_matcher :option_validate_true_value_node_from_add_foreign_key, <<~PATTERN
-          (send
-            nil?
-            :add_foreign_key
-            _
-            _
-            (hash
-              <
-                (pair
-                  (sym :validate)
-                  $true
-                )
-                ...
-              >
-            )
-          )
-        PATTERN
-
-        # @!method option_foreign_key_true_node_from_add_reference(node)
-        #   @param node [RuboCop::AST::SendNode]
-        #   @return [RuboCop::AST::PairNode]
-        def_node_matcher :option_foreign_key_true_node_from_add_reference, <<~PATTERN
-          (send
-            nil?
-            :add_reference
-            _
-            _
-            (hash
-              <
-                $(pair
-                  (sym :foreign_key)
-                  true
-                )
-                ...
-              >
-            )
-          )
-        PATTERN
-
-        # @param node [RuboCop::AST::SendNode]
-        # @return [Boolean]
-        def add_foreign_key_with_validate_option_true?(node)
-          option_validate_true_value_node_from_add_foreign_key(node)
-        end
-
-        # @param node [RuboCop::AST::SendNode]
-        # @return [Boolean]
-        def add_reference_with_validate_option_true?(node)
-          option_foreign_key_true_node_from_add_reference(node)
-        end
-
-        # @param corrector [RuboCop::Cop::Corrector]
-        # @param node [RuboCop::AST::SendNode]
-        # @return [void]
-        def autocorrect(
-          corrector,
-          node
-        )
-          if add_foreign_key_without_validate_option?(node)
-            corrector.insert_after(node.last_argument, ', validate: false')
-          elsif add_foreign_key_with_validate_option_true?(node)
-            corrector.replace(
-              option_validate_true_value_node_from_add_foreign_key(node),
-              'false'
-            )
-          elsif add_reference_with_validate_option_true?(node)
-            corrector.remove(
-              range_with_surrounding_comma(
-                range_with_surrounding_space(
-                  option_foreign_key_true_node_from_add_reference(node).location.expression,
-                  side: :left
-                ),
-                :left
-              )
-            )
-          end
-        end
-
-        # @param node [RuboCop::AST::SendNode]
-        # @return [Boolean]
-        def bad?(node)
-          add_foreign_key_without_validate_option?(node) ||
-            add_foreign_key_with_validate_option_true?(node) ||
-            add_reference_with_validate_option_true?(node)
-        end
-      end
-    end
-  end
-end

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

@@ -1,164 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module Sevencop
-      # Use `algorithm: :concurrently` on adding indexes to existing tables in PostgreSQL.
-      #
-      # To avoid blocking writes.
-      #
-      # @safety
-      #   Only meaningful in PostgreSQL.
-      #
-      # @example
-      #   # bad
-      #   class AddIndexToUsersName < ActiveRecord::Migration[7.0]
-      #     def change
-      #       add_index :users, :name
-      #     end
-      #   end
-      #
-      #   # good
-      #   class AddIndexToUsersNameConcurrently < ActiveRecord::Migration[7.0]
-      #     disable_ddl_transaction!
-      #
-      #     def change
-      #       add_index :users, :name, algorithm: :concurrently
-      #     end
-      #   end
-      class RailsMigrationAddIndexConcurrently < RuboCop::Cop::Base
-        extend AutoCorrector
-
-        include ::Sevencop::CopConcerns::DisableDdlTransaction
-
-        MSG = 'Use `algorithm: :concurrently` on adding indexes to existing tables in PostgreSQL.'
-
-        RESTRICT_ON_SEND = %i[
-          add_index
-          index
-        ].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_index?(node)
-        #   @param node [RuboCop::AST::SendNode]
-        #   @return [Boolean]
-        def_node_matcher :add_index?, <<~PATTERN
-          (send
-            nil?
-            :add_index
-            _
-            _
-            ...
-          )
-        PATTERN
-
-        # @!method add_index_concurrently?(node)
-        #   @param node [RuboCop::AST::SendNode]
-        #   @return [Boolean]
-        def_node_matcher :add_index_concurrently?, <<~PATTERN
-          (send
-            nil?
-            :add_index
-            _
-            _
-            (hash
-              <
-                (pair
-                  (sym :algorithm)
-                  (sym :concurrently)
-                )
-                ...
-              >
-            )
-          )
-        PATTERN
-
-        # @!method index?(node)
-        #   @param node [RuboCop::AST::SendNode]
-        #   @return [Boolean]
-        def_node_matcher :index?, <<~PATTERN
-          (send
-            lvar
-            :index
-            _
-            ...
-          )
-        PATTERN
-
-        # @!method index_concurrently?(node)
-        #   @param node [RuboCop::AST::SendNode]
-        #   @return [Boolean]
-        def_node_matcher :index_concurrently?, <<~PATTERN
-          (send
-            lvar
-            :index
-            _
-            (hash
-              <
-                (pair
-                  (sym :algorithm)
-                  (sym :concurrently)
-                )
-                ...
-              >
-            )
-          )
-        PATTERN
-
-        # @param corrector [RuboCop::Cop::Corrector]
-        # @param node [RuboCop::AST::SendNode]
-        # @return [void]
-        def autocorrect(
-          corrector,
-          node
-        )
-          insert_disable_ddl_transaction(corrector, node) unless within_disable_ddl_transaction?(node)
-          insert_algorithm_option(corrector, node)
-        end
-
-        # @param node [RuboCop::AST::SendNode]
-        # @return [Boolean]
-        def bad?(node)
-          case node.method_name
-          when :add_index
-            add_index?(node) && !add_index_concurrently?(node)
-          when :index
-            index?(node) && in_change_table?(node) && !index_concurrently?(node)
-          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::SendNode]
-        # @return [void]
-        def insert_algorithm_option(
-          corrector,
-          node
-        )
-          target_node = node.last_argument
-          target_node = target_node.pairs.last if target_node.hash_type?
-          corrector.insert_after(
-            target_node,
-            ', algorithm: :concurrently'
-          )
-        end
-      end
-    end
-  end
-end

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

@@ -1,95 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module Sevencop
-      # Use `in_batches` in batch processing.
-      #
-      # For more efficient batch processing.
-      #
-      # @safety
-      #   There are some cases where we should not do that,
-      #   or this type of consideration might be already done in a way that we cannot detect.
-      #
-      # @example
-      #   # bad
-      #   class BackfillSomeColumn < ActiveRecord::Migration[7.0]
-      #     disable_ddl_transaction!
-      #
-      #     def change
-      #       User.update_all(some_column: 'some value')
-      #     end
-      #   end
-      #
-      #   # good
-      #   class BackfillSomeColumnToUsers < ActiveRecord::Migration[7.0]
-      #     disable_ddl_transaction!
-      #
-      #     def up
-      #       User.within_in_batches do |relation|
-      #         relation.update_all(some_column: 'some value')
-      #       end
-      #     end
-      #   end
-      class RailsMigrationBatchInBatches < RuboCop::Cop::Base
-        extend AutoCorrector
-
-        include ::Sevencop::CopConcerns::BatchProcessing
-
-        MSG = 'Use `in_batches` in batch processing.'
-
-        RESTRICT_ON_SEND = %i[
-          delete_all
-          update_all
-        ].freeze
-
-        # @param node [RuboCop::AST::SendNode]
-        # @return [void]
-        def on_send(node)
-          return unless wrong?(node)
-
-          add_offense(node) do |corrector|
-            autocorrect(corrector, node)
-          end
-        end
-
-        private
-
-        # @param corrector [RuboCop::Cop::Corrector]
-        # @param node [RuboCop::AST::SendNode]
-        # @return [void]
-        def autocorrect(
-          corrector,
-          node
-        )
-          range = node.location.selector.with(
-            end_pos: node.location.expression.end_pos
-          )
-          corrector.replace(
-            range,
-            <<~TEXT.chomp
-              in_batches do |relation|
-                relation.#{range.source}
-              end
-            TEXT
-          )
-        end
-
-        # @param node [RuboCop::AST::Node]
-        # @return [Boolean]
-        def within_in_batches?(node)
-          node.each_ancestor(:block).any? do |ancestor|
-            ancestor.method?(:in_batches)
-          end
-        end
-
-        # @param node [RuboCop::AST::SendNode]
-        # @return [Boolean]
-        def wrong?(node)
-          batch_processing?(node) &&
-            !within_in_batches?(node)
-        end
-      end
-    end
-  end
-end

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

@@ -1,83 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module Sevencop
-      # Disable transaction in batch processing.
-      #
-      # To avoid locking the table.
-      #
-      # @safety
-      #   There are some cases where transaction is really needed.
-      #
-      # @example
-      #   # bad
-      #   class AddSomeColumnToUsersThenBackfillSomeColumn < ActiveRecord::Migration[7.0]
-      #     def change
-      #       add_column :users, :some_column, :text
-      #       User.update_all(some_column: 'some value')
-      #     end
-      #   end
-      #
-      #   # good
-      #   class AddSomeColumnToUsers < ActiveRecord::Migration[7.0]
-      #     def change
-      #       add_column :users, :some_column, :text
-      #     end
-      #   end
-      #
-      #   class BackfillSomeColumnToUsers < ActiveRecord::Migration[7.0]
-      #     disable_ddl_transaction!
-      #
-      #     def up
-      #       User.unscoped.in_batches do |relation|
-      #         relation.update_all(some_column: 'some value')
-      #         sleep(0.01)
-      #       end
-      #     end
-      #   end
-      class RailsMigrationBatchInTransaction < RuboCop::Cop::Base
-        extend AutoCorrector
-
-        include ::Sevencop::CopConcerns::BatchProcessing
-        include ::Sevencop::CopConcerns::DisableDdlTransaction
-
-        MSG = 'Disable transaction in batch processing.'
-
-        RESTRICT_ON_SEND = %i[
-          delete_all
-          update_all
-        ].freeze
-
-        # @param node [RuboCop::AST::SendNode]
-        # @return [void]
-        def on_send(node)
-          return unless wrong?(node)
-
-          add_offense(node) do |corrector|
-            autocorrect(corrector, node)
-          end
-        end
-
-        private
-
-        # @param corrector [RuboCop::Cop::Corrector]
-        # @param node [RuboCop::AST::SendNode]
-        # @return [void]
-        def autocorrect(
-          corrector,
-          node
-        )
-          insert_disable_ddl_transaction(corrector, node)
-        end
-
-        # @param node [RuboCop::AST::SendNode]
-        # @return [Boolean]
-        def wrong?(node)
-          batch_processing?(node) &&
-            !within_disable_ddl_transaction?(node)
-        end
-      end
-    end
-  end
-end

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

@@ -1,108 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module Sevencop
-      # Use throttling in batch processing.
-      #
-      # @safety
-      #   There are some cases where we should not do throttling,
-      #   or the throttling might be already done in a way that we cannot detect.
-      #
-      # @example
-      #   # bad
-      #   class BackfillSomeColumn < ActiveRecord::Migration[7.0]
-      #     disable_ddl_transaction!
-      #
-      #     def change
-      #       User.in_batches do |relation|
-      #         relation.update_all(some_column: 'some value')
-      #       end
-      #     end
-      #   end
-      #
-      #   # good
-      #   class BackfillSomeColumnToUsers < ActiveRecord::Migration[7.0]
-      #     disable_ddl_transaction!
-      #
-      #     def up
-      #       User.in_batches do |relation|
-      #         relation.update_all(some_column: 'some value')
-      #         sleep(0.01)
-      #       end
-      #     end
-      #   end
-      class RailsMigrationBatchWithThrottling < RuboCop::Cop::Base
-        extend AutoCorrector
-
-        include ::Sevencop::CopConcerns::BatchProcessing
-
-        MSG = 'Use throttling in batch processing.'
-
-        RESTRICT_ON_SEND = %i[
-          delete_all
-          update_all
-        ].freeze
-
-        # @param node [RuboCop::AST::SendNode]
-        # @return [void]
-        def on_send(node)
-          return unless wrong?(node)
-
-          add_offense(node) do |corrector|
-            autocorrect(corrector, node)
-          end
-        end
-
-        private
-
-        # @!method sleep?(node)
-        #   @param node [RuboCop::AST::Node]
-        #   @return [Boolean]
-        def_node_matcher :sleep?, <<~PATTERN
-          (send
-            nil?
-            :sleep
-            ...
-          )
-        PATTERN
-
-        # @param corrector [RuboCop::Cop::Corrector]
-        # @param node [RuboCop::AST::SendNode]
-        # @return [void]
-        def autocorrect(
-          corrector,
-          node
-        )
-          corrector.insert_after(
-            node,
-            "\n#{' ' * node.location.column}sleep(0.01)"
-          )
-        end
-
-        # @param node [RuboCop::AST::Node]
-        # @return [Boolean]
-        def in_block?(node)
-          node.parent&.block_type? ||
-            (node.parent&.begin_type? && node.parent.parent&.block_type?)
-        end
-
-        # @param node [RuboCop::AST::SendNode]
-        # @return [Boolean]
-        def with_throttling?(node)
-          (node.left_siblings + node.right_siblings).any? do |sibling|
-            sleep?(sibling)
-          end
-        end
-
-        # @param node [RuboCop::AST::SendNode]
-        # @return [Boolean]
-        def wrong?(node)
-          batch_processing?(node) &&
-            in_block?(node) &&
-            !with_throttling?(node)
-        end
-      end
-    end
-  end
-end