Class: RuboCop::Cop::Performance::RedundantBlockCall

Inherits:
Cop
  • Object
show all
Defined in:
lib/rubocop/cop/performance/redundant_block_call.rb

Overview

This cop identifies the use of a ‘&block` parameter and `block.call` where `yield` would do just as well.

Examples:

@bad
def method(&block)
  block.call
end
def another(&func)
  func.call 1, 2, 3
end

@good
def method
  yield
end
def another
  yield 1, 2, 3
end

Constant Summary collapse

MSG =
'Use `yield` instead of `%s.call`.'.freeze
YIELD =
'yield'.freeze
OPEN_PAREN =
'('.freeze
CLOSE_PAREN =
')'.freeze
SPACE =
' '.freeze

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES, Util::STRING_ESCAPES, Util::STRING_ESCAPE_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #correct, #debug?, #details, #display_cop_names?, #display_style_guide?, #excluded_file?, #extra_details?, inherited, #initialize, #join_force?, lint?, match?, #message, non_rails, #parse, qualified_cop_name, #reference_url, #relevant_file?, #style_guide_url, #target_ruby_version

Methods included from Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search_body

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, block_length, comment_line?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, first_part_of_call_chain, interpret_string_escapes, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, ternary_op?, to_string_literal, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, hidden?, issue_deprecation_warning, match_path?, relative_path

Constructor Details

This class inherits a constructor from RuboCop::Cop::Cop

Instance Method Details

#autocorrect(node) ⇒ Object

offenses are registered on the ‘block.call` nodes



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
# File 'lib/rubocop/cop/performance/redundant_block_call.rb', line 52

def autocorrect(node)
  _receiver, _method, *args = *node
  new_source = String.new(YIELD)
  unless args.empty?
    new_source += if parentheses?(node)
                    OPEN_PAREN
                  else
                    SPACE
                  end

    new_source << args.map(&:source).join(', ')
  end

  new_source << CLOSE_PAREN if parentheses?(node)
  ->(corrector) { corrector.replace(node.source_range, new_source) }
end

#on_def(node) ⇒ Object



42
43
44
45
46
47
48
49
# File 'lib/rubocop/cop/performance/redundant_block_call.rb', line 42

def on_def(node)
  blockarg_def(node) do |argname, body|
    next unless body
    blockarg_calls(body, argname) do |blockcall|
      add_offense(blockcall, :expression, format(MSG, argname))
    end
  end
end