Prism::MagicComment

Class

This represents a magic comment that was encountered during parsing.

Attributes

key_loc

Read

A Location object representing the location of the key in the source.

value_loc

Read

A Location object representing the location of the value in the source.

Class Methods

new(key_loc, value_loc)

lib/prism/parse_result.rb View on GitHub

          
            # File tmp/rubies/ruby-3.3.0/lib/prism/parse_result.rb, line 281
def initialize(key_loc, value_loc)
  @key_loc = key_loc
  @value_loc = value_loc
end

Create a new magic comment object with the given key and value locations.

Instance Methods

deconstruct_keys(keys)

lib/prism/parse_result.rb View on GitHub

          
            # File tmp/rubies/ruby-3.3.0/lib/prism/parse_result.rb, line 297
def deconstruct_keys(keys)
  { key_loc: key_loc, value_loc: value_loc }
end

Implement the hash pattern matching interface for MagicComment.

inspect

lib/prism/parse_result.rb View on GitHub

          
            # File tmp/rubies/ruby-3.3.0/lib/prism/parse_result.rb, line 302
def inspect
  "#<Prism::MagicComment @key=#{key.inspect} @value=#{value.inspect}>"
end

Returns a string representation of this magic comment.

key

lib/prism/parse_result.rb View on GitHub

          
            # File tmp/rubies/ruby-3.3.0/lib/prism/parse_result.rb, line 287
def key
  key_loc.slice
end

Returns the key of the magic comment by slicing it from the source code.

value

lib/prism/parse_result.rb View on GitHub

          
            # File tmp/rubies/ruby-3.3.0/lib/prism/parse_result.rb, line 292
def value
  value_loc.slice
end

Returns the value of the magic comment by slicing it from the source code.