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.

Examples:

# bad
?x

# good
'x'

# good
?\C-\M-d

Constant Summary collapse

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

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods included from RuboCop::Cop::StringHelp

#on_regexp, #on_str

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 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, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens

Methods included from PathUtil

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

Constructor Details

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

Instance Method Details

#autocorrect(node) ⇒ Object



29
30
31
32
33
34
35
36
37
38
39
40
41
# File 'lib/rubocop/cop/style/character_literal.rb', line 29

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_detectedObject

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



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

def correct_style_detected; end

#offense?(node) ⇒ Boolean

Returns:

  • (Boolean)


23
24
25
26
27
# File 'lib/rubocop/cop/style/character_literal.rb', line 23

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_detectedObject

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



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

def opposite_style_detected; end