rubocop-rspec 1.20.1 → 1.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc22359823d51921927c6eccc2042da9aeba3da2ce8587e23afdbe55bc3b2840
-  data.tar.gz: 2444605d47dbe964004743b2581a849ccd571c0fbbdc0bd398a6c03755842e4c
+  metadata.gz: db6a354c4b2a3ba18944c5a6fc3ce076eaec380b3f84b67d3a825ab81a2f18a2
+  data.tar.gz: c15d5bb4a019e0ff6d419058e136959aa54af22a409e302c4cbd012f06960ba6
 SHA512:
-  metadata.gz: dc6aaa5e37a13006b8e66478889cad7a51ce8599075d0304f21cd235cab42ae62209a2bede56a0dd984956302719ef00477680ac4bc6c3cd766a456fc8742d7c
-  data.tar.gz: 597ed8a84f733c73bb489b722fb26fbc2120514bf19b6fd091641094a2da8d3f7b3942fe1be33150cfa2c0f96bc926d191658df42226ac19b6ff97e9d7955997
+  metadata.gz: cd09459ea1199299104e462a6592ffe6ecba612f6560e4f5003c13c302cf47a9b21b5da186cb7237378c2187f83c63894fb0a89780ce9c22d328b4cfb9795c81
+  data.tar.gz: 2f24de47526a5719c96772d5c4e557fc37d2cc39472c372e0c3c6d4913a47cee1568bb06547de1d67684d1afd60b8875c7073e162b8e637e5718b4b4f8972839

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## Master (Unreleased)
 
+## 1.21.0 (2017-12-13)
+
+* Compatibility with RuboCop v0.52.0. ([@bquorning][])
+* Improve performance when user does not override default RSpec Pattern config. ([@walf443][])
+* Add `AggregateFailuresByDefault` configuration for `RSpec/MultipleExpectations` cop. ([@onk][])
+
 ## 1.20.1 (2017-11-15)
 
 * Add "without" to list of default allowed prefixes for `RSpec/ContextWording`. ([@bquorning][])

data/config/default.yml

@@ -237,6 +237,7 @@ RSpec/MultipleExpectations:
   Description: Checks if examples contain too many `expect` calls.
   Enabled: true
   Max: 1
+  AggregateFailuresByDefault: false
   StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/MultipleExpectations
 
 RSpec/MultipleSubjects:

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

@@ -33,7 +33,7 @@ module RuboCop
         #     end
         #   end
         class FeatureMethods < Cop
-          MSG = 'Use `%s` instead of `%s`.'.freeze
+          MSG = 'Use `%<replacement>s` instead of `%<method>s`.'.freeze
 
           # https://git.io/v7Kwr
           MAP = {
@@ -56,7 +56,7 @@ module RuboCop
               add_offense(
                 send_node,
                 location: :selector,
-                message: format(MSG, MAP[match], match)
+                message: format(MSG, method: match, replacement: MAP[match])
               )
             end
           end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RuboCop
   module Cop # rubocop:disable Style/Documentation
     WorkaroundCop = Cop.dup
@@ -42,6 +44,11 @@ module RuboCop
         DEFAULT_CONFIGURATION =
           RuboCop::RSpec::CONFIG.fetch('AllCops').fetch('RSpec')
 
+        DEFAULT_PATTERN_RE = Regexp.union(
+          DEFAULT_CONFIGURATION.fetch('Patterns')
+                               .map(&Regexp.public_method(:new))
+        )
+
         # Invoke the original inherited hook so our cops are recognized
         def self.inherited(subclass)
           RuboCop::Cop::Cop.inherited(subclass)
@@ -58,12 +65,25 @@ module RuboCop
         end
 
         def rspec_pattern
-          Regexp.union(rspec_pattern_config.map(&Regexp.public_method(:new)))
+          if rspec_pattern_config?
+            Regexp.union(rspec_pattern_config.map(&Regexp.public_method(:new)))
+          else
+            DEFAULT_PATTERN_RE
+          end
         end
 
-        def rspec_pattern_config
+        def all_cops_config
           config
             .for_all_cops
+        end
+
+        def rspec_pattern_config?
+          return unless all_cops_config.key?('RSpec')
+          all_cops_config.fetch('RSpec').key?('Patterns')
+        end
+
+        def rspec_pattern_config
+          all_cops_config
             .fetch('RSpec', DEFAULT_CONFIGURATION)
             .fetch('Patterns')
         end

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

@@ -37,7 +37,7 @@ module RuboCop
         include ConfigurableEnforcedStyle
 
         DESCRIBED_CLASS = 'described_class'.freeze
-        MSG             = 'Use `%s` instead of `%s`.'.freeze
+        MSG             = 'Use `%<replacement>s` instead of `%<src>s`.'.freeze
 
         def_node_matcher :common_instance_exec_closure?, <<-PATTERN
           (block (send (const nil? {:Class :Module}) :new ...) ...)
@@ -91,9 +91,10 @@ module RuboCop
 
         def message(offense)
           if style == :described_class
-            format(MSG, DESCRIBED_CLASS, offense)
+            format(MSG, replacement: DESCRIBED_CLASS, src: offense)
           else
-            format(MSG, @described_class.const_name, DESCRIBED_CLASS)
+            format(MSG, replacement: @described_class.const_name,
+                        src: DESCRIBED_CLASS)
           end
         end
 

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

@@ -28,7 +28,7 @@ module RuboCop
       class ExampleLength < Cop
         include CodeLength
 
-        MSG = 'Example has too many lines [%d/%d].'.freeze
+        MSG = 'Example has too many lines [%<total>d/%<max>d].'.freeze
 
         def on_block(node)
           return unless example?(node)
@@ -47,7 +47,7 @@ module RuboCop
         end
 
         def message(length)
-          format(MSG, length, max_length)
+          format(MSG, total: length, max: max_length)
         end
       end
     end

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

@@ -44,7 +44,7 @@ module RuboCop
       class FilePath < Cop
         include RuboCop::RSpec::TopLevelDescribe
 
-        MSG = 'Spec path should end with `%s`.'.freeze
+        MSG = 'Spec path should end with `%<suffix>s`.'.freeze
 
         def_node_search :const_described?,  '(send _ :describe (const ...) ...)'
         def_node_search :routing_metadata?, '(pair (sym :type) (sym :routing))'
@@ -57,7 +57,11 @@ module RuboCop
 
           return if filename_ends_with?(glob)
 
-          add_offense(node, location: :expression, message: format(MSG, glob))
+          add_offense(
+            node,
+            location: :expression,
+            message: format(MSG, suffix: glob)
+          )
         end
 
         private

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

@@ -60,8 +60,9 @@ module RuboCop
       class HookArgument < Cop
         include ConfigurableEnforcedStyle
 
-        IMPLICIT_MSG = 'Omit the default `%p` argument for RSpec hooks.'.freeze
-        EXPLICIT_MSG = 'Use `%p` for RSpec hooks.'.freeze
+        IMPLICIT_MSG = 'Omit the default `%<scope>p` ' \
+                       'argument for RSpec hooks.'.freeze
+        EXPLICIT_MSG = 'Use `%<scope>p` for RSpec hooks.'.freeze
 
         HOOKS = Hooks::ALL.node_pattern_union.freeze
 
@@ -102,15 +103,15 @@ module RuboCop
           add_offense(
             method_send,
             location: :selector,
-            message: format(EXPLICIT_MSG, style)
+            message: format(EXPLICIT_MSG, scope: style)
           )
         end
 
         def explicit_message(scope)
           if implicit_style?
-            format(IMPLICIT_MSG, scope)
+            format(IMPLICIT_MSG, scope: scope)
           else
-            format(EXPLICIT_MSG, style)
+            format(EXPLICIT_MSG, scope: style)
           end
         end
 

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

@@ -21,8 +21,8 @@ module RuboCop
       class ItBehavesLike < Cop
         include ConfigurableEnforcedStyle
 
-        MSG = 'Prefer `%s` over `%s` when including examples in '\
-              'a nested context.'.freeze
+        MSG = 'Prefer `%<replacement>s` over `%<original>s` when including '\
+              'examples in a nested context.'.freeze
 
         def_node_matcher :example_inclusion_offense, '(send _ % ...)'
 
@@ -39,7 +39,7 @@ module RuboCop
         private
 
         def message(_node)
-          format(MSG, style, alternative_style)
+          format(MSG, replacement: style, original: alternative_style)
         end
       end
     end

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

@@ -63,8 +63,12 @@ module RuboCop
 
         def node_range(node)
           range = node.source_range
-          range = range_with_surrounding_space(range, :left, false)
-          range = range_with_surrounding_space(range, :right, true)
+          range = range_with_surrounding_space(
+            range: range, side: :left, newlines: false
+          )
+          range = range_with_surrounding_space(
+            range: range, side: :right, newlines: true
+          )
           range
         end
 

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

@@ -27,7 +27,7 @@ module RuboCop
       class MessageExpectation < Cop
         include ConfigurableEnforcedStyle
 
-        MSG = 'Prefer `%s` for setting message expectations.'.freeze
+        MSG = 'Prefer `%<style>s` for setting message expectations.'.freeze
 
         SUPPORTED_STYLES = %w[allow expect].freeze
 
@@ -41,7 +41,8 @@ module RuboCop
           message_expectation(node) do |match|
             return correct_style_detected if preferred_style?(match)
 
-            add_offense(match, location: :selector, message: MSG % style) do
+            message = format(MSG, style: style)
+            add_offense(match, location: :selector, message: message) do
               opposite_style_detected
             end
           end

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

@@ -31,8 +31,8 @@ module RuboCop
                       'expectations.'.freeze
 
         MSG_HAVE_RECEIVED = 'Prefer `have_received` for setting message '\
-                            'expectations. Setup `%s` as a spy using `allow`'\
-                            ' or `instance_spy`.'.freeze
+                            'expectations. Setup `%<source>s` as a spy using '\
+                            '`allow` or `instance_spy`.'.freeze
 
         SUPPORTED_STYLES = %w[have_received receive].freeze
 
@@ -73,7 +73,7 @@ module RuboCop
           when :receive
             MSG_RECEIVE
           when :have_received
-            MSG_HAVE_RECEIVED % receiver.source
+            format(MSG_HAVE_RECEIVED, source: receiver.source)
           end
         end
       end

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

@@ -79,7 +79,8 @@ module RuboCop
         def example_with_aggregated_failures?(node)
           example = node.children.first
 
-          with_aggregated_failures?(example) &&
+          (aggregated_failures_by_default? ||
+            with_aggregated_failures?(example)) &&
             !disabled_aggregated_failures?(example)
         end
 
@@ -111,6 +112,10 @@ module RuboCop
         def max_expectations
           Integer(cop_config.fetch('Max', 1))
         end
+
+        def aggregated_failures_by_default?
+          cop_config.fetch('AggregateFailuresByDefault', false)
+        end
       end
     end
   end

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

@@ -87,7 +87,8 @@ module RuboCop
       class NestedGroups < Cop
         include RuboCop::RSpec::TopLevelDescribe
 
-        MSG = 'Maximum example group nesting exceeded [%d/%d].'.freeze
+        MSG = 'Maximum example group nesting exceeded ' \
+              '[%<total>d/%<max>d].'.freeze
 
         DEPRECATED_MAX_KEY = 'MaxNesting'.freeze
 
@@ -120,7 +121,7 @@ module RuboCop
         end
 
         def message(nesting)
-          format(MSG, nesting, max_nesting)
+          format(MSG, total: nesting, max: max_nesting)
         end
 
         def max_nesting

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

@@ -16,7 +16,7 @@ module RuboCop
       class NotToNot < Cop
         include ConfigurableEnforcedStyle
 
-        MSG = 'Prefer `%s` over `%s`.'.freeze
+        MSG = 'Prefer `%<replacement>s` over `%<original>s`.'.freeze
 
         def_node_matcher :not_to_not_offense, '(send _ % ...)'
 
@@ -33,7 +33,7 @@ module RuboCop
         private
 
         def message(_node)
-          format(MSG, style, alternative_style)
+          format(MSG, replacement: style, original: alternative_style)
         end
       end
     end

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

@@ -311,8 +311,6 @@ module RuboCop
           check_explicit(node) if style == :explicit
         end
 
-        private
-
         def autocorrect(node)
           case style
           when :inflected
@@ -322,6 +320,8 @@ module RuboCop
           end
         end
 
+        private
+
         # returns args location with whitespace
         # @example
         #   foo 1, 2

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.20.1'.freeze
+      STRING = '1.21.0'.freeze
     end
   end
 end

data/rubocop-rspec.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.test_files = spec.files.grep(%r{^spec/})
   spec.extra_rdoc_files = ['MIT-LICENSE.md', 'README.md']
 
-  spec.add_runtime_dependency 'rubocop', '>= 0.51.0'
+  spec.add_runtime_dependency 'rubocop', '>= 0.52.0'
 
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '>= 3.4'

data/spec/rubocop/cop/rspec/cop_spec.rb

@@ -31,6 +31,7 @@ RSpec.describe RuboCop::Cop::RSpec::Cop do
         add_offense(node, location: :expression, message: 'I flag everything')
       end
     end
+    # rubocop:enable ClassAndModuleChildren
     RuboCop::RSpec::FakeCop
   end
 

data/spec/rubocop/cop/rspec/factory_bot/dynamic_attribute_defined_statically_spec.rb

@@ -2,6 +2,8 @@
 
 # rubocop:disable Metrics/LineLength
 RSpec.describe RuboCop::Cop::RSpec::FactoryBot::DynamicAttributeDefinedStatically do
+  # rubocop:enable Metrics/LineLength
+
   subject(:cop) { described_class.new(config) }
 
   let(:config) { RuboCop::Config.new }

data/spec/rubocop/cop/rspec/focus_spec.rb

@@ -71,6 +71,7 @@ RSpec.describe RuboCop::Cop::RSpec::Focus do
                  ^^^^^^ Focused spec found.
     RUBY
   end
+  # rubocop:enable RSpec/ExampleLength
 
   it 'does not flag unfocused specs' do
     expect_no_offenses(<<-RUBY)

data/spec/rubocop/cop/rspec/multiple_expectations_spec.rb

@@ -132,7 +132,7 @@ RSpec.describe RuboCop::Cop::RSpec::MultipleExpectations, :config do
     end
   end
 
-  context 'with configuration' do
+  context 'with Max configuration' do
     let(:cop_config) do
       { 'Max' => '2' }
     end
@@ -162,6 +162,57 @@ RSpec.describe RuboCop::Cop::RSpec::MultipleExpectations, :config do
     end
   end
 
+  context 'with AggregateFailuresByDefault configuration' do
+    let(:cop_config) do
+      { 'AggregateFailuresByDefault' => true }
+    end
+
+    it 'ignores examples without metadata' do
+      expect_no_offenses(<<-RUBY)
+        describe Foo do
+          it 'uses expect twice' do
+            expect(foo).to eq(bar)
+            expect(baz).to eq(bar)
+          end
+        end
+      RUBY
+    end
+
+    it 'ignores examples with `:aggregate_failures`' do
+      expect_no_offenses(<<-RUBY)
+        describe Foo do
+          it 'uses expect twice', :aggregate_failures do
+            expect(foo).to eq(bar)
+            expect(baz).to eq(bar)
+          end
+        end
+      RUBY
+    end
+
+    it 'ignores examples with `aggregate_failures: true`' do
+      expect_no_offenses(<<-RUBY)
+        describe Foo do
+          it 'uses expect twice', aggregate_failures: true do
+            expect(foo).to eq(bar)
+            expect(baz).to eq(bar)
+          end
+        end
+      RUBY
+    end
+
+    it 'checks examples with `aggregate_failures: false`' do
+      expect_offense(<<-RUBY)
+        describe Foo do
+          it 'uses expect twice', aggregate_failures: false do
+          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Example has too many expectations [2/1].
+            expect(foo).to eq(bar)
+            expect(baz).to eq(bar)
+          end
+        end
+      RUBY
+    end
+  end
+
   it 'generates a todo based on the worst violation' do
     inspect_source(<<-RUBY, 'spec/foo_spec.rb')
       describe Foo do

data/spec/rubocop/rspec/example_spec.rb

@@ -9,12 +9,12 @@ RSpec.describe RuboCop::RSpec::Example do
 
   it 'extracts doc string' do
     expect(example("it('does x') { foo }").doc_string)
-      .to eql(s(:str, 'does x'))
+      .to eq(s(:str, 'does x'))
   end
 
   it 'extracts doc string for unimplemented examples' do
     expect(example("it('does x')").doc_string)
-      .to eql(s(:str, 'does x'))
+      .to eq(s(:str, 'does x'))
   end
 
   it 'returns nil for examples without doc strings' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec
 version: !ruby/object:Gem::Version
-  version: 1.20.1
+  version: 1.21.0
 platform: ruby
 authors:
 - John Backus
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-15 00:00:00.000000000 Z
+date: 2017-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -18,14 +18,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.51.0
+        version: 0.52.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.51.0
+        version: 0.52.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement