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 `%<argname>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::CONDITIONAL_NODES, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::LOGICAL_OPERATOR_NODES, Util::MODIFIER_NODES, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, autocorrect_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, #correct, department, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_rails_version, #target_ruby_version

Methods included from AST::Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

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?, comment_line?, double_quotes_required?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, operator?, parentheses?, parenthesized_call?, precede?, range_between, range_by_whole_lines, range_with_surrounding_comma, range_with_surrounding_space, same_line?, source_range, strip_quotes, stripped_source_upto, symbol_without_quote?, to_string_literal, to_supported_styles, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, find_file_upwards, match_path?, pwd, relative_path, reset_pwd, smart_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



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/rubocop/cop/performance/redundant_block_call.rb', line 56

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) && !args.empty?
  ->(corrector) { corrector.replace(node.source_range, new_source) }
end

#on_def(node) ⇒ Object 



45
46
47
48
49
50
51
52
53
 
# File 'lib/rubocop/cop/performance/redundant_block_call.rb', line 45

def on_def(node)
  blockarg_def(node) do |argname, body|
    next unless body

    calls_to_report(argname, body).each do |blockcall|
      add_offense(blockcall, message: format(MSG, argname: argname))
    end
  end
end