123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Layout::EmptyLinesAroundArguments

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/empty_lines_around_arguments.rb

Overview

Checks if empty lines exist around the arguments of a method invocation.

Examples:

# bad
do_something(
  foo

)

process(bar,

        baz: qux,
        thud: fred)

some_method(

  [1,2,3],
  x: y
)

# good
do_something(
  foo
)

process(bar,
        baz: qux,
        thud: fred)

some_method(
  [1,2,3],
  x: y
)

Constant Summary

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

::RuboCop::Cop::RangeHelp - Included

BYTE_ORDER_MARK, NOT_GIVEN

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::RangeHelp - Included

#add_range, #column_offset_between,
#contents_range

A range containing only the contents of a literal with delimiters (e.g.

#directions,
#effective_column

Returns the column attribute of the range, except if the range is on the first line and there’s a byte order mark at the beginning of that line, in which case 1 is subtracted from the column value.

#final_pos, #move_pos, #move_pos_str, #range_between, #range_by_whole_lines, #range_with_comments, #range_with_comments_and_lines, #range_with_surrounding_comma, #range_with_surrounding_space, #source_range

::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 Method Details

#empty_lines(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/empty_lines_around_arguments.rb', line 65

def empty_lines(node)
  lines = processed_lines(node)
  lines.select! { |code, _| code.empty? }
  lines.map { |_, line| line }
end

#extra_lines(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/empty_lines_around_arguments.rb', line 71

def extra_lines(node)
  empty_lines(node).each do |line|
    range = source_range(processed_source.buffer, line, 0)
    yield(range)
  end
end

#inner_lines(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/empty_lines_around_arguments.rb', line 93

def inner_lines(node)
  [node.first_line + 1, node.last_line - 1]
end

#line_numbers(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/empty_lines_around_arguments.rb', line 84

def line_numbers(node)
  inner_lines = []
  line_nums = node.arguments.each_with_object([]) do |arg_node, lines|
    lines << outer_lines(arg_node)
    inner_lines << inner_lines(arg_node) if arg_node.multiline?
  end
  line_nums.flatten.uniq - inner_lines.flatten - outer_lines(node)
end

#on_csend(node)

Alias for #on_send.

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/empty_lines_around_arguments.rb', line 57

alias on_csend on_send

#on_send(node) Also known as: #on_csend

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/empty_lines_around_arguments.rb', line 47

def on_send(node)
  return if node.single_line? || node.arguments.empty? ||
            receiver_and_method_call_on_different_lines?(node)

  extra_lines(node) do |range|
    add_offense(range) do |corrector|
      corrector.remove(range)
    end
  end
end

#outer_lines(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/empty_lines_around_arguments.rb', line 97

def outer_lines(node)
  [node.first_line - 1, node.last_line + 1]
end

#processed_lines(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/empty_lines_around_arguments.rb', line 78

def processed_lines(node)
  line_numbers(node).each_with_object([]) do |num, array|
    array << [processed_source.lines[num - 1], num]
  end
end

#receiver_and_method_call_on_different_lines?(node) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/empty_lines_around_arguments.rb', line 61

def receiver_and_method_call_on_different_lines?(node)
  node.receiver && node.receiver.loc.last_line != node.loc.selector&.line
end