rubocop-rspec 2.0.0 → 2.4.0

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

@@ -23,6 +23,7 @@ module RuboCop
       class SharedExamples < Base
         extend AutoCorrector
 
+        # @!method shared_examples(node)
         def_node_matcher :shared_examples,
                          send_pattern(
                            '{#SharedGroups.all #Includes.all}'

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

@@ -19,13 +19,16 @@ module RuboCop
       class SingleArgumentMessageChain < Base
         extend AutoCorrector
 
-        MSG = 'Use `%<recommended>s` instead of calling '\
+        MSG = 'Use `%<recommended>s` instead of calling ' \
               '`%<called>s` with a single argument.'
+        RESTRICT_ON_SEND = %i[receive_message_chain stub_chain].freeze
 
+        # @!method message_chain(node)
         def_node_matcher :message_chain, <<-PATTERN
           (send _ {:receive_message_chain :stub_chain} $_)
         PATTERN
 
+        # @!method single_key_hash?(node)
         def_node_matcher :single_key_hash?, '(hash pair)'
 
         def on_send(node)

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

@@ -39,6 +39,7 @@ module RuboCop
           }
         PATTERN
 
+        # @!method configured_response?(node)
         def_node_matcher :configured_response?, <<~PATTERN
           { :and_return :and_raise :and_throw :and_yield
             :and_call_original :and_wrap_original }

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

@@ -13,11 +13,21 @@ module RuboCop
       #
       # @example
       #   # bad
-      #   describe Foo do
-      #     subject(:bar) { baz }
+      #   describe Article do
+      #     subject(:article) { Article.new }
       #
-      #     before do
-      #       allow(bar).to receive(:qux?).and_return(true)
+      #     it 'indicates that the author is unknown' do
+      #       allow(article).to receive(:author).and_return(nil)
+      #       expect(article.description).to include('by an unknown author')
+      #     end
+      #   end
+      #
+      #   # good
+      #   describe Article do
+      #     subject(:article) { Article.new(author: nil) }
+      #
+      #     it 'indicates that the author is unknown' do
+      #       expect(article.description).to include('by an unknown author')
       #     end
       #   end
       #
@@ -71,6 +81,7 @@ module RuboCop
           )
         PATTERN
 
+        # @!method message_expectation_matcher?(node)
         def_node_search :message_expectation_matcher?, <<-PATTERN
           (send nil? {
             :receive :receive_messages :receive_message_chain :have_received

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

@@ -32,7 +32,9 @@ module RuboCop
       #     expect { do_something }.not_to raise_error
       class UnspecifiedException < Base
         MSG = 'Specify the exception being captured'
+        RESTRICT_ON_SEND = %i[to].freeze
 
+        # @!method empty_raise_error_or_exception(node)
         def_node_matcher :empty_raise_error_or_exception, <<-PATTERN
           (send
             (block

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

@@ -24,7 +24,9 @@ module RuboCop
       #   end
       class VerifiedDoubles < Base
         MSG = 'Prefer using verifying doubles over normal doubles.'
+        RESTRICT_ON_SEND = %i[double spy].freeze
 
+        # @!method unverified_double(node)
         def_node_matcher :unverified_double, <<-PATTERN
           {(send nil? {:double :spy} $...)}
         PATTERN

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

@@ -14,11 +14,14 @@ module RuboCop
       class VoidExpect < Base
         MSG = 'Do not use `expect()` without `.to` or `.not_to`. ' \
               'Chain the methods or remove it.'
+        RESTRICT_ON_SEND = %i[expect].freeze
 
+        # @!method expect?(node)
         def_node_matcher :expect?, <<-PATTERN
           (send nil? :expect ...)
         PATTERN
 
+        # @!method expect_block?(node)
         def_node_matcher :expect_block?, <<-PATTERN
           (block #expect? (args) _body)
         PATTERN

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

@@ -17,10 +17,13 @@ module RuboCop
 
         MSG = 'Use `.and_yield`.'
 
+        # @!method method_on_stub?(node)
         def_node_search :method_on_stub?, '(send nil? :receive ...)'
 
+        # @!method block_arg(node)
         def_node_matcher :block_arg, '(args (blockarg $_))'
 
+        # @!method block_call?(node)
         def_node_matcher :block_call?, '(send (lvar %) :call ...)'
 
         def on_block(node)

data/lib/rubocop/cop/rspec_cops.rb

@@ -8,6 +8,7 @@ require_relative 'rspec/factory_bot/attribute_defined_statically'
 require_relative 'rspec/factory_bot/create_list'
 require_relative 'rspec/factory_bot/factory_class_name'
 
+require_relative 'rspec/rails/avoid_setup_hook'
 begin
   require_relative 'rspec/rails/http_status'
 rescue LoadError
@@ -47,6 +48,7 @@ require_relative 'rspec/file_path'
 require_relative 'rspec/focus'
 require_relative 'rspec/hook_argument'
 require_relative 'rspec/hooks_before_examples'
+require_relative 'rspec/identical_equality_assertion'
 require_relative 'rspec/implicit_block_expectation'
 require_relative 'rspec/implicit_expect'
 require_relative 'rspec/implicit_subject'

data/lib/rubocop/rspec/config_formatter.rb

@@ -15,7 +15,9 @@ module RuboCop
       end
 
       def dump
-        YAML.dump(unified_config).gsub(EXTENSION_ROOT_DEPARTMENT, "\n\\1")
+        YAML.dump(unified_config)
+          .gsub(EXTENSION_ROOT_DEPARTMENT, "\n\\1")
+          .gsub(/^(\s+)- /, '\1  - ')
       end
 
       private

data/lib/rubocop/rspec/corrector/move_node.rb

@@ -6,6 +6,7 @@ module RuboCop
       # Helper methods to move a node
       class MoveNode
         include RuboCop::Cop::RangeHelp
+        include RuboCop::Cop::RSpec::CommentsHelp
         include RuboCop::Cop::RSpec::FinalEndLocation
 
         attr_reader :original, :corrector, :processed_source
@@ -17,20 +18,16 @@ module RuboCop
         end
 
         def move_before(other)
-          position = other.loc.expression
-          indent = ' ' * other.loc.column
-          newline_indent = "\n#{indent}"
+          position = start_line_position(other)
 
-          corrector.insert_before(position, source(original) + newline_indent)
+          corrector.insert_before(position, "#{source(original)}\n")
           corrector.remove(node_range_with_surrounding_space(original))
         end
 
         def move_after(other)
-          position = final_end_location(other)
-          indent = ' ' * other.loc.column
-          newline_indent = "\n#{indent}"
+          position = end_line_position(other)
 
-          corrector.insert_after(position, newline_indent + source(original))
+          corrector.insert_after(position, "\n#{source(original)}")
           corrector.remove(node_range_with_surrounding_space(original))
         end
 
@@ -41,7 +38,7 @@ module RuboCop
         end
 
         def node_range(node)
-          node.loc.expression.with(end_pos: final_end_location(node).end_pos)
+          source_range_with_comment(node)
         end
 
         def node_range_with_surrounding_space(node)

data/lib/rubocop/rspec/example.rb

@@ -4,8 +4,13 @@ module RuboCop
   module RSpec
     # Wrapper for RSpec examples
     class Example < Concept
+      # @!method extract_doc_string(node)
       def_node_matcher :extract_doc_string,     '(send _ _ $_ ...)'
+
+      # @!method extract_metadata(node)
       def_node_matcher :extract_metadata,       '(send _ _ _ $...)'
+
+      # @!method extract_implementation(node)
       def_node_matcher :extract_implementation, '(block send args $_)'
 
       def doc_string

data/lib/rubocop/rspec/hook.rb

@@ -4,6 +4,7 @@ module RuboCop
   module RSpec
     # Wrapper for RSpec hook
     class Hook < Concept
+      # @!method extract_metadata(node)
       def_node_matcher :extract_metadata, <<~PATTERN
         (block
           (send _ _ #valid_scope? ? $...) ...

data/lib/rubocop/rspec/language.rb

@@ -19,23 +19,31 @@ module RuboCop
         attr_accessor :config
       end
 
+      # @!method rspec?(node)
       def_node_matcher :rspec?, '{(const {nil? cbase} :RSpec) nil?}'
 
+      # @!method example_group?(node)
       def_node_matcher :example_group?, block_pattern('#ExampleGroups.all')
 
+      # @!method shared_group?(node)
       def_node_matcher :shared_group?, block_pattern('#SharedGroups.all')
 
+      # @!method spec_group?(node)
       def_node_matcher :spec_group?,
                        block_pattern('{#SharedGroups.all #ExampleGroups.all}')
 
+      # @!method example_group_with_body?(node)
       def_node_matcher :example_group_with_body?, <<-PATTERN
         (block #{send_pattern('#ExampleGroups.all')} args !nil?)
       PATTERN
 
+      # @!method example?(node)
       def_node_matcher :example?, block_pattern('#Examples.all')
 
+      # @!method hook?(node)
       def_node_matcher :hook?, block_pattern('#Hooks.all')
 
+      # @!method let?(node)
       def_node_matcher :let?, <<-PATTERN
         {
           #{block_pattern('#Helpers.all')}
@@ -43,6 +51,7 @@ module RuboCop
         }
       PATTERN
 
+      # @!method include?(node)
       def_node_matcher :include?, <<-PATTERN
         {
           #{send_pattern('#Includes.all')}
@@ -50,6 +59,7 @@ module RuboCop
         }
       PATTERN
 
+      # @!method subject?(node)
       def_node_matcher :subject?, block_pattern('#Subjects.all')
 
       module ExampleGroups # :nodoc:

data/lib/rubocop/rspec/node.rb

@@ -2,7 +2,7 @@
 
 module RuboCop
   module RSpec
-    # RuboCop-RSpec specific extensions of RuboCop::AST::Node
+    # RuboCop RSpec specific extensions of RuboCop::AST::Node
     module Node
       # In various cops we want to regard const as literal althought it's not
       # strictly literal.

data/lib/rubocop/rspec/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.4.0
 platform: ruby
 authors:
 - John Backus
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-06 00:00:00.000000000 Z
+date: 2021-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -183,6 +183,7 @@ files:
 - lib/rubocop/cop/rspec/focus.rb
 - lib/rubocop/cop/rspec/hook_argument.rb
 - lib/rubocop/cop/rspec/hooks_before_examples.rb
+- lib/rubocop/cop/rspec/identical_equality_assertion.rb
 - lib/rubocop/cop/rspec/implicit_block_expectation.rb
 - lib/rubocop/cop/rspec/implicit_expect.rb
 - lib/rubocop/cop/rspec/implicit_subject.rb
@@ -198,6 +199,7 @@ files:
 - lib/rubocop/cop/rspec/message_expectation.rb
 - lib/rubocop/cop/rspec/message_spies.rb
 - lib/rubocop/cop/rspec/missing_example_group_argument.rb
+- lib/rubocop/cop/rspec/mixin/comments_help.rb
 - lib/rubocop/cop/rspec/mixin/empty_line_separation.rb
 - lib/rubocop/cop/rspec/mixin/final_end_location.rb
 - lib/rubocop/cop/rspec/mixin/top_level_group.rb
@@ -212,6 +214,7 @@ files:
 - lib/rubocop/cop/rspec/overwriting_setup.rb
 - lib/rubocop/cop/rspec/pending.rb
 - lib/rubocop/cop/rspec/predicate_matcher.rb
+- lib/rubocop/cop/rspec/rails/avoid_setup_hook.rb
 - lib/rubocop/cop/rspec/rails/http_status.rb
 - lib/rubocop/cop/rspec/receive_counts.rb
 - lib/rubocop/cop/rspec/receive_never.rb
@@ -250,11 +253,11 @@ files:
 - lib/rubocop/rspec/node.rb
 - lib/rubocop/rspec/version.rb
 - lib/rubocop/rspec/wording.rb
-homepage: https://github.com/rubocop-hq/rubocop-rspec
+homepage: https://github.com/rubocop/rubocop-rspec
 licenses:
 - MIT
 metadata:
-  changelog_uri: https://github.com/rubocop-hq/rubocop-rspec/blob/master/CHANGELOG.md
+  changelog_uri: https://github.com/rubocop/rubocop-rspec/blob/master/CHANGELOG.md
   documentation_uri: https://docs.rubocop.org/rubocop-rspec/
 post_install_message:
 rdoc_options: []
@@ -264,14 +267,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.16
 signing_key:
 specification_version: 4
 summary: Code style checking for RSpec files