Class: RuboCop::Cop::Layout::SpaceBeforeFirstArg

Inherits:
Cop
  • Object
show all
Includes:
PrecedingFollowingAlignment
Defined in:
lib/rubocop/cop/layout/space_before_first_arg.rb

Overview

Checks that exactly one space is used between a method name and the first argument for method calls without parentheses.

Alternatively, extra spaces can be added to align the argument with something on a preceding or following line, if the AllowForAlignment config parameter is true.

Examples:

# bad
something  x
something   y, z
something'hello'

# good
something x
something y, z
something 'hello'

Constant Summary collapse

MSG = 
'Put one space between the method name and ' \
'the first argument.'.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(range) ⇒ Object 



43
44
45
 
# File 'lib/rubocop/cop/layout/space_before_first_arg.rb', line 43

def autocorrect(range)
  ->(corrector) { corrector.replace(range, ' ') }
end

#on_send(node) ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/rubocop/cop/layout/space_before_first_arg.rb', line 30

def on_send(node)
  return unless regular_method_call_with_arguments?(node)
  return unless expect_params_after_method_name?(node)

  first_arg = node.first_argument.source_range
  first_arg_with_space = range_with_surrounding_space(range: first_arg,
                                                      side: :left)
  space = range_between(first_arg_with_space.begin_pos,
                        first_arg.begin_pos)

  add_offense(space, location: space) if space.length != 1
end