sevencop 0.22.0 → 0.24.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2aff4e0e776ef3fa5b3f71ece7b7c83013caadaf829fc86827ab246f5f80382
-  data.tar.gz: 1889785ce282e4d530c7eef4a54afaa948181b1557e788425e9b30e831935b77
+  metadata.gz: 47139f7d9fb3b1e73416958e9f2f87ccafa4145864e046a1539ffd33018bd603
+  data.tar.gz: f9c759a3adbbf7e25b327755c8d5fc0a00d5f6438f79b4df3e33d138ca296fb7
 SHA512:
-  metadata.gz: 386a275378516b205cbd1dc4d50226776d106dc98eb8c534973ff7379c39b59f0e49ae4985058f79254d2256a09ac459b6357e1c5d0f03a8e2d780ec8b1fc990
-  data.tar.gz: 91adea811d280655577fd88cdb4b861b3a9e04f4c89d9542a4ce38281f325cfe0be590cb45ce8937375b4d13e67970518e6381531f46087689e58f3b8d0c5156
+  metadata.gz: e43613b26de17bca55c264a4892a3c20684fcc5c6e285c2407249c6369218d82650bdfb0e8963fd43c19c25a5fe24d885c4074894c8bc28fc105a0ba2dbfbb6e
+  data.tar.gz: 4697e89105ef1bcd388a72af2505d3b1d19ea5fa0f1c3867d3fca0313d0c470d38b92eb89fa477e6782fbd83dff3e32300cfd812b67dd06b472fd6747480b10a

data/.rubocop.yml

@@ -3,7 +3,7 @@ require:
   - rubocop-performance
   - rubocop-rake
   - rubocop-rspec
-  - sevencop
+  - ./lib/sevencop
 
 AllCops:
   NewCops: enable

data/Gemfile.lock

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

data/README.md

@@ -36,27 +36,16 @@ Note that all cops are `Enabled: false` by default.
 - [Sevencop/MethodDefinitionInIncluded](lib/rubocop/cop/sevencop/method_definition_in_included.rb)
 - [Sevencop/MethodDefinitionKeywordArgumentOrdered](lib/rubocop/cop/sevencop/method_definition_keyword_argument_ordered.rb)
 - [Sevencop/MethodDefinitionOrdered](lib/rubocop/cop/sevencop/method_definition_ordered.rb)
+- [Sevencop/RailsActionName](lib/rubocop/cop/sevencop/rails_action_name.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)
+
+## Notes
+
+All migration related cops are moved to [r7kamura/rubocop-migration](https://github.com/r7kamura/rubocop-migration).

data/config/default.yml

@@ -68,6 +68,22 @@ Sevencop/MethodDefinitionKeywordArgumentOrdered:
   Safe: false
   VersionAdded: '0.13'
 
+Sevencop/RailsActionName:
+  Description: |
+    Use only specific action names.
+  Enabled: false
+  VersionAdded: '0.24'
+  ActionNames:
+    - create
+    - destroy
+    - edit
+    - index
+    - new
+    - show
+    - update
+  Include:
+    - app/controllers/**/*.rb
+
 Sevencop/RailsBelongsToOptional:
   Description: |
     Force `belongs_to` with `optional: true` option.
@@ -82,149 +98,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/rubocop/cop/sevencop/rails_action_name.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Sevencop
+      # Use only specific action names.
+      #
+      # @example
+      #   # bad
+      #   class UsersController < ApplicationController
+      #     def articles
+      #     end
+      #   end
+      #
+      #   # good
+      #   class UserArticlesController < ApplicationController
+      #     def index
+      #     end
+      #   end
+      class RailsActionName < Base
+        include VisibilityHelp
+
+        MSG = 'Use only specific action names.'
+
+        # @param node [RuboCop::AST::DefNode]
+        # @return [void]
+        def on_def(node)
+          return unless bad?(node)
+
+          add_offense(node.location.name)
+        end
+
+        private
+
+        # @param node [RuboCop::AST::DefNode]
+        # @return [Boolean]
+        def action?(node)
+          node_visibility(node) == :public
+        end
+
+        # @param node [RuboCop::AST::DefNode]
+        # @return [Boolean]
+        def bad?(node)
+          action?(node) &&
+            !configured_action_name?(node)
+        end
+
+        # @param node [RuboCop::AST::DefNode]
+        # @return [Boolean]
+        def configured_action_name?(node)
+          configured_action_names.include?(node.method_name.to_s)
+        end
+
+        # @return [Array<String>]
+        def configured_action_names
+          cop_config['ActionNames']
+        end
+      end
+    end
+  end
+end

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

@@ -33,30 +33,43 @@ module RuboCop
         # @param node [RuboCop::AST::SendNode]
         # @return [void]
         def on_send(node)
-          return unless top_level_describe?(node)
-          return unless node.first_argument
-          return if http_endpoint_identifier?(node.first_argument)
+          return unless bad?(node)
 
           add_offense(node.first_argument)
         end
 
         private
 
-        # @!method top_level_describe?(node)
+        # @!method describing_http_endpoint_identifier?(node)
         #   @param node [RuboCop::AST::SendNode]
         #   @return [Boolean]
-        def_node_matcher :top_level_describe?, <<~PATTERN
+        def_node_matcher :describing_http_endpoint_identifier?, <<~PATTERN
           (send
-            (const nil? :RSpec)
+            _
             :describe
+            (str DESCRIPTION_PATTERN)
             ...
           )
         PATTERN
 
-        # @param node [RuboCop::AST::Node, nil]
-        # @return [Boolean]
-        def http_endpoint_identifier?(node)
-          node&.str_type? && node.value.match?(DESCRIPTION_PATTERN)
+        # @!method describing_at_top_level?(node)
+        #   @param node [RuboCop::AST::SendNode]
+        #   @return [Boolean]
+        def_node_matcher :describing_at_top_level?, <<~PATTERN
+          (send
+            (const
+              {nil? cbase}
+              :RSpec
+            )
+            :describe
+            ...
+          )
+        PATTERN
+
+        # @param node [RuboCop::AST::SendNode]
+        def bad?(node)
+          describing_at_top_level?(node) &&
+            !describing_http_endpoint_identifier?(node)
         end
       end
     end

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.24.2'
 end

data/lib/sevencop.rb

@@ -12,24 +12,9 @@ require_relative 'rubocop/cop/sevencop/method_definition_arguments_multiline'
 require_relative 'rubocop/cop/sevencop/method_definition_in_included'
 require_relative 'rubocop/cop/sevencop/method_definition_keyword_argument_ordered'
 require_relative 'rubocop/cop/sevencop/method_definition_ordered'
+require_relative 'rubocop/cop/sevencop/rails_action_name'
 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.24.2
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-16 00:00:00.000000000 Z
+date: 2022-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -64,24 +64,9 @@ files:
 - lib/rubocop/cop/sevencop/method_definition_in_included.rb
 - lib/rubocop/cop/sevencop/method_definition_keyword_argument_ordered.rb
 - lib/rubocop/cop/sevencop/method_definition_ordered.rb
+- lib/rubocop/cop/sevencop/rails_action_name.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 +76,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