Class: RuboCop::Cop::Style::MethodCallWithArgsParentheses

Inherits:
Cop
  • Object
show all
Defined in:
lib/rubocop/cop/style/method_call_with_args_parentheses.rb

Overview

This cop checks presence of parentheses in method calls containing parameters. As in popular Ruby’s frameworks a lot of methods should always be called without parentheses, users can ignore them by passing their names to IgnoredMethods option.

Examples:

# bad
array.delete e

# good
array.delete(e)

# good if `puts` is listed in IgnoredMethods
puts 'test'

Constant Summary collapse

MSG = 
'Use parentheses for method calls with arguments.'.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, 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_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?, block_length, comment_line?, compatible_external_encoding_for?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, hard_to_type?, interpret_string_escapes, line_distance, line_range, move_pos, needs_escaping?, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, preceed?, range_between, range_with_surrounding_comma, range_with_surrounding_space, same_line?, source_range, strip_quotes, stripped_source_upto, to_string_literal, to_supported_styles, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, match_path?, relative_path

Constructor Details

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

Instance Method Details

#autocorrect(node) ⇒ Object 



49
50
51
52
53
54
 
# File 'lib/rubocop/cop/style/method_call_with_args_parentheses.rb', line 49

def autocorrect(node)
  lambda do |corrector|
    corrector.replace(args_begin(node), '(')
    corrector.insert_after(args_end(node), ')')
  end
end

#on_send(node) ⇒ Object 



24
25
26
27
28
29
30
31
32
 
# File 'lib/rubocop/cop/style/method_call_with_args_parentheses.rb', line 24

def on_send(node)
  _receiver, method_name, *args = *node
  return if ignored_list.include?(method_name)
  return if args.empty?
  return if operator_call?(node)
  return if parentheses?(node)

  add_offense(node, :selector)
end

#on_super(node) ⇒ Object 



34
35
36
37
38
39
 
# File 'lib/rubocop/cop/style/method_call_with_args_parentheses.rb', line 34

def on_super(node)
  # super nodetype implies call with arguments.
  return if parentheses?(node)

  add_offense(node, :keyword)
end

#on_yield(node) ⇒ Object 



41
42
43
44
45
46
47
 
# File 'lib/rubocop/cop/style/method_call_with_args_parentheses.rb', line 41

def on_yield(node)
  args = node.children
  return if args.empty?
  return if parentheses?(node)

  add_offense(node, :keyword)
end