Sha256: db009ad5545a239bcd092596b12555eac6dd2dffc51d0561241d19c72f12df62

Contents?: true

Size: 2 KB

Versions: 10

Compression:

Stored size: 2 KB

Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    module RSpec
      # This cop checks for calling a block within a stub.
      #
      # @example
      #   # bad
      #   allow(foo).to receive(:bar) { |&block| block.call(1) }
      #
      #   # good
      #   expect(foo).to be(:bar).and_yield(1)
      class Yield < Base
        extend AutoCorrector
        include RangeHelp

        MSG = 'Use `.and_yield`.'

        def_node_search :method_on_stub?, '(send nil? :receive ...)'

        def_node_matcher :block_arg, '(args (blockarg $_))'

        def_node_matcher :block_call?, '(send (lvar %) :call ...)'

        def on_block(node)
          return unless method_on_stub?(node.send_node)

          block_arg(node.arguments) do |block|
            if calling_block?(node.body, block)
              range = block_range(node)

              add_offense(range) do |corrector|
                autocorrect(corrector, node, range)
              end
            end
          end
        end

        private

        def autocorrect(corrector, node, range)
          corrector.replace(
            range_with_surrounding_space(range: range, side: :left),
            generate_replacement(node.body)
          )
        end

        def calling_block?(node, block)
          if node.begin_type?
            node.each_child_node.all? { |child| block_call?(child, block) }
          else
            block_call?(node, block)
          end
        end

        def block_range(node)
          node.loc.begin.with(end_pos: node.loc.end.end_pos)
        end

        def generate_replacement(node)
          if node.begin_type?
            node.children.map { |child| convert_block_to_yield(child) }.join
          else
            convert_block_to_yield(node)
          end
        end

        def convert_block_to_yield(node)
          args = node.arguments
          replacement = '.and_yield'
          replacement += "(#{args.map(&:source).join(', ')})" if args.any?
          replacement
        end
      end
    end
  end
end

Version data entries

10 entries across 10 versions & 1 rubygems

Version Path
rubocop-rspec-2.2.0 lib/rubocop/cop/rspec/yield.rb
rubocop-rspec-2.1.0 lib/rubocop/cop/rspec/yield.rb
rubocop-rspec-2.0.1 lib/rubocop/cop/rspec/yield.rb
rubocop-rspec-2.0.0 lib/rubocop/cop/rspec/yield.rb
rubocop-rspec-2.0.0.pre lib/rubocop/cop/rspec/yield.rb
rubocop-rspec-1.44.1 lib/rubocop/cop/rspec/yield.rb
rubocop-rspec-1.44.0 lib/rubocop/cop/rspec/yield.rb
rubocop-rspec-1.43.2 lib/rubocop/cop/rspec/yield.rb
rubocop-rspec-1.43.1 lib/rubocop/cop/rspec/yield.rb
rubocop-rspec-1.43.0 lib/rubocop/cop/rspec/yield.rb