class SyntaxSuggest::PathnameFromMessage - Documentation for Ruby 4.0
Description: class SyntaxSuggest::PathnameFromMessage: github. bad.
Keywords: ruby,class,SyntaxSuggest::PathnameFromMessage

🔍

No recent searches

# class SyntaxSuggest::PathnameFromMessage

Converts a `SyntaxError` message to a path

Handles the case where the filename has a colon in it such as on a windows file system: github.com/ruby/syntax_suggest/issues/111

Example:

    message = "/tmp/scratch:2:in `require_relative': /private/tmp/bad.rb:1: syntax error, unexpected `end' (SyntaxError)"
    puts PathnameFromMessage.new(message).call.name
    # => "/tmp/scratch.rb"

### Constants

EVAL_RE
STREAMING_RE

### Attributes

name [R]

### Public Class Methods

new (message, io: $stderr)
Source

    # File lib/syntax_suggest/pathname_from_message.rb, line 20
    def initialize(message, io: $stderr)
      @line = message.lines.first
      @parts = @line.split(":")
      @guess = []
      @name = nil
      @io = io
    end

### Public Instance Methods

call ()
Source

    # File lib/syntax_suggest/pathname_from_message.rb, line 28
    def call
      if skip_missing_file_name?
        if ENV["SYNTAX_SUGGEST_DEBUG"]
          @io.puts "SyntaxSuggest: Could not find filename from #{@line.inspect}"
        end
      else
        until stop?
          @guess << @parts.shift
          @name = Pathname(@guess.join(":"))
        end

        if @parts.empty?
          @io.puts "SyntaxSuggest: Could not find filename from #{@line.inspect}"
          @name = nil
        end
      end

      self
    end

skip_missing_file_name? ()
Source

    # File lib/syntax_suggest/pathname_from_message.rb, line 55
    def skip_missing_file_name?
      @line.match?(EVAL_RE) || @line.match?(STREAMING_RE)
    end

stop? ()
Source

    # File lib/syntax_suggest/pathname_from_message.rb, line 48
    def stop?
      return true if @parts.empty?
      return false if @guess.empty?

      @name&.exist?
    end