Class: RuboCop::Cop::Layout::SpaceAroundOperators

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Includes:
PrecedingFollowingAlignment, RangeHelp, RationalLiteral
Defined in:
lib/rubocop/cop/layout/space_around_operators.rb

Overview

Checks that operators have space around them, except for ** which should or shouldn't have surrounding space depending on configuration. It allows vertical alignment consisting of one or more whitespace around operators.

This cop has `AllowForAlignment` option. When `true`, allows most uses of extra spacing if the intent is to align with an operator on the previous or next line, not counting empty lines or comment lines.

Examples:

# bad
total = 3*4
"apple"+"juice"
my_number = 38/4

# good
total = 3 * 4
"apple" + "juice"
my_number = 38 / 4

AllowForAlignment: true (default)

# good
{
  1 =>  2,
  11 => 3
}

AllowForAlignment: false

# bad
{
  1 =>  2,
  11 => 3
}

EnforcedStyleForExponentOperator: no_space (default)

# bad
a ** b

# good
a**b

EnforcedStyleForExponentOperator: space

# bad
a**b

# good
a ** b

Constant Summary collapse

IRREGULAR_METHODS =
%i[[] ! []=].freeze
EXCESSIVE_SPACE =
'  '

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

#add_global_offense, #add_offense, badge, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #ready, #relevant_file?, 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?, #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_withObject


62
63
64
# File 'lib/rubocop/cop/layout/space_around_operators.rb', line 62

def self.autocorrect_incompatible_with
  [Style::SelfAssignment]
end

Instance Method Details

#on_assignment(node) ⇒ Object Also known as: on_lvasgn, on_masgn, on_ivasgn, on_cvasgn, on_gvasgn, on_or_asgn, on_and_asgn


103
104
105
106
107
108
109
# File 'lib/rubocop/cop/layout/space_around_operators.rb', line 103

def on_assignment(node)
  _, rhs, = *node

  return unless rhs

  check_operator(:assignment, node.loc.operator, rhs.source_range)
end

#on_binary(node) ⇒ Object Also known as: on_or, on_and, on_class


119
120
121
122
123
124
125
# File 'lib/rubocop/cop/layout/space_around_operators.rb', line 119

def on_binary(node)
  _, rhs, = *node

  return unless rhs

  check_operator(:binary, node.loc.operator, rhs.source_range)
end

#on_casgn(node) ⇒ Object


111
112
113
114
115
116
117
# File 'lib/rubocop/cop/layout/space_around_operators.rb', line 111

def on_casgn(node)
  _, _, right, = *node

  return unless right

  check_operator(:assignment, node.loc.operator, right.source_range)
end

#on_if(node) ⇒ Object


78
79
80
81
82
83
# File 'lib/rubocop/cop/layout/space_around_operators.rb', line 78

def on_if(node)
  return unless node.ternary?

  check_operator(:if, node.loc.question, node.if_branch.source_range)
  check_operator(:if, node.loc.colon, node.else_branch.source_range)
end

#on_match_pattern(node) ⇒ Object


135
136
137
138
139
# File 'lib/rubocop/cop/layout/space_around_operators.rb', line 135

def on_match_pattern(node)
  return if target_ruby_version < 3.0

  check_operator(:match_pattern, node.loc.operator, node.source_range)
end

#on_pair(node) ⇒ Object


70
71
72
73
74
75
76
# File 'lib/rubocop/cop/layout/space_around_operators.rb', line 70

def on_pair(node)
  return unless node.hash_rocket?

  return if hash_table_style? && !node.parent.pairs_on_same_line?

  check_operator(:pair, node.loc.operator, node.source_range)
end

#on_resbody(node) ⇒ Object


85
86
87
88
89
90
91
# File 'lib/rubocop/cop/layout/space_around_operators.rb', line 85

def on_resbody(node)
  return unless node.loc.assoc

  _, variable, = *node

  check_operator(:resbody, node.loc.assoc, variable.source_range)
end

#on_sclass(node) ⇒ Object


66
67
68
# File 'lib/rubocop/cop/layout/space_around_operators.rb', line 66

def on_sclass(node)
  check_operator(:sclass, node.loc.operator, node.source_range)
end

#on_send(node) ⇒ Object


93
94
95
96
97
98
99
100
101
# File 'lib/rubocop/cop/layout/space_around_operators.rb', line 93

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

  if node.setter_method?
    on_special_asgn(node)
  elsif regular_operator?(node)
    check_operator(:send, node.loc.selector, node.first_argument.source_range)
  end
end

#on_special_asgn(node) ⇒ Object Also known as: on_op_asgn


127
128
129
130
131
132
133
# File 'lib/rubocop/cop/layout/space_around_operators.rb', line 127

def on_special_asgn(node)
  _, _, right, = *node

  return unless right

  check_operator(:special_asgn, node.loc.operator, right.source_range)
end