Reconfigure error tests

Author: kddnewton

bin/prism

@@ -13,6 +13,7 @@ module Prism
  when "console" then console
  when "dot" then dot(argv)
  when "encoding" then encoding(argv)
+ when "error" then error(argv)
  when "lex" then lex(argv)
  when "locals" then locals(argv)
  when "parse" then parse(argv)
@@ -27,6 +28,7 @@ module Prism
  bin/prism console
  bin/prism dot [source]
  bin/prism encoding [encoding]
+ bin/prism error [name] [source]
  bin/prism lex [source]
  bin/prism locals [source]
  bin/prism parse [source]
@@ -157,6 +159,29 @@ module Prism
  unicode_lists(found) if found == Encoding::UTF_8 || found == Encoding::UTF8_MAC
  end
 
+ # bin/prism error [name] [source]
+ def error(argv)
+ name = argv.shift
+ source, _ = read_source(argv)
+
+ result = Prism.parse(source)
+ raise "Expected #{source.inspect} to have errors" if result.success?
+
+ filepath = File.expand_path("../test/prism/errors/#{name}.txt", __dir__)
+
+ if File.file?(filepath)
+ counter = 1
+
+ begin
+ current = "#{File.dirname(filepath)}/#{File.basename(filepath, ".txt")}_#{counter += 1}.txt"
+ end while File.file?(current)
+
+ filepath = current
+ end
+
+ File.write(filepath, result.errors_format)
+ end
+
  # bin/prism lex [source]
  def lex(argv)
  source, filepath = read_source(argv)

lib/prism/parse_result.rb

@@ -575,6 +575,7 @@ def failure?
  # This is a result specific to the `parse` and `parse_file` methods.
  class ParseResult < Result
  autoload :Comments, "prism/parse_result/comments"
+ autoload :Errors, "prism/parse_result/errors"
  autoload :Newlines, "prism/parse_result/newlines"
 
  private_constant :Comments
@@ -604,6 +605,12 @@ def attach_comments!
  def mark_newlines!
  value.accept(Newlines.new(source.offsets.size)) # steep:ignore
  end
+
+ # Returns a string representation of the syntax tree with the errors
+ # displayed inline.
+ def errors_format
+ Errors.new(self).format
+ end
  end
 
  # This is a result specific to the `lex` and `lex_file` methods.

lib/prism/parse_result/errors.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require "stringio"
+
+module Prism
+ class ParseResult < Result
+ class Errors
+ attr_reader :parse_result
+
+ def initialize(parse_result)
+ @parse_result = parse_result
+ end
+
+ def format
+ error_lines = {}
+ parse_result.errors.each do |error|
+ location = error.location
+ (location.start_line..location.end_line).each do |line|
+ error_lines[line] ||= []
+ error_lines[line] << error
+ end
+ end
+
+ source_lines = parse_result.source.source.lines
+ source_lines << "" if error_lines.key?(source_lines.size + 1)
+
+ io = StringIO.new
+ source_lines.each.with_index(1) do |line, line_number|
+ io.puts(line)
+ 
+ (error_lines.delete(line_number) || []).each do |error|
+ location = error.location
+ 
+ case line_number
+ when location.start_line
+ io.print(" " * location.start_column + "^")
+ 
+ if location.start_line == location.end_line
+ if location.start_column != location.end_column
+ io.print("~" * (location.end_column - location.start_column - 1))
+ end
+ 
+ io.puts(" " + error.message)
+ else
+ io.puts("~" * (line.bytesize - location.start_column))
+ end
+ when location.end_line
+ io.puts("~" * location.end_column + " " + error.message)
+ else
+ io.puts("~" * line.bytesize)
+ end
+ end
+ end
+ 
+ io.puts
+ io.string
+ end
+ end
+ end
+end

test/prism/errors/1_2_3.txt

@@ -0,0 +1,11 @@
+(1, 2, 3)
+ ^ unexpected ',', expecting end-of-input
+ ^ unexpected ',', ignoring it
+ ^ expected a matching `)`
+ ^ unexpected ',', expecting end-of-input
+ ^ unexpected ',', ignoring it
+ ^ unexpected ',', expecting end-of-input
+ ^ unexpected ',', ignoring it
+ ^ unexpected ')', expecting end-of-input
+ ^ unexpected ')', ignoring it
+

test/prism/errors/aliasing_global_variable_with_global_number_variable.txt

@@ -0,0 +1,3 @@
+alias $a $1
+ ^~ invalid argument being passed to `alias`; can't make alias for the number variables
+

test/prism/errors/aliasing_global_variable_with_non_global_variable.txt

@@ -0,0 +1,3 @@
+alias $a b
+ ^ invalid argument being passed to `alias`; expected a bare word, symbol, constant, or global variable
+

test/prism/errors/aliasing_non_global_variable_with_global_variable.txt

@@ -0,0 +1,3 @@
+alias a $b
+ ^~ invalid argument being passed to `alias`; expected a bare word, symbol, constant, or global variable
+

test/prism/errors/alnum_delimiters.txt

@@ -0,0 +1,3 @@
+%qXfooX
+^ unknown type of %string
+

test/prism/errors/alnum_delimiters_2.txt

@@ -0,0 +1,3 @@
+%QXfooX
+^ unknown type of %string
+

test/prism/errors/alnum_delimiters_3.txt

@@ -0,0 +1,3 @@
+%wXfooX
+^ unknown type of %string
+