class RubbyCop::Cop::Style::StringLiterals
Checks if uses of quotes match the configured preference.
Constants
- MSG_INCONSISTENT
Public Instance Methods
on_dstr(node)
click to toggle source
# File lib/rubbycop/cop/style/string_literals.rb, line 13 def on_dstr(node) # Strings which are continued across multiple lines using \ # are parsed as a `dstr` node with `str` children # If one part of that continued string contains interpolations, # then it will be parsed as a nested `dstr` node return unless consistent_multiline? return if node.loc.is_a?(Parser::Source::Map::Heredoc) children = node.children return unless all_string_literals?(children) quote_styles = detect_quote_styles(node) if quote_styles.size > 1 add_offense(node, :expression, MSG_INCONSISTENT) else check_multiline_quote_style(node, quote_styles[0]) end ignore_node(node) end
Private Instance Methods
accept_child_double_quotes?(nodes)
click to toggle source
# File lib/rubbycop/cop/style/string_literals.rb, line 94 def accept_child_double_quotes?(nodes) nodes.any? do |n| n.dstr_type? || double_quotes_required?(n.source) end end
all_string_literals?(nodes)
click to toggle source
# File lib/rubbycop/cop/style/string_literals.rb, line 37 def all_string_literals?(nodes) nodes.all? { |n| n.str_type? || n.dstr_type? } end
check_multiline_quote_style(node, quote)
click to toggle source
# File lib/rubbycop/cop/style/string_literals.rb, line 75 def check_multiline_quote_style(node, quote) range = node.source_range children = node.children if unexpected_single_quotes?(quote) add_offense(node, range) if children.all? { |c| wrong_quotes?(c) } elsif unexpected_double_quotes?(quote) && !accept_child_double_quotes?(children) add_offense(node, range) end end
consistent_multiline?()
click to toggle source
# File lib/rubbycop/cop/style/string_literals.rb, line 71 def consistent_multiline? cop_config['ConsistentQuotesInMultiline'] end
detect_quote_styles(node)
click to toggle source
# File lib/rubbycop/cop/style/string_literals.rb, line 41 def detect_quote_styles(node) styles = node.children.map { |c| c.loc.begin } # For multi-line strings that only have quote marks # at the beginning of the first line and the end of # the last, the begin and end region of each child # is nil. The quote marks are in the parent node. return [node.loc.begin.source] if styles.all?(&:nil?) styles.map(&:source).uniq end
message(*)
click to toggle source
# File lib/rubbycop/cop/style/string_literals.rb, line 53 def message(*) if style == :single_quotes "Prefer single-quoted strings when you don't need string " \ 'interpolation or special symbols.' else 'Prefer double-quoted strings unless you need single quotes to ' \ 'avoid extra backslashes for escaping.' end end
offense?(node)
click to toggle source
# File lib/rubbycop/cop/style/string_literals.rb, line 63 def offense?(node) # If it's a string within an interpolation, then it's not an offense # for this cop. return false if inside_interpolation?(node) wrong_quotes?(node) end
unexpected_double_quotes?(quote)
click to toggle source
# File lib/rubbycop/cop/style/string_literals.rb, line 90 def unexpected_double_quotes?(quote) quote == '"' && style == :single_quotes end
unexpected_single_quotes?(quote)
click to toggle source
# File lib/rubbycop/cop/style/string_literals.rb, line 86 def unexpected_single_quotes?(quote) quote == "'" && style == :double_quotes end