123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Layout::DotPosition

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

Overview

Checks the . position in multi-line method calls.

Examples:

EnforcedStyle: leading (default)

# bad
something.
  method

# good
something
  .method

EnforcedStyle: trailing

# bad
something
  .method

# good
something.
  method

Constant Summary

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

::RuboCop::Cop::ConfigurableEnforcedStyle - Included

SYMBOL_TO_STRING_CACHE

::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::ConfigurableEnforcedStyle - 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

Class Method Details

.autocorrect_incompatible_with

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/dot_position.rb', line 30

def self.autocorrect_incompatible_with
  [Style::RedundantSelf]
end

Instance Method Details

#autocorrect(corrector, dot, node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/dot_position.rb', line 49

def autocorrect(corrector, dot, node)
  dot_range = if processed_source[dot.line - 1].strip == '.'
                range_by_whole_lines(dot, include_final_newline: true)
              else
                dot
              end
  corrector.remove(dot_range)
  case style
  when :leading
    corrector.insert_before(selector_range(node), dot.source)
  when :trailing
    corrector.insert_after(node.receiver, dot.source)
  end
end

#correct_dot_position_style?(dot_line, selector_line) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/dot_position.rb', line 99

def correct_dot_position_style?(dot_line, selector_line)
  case style
  when :leading then dot_line == selector_line
  when :trailing then dot_line != selector_line
  end
end

#end_range(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/dot_position.rb', line 126

def end_range(node)
  node.source_range.end
end

#heredoc?(node) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/dot_position.rb', line 122

def heredoc?(node)
  (node.str_type? || node.dstr_type?) && node.heredoc?
end

#last_heredoc_line(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/dot_position.rb', line 114

def last_heredoc_line(node)
  if node.send_type?
    node.arguments.select { |arg| heredoc?(arg) }.map { |arg| arg.loc.heredoc_end.line }.max
  elsif heredoc?(node)
    node.loc.heredoc_end.line
  end
end

#line_between?(first_line, second_line) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/dot_position.rb', line 95

def line_between?(first_line, second_line)
  (first_line - second_line) > 1
end

#message(dot) (private)

[ GitHub ]

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

def message(dot)
  "Place the #{dot.source} on the " +
    case style
    when :leading
      'next line, together with the method name.'
    when :trailing
      'previous line, together with the method call receiver.'
    end
end

#on_csend(node)

Alias for #on_send.

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/dot_position.rb', line 45

alias on_csend on_send

#on_send(node) Also known as: #on_csend

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/dot_position.rb', line 34

def on_send(node)
  return unless node.dot? || node.safe_navigation?

  return correct_style_detected if proper_dot_position?(node)

  opposite_style_detected
  dot = node.loc.dot
  message = message(dot)

  add_offense(dot, message: message) { |corrector| autocorrect(corrector, dot, node) }
end

#proper_dot_position?(node) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/dot_position.rb', line 74

def proper_dot_position?(node)
  selector_range = selector_range(node)

  return true if same_line?(selector_range, end_range(node.receiver))

  selector_line = selector_range.line
  receiver_line = receiver_end_line(node.receiver)
  dot_line = node.loc.dot.line

  # don't register an offense if there is a line comment between the
  # dot and the selector otherwise, we might break the code while
  # "correcting" it (even if there is just an extra blank line, treat
  # it the same)
  # Also, in the case of a heredoc, the receiver will end after the dot,
  # because the heredoc body is on subsequent lines, so use the highest
  # line to compare to.
  return true if line_between?(selector_line, [receiver_line, dot_line].max)

  correct_dot_position_style?(dot_line, selector_line)
end

#receiver_end_line(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/dot_position.rb', line 106

def receiver_end_line(node)
  if (line = last_heredoc_line(node))
    line
  else
    node.source_range.end.line
  end
end

#selector_range(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/dot_position.rb', line 130

def selector_range(node)
  return node unless node.call_type?

  # l.(1) has no selector, so we use the opening parenthesis instead
  node.loc.selector || node.loc.begin
end