sevencop 0.23.0 → 0.24.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f1682050c56b200417e16dfd5e9f90898838834b29609ef01548b40ab4d4700
-  data.tar.gz: f44e1c9e38ee48b6719e7df278d7858d9f6dc846c3469a96d11975b5a0d572b9
+  metadata.gz: 47139f7d9fb3b1e73416958e9f2f87ccafa4145864e046a1539ffd33018bd603
+  data.tar.gz: f9c759a3adbbf7e25b327755c8d5fc0a00d5f6438f79b4df3e33d138ca296fb7
 SHA512:
-  metadata.gz: 5c3fe3df83f0a4aef3503cfe39d8d82262c1dfd3bdd5b8745922a2649991d56c208d9a6ccc8a6b2f87757e7cdb1423e33f97869a39f4172984c15b4941797df9
-  data.tar.gz: e9dc4ceaac5717391ba294a3995572e9cce89f3316104d2e2139af30fc994d60a9e13c0ee2eb864566b27b2e6d04ff634f0b714d1d93c0ce1f4d969294bf2da9
+  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.23.0)
+    sevencop (0.24.2)
       activesupport
       rubocop
 

data/README.md

@@ -36,6 +36,7 @@ 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/RailsOrderField](lib/rubocop/cop/sevencop/rails_order_field.rb)
@@ -44,3 +45,7 @@ Note that all cops are `Enabled: false` by default.
 - [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.

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/version.rb

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

data/lib/sevencop.rb

@@ -12,6 +12,7 @@ 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_order_field'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sevencop
 version: !ruby/object:Gem::Version
-  version: 0.23.0
+  version: 0.24.2
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-19 00:00:00.000000000 Z
+date: 2022-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -64,6 +64,7 @@ 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_order_field.rb