Class: RuboCop::Cop::Style::QuotedSymbols
Relationships & Source Files | |
Super Chains via Extension / Inclusion / Inheritance | |
Class Chain:
self,
::RuboCop::Cop::AutoCorrector ,
::RuboCop::Cop::Base ,
::RuboCop::ExcludeLimit ,
NodePattern::Macros,
RuboCop::AST::Sexp
|
|
Instance Chain:
|
|
Inherits: |
RuboCop::Cop::Base
|
Defined in: | lib/rubocop/cop/style/quoted_symbols.rb |
Overview
Checks if the quotes used for quoted symbols match the configured defaults.
By default uses the same configuration as Style/StringLiterals
; if that
cop is not enabled, the default EnforcedStyle
is single_quotes
.
String interpolation is always kept in double quotes.
Note
|
Lint/SymbolConversion can be used in parallel to ensure that symbols
are not quoted that don’t need to be. This cop is for configuring the quoting
style to use for symbols that require quotes.
|
Constant Summary
-
MSG_DOUBLE =
# File 'lib/rubocop/cop/style/quoted_symbols.rb', line 41'Prefer double-quoted symbols unless you need single quotes to ' \ 'avoid extra backslashes for escaping.'
-
MSG_SINGLE =
# File 'lib/rubocop/cop/style/quoted_symbols.rb', line 39"Prefer single-quoted symbols when you don't need string interpolation " \ 'or special symbols.'
::RuboCop::Cop::Base
- Inherited
EMPTY_OFFENSES, RESTRICT_ON_SEND
::RuboCop::Cop::ConfigurableEnforcedStyle
- Included
Class Attribute Summary
::RuboCop::Cop::AutoCorrector
- Extended
::RuboCop::Cop::Base
- Inherited
.gem_requirements, .lint?, | |
.support_autocorrect? | Returns if class supports autocorrect. |
.support_multiple_source? | Override if your cop should be called repeatedly for multiple investigations Between calls to |
Class Method Summary
::RuboCop::Cop::Base
- Inherited
.autocorrect_incompatible_with | List of cops that should not try to autocorrect at the same time as this cop. |
.badge | Naming. |
.callbacks_needed, .cop_name, .department, | |
.documentation_url | Returns a url to view this cops documentation online. |
.exclude_from_registry | Call for abstract Cop classes. |
.inherited, | |
.joining_forces | Override and return the Force class(es) you need to join. |
.match? | Returns true if the cop name or the cop namespace matches any of the given names. |
.new, | |
.requires_gem | Register a version requirement for the given gem name. |
.restrict_on_send |
::RuboCop::ExcludeLimit
- Extended
exclude_limit | Sets up a configuration option to have an exclude limit tracked. |
transform |
Instance Attribute Summary
::RuboCop::Cop::StringLiteralsHelp
- Included
::RuboCop::Cop::ConfigurableEnforcedStyle
- Included
::RuboCop::Cop::Base
- Inherited
::RuboCop::Cop::AutocorrectLogic
- Included
Instance Method Summary
- #on_sym(node)
- #alternative_style private
- #autocorrect(corrector, node) private
- #correct_quotes(str) private
- #hash_colon_key?(node) ⇒ Boolean private
- #invalid_double_quotes?(source) ⇒ Boolean private
- #quoted?(sym_node) ⇒ Boolean private
- #style private
- #wrong_quotes?(node) ⇒ Boolean private
::RuboCop::Cop::StringLiteralsHelp
- Included
::RuboCop::Cop::SymbolHelp
- Included
::RuboCop::Cop::ConfigurableEnforcedStyle
- Included
::RuboCop::Cop::Base
- Inherited
#add_global_offense | Adds an offense that has no particular location. |
#add_offense | Adds an offense on the specified range (or node with an expression) Unless that offense is disabled for this range, a corrector will be yielded to provide the cop the opportunity to autocorrect the offense. |
#begin_investigation | Called before any investigation. |
#callbacks_needed, | |
#cop_config | Configuration Helpers. |
#cop_name, #excluded_file?, | |
#external_dependency_checksum | This method should be overridden when a cop’s behavior depends on state that lives outside of these locations: |
#inspect, | |
#message | Gets called if no message is specified when calling |
#name | Alias for Base#cop_name. |
#offenses, | |
#on_investigation_end | Called after all on_… |
#on_new_investigation | Called before all on_… |
#on_other_file | Called instead of all on_… |
#parse | There should be very limited reasons for a Cop to do it’s own parsing. |
#parser_engine, | |
#ready | Called between investigations. |
#relevant_file?, #target_rails_version, #target_ruby_version, #annotate, #apply_correction, #attempt_correction, | |
#callback_argument | Reserved for Cop::Cop. |
#complete_investigation | Called to complete an investigation. |
#correct, #current_corrector, | |
#current_offense_locations | Reserved for Commissioner: |
#current_offenses, #currently_disabled_lines, #custom_severity, #default_severity, #disable_uncorrectable, #enabled_line?, #file_name_matches_any?, #find_message, #find_severity, #range_for_original, #range_from_node_or_range, | |
#reset_investigation | Actually private methods. |
#use_corrector |
::RuboCop::Cop::AutocorrectLogic
- Included
#disable_offense, #disable_offense_at_end_of_line, #disable_offense_before_and_after, #disable_offense_with_eol_or_surround_comment, #heredoc_range, #max_line_length, #multiline_ranges, #multiline_string?, | |
#range_by_lines | Expand the given range to include all of any lines it covers. |
#range_of_first_line, #range_overlaps_offense?, #string_continuation?, #surrounding_heredoc?, #surrounding_percent_array? |
::RuboCop::Cop::IgnoredNode
- Included
Constructor Details
This class inherits a constructor from RuboCop::Cop::Base
Instance Method Details
#alternative_style (private)
[ GitHub ]# File 'lib/rubocop/cop/style/quoted_symbols.rb', line 106
def alternative_style (supported_styles - [style, :same_as_string_literals]).first end
#autocorrect(corrector, node) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/quoted_symbols.rb', line 71
def autocorrect(corrector, node) str = if hash_colon_key?(node) # strip quotes correct_quotes(node.source[1..-2]) else # strip leading `:` and quotes ":#{correct_quotes(node.source[2..-2])}" end corrector.replace(node, str) end
#correct_quotes(str) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/quoted_symbols.rb', line 88
def correct_quotes(str) correction = if style == :single_quotes to_string_literal(str) else str.gsub("\\'", "'").inspect end # The conversion process doubles escaped slashes, so they have to be reverted correction.gsub('\\\\', '\\').gsub('\"', '"') end
#hash_colon_key?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/quoted_symbols.rb', line 83
def hash_colon_key?(node) # Is the node a hash key with the colon style? hash_key?(node) && node.parent.colon? end
#invalid_double_quotes?(source) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/quoted_symbols.rb', line 61
def invalid_double_quotes?(source) return false unless style == :double_quotes # The string needs single quotes if: # 1. It contains a double quote # 2. It contains text that would become an escape sequence with double quotes # 3. It contains text that would become an interpolation with double quotes !/" | (?<!\\)\\[aAbcdefkMnprsStuUxzZ0-7] | \#[@{$]/x.match?(source) end
#on_sym(node)
[ GitHub ]# File 'lib/rubocop/cop/style/quoted_symbols.rb', line 44
def on_sym(node) return unless quoted?(node) = style == :single_quotes ? MSG_SINGLE : MSG_DOUBLE if wrong_quotes?(node) || invalid_double_quotes?(node.source) add_offense(node, message: ) do |corrector| opposite_style_detected autocorrect(corrector, node) end else correct_style_detected end end
#quoted?(sym_node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/quoted_symbols.rb', line 110
def quoted?(sym_node) sym_node.source.match?(/\A:?(['"]).*?\1\z/m) end
#style (private)
[ GitHub ]# File 'lib/rubocop/cop/style/quoted_symbols.rb', line 99
def style return super unless super == :same_as_string_literals return :single_quotes unless string_literals_config['Enabled'] string_literals_config['EnforcedStyle'].to_sym end
#wrong_quotes?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/quoted_symbols.rb', line 114
def wrong_quotes?(node) return super if hash_key?(node) super(node.source[1..]) end