rubocop-rspec 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1531e973244c7aac66856335d340dee502696e988f9816bf74e7f5555d80d90
-  data.tar.gz: b634d15c53e126f497928eca6adfa6fae08b095ccb1a93f3d906826bca56efd4
+  metadata.gz: 4a953b5fa50cd545314cbe25e453b476b670cd2a4eb2d60c75109354ed7c333c
+  data.tar.gz: be5782eb1c0f8e4ca86b28ed39fba908719afe73dd544a161885719485853a89
 SHA512:
-  metadata.gz: e91e8656f9f82f02fa041d5795d01eba023460aad4e3c06b55167b3f92fc0d22324250e1d116eb63c3b60e915240347f0a36cbe14c8b3752f7c6a63ea9949bd4
-  data.tar.gz: 8c470782145e23962f3653beb13b4543d461a3de9bbea201d5fb0c66fc8bfebb5695afad7bc545b37dba664362dee8edb0f579441f0bafcd963ab86f503b0415
+  metadata.gz: e859b8c055f4502d3156595c8293decfe10883a6bea0f61a21558b9acc771b1231699439611a3da3ccb0841495ad7c1a5af3ec1c6d3e948fbb29b70a0b77289d
+  data.tar.gz: a817dcdbcd1850d4888f4d5fc58837a1c8c59fa754f10dff0aa3eebf24013e88230d84719592115b3339551ac2c932240d01bac1b8a5094982943f1a9e960908

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 ## Master (Unreleased)
 
+## 2.3.0 (2021-04-28)
+
+* Allow `RSpec/ContextWording` to accept multi-word prefixes. ([@hosamaly][])
+* Drop support for ruby 2.4. ([@bquorning][])
+* Add `CountAsOne` configuration option to `RSpec/ExampleLength`. ([@stephannv][])
+* Fix a false positive for `RSpec/RepeatedExampleGroupBody` when `pending` or `skip` have argument(s). ([@Tietew][])
+
 ## 2.2.0 (2021-02-02)
 
 * Fix `HooksBeforeExamples`, `LeadingSubject`, `LetBeforeExamples` and `ScatteredLet` autocorrection to take into account inline comments and comments immediately before the moved node. ([@Darhazer][])
@@ -603,3 +610,6 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
 [@sl4vr]: https://github.com/sl4vr
 [@ahukkanen]: https://github.com/ahukkanen
 [@dvandersluis]: https://github.com/dvandersluis
+[@hosamaly]: https://github.com/hosamaly
+[@stephannv]: https://github.com/stephannv
+[@Tietew]: https://github.com/Tietew

data/README.md

@@ -2,12 +2,12 @@
 
 [![Join the chat at https://gitter.im/rubocop-rspec/Lobby](https://badges.gitter.im/rubocop-rspec/Lobby.svg)](https://gitter.im/rubocop-rspec/Lobby)
 [![Gem Version](https://badge.fury.io/rb/rubocop-rspec.svg)](https://rubygems.org/gems/rubocop-rspec)
-[![CircleCI](https://circleci.com/gh/rubocop-hq/rubocop-rspec.svg?style=svg)](https://circleci.com/gh/rubocop-hq/rubocop-rspec)
+[![CircleCI](https://circleci.com/gh/rubocop/rubocop-rspec.svg?style=svg)](https://circleci.com/gh/rubocop/rubocop-rspec)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/8ffaabf633c968c22bdd/test_coverage)](https://codeclimate.com/github/rubocop-hq/rubocop-rspec/test_coverage)
 [![Maintainability](https://api.codeclimate.com/v1/badges/8ffaabf633c968c22bdd/maintainability)](https://codeclimate.com/github/rubocop-hq/rubocop-rspec/maintainability)
 
 RSpec-specific analysis for your projects, as an extension to
-[RuboCop](https://github.com/rubocop-hq/rubocop).
+[RuboCop](https://github.com/rubocop/rubocop).
 
 ## Installation
 

data/config/default.yml

@@ -253,7 +253,9 @@ RSpec/ExampleLength:
   Description: Checks for long examples.
   Enabled: true
   Max: 5
+  CountAsOne: []
   VersionAdded: '1.5'
+  VersionChanged: '2.3'
   StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/ExampleLength
 
 RSpec/ExampleWithoutDescription:

data/lib/rubocop/cop/rspec/around_block.rb

@@ -30,10 +30,12 @@ module RuboCop
         MSG_UNUSED_ARG = 'You should call `%<arg>s.call` ' \
                          'or `%<arg>s.run`.'
 
+        # @!method hook(node)
         def_node_matcher :hook, <<-PATTERN
           (block (send nil? :around sym ?) (args $...) ...)
         PATTERN
 
+        # @!method find_arg_usage(node)
         def_node_search :find_arg_usage, <<-PATTERN
           {(send $... {:call :run}) (send _ _ $...) (yield $...) (block-pass $...)}
         PATTERN

data/lib/rubocop/cop/rspec/be.rb

@@ -22,6 +22,7 @@ module RuboCop
       class Be < Base
         MSG = "Don't use `be` without an argument."
 
+        # @!method be_without_args(node)
         def_node_matcher :be_without_args, <<-PATTERN
           (send _ #Runners.all $(send nil? :be))
         PATTERN

data/lib/rubocop/cop/rspec/be_eql.rb

@@ -41,6 +41,7 @@ module RuboCop
         MSG = 'Prefer `be` over `eql`.'
         RESTRICT_ON_SEND = %i[to].freeze
 
+        # @!method eql_type_with_identity(node)
         def_node_matcher :eql_type_with_identity, <<-PATTERN
           (send _ :to $(send nil? :eql {true false int float sym nil_type?}))
         PATTERN

data/lib/rubocop/cop/rspec/before_after_all.rb

@@ -31,6 +31,7 @@ module RuboCop
 
         RESTRICT_ON_SEND = %i[before after].freeze
 
+        # @!method before_or_after_all(node)
         def_node_matcher :before_or_after_all, <<-PATTERN
           $(send _ {:before :after} (sym {:all :context}))
         PATTERN

data/lib/rubocop/cop/rspec/capybara/current_path_expectation.rb

@@ -32,17 +32,20 @@ module RuboCop
 
           RESTRICT_ON_SEND = %i[expect].freeze
 
+          # @!method expectation_set_on_current_path(node)
           def_node_matcher :expectation_set_on_current_path, <<-PATTERN
             (send nil? :expect (send {(send nil? :page) nil?} :current_path))
           PATTERN
 
           # Supported matchers: eq(...) / match(/regexp/) / match('regexp')
+          # @!method as_is_matcher(node)
           def_node_matcher :as_is_matcher, <<-PATTERN
             (send
               #expectation_set_on_current_path $#Runners.all
               ${(send nil? :eq ...) (send nil? :match (regexp ...))})
           PATTERN
 
+          # @!method regexp_str_matcher(node)
           def_node_matcher :regexp_str_matcher, <<-PATTERN
             (send
               #expectation_set_on_current_path $#Runners.all

data/lib/rubocop/cop/rspec/capybara/feature_methods.rb

@@ -55,16 +55,19 @@ module RuboCop
             feature:    :describe
           }.freeze
 
+          # @!method capybara_speak(node)
           def_node_matcher :capybara_speak, <<-PATTERN
             {#{MAP.keys.map(&:inspect).join(' ')}}
           PATTERN
 
+          # @!method spec?(node)
           def_node_matcher :spec?, <<-PATTERN
             (block
               (send #rspec? {:describe :feature} ...)
             ...)
           PATTERN
 
+          # @!method feature_method(node)
           def_node_matcher :feature_method, <<-PATTERN
             (block
               $(send #rspec? $#capybara_speak ...)

data/lib/rubocop/cop/rspec/capybara/visibility_matcher.rb

@@ -46,10 +46,12 @@ module RuboCop
 
           RESTRICT_ON_SEND = CAPYBARA_MATCHER_METHODS
 
+          # @!method visible_true?(node)
           def_node_matcher :visible_true?, <<~PATTERN
             (send nil? #capybara_matcher? ... (hash <$(pair (sym :visible) true) ...>))
           PATTERN
 
+          # @!method visible_false?(node)
           def_node_matcher :visible_false?, <<~PATTERN
             (send nil? #capybara_matcher? ... (hash <$(pair (sym :visible) false) ...>))
           PATTERN

data/lib/rubocop/cop/rspec/context_method.rb

@@ -28,6 +28,7 @@ module RuboCop
 
         MSG = 'Use `describe` for testing methods.'
 
+        # @!method context_method(node)
         def_node_matcher :context_method, <<-PATTERN
           (block (send #rspec? :context $(str #method_name?) ...) ...)
         PATTERN

data/lib/rubocop/cop/rspec/context_wording.rb

@@ -8,6 +8,7 @@ module RuboCop
       # The default list of prefixes is minimal. Users are encouraged to tailor
       # the configuration to meet project needs. Other acceptable prefixes may
       # include `if`, `unless`, `for`, `before`, `after`, or `during`.
+      # They may consist of multiple words if desired.
       #
       # @see https://rspec.rubystyle.guide/#context-descriptions
       # @see http://www.betterspecs.org/#contexts
@@ -37,6 +38,7 @@ module RuboCop
       class ContextWording < Base
         MSG = 'Start context description with %<prefixes>s.'
 
+        # @!method context_wording(node)
         def_node_matcher :context_wording, <<-PATTERN
           (block (send #rspec? { :context :shared_context } $(str #bad_prefix?) ...) ...)
         PATTERN
@@ -51,7 +53,7 @@ module RuboCop
         private
 
         def bad_prefix?(description)
-          !prefixes.include?(description.split(/\b/).first)
+          !prefix_regex.match?(description)
         end
 
         def joined_prefixes
@@ -65,6 +67,10 @@ module RuboCop
         def prefixes
           cop_config['Prefixes'] || []
         end
+
+        def prefix_regex
+          /^#{Regexp.union(prefixes)}\b/
+        end
       end
     end
   end

data/lib/rubocop/cop/rspec/describe_class.rb

@@ -40,14 +40,17 @@ module RuboCop
         MSG = 'The first argument to describe should be ' \
               'the class or module being tested.'
 
+        # @!method example_group_with_ignored_metadata?(node)
         def_node_matcher :example_group_with_ignored_metadata?, <<~PATTERN
           (send #rspec? :describe ... (hash <#ignored_metadata? ...>))
         PATTERN
 
+        # @!method not_a_const_described(node)
         def_node_matcher :not_a_const_described, <<~PATTERN
           (send #rspec? :describe $[!const !#string_constant?] ...)
         PATTERN
 
+        # @!method sym_pair(node)
         def_node_matcher :sym_pair, <<~PATTERN
           (pair $sym $sym)
         PATTERN

data/lib/rubocop/cop/rspec/describe_method.rb

@@ -22,6 +22,7 @@ module RuboCop
         MSG = 'The second argument to describe should be the method ' \
               "being tested. '#instance' or '.class'."
 
+        # @!method second_argument(node)
         def_node_matcher :second_argument, <<~PATTERN
           (block
             (send #rspec? :describe _first_argument $(str _) ...) ...

data/lib/rubocop/cop/rspec/describe_symbol.rb

@@ -21,6 +21,7 @@ module RuboCop
         MSG = 'Avoid describing symbols.'
         RESTRICT_ON_SEND = %i[describe].freeze
 
+        # @!method describe_symbol?(node)
         def_node_matcher :describe_symbol?, <<-PATTERN
           (send #rspec? :describe $sym ...)
         PATTERN

data/lib/rubocop/cop/rspec/described_class.rb

@@ -61,18 +61,23 @@ module RuboCop
         DESCRIBED_CLASS = 'described_class'
         MSG             = 'Use `%<replacement>s` instead of `%<src>s`.'
 
+        # @!method common_instance_exec_closure?(node)
         def_node_matcher :common_instance_exec_closure?, <<-PATTERN
           (block (send (const nil? {:Class :Module :Struct}) :new ...) ...)
         PATTERN
 
+        # @!method rspec_block?(node)
         def_node_matcher :rspec_block?, block_pattern('#ALL.all')
 
+        # @!method scope_changing_syntax?(node)
         def_node_matcher :scope_changing_syntax?, '{def class module}'
 
+        # @!method described_constant(node)
         def_node_matcher :described_constant, <<-PATTERN
           (block (send _ :describe $(const ...) ...) (args) $_)
         PATTERN
 
+        # @!method contains_described_class?(node)
         def_node_search :contains_described_class?, <<-PATTERN
           (send nil? :described_class)
         PATTERN

data/lib/rubocop/cop/rspec/described_class_module_wrapping.rb

@@ -18,10 +18,11 @@ module RuboCop
       #     # ...
       #   end
       #
-      # @see https://github.com/rubocop-hq/rubocop-rspec/issues/735
+      # @see https://github.com/rubocop/rubocop-rspec/issues/735
       class DescribedClassModuleWrapping < Base
         MSG = 'Avoid opening modules and defining specs within them.'
 
+        # @!method find_rspec_blocks(node)
         def_node_search :find_rspec_blocks, block_pattern('#ExampleGroups.all')
 
         def on_module(node)

data/lib/rubocop/cop/rspec/dialect.rb

@@ -47,6 +47,7 @@ module RuboCop
 
         MSG = 'Prefer `%<prefer>s` over `%<current>s`.'
 
+        # @!method rspec_method?(node)
         def_node_matcher :rspec_method?, send_pattern('#ALL.all')
 
         def on_send(node)

data/lib/rubocop/cop/rspec/empty_hook.rb

@@ -28,6 +28,7 @@ module RuboCop
 
         MSG = 'Empty hook detected.'
 
+        # @!method empty_hook?(node)
         def_node_matcher :empty_hook?, <<~PATTERN
           (block $#{send_pattern('#Hooks.all')} _ nil?)
         PATTERN

data/lib/rubocop/cop/rspec/example_length.rb

@@ -25,29 +25,43 @@ module RuboCop
       #     result = service.call
       #     expect(result).to be(true)
       #   end
+      #
+      # You can set literals you want to fold with `CountAsOne`.
+      # Available are: 'array', 'hash', and 'heredoc'. Each literal
+      # will be counted as one line regardless of its actual size.
+      #
+      # @example CountAsOne: ['array', 'heredoc']
+      #
+      #   it do
+      #     array = [         # +1
+      #       1,
+      #       2
+      #     ]
+      #
+      #     hash = {          # +3
+      #       key: 'value'
+      #     }
+      #
+      #     msg = <<~HEREDOC  # +1
+      #       Heredoc
+      #       content.
+      #     HEREDOC
+      #   end                 # 5 points
       class ExampleLength < Base
         include CodeLength
 
-        MSG = 'Example has too many lines [%<total>d/%<max>d].'
+        LABEL = 'Example'
 
         def on_block(node)
           return unless example?(node)
 
-          length = code_length(node)
-
-          return unless length > max_length
-
-          add_offense(node, message: message(length))
+          check_code_length(node)
         end
 
         private
 
-        def code_length(node)
-          node.source.lines[1..-2].count { |line| !irrelevant_line(line) }
-        end
-
-        def message(length)
-          format(MSG, total: length, max: max_length)
+        def cop_label
+          LABEL
         end
       end
     end

data/lib/rubocop/cop/rspec/example_without_description.rb

@@ -54,6 +54,7 @@ module RuboCop
                                'have auto-generated description.'
         MSG_ADD_DESCRIPTION  = 'Add a description.'
 
+        # @!method example_description(node)
         def_node_matcher :example_description, '(send nil? _ $(str $_))'
 
         def on_block(node)

data/lib/rubocop/cop/rspec/example_wording.rb

@@ -38,6 +38,7 @@ module RuboCop
         SHOULD_PREFIX = /\Ashould(?:n't)?\b/i.freeze
         IT_PREFIX     = /\Ait /i.freeze
 
+        # @!method it_description(node)
         def_node_matcher :it_description, <<-PATTERN
           (block (send _ :it ${
             (str $_)

data/lib/rubocop/cop/rspec/expect_actual.rb

@@ -45,6 +45,7 @@ module RuboCop
 
         SUPPORTED_MATCHERS = %i[eq eql equal be].freeze
 
+        # @!method expect_literal(node)
         def_node_matcher :expect_literal, <<~PATTERN
           (send
             (send nil? :expect $#literal?)

data/lib/rubocop/cop/rspec/expect_change.rb

@@ -37,10 +37,12 @@ module RuboCop
         MSG_CALL = 'Prefer `change { %<obj>s.%<attr>s }`.'
         RESTRICT_ON_SEND = %i[change].freeze
 
+        # @!method expect_change_with_arguments(node)
         def_node_matcher :expect_change_with_arguments, <<-PATTERN
           (send nil? :change ({const send} nil? $_) (sym $_))
         PATTERN
 
+        # @!method expect_change_with_block(node)
         def_node_matcher :expect_change_with_block, <<-PATTERN
           (block
             (send nil? :change)

data/lib/rubocop/cop/rspec/expect_in_hook.rb

@@ -23,6 +23,7 @@ module RuboCop
       class ExpectInHook < Base
         MSG = 'Do not use `%<expect>s` in `%<hook>s` hook'
 
+        # @!method expectation(node)
         def_node_search :expectation, send_pattern('#Expectations.all')
 
         def on_block(node)

data/lib/rubocop/cop/rspec/factory_bot/attribute_defined_statically.rb

@@ -29,10 +29,12 @@ module RuboCop
 
           MSG = 'Use a block to declare attribute values.'
 
+          # @!method value_matcher(node)
           def_node_matcher :value_matcher, <<-PATTERN
             (send _ !#reserved_method? $...)
           PATTERN
 
+          # @!method factory_attributes(node)
           def_node_matcher :factory_attributes, <<-PATTERN
             (block (send _ #attribute_defining_method? ...) _ { (begin $...) $(send ...) } )
           PATTERN
@@ -79,6 +81,7 @@ module RuboCop
             value_matcher(attribute).to_a.all?(&:block_pass_type?)
           end
 
+          # @!method association?(node)
           def_node_matcher :association?, '(hash <(pair (sym :factory) _) ...>)'
 
           def autocorrect_replacing_parens(corrector, node)

data/lib/rubocop/cop/rspec/factory_bot/create_list.rb

@@ -32,6 +32,7 @@ module RuboCop
           MSG_N_TIMES = 'Prefer %<number>s.times.'
           RESTRICT_ON_SEND = %i[create_list].freeze
 
+          # @!method n_times_block_without_arg?(node)
           def_node_matcher :n_times_block_without_arg?, <<-PATTERN
             (block
               (send (int _) :times)
@@ -40,10 +41,12 @@ module RuboCop
             )
           PATTERN
 
+          # @!method factory_call(node)
           def_node_matcher :factory_call, <<-PATTERN
             (send ${(const nil? {:FactoryGirl :FactoryBot}) nil?} :create (sym $_) $...)
           PATTERN
 
+          # @!method factory_list_call(node)
           def_node_matcher :factory_list_call, <<-PATTERN
             (send {(const nil? {:FactoryGirl :FactoryBot}) nil?} :create_list (sym _) (int $_) ...)
           PATTERN