класс SyntaxSuggest::ExplainSyntax

Родитель:: Объект

Объясняет синтаксические ошибки на основе их источника

Пример:

source = "def foo; puts 'lol'" # Note missing end
explain ExplainSyntax.new(
  code_lines: CodeLine.from_source(source)
).call
explain.errors.first
# => "Unmatched keyword, missing `end' ?"

Если ошибка не может быть определена подсчётом лексем, то выполняется риппер для входных данных, и возвращаются необработанные ошибки риппера.

Пример:

source = "1 * " # Note missing a second number
explain ExplainSyntax.new(
  code_lines: CodeLine.from_source(source)
).call
explain.errors.first
# => "syntax error, unexpected end-of-input"

Константы

INVERSE

Публичные методы класса

new(code_lines:) Показать исходный код

# File lib/syntax_suggest/explain_syntax.rb, line 40
def initialize(code_lines:)
  @code_lines = code_lines
  @left_right = LeftRightLexCount.new
  @missing = nil
end

Публичные методы экземпляра

call() Показать исходный код

# File lib/syntax_suggest/explain_syntax.rb, line 46
def call
  @code_lines.each do |line|
    line.lex.each do |lex|
      @left_right.count_lex(lex)
    end
  end

  self
end

errors() Показать исходный код

# File lib/syntax_suggest/explain_syntax.rb, line 95
def errors
  if missing.empty?
    return RipperErrors.new(@code_lines.map(&:original).join).call.errors
  end

  missing.map { |miss| why(miss) }
end

Возвращает массив сообщений о синтаксических ошибках

Если парные элементы не найдены, используется исходные сообщения об ошибках риппера.

missing() Показать исходный код

# File lib/syntax_suggest/explain_syntax.rb, line 65
def missing
  @missing ||= @left_right.missing
end

Возвращает массив отсутствующих элементов

Например, это:

ExplainSyntax.new(code_lines: lines).missing
# => ["}"]

Указывает, что в исходном коде отсутствует символ ‘}`.

why(miss) Показать исходный код

# File lib/syntax_suggest/explain_syntax.rb, line 77
def why(miss)
  case miss
  when "keyword"
    "Unmatched `end', missing keyword (`do', `def`, `if`, etc.) ?"
  when "end"
    "Unmatched keyword, missing `end' ?"
  else
    inverse = INVERSE.fetch(miss) {
      raise "Unknown explain syntax char or key: #{miss.inspect}"
    }
    "Unmatched `#{inverse}', missing `#{miss}' ?"
  end
end

Преобразует строку с отсутствующим элементом в удобочитаемое объяснение.

Пример:

explain.why("}")
# => "Unmatched `{', missing `}' ?"

Ruby Core © 1993–2022 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.