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

EnforcedStyleForRationalLiterals: no_space (default)

# bad
1 / 48r

# good
1/48r

EnforcedStyleForRationalLiterals: space

# bad
1/48r

# good
1 / 48r

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

#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 



76
77
78
 
# File 'lib/rubocop/cop/layout/space_around_operators.rb', line 76

def self.autocorrect_incompatible_with
  [Style::SelfAssignment]
end

Instance Method Details

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



115
116
117
118
119
120
121
122
 
# File 'lib/rubocop/cop/layout/space_around_operators.rb', line 115

def on_assignment(node)
  rhs = node.rhs

  return unless rhs

  type = node.op_asgn_type? ? :special_asgn : :assignment
  check_operator(type, node.loc.operator, rhs)
end

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



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

def on_binary(node)
  rhs = node.rhs

  return unless rhs

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

#on_class(node) ⇒ Object 



124
125
126
127
128
129
130
 
# File 'lib/rubocop/cop/layout/space_around_operators.rb', line 124

def on_class(node)
  rhs = node.parent_class

  return unless rhs

  check_operator(:class, node.loc.operator, rhs)
end

#on_if(node) ⇒ Object 



92
93
94
95
96
97
 
# File 'lib/rubocop/cop/layout/space_around_operators.rb', line 92

def on_if(node)
  return unless node.ternary?

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

#on_match_pattern(node) ⇒ Object 



148
149
150
151
152
 
# File 'lib/rubocop/cop/layout/space_around_operators.rb', line 148

def on_match_pattern(node)
  return if target_ruby_version < 3.0

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

#on_pair(node) ⇒ Object 



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

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)
end

#on_resbody(node) ⇒ Object 



99
100
101
102
103
 
# File 'lib/rubocop/cop/layout/space_around_operators.rb', line 99

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

  check_operator(:resbody, node.loc.assoc, node.exception_variable)
end

#on_sclass(node) ⇒ Object 



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

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

#on_send(node) ⇒ Object 



105
106
107
108
109
110
111
112
113
 
# File 'lib/rubocop/cop/layout/space_around_operators.rb', line 105

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

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

#on_setter_method(node) ⇒ Object 



140
141
142
143
144
145
146
 
# File 'lib/rubocop/cop/layout/space_around_operators.rb', line 140

def on_setter_method(node)
  rhs = node.first_argument

  return unless rhs

  check_operator(:special_asgn, node.loc.operator, node.first_argument)
end