rubocop-rspec 1.37.1 → 1.38.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b83eaf98373fd696c64571d551394a287cecc7577b9b69ecf6b425a392b41e3
-  data.tar.gz: 390966b2a4e34f20dadd3b6f162ee812a2386602b32d98de7d5fa62f63af3e3a
+  metadata.gz: '04629f5b3e67ce4028685a73823dbc4d4ec5b0507162c16c7d1ee2d524871277'
+  data.tar.gz: 0cd6e7fa477d73f7a0621b9cb80b440f32f96baf109a1eef87166e69efd34df9
 SHA512:
-  metadata.gz: 6e4b4c02a0fb2987cb3fab05a26f557dc8f202262dc77202a1ba82916ac27c43d88d585218f6656c86dcfb1cd2e8c467e3b8ea2a50d790957401c2499d57a7d5
-  data.tar.gz: c496849147815725376d0bfc43c3c6da0cd544144434980460366ee013136df4203992b6fe90a31468d4529af145ee3608de1d80827bb406c69bc371cfec42af
+  metadata.gz: a0c46cbd0c72758c7e15fde02483a00c8e67c85b2155cddb6b1a0ae77338e0ff12f26e5ba4bf495e828318254f970d374ab3504ab21adda414a0d3663d4f257a
+  data.tar.gz: 62e31b5d76328e94595256ddd1215d2ae526f5fe4df09ad704a46a3e2865a7eebfc60f64e1b868967315a8b4efd329b4f55e587b646353974c290cd3bd33c474

data/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ## Master (Unreleased)
 
+## 1.38.0 (2020-02-11)
+
+* Fix `RSpec/InstanceVariable` detection inside custom matchers. ([@pirj][])
+* Fix `RSpec/ScatteredSetup` to distinguish hooks with different metadata. ([@pirj][])
+* Add autocorrect support for `RSpec/ExpectActual` cop. ([@dduugg][], [@pirj][])
+* Add `RSpec/RepeatedExampleGroupBody` cop. ([@lazycoder9][])
+* Add `RSpec/RepeatedExampleGroupDescription` cop. ([@lazycoder9][])
+* Add block name and other lines to `RSpec/ScatteredSetup` message. ([@elebow][])
+* Fix `RSpec/RepeatedDescription` to take into account example metadata. ([@lazycoder9][])
+
 ## 1.37.1 (2019-12-16)
 
 * Improve message and description of `FactoryBot/FactoryClassName`. ([@ybiquitous][])
@@ -472,3 +482,6 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
 [@mkrawc]: https://github.com/mkrawc
 [@jfragoulis]: https://github.com/jfragoulis
 [@ybiquitous]: https://github.com/ybiquitous
+[@dduugg]: https://github.com/dduugg
+[@lazycoder9]: https://github.com/lazycoder9
+[@elebow]: https://github.com/elebow

data/README.md

@@ -20,7 +20,7 @@ gem install rubocop-rspec
 or if you use bundler put this in your `Gemfile`
 
 ```
-gem 'rubocop-rspec'
+gem 'rubocop-rspec', require: false
 ```
 
 ## Usage

data/config/default.yml

@@ -394,6 +394,16 @@ RSpec/RepeatedExample:
   Description: Check for repeated examples within example groups.
   StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/RepeatedExample
 
+RSpec/RepeatedExampleGroupBody:
+  Enabled: true
+  Description: Check for repeated describe and context block body.
+  StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/RepeatedExampleGroupBody
+
+RSpec/RepeatedExampleGroupDescription:
+  Enabled: true
+  Description: Check for repeated example group descriptions.
+  StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/RepeatedExampleGroupDescription
+
 RSpec/ReturnFromStub:
   Enabled: true
   Description: Checks for consistent style of stub's return setting.

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

@@ -5,7 +5,11 @@ module RuboCop
     module RSpec
       # Checks that `context` docstring starts with an allowed prefix.
       #
-      # @see https://github.com/reachlocal/rspec-style-guide#context-descriptions
+      # 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`.
+      #
+      # @see https://rspec.rubystyle.guide/#context-descriptions
       # @see http://www.betterspecs.org/#contexts
       #
       # @example `Prefixes` configuration

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

@@ -41,11 +41,31 @@ module RuboCop
           regexp
         ].freeze
 
-        def_node_matcher :expect_literal, '(send _ :expect $#literal?)'
+        SUPPORTED_MATCHERS = %i[eq eql equal be].freeze
+
+        def_node_matcher :expect_literal, <<~PATTERN
+          (send
+            (send nil? :expect $#literal?)
+            #{Runners::ALL.node_pattern_union}
+            {
+              (send (send nil? $:be) :== $_)
+              (send nil? $_ $_ ...)
+            }
+          )
+        PATTERN
 
         def on_send(node)
           expect_literal(node) do |argument|
-            add_offense(argument)
+            add_offense(node, location: argument.source_range)
+          end
+        end
+
+        def autocorrect(node)
+          actual, matcher, expected = expect_literal(node)
+          lambda do |corrector|
+            return unless SUPPORTED_MATCHERS.include?(matcher)
+
+            swap(corrector, actual, expected)
           end
         end
 
@@ -65,6 +85,11 @@ module RuboCop
           COMPLEX_LITERALS.include?(node.type) &&
             node.each_child_node.all?(&method(:literal?))
         end
+
+        def swap(corrector, actual, expected)
+          corrector.replace(actual.source_range, expected.source)
+          corrector.replace(expected.source_range, actual.source)
+        end
       end
     end
   end

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

@@ -58,6 +58,13 @@ module RuboCop
           (block (send (const nil? :Class) :new ...) ...)
         PATTERN
 
+        def_node_matcher :custom_matcher?, <<-PATTERN
+          (block {
+            (send nil? :matcher sym)
+            (send (const (const nil? :RSpec) :Matchers) :define sym)
+          } ...)
+        PATTERN
+
         def_node_search :ivar_usage, '$(ivar $_)'
 
         def_node_search :ivar_assigned?, '(ivasgn % ...)'
@@ -66,8 +73,8 @@ module RuboCop
           return unless spec_group?(node)
 
           ivar_usage(node) do |ivar, name|
-            return if inside_dynamic_class?(ivar)
-            return if assignment_only? && !ivar_assigned?(node, name)
+            next if valid_usage?(ivar)
+            next if assignment_only? && !ivar_assigned?(node, name)
 
             add_offense(ivar)
           end
@@ -75,8 +82,10 @@ module RuboCop
 
         private
 
-        def inside_dynamic_class?(node)
-          node.each_ancestor(:block).any? { |block| dynamic_class?(block) }
+        def valid_usage?(node)
+          node.each_ancestor(:block).any? do |block|
+            dynamic_class?(block) || custom_matcher?(block)
+          end
         end
 
         def assignment_only?

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

@@ -29,6 +29,17 @@ module RuboCop
       #       end
       #     end
       #
+      #     # good
+      #     RSpec.describe User do
+      #       it 'is valid' do
+      #         # ...
+      #       end
+      #
+      #       it 'is valid', :flag do
+      #         # ...
+      #       end
+      #     end
+      #
       class RepeatedDescription < Cop
         MSG = "Don't repeat descriptions within an example group."
 
@@ -47,14 +58,18 @@ module RuboCop
           grouped_examples =
             RuboCop::RSpec::ExampleGroup.new(node)
               .examples
-              .group_by(&:doc_string)
+              .group_by { |example| example_signature(example) }
 
           grouped_examples
-            .select { |description, group| description && group.size > 1 }
+            .select { |signatures, group| signatures.any? && group.size > 1 }
             .values
             .flatten
             .map(&:definition)
         end
+
+        def example_signature(example)
+          [example.metadata, example.doc_string]
+        end
       end
     end
   end

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

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Check for repeated describe and context block body.
+      #
+      # @example
+      #
+      #    # bad
+      #    describe 'cool feature x' do
+      #      it { cool_predicate }
+      #    end
+      #
+      #    describe 'cool feature y' do
+      #      it { cool_predicate }
+      #    end
+      #
+      #    # good
+      #    describe 'cool feature' do
+      #      it { cool_predicate }
+      #    end
+      #
+      #    describe 'another cool feature' do
+      #      it { another_predicate }
+      #    end
+      #
+      #    # good
+      #    context 'when case x', :tag do
+      #      it { cool_predicate }
+      #    end
+      #
+      #    context 'when case y' do
+      #      it { cool_predicate }
+      #    end
+      #
+      class RepeatedExampleGroupBody < Cop
+        MSG = 'Repeated %<group>s block body on line(s) %<loc>s'
+
+        def_node_matcher :several_example_groups?, <<-PATTERN
+          (begin <#example_group_with_body? #example_group_with_body? ...>)
+        PATTERN
+
+        def_node_matcher :metadata, '(block (send _ _ _ $...) ...)'
+        def_node_matcher :body, '(block _ args $...)'
+
+        def_node_matcher :skip_or_pending?, <<-PATTERN
+          (block <(send nil? {:skip :pending}) ...>)
+        PATTERN
+
+        def on_begin(node)
+          return unless several_example_groups?(node)
+
+          repeated_group_bodies(node).each do |group, repeats|
+            add_offense(group, message: message(group, repeats))
+          end
+        end
+
+        private
+
+        def repeated_group_bodies(node)
+          node
+            .children
+            .select { |child| example_group_with_body?(child) }
+            .reject { |child| skip_or_pending?(child) }
+            .group_by { |group| signature_keys(group) }
+            .values
+            .reject(&:one?)
+            .flat_map { |groups| add_repeated_lines(groups) }
+        end
+
+        def add_repeated_lines(groups)
+          repeated_lines = groups.map(&:first_line)
+          groups.map { |group| [group, repeated_lines - [group.first_line]] }
+        end
+
+        def signature_keys(group)
+          [metadata(group), body(group)]
+        end
+
+        def message(group, repeats)
+          format(MSG, group: group.method_name, loc: repeats)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Check for repeated example group descriptions.
+      #
+      # @example
+      #
+      #    # bad
+      #    describe 'cool feature' do
+      #      # example group
+      #    end
+      #
+      #    describe 'cool feature' do
+      #      # example group
+      #    end
+      #
+      #    # bad
+      #    context 'when case x' do
+      #      # example group
+      #    end
+      #
+      #    describe 'when case x' do
+      #      # example group
+      #    end
+      #
+      #    # good
+      #    describe 'cool feature' do
+      #      # example group
+      #    end
+      #
+      #    describe 'another cool feature' do
+      #      # example group
+      #    end
+      #
+      #    # good
+      #    context 'when case x' do
+      #      # example group
+      #    end
+      #
+      #    context 'when another case' do
+      #      # example group
+      #    end
+      #
+      class RepeatedExampleGroupDescription < Cop
+        MSG = 'Repeated %<group>s block description on line(s) %<loc>s'
+
+        def_node_matcher :several_example_groups?, <<-PATTERN
+          (begin <#example_group? #example_group? ...>)
+        PATTERN
+
+        def_node_matcher :doc_string_and_metadata, <<-PATTERN
+          (block (send _ _ $_ $...) ...)
+        PATTERN
+
+        def_node_matcher :skip_or_pending?, <<-PATTERN
+          (block <(send nil? {:skip :pending}) ...>)
+        PATTERN
+
+        def_node_matcher :empty_description?, '(block (send _ _) ...)'
+
+        def on_begin(node)
+          return unless several_example_groups?(node)
+
+          repeated_group_descriptions(node).each do |group, repeats|
+            add_offense(group, message: message(group, repeats))
+          end
+        end
+
+        private
+
+        def repeated_group_descriptions(node)
+          node
+            .children
+            .select { |child| example_group?(child) }
+            .reject { |child| skip_or_pending?(child) }
+            .reject { |child| empty_description?(child) }
+            .group_by { |group| doc_string_and_metadata(group) }
+            .values
+            .reject(&:one?)
+            .flat_map { |groups| add_repeated_lines(groups) }
+        end
+
+        def add_repeated_lines(groups)
+          repeated_lines = groups.map(&:first_line)
+          groups.map { |group| [group, repeated_lines - [group.first_line]] }
+        end
+
+        def message(group, repeats)
+          format(MSG, group: group.method_name, loc: repeats)
+        end
+      end
+    end
+  end
+end

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

@@ -23,25 +23,43 @@ module RuboCop
       #   end
       #
       class ScatteredSetup < Cop
-        MSG = 'Do not define multiple hooks in the same example group.'
+        MSG = 'Do not define multiple `%<hook_name>s` hooks in the same '\
+              'example group (also defined on %<lines>s).'
 
         def on_block(node)
           return unless example_group?(node)
 
-          analyzable_hooks(node).each do |repeated_hook|
-            add_offense(repeated_hook)
+          repeated_hooks(node).each do |occurrences|
+            lines = occurrences.map(&:first_line)
+
+            occurrences.each do |occurrence|
+              lines_except_current = lines - [occurrence.first_line]
+              message = format(MSG, hook_name: occurrences.first.method_name,
+                               lines: lines_msg(lines_except_current))
+              add_offense(occurrence, message: message)
+            end
           end
         end
 
-        def analyzable_hooks(node)
-          RuboCop::RSpec::ExampleGroup.new(node)
+        def repeated_hooks(node)
+          hooks = RuboCop::RSpec::ExampleGroup.new(node)
             .hooks
-            .select { |hook| hook.knowable_scope? && hook.valid_scope? }
-            .group_by { |hook| [hook.name, hook.scope] }
+            .select(&:knowable_scope?)
+            .group_by { |hook| [hook.name, hook.scope, hook.metadata] }
             .values
             .reject(&:one?)
-            .flatten
-            .map(&:to_node)
+
+          hooks.map do |hook|
+            hook.map(&:to_node)
+          end
+        end
+
+        def lines_msg(numbers)
+          if numbers.size == 1
+            "line #{numbers.first}"
+          else
+            "lines #{numbers.join(', ')}"
+          end
         end
       end
     end

data/lib/rubocop/cop/rspec_cops.rb

@@ -74,6 +74,8 @@ require_relative 'rspec/receive_counts'
 require_relative 'rspec/receive_never'
 require_relative 'rspec/repeated_description'
 require_relative 'rspec/repeated_example'
+require_relative 'rspec/repeated_example_group_body'
+require_relative 'rspec/repeated_example_group_description'
 require_relative 'rspec/return_from_stub'
 require_relative 'rspec/scattered_let'
 require_relative 'rspec/scattered_setup'

data/lib/rubocop/rspec/hook.rb

@@ -4,21 +4,24 @@ module RuboCop
   module RSpec
     # Wrapper for RSpec hook
     class Hook < Concept
-      STANDARDIZED_SCOPES = %i[each context suite].freeze
-      private_constant(:STANDARDIZED_SCOPES)
+      def_node_matcher :extract_metadata, <<~PATTERN
+        (block
+          {
+            (send _ _ #valid_scope? $...)
+            (send _ _ $...)
+          }
+          ...
+        )
+      PATTERN
 
       def name
         node.method_name
       end
 
       def knowable_scope?
-        return true unless scope_argument
-
-        scope_argument.sym_type?
-      end
-
-      def valid_scope?
-        STANDARDIZED_SCOPES.include?(scope)
+        scope_argument.nil? ||
+          scope_argument.sym_type? ||
+          scope_argument.hash_type?
       end
 
       def example?
@@ -26,17 +29,47 @@ module RuboCop
       end
 
       def scope
+        return :each if scope_argument&.hash_type?
+
         case scope_name
         when nil, :each, :example then :each
         when :context, :all       then :context
         when :suite               then :suite
-        else
-          scope_name
         end
       end
 
+      def metadata
+        (extract_metadata(node) || [])
+          .map { |meta| transform_metadata(meta) }
+          .flatten
+          .inject(&:merge)
+      end
+
       private
 
+      def valid_scope?(node)
+        node&.sym_type? && Hooks::Scopes::ALL.include?(node.value)
+      end
+
+      def transform_metadata(meta)
+        if meta.sym_type?
+          { meta => true }
+        else
+          # This check is to be able to compare those two hooks:
+          #
+          #   before(:example, :special) { ... }
+          #   before(:example, special: true) { ... }
+          #
+          # In the second case it's a node with a pair that has a value
+          # of a `true_type?`.
+          meta.pairs.map { |pair| { pair.key => transform_true(pair.value) } }
+        end
+      end
+
+      def transform_true(node)
+        node.true_type? ? true : node
+      end
+
       def scope_name
         scope_argument.to_a.first
       end

data/lib/rubocop/rspec/language.rb

@@ -94,6 +94,18 @@ module RuboCop
             append_after
           ]
         )
+
+        module Scopes
+          ALL = SelectorSet.new(
+            %i[
+              each
+              example
+              context
+              all
+              suite
+            ]
+          )
+        end
       end
 
       module Helpers

data/lib/rubocop/rspec/version.rb

@@ -4,7 +4,7 @@ module RuboCop
   module RSpec
     # Version information for the RSpec RuboCop plugin.
     module Version
-      STRING = '1.37.1'
+      STRING = '1.38.0'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec
 version: !ruby/object:Gem::Version
-  version: 1.37.1
+  version: 1.38.0
 platform: ruby
 authors:
 - John Backus
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-16 00:00:00.000000000 Z
+date: 2020-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -72,16 +72,16 @@ dependencies:
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.18'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -182,6 +182,8 @@ files:
 - lib/rubocop/cop/rspec/receive_never.rb
 - lib/rubocop/cop/rspec/repeated_description.rb
 - lib/rubocop/cop/rspec/repeated_example.rb
+- lib/rubocop/cop/rspec/repeated_example_group_body.rb
+- lib/rubocop/cop/rspec/repeated_example_group_description.rb
 - lib/rubocop/cop/rspec/return_from_stub.rb
 - lib/rubocop/cop/rspec/scattered_let.rb
 - lib/rubocop/cop/rspec/scattered_setup.rb
@@ -234,7 +236,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.1
 signing_key: 
 specification_version: 4
 summary: Code style checking for RSpec files