sevencop 0.17.2 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb03ae9347c8419a82327535021c4567f50ee667fa6b49d01de0766c9db17b19
-  data.tar.gz: 219b887de52c24ffd4c6baf30b6443311e297b4ef1e3b03895d60f874b145b1f
+  metadata.gz: 4a5c6bd0519b94116517f840ad8b192901dc75c15ebe65abc448f5eb5bb35a5b
+  data.tar.gz: db75fc90b34060eb00308bb14182e3513465243ab9f24739f7baa7f90f374abe
 SHA512:
-  metadata.gz: 4a8c1fba03d1a7e5bacae6aa878f9d6284c8b1c5becd745285b5e5f3910784ecc5b815191d0a1f4c7f0e6ee06e70109a58af8bd5dd78797bacaf053a7857e42b
-  data.tar.gz: b0d4562158515e27a4bbc8c3e90a633bcaeb548267ab208b92e55931416b843340c5b2a528f3bcfbd72f430701513aeda02fcbfb2dc8602945456a94eb1ece4d
+  metadata.gz: 4c1fa9ec76954f0f2fb8a7db9fb3ed328ef6dfbd9a7e98997abfbc2fe277af1771453ea954df373e42600e629eda7561b74ec21a73fc7e783742e32aff3f2be8
+  data.tar.gz: bf3f45bf67ccdd187355c81c586eb46903696c89d3234eabb1009938cbc62a7866a4158aec3ff91f1cdf7d4c4fcc59171c8f9e5f7c316ffdf8fe76a8d93dc7f9

data/.rubocop.yml

@@ -28,6 +28,7 @@ RSpec/ExampleLength:
 
 RSpec/FilePath:
   CustomTransform:
+    RSpecDescribeHttpEndpoint: rspec_describe_http_endpoint
     RSpecExamplesInSameGroup: rspec_examples_in_same_group
 
 RSpec/MultipleExpectations:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sevencop (0.17.2)
+    sevencop (0.18.0)
       rubocop
 
 GEM

data/README.md

@@ -39,6 +39,7 @@ Choose the cops you want to use and enable them on your .rubocop.yml.
 - [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

@@ -68,6 +68,14 @@ Sevencop/RequireOrdered:
   Enabled: false
   VersionAdded: '0.16'
 
+Sevencop/RSpecDescribeHttpEndpoint:
+  Description: |
+    Pass HTTP endpoint identifier to top-level `describe` on request-specs.
+  Enabled: false
+  VersionAdded: '0.18'
+  Include:
+    - spec/requests/**/*.rb
+
 Sevencop/RSpecExamplesInSameGroup:
   Description: |
     Combine examples in the same groups in the time-consuming kinds of specs.

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

@@ -40,9 +40,7 @@ module RuboCop
           previous_older_sibling = find_previous_older_sibling(node)
           return unless previous_older_sibling
 
-          add_offense(
-            range_with_comments(node)
-          ) do |corrector|
+          add_offense(node) do |corrector|
             swap(
               range_with_comments_and_lines(previous_older_sibling),
               range_with_comments_and_lines(node),

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

@@ -52,7 +52,7 @@ module RuboCop
           return unless previous_older_sibling
 
           add_offense(
-            range_with_comments(node),
+            node,
             message: "Sort `#{node.method_name}` in alphabetical order."
           ) do |corrector|
             swap(

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Sevencop
+      # Pass HTTP endpoint identifier to top-level `describe` on request-specs.
+      #
+      # @see https://github.com/r7kamura/rspec-request_describer
+      #
+      # @example
+      #   # bad
+      #   RSpec.describe 'Users'
+      #
+      #   # good
+      #   RSpec.describe 'GET /users'
+      class RSpecDescribeHttpEndpoint < Base
+        MSG = 'Pass HTTP endpoint identifier to top-level `describe` on request-specs.'
+
+        RESTRICT_ON_SEND = %i[
+          describe
+        ].freeze
+
+        SUPPORTED_HTTP_METHODS = %w[
+          DELETE
+          GET
+          PATCH
+          POST
+          PUT
+        ].freeze
+
+        DESCRIPTION_PATTERN = %r{\A#{::Regexp.union(SUPPORTED_HTTP_METHODS)} /}.freeze
+
+        # @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)
+
+          add_offense(node.first_argument)
+        end
+
+        private
+
+        # @!method top_level_describe?(node)
+        #   @param node [RuboCop::AST::SendNode]
+        #   @return [Boolean]
+        def_node_matcher :top_level_describe?, <<~PATTERN
+          (send
+            (const nil? :RSpec)
+            :describe
+            _
+          )
+        PATTERN
+
+        # @param node [RuboCop::AST::Node]
+        # @return [Boolean]
+        def http_endpoint_identifier?(node)
+          node.is_a?(::RuboCop::AST::StrNode) && node.value.match?(DESCRIPTION_PATTERN)
+        end
+      end
+    end
+  end
+end

data/lib/sevencop/cop_concerns/ordered.rb

@@ -5,23 +5,30 @@ module Sevencop
     module Ordered
       private
 
+      # @param range1 [Paresr::Source::Range]
+      # @param range2 [Paresr::Source::Range]
+      # @return [Paresr::Source::Range]
+      def add_range(
+        range1,
+        range2
+      )
+        range1.with(
+          begin_pos: [range1.begin_pos, range2.begin_pos].min,
+          end_pos: [range1.end_pos, range2.end_pos].max
+        )
+      end
+
       # @param node [RuboCop::AST::Node]
       # @return [Paresr::Source::Range]
       def range_with_comments(node)
-        comment = processed_source.ast_with_comments[node].first
-        if comment
-          node.location.expression.with(
-            begin_pos: [
-              comment.location.expression.begin_pos,
-              node.location.expression.begin_pos
-            ].min,
-            end_pos: [
-              comment.location.expression.end_pos,
-              node.location.expression.end_pos
-            ].max
-          )
-        else
-          node.location.expression
+        ranges = [
+          node,
+          *processed_source.ast_with_comments[node]
+        ].map do |element|
+          element.location.expression
+        end
+        ranges.reduce do |result, range|
+          add_range(result, range)
         end
       end
 

data/lib/sevencop/version.rb

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

data/lib/sevencop.rb

@@ -15,4 +15,5 @@ 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'
 require_relative 'rubocop/cop/sevencop/require_ordered'
+require_relative 'rubocop/cop/sevencop/rspec_describe_http_endpoint'
 require_relative 'rubocop/cop/sevencop/rspec_examples_in_same_group'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sevencop
 version: !ruby/object:Gem::Version
-  version: 0.17.2
+  version: 0.18.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-07 00:00:00.000000000 Z
+date: 2022-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -52,6 +52,7 @@ files:
 - lib/rubocop/cop/sevencop/rails_uniqueness_validator_explicit_case_sensitivity.rb
 - lib/rubocop/cop/sevencop/rails_where_not.rb
 - lib/rubocop/cop/sevencop/require_ordered.rb
+- lib/rubocop/cop/sevencop/rspec_describe_http_endpoint.rb
 - lib/rubocop/cop/sevencop/rspec_examples_in_same_group.rb
 - lib/sevencop.rb
 - lib/sevencop/config_loader.rb