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

Inherits:
Cop
  • Object
show all
Includes:
PrecedingFollowingAlignment, RangeHelp
Defined in:
lib/rubocop/cop/layout/space_around_operators.rb

Overview

Checks that operators have space around them, except for ** which should not have surrounding space.

Examples:

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

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

Constant Summary collapse

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

Constants included from Util

Util::ASGN_NODES, Util::CONDITIONAL_NODES, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::LOGICAL_OPERATOR_NODES, Util::MODIFIER_NODES, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, #correct, department, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_rails_version, #target_ruby_version

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

Methods included from AST::Sexp

#s

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, comment_line?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, operator?, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens

Methods included from PathUtil

absolute?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

This class inherits a constructor from RuboCop::Cop::Cop

Class Method Details

.autocorrect_incompatible_withObject



27
28
29
# File 'lib/rubocop/cop/layout/space_around_operators.rb', line 27

def self.autocorrect_incompatible_with
  [Style::SelfAssignment]
end

Instance Method Details

#autocorrect(range) ⇒ Object



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

def autocorrect(range)
  lambda do |corrector|
    if range.source =~ /\*\*/
      corrector.replace(range, '**')
    elsif range.source.end_with?("\n")
      corrector.replace(range, " #{range.source.strip}\n")
    else
      corrector.replace(range, " #{range.source.strip} ")
    end
  end
end

#on_binary(node) ⇒ Object Also known as: on_or, on_and, on_lvasgn, on_masgn, on_ivasgn, on_cvasgn, on_gvasgn, on_class, on_or_asgn, on_and_asgn



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

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

  return unless rhs

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

#on_if(node) ⇒ Object



39
40
41
42
43
44
# File 'lib/rubocop/cop/layout/space_around_operators.rb', line 39

def on_if(node)
  return unless node.ternary?

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

#on_pair(node) ⇒ Object



31
32
33
34
35
36
37
# File 'lib/rubocop/cop/layout/space_around_operators.rb', line 31

def on_pair(node)
  return unless node.hash_rocket?

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

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

#on_resbody(node) ⇒ Object



46
47
48
49
50
51
52
# File 'lib/rubocop/cop/layout/space_around_operators.rb', line 46

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

  _, variable, = *node

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

#on_send(node) ⇒ Object



54
55
56
57
58
59
60
# File 'lib/rubocop/cop/layout/space_around_operators.rb', line 54

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

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



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

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

  return unless right
  check_operator(node.loc.operator, right.source_range)
end