123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Layout::ArgumentAlignment

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::RuboCop::Cop::AutoCorrector, ::RuboCop::Cop::Base, ::RuboCop::ExcludeLimit, NodePattern::Macros, RuboCop::AST::Sexp
Instance Chain:
Inherits: RuboCop::Cop::Base
Defined in: lib/rubocop/cop/layout/argument_alignment.rb

Overview

Here we check if the arguments on a multi-line method definition are aligned.

Examples:

EnforcedStyle: with_first_argument (default)

# good

foo :bar,
    :baz,
    key: value

foo(
  :bar,
  :baz,
  key: value
)

# bad

foo :bar,
  :baz,
  key: value

foo(
  :bar,
    :baz,
    key: value
)

EnforcedStyle: with_fixed_indentation

# good

foo :bar,
  :baz,
  key: value

# bad

foo :bar,
    :baz,
    key: value

Constant Summary

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

::RuboCop::Cop::Alignment - Included

SPACE

Class Attribute Summary

::RuboCop::Cop::AutoCorrector - Extended

::RuboCop::Cop::Base - Inherited

.gem_requirements, .lint?,
.support_autocorrect?

Returns if class supports autocorrect.

.support_multiple_source?

Override if your cop should be called repeatedly for multiple investigations Between calls to on_new_investigation and on_investigation_end, the result of processed_source will remain constant.

Class Method Summary

::RuboCop::Cop::Base - Inherited

.autocorrect_incompatible_with

List of cops that should not try to autocorrect at the same time as this cop.

.badge

Naming.

.callbacks_needed, .cop_name, .department,
.documentation_url

Returns an url to view this cops documentation online.

.exclude_from_registry

Call for abstract Cop classes.

.inherited,
.joining_forces

Override and return the Force class(es) you need to join.

.match?

Returns true if the cop name or the cop namespace matches any of the given names.

.new,
.requires_gem

Register a version requirement for the given gem name.

.restrict_on_send

::RuboCop::ExcludeLimit - Extended

exclude_limit

Sets up a configuration option to have an exclude limit tracked.

transform

Instance Attribute Summary

Instance Method Summary

::RuboCop::Cop::Alignment - Included

::RuboCop::Cop::Base - Inherited

#add_global_offense

Adds an offense that has no particular location.

#add_offense

Adds an offense on the specified range (or node with an expression) Unless that offense is disabled for this range, a corrector will be yielded to provide the cop the opportunity to autocorrect the offense.

#begin_investigation

Called before any investigation.

#callbacks_needed,
#cop_config

Configuration Helpers.

#cop_name, #excluded_file?,
#external_dependency_checksum

This method should be overridden when a cop’s behavior depends on state that lives outside of these locations:

#inspect
#message

Gets called if no message is specified when calling add_offense or add_global_offense Cops are discouraged to override this; instead pass your message directly.

#name

Alias for Base#cop_name.

#offenses,
#on_investigation_end

Called after all on_…​

#on_new_investigation

Called before all on_…​

#on_other_file

Called instead of all on_…​

#parse

There should be very limited reasons for a Cop to do it’s own parsing.

#parser_engine,
#ready

Called between investigations.

#relevant_file?, #target_rails_version, #target_ruby_version, #annotate, #apply_correction, #attempt_correction,
#callback_argument

Reserved for Cop::Cop.

#complete_investigation

Called to complete an investigation.

#correct, #current_corrector,
#current_offense_locations

Reserved for Commissioner:

#current_offenses, #currently_disabled_lines, #custom_severity, #default_severity, #disable_uncorrectable, #enabled_line?, #file_name_matches_any?, #find_message, #find_severity, #range_for_original, #range_from_node_or_range,
#reset_investigation

Actually private methods.

#use_corrector

::RuboCop::Cop::AutocorrectLogic - Included

::RuboCop::Cop::IgnoredNode - Included

Constructor Details

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

Instance Attribute Details

#autocorrect_incompatible_with_other_cops?Boolean (readonly, private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/argument_alignment.rb', line 68

def autocorrect_incompatible_with_other_cops?
  with_first_argument_style? && enforce_hash_argument_with_separator?
end

#enforce_hash_argument_with_separator?Boolean (readonly, private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/argument_alignment.rb', line 144

def enforce_hash_argument_with_separator?
  return false unless hash_argument_config['Enabled']

  RuboCop::Cop::Layout::HashAlignment::SEPARATOR_ALIGNMENT_STYLES.any? do |style|
    hash_argument_config[style]&.include?('separator')
  end
end

#fixed_indentation?Boolean (readonly, private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/argument_alignment.rb', line 116

def fixed_indentation?
  cop_config['EnforcedStyle'] == 'with_fixed_indentation'
end

#with_first_argument_style?Boolean (readonly, private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/argument_alignment.rb', line 120

def with_first_argument_style?
  cop_config['EnforcedStyle'] == 'with_first_argument'
end

Instance Method Details

#arguments_or_first_arg_pairs(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/argument_alignment.rb', line 92

def arguments_or_first_arg_pairs(node)
  first_arg = node.first_argument
  if first_arg.hash_type? && !first_arg.braces?
    first_arg.pairs
  else
    node.arguments
  end
end

#arguments_with_last_arg_pairs(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/argument_alignment.rb', line 80

def arguments_with_last_arg_pairs(node)
  items = node.arguments[0..-2]
  last_arg = node.last_argument

  if last_arg.hash_type? && !last_arg.braces?
    items += last_arg.pairs
  else
    items << last_arg
  end
  items
end

#autocorrect(corrector, node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/argument_alignment.rb', line 108

def autocorrect(corrector, node)
  AlignmentCorrector.correct(corrector, processed_source, node, column_delta)
end

#base_column(node, first_argument) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/argument_alignment.rb', line 124

def base_column(node, first_argument)
  if fixed_indentation? || first_argument.nil?
    lineno = target_method_lineno(node)
    line = node.source_range.source_buffer.source_line(lineno)
    indentation_of_line = /\S.*/.match(line).begin(0)
    indentation_of_line + configured_indentation_width
  else
    display_column(first_argument.source_range)
  end
end

#flattened_arguments(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/argument_alignment.rb', line 72

def flattened_arguments(node)
  if fixed_indentation?
    arguments_with_last_arg_pairs(node)
  else
    arguments_or_first_arg_pairs(node)
  end
end

#hash_argument_config (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/argument_alignment.rb', line 152

def hash_argument_config
  config.for_cop('Layout/HashAlignment')
end

#message(_node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/argument_alignment.rb', line 112

def message(_node)
  fixed_indentation? ? FIXED_INDENT_MSG : ALIGN_PARAMS_MSG
end

#multiple_arguments?(node) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/argument_alignment.rb', line 101

def multiple_arguments?(node)
  return true if node.arguments.size >= 2

  first_argument = node.first_argument
  first_argument&.hash_type? && first_argument.pairs.count >= 2
end

#on_csend(node)

Alias for #on_send.

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/argument_alignment.rb', line 64

alias on_csend on_send

#on_send(node) Also known as: #on_csend

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/argument_alignment.rb', line 55

def on_send(node)
  return if !multiple_arguments?(node) || (node.send_type? && node.method?(:[]=)) ||
            autocorrect_incompatible_with_other_cops?

  items = flattened_arguments(node)

  check_alignment(items, base_column(node, items.first))
end

#target_method_lineno(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/argument_alignment.rb', line 135

def target_method_lineno(node)
  if node.loc.selector
    node.loc.selector.line
  else
    # l.(1) has no selector, so we use the opening parenthesis instead
    node.loc.begin.line
  end
end