sevencop 0.20.1 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22e21f2ba7c484fc1fd0d23b9b7d4dcf70d3e0f2f5f764e95e6dc65d10c419e9
-  data.tar.gz: b689a364af2f7728c3947575d4edcc5f79a9ce3767fa769acf4829587fa9e63c
+  metadata.gz: e2aff4e0e776ef3fa5b3f71ece7b7c83013caadaf829fc86827ab246f5f80382
+  data.tar.gz: 1889785ce282e4d530c7eef4a54afaa948181b1557e788425e9b30e831935b77
 SHA512:
-  metadata.gz: 9cab7cab01a11e6c9ea1de15a97ae4ea6c8315dc4c4a2304d4ee1178775dd8526cccd2a42cdca9d30069936e816bde32cd58451e157fa85b737bb2bfa5368465
-  data.tar.gz: 0040a81647501bcb03ee0f0bd0f97722b2483c202751debc7a530d58677a4d822e73039803a6066d1d6085e2dcd7c9a06fead8c06991e2b14afdc927ebd8b07b
+  metadata.gz: 386a275378516b205cbd1dc4d50226776d106dc98eb8c534973ff7379c39b59f0e49ae4985058f79254d2256a09ac459b6357e1c5d0f03a8e2d780ec8b1fc990
+  data.tar.gz: 91adea811d280655577fd88cdb4b861b3a9e04f4c89d9542a4ce38281f325cfe0be590cb45ce8937375b4d13e67970518e6381531f46087689e58f3b8d0c5156

data/.rubocop.yml

@@ -13,6 +13,9 @@ AllCops:
 Gemspec/RequireMFA:
   Enabled: false
 
+Layout/LineLength:
+  Enabled: false
+
 Metrics:
   Enabled: false
 
@@ -49,6 +52,9 @@ Sevencop/MethodDefinitionKeywordArgumentOrdered:
 Sevencop/MethodDefinitionOrdered:
   Enabled: true
 
+Sevencop/RequireOrdered:
+  Enabled: true
+
 Style/Documentation:
   Enabled: false
 

data/Gemfile.lock

@@ -1,15 +1,25 @@
 PATH
   remote: .
   specs:
-    sevencop (0.20.1)
+    sevencop (0.22.0)
+      activesupport
       rubocop
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (7.0.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
     ast (2.4.2)
+    concurrent-ruby (1.1.10)
     diff-lcs (1.5.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
     json (2.6.2)
+    minitest (5.16.3)
     parallel (1.22.1)
     parser (3.1.2.1)
       ast (~> 2.4.1)
@@ -50,6 +60,8 @@ GEM
     rubocop-rspec (2.13.1)
       rubocop (~> 1.33)
     ruby-progressbar (1.11.0)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (2.3.0)
 
 PLATFORMS

data/README.md

@@ -24,11 +24,13 @@ Sevencop/MethodDefinitionOrdered:
   Enabled: true
 ```
 
-## Cops
+Note that all cops are `Enabled: false` by default.
 
-Choose the cops you want to use and enable them on your .rubocop.yml.
+## Cops
 
 - [Sevencop/AutoloadOrdered](lib/rubocop/cop/sevencop/autoload_ordered.rb)
+- [Sevencop/FactoryBotAssociationOption](lib/rubocop/cop/sevencop/factory_bot_association_option.rb)
+- [Sevencop/FactoryBotAssociationStyle](lib/rubocop/cop/sevencop/factory_bot_association_style.rb)
 - [Sevencop/HashElementOrdered](lib/rubocop/cop/sevencop/hash_element_ordered.rb)
 - [Sevencop/MethodDefinitionArgumentsMultiline](lib/rubocop/cop/sevencop/method_definition_arguments_multiline.rb)
 - [Sevencop/MethodDefinitionInIncluded](lib/rubocop/cop/sevencop/method_definition_in_included.rb)
@@ -36,12 +38,25 @@ Choose the cops you want to use and enable them on your .rubocop.yml.
 - [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)
 - [Sevencop/RequireOrdered](lib/rubocop/cop/sevencop/require_ordered.rb)
 - [Sevencop/RSpecDescribeHttpEndpoint](lib/rubocop/cop/sevencop/rspec_describe_http_endpoint.rb)
 - [Sevencop/RSpecExamplesInSameGroup](lib/rubocop/cop/sevencop/rspec_examples_in_same_group.rb)
-
-Note that all cops are `Enabled: false` by default.

data/config/default.yml

@@ -5,6 +5,35 @@ Sevencop/AutoloadOrdered:
   Safe: false
   VersionAdded: '0.12'
 
+Sevencop/FactoryBotAssociationOptions:
+  Description: |
+    Remove redundant options from FactoryBot associations.
+  Enabled: false
+  VersionAdded: '0.21'
+
+Sevencop/FactoryBotAssociationStyle:
+  Description: |
+    Use consistent style in FactoryBot associations.
+  Enabled: false
+  Safe: false
+  VersionAdded: '0.21'
+  EnforcedStyle: implicit
+  SupportedStyles:
+    - explicit
+    - implicit
+  inherit_mode:
+    merge:
+      - NonImplicitAssociationMethodNames
+  NonImplicitAssociationMethodNames:
+    - skip_create
+  Include:
+    - factories.rb
+    - factories/*.rb
+    - spec/factories.rb
+    - spec/factories/*.rb
+    - test/factories.rb
+    - test/factories/*.rb
+
 Sevencop/HashElementOrdered:
   Description: |
     Sort Hash elements by key.
@@ -53,6 +82,131 @@ 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.
@@ -62,6 +216,15 @@ Sevencop/RailsMigrationReservedWordMysql:
   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/rubocop/cop/sevencop/factory_bot_association_option.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Sevencop
+      # Remove redundant options from FactoryBot associations.
+      #
+      # @example
+      #   # bad
+      #   association :user, factory: :user
+      #
+      #   # good
+      #   association :user
+      class FactoryBotAssociationOption < RuboCop::Cop::Base
+        extend AutoCorrector
+
+        include RangeHelp
+
+        MSG = 'Remove redundant options from FactoryBot associations.'
+
+        RESTRICT_ON_SEND = %i[association].freeze
+
+        # @param node [RuboCop::AST::SendNode]
+        # @return [void]
+        def on_send(node)
+          association_name = association_name_from(node)
+          factory_option = factory_option_from(node)
+          return if !factory_option || association_name != factory_option.value.value
+
+          add_offense(factory_option) do |corrector|
+            autocorrect(corrector, factory_option)
+          end
+        end
+
+        private
+
+        # @!method association_name_from(node)
+        #   @param node [RuboCop::AST::SendNode]
+        #   @return [Symbol, nil]
+        def_node_matcher :association_name_from, <<~PATTERN
+          (send
+            nil?
+            _
+            (sym $_)
+            ...
+          )
+        PATTERN
+
+        # @!method factory_option_from(node)
+        #   @param node [RuboCop::AST::SendNode]
+        #   @return [RuboCop::AST::PairNode, nil]
+        def_node_matcher :factory_option_from, <<~PATTERN
+          (send
+            nil?
+            _
+            _
+            (hash
+              <
+                $(pair
+                  (sym :factory)
+                  sym
+                )
+                ...
+              >
+            )
+          )
+        PATTERN
+
+        # @param corrector [RuboCop::Cop::Corrector]
+        # @param node [RuboCop::AST::PairNode]
+        # @return [void]
+        def autocorrect(
+          corrector,
+          node
+        )
+          corrector.remove(
+            range_with_surrounding_comma(
+              range_with_surrounding_space(
+                node.location.expression,
+                side: :left
+              ),
+              :left
+            )
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,167 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Sevencop
+      # Use consistent style in FactoryBot associations.
+      #
+      # @safety
+      #   This cop may cause false-positives in `EnforcedStyle: explicit` case.
+      #   It recognizes any method call that has no arguments as an implicit association
+      #   but it might be a user-defined trait call.
+      #
+      # @example EnforcedStyle: implicit (default)
+      #   # bad
+      #   association :user
+      #
+      #   # good
+      #   user
+      #
+      #   # good
+      #   association :author, factory: user
+      #
+      # @example EnforcedStyle: explicit
+      #   # bad
+      #   user
+      #
+      #   # good
+      #   association :user
+      #
+      #   # good (defined in NonImplicitAssociationMethodNames)
+      #   skip_create
+      class FactoryBotAssociationStyle < RuboCop::Cop::Base
+        extend AutoCorrector
+
+        include ConfigurableEnforcedStyle
+
+        MSG = 'Use consistent style in FactoryBot associations.'
+
+        RESTRICT_ON_SEND = %i[factory].freeze
+
+        # @param node [RuboCop::AST::SendNode]
+        # @return [void]
+        def on_send(node)
+          bad_associations_in(node).each do |association|
+            add_offense(association) do |corrector|
+              autocorrect(corrector, association)
+            end
+          end
+        end
+
+        private
+
+        # @!method explicit_association?(node)
+        #   @param node [RuboCop::AST::SendNode]
+        #   @return [Boolean]
+        def_node_matcher :explicit_association?, <<~PATTERN
+          (send
+            nil?
+            :association
+            ...
+          )
+        PATTERN
+
+        # @!method implicit_association?(node)
+        #   @param node [RuboCop::AST::SendNode]
+        #   @return [Boolean]
+        def_node_matcher :implicit_association?, <<~PATTERN
+          (send
+            nil?
+            !#non_implicit_association_method_name?
+          )
+        PATTERN
+
+        # @param corrector [RuboCop::Cop::Corrector]
+        # @param node [RuboCop::AST::SendNode]
+        def autocorrect(
+          corrector,
+          node
+        )
+          case style
+          when :explicit
+            autocorrect_to_explicit_style(corrector, node)
+          when :implicit
+            autocorrect_to_implicit_style(corrector, node)
+          end
+        end
+
+        # @param corrector [RuboCop::Cop::Corrector]
+        # @param node [RuboCop::AST::SendNode]
+        # @return [void]
+        def autocorrect_to_explicit_style(
+          corrector,
+          node
+        )
+          corrector.replace(node, "association :#{node.method_name}")
+        end
+
+        # @param corrector [RuboCop::Cop::Corrector]
+        # @param node [RuboCop::AST::SendNode]
+        # @return [void]
+        def autocorrect_to_implicit_style(
+          corrector,
+          node
+        )
+          corrector.replace(node, node.first_argument.value.to_s)
+        end
+
+        # @param node [RuboCop::AST::SendNode]
+        # @return [Boolean]
+        def autocorrectable_to_implicit_style?(node)
+          node.arguments.one?
+        end
+
+        # @param node [RuboCop::AST::SendNode]
+        # @return [Boolean]
+        def bad?(node)
+          case style
+          when :explicit
+            bad_to_explicit_style?(node)
+          when :implicit
+            bad_to_implicit_style?(node)
+          end
+        end
+
+        # @param node [RuboCop::AST::SendNode]
+        # @return [Array<RuboCop::AST::SendNode>]
+        def bad_associations_in(node)
+          children_of_factory_block(node).select do |child|
+            bad?(child)
+          end
+        end
+
+        # @param node [RuboCop::AST::SendNode]
+        # @return [Boolean]
+        def bad_to_explicit_style?(node)
+          implicit_association?(node)
+        end
+
+        # @param node [RuboCop::AST::SendNode]
+        # @return [Boolean]
+        def bad_to_implicit_style?(node)
+          explicit_association?(node) && autocorrectable_to_implicit_style?(node)
+        end
+
+        # @param node [RuboCop::AST::SendNode]
+        # @return [Array<RuboCop::AST::Node>]
+        def children_of_factory_block(node)
+          block = node.parent
+          return [] unless block
+          return [] unless block.block_type?
+
+          if block.body.begin_type?
+            block.body.children
+          else
+            [block.body]
+          end
+        end
+
+        # @param method_name [Symbol]
+        # @return [Boolean]
+        def non_implicit_association_method_name?(method_name)
+          cop_config['NonImplicitAssociationMethodNames'].include?(method_name.to_s)
+        end
+      end
+    end
+  end
+end

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

@@ -73,7 +73,7 @@ module RuboCop
             _*
             ({ hash | kwargs }
               (pair ...)*
-              $(pair (sym :type) (sym _))
+              $(pair (sym :type) sym)
               (pair ...)*
             )
           )

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

@@ -0,0 +1,111 @@
+# 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