tex_log_parser 1.0.0.pre.9 → 1.0.0.pre.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a31484789a537268e2bcd739ff74fac6b946068
-  data.tar.gz: a0bce484490571886b62aa1434f3ea4c625dbd0f
+  metadata.gz: c466836b3e482413ab935462f0bc513bc7bd43a5
+  data.tar.gz: 8cf420477f87eb3e5cca65db7c5b5dedc1b1129b
 SHA512:
-  metadata.gz: d6f9094ef608e78610997a5ed04ee3c01ee8e9d53bf942cf263c2b4e6378ee4193b3f8b39b77d69440591d6365d4a013e23c273bcdc2fb5a8abd0c10693081e9
-  data.tar.gz: 623cd9d97a032617e669edaa71e171e70195fc71eb2480afd316387c01cfc9390dad80822dd680c8536b30ced3964760d3f7e6c7621fe8d83cd08c565eb46609
+  metadata.gz: 7e10d29ce1cfee50a9ee0c6ff16fa57bf76afe91f88b71b81966e7ee12bd469c4995147f76821b8fbba60f7b8ef07bd264fc32500a6dcba25b257a5d5c947ed3
+  data.tar.gz: 93884717b008a2b80f5b7d8aa4e8d9df4e7e4e563beed9e11333bd8bc28a8341b20fdd61b9d61b8c910537c8b5a0bc9cee1e7c207445e3e185348c6a51277ec1

data/lib/logger.rb

@@ -8,10 +8,14 @@ class Logger
   class << self
     attr_accessor :debugging
 
+    def debug?
+      debugging || !ENV['DEBUG'].nil?
+    end
+
     # Logs the given message to STDOUT if `debug` is true.
     # @param [String] message
     def debug(message)
-      puts message if debugging || !ENV['DEBUG'].nil?
+      puts message if debug?
     end
   end
 end

data/lib/tex_log_parser/log_message.rb

@@ -34,7 +34,7 @@ class LogMessage
 
     message = @message
     message = message.split("\n").map(&:strip).join(' ') unless @preformatted
-    message += "\nLog pattern: '#{@pattern}'" if Logger.debugging
+    message += "\nLog pattern: '#{@pattern}'" if Logger.debug?
 
     <<~MSG
       #{@source_file}#{lines}: #{@level.to_s.upcase}
@@ -51,7 +51,7 @@ class LogMessage
       log_lines: @log_lines,
       preformatted: @preformatted
     }
-    hash[:pattern] = @pattern if Logger.debugging
+    hash[:pattern] = @pattern if Logger.debug?
     JSON.pretty_generate hash
   end
 end

data/lib/tex_log_parser/log_parser.rb

@@ -3,6 +3,7 @@
 # TODO: document
 module LogParser
   attr_reader :messages
+  attr_reader :scope_changes_by_line if Logger.debug?
 
   # TODO: document
   # @param [Array<String>,IO,StringIO] log
@@ -15,6 +16,7 @@ module LogParser
     @lines = LogBuffer.new(log)
 
     Logger.debug "Parsing from '#{log}'"
+    @scope_changes_by_line = {} if Logger.debug?
   end
 
   # @return [Array<LogPattern>]
@@ -62,7 +64,7 @@ module LogParser
     raise 'Parse already done!' if @lines.empty?
 
     line = @lines.first
-    Logger.debug "\nLine: '#{line.strip}'"
+    Logger.debug "\nLine #{@log_line_number}: '#{line.strip}'"
     msg = nil
 
     # Use the first pattern that matches. Let's hope that's a good heuristic.
@@ -89,7 +91,9 @@ module LogParser
 
   def remove_consumed_lines(i)
     @lines.forward(i)
-    @log_line_number += i
+    @log_line_number                         += i
+
+    @scope_changes_by_line[@log_line_number] = [] if Logger.debug? && i > 0
   end
 
   # @return [LogMessage,nil]
@@ -101,6 +105,7 @@ module LogParser
     message.log_lines = { from: @log_line_number,
                           to: @log_line_number + consumed_lines - 1 }
     message.source_file ||= @files.last
+    message.source_lines ||= { from: nil, to: nil }
 
     Logger.debug message
     remove_consumed_lines consumed_lines
@@ -117,9 +122,13 @@ module LogParser
     scope_changes(@lines.first).each do |op|
       if op == :pop
         left = @files.pop
+
         Logger.debug "- Finished source file: '#{left.nil? ? 'nil' : left}'"
+        @scope_changes_by_line[@log_line_number].push "pop  #{left}" if Logger.debug?
       else # op is file name
         Logger.debug "- Entered source file: '#{op}'"
+        @scope_changes_by_line[@log_line_number].push "push #{op}" if Logger.debug?
+
         @files.push(op)
       end
     end

data/lib/tex_log_parser/patterns/file_line_error.rb

@@ -22,6 +22,8 @@ class FileLineError
     msg.preformatted = true
     msg.level = :error
 
+    msg.message.gsub!(@start, '')
+
     [msg, consumed]
   end
 end

data/lib/tex_log_parser/patterns/highlighted_messages.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+# Matches messages of these forms:
+#
+#     !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+#     !
+#     ./plain.tex:5: fontspec error: "font-not-found"
+#     !
+#     ! The font "NoSuchFont" cannot be found.
+#     !
+#     ! See the fontspec documentation for further information.
+#     !
+#     ! For immediate help type H <return>.
+#     !...............................................
+#
+#     l.5 \setmainfont{NoSuchFont}
+#
+# and
+#
+#     !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+#     !
+#     ! fontspec error: "font-not-found"
+#     !
+#     ! The font "NoSuchFont" cannot be found.
+#     !
+#     ! See the fontspec documentation for further information.
+#     !
+#     ! For immediate help type H <return>.
+#     !...............................................
+#
+#     l.5 \setmainfont{NoSuchFont}
+#
+# and
+#
+#     .................................................
+#     . LaTeX info: "xparse/define-command"
+#     .
+#     . Defining command \fontspec with sig. 'O{}mO{}' on line 472.
+#     .................................................
+class HighlightedMessages
+  include RegExpPattern
+
+  def initialize
+    super(/^(\!{3,}|\.{3,})$/,
+          { pattern: lambda { |m|
+                       if m[1][0] == '!'
+                         /^l\.(\d+)/
+                       else
+                         /^\.{3,}\s*$/
+                       end
+                     },
+            until: :match,
+            inclusive: true })
+  end
+
+  def read(lines)
+    # @type [LogMessage] msg
+    msg, consumed = super(lines)
+
+    is_error = @start_match[1][0] == '!'
+
+    if is_error
+      file_line_match = %r{^(/?(?:.*?/)*[^/]+):(\d+):\s*}.match(msg.message)
+      line = nil
+      if !file_line_match.nil? # if file-line active
+        msg.source_file = file_line_match[1]
+        line = file_line_match[2].to_i
+        msg.message.gsub!(file_line_match[0], '')
+      elsif !@end_match[1].nil?
+        # No file-line format, so use line number from end match
+        line = @end_match[1].to_i
+      end
+      msg.source_lines = { from: line, to: line } unless line.nil?
+
+      msg.level = :error
+
+      msg.message.gsub!(/^.*?For immediate help type.*$/, '')
+      msg.message.gsub!(/^\!\.+\s*$/, '')
+      msg.message.gsub!(/^l\.\d+\s+.*$/, '')
+    else
+      # BROKEN_BY_LINEBREAKS
+      # TODO: may be split across lines --> remove whitespace before extracting
+      line_match = /on line\s+(\d+)\.$/.match(msg.message)
+      unless line_match.nil?
+        line = line_match[1].to_i
+        msg.source_lines = { from: line, to: line }
+      end
+
+      msg.level = :info
+
+      msg.message.gsub!(@end_match[0], '')
+    end
+
+    msg.preformatted = true
+    msg.message.gsub!(@start, '')
+    msg.message.gsub!(/^#{@start_match[1][0]}\s+/, '')
+    msg.message.strip!
+
+    [msg, consumed]
+  end
+end

data/lib/tex_log_parser/patterns/{exclaiming_error.rb → standard_error.rb}

@@ -6,12 +6,20 @@
 #   <inserted text>
 #                   \par
 #   <*> plain.tex
-class ExclaimingError
+#
+# and
+#
+#   ! Font TU/NoSuchFont(0)/m/n/9=NoSuchFont at 9.0pt not loadable: Metric (TFM) fi
+#   le or installed font not found.
+#   <to be read again>
+#                    relax
+#   l.40 \end{document}
+class StandardError
   include RegExpPattern
 
   def initialize
     super(/^\! \w+/,
-          { pattern: ->(_) { /^\s*<\*>\s+([^\s]+)/ }, until: :match, inclusive: true }
+          { pattern: ->(_) { /^\s*<\*>\s+([^\s]+)|^l\.(\d+)\s+/ }, until: :match, inclusive: true }
     )
   end
 
@@ -24,7 +32,11 @@ class ExclaimingError
     msg.message.gsub!(@ending[:pattern][nil], '')
     msg.message.rstrip!
 
-    msg.source_file = @end_match[1]
+    file = @end_match[1]
+    line = @end_match[2].to_i
+
+    msg.source_file = file unless file.nil?
+    msg.source_lines = { from: line, to: line } unless line.nil? || line.zero?
     msg.preformatted = true
 
     [msg, consumed]

data/lib/tex_log_parser/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class TexLogParser
-  VERSION = '1.0.0.pre.9'
+  VERSION = '1.0.0.pre.10'
 end

data/lib/tex_log_parser.rb

@@ -11,37 +11,56 @@ Dir["#{File.expand_path(__dir__)}/tex_log_parser/patterns/*.rb"].each { |p| requ
 class TexLogParser
   include LogParser
 
+  def initialize(log, _options = {})
+    super(log, _options)
+
+    # BROKEN_BY_LINEBREAKS
+    # I'd prefer to have this stateless, but well (see below).
+    @pushed_dummy = false
+  end
+
   def patterns
-    [FileLineError.new,
+    [HighlightedMessages.new,
+     FileLineError.new,
      PrefixedMultiLinePattern.new,
      RunawayParameterError.new,
-     ExclaimingError.new,
+     StandardError.new,
      FatalErrorOccurred.new,
      BadHboxWarning.new]
   end
 
   def scope_changes(line)
-    case line
-    when /^\s*\(([^()]*)\)\s*(.*)$/
-      # A scope opened and closed immediately -- log it, then
-      # continue with rest of the line (there can be multiple such
-      # things in one line, see e.g. 000.log:656)
-      [Regexp.last_match(1), :pop] + (Regexp.last_match(2).strip.empty? ? [] : scope_changes(Regexp.last_match(2)))
-    when /^\s*\(([^()]+?)\s*$/
-      # A scope opened and will be closed later.
-      # Happens on a dedicated line
-      [Regexp.last_match(1)]
-    when /^\s*(\)+)(.*)$/
-      # Scopes close on a dedicated line, except if they don't (cf 000.log:624)
-      # So we have to continue on the rest of the line. Uh oh.
-      ([:pop] * Regexp.last_match(1).length) + scope_changes(Regexp.last_match(2))
-    when /\([^)]*$/
-      # BROKEN_BY_LINEBREAKS
-      # Bad linebreaks can cause trailing ) to spill over. Narf.
-      # e.g. 000.log:502-503
-      ['dummy'] # Compensate the bad pop that will happen next line.
-    else
-      []
-    end
+    result =
+      case line
+      when /^\s*\(([^()]*)\)\s*(.*)$/
+        # A scope opened and closed immediately -- log it, then
+        # continue with rest of the line (there can be multiple such
+        # things in one line, see e.g. 000.log:656)
+        [Regexp.last_match(1), :pop] +
+        (Regexp.last_match(2).strip.empty? ? [] : scope_changes(Regexp.last_match(2)))
+      when /^\s*\(([^()]+?)\s*$/
+        # A scope opened and will be closed later.
+        # Happens on a dedicated line
+        [Regexp.last_match(1)]
+      when /^\s*(\)+)(.*)$/
+        # Scopes close on a dedicated line, except if they don't (cf 000.log:624)
+        # So we have to continue on the rest of the line. Uh oh.
+        ([:pop] * Regexp.last_match(1).length) + scope_changes(Regexp.last_match(2))
+      when /\([^)]*$/
+        # BROKEN_BY_LINEBREAKS
+        # Bad linebreaks can cause trailing ) to spill over. Narf.
+        # e.g. 000.log:502-503
+        pushed_dummy = true
+        ['dummy'] # Compensate the bad pop that will happen next line.
+      when /^[^()]*\)/
+        # BROKEN_BY_LINEBREAKS
+        # Badly broken lines may push ) prefixed by non-whitespace. Narf.
+        [:pop] if @pushed_dummy ? [:pop] : []
+      else
+        []
+      end
+
+    @pushed_dummy = pushed_dummy || false
+    result
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tex_log_parser
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.9
+  version: 1.0.0.pre.10
 platform: ruby
 authors:
 - Raphael Reitzig
@@ -83,12 +83,12 @@ files:
 - lib/tex_log_parser/log_parser.rb
 - lib/tex_log_parser/log_pattern.rb
 - lib/tex_log_parser/patterns/bad_hbox_warning.rb
-- lib/tex_log_parser/patterns/exclaiming_error.rb
 - lib/tex_log_parser/patterns/fatal_error_occurred.rb
 - lib/tex_log_parser/patterns/file_line_error.rb
-- lib/tex_log_parser/patterns/fontspec_error.rb
+- lib/tex_log_parser/patterns/highlighted_messages.rb
 - lib/tex_log_parser/patterns/prefixed_multi_line_pattern.rb
 - lib/tex_log_parser/patterns/runaway_parameter_error.rb
+- lib/tex_log_parser/patterns/standard_error.rb
 - lib/tex_log_parser/version.rb
 homepage: http://github.com/reitzig/texlogparser
 licenses:

data/lib/tex_log_parser/patterns/fontspec_error.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-# TODO: document
-class FontspecError
-  include RegExpPattern
-
-  # TODO: implement
-end