rubocop-rspec 1.12.0 → 1.13.0

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

@@ -14,37 +14,26 @@ module RuboCop
       #     expect(false).not_to be_true
       #   end
       class NotToNot < Cop
-        include RuboCop::Cop::ConfigurableEnforcedStyle
+        include ConfigurableEnforcedStyle
 
-        MSG = 'Prefer `%s` over `%s`'.freeze
+        MSG = 'Prefer `%s` over `%s`.'.freeze
 
-        METHOD_NAMES = [:not_to, :to_not].freeze
+        def_node_matcher :not_to_not_offense, '(send _ % ...)'
 
         def on_send(node)
-          _receiver, method_name, *_args = *node
-
-          return unless METHOD_NAMES.include?(method_name)
-
-          return if style.equal?(method_name)
-          add_offense(node, :expression)
-        end
-
-        def message(node)
-          _receiver, method_name, *_args = *node
-
-          if method_name.equal?(:not_to)
-            format(MSG, 'to_not', 'not_to')
-          else
-            format(MSG, 'not_to', 'to_not')
+          not_to_not_offense(node, alternative_style) do
+            add_offense(node, :expression)
           end
         end
 
         def autocorrect(node)
-          _receiver, method_name, *_args = *node
-          lambda do |corrector|
-            corrector.replace(node.loc.selector,
-                              method_name.equal?(:not_to) ? 'to_not' : 'not_to')
-          end
+          ->(corrector) { corrector.replace(node.loc.selector, style.to_s) }
+        end
+
+        private
+
+        def message(_node)
+          format(MSG, style, alternative_style)
         end
       end
     end

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

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Checks for proper shared_context and shared_examples usage.
+      #
+      # If there are no examples defined, use shared_context.
+      # If there is no setup defined, use shared_examples.
+      #
+      # @example
+      #   # bad
+      #   RSpec.shared_context 'only examples here' do
+      #     it 'does x' do
+      #     end
+      #
+      #     it 'does 'y' do
+      #     end
+      #   end
+      #
+      #   # good
+      #   RSpec.shared_examples 'only examples here' do
+      #     it 'does x' do
+      #     end
+      #
+      #     it 'does 'y' do
+      #     end
+      #   end
+      #
+      # @example
+      #   # bad
+      #   RSpec.shared_examples 'only setup here' do
+      #     subject(:foo) { :bar }
+      #
+      #     let(:baz) { :bazz }
+      #
+      #     before do
+      #       something
+      #     end
+      #   end
+      #
+      #   # good
+      #   RSpec.shared_context 'only setup here' do
+      #     subject(:foo) { :bar }
+      #
+      #     let(:baz) { :bazz }
+      #
+      #     before do
+      #       something
+      #     end
+      #   end
+      #
+      class SharedContext < Cop
+        MSG_EXAMPLES = "Use `shared_examples` when you don't "\
+                       'define context.'.freeze
+
+        MSG_CONTEXT  = "Use `shared_context` when you don't "\
+                       'define examples.'.freeze
+
+        examples = (Examples::ALL + Includes::EXAMPLES)
+        def_node_search :examples?, examples.send_pattern
+
+        context = (Hooks::ALL + Helpers::ALL + Includes::CONTEXT + Subject::ALL)
+        def_node_search :context?, context.send_pattern
+
+        def_node_matcher :shared_context, SharedGroups::CONTEXT.block_pattern
+        def_node_matcher :shared_example, SharedGroups::EXAMPLES.block_pattern
+
+        def on_block(node)
+          context_with_only_examples(node) do
+            add_shared_item_offense(node, MSG_EXAMPLES)
+          end
+
+          examples_with_only_context(node) do
+            add_shared_item_offense(node, MSG_CONTEXT)
+          end
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            context_with_only_examples(node.parent) do
+              corrector.replace(node.loc.selector, 'shared_examples')
+            end
+
+            examples_with_only_context(node.parent) do
+              corrector.replace(node.loc.selector, 'shared_context')
+            end
+          end
+        end
+
+        private
+
+        def context_with_only_examples(node)
+          shared_context(node) { yield if examples?(node) && !context?(node) }
+        end
+
+        def examples_with_only_context(node)
+          shared_example(node) { yield if context?(node) && !examples?(node) }
+        end
+
+        def add_shared_item_offense(node, message)
+          add_offense(node.children.first, :expression, message)
+        end
+      end
+    end
+  end
+end

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

@@ -15,44 +15,37 @@ module RuboCop
       #   allow(foo).to receive("bar.baz")
       #
       class SingleArgumentMessageChain < Cop
-        MESSAGE = 'Use `%<recommended_method>s` instead of calling ' \
-          '`%<called_method>s` with a single argument'.freeze
+        MSG = 'Use `%<recommended>s` instead of calling '\
+              '`%<called>s` with a single argument.'.freeze
+
+        def_node_matcher :message_chain, <<-PATTERN
+          (send _ #{Matchers::MESSAGE_CHAIN.node_pattern_union} $...)
+        PATTERN
 
         def on_send(node)
-          _receiver, method_name, *args = *node
-          return unless Matchers::MESSAGE_CHAIN.include?(method_name)
-          return if args.size > 1
-          return if multi_argument_string?(args)
+          message_chain(node) do |(first, *remaining)|
+            return if first.to_s.include?('.') || remaining.any?
 
-          add_offense(node, :selector, message(method_name))
+            add_offense(node, :selector)
+          end
         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'
-            )
+            corrector.replace(node.loc.selector, replacement(node.method_name))
           end
         end
 
         private
 
-        def multi_argument_string?(args)
-          args.size == 1 &&
-            args.first.type == :str &&
-            args.first.children.first.include?('.')
+        def replacement(method)
+          method.equal?(:receive_message_chain) ? 'receive' : 'stub'
         end
 
-        def message(method)
-          recommendation = method == :receive_message_chain ? :receive : :stub
+        def message(node)
+          method = node.method_name
 
-          format(
-            MESSAGE,
-            recommended_method: recommendation,
-            called_method: method
-          )
+          format(MSG, recommended: replacement(method), called: method)
         end
       end
     end

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

@@ -39,10 +39,10 @@ module RuboCop
         #
         #   @yield [Symbol] subject name
         def_node_matcher :subject, <<-PATTERN
-        {
-          (block (send nil :subject (sym $_)) args ...)
-          (block (send nil $:subject) args ...)
-        }
+          {
+            (block (send nil :subject (sym $_)) args ...)
+            (block (send nil $:subject) args ...)
+          }
         PATTERN
 
         # @!method message_expectation?(node, method_name)

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

@@ -25,10 +25,11 @@ module RuboCop
         PATTERN
 
         def on_send(node)
-          return unless (name = unverified_double(node))
-          return if name.type.equal?(:sym) && cop_config['IgnoreSymbolicNames']
+          unverified_double(node) do |name|
+            return if name.sym_type? && cop_config['IgnoreSymbolicNames']
 
-          add_offense(node, :expression)
+            add_offense(node, :expression)
+          end
         end
       end
     end

data/lib/rubocop/rspec/example_group.rb

@@ -17,7 +17,7 @@ module RuboCop
       #
       #   Detect if node is `before`, `after`, `around`
       def_node_matcher :hook, <<-PATTERN
-      (block {$(send nil #{Hooks::ALL.node_pattern_union} ...)} ...)
+        (block {$(send nil #{Hooks::ALL.node_pattern_union} ...)} ...)
       PATTERN
 
       def examples

data/lib/rubocop/rspec/language.rb

@@ -56,20 +56,23 @@ module RuboCop
       end
 
       module SharedGroups
-        ALL = SelectorSet.new(
-          %i(shared_examples shared_context shared_examples_for)
-        )
+        EXAMPLES = SelectorSet.new(%i(shared_examples shared_examples_for))
+        CONTEXT = SelectorSet.new(%i(shared_context))
+
+        ALL = EXAMPLES + CONTEXT
       end
 
       module Includes
-        ALL = SelectorSet.new(
+        EXAMPLES = SelectorSet.new(
           %i(
             it_behaves_like
             it_should_behave_like
-            include_context
             include_examples
           )
         )
+        CONTEXT = SelectorSet.new(%i(include_context))
+
+        ALL = EXAMPLES + CONTEXT
       end
 
       module Examples
@@ -82,19 +85,34 @@ module RuboCop
       end
 
       module Hooks
-        ALL = SelectorSet.new(%i(after around before))
+        ALL = SelectorSet.new(
+          %i(
+            prepend_before
+            before
+            append_before
+            around
+            prepend_after
+            after
+            append_after
+          )
+        )
       end
 
       module Helpers
         ALL = SelectorSet.new(%i(let let!))
       end
 
+      module Subject
+        ALL = SelectorSet.new(%i(subject))
+      end
+
       ALL =
         ExampleGroups::ALL +
         SharedGroups::ALL  +
         Examples::ALL      +
         Hooks::ALL         +
-        Helpers::ALL
+        Helpers::ALL       +
+        Subject::ALL
     end
   end
 end

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.12.0'.freeze
+      STRING = '1.13.0'.freeze
     end
   end
 end

data/spec/expect_violation/expectation_spec.rb

@@ -6,9 +6,9 @@ RSpec.describe ExpectViolation::Expectation do
   context 'when given a single assertion on class end' do
     let(:string) do
       <<-SRC
-      class Foo
-      end
-      ^^^ The end of `Foo` should be annotated.
+        class Foo
+        end
+        ^^^ The end of `Foo` should be annotated.
       SRC
     end
 
@@ -23,7 +23,7 @@ RSpec.describe ExpectViolation::Expectation do
     end
 
     it 'has an assertion on column range 1-3' do
-      expect(assertion.column_range).to eql(6...9)
+      expect(assertion.column_range).to eql(8...11)
     end
 
     it 'has an assertion with correct violation message' do
@@ -32,8 +32,8 @@ RSpec.describe ExpectViolation::Expectation do
 
     it 'recreates source' do
       expect(expectation.source).to eql(<<-RUBY)
-      class Foo
-      end
+        class Foo
+        end
       RUBY
     end
   end
@@ -41,13 +41,13 @@ RSpec.describe ExpectViolation::Expectation do
   context 'when given many assertions on two lines' do
     let(:string) do
       <<-SRC
-      foo bar
-          ^ Charlie
-         ^^ Charlie
-          ^^ Bronco
-          ^^ Alpha
-      baz
-      ^ Delta
+        foo bar
+            ^ Charlie
+           ^^ Charlie
+            ^^ Bronco
+            ^^ Alpha
+        baz
+        ^ Delta
       SRC
     end
 
@@ -65,7 +65,7 @@ RSpec.describe ExpectViolation::Expectation do
 
     it 'has assertions on column range 1-3' do
       expect(assertions.map(&:column_range)).to eql(
-        [9...11, 10...11, 10...12, 10...12, 6...7]
+        [11...13, 12...13, 12...14, 12...14, 8...9]
       )
     end
 
@@ -77,8 +77,8 @@ RSpec.describe ExpectViolation::Expectation do
 
     it 'recreates source' do
       expect(expectation.source).to eql(<<-RUBY)
-      foo bar
-      baz
+        foo bar
+        baz
       RUBY
     end
   end

data/spec/project/changelog_spec.rb

@@ -1,4 +1,4 @@
-describe 'CHANGELOG.md' do
+RSpec.describe 'CHANGELOG.md' do
   subject(:changelog) { SpecHelper::ROOT.join('CHANGELOG.md').read }
 
   it 'has link definitions for all implicit links' do

data/spec/project/default_config_spec.rb

@@ -1,4 +1,4 @@
-describe 'config/default.yml' do
+RSpec.describe 'config/default.yml' do
   subject(:default_config) do
     RuboCop::ConfigLoader.load_file('config/default.yml')
   end

data/spec/project/project_requires_spec.rb

@@ -1,4 +1,4 @@
-describe 'Project requires' do
+RSpec.describe 'Project requires' do
   it 'alphabetizes cop requires' do
     source   = SpecHelper::ROOT.join('lib', 'rubocop-rspec.rb').read
     requires = source.split("\n").grep(%r{rubocop/cop/rspec/[^(?:cop)]})

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

@@ -1,11 +1,11 @@
-describe RuboCop::Cop::RSpec::AnyInstance do
+RSpec.describe RuboCop::Cop::RSpec::AnyInstance do
   subject(:cop) { described_class.new }
 
   it 'finds `allow_any_instance_of` instead of an instance double' do
     expect_violation(<<-RUBY)
       before do
         allow_any_instance_of(Object).to receive(:foo)
-        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Avoid stubbing using `allow_any_instance_of`
+        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Avoid stubbing using `allow_any_instance_of`.
       end
     RUBY
   end
@@ -14,7 +14,7 @@ describe RuboCop::Cop::RSpec::AnyInstance do
     expect_violation(<<-RUBY)
       before do
         expect_any_instance_of(Object).to receive(:foo)
-        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Avoid stubbing using `expect_any_instance_of`
+        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Avoid stubbing using `expect_any_instance_of`.
       end
     RUBY
   end
@@ -23,7 +23,7 @@ describe RuboCop::Cop::RSpec::AnyInstance do
     expect_violation(<<-RUBY)
       before do
         Object.any_instance.should_receive(:foo)
-        ^^^^^^^^^^^^^^^^^^^ Avoid stubbing using `any_instance`
+        ^^^^^^^^^^^^^^^^^^^ Avoid stubbing using `any_instance`.
       end
     RUBY
   end