Class: RuboCop::Cop::Style::CharacterLiteral

Inherits:
Cop
  • Object
show all
Includes:
RuboCop::Cop::StringHelp
Defined in:
lib/rubocop/cop/style/character_literal.rb

Overview

Checks for uses of the character literal ?x.

Constant Summary collapse

MSG = 
'Do not use the character literal - use string literal instead.'

Constants included from RuboCop::Cop::StringHelp

RuboCop::Cop::StringHelp::ESCAPED_CHAR_REGEXP

Constants included from Util

Util::ASGN_NODES, Util::BASIC_LITERALS, Util::EQUALS_ASGN_NODES, Util::LITERALS, Util::OPERATOR_METHODS, Util::PROC_NEW_NODE, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods included from RuboCop::Cop::StringHelp

#inside_interpolation?, #on_regexp, #on_str

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?, #excluded_file?, #extra_details?, inherited, #initialize, #join_force?, lint?, match?, #message, non_rails, qualified_cop_name, rails?, #reference_url, #relevant_file?, #style_guide_url

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search

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, command?, comment_line?, const_name, directions, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, proc?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, within_node?

Methods included from PathUtil

hidden?, issue_deprecation_warning, match_path?, relative_path

Constructor Details

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

Instance Method Details

#autocorrect(node) ⇒ Object 



18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/rubocop/cop/style/character_literal.rb', line 18

def autocorrect(node)
  lambda do |corrector|
    string = node.loc.expression.source[1..-1]

    if string.length == 1 # normal character
      corrector.replace(node.loc.expression, "'#{string}'")
    elsif string.length == 2 # special character like \n
      corrector.replace(node.loc.expression, %("#{string}"))
    end
  end
end

#correct_style_detected ⇒ Object

Dummy implementation of method in ConfigurableEnforcedStyle that is called from StringHelp.



37
38
 
# File 'lib/rubocop/cop/style/character_literal.rb', line 37

def correct_style_detected
end

#offense?(node) ⇒ Boolean

Returns:

  • (Boolean) 


12
13
14
15
16
 
# File 'lib/rubocop/cop/style/character_literal.rb', line 12

def offense?(node)
  # we don't register an offense for things like ?\C-\M-d
  node.loc.begin.is?('?') &&
    node.loc.expression.source.size.between?(2, 3)
end

#opposite_style_detected ⇒ Object

Dummy implementation of method in ConfigurableEnforcedStyle that is called from StringHelp.



32
33
 
# File 'lib/rubocop/cop/style/character_literal.rb', line 32

def opposite_style_detected
end