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

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Includes:
PrecedingFollowingAlignment, RangeHelp
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.'

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Class Method Summary collapse

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods inherited from Base

#active_support_extensions_enabled?, #add_global_offense, #add_offense, #always_autocorrect?, badge, #begin_investigation, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #cop_config, cop_name, #cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, #inspect, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #parser_engine, #ready, #relevant_file?, requires_gem, #string_literals_frozen_by_default?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

#exclude_limit

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #autocorrect_with_disable_uncorrectable?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

silence_warnings

Constructor Details

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

Class Method Details

.autocorrect_incompatible_with ⇒ Object 



31
32
33
 
# File 'lib/rubocop/cop/layout/space_before_first_arg.rb', line 31

def self.autocorrect_incompatible_with
  [Style::MethodCallWithArgsParentheses]
end

Instance Method Details

#on_send(node) ⇒ Object Also known as: on_csend 



35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/rubocop/cop/layout/space_before_first_arg.rb', line 35

def on_send(node)
  return unless regular_method_call_with_arguments?(node)
  return if node.parenthesized?

  first_arg = node.first_argument.source_range
  first_arg_with_space = range_with_surrounding_space(first_arg, side: :left)
  space = range_between(first_arg_with_space.begin_pos, first_arg.begin_pos)
  return if space.length == 1
  return unless expect_params_after_method_name?(node)

  add_offense(space) { |corrector| corrector.replace(space, ' ') }
end