Class: RuboCop::Cop::Style::SpaceBeforeFirstArg

Inherits:
Cop
  • Object
show all
Includes:
PrecedingFollowingAlignment
Defined in:
lib/rubocop/cop/style/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

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::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 included from PrecedingFollowingAlignment

#aligned_assignment?, #aligned_char?, #aligned_identical?, #aligned_operator?, #aligned_token?, #aligned_with_adjacent_line?, #aligned_with_line?, #aligned_with_operator?, #aligned_with_something?, #aligned_words?, #allow_for_alignment?, #comment_lines

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(range) ⇒ Object



44
45
46
# File 'lib/rubocop/cop/style/space_before_first_arg.rb', line 44

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

#on_send(node) ⇒ Object



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
# File 'lib/rubocop/cop/style/space_before_first_arg.rb', line 25

def on_send(node)
  return if parentheses?(node)

  _receiver, method_name, *args = *node
  return if args.empty?
  return if operator?(method_name)
  return if node.asgn_method_call?

  arg1 = args.first.source_range
  return if arg1.line > node.loc.line
  return if allow_for_alignment? && aligned_with_something?(arg1)

  arg1_with_space = range_with_surrounding_space(arg1, :left)
  space = Parser::Source::Range.new(arg1.source_buffer,
                                    arg1_with_space.begin_pos,
                                    arg1.begin_pos)
  add_offense(space, space) if space.length > 1
end