rubocop-rspec 1.9.1 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7161e38d3d46174e4acad35bf1ab6b7fdd8d62d4
-  data.tar.gz: d9b7e70692513359abc3501795939c31075bd3dc
+  metadata.gz: afa52f47ad386fe20a2a338ff9da7c6a032c385b
+  data.tar.gz: 07143368c4d5e201d12bfba8379e5c2c79bcba99
 SHA512:
-  metadata.gz: 7d57d6b57e5333d78635bcc4282ece219f7c2ebc0b7ed394e65da9a4167861752ec69bc4e588038737c21af69b1cfe86959d82fef02cce16e9dccd2ef9718fd0
-  data.tar.gz: d961bdccd80bab88bb0c04f00c2e27003e7203aa212a0ec12f8403455e522d8b85b7171e0fd27e495dd524569df2246f3590dd660db7974997f052160f51c91b
+  metadata.gz: 89dfa9c530533694d03d670112ae870f9ba626875bcff32bb9ab4c708f393e99e1e4eb5562adb5ad2e8231c5366594fabbd431a8ec758ec856491fa747f84b66
+  data.tar.gz: 9517b60ae000d18800f11bb8e579d5889883eff511975ce4ff77a56e72cc0450e9f998b93694c3c90d9e47c9546aebb0fe8296fdbcfa4048e16cfddfc7fda5b1

data/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ## Master (unreleased)
 
+## 1.10.0 (2017-01-15)
+
+* Fix false negative for `RSpec/MessageSpies` cop. ([@onk][])
+* Fix internal dependencies on RuboCop to be compatible with 0.47 release. ([@backus][])
+* Add autocorrect support for `SingleArgumentMessageChain` cop. ([@bquorning][])
+* Rename `NestedGroups`' configuration key from `MaxNesting` to `Max` in order to be consistent with other cop configuration. ([@backus][])
+* Add `RepeatedExample` cop for detecting repeated examples within example groups. ([@backus][])
+* Add `ScatteredSetup` cop for enforcing that only one `before`, `around`, and `after` hook are used per example group scope. ([@backus][])
+* Add `ExpectOutput` cop for recommending `expect { ... }.to output(...).to_stdout`. ([@backus][])
+
 ## 1.9.1 (2017-01-02)
 
 * Fix unintentional regression change in `NestedGroups` reported in #270. ([@backus][])
@@ -161,3 +171,4 @@
 [@baberthal]: https://github.com/baberthal
 [@jeffreyc]: https://github.com/jeffreyc
 [@clupprich]: https://github.com/clupprich
+[@onk]: https://github.com/onk

data/Gemfile

@@ -4,11 +4,12 @@ gemspec
 
 group :test do
   gem 'codeclimate-test-reporter', '~> 1.0.0'
+  gem 'rubocop',                   '~> 0.47'
   gem 'simplecov',                 '~> 0.12.0', require: false
 end
 
 local_gemfile = 'Gemfile.local'
 
 if File.exist?(local_gemfile)
-  eval(File.read(local_gemfile)) # rubocop:disable Lint/Eval
+  eval(File.read(local_gemfile)) # rubocop:disable Security/Eval
 end

data/config/default.yml

@@ -49,6 +49,10 @@ RSpec/ExpectActual:
   Description: Checks for `expect(...)` calls containing literal values.
   Enabled: true
 
+RSpec/ExpectOutput:
+  Description: Checks for opportunities to use `expect { ... }.to output`.
+  Enabled: true
+
 RSpec/FilePath:
   Description: Checks that spec file paths are consistent with the test subject.
   Enabled: true
@@ -127,7 +131,7 @@ RSpec/NamedSubject:
 RSpec/NestedGroups:
   Description: Checks for nested example groups.
   Enabled: true
-  MaxNesting: 3
+  Max: 3
 
 RSpec/NotToNot:
   Description: Checks for consistent method usage for negating expectations.
@@ -141,10 +145,18 @@ RSpec/RepeatedDescription:
   Enabled: true
   Description: Check for repeated description strings in example groups.
 
+RSpec/RepeatedExample:
+  Enabled: true
+  Description: Check for repeated examples within example groups.
+
 RSpec/SingleArgumentMessageChain:
   Description: Checks that chains of messages contain more than one element.
   Enabled: true
 
+RSpec/ScatteredSetup:
+  Description: Checks for setup scattered across multiple hooks in an example group.
+  Enabled: true
+
 RSpec/SubjectStub:
   Description: Checks for stubbed test subjects.
   Enabled: true

data/lib/rubocop-rspec.rb

@@ -11,8 +11,10 @@ require 'rubocop/rspec/wording'
 require 'rubocop/rspec/util'
 require 'rubocop/rspec/language'
 require 'rubocop/rspec/language/node_pattern'
+require 'rubocop/rspec/concept'
 require 'rubocop/rspec/example_group'
 require 'rubocop/rspec/example'
+require 'rubocop/rspec/hook'
 require 'rubocop/cop/rspec/cop'
 
 RuboCop::RSpec::Inject.defaults!
@@ -27,6 +29,7 @@ require 'rubocop/cop/rspec/empty_example_group'
 require 'rubocop/cop/rspec/example_length'
 require 'rubocop/cop/rspec/example_wording'
 require 'rubocop/cop/rspec/expect_actual'
+require 'rubocop/cop/rspec/expect_output'
 require 'rubocop/cop/rspec/file_path'
 require 'rubocop/cop/rspec/focus'
 require 'rubocop/cop/rspec/hook_argument'
@@ -43,6 +46,8 @@ require 'rubocop/cop/rspec/named_subject'
 require 'rubocop/cop/rspec/nested_groups'
 require 'rubocop/cop/rspec/not_to_not'
 require 'rubocop/cop/rspec/repeated_description'
+require 'rubocop/cop/rspec/repeated_example'
+require 'rubocop/cop/rspec/scattered_setup'
 require 'rubocop/cop/rspec/single_argument_message_chain'
 require 'rubocop/cop/rspec/subject_stub'
 require 'rubocop/cop/rspec/verified_doubles'

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

@@ -33,7 +33,7 @@ module RuboCop
           _receiver, method_name, *_args = *node
           return unless ANY_INSTANCE_METHODS.include?(method_name)
 
-          add_offense(node, :expression, MESSAGE % { method: method_name })
+          add_offense(node, :expression, format(MESSAGE, method: method_name))
         end
       end
     end

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

@@ -7,8 +7,7 @@ module RuboCop
     class WorkaroundCop
       # Overwrite the cop inherited method to be a noop. Our RSpec::Cop
       # class will invoke the inherited hook instead
-      def self.inherited(*)
-      end
+      def self.inherited(*); end
 
       # Special case `Module#<` so that the rspec support rubocop exports
       # is compatible with our subclass

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

@@ -54,7 +54,7 @@ module RuboCop
         def find_constant_usage(node, described_class, &block)
           yield(node) if node.eql?(described_class)
 
-          return unless node.instance_of?(Node)
+          return unless node.is_a?(Parser::AST::Node)
           return if scope_change?(node) || node.const_type?
 
           node.children.each do |child|

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Checks for opportunities to use `expect { ... }.to output`.
+      #
+      # @example
+      #   # bad
+      #   $stdout = StringIO.new
+      #   my_app.print_report
+      #   $stdout = STDOUT
+      #   expect($stdout.string).to eq('Hello World')
+      #
+      #   # good
+      #   expect { my_app.print_report }.to output('Hello World').to_stdout
+      class ExpectOutput < Cop
+        MSG = 'Use `expect { ... }.to output(...).to_%<name>s` ' \
+              'instead of mutating $%<name>s'.freeze
+
+        def_node_matcher :hook?, Hooks::ALL.block_pattern
+
+        def on_gvasgn(node)
+          return unless inside_example_scope?(node)
+
+          variable_name, _rhs = *node
+          name = variable_name[1..-1]
+          return unless name.eql?('stdout') || name.eql?('stderr')
+
+          add_offense(node, :name, format(MSG, name: name))
+        end
+
+        private
+
+        # Detect if we are inside the scope of a single example
+        #
+        # We want to encourage using `expect { ... }.to output` so
+        # we only care about situations where you would replace with
+        # an expectation. Therefore, assignments to stderr or stdout
+        # within a `before(:all)` or otherwise outside of an example
+        # don't matter.
+        def inside_example_scope?(node)
+          return false if node.nil? || example_group?(node)
+          return true if example?(node)
+          return RuboCop::RSpec::Hook.new(node).example? if hook?(node)
+
+          inside_example_scope?(node.parent)
+        end
+      end
+    end
+  end
+end

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

@@ -87,10 +87,11 @@ module RuboCop
         end
 
         def offense_message(offending_source)
-          MSG % {
+          format(
+            MSG,
             good: replacement_source(offending_source),
             bad:  offending_source
-          }
+          )
         end
 
         def replacement_source(offending_source)

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

@@ -18,7 +18,7 @@ module RuboCop
           _receiver, method_name, *_args = *node
           return unless Matchers::MESSAGE_CHAIN.include?(method_name)
 
-          add_offense(node, :selector, MESSAGE % { method: method_name })
+          add_offense(node, :selector, format(MESSAGE, method: method_name))
         end
       end
     end

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

@@ -36,7 +36,7 @@ module RuboCop
         SUPPORTED_STYLES = %w(have_received receive).freeze
 
         def_node_matcher :message_expectation, %(
-          (send (send nil :expect (send nil $_)) :to ...)
+          (send (send nil :expect $_) {:to :to_not :not_to} ...)
         )
 
         def_node_search :receive_message, %(
@@ -70,7 +70,7 @@ module RuboCop
           when :receive
             MSG_RECEIVE
           when :have_received
-            MSG_HAVE_RECEIVED % receiver
+            MSG_HAVE_RECEIVED % receiver.source
           end
         end
       end

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

@@ -48,9 +48,7 @@ module RuboCop
       class MultipleExpectations < Cop
         include ConfigurableMax
 
-        MSG = 'Too many expectations.'.freeze
-
-        def_node_matcher :example?, Examples::ALL.block_pattern
+        MSG = 'Example has too many expectations [%{total}/%{max}]'.freeze
 
         def_node_search :expect, '(send _ :expect ...)'
 
@@ -72,7 +70,7 @@ module RuboCop
           add_offense(
             method,
             :expression,
-            MSG % { total: expectation_count, max: max_expectations }
+            format(MSG, total: expectation_count, max: max_expectations)
           )
         end
 

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

@@ -60,7 +60,7 @@ module RuboCop
         private
 
         def subject_usage(node, &block)
-          return unless node.instance_of?(Node)
+          return unless node.is_a?(Parser::AST::Node)
 
           unnamed_subject(node, &block)
 

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

@@ -89,6 +89,12 @@ module RuboCop
 
         MSG = 'Maximum example group nesting exceeded'.freeze
 
+        DEPRECATED_MAX_KEY = 'MaxNesting'.freeze
+
+        DEPRECATION_WARNING =
+          "Configuration key `#{DEPRECATED_MAX_KEY}` for #{cop_name} is " \
+          'deprecated in favor of `Max`. Please use that instead.'.freeze
+
         def_node_search :find_contexts, ExampleGroups::ALL.block_pattern
 
         def on_top_level_describe(node, _)
@@ -110,7 +116,16 @@ module RuboCop
         end
 
         def max_nesting
-          Integer(cop_config.fetch('MaxNesting', 3))
+          @max_nesting ||= Integer(max_nesting_config)
+        end
+
+        def max_nesting_config
+          if cop_config.key?(DEPRECATED_MAX_KEY)
+            warn DEPRECATION_WARNING
+            cop_config.fetch(DEPRECATED_MAX_KEY)
+          else
+            cop_config.fetch('Max', 3)
+          end
         end
       end
     end

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

@@ -0,0 +1,41 @@
+module RuboCop
+  module Cop
+    module RSpec
+      # Check for repeated examples within example groups.
+      #
+      # @example
+      #
+      #    it 'is valid' do
+      #      expect(user).to be_valid
+      #    end
+      #
+      #    it 'validates the user' do
+      #      expect(user).to be_valid
+      #    end
+      #
+      class RepeatedExample < Cop
+        MSG = "Don't repeat examples within an example group.".freeze
+
+        def on_block(node)
+          return unless example_group?(node)
+
+          repeated_examples(node).each do |repeated_example|
+            add_offense(repeated_example, :expression)
+          end
+        end
+
+        private
+
+        def repeated_examples(node)
+          RuboCop::RSpec::ExampleGroup.new(node)
+            .examples
+            .group_by { |example| [example.metadata, example.implementation] }
+            .values
+            .reject(&:one?)
+            .flatten
+            .map(&:to_node)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Checks for setup scattered across multiple hooks in an example group.
+      #
+      # Unify `before`, `after`, and `around` hooks when possible.
+      #
+      # @example
+      #   # bad
+      #   describe Foo do
+      #     before { setup1 }
+      #     before { setup2 }
+      #   end
+      #
+      #   # good
+      #   describe Foo do
+      #     before do
+      #       setup1
+      #       setup2
+      #     end
+      #   end
+      #
+      class ScatteredSetup < Cop
+        MSG = 'Do not define multiple hooks in the same example group.'.freeze
+
+        def on_block(node)
+          return unless example_group?(node)
+
+          analyzable_hooks(node).each do |repeated_hook|
+            add_offense(repeated_hook, :expression)
+          end
+        end
+
+        def analyzable_hooks(node)
+          RuboCop::RSpec::ExampleGroup.new(node)
+            .hooks
+            .select { |hook| hook.knowable_scope? && hook.valid_scope? }
+            .group_by { |hook| [hook.name, hook.scope] }
+            .values
+            .reject(&:one?)
+            .flatten
+            .map(&:to_node)
+        end
+      end
+    end
+  end
+end

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

@@ -27,6 +27,16 @@ module RuboCop
           add_offense(node, :selector, message(method_name))
         end
 
+        def autocorrect(node)
+          _receiver, method_name, *_args = *node
+          lambda do |corrector|
+            corrector.replace(
+              node.loc.selector,
+              method_name.equal?(:receive_message_chain) ? 'receive' : 'stub'
+            )
+          end
+        end
+
         private
 
         def multi_argument_string?(args)
@@ -36,11 +46,13 @@ module RuboCop
         end
 
         def message(method)
-          if method == :receive_message_chain
-            MESSAGE % { recommended_method: :receive, called_method: method }
-          else
-            MESSAGE % { recommended_method: :stub, called_method: method }
-          end
+          recommendation = method == :receive_message_chain ? :receive : :stub
+
+          format(
+            MESSAGE,
+            recommended_method: recommendation,
+            called_method: method
+          )
         end
       end
     end

data/lib/rubocop/rspec.rb

@@ -3,7 +3,7 @@ module RuboCop
   module RSpec
     PROJECT_ROOT   = Pathname.new(__dir__).parent.parent.expand_path.freeze
     CONFIG_DEFAULT = PROJECT_ROOT.join('config', 'default.yml').freeze
-    CONFIG         = YAML.load(CONFIG_DEFAULT.read).freeze
+    CONFIG         = YAML.safe_load(CONFIG_DEFAULT.read).freeze
 
     private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
   end