rubocop-rspec 1.8.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6bfc346a6e12eab244a17f9fc8401bfb1c4c8d86
-  data.tar.gz: f0b9285af75fab2774940505d868ef097936d8ec
+  metadata.gz: d160e862b58dbfd9bcd2ae0966bd185d1ed13d25
+  data.tar.gz: 3b32f0c16a19b8f110e40d79f4a87d510e3c9226
 SHA512:
-  metadata.gz: ed95fbfc52c82a0f4c7674a675e805ca1649c8088734fc19c31d73c70eb2c15cee292d36579184ff2f61beb13492543d9cac5b19abb3190de23ebbfc168dd0a1
-  data.tar.gz: b225fca79ccc76547a283c140b2e5add1430c13dcb5bd3db74a0b68d7fa7a4546be8aa5d1ad9e67387969f9c72bd3ce8702e6255d7a048e542a9ff975ddfa596
+  metadata.gz: b429eb8553d36a1aec8613f57a4f3356518acb89ade8e41f96093dc6ba430b592b3a35899dcefe8df5833a1c0ceb7afa8d3bf1431ad554ffaeb057b2775df622
+  data.tar.gz: 4bc98868826de4ba820c107b5507beb1b57259d147199cec394054c5ac6887786ba1db1ce396bfcfe8ed345387b736b73b18c8b0e1bf0f3b3841f665e7f23064

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 ## Master (unreleased)
 
+## 1.9.0 (2016-12-29)
+
+* Add `MessageSpies` cop for enforcing consistent style of either `expect(...).to have_received` or `expect(...).to receive`, intended as a replacement for the `MessageExpectation` cop. ([@bquorning][])
+* Fix `DescribeClass` to not flag `describe` at the top of a block of shared examples. ([@clupprich][])
+* Add `SingleArgumentMessageChain` cop for recommending use of `receive` instead of `receive_message_chain` where possible. ([@bquorning][])
+* Add `RepeatedDescription` cop for detecting repeated example descriptions within example groups. ([@backus][])
+
 ## 1.8.0 (2016-10-27)
 
 * Optionally ignore method names in the `describe` argument when running the `FilePath` cop. ([@bquorning][])
@@ -148,3 +155,4 @@
 [@jaredmoody]: https://github.com/jaredmoody
 [@baberthal]: https://github.com/baberthal
 [@jeffreyc]: https://github.com/jeffreyc
+[@clupprich]: https://github.com/clupprich

data/Gemfile

@@ -3,7 +3,8 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
-  gem 'codeclimate-test-reporter', require: false
+  gem 'codeclimate-test-reporter', '~> 1.0.0'
+  gem 'simplecov',                 '~> 0.12.0', require: false
 end
 
 local_gemfile = 'Gemfile.local'

data/Rakefile

@@ -20,6 +20,8 @@ desc 'Run RSpec with code coverage'
 task :coverage do
   ENV['COVERAGE'] = 'true'
   Rake::Task['spec'].execute
+
+  sh('codeclimate-test-reporter') if ENV['CI']
 end
 
 desc 'Run RuboCop over this gem'
@@ -42,4 +44,4 @@ task confirm_config: :build_config do
   end
 end
 
-task default: [:build_config, :spec, :internal_investigation, :confirm_config]
+task default: %i(build_config coverage internal_investigation confirm_config)

data/config/default.yml

@@ -103,6 +103,14 @@ RSpec/MessageExpectation:
   - allow
   - expect
 
+RSpec/MessageSpies:
+  Description: Checks that message expectations are set using spies.
+  Enabled: true
+  EnforcedStyle: have_received
+  SupportedStyles:
+  - have_received
+  - receive
+
 RSpec/MultipleDescribes:
   Description: Checks for multiple top level describes.
   Enabled: true
@@ -129,6 +137,14 @@ RSpec/NotToNot:
   - to_not
   Enabled: true
 
+RSpec/RepeatedDescription:
+  Enabled: true
+  Description: Check for repeated description strings in example groups.
+
+RSpec/SingleArgumentMessageChain:
+  Description: Checks that chains of messages contain more than one element.
+  Enabled: true
+
 RSpec/SubjectStub:
   Description: Checks for stubbed test subjects.
   Enabled: true

data/lib/rubocop-rspec.rb

@@ -11,7 +11,9 @@ require 'rubocop/rspec/wording'
 require 'rubocop/rspec/util'
 require 'rubocop/rspec/language'
 require 'rubocop/rspec/language/node_pattern'
-require 'rubocop/rspec/spec_only'
+require 'rubocop/rspec/example_group'
+require 'rubocop/rspec/example'
+require 'rubocop/cop/rspec/cop'
 
 RuboCop::RSpec::Inject.defaults!
 
@@ -34,10 +36,13 @@ require 'rubocop/cop/rspec/leading_subject'
 require 'rubocop/cop/rspec/let_setup'
 require 'rubocop/cop/rspec/message_chain'
 require 'rubocop/cop/rspec/message_expectation'
+require 'rubocop/cop/rspec/message_spies'
 require 'rubocop/cop/rspec/multiple_describes'
 require 'rubocop/cop/rspec/multiple_expectations'
 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/single_argument_message_chain'
 require 'rubocop/cop/rspec/subject_stub'
 require 'rubocop/cop/rspec/verified_doubles'

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

@@ -21,8 +21,6 @@ module RuboCop
       #     end
       #   end
       class AnyInstance < Cop
-        include RuboCop::RSpec::SpecOnly
-
         MESSAGE = 'Avoid stubbing using `%{method}`'.freeze
 
         ANY_INSTANCE_METHODS = [

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

@@ -34,8 +34,7 @@ module RuboCop
       # coerce objects for comparison.
       #
       class BeEql < Cop
-        include RuboCop::RSpec::SpecOnly,
-                RuboCop::Cop::ConfigurableEnforcedStyle
+        include RuboCop::Cop::ConfigurableEnforcedStyle
 
         MSG = 'Prefer `be` over `eql`'.freeze
 

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

@@ -0,0 +1,66 @@
+module RuboCop
+  module Cop # rubocop:disable Style/Documentation
+    WorkaroundCop = Cop.dup
+
+    # Clone of the the normal RuboCop::Cop::Cop class so we can rewrite
+    # the inherited method without breaking functionality
+    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
+
+      # Special case `Module#<` so that the rspec support rubocop exports
+      # is compatible with our subclass
+      def self.<(other)
+        other.equal?(RuboCop::Cop::Cop) || super
+      end
+    end
+    private_constant(:WorkaroundCop)
+
+    module RSpec
+      # @abstract parent class to rspec cops
+      #
+      # The criteria for whether rubocop-rspec analyzes a certain ruby file
+      # is configured via `AllCops/RSpec`. For example, if you want to
+      # customize your project to scan all files within a `test/` directory
+      # then you could add this to your configuration:
+      #
+      # @example configuring analyzed paths
+      #
+      #   AllCops:
+      #     RSpec:
+      #       Patterns:
+      #       - '_test.rb$'
+      #       - '(?:^|/)test/'
+      class Cop < WorkaroundCop
+        DEFAULT_CONFIGURATION =
+          RuboCop::RSpec::CONFIG.fetch('AllCops').fetch('RSpec')
+
+        include RuboCop::RSpec::Language, RuboCop::RSpec::Language::NodePattern
+
+        # Invoke the original inherited hook so our cops are recognized
+        def self.inherited(subclass)
+          RuboCop::Cop::Cop.inherited(subclass)
+        end
+
+        def relevant_file?(file)
+          rspec_pattern =~ file && super
+        end
+
+        private
+
+        def rspec_pattern
+          Regexp.union(rspec_pattern_config.map(&Regexp.public_method(:new)))
+        end
+
+        def rspec_pattern_config
+          config
+            .for_all_cops
+            .fetch('RSpec', DEFAULT_CONFIGURATION)
+            .fetch('Patterns')
+        end
+      end
+    end
+  end
+end

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

@@ -17,7 +17,7 @@ module RuboCop
       #   describe "A feature example", type: :feature do
       #   end
       class DescribeClass < Cop
-        include RuboCop::RSpec::SpecOnly, RuboCop::RSpec::TopLevelDescribe
+        include RuboCop::RSpec::TopLevelDescribe
 
         MSG = 'The first argument to describe should be '\
               'the class or module being tested.'.freeze
@@ -39,7 +39,12 @@ module RuboCop
           (sym {:request :feature :routing :view}))
         PATTERN
 
+        def_node_matcher :shared_group?, <<-PATTERN
+          (block (send {(const nil :RSpec) nil} #{SharedGroups::ALL.node_pattern_union} ...) ...)
+        PATTERN
+
         def on_top_level_describe(node, args)
+          return if shared_group?(root_node)
           return if valid_describe?(node)
 
           describe_with_metadata(node) do |pairs|

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

@@ -17,8 +17,7 @@ module RuboCop
       #   describe MyClass, '.my_class_method' do
       #   end
       class DescribeMethod < Cop
-        include RuboCop::RSpec::SpecOnly,
-                RuboCop::RSpec::TopLevelDescribe,
+        include RuboCop::RSpec::TopLevelDescribe,
                 RuboCop::RSpec::Util
 
         MESSAGE = 'The second argument to describe should be the method ' \

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

@@ -20,20 +20,17 @@ module RuboCop
       #     subject { described_class.do_something }
       #   end
       class DescribedClass < Cop
-        include RuboCop::RSpec::SpecOnly, RuboCop::RSpec::TopLevelDescribe
+        include RuboCop::RSpec::TopLevelDescribe
 
         DESCRIBED_CLASS = 'described_class'.freeze
         MSG             = "Use `#{DESCRIBED_CLASS}` instead of `%s`".freeze
 
-        RSPEC_BLOCK_METHODS = RuboCop::RSpec::Language::ALL.to_node_pattern
-
         def_node_matcher :common_instance_exec_closure?, <<-PATTERN
           (block (send (const nil {:Class :Module}) :new ...) ...)
         PATTERN
 
-        def_node_matcher :rspec_block?, <<-PATTERN
-          (block (send nil {#{RSPEC_BLOCK_METHODS}} ...) ...)
-        PATTERN
+        def_node_matcher :rspec_block?,
+                         RuboCop::RSpec::Language::ALL.block_pattern
 
         def_node_matcher :scope_changing_syntax?, '{def class module}'
 

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

@@ -58,21 +58,11 @@ module RuboCop
       #   end
       #
       class EmptyExampleGroup < Cop
-        include RuboCop::RSpec::SpecOnly,
-                RuboCop::RSpec::Language,
-                RuboCop::RSpec::Language::NodePattern
-
         MSG = 'Empty example group detected.'.freeze
 
         def_node_search :contains_example?, <<-PATTERN
           {
-            (send _ {
-              #{Examples::ALL.to_node_pattern}
-              :it_behaves_like
-              :it_should_behave_like
-              :include_context
-              :include_examples
-            } ...)
+            #{(Examples::ALL + Includes::ALL).send_pattern}
             (send _ #custom_include? ...)
           }
         PATTERN

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

@@ -26,7 +26,7 @@ module RuboCop
       #     expect(result).to be(true)
       #   end
       class ExampleLength < Cop
-        include RuboCop::RSpec::SpecOnly, CodeLength
+        include CodeLength
 
         EXAMPLE_BLOCKS = RuboCop::RSpec::Language::Examples::ALL
 

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

@@ -19,8 +19,6 @@ module RuboCop
       #   it 'finds nothing' do
       #   end
       class ExampleWording < Cop
-        include RuboCop::RSpec::SpecOnly
-
         MSG = 'Do not use should when describing your tests.'.freeze
 
         def on_block(node) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength,Metrics/LineLength

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

@@ -17,8 +17,6 @@ module RuboCop
       #   expect(name).to eq("John")
       #
       class ExpectActual < Cop
-        include RuboCop::RSpec::SpecOnly
-
         MSG = 'Provide the actual you are testing to `expect(...)`'.freeze
 
         SIMPLE_LITERALS = %i(

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

@@ -42,7 +42,7 @@ module RuboCop
       #   my_class_spec.rb         # describe MyClass, '#method'
       #
       class FilePath < Cop
-        include RuboCop::RSpec::SpecOnly, RuboCop::RSpec::TopLevelDescribe
+        include RuboCop::RSpec::TopLevelDescribe
 
         MESSAGE = 'Spec path should end with `%s`'.freeze
         ROUTING_PAIR = s(:pair, s(:sym, :type), s(:sym, :routing))

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

@@ -20,8 +20,6 @@ module RuboCop
       #   describe MyClass do
       #   end
       class Focus < Cop
-        include RuboCop::RSpec::SpecOnly, RuboCop::RSpec::Language
-
         MSG = 'Focused spec found.'.freeze
 
         focusable =
@@ -32,20 +30,17 @@ module RuboCop
 
         focused = ExampleGroups::FOCUSED + Examples::FOCUSED
 
-        FOCUSABLE_SELECTORS = focusable.to_node_pattern
-        FOCUSING_SELECTORS  = focused.to_node_pattern
+        FOCUSABLE_SELECTORS = focusable.node_pattern_union
 
         FOCUS_SYMBOL = s(:sym, :focus)
         FOCUS_TRUE   = s(:pair, FOCUS_SYMBOL, s(:true))
 
         def_node_matcher :metadata, <<-PATTERN
-          {(send nil {#{FOCUSABLE_SELECTORS}} ... (hash $...))
-           (send nil {#{FOCUSABLE_SELECTORS}} $...)}
+          {(send nil #{FOCUSABLE_SELECTORS} ... (hash $...))
+           (send nil #{FOCUSABLE_SELECTORS} $...)}
         PATTERN
 
-        def_node_matcher :focused_block?, <<-PATTERN
-          (send nil {#{FOCUSING_SELECTORS}} ...)
-        PATTERN
+        def_node_matcher :focused_block?, focused.send_pattern
 
         def on_send(node)
           focus_metadata(node) do |focus|

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

@@ -57,15 +57,13 @@ module RuboCop
       #   before(:example) do
       #     ...
       #   end
-      class HookArgument < RuboCop::Cop::Cop
-        include RuboCop::RSpec::Language,
-                RuboCop::RSpec::SpecOnly,
-                ConfigurableEnforcedStyle
+      class HookArgument < Cop
+        include ConfigurableEnforcedStyle
 
         IMPLICIT_MSG = 'Omit the default `%p` argument for RSpec hooks.'.freeze
         EXPLICIT_MSG = 'Use `%p` for RSpec hooks.'.freeze
 
-        HOOKS = "{#{Hooks::ALL.to_node_pattern}}".freeze
+        HOOKS = Hooks::ALL.node_pattern_union.freeze
 
         def_node_matcher :scoped_hook, <<-PATTERN
         (block $(send nil #{HOOKS} (sym ${:each :example})) ...)

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

@@ -25,7 +25,7 @@ module RuboCop
       #   it { should be_truthy }
       #
       class ImplicitExpect < Cop
-        include RuboCop::RSpec::SpecOnly, ConfigurableEnforcedStyle
+        include ConfigurableEnforcedStyle
 
         MSG = 'Prefer `%<good>s` over `%<bad>s`.'.freeze
 

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

@@ -47,15 +47,11 @@ module RuboCop
       #   end
       #
       class InstanceVariable < Cop
-        include RuboCop::RSpec::SpecOnly, RuboCop::RSpec::Language
-
         MESSAGE = 'Use `let` instead of an instance variable'.freeze
 
         EXAMPLE_GROUP_METHODS = ExampleGroups::ALL + SharedGroups::ALL
 
-        def_node_matcher :spec_group?, <<-PATTERN
-          (block (send _ {#{EXAMPLE_GROUP_METHODS.to_node_pattern}} ...) ...)
-        PATTERN
+        def_node_matcher :spec_group?, EXAMPLE_GROUP_METHODS.block_pattern
 
         def_node_search :ivar_usage, '$(ivar $_)'
 

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

@@ -27,8 +27,6 @@ module RuboCop
       #     end
       #   end
       class LeadingSubject < Cop
-        include RuboCop::RSpec::SpecOnly, RuboCop::RSpec::Language
-
         MSG = 'Declare `subject` above any other `let` declarations'.freeze
 
         def_node_matcher :subject?, '(block $(send nil :subject ...) args ...)'

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

@@ -26,10 +26,7 @@ module RuboCop
       #     expect(Widget.count).to eq(1)
       #   end
       class LetSetup < Cop
-        include RuboCop::RSpec::SpecOnly,
-                RuboCop::RSpec::TopLevelDescribe,
-                RuboCop::RSpec::Language,
-                RuboCop::RSpec::Language::NodePattern
+        include RuboCop::RSpec::TopLevelDescribe
 
         MSG = 'Do not use `let!` for test setup.'.freeze
 

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

@@ -12,18 +12,11 @@ module RuboCop
       #   allow(foo).to receive(bar: thing)
       #
       class MessageChain < Cop
-        include RuboCop::RSpec::SpecOnly
-
         MESSAGE = 'Avoid stubbing using `%<method>s`'.freeze
 
-        MESSAGE_CHAIN_METHODS = [
-          :receive_message_chain,
-          :stub_chain
-        ].freeze
-
         def on_send(node)
           _receiver, method_name, *_args = *node
-          return unless MESSAGE_CHAIN_METHODS.include?(method_name)
+          return unless Matchers::MESSAGE_CHAIN.include?(method_name)
 
           add_offense(node, :selector, MESSAGE % { method: method_name })
         end