Class: Prism::MagicComment

Inherits:
Object show all
Defined in:
lib/prism/parse_result.rb

Overview

This represents a magic comment that was encountered during parsing.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(key_loc, value_loc) ⇒ MagicComment

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



281
282
283
284
 
# File 'lib/prism/parse_result.rb', line 281

def initialize(key_loc, value_loc)
  @key_loc = key_loc
  @value_loc = value_loc
end

Instance Attribute Details

#key_loc ⇒ Object (readonly)

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



275
276
277
 
# File 'lib/prism/parse_result.rb', line 275

def key_loc
  @key_loc
end

#value_loc ⇒ Object (readonly)

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



278
279
280
 
# File 'lib/prism/parse_result.rb', line 278

def value_loc
  @value_loc
end

Instance Method Details

#deconstruct_keys(keys) ⇒ Object

Implement the hash pattern matching interface for MagicComment.



297
298
299
 
# File 'lib/prism/parse_result.rb', line 297

def deconstruct_keys(keys)
  { key_loc: key_loc, value_loc: value_loc }
end

#inspect ⇒ Object

Returns a string representation of this magic comment.



302
303
304
 
# File 'lib/prism/parse_result.rb', line 302

def inspect
  "#<Prism::MagicComment @key=#{key.inspect} @value=#{value.inspect}>"
end

#key ⇒ Object

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



287
288
289
 
# File 'lib/prism/parse_result.rb', line 287

def key
  key_loc.slice
end

#value ⇒ Object

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



292
293
294
 
# File 'lib/prism/parse_result.rb', line 292

def value
  value_loc.slice
end