sevencop 0.24.3 → 0.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2de685c5ac228ea5d73a3e69cc4440d6f101f4defd72e6b2a48eb472b79cf7c7
-  data.tar.gz: 99f300aba16238c5ec418dcae77d787dee4c7c5b8eaba4231b5515e84e66881e
+  metadata.gz: 922dc5655a1c67a3c6cbe88b4f5b4ca72fc6a504acb678451ca2aece5a7ac0b8
+  data.tar.gz: f00c654f92a7c6a26e4b6514dbaf68adc3a0a6c62efd7f113740675b0104a53f
 SHA512:
-  metadata.gz: eb3ee7eedc5dcb05edb4ef88ead51db016ad9ca6e8e552c610b63285cb6b1de493bcec9b2951049253624f392949465eab8b0ddbda948c40a530171f041e1281
-  data.tar.gz: cdb6c950a0264ccfb74aef21c03cc3a200365b0de3fc3dca785ef79ab781d70cae40d49182ca842e5a41e5d95ae6e48dc429a79c9864d56ee7906cb937cb83a4
+  metadata.gz: 6f21bb92a5a4409c777ba0770728f2e03d9ddc3fcebd75f5204f628155b99dbbf25006f37af1f5fdd58742cdce53400e201708194d5db46da5a53d5a269bc004
+  data.tar.gz: 7c1ecca97ecacebad51e38ff1005e7c500586b85f6d4ee3de816dc3ddb846cd0faeca19520ca5dd1edf1f0296b94a6fc631a53deaf8bb4745021f4fdfccdb08c

data/Gemfile.lock

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

data/config/default.yml

@@ -128,7 +128,7 @@ Sevencop/RequireOrdered:
 
 Sevencop/RSpecDescribeHttpEndpoint:
   Description: |
-    Pass HTTP endpoint identifier to top-level `describe` on request-specs.
+    Pass HTTP endpoint identifier (e.g. `GET /users`) to top-level `describe` on request-specs.
   Enabled: false
   VersionAdded: '0.18'
   Include:
@@ -139,6 +139,7 @@ Sevencop/RSpecExamplesInSameGroup:
     Combine examples in the same groups in the time-consuming kinds of specs.
   Enabled: false
   VersionAdded: '0.17'
+  IncludeSharedExamples: false
   Include:
     - spec/controllers/**/*
     - spec/requests/**/*

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

@@ -3,7 +3,11 @@
 module RuboCop
   module Cop
     module Sevencop
-      # Pass HTTP endpoint identifier to top-level `describe` on request-specs.
+      # Pass HTTP endpoint identifier (e.g. `GET /users`) to top-level `describe` on request-specs.
+      #
+      # In request-specs, one should be aware that it is a test type for endpoints at HTTP layer.
+      # Therefore it is good practice to put the HTTP method and path in the top-level description
+      # and to separate examples groups by each endpoint.
       #
       # @see https://github.com/r7kamura/rspec-request_describer
       #
@@ -14,7 +18,7 @@ module RuboCop
       #   # good
       #   RSpec.describe 'GET /users'
       class RSpecDescribeHttpEndpoint < Base
-        MSG = 'Pass HTTP endpoint identifier to top-level `describe` on request-specs.'
+        MSG = 'Pass HTTP endpoint identifier (e.g. `GET /users`) to top-level `describe` on request-specs.'
 
         RESTRICT_ON_SEND = %i[
           describe

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

@@ -6,7 +6,6 @@ module RuboCop
       # Combine examples in same group in the time-consuming kinds of specs.
       #
       # @example
-      #
       #   # bad
       #   context 'when user is logged in' do
       #     it 'returns 200' do
@@ -27,20 +26,42 @@ module RuboCop
       #     end
       #   end
       #
+      #   # bad - IncludeSharedExamples: true
+      #   context 'when user is logged in' do
+      #     it 'returns 200' do
+      #       subject
+      #       expect(response).to have_http_status(200)
+      #     end
+      #
+      #     includes_examples 'creates Foo'
+      #   end
       class RSpecExamplesInSameGroup < Base
-        EXAMPLE_METHOD_NAMES_REGULAR = ::Set[
+        METHOD_NAMES_FOR_REGULAR_EXAMPLE = ::Set[
+          :example,
           :it,
           :its,
-          :specify,
-          :example,
           :scenario,
+          :specify
         ].freeze
 
+        METHOD_NAMES_FOR_SHARED_EXAMPLES = ::Set[
+          :include_examples,
+          :it_behaves_like,
+          :it_should_behave_like
+        ]
+
         MSG = 'Combine examples in the same group in the time-consuming kinds of specs.'
 
-        # @param node [RuboCop::AST::BlockNode]
+        RESTRICT_ON_SEND = [
+          *METHOD_NAMES_FOR_REGULAR_EXAMPLE,
+          *METHOD_NAMES_FOR_SHARED_EXAMPLES
+        ].freeze
+
+        # @param node [RuboCop::AST::SendNode]
         # @return [void]
-        def on_block(node)
+        def on_send(node)
+          node = node.block_node || node
+
           return unless example?(node)
 
           previous_sibling_example = previous_sibling_example_of(node)
@@ -48,27 +69,45 @@ module RuboCop
 
           add_offense(node)
         end
-        alias on_numblock on_block
 
         private
 
-        # @!method example?(node)
-        #   @param node [RuboCop::AST::Node]
-        #   @return [Boolean]
-        def_node_matcher :example?, <<~PATTERN
-          (block
-            (send nil? EXAMPLE_METHOD_NAMES_REGULAR ...)
-            ...
-          )
-        PATTERN
+        # @param node [RuboCop::AST::BlockNode, RuboCop::AST::SendNode]
+        # @return [Boolean]
+        def example?(node)
+          if include_shared_examples?
+            regular_example?(node) || shared_example?(node)
+          else
+            regular_example?(node)
+          end
+        end
+
+        # @return [Boolean]
+        def include_shared_examples?
+          cop_config['IncludeSharedExamples']
+        end
 
-        # @param node [RuboCop::AST::BlockNode]
-        # @return [RuboCop::AST::BlockNode, nil]
+        # @param node [RuboCop::AST::BlockNode, RuboCop::AST::SendNode]
+        # @return [RuboCop::AST::BlockNode, RuboCop::AST::SendNode, nil]
         def previous_sibling_example_of(node)
+          return unless node.parent&.begin_type?
+
           node.left_siblings.find do |sibling|
             sibling.is_a?(::RuboCop::AST::Node) && example?(sibling)
           end
         end
+
+        # @param node [RuboCop::AST::BlockNode, RuboCop::AST::SendNode]
+        # @return [Boolean]
+        def regular_example?(node)
+          METHOD_NAMES_FOR_REGULAR_EXAMPLE.include?(node.method_name)
+        end
+
+        # @param node [RuboCop::AST::BlockNode, RuboCop::AST::SendNode]
+        # @return [Boolean]
+        def shared_example?(node)
+          METHOD_NAMES_FOR_SHARED_EXAMPLES.include?(node.method_name)
+        end
       end
     end
   end

data/lib/sevencop/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sevencop
 version: !ruby/object:Gem::Version
-  version: 0.24.3
+  version: 0.25.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-24 00:00:00.000000000 Z
+date: 2022-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport