rubocop-rspec 2.2.0 → 2.3.0

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

@@ -50,13 +50,16 @@ module RuboCop
         MSG = 'Repeated include of shared_examples %<name>s ' \
           'on line(s) %<repeat>s'
 
+        # @!method several_include_examples?(node)
         def_node_matcher :several_include_examples?, <<-PATTERN
           (begin <#include_examples? #include_examples? ...>)
         PATTERN
 
+        # @!method include_examples?(node)
         def_node_matcher :include_examples?,
                          send_pattern('#Includes.examples')
 
+        # @!method shared_examples_name(node)
         def_node_matcher :shared_examples_name, <<-PATTERN
           (send _ #Includes.examples $_ ...)
         PATTERN

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

@@ -41,8 +41,13 @@ module RuboCop
         MSG_BLOCK = 'Use block for static values.'
         RESTRICT_ON_SEND = %i[and_return].freeze
 
+        # @!method contains_stub?(node)
         def_node_search :contains_stub?, '(send nil? :receive (...))'
+
+        # @!method stub_with_block?(node)
         def_node_matcher :stub_with_block?, '(block #contains_stub? ...)'
+
+        # @!method and_return_value(node)
         def_node_search :and_return_value, <<-PATTERN
           $(send _ :and_return $(...))
         PATTERN

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

@@ -56,9 +56,11 @@ module RuboCop
         MSG_EXAMPLES = "Use `shared_examples` when you don't define context."
         MSG_CONTEXT  = "Use `shared_context` when you don't define examples."
 
+        # @!method examples?(node)
         def_node_search :examples?,
                         send_pattern('{#Includes.examples #Examples.all}')
 
+        # @!method context?(node)
         def_node_search :context?, <<-PATTERN
           (
             send #rspec? {
@@ -70,8 +72,10 @@ module RuboCop
           )
         PATTERN
 
+        # @!method shared_context(node)
         def_node_matcher :shared_context,
                          block_pattern('#SharedGroups.context')
+        # @!method shared_example(node)
         def_node_matcher :shared_example,
                          block_pattern('#SharedGroups.examples')
 

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

@@ -23,10 +23,12 @@ module RuboCop
               '`%<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

@@ -81,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

@@ -34,6 +34,7 @@ module RuboCop
         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

@@ -26,6 +26,7 @@ module RuboCop
         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

@@ -16,10 +16,12 @@ module RuboCop
               '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/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/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - John Backus
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-02 00:00:00.000000000 Z
+date: 2021-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -251,11 +251,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: []
@@ -265,14 +265,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.2.2
+rubygems_version: 3.2.16
 signing_key:
 specification_version: 4
 summary: Code style checking for RSpec files