класс Ripper

# File ext/ripper/lib/ripper/lexer.rb, line 51
def Ripper.lex(src, filename = '-', lineno = 1, **kw)
  Lexer.new(src, filename, lineno).lex(**kw)
end

Токенизирует программу Ruby и возвращает массив массивов, отформатированный как [[lineno, column], type, token, state]. Аргумент filename в основном игнорируется. По умолчанию этот метод не обрабатывает синтаксические ошибки в src, используйте ключевое слово raise_errors для повышения исключения SyntaxError при ошибке в src.

require 'ripper'
require 'pp'

pp Ripper.lex("def m(a) nil end")
#=> [[[1,  0], :on_kw,     "def", FNAME    ],
     [[1,  3], :on_sp,     " ",   FNAME    ],
     [[1,  4], :on_ident,  "m",   ENDFN    ],
     [[1,  5], :on_lparen, "(",   BEG|LABEL],
     [[1,  6], :on_ident,  "a",   ARG      ],
     [[1,  7], :on_rparen, ")",   ENDFN    ],
     [[1,  8], :on_sp,     " ",   BEG      ],
     [[1,  9], :on_kw,     "nil", END      ],
     [[1, 12], :on_sp,     " ",   END      ],
     [[1, 13], :on_kw,     "end", END      ]]

# File ext/ripper/lib/ripper/core.rb, line 18
def Ripper.parse(src, filename = '(ripper)', lineno = 1)
  new(src, filename, lineno).parse
end

Парсит заданную программу Ruby, считываемую из src. src должен быть строкой String или объектом IO, или объектом с методом gets.

# File ext/ripper/lib/ripper/sexp.rb, line 35
def Ripper.sexp(src, filename = '-', lineno = 1, raise_errors: false)
  builder = SexpBuilderPP.new(src, filename, lineno)
  sexp = builder.parse
  if builder.error?
    if raise_errors
      raise SyntaxError, builder.error
    end
  else
    sexp
  end
end

ЭКСПЕРИМЕНТАЛЬНЫЙ

Парсит src и создает дерево S-выражений. Возвращает более читаемое дерево, чем Ripper.sexp_raw. Этот метод предназначен в основном для разработчиков. Аргумент filename в основном игнорируется. По умолчанию этот метод не обрабатывает синтаксические ошибки в src, возвращая nil в таких случаях. Используйте ключевое слово raise_errors для повышения исключения SyntaxError при ошибке в src.

require 'ripper'
require 'pp'

pp Ripper.sexp("def m(a) nil end")
  #=> [:program,
       [[:def,
        [:@ident, "m", [1, 4]],
        [:paren, [:params, [[:@ident, "a", [1, 6]]], nil, nil, nil, nil, nil, nil]],
        [:bodystmt, [[:var_ref, [:@kw, "nil", [1, 9]]]], nil, nil, nil]]]]

# File ext/ripper/lib/ripper/sexp.rb, line 71
def Ripper.sexp_raw(src, filename = '-', lineno = 1, raise_errors: false)
  builder = SexpBuilder.new(src, filename, lineno)
  sexp = builder.parse
  if builder.error?
    if raise_errors
      raise SyntaxError, builder.error
    end
  else
    sexp
  end
end

ЭКСПЕРИМЕНТАЛЬНЫЙ

Парсит src и создаёт дерево S-выражений. Этот метод предназначен в основном для разработчиков. Аргумент filename в основном игнорируется. По умолчанию этот метод не обрабатывает синтаксические ошибки в src, возвращая nil в таких случаях. Используйте ключевое слово raise_errors для повышения исключения SyntaxError при ошибке в src.

require 'ripper'
require 'pp'

pp Ripper.sexp_raw("def m(a) nil end")
  #=> [:program,
       [:stmts_add,
        [:stmts_new],
        [:def,
         [:@ident, "m", [1, 4]],
         [:paren, [:params, [[:@ident, "a", [1, 6]]], nil, nil, nil]],
         [:bodystmt,
          [:stmts_add, [:stmts_new], [:var_ref, [:@kw, "nil", [1, 9]]]],
          nil,
          nil,
          nil]]]]

# File ext/ripper/lib/ripper/lexer.rb, line 277
def Ripper.slice(src, pattern, n = 0)
  if m = token_match(src, pattern)
  then m.string(n)
  else nil
  end
end

ЭКСПЕРИМЕНТАЛЬНЫЙ

Парсит src и возвращает строку, которая совпала с pattern. pattern должен быть описан как Regexp.

require 'ripper'

p Ripper.slice('def m(a) nil end', 'ident')                   #=> "m"
p Ripper.slice('def m(a) nil end', '[ident lparen rparen]+')  #=> "m(a)"
p Ripper.slice("<<EOS\nstring\nEOS",
               'heredoc_beg nl $(tstring_content*) heredoc_end', 1)
    #=> "string\n"

# File ext/ripper/lib/ripper/lexer.rb, line 25
def Ripper.tokenize(src, filename = '-', lineno = 1, **kw)
  Lexer.new(src, filename, lineno).tokenize(**kw)
end

Токенизирует программу Ruby и возвращает массив строк. Аргументы filename и lineno в основном игнорируются, так как возвращаемое значение — это просто токенизированный ввод. По умолчанию этот метод не обрабатывает синтаксические ошибки в src, используйте ключевое слово raise_errors для повышения исключения SyntaxError при ошибке в src.

p Ripper.tokenize("def m(a) nil end")
   # => ["def", " ", "m", "(", "a", ")", " ", "nil", " ", "end"]

# File ext/ripper/lib/ripper/core.rb, line 63
def compile_error(msg)
end

Этот метод вызывается при обнаружении синтаксической ошибки парсером.

# File ext/ripper/lib/ripper/core.rb, line 54
def warn(fmt, *args)
end

Этот метод вызывается, когда парсер генерирует слабое предупреждение. fmt и args в стиле printf.

# File ext/ripper/lib/ripper/core.rb, line 59
def warning(fmt, *args)
end

Этот метод вызывается, когда парсер генерирует сильное предупреждение. fmt и args в стиле printf.