Sha256: ee27b2e452a91fa4166ecc57fa70fa4cb512177863554df8777125b9a18ec8b5
Contents?: true
Size: 1.64 KB
Versions: 4
Compression:
Stored size: 1.64 KB
Contents
# frozen_string_literal: true
module RuboCop
module Cop
module RSpec
# Checks if an example contains any expectation.
#
# All RSpec's example and expectation methods are covered by default.
# If you are using your own custom methods,
# add the following configuration:
#
# RSpec:
# Language:
# Examples:
# Regular:
# - custom_it
# Expectations:
# - custom_expect
#
# @example
# # bad
# it do
# a?
# end
#
# # good
# it do
# expect(a?).to be(true)
# end
#
class NoExpectationExample < Base
MSG = 'No expectation found in this example.'
# @!method regular_or_focused_example?(node)
# @param [RuboCop::AST::Node] node
# @return [Boolean]
def_node_matcher :regular_or_focused_example?, <<~PATTERN
{
#{block_pattern('{#Examples.regular | #Examples.focused}')}
#{numblock_pattern('{#Examples.regular | #Examples.focused}')}
}
PATTERN
# @!method including_any_expectation?(node)
# @param [RuboCop::AST::Node] node
# @return [Boolean]
def_node_search(
:including_any_expectation?,
send_pattern('#Expectations.all')
)
# @param [RuboCop::AST::BlockNode] node
def on_block(node)
return unless regular_or_focused_example?(node)
return if including_any_expectation?(node)
add_offense(node)
end
alias on_numblock on_block
end
end
end
end
Version data entries
4 entries across 4 versions & 2 rubygems