rubocop-rspec 1.33.0 → 1.34.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53e671fa54f485f07186b567e9e44f7522db1e9508f5f723549c1f50f467ef68
-  data.tar.gz: 5f842a528fb62843a686e9674d4b94f5a44008afbc602c9babfb91ddf90ef4df
+  metadata.gz: b93f9fd4cff11c9b4a47a1bffca8e578bcf0e354320b461d63cdab7d01fad49b
+  data.tar.gz: 31244d48dd90be566b9f3b18dbe3f7c40112de41ef9fe9dbcbc282e20da2c66e
 SHA512:
-  metadata.gz: 1e03a650246098cb4498448db4e91846bb25643ea3673ec54db68678dbe80acefecbc69f20ca484addbea5f8a97a7dd84e3d21205b14da21cc74de45d8048501
-  data.tar.gz: 1d3cfdc4b32495be01056e6435bebaf1c1575bb37bda80973c31095ec4ce2f3556ce90ad9360e81102522869fa57c1f0eb6d005d670820b75df00c70e689131e
+  metadata.gz: ca99737cdb9ebea08757e8412974d678c846623798efab61a3a8e3e35ece75ccde9c3bcb41a2e800eeefa465ea955ee2683e843b62c0eda3698a0fa9f562fa05
+  data.tar.gz: ff707c6bd4b46f289beb68127b4b49a214c490914098aaadacf436c0efbf41511ef942cbeb52f50428310788d05fdeaf43be69a6bfe43bf5383fd50d7fe075d9

data/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 ## Master (Unreleased)
 
+## 1.34.0 (2019-07-23)
+
+* Remove `AggregateFailuresByDefault` config option of `RSpec/MultipleExpectations`. ([@pirj][])
+* Add `RSpec/LeakyConstantDeclaration` cop. ([@jonatas][], [@pirj][])
+* Improve `aggregate_failures` metadata detection of `RSpec/MultipleExpectations`. ([@pirj][])
+* Improve `RSpec/SubjectStub` detection and message. ([@pirj][])
+* Change message of `RSpec/LetSetup` cop to be more descriptive. ([@foton][])
+* Improve `RSpec/ExampleWording` to handle interpolated example messages. ([@nc-holodakg][])
+* Improve detection by allowing the use of `RSpec` as a top-level constant. ([@pirj][])
+* Fix `RSpec/DescribedClass`'s incorrect detection. ([@pirj][])
+* Improve `RSpec/DescribedClass`'s ability to detect inside modules and classes. ([@pirj][])
+
 ## 1.33.0 (2019-05-13)
 
 * Let `RSpec/DescribedClass` pass `Struct` instantiation closures. ([@schmijos][])
@@ -202,7 +214,7 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
 * Add [observed_nesting/max_nesting] info to `RSpec/NestedGroups` messages. ([@dgollahon][])
 * Add `RSpec/ItBehavesLike` cop. ([@dgollahon][])
 * Add `RSpec/SharedContext` cop. ([@Darhazer][])
-* `Rspec/MultipleExpectations`: Count aggregate_failures block as single expectation. ([@Darhazer][])
+* `RSpec/MultipleExpectations`: Count aggregate_failures block as single expectation. ([@Darhazer][])
 * Fix `ExpectActual` cop flagging `rspec-rails` routing specs. ([@backus][])
 * Fix `FilePath` cop not registering offenses for files like `spec/blog/user.rb` when it should be `spec/blog/user_spec.rb`. ([@backus][])
 
@@ -310,7 +322,7 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
 * Update to rubocop 0.37.2. ([@nijikon][])
 * Update ruby versions we test against. ([@nijikon][])
 * Add `RSpec::NotToNot` cop. ([@miguelfteixeira][])
-* Add `Rspec/AnyInstance` cop. ([@mlarraz][])
+* Add `RSpec/AnyInstance` cop. ([@mlarraz][])
 
 ## 1.3.1
 
@@ -418,3 +430,5 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
 [@mkenyon]: https://github.com/mkenyon
 [@gsamokovarov]: https://github.com/gsamokovarov
 [@schmijos]: https://github.com/schmijos
+[@foton]: https://github.com/foton
+[@nc-holodakg]: https://github.com/nc-holodakg

data/README.md

@@ -32,10 +32,18 @@ ways to do this:
 
 Put this into your `.rubocop.yml`.
 
-```
+```yaml
 require: rubocop-rspec
 ```
 
+Alternatively, use the following array notation when specifying multiple extensions.
+
+```yaml
+require:
+  - rubocop-other-extension
+  - rubocop-rspec
+```
+
 Now you can run `rubocop` and it will automatically load the RuboCop RSpec
 cops together with the standard cops.
 
@@ -119,7 +127,7 @@ is a feature of RSpec itself – you can read about it in the [RSpec Documentati
 Enforcing
 
 ```ruby
-Rspec.describe MyClass do
+RSpec.describe MyClass do
   ...
 end
 ```

data/config/default.yml

@@ -50,7 +50,7 @@ RSpec/BeforeAfterAll:
   StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/BeforeAfterAll
 
 RSpec/ContextWording:
-  Description: "`context` block descriptions should start with 'when', or 'with'."
+  Description: Checks that `context` docstring starts with an allowed prefix.
   Enabled: true
   Prefixes:
   - when
@@ -251,6 +251,11 @@ RSpec/LeadingSubject:
   Enabled: true
   StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/LeadingSubject
 
+RSpec/LeakyConstantDeclaration:
+  Description: Checks that no class, module, or constant is declared.
+  Enabled: true
+  StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/LeakyConstantDeclaration
+
 RSpec/LetBeforeExamples:
   Description: Checks for `let` definitions that come after an example.
   Enabled: true

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

@@ -33,7 +33,6 @@ module RuboCop
           disallowed_stub(node) do |method|
             add_offense(
               node,
-              location: :expression,
               message: format(MSG, method: method)
             )
           end

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

@@ -51,7 +51,7 @@ module RuboCop
         private
 
         def add_no_arg_offense(node)
-          add_offense(node, location: :expression, message: MSG_NO_ARG)
+          add_offense(node, message: MSG_NO_ARG)
         end
 
         def check_for_unused_proxy(block, proxy)
@@ -63,7 +63,6 @@ module RuboCop
 
           add_offense(
             proxy,
-            location: :expression,
             message: format(MSG_UNUSED_ARG, arg: name)
           )
         end

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

@@ -37,7 +37,6 @@ module RuboCop
           before_or_after_all(node) do |hook|
             add_offense(
               node,
-              location: :expression,
               message: format(MSG, hook: hook.source)
             )
           end

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

@@ -3,18 +3,22 @@
 module RuboCop
   module Cop
     module RSpec
-      # `context` block descriptions should start with 'when', or 'with'.
+      # Checks that `context` docstring starts with an allowed prefix.
       #
       # @see https://github.com/reachlocal/rspec-style-guide#context-descriptions
       # @see http://www.betterspecs.org/#contexts
       #
-      # @example `Prefixes` configuration option, defaults: 'when', 'with', and
-      # 'without'
-      #   Prefixes:
-      #     - when
-      #     - with
-      #     - without
-      #     - if
+      # @example `Prefixes` configuration
+      #
+      #   # .rubocop.yml
+      #   # RSpec/ContextWording:
+      #   #   Prefixes:
+      #   #     - when
+      #   #     - with
+      #   #     - without
+      #   #     - if
+      #   #     - unless
+      #   #     - for
       #
       # @example
       #   # bad
@@ -35,7 +39,8 @@ module RuboCop
 
         def on_block(node)
           context_wording(node) do |context|
-            add_offense(context, message: message)
+            add_offense(context,
+                        message: format(MSG, prefixes: joined_prefixes))
           end
         end
 
@@ -45,14 +50,6 @@ module RuboCop
           !prefixes.include?(description.split.first)
         end
 
-        def prefixes
-          cop_config['Prefixes'] || []
-        end
-
-        def message
-          format(MSG, prefixes: joined_prefixes)
-        end
-
         def joined_prefixes
           quoted = prefixes.map { |prefix| "'#{prefix}'" }
           return quoted.first if quoted.size == 1
@@ -60,6 +57,10 @@ module RuboCop
           quoted << "or #{quoted.pop}"
           quoted.join(', ')
         end
+
+        def prefixes
+          cop_config['Prefixes'] || []
+        end
       end
     end
   end

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

@@ -52,7 +52,7 @@ module RuboCop
             return if pairs.any?(&method(:rails_metadata?))
           end
 
-          add_offense(args.first, location: :expression)
+          add_offense(args.first)
         end
       end
     end

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

@@ -27,7 +27,7 @@ module RuboCop
           return unless second_arg&.str_type?
           return if second_arg.str_content.start_with?('#', '.')
 
-          add_offense(second_arg, location: :expression)
+          add_offense(second_arg)
         end
       end
     end

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

@@ -26,7 +26,7 @@ module RuboCop
 
         def on_send(node)
           describe_symbol?(node) do |match|
-            add_offense(match, location: :expression)
+            add_offense(match)
           end
         end
       end

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

@@ -33,7 +33,6 @@ module RuboCop
       #   end
       #
       class DescribedClass < Cop
-        include RuboCop::RSpec::TopLevelDescribe
         include ConfigurableEnforcedStyle
 
         DESCRIBED_CLASS = 'described_class'
@@ -48,20 +47,19 @@ module RuboCop
 
         def_node_matcher :scope_changing_syntax?, '{def class module}'
 
+        def_node_matcher :described_constant, <<-PATTERN
+          (block (send _ :describe $(const ...) ...) (args) $_)
+        PATTERN
+
         def on_block(node)
-          # In case the explicit style is used, we needs to remember what's
-          # being described. Thus, we use an ivar for @described_class.
-          describe, @described_class, body = described_constant(node)
+          # In case the explicit style is used, we need to remember what's
+          # being described.
+          @described_class, body = described_constant(node)
 
-          return if body.nil?
-          return unless top_level_describe?(describe)
+          return unless body
 
           find_usage(body) do |match|
-            add_offense(
-              match,
-              location: :expression,
-              message: message(match.const_name)
-            )
+            add_offense(match, message: message(match.const_name))
           end
         end
 
@@ -108,16 +106,84 @@ module RuboCop
         end
 
         def skip_blocks?
-          cop_config['SkipBlocks'].equal?(true)
+          cop_config['SkipBlocks']
         end
 
         def offensive?(node)
           if style == :described_class
-            node.eql?(@described_class)
+            offensive_described_class?(node)
           else
             node.send_type? && node.method_name == :described_class
           end
         end
+
+        def offensive_described_class?(node)
+          return unless node.const_type?
+
+          nearest_described_class, = node.each_ancestor(:block)
+            .map { |ancestor| described_constant(ancestor) }.find(&:itself)
+
+          return if nearest_described_class.equal?(node)
+
+          full_const_name(nearest_described_class) == full_const_name(node)
+        end
+
+        def full_const_name(node)
+          collapse_namespace(namespace(node), const_name(node))
+        end
+
+        # @param namespace [Array<Symbol>]
+        # @param const [Array<Symbol>]
+        # @return [Array<Symbol>]
+        # @example
+        #   # nil represents base constant
+        #   collapse_namespace([], :C)                 # => [:C]
+        #   collapse_namespace([:A, :B], [:C)          # => [:A, :B, :C]
+        #   collapse_namespace([:A, :B], [:B, :C)      # => [:A, :B, :C]
+        #   collapse_namespace([:A, :B], [nil, :C)     # => [nil, :C]
+        #   collapse_namespace([:A, :B], [nil, :B, :C) # => [nil, :B, :C]
+        def collapse_namespace(namespace, const)
+          return const if namespace.empty?
+          return const if const.first.nil?
+
+          start = [0, (namespace.length - const.length)].max
+          max = namespace.length
+          intersection = (start..max).find do |shift|
+            namespace[shift, max - shift] == const[0, max - shift]
+          end
+          [*namespace[0, intersection], *const]
+        end
+
+        # @param node [RuboCop::AST::Node]
+        # @return [Array<Symbol>]
+        # @example
+        #   const_name(s(:const, nil, :C))                # => [:C]
+        #   const_name(s(:const, s(:const, nil, :M), :C)) # => [:M, :C]
+        #   const_name(s(:const, s(:cbase), :C))          # => [nil, :C]
+        def const_name(node)
+          # rubocop:disable InternalAffairs/NodeDestructuring
+          namespace, name = *node
+          # rubocop:enable InternalAffairs/NodeDestructuring
+          if !namespace
+            [name]
+          elsif namespace.cbase_type?
+            [nil, name]
+          else
+            [*const_name(namespace), name]
+          end
+        end
+
+        # @param node [RuboCop::AST::Node]
+        # @return [Array<Symbol>]
+        # @example
+        #   namespace(node) # => [:A, :B, :C]
+        def namespace(node)
+          node
+            .each_ancestor(:class, :module)
+            .reverse_each
+            .flat_map { |ancestor| ancestor.defined_module_name.split('::') }
+            .map(&:to_sym)
+        end
       end
     end
   end

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

@@ -70,7 +70,7 @@ module RuboCop
         def on_block(node)
           return unless example_group?(node) && !contains_example?(node)
 
-          add_offense(node.send_node, location: :expression)
+          add_offense(node.send_node)
         end
 
         private

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

@@ -24,7 +24,7 @@ module RuboCop
           return if last_child?(node)
 
           missing_separating_line(node) do |location|
-            add_offense(node, location: location, message: MSG)
+            add_offense(node, location: location)
           end
         end
 

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

@@ -37,7 +37,7 @@ module RuboCop
 
           return unless length > max_length
 
-          add_offense(node, location: :expression, message: message(length))
+          add_offense(node, message: message(length))
         end
 
         private

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

@@ -36,10 +36,12 @@ module RuboCop
         SHOULD_PREFIX = /\Ashould(?:n't)?\b/i.freeze
         IT_PREFIX     = /\Ait /i.freeze
 
-        def_node_matcher(
-          :it_description,
-          '(block (send _ :it $(str $_) ...) ...)'
-        )
+        def_node_matcher :it_description, <<-PATTERN
+          (block (send _ :it ${
+            (str $_)
+            (dstr (str $_ ) ...)
+          } ...) ...)
+        PATTERN
 
         def on_block(node)
           it_description(node) do |description_node, message|

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

@@ -45,7 +45,7 @@ module RuboCop
 
         def on_send(node)
           expect_literal(node) do |argument|
-            add_offense(argument, location: :expression)
+            add_offense(argument)
           end
         end
 

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

@@ -21,7 +21,9 @@ module RuboCop
         def on_gvasgn(node)
           return unless inside_example_scope?(node)
 
+          # rubocop:disable InternalAffairs/NodeDestructuring
           variable_name, _rhs = *node
+          # rubocop:enable InternalAffairs/NodeDestructuring
           name = variable_name[1..-1]
           return unless name.eql?('stdout') || name.eql?('stderr')
 

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

@@ -40,7 +40,7 @@ module RuboCop
               next unless offensive_receiver?(attribute.receiver, node)
               next if proc?(attribute) || association?(attribute)
 
-              add_offense(attribute, location: :expression)
+              add_offense(attribute)
             end
           end
 

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

@@ -51,8 +51,7 @@ module RuboCop
             return unless n_times_block_without_arg?(node)
             return unless contains_only_factory?(node.body)
 
-            add_offense(node.send_node,
-                        location: :expression, message: MSG_CREATE_LIST)
+            add_offense(node.send_node, message: MSG_CREATE_LIST)
           end
 
           def on_send(node)