Class: RuboCop::Cop::Style::SpaceAroundOperators

Inherits:
Cop
  • Object
show all
Includes:
HashNode, IfNode, PrecedingFollowingAlignment
Defined in:
lib/rubocop/cop/style/space_around_operators.rb

Overview

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

Constant Summary

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods included from HashNode

#any_pairs_on_the_same_line?

Methods included from PrecedingFollowingAlignment

#aligned_assignment?, #aligned_char?, #aligned_identical?, #aligned_operator?, #aligned_token?, #aligned_with_adjacent_line?, #aligned_with_any_line?, #aligned_with_any_line_range?, #aligned_with_line?, #aligned_with_operator?, #aligned_with_something?, #aligned_words?, #allow_for_alignment?, #comment_lines

Methods included from IfNode

#elsif?, #if_else?, #if_node_parts, #modifier_if?, #ternary?

Methods included from NodePattern::Macros

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

Methods inherited from Cop

#add_offense, all, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #correct, #debug?, #details, #display_cop_names?, #display_style_guide?, #duplicate_location?, #excluded_file?, #extra_details?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #reference_url, #relevant_file?, #style_guide_url, #target_ruby_version

Methods included from 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?, block_length, comment_line?, compatible_external_encoding_for?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, hard_to_type?, interpret_string_escapes, line_distance, line_range, move_pos, needs_escaping?, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, preceed?, range_between, range_with_surrounding_comma, range_with_surrounding_space, same_line?, source_range, strip_quotes, stripped_source_upto, to_string_literal, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, match_path?, relative_path

Constructor Details

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

Instance Method Details

#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 



52
53
54
55
56
 
# File 'lib/rubocop/cop/style/space_around_operators.rb', line 52

def on_binary(node)
  _, right, = *node
  return if right.nil?
  check_operator(node.loc.operator, right.source_range)
end

#on_if(node) ⇒ Object 



25
26
27
28
29
30
31
 
# File 'lib/rubocop/cop/style/space_around_operators.rb', line 25

def on_if(node)
  return unless ternary?(node)
  _, if_branch, else_branch = *node

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

#on_pair(node) ⇒ Object 



13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/rubocop/cop/style/space_around_operators.rb', line 13

def on_pair(node)
  return unless node.loc.operator.is?('=>')

  align_hash_config = config.for_cop('Style/AlignHash')
  return if align_hash_config['EnforcedHashRocketStyle'] == 'table' &&
            !any_pairs_on_the_same_line?(node.parent)

  _, right = *node

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

#on_resbody(node) ⇒ Object 



33
34
35
36
37
38
 
# File 'lib/rubocop/cop/style/space_around_operators.rb', line 33

def on_resbody(node)
  return unless node.loc.assoc
  _, variable, = *node

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

#on_send(node) ⇒ Object 



40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/rubocop/cop/style/space_around_operators.rb', line 40

def on_send(node)
  if node.loc.operator # aref assignment, attribute assignment
    on_special_asgn(node)
  elsif !node.unary_operation? && !called_with_dot?(node)
    op = node.method_name
    if operator_with_regular_syntax?(op)
      _, _, right, = *node
      check_operator(node.loc.selector, right.source_range)
    end
  end
end

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



58
59
60
61
62
 
# File 'lib/rubocop/cop/style/space_around_operators.rb', line 58

def on_special_asgn(node)
  return unless node.loc.operator
  _, _, right, = *node
  check_operator(node.loc.operator, right.source_range)
end