class SyntaxTree::StringLiteral

StringLiteral represents a string literal.

"string"

Attributes

comments[R]

Array[ Comment | EmbDoc ]: the comments attached to this node

parts[R]

Array[ StringEmbExpr | StringDVar | TStringContent ]: the parts of the

string literal

quote[R]

nil | String: which quote was used by the string literal

Public Class Methods

new(parts:, quote:, location:) click to toggle source

# File lib/syntax_tree/node.rb, line 10329
def initialize(parts:, quote:, location:)
  @parts = parts
  @quote = quote
  @location = location
  @comments = []
end

Public Instance Methods

===(other) click to toggle source

# File lib/syntax_tree/node.rb, line 10403
def ===(other)
  other.is_a?(StringLiteral) && ArrayMatch.call(parts, other.parts) &&
    quote === other.quote
end

accept(visitor) click to toggle source

# File lib/syntax_tree/node.rb, line 10336
def accept(visitor)
  visitor.visit_string_literal(self)
end

child_nodes() click to toggle source

# File lib/syntax_tree/node.rb, line 10340
def child_nodes
  parts
end

Also aliased as: deconstruct

copy(parts: nil, quote: nil, location: nil) click to toggle source

# File lib/syntax_tree/node.rb, line 10344
def copy(parts: nil, quote: nil, location: nil)
  node =
    StringLiteral.new(
      parts: parts || self.parts,
      quote: quote || self.quote,
      location: location || self.location
    )

  node.comments.concat(comments.map(&:copy))
  node
end

deconstruct()

Alias for: child_nodes

deconstruct_keys(_keys) click to toggle source

# File lib/syntax_tree/node.rb, line 10358
def deconstruct_keys(_keys)
  { parts: parts, quote: quote, location: location, comments: comments }
end

format(q) click to toggle source

# File lib/syntax_tree/node.rb, line 10362
def format(q)
  if parts.empty?
    q.text("#{q.quote}#{q.quote}")
    return
  end

  opening_quote, closing_quote =
    if !Quotes.locked?(self, q.quote)
      [q.quote, q.quote]
    elsif quote&.start_with?("%")
      [quote, Quotes.matching(quote[/%[qQ]?(.)/, 1])]
    else
      [quote, quote]
    end

  q.text(opening_quote)
  q.group do
    parts.each do |part|
      if part.is_a?(TStringContent)
        value = Quotes.normalize(part.value, closing_quote)
        first = true

        value.each_line(chomp: true) do |line|
          if first
            first = false
          else
            q.breakable_return
          end

          q.text(line)
        end

        q.breakable_return if value.end_with?("\n")
      else
        q.format(part)
      end
    end
  end
  q.text(closing_quote)
end