Sha256: 00efd2b7137c6acaeee30afb1358bdfe952682d0f80a8f9083f6d7ea374b7461

Contents?: true

Size: 1.94 KB

Versions: 24

Compression:

Stored size: 1.94 KB

Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    module RSpec
      # Check that implicit block expectation syntax is not used.
      #
      # Prefer using explicit block expectations.
      #
      # @example
      #   # bad
      #   subject { -> { do_something } }
      #   it { is_expected.to change(something).to(new_value) }
      #
      #   # good
      #   it 'changes something to a new value' do
      #     expect { do_something }.to change(something).to(new_value)
      #   end
      #
      class ImplicitBlockExpectation < Base
        MSG = 'Avoid implicit block expectations.'
        RESTRICT_ON_SEND = %i[is_expected should should_not].freeze

        # @!method lambda?(node)
        def_node_matcher :lambda?, <<~PATTERN
          {
            (send (const nil? :Proc) :new)
            (send nil? {:proc :lambda})
          }
        PATTERN

        # @!method lambda_subject?(node)
        def_node_matcher :lambda_subject?, '(block #lambda? ...)'

        # @!method implicit_expect(node)
        def_node_matcher :implicit_expect, <<~PATTERN
          $(send nil? {:is_expected :should :should_not} ...)
        PATTERN

        def on_send(node)
          implicit_expect(node) do |implicit_expect|
            subject = nearest_subject(implicit_expect)
            add_offense(implicit_expect) if lambda_subject?(subject&.body)
          end
        end

        private

        def nearest_subject(node)
          node
            .each_ancestor(:block)
            .lazy
            .select { |block_node| multi_statement_example_group?(block_node) }
            .map { |block_node| find_subject(block_node) }
            .find(&:itself)
        end

        def multi_statement_example_group?(node)
          example_group_with_body?(node) && node.body.begin_type?
        end

        def find_subject(block_node)
          block_node.body.child_nodes.find { |send_node| subject?(send_node) }
        end
      end
    end
  end
end

Version data entries

24 entries across 24 versions & 5 rubygems

Version Path
minato_ruby_api_client-0.2.2 vendor/bundle/ruby/3.2.0/gems/rubocop-rspec-3.0.3/lib/rubocop/cop/rspec/implicit_block_expectation.rb
rubocop-rspec-3.3.0 lib/rubocop/cop/rspec/implicit_block_expectation.rb
rubocop-rspec-3.2.0 lib/rubocop/cop/rspec/implicit_block_expectation.rb
rubocop-rspec-3.1.0 lib/rubocop/cop/rspec/implicit_block_expectation.rb
rubocop-rspec-3.0.5 lib/rubocop/cop/rspec/implicit_block_expectation.rb
rubocop-rspec-3.0.4 lib/rubocop/cop/rspec/implicit_block_expectation.rb
blacklight-spotlight-3.6.0.beta8 vendor/bundle/ruby/3.2.0/gems/rubocop-rspec-3.0.1/lib/rubocop/cop/rspec/implicit_block_expectation.rb
rubocop-rspec-3.0.3 lib/rubocop/cop/rspec/implicit_block_expectation.rb
rubocop-rspec-3.0.2 lib/rubocop/cop/rspec/implicit_block_expectation.rb
katalyst-govuk-formbuilder-1.9.2 vendor/bundle/ruby/3.3.0/gems/rubocop-rspec-3.0.1/lib/rubocop/cop/rspec/implicit_block_expectation.rb
rubocop-rspec-3.0.1 lib/rubocop/cop/rspec/implicit_block_expectation.rb
rubocop-rspec-3.0.0 lib/rubocop/cop/rspec/implicit_block_expectation.rb
rubocop-rspec-3.0.0.pre lib/rubocop/cop/rspec/implicit_block_expectation.rb
rubocop-rspec-2.31.0 lib/rubocop/cop/rspec/implicit_block_expectation.rb
rubocop-rspec-2.30.0 lib/rubocop/cop/rspec/implicit_block_expectation.rb
rubocop-rspec-2.29.2 lib/rubocop/cop/rspec/implicit_block_expectation.rb
rubocop-rspec-2.29.1 lib/rubocop/cop/rspec/implicit_block_expectation.rb
rubocop-rspec-2.29.0 lib/rubocop/cop/rspec/implicit_block_expectation.rb
rubocop-rspec-2.28.0 lib/rubocop/cop/rspec/implicit_block_expectation.rb
rubocop-rspec-2.27.1 lib/rubocop/cop/rspec/implicit_block_expectation.rb