Class: RuboCop::Cop::Layout::SpaceAfterColon

Inherits:
Cop
  • Object
show all
Defined in:
lib/rubocop/cop/layout/space_after_colon.rb

Overview

Checks for colon (:) not followed by some kind of space. N.B. this cop does not handle spaces after a ternary operator, which are instead handled by Layout/SpaceAroundOperators.

Examples:

# bad
def f(a:, b:2); {a:3}; end

# good
def f(a:, b: 2); {a: 3}; end

Constant Summary collapse

MSG = 
'Space missing after colon.'.freeze

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, 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

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, autocorrect_incompatible_with, 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 AST::Sexp

#s

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 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?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, operator?, parentheses?, parenthesized_call?, precede?, range_between, range_by_whole_lines, range_with_surrounding_comma, range_with_surrounding_space, same_line?, source_range, strip_quotes, stripped_source_upto, symbol_without_quote?, to_string_literal, to_supported_styles, to_symbol_literal, within_node?

Methods included from PathUtil

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

Constructor Details

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

Instance Method Details

#autocorrect(range) ⇒ Object 



35
36
37
 
# File 'lib/rubocop/cop/layout/space_after_colon.rb', line 35

def autocorrect(range)
  ->(corrector) { corrector.insert_after(range, ' ') }
end

#on_kwoptarg(node) ⇒ Object 



27
28
29
30
31
32
33
 
# File 'lib/rubocop/cop/layout/space_after_colon.rb', line 27

def on_kwoptarg(node)
  # We have no direct reference to the colon source range following an
  # optional keyword argument's name, so must construct one.
  colon = node.loc.name.end.resize(1)

  add_offense(colon, location: colon) unless followed_by_space?(colon)
end

#on_pair(node) ⇒ Object 



19
20
21
22
23
24
25
 
# File 'lib/rubocop/cop/layout/space_after_colon.rb', line 19

def on_pair(node)
  return unless node.colon?

  colon = node.loc.operator

  add_offense(colon, location: colon) unless followed_by_space?(colon)
end