Class: TreeHaver::Backends::Prism::Language

Inherits:
TreeHaver::Base::Language show all
Defined in:
lib/tree_haver/backends/prism.rb

Overview

Prism language wrapper

Unlike tree-sitter which supports many languages via grammar files, Prism only parses Ruby. This class exists for API compatibility with other tree_haver backends.

Examples:

language = TreeHaver::Backends::Prism::Language.ruby
parser.language = language

Instance Attribute Summary

Attributes inherited from TreeHaver::Base::Language

#backend, #name, #options

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from TreeHaver::Base::Language

#eql?, #hash, #inspect

Constructor Details

#initialize(name = :ruby, options: {}) ⇒ Language

Returns a new instance of Language.

Parameters:

  • name (Symbol) (defaults to: :ruby) —

    language name (should be :ruby)

  • options (Hash) (defaults to: {}) —

    Prism parsing options (e.g., frozen_string_literal, version)



96
97
98
99
100
101
102
103
104
 
# File 'lib/tree_haver/backends/prism.rb', line 96

def initialize(name = :ruby, options: {})
  super(name, backend: :prism, options: options)

  unless self.name == :ruby
    raise TreeHaver::NotAvailable,
      "Prism only supports Ruby parsing. " \
        "Got language: #{name.inspect}"
  end
end

Class Method Details

.from_library(_path = nil, symbol: nil, name: nil) ⇒ Language Also known as: from_path

Load language from library path (API compatibility)

Prism only supports Ruby, so path and symbol parameters are ignored.

Parameters:

  • _path (String) (defaults to: nil) —

    Ignored - Prism doesn’t load external grammars

  • symbol (String, nil) (defaults to: nil) —

    Ignored - Prism only supports Ruby

  • name (String, nil) (defaults to: nil) —

    Language name hint (defaults to :ruby)

Returns:

Raises:



141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/tree_haver/backends/prism.rb', line 141

def from_library(_path = nil, symbol: nil, name: nil)
  lang_name = name || :ruby

  unless lang_name == :ruby
    raise TreeHaver::NotAvailable,
      "Prism backend only supports Ruby, not #{lang_name}. " \
        "Use a tree-sitter backend for #{lang_name} support."
  end

  ruby
end

.ruby(options = {}) ⇒ Language

Create a Ruby language instance (convenience method)

Examples:

lang = TreeHaver::Backends::Prism::Language.ruby
lang = TreeHaver::Backends::Prism::Language.ruby(frozen_string_literal: true)

Parameters:

  • options (Hash) (defaults to: {}) —

    Prism parsing options

Options Hash (options):

  • :frozen_string_literal (Boolean) —

    frozen string literal pragma

  • :version (String) —

    Ruby version to parse as (e.g., “3.3.0”)

  • :command_line (Symbol) —

    command line option (-e, -n, etc.)

Returns:



128
129
130
 
# File 'lib/tree_haver/backends/prism.rb', line 128

def ruby(options = {})
  new(:ruby, options: options)
end

Instance Method Details

#<=>(other) ⇒ Integer?

Compare languages for equality by options (since name is always :ruby)

Parameters:

  • other (Object) —

    object to compare with

Returns:

  • (Integer, nil) —

    -1, 0, 1, or nil if not comparable



110
111
112
113
114
115
 
# File 'lib/tree_haver/backends/prism.rb', line 110

def <=>(other)
  return unless other.is_a?(TreeHaver::Base::Language)
  return unless other.backend == backend

  options.to_a.sort <=> other.options.to_a.sort
end