rubocop-rspec 1.21.0 → 1.22.0

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

@@ -13,49 +13,49 @@ module RuboCop
       # @example when configuration is `EnforcedStyle: implicit`
       #   # bad
       #   before(:each) do
-      #     ...
+      #     # ...
       #   end
       #
       #   # bad
       #   before(:example) do
-      #     ...
+      #     # ...
       #   end
       #
       #   # good
       #   before do
-      #     ...
+      #     # ...
       #   end
       #
       # @example when configuration is `EnforcedStyle: each`
       #   # bad
       #   before(:example) do
-      #     ...
+      #     # ...
       #   end
       #
       #   # good
       #   before do
-      #     ...
+      #     # ...
       #   end
       #
       #   # good
       #   before(:each) do
-      #     ...
+      #     # ...
       #   end
       #
       # @example when configuration is `EnforcedStyle: example`
       #   # bad
       #   before(:each) do
-      #     ...
+      #     # ...
       #   end
       #
       #   # bad
       #   before do
-      #     ...
+      #     # ...
       #   end
       #
       #   # good
       #   before(:example) do
-      #     ...
+      #     # ...
       #   end
       class HookArgument < Cop
         include ConfigurableEnforcedStyle

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

@@ -53,6 +53,10 @@ module RuboCop
 
         def_node_matcher :spec_group?, EXAMPLE_GROUP_METHODS.block_pattern
 
+        def_node_matcher :dynamic_class?, <<-PATTERN
+          (block (send (const nil? :Class) :new ...) ...)
+        PATTERN
+
         def_node_search :ivar_usage, '$(ivar $_)'
 
         def_node_search :ivar_assigned?, '(ivasgn % ...)'
@@ -61,6 +65,7 @@ module RuboCop
           return unless spec_group?(node)
 
           ivar_usage(node) do |ivar, name|
+            return if inside_dynamic_class?(ivar)
             return if assignment_only? && !ivar_assigned?(node, name)
 
             add_offense(ivar, location: :expression)
@@ -69,6 +74,10 @@ module RuboCop
 
         private
 
+        def inside_dynamic_class?(node)
+          node.each_ancestor(:block).any? { |block| dynamic_class?(block) }
+        end
+
         def assignment_only?
           cop_config['AssignmentOnly']
         end

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

@@ -62,14 +62,7 @@ module RuboCop
         end
 
         def node_range(node)
-          range = node.source_range
-          range = range_with_surrounding_space(
-            range: range, side: :left, newlines: false
-          )
-          range = range_with_surrounding_space(
-            range: range, side: :right, newlines: true
-          )
-          range
+          range_by_whole_lines(node.source_range, include_final_newline: true)
         end
 
         def in_spec_block?(node)

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

@@ -47,6 +47,17 @@ module RuboCop
           check_let_declarations(node.body) if multiline_block?(node.body)
         end
 
+        def autocorrect(node)
+          lambda do |corrector|
+            first_example = find_first_example(node.parent)
+            first_example_pos = first_example.loc.expression
+            indent = "\n" + ' ' * first_example.loc.column
+
+            corrector.insert_before(first_example_pos, source(node) + indent)
+            corrector.remove(node_range_with_surrounding_space(node))
+          end
+        end
+
         private
 
         def multiline_block?(block)
@@ -54,16 +65,45 @@ module RuboCop
         end
 
         def check_let_declarations(node)
-          example_found = false
+          first_example = find_first_example(node)
+          return unless first_example
 
           node.each_child_node do |child|
-            if let?(child)
-              add_offense(child, location: :expression) if example_found
-            elsif example_or_group?(child)
-              example_found = true
-            end
+            next if child.sibling_index < first_example.sibling_index
+            add_offense(child, location: :expression) if let?(child)
+          end
+        end
+
+        def find_first_example(node)
+          node.children.find { |sibling| example_or_group?(sibling) }
+        end
+
+        def node_range_with_surrounding_space(node)
+          range = node_range(node)
+          range_by_whole_lines(range, include_final_newline: true)
+        end
+
+        def source(node)
+          node_range(node).source
+        end
+
+        def node_range(node)
+          range_between(node.loc.expression.begin_pos, last_node_loc(node))
+        end
+
+        def last_node_loc(node)
+          heredoc = heredoc_lines(node).last
+
+          if heredoc
+            heredoc.loc.heredoc_end.end_pos
+          else
+            node.loc.end.end_pos
           end
         end
+
+        def heredoc_lines(node)
+          node.body.child_nodes.select { |n| n.loc.respond_to?(:heredoc_end) }
+        end
       end
     end
   end

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

@@ -15,8 +15,8 @@ module RuboCop
       #   describe MyClass, '.do_something_else' do
       #   end
       #
-      #   #good
-      #   describe MyClass
+      #   # good
+      #   describe MyClass do
       #     describe '.do_something' do
       #     end
       #     describe '.do_something_else' do

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

@@ -26,7 +26,7 @@ module RuboCop
       #       expect(user.name).to eq("John")
       #     end
       #
-      #     it 'sets the users age'
+      #     it 'sets the users age' do
       #       expect(user.age).to eq(22)
       #     end
       #   end
@@ -96,10 +96,8 @@ module RuboCop
         end
 
         def flag_example(node, expectation_count:)
-          method, = *node
-
           add_offense(
-            method,
+            node.send_node,
             location: :expression,
             message: format(
               MSG,

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

@@ -64,8 +64,7 @@ module RuboCop
 
         def rename_autocorrect(node)
           lambda do |corrector|
-            send_node, _args, _body = *node
-            corrector.replace(send_node.loc.selector, 'let')
+            corrector.replace(node.send_node.loc.selector, 'let')
           end
         end
 

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

@@ -21,7 +21,7 @@ module RuboCop
       #       let(:user_attributes) do
       #         {
       #           name: 'John',
-      #           age:  22
+      #           age:  22,
       #           role: role
       #         }
       #       end
@@ -43,7 +43,7 @@ module RuboCop
       #     let(:user) do
       #       UserCreate.call(
       #         name: 'John',
-      #         age:  22
+      #         age:  22,
       #         role: 'admin'
       #       )
       #     end

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

@@ -7,20 +7,20 @@ module RuboCop
       #
       # @example
       #   # bad
-      #     let(:foo) { bar }
-      #     let(:foo) { baz }
+      #   let(:foo) { bar }
+      #   let(:foo) { baz }
       #
-      #     subject(:foo) { bar }
-      #     let(:foo) { baz }
+      #   subject(:foo) { bar }
+      #   let(:foo) { baz }
       #
-      #     let(:foo) { bar }
-      #     let!(:foo) { baz }
+      #   let(:foo) { bar }
+      #   let!(:foo) { baz }
       #
       #   # good
-      #     subject(:test) { something }
-      #     let(:foo) { bar }
-      #     let(:baz) { baz }
-      #     let!(:other) { other }
+      #   subject(:test) { something }
+      #   let(:foo) { bar }
+      #   let(:baz) { baz }
+      #   let!(:other) { other }
       class OverwritingSetup < Cop
         MSG = '`%<name>s` is already defined.'.freeze
 
@@ -31,9 +31,7 @@ module RuboCop
         def on_block(node)
           return unless example_group_with_body?(node)
 
-          _describe, _args, body = *node
-
-          find_duplicates(body) do |duplicate, name|
+          find_duplicates(node.body) do |duplicate, name|
             add_offense(
               duplicate,
               location: :expression,

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

@@ -53,6 +53,14 @@ module RuboCop
           end
         end
 
+        def autocorrect(node)
+          if style == :block
+            AndReturnCallCorrector.new(node)
+          else
+            BlockBodyCorrector.new(node)
+          end
+        end
+
         private
 
         def check_and_return_call(node)
@@ -84,6 +92,83 @@ module RuboCop
         def dynamic?(node)
           !node.recursive_literal?
         end
+
+        # :nodoc:
+        class AndReturnCallCorrector
+          def initialize(node)
+            @node = node
+            @receiver, _method_name, @args = *node
+          end
+
+          def call(corrector)
+            # Heredoc autocorrection is not yet implemented.
+            return if heredoc?
+
+            corrector.replace(range, " { #{replacement} }")
+          end
+
+          private
+
+          attr_reader :node, :receiver, :args
+
+          def heredoc?
+            args.loc.is_a?(Parser::Source::Map::Heredoc)
+          end
+
+          def range
+            Parser::Source::Range.new(
+              node.source_range.source_buffer,
+              receiver.source_range.end_pos,
+              node.source_range.end_pos
+            )
+          end
+
+          def replacement
+            if hash_without_braces?
+              "{ #{args.source} }"
+            else
+              args.source
+            end
+          end
+
+          def hash_without_braces?
+            args.hash_type? && !args.braces?
+          end
+        end
+
+        # :nodoc:
+        class BlockBodyCorrector
+          def initialize(node)
+            @block = node.each_ancestor(:block).first
+            @node = node
+            @body = block.body || NULL_BLOCK_BODY
+          end
+
+          def call(corrector)
+            # Heredoc autocorrection is not yet implemented.
+            return if heredoc?
+
+            corrector.replace(range, ".and_return(#{body.source})")
+          end
+
+          private
+
+          attr_reader :node, :block, :body
+
+          def range
+            Parser::Source::Range.new(
+              block.source_range.source_buffer,
+              node.source_range.end_pos,
+              block.source_range.end_pos
+            )
+          end
+
+          def heredoc?
+            body.loc.is_a?(Parser::Source::Map::Heredoc)
+          end
+
+          NULL_BLOCK_BODY = Struct.new(:loc, :source).new(nil, 'nil')
+        end
       end
     end
   end

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

@@ -34,22 +34,18 @@ module RuboCop
         def on_block(node)
           return unless example_group_with_body?(node)
 
-          _describe, _args, body = *node
-
-          check_let_declarations(body)
+          check_let_declarations(node.body)
         end
 
-        def check_let_declarations(node)
-          let_found = false
-          mix_found = false
+        private
+
+        def check_let_declarations(body)
+          lets = body.each_child_node.select { |node| let?(node) }
 
-          node.each_child_node do |child|
-            if let?(child)
-              add_offense(child, location: :expression) if mix_found
-              let_found = true
-            elsif let_found
-              mix_found = true
-            end
+          first_let = lets.first
+          lets.each_with_index do |node, idx|
+            next if node.sibling_index == first_let.sibling_index + idx
+            add_offense(node, location: :expression)
           end
         end
       end

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

@@ -14,7 +14,7 @@ module RuboCop
       #     it 'does x' do
       #     end
       #
-      #     it 'does 'y' do
+      #     it 'does y' do
       #     end
       #   end
       #
@@ -23,7 +23,7 @@ module RuboCop
       #     it 'does x' do
       #     end
       #
-      #     it 'does 'y' do
+      #     it 'does y' do
       #     end
       #   end
       #

data/lib/rubocop/cop/rspec_cops.rb

@@ -0,0 +1,59 @@
+require_relative 'rspec/capybara/current_path_expectation'
+require_relative 'rspec/capybara/feature_methods'
+
+require_relative 'rspec/factory_bot/dynamic_attribute_defined_statically'
+
+require_relative 'rspec/align_left_let_brace'
+require_relative 'rspec/align_right_let_brace'
+require_relative 'rspec/any_instance'
+require_relative 'rspec/around_block'
+require_relative 'rspec/be_eql'
+require_relative 'rspec/before_after_all'
+require_relative 'rspec/context_wording'
+require_relative 'rspec/describe_class'
+require_relative 'rspec/described_class'
+require_relative 'rspec/describe_method'
+require_relative 'rspec/describe_symbol'
+require_relative 'rspec/empty_example_group'
+require_relative 'rspec/empty_line_after_final_let'
+require_relative 'rspec/empty_line_after_subject'
+require_relative 'rspec/example_length'
+require_relative 'rspec/example_without_description'
+require_relative 'rspec/example_wording'
+require_relative 'rspec/expect_actual'
+require_relative 'rspec/expect_change'
+require_relative 'rspec/expect_in_hook'
+require_relative 'rspec/expect_output'
+require_relative 'rspec/file_path'
+require_relative 'rspec/focus'
+require_relative 'rspec/hook_argument'
+require_relative 'rspec/implicit_expect'
+require_relative 'rspec/instance_spy'
+require_relative 'rspec/instance_variable'
+require_relative 'rspec/invalid_predicate_matcher'
+require_relative 'rspec/it_behaves_like'
+require_relative 'rspec/iterated_expectation'
+require_relative 'rspec/leading_subject'
+require_relative 'rspec/let_before_examples'
+require_relative 'rspec/let_setup'
+require_relative 'rspec/message_chain'
+require_relative 'rspec/message_expectation'
+require_relative 'rspec/message_spies'
+require_relative 'rspec/multiple_describes'
+require_relative 'rspec/multiple_expectations'
+require_relative 'rspec/multiple_subjects'
+require_relative 'rspec/named_subject'
+require_relative 'rspec/nested_groups'
+require_relative 'rspec/not_to_not'
+require_relative 'rspec/overwriting_setup'
+require_relative 'rspec/predicate_matcher'
+require_relative 'rspec/repeated_description'
+require_relative 'rspec/repeated_example'
+require_relative 'rspec/return_from_stub'
+require_relative 'rspec/scattered_let'
+require_relative 'rspec/scattered_setup'
+require_relative 'rspec/shared_context'
+require_relative 'rspec/single_argument_message_chain'
+require_relative 'rspec/subject_stub'
+require_relative 'rspec/verified_doubles'
+require_relative 'rspec/void_expect'