class RuboCop::Cop::Layout::SpaceAroundOperators
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.
@example
# bad total = 3*4 "apple"+"juice" my_number = 38/4 # good total = 3 * 4 "apple" + "juice" my_number = 38 / 4
@example AllowForAlignment: true (default)
# good { 1 => 2, 11 => 3 }
@example AllowForAlignment: false
# bad { 1 => 2, 11 => 3 }
@example EnforcedStyleForExponentOperator: no_space (default)
# bad a ** b # good a**b
@example EnforcedStyleForExponentOperator: space
# bad a**b # good a ** b
Constants
- EXCESSIVE_SPACE
- IRREGULAR_METHODS
Public Class Methods
autocorrect_incompatible_with()
click to toggle source
# File lib/rubocop/cop/layout/space_around_operators.rb, line 62 def self.autocorrect_incompatible_with [Style::SelfAssignment] end
Public Instance Methods
on_assignment(node)
click to toggle source
# 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)
click to toggle source
# 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)
click to toggle source
# 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)
click to toggle source
# 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)
click to toggle source
# 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)
click to toggle source
# 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)
click to toggle source
# 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)
click to toggle source
# 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)
click to toggle source
# 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)
click to toggle source
# 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
Also aliased as: on_op_asgn
Private Instance Methods
align_hash_cop_config()
click to toggle source
# File lib/rubocop/cop/layout/space_around_operators.rb, line 236 def align_hash_cop_config config.for_cop('Layout/HashAlignment') end
autocorrect(corrector, range)
click to toggle source
# File lib/rubocop/cop/layout/space_around_operators.rb, line 179 def autocorrect(corrector, range) if /\*\*/.match?(range.source) && !space_around_exponent_operator? corrector.replace(range, '**') elsif range.source.end_with?("\n") corrector.replace(range, " #{range.source.strip}\n") else enclose_operator_with_space(corrector, range) end end
check_operator(type, operator, right_operand)
click to toggle source
# File lib/rubocop/cop/layout/space_around_operators.rb, line 163 def check_operator(type, operator, right_operand) with_space = range_with_surrounding_space(operator) return if with_space.source.start_with?("\n") offense(type, operator, with_space, right_operand) do |msg| add_offense(operator, message: msg) do |corrector| autocorrect(corrector, with_space) end end end
enclose_operator_with_space(corrector, range)
click to toggle source
# File lib/rubocop/cop/layout/space_around_operators.rb, line 189 def enclose_operator_with_space(corrector, range) operator = range.source # If `ForceEqualSignAlignment` is true, `Layout/ExtraSpacing` cop # inserts spaces before operator. If `Layout/SpaceAroundOperators` cop # inserts a space, it collides and raises the infinite loop error. if force_equal_sign_alignment? && !operator.end_with?(' ') corrector.insert_after(range, ' ') else corrector.replace(range, " #{operator.strip} ") end end
excess_leading_space?(type, operator, with_space)
click to toggle source
# File lib/rubocop/cop/layout/space_around_operators.rb, line 216 def excess_leading_space?(type, operator, with_space) return false unless allow_for_alignment? return false unless with_space.source.start_with?(EXCESSIVE_SPACE) return !aligned_with_operator?(operator) unless type == :assignment token = Token.new(operator, nil, operator.source) align_preceding = aligned_with_preceding_assignment(token) return false if align_preceding == :yes || aligned_with_subsequent_assignment(token) == :none aligned_with_subsequent_assignment(token) != :yes end
excess_trailing_space?(right_operand, with_space)
click to toggle source
# File lib/rubocop/cop/layout/space_around_operators.rb, line 231 def excess_trailing_space?(right_operand, with_space) with_space.source.end_with?(EXCESSIVE_SPACE) && (!allow_for_alignment? || !aligned_with_something?(right_operand)) end
force_equal_sign_alignment?()
click to toggle source
# File lib/rubocop/cop/layout/space_around_operators.rb, line 248 def force_equal_sign_alignment? config.for_cop('Layout/ExtraSpacing')['ForceEqualSignAlignment'] end
hash_table_style?()
click to toggle source
# File lib/rubocop/cop/layout/space_around_operators.rb, line 240 def hash_table_style? align_hash_cop_config && align_hash_cop_config['EnforcedHashRocketStyle'] == 'table' end
offense(type, operator, with_space, right_operand) { |msg| ... }
click to toggle source
# File lib/rubocop/cop/layout/space_around_operators.rb, line 174 def offense(type, operator, with_space, right_operand) msg = offense_message(type, operator, with_space, right_operand) yield msg if msg end
offense_message(type, operator, with_space, right_operand)
click to toggle source
# File lib/rubocop/cop/layout/space_around_operators.rb, line 202 def offense_message(type, operator, with_space, right_operand) if should_not_have_surrounding_space?(operator) return if with_space.is?(operator.source) "Space around operator `#{operator.source}` detected." elsif !/^\s.*\s$/.match?(with_space.source) "Surrounding space missing for operator `#{operator.source}`." elsif excess_leading_space?(type, operator, with_space) || excess_trailing_space?(right_operand, with_space) "Operator `#{operator.source}` should be surrounded " \ 'by a single space.' end end
operator_with_regular_syntax?(send_node)
click to toggle source
# File lib/rubocop/cop/layout/space_around_operators.rb, line 159 def operator_with_regular_syntax?(send_node) send_node.operator_method? && !IRREGULAR_METHODS.include?(send_node.method_name) end
regular_operator?(send_node)
click to toggle source
# File lib/rubocop/cop/layout/space_around_operators.rb, line 155 def regular_operator?(send_node) !send_node.unary_operation? && !send_node.dot? && operator_with_regular_syntax?(send_node) end
should_not_have_surrounding_space?(operator)
click to toggle source
# File lib/rubocop/cop/layout/space_around_operators.rb, line 252 def should_not_have_surrounding_space?(operator) operator.is?('**') ? !space_around_exponent_operator? : false end
space_around_exponent_operator?()
click to toggle source
# File lib/rubocop/cop/layout/space_around_operators.rb, line 244 def space_around_exponent_operator? cop_config['EnforcedStyleForExponentOperator'] == 'space' end