sevencop 0.22.0 → 0.23.0

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

@@ -1,81 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module Sevencop
-      # Avoid renaming columns that are in use.
-      #
-      # It will cause errors in your application.
-      # A safer approach is to:
-      #
-      # 1. Create a new column
-      # 2. Write to both columns
-      # 3. Backfill data from the old column to the new column
-      # 4. Move reads from the old column to the new column
-      # 5. Stop writing to the old column
-      # 6. Drop the old column
-      #
-      # @safety
-      #   Only meaningful if the column is in use.
-      #
-      # @example
-      #   # bad
-      #   class RenameUsersSettingsToProperties < ActiveRecord::Migration[7.0]
-      #     def change
-      #       rename_column :users, :settings, :properties
-      #     end
-      #   end
-      #
-      #   # good
-      #   class AddUsersProperties < ActiveRecord::Migration[7.0]
-      #     def change
-      #       add_column :users, :properties, :jsonb
-      #     end
-      #   end
-      #
-      #   class User < ApplicationRecord
-      #     self.ignored_columns += %w[settings]
-      #   end
-      #
-      #   class RemoveUsersSettings < ActiveRecord::Migration[7.0]
-      #     def change
-      #       remove_column :users, :settings
-      #     end
-      #   end
-      class RailsMigrationRenameColumn < RuboCop::Cop::Base
-        MSG = 'Avoid renaming columns that are in use.'
-
-        RESTRICT_ON_SEND = %i[
-          rename_column
-        ].freeze
-
-        # @param node [RuboCop::AST::SendNode]
-        # @return [void]
-        def on_send(node)
-          return unless bad?(node)
-
-          add_offense(node)
-        end
-
-        private
-
-        # @!method rename_column?(node)
-        #   @param node [RuboCop::AST::SendNode]
-        #   @return [Boolean]
-        def_node_matcher :rename_column?, <<~PATTERN
-          (send
-            nil?
-            :rename_column
-            ...
-          )
-        PATTERN
-
-        # @param node [RuboCop::AST::SendNode]
-        # @return [Boolean]
-        def bad?(node)
-          rename_column?(node)
-        end
-      end
-    end
-  end
-end

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

@@ -1,79 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module Sevencop
-      # Avoid renaming tables that are in use.
-      #
-      # It will cause errors in your application.
-      # A safer approach is to:
-      #
-      # 1. Create a new table
-      # 2. Write to both tables
-      # 3. Backfill data from the old table to new table
-      # 4. Move reads from the old table to the new table
-      # 5. Stop writing to the old table
-      # 6. Drop the old table
-      #
-      # @safety
-      #   Only meaningful if the table is in use.
-      #
-      # @example
-      #   # bad
-      #   class RenameUsersToAccouts < ActiveRecord::Migration[7.0]
-      #     def change
-      #       rename_table :users, :accounts
-      #     end
-      #   end
-      #
-      #   # good
-      #   class AddAccounts < ActiveRecord::Migration[7.0]
-      #     def change
-      #       create_table :accounts do |t|
-      #         t.string :name, null: false
-      #       end
-      #     end
-      #   end
-      #
-      #   class RemoveUsers < ActiveRecord::Migration[7.0]
-      #     def change
-      #       remove_table :users
-      #     end
-      #   end
-      class RailsMigrationRenameTable < RuboCop::Cop::Base
-        MSG = 'Avoid renaming tables that are in use.'
-
-        RESTRICT_ON_SEND = %i[
-          rename_table
-        ].freeze
-
-        # @param node [RuboCop::AST::SendNode]
-        # @return [void]
-        def on_send(node)
-          return unless bad?(node)
-
-          add_offense(node)
-        end
-
-        private
-
-        # @!method rename_table?(node)
-        #   @param node [RuboCop::AST::SendNode]
-        #   @return [Boolean]
-        def_node_matcher :rename_table?, <<~PATTERN
-          (send
-            nil?
-            :rename_table
-            ...
-          )
-        PATTERN
-
-        # @param node [RuboCop::AST::SendNode]
-        # @return [Boolean]
-        def bad?(node)
-          rename_table?(node)
-        end
-      end
-    end
-  end
-end

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

@@ -1,232 +0,0 @@
-# frozen_string_literal: true
-
-require 'set'
-
-module RuboCop
-  module Cop
-    module Sevencop
-      # Avoid using MySQL reserved words as identifiers.
-      #
-      # @example
-      #   # bad
-      #   # NOTE: `role` is a reserved word in MySQL.
-      #   add_column :users, :role, :string
-      #
-      #   # good
-      #   add_column :users, :some_other_good_name, :string
-      class RailsMigrationReservedWordMysql < RuboCop::Cop::Base
-        include ::Sevencop::CopConcerns::ColumnTypeMethod
-
-        MSG = 'Avoid using MySQL reserved words as identifiers.'
-
-        # Obtained from https://dev.mysql.com/doc/refman/8.0/en/keywords.html.
-        PATH_TO_RESERVED_WORDS_FILE = File.expand_path(
-          '../../../../data/reserved_words_mysql.txt',
-          __dir__
-        ).freeze
-
-        RESTRICT_ON_SEND = [
-          :add_column,
-          :add_index,
-          :add_reference,
-          :create_join_table,
-          :create_table,
-          :rename,
-          :rename_column,
-          :rename_index,
-          :rename_table,
-          *COLUMN_TYPE_METHOD_NAMES
-        ].freeze
-
-        class << self
-          # @return [Array<String>]
-          def reserved_words
-            @reserved_words ||= ::Set.new(
-              ::File.read(PATH_TO_RESERVED_WORDS_FILE).split("\n")
-            ).freeze
-          end
-        end
-
-        # @param node [RuboCop::AST::DefNode]
-        # @return [void]
-        def on_send(node)
-          offended_identifier_nodes_from(node).each do |identifier_node|
-            add_offense(identifier_node)
-          end
-        end
-
-        private
-
-        # @!method index_name_option_from_add_index(node)
-        #   @param node [RuboCop::AST::SendNode]
-        #   @return [RuboCop::AST::Node, nil]
-        def_node_matcher :index_name_option_from_add_index, <<~PATTERN
-          (send
-            nil?
-            :add_index
-            _
-            _
-            (hash
-              <
-                (pair
-                  (sym :name)
-                  $_
-                )
-              >
-              ...
-            )
-          )
-        PATTERN
-
-        # @!method index_name_option_from_add_reference(node)
-        #   @param node [RuboCop::AST::SendNode]
-        #   @return [RuboCop::AST::Node, nil]
-        def_node_matcher :index_name_option_from_add_reference, <<~PATTERN
-          (send
-            nil?
-            :add_reference
-            _
-            _
-            (hash
-              <
-                (pair
-                  (sym :index)
-                  (hash
-                    <
-                      (pair
-                        (sym :name)
-                        $_
-                      )
-                    >
-                    ...
-                  )
-                )
-              >
-              ...
-            )
-          )
-        PATTERN
-
-        # @!method index_name_option_from_column_type(node)
-        #   @param node [RuboCop::AST::SendNode]
-        #   @return [RuboCop::AST::Node, nil]
-        def_node_matcher :index_name_option_from_column_type, <<~PATTERN
-          (send
-            lvar
-            COLUMN_TYPE_METHOD_NAMES
-            _
-            (hash
-              <
-                (pair
-                  (sym :index)
-                  (hash
-                    <
-                      (pair
-                        (sym :name)
-                        $_
-                      )
-                      ...
-                    >
-                  )
-                )
-                ...
-              >
-            )
-          )
-        PATTERN
-
-        # @!method table_name_option_from(node)
-        #   @param node [RuboCop::AST::SendNode]
-        #   @return [RuboCop::AST::Node, nil]
-        def_node_matcher :table_name_option_from, <<~PATTERN
-          (send
-            nil?
-            :create_join_table
-            _
-            _
-            (hash
-              <
-                (pair
-                  (sym :table_name)
-                  $_
-                )
-                ...
-              >
-            )
-          )
-        PATTERN
-
-        # @param node [RuboCop::AST::SendNode]
-        # @return [Array<RuboCop::AST::Node>]
-        def identifier_column_name_nodes_from(node)
-          case node.method_name
-          when :add_column, :rename
-            [node.arguments[1]]
-          when :rename_column
-            [node.arguments[2]]
-          when *COLUMN_TYPE_METHOD_NAMES
-            [node.arguments[0]]
-          else
-            []
-          end
-        end
-
-        # @param node [RuboCop::AST::SendNode]
-        # @return [Array<RuboCop::AST::Node>]
-        def identifier_index_name_nodes_from(node)
-          case node.method_name
-          when :add_index
-            [index_name_option_from_add_index(node)].compact
-          when :add_reference
-            [index_name_option_from_add_reference(node)].compact
-          when :rename_index
-            [node.arguments[2]]
-          when *COLUMN_TYPE_METHOD_NAMES
-            [index_name_option_from_column_type(node)].compact
-          else
-            []
-          end
-        end
-
-        # @param node [RuboCop::AST::SendNode]
-        # @return [Array<RuboCop::AST::Node>]
-        def identifier_nodes_from(node)
-          identifier_table_name_nodes_from(node) +
-            identifier_column_name_nodes_from(node) +
-            identifier_index_name_nodes_from(node)
-        end
-
-        # @param node [RuboCop::AST::SendNode]
-        # @return [Array<RuboCop::AST::Node>]
-        def identifier_table_name_nodes_from(node)
-          case node.method_name
-          when :create_join_table
-            [table_name_option_from(node)].compact
-          when :create_table
-            [node.arguments[0]]
-          when :rename_table
-            [node.arguments[1]]
-          else
-            []
-          end
-        end
-
-        # @param node [RuboCop::AST::Node]
-        # @return [Array<RuboCop::AST::Node>]
-        def offended_identifier_nodes_from(node)
-          identifier_nodes_from(node).select do |identifier_node|
-            reserved_word_identifier_node?(identifier_node)
-          end
-        end
-
-        # @param node [RuboCop::AST::Node]
-        # @return [Boolean]
-        def reserved_word_identifier_node?(node)
-          return false unless node.respond_to?(:value)
-
-          self.class.reserved_words.include?(node.value.to_s)
-        end
-      end
-    end
-  end
-end

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

@@ -1,92 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module Sevencop
-      # Keep unique index columns count less than a specified number.
-      #
-      # Adding a non-unique index with more than three columns rarely improves performance.
-      # Instead, start an index with columns that narrow down the results the most.
-      #
-      # @example
-      #   # bad
-      #   add_index :users, %i[a b c d]
-      #
-      #   # good (`MaxColumnsCount: 3` by default)
-      #   add_index :users, %i[a b c]
-      class RailsMigrationUniqueIndexColumnsCount < RuboCop::Cop::Base
-        RESTRICT_ON_SEND = %i[
-          add_index
-          index
-        ].freeze
-
-        # @param node [RuboCop::AST::SendNode]
-        # @return [void]
-        def on_send(node)
-          column_names_node = column_names_node_from(node)
-          return unless column_names_node
-
-          column_names_count = columns_count_from(column_names_node)
-          return if column_names_count <= max_columns_count
-
-          add_offense(
-            column_names_node,
-            message: "Keep unique index columns count less than #{max_columns_count}."
-          )
-        end
-
-        private
-
-        # @!method column_names_node_from_add_index(node)
-        #   @param node [RuboCop::AST::SendNode]
-        #   @return [RuboCop::AST::Node, nil]
-        def_node_matcher :column_names_node_from_add_index, <<~PATTERN
-          (send
-            nil?
-            _
-            _
-            $({array | sym} ...)
-          )
-        PATTERN
-
-        # @!method column_names_node_from_index(node)
-        #   @param node [RuboCop::AST::SendNode]
-        #   @return [RuboCop::AST::Node, nil]
-        def_node_matcher :column_names_node_from_index, <<~PATTERN
-          (send
-            (lvar ...)
-            _
-            $({array | sym} ...)
-          )
-        PATTERN
-
-        # @param node [RuboCop::AST::SendNode]
-        # @return [RuboCop::AST::Node, nil]
-        def column_names_node_from(node)
-          case node.method_name
-          when :add_index
-            column_names_node_from_add_index(node)
-          when :index
-            column_names_node_from_index(node)
-          end
-        end
-
-        # @param node [RuboCop::AST::Node]
-        # @return [Integer, nil]
-        def columns_count_from(node)
-          case node.type
-          when :array
-            node.values.count
-          when :sym
-            1
-          end
-        end
-
-        # @return [Integer]
-        def max_columns_count
-          cop_config['MaxColumnsCount']
-        end
-      end
-    end
-  end
-end

data/lib/sevencop/cop_concerns/batch_processing.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-module Sevencop
-  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

data/lib/sevencop/cop_concerns/column_type_method.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module Sevencop
-  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

data/lib/sevencop/cop_concerns/disable_ddl_transaction.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-module Sevencop
-  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