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.'.freeze

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, Util::STRING_ESCAPES, Util::STRING_ESCAPE_REGEX

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, #parse, qualified_cop_name, #reference_url, #relevant_file?, #style_guide_url, #target_ruby_version

Methods included from Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search_body

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?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, first_part_of_call_chain, interpret_string_escapes, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, to_string_literal, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, 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 



20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/rubocop/cop/style/character_literal.rb', line 20

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

    # special character like \n
    # or ' which needs to use "" or be escaped.
    if string.length == 2 || string == "'"
      corrector.replace(node.source_range, %("#{string}"))
    elsif string.length == 1 # normal character
      corrector.replace(node.source_range, "'#{string}'")
    end
  end
end

#correct_style_detected ⇒ Object

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



41
42
 
# File 'lib/rubocop/cop/style/character_literal.rb', line 41

def correct_style_detected
end

#offense?(node) ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#opposite_style_detected ⇒ Object

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



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

def opposite_style_detected
end