Class: RuboCop::Cop::Style::CharacterLiteral
- 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::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
- #autocorrect(node) ⇒ Object
-
#correct_style_detected ⇒ Object
Dummy implementation of method in ConfigurableEnforcedStyle that is called from StringHelp.
- #offense?(node) ⇒ Boolean
-
#opposite_style_detected ⇒ Object
Dummy implementation of method in ConfigurableEnforcedStyle that is called from StringHelp.
Methods included from RuboCop::Cop::StringHelp
#inside_interpolation?, #on_regexp, #on_str
Methods inherited from Cop
#add_offense, all, 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_ruby_version
Methods included from AST::Sexp
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?, 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_supported_styles, 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
#autocorrect(node) ⇒ Object
19 20 21 22 23 24 25 26 27 28 29 30 31 |
# File 'lib/rubocop/cop/style/character_literal.rb', line 19 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.
39 |
# File 'lib/rubocop/cop/style/character_literal.rb', line 39 def correct_style_detected; end |
#offense?(node) ⇒ Boolean
13 14 15 16 17 |
# File 'lib/rubocop/cop/style/character_literal.rb', line 13 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.
35 |
# File 'lib/rubocop/cop/style/character_literal.rb', line 35 def opposite_style_detected; end |