tex_log_parser 1.0.0.pre.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4278834a923e4825ac4e56bcd07e6b7eeb681643
+  data.tar.gz: 38810767f39844e7ec8eac3b78a445f8ebdbf68c
+SHA512:
+  metadata.gz: 701b97b4ab74385a29286fbb30055296ee417881f636f00638d692ece7b74a4fa47b3e68a567c22c403279709240abcd4fad45df80f82d4c6be95fa4a643ab2d
+  data.tar.gz: 0aaa4a74adb27548e8e2487bbf2b3a8782481eb4cce192098b549e250ab39a4bb142ead0796eac745f5f940a3d90ee030274773d853ee7159cb940aad1a4f792

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Raphael R.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,6 @@
+# TeXLogParser
+
+[![Gem Version](https://badge.fury.io/rb/texlogparser.svg)](https://rubygems.org/gems/texlogparser)
+[![Travis build status](https://api.travis-ci.org/reitzig/texlogparser.svg?branch=master)](https://travis-ci.org/reitzig/texlogparser)
+
+TODO write

data/bin/texlogparser

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'tex_log_parser'
+
+# TODO read stdin, parse, write default format (file-line? json?) to stdout
+# TODO options for output format?

data/lib/tex_log_parser/log_message.rb

@@ -0,0 +1,32 @@
+# @attr [String] message
+# @attr [String,nil] source_file
+# @attr [Hash<Symbol, Int>,nil] source_lines
+# @attr [Hash<Symbol, Int>,nil] log_lines
+# @attr [true,false] preformatted
+# @attr [:error,:warning,:info,:debug] level
+class LogMessage
+  def initialize(message:, source_file: nil, source_lines: nil, log_lines: nil, preformatted: false, level: :info)
+    @message = message
+    @source_file = source_file
+    @source_lines = source_lines
+    @log_lines = log_lines
+    @preformatted = preformatted
+    @level = level
+  end
+
+  attr_accessor :message, :source_file, :source_lines, :log_lines,
+                :preformatted, :level
+
+  def to_s
+    lines = if @source_lines.nil?
+              ""
+            else
+              # @type [Hash<Symbol, Int>] @source_lines
+              @source_lines.values.join("-")
+            end
+    <<~MSG
+      #{@source_file}:#{lines} #{@level.to_s.capitalize}
+      #{@message}
+    MSG
+  end
+end

data/lib/tex_log_parser/log_parser.rb

@@ -0,0 +1,74 @@
+# TODO: document
+module LogParser
+  def initialize
+    @files = []
+  end
+
+  # @return [Array<LogPattern>]
+  def patterns
+    raise NotImplementedError
+  end
+
+  # @param [String] line
+  # @return [Array<String,:pop>] A list of new scopes this line enters (strings)
+  #                              and leaves (`:pop`).
+  #                              Read stack operations from left to right.
+  def scope_changes(line)
+    raise NotImplementedError
+  end
+
+  # TODO: document
+  # @param [Array<String>] log_lines
+  # @return [Array<LogMessage>]
+  def parse(log_lines)
+    messages = []
+
+    log_line_number = 1
+    until log_lines.empty?
+      line = log_lines.first
+
+      if line.strip.empty?
+        consumed_lines = 1
+      else
+        # Use the first pattern that matches. Let's hope that's a good heuristic.
+        # If not, we'll have to let all competitors consume and see who wins --
+        # which we'd decide how?
+        matching_pattern = patterns.detect { |p| p.begins_at?(line) }
+
+        if matching_pattern.nil?
+          # In the hope that scope changes happen not on the same
+          # line as messages. Gulp.
+          scope_changes(log_lines.first).each { |op|
+            if op == :pop
+              left = @files.pop
+              #puts "Finished file #{left.nil? ? "nil" : left}" # TODO: debug mode
+              left
+            else
+              #puts "Entered file #{op}" # TODO: debug mode
+              @files.push(op)
+            end
+          }
+
+          # Try again with the next line
+          consumed_lines = 1
+        else
+          # Apply the pattern, i.e. read the next message!
+          # @type [LogMessage] message
+          message, consumed_lines = matching_pattern.read(log_lines)
+          message.log_lines = { from: log_line_number,
+                                to: log_line_number + consumed_lines - 1 }
+          message.source_file ||= @files.last
+
+          messages.push(message)
+        end
+      end
+
+      # Forward the window
+      log_lines.slice!(0, consumed_lines)
+      log_line_number += consumed_lines
+    end
+
+    #puts "Filestack: #{@files}" # TODO: debug mode
+    messages
+  end
+end

data/lib/tex_log_parser/log_pattern.rb

@@ -0,0 +1,65 @@
+require "#{File.expand_path(__dir__)}/log_message.rb"
+
+# TODO: Document
+module LogPattern
+  # TODO: Document
+  # @param [String] line
+  # @return [true,false]
+  def begins_at?(line)
+    raise NotImplementedError
+  end
+
+  # TODO: Document
+  # @param [Array<String>] lines
+  # @return [Array<(LogMessage, Int)>]
+  def read(lines)
+    raise NotImplementedError
+  end
+end
+
+# TODO: document
+# @attr [Regexp] start
+# @attr [MatchData] start_match
+# @attr [Regexp] ending
+module RegExpPattern
+  include LogPattern
+
+  # @param [Regexp] start
+  # @param [Hash] ending
+  # @option ending [Regexp] :pattern
+  # @option ending [:match,:mismatch] :until
+  # @option ending [true,false] :inclusive
+  def initialize(start, ending = { pattern: ->(_) { /^\s+$/ },
+                                   until: :match,
+                                   inclusive: false })
+    @start = start
+    @ending = ending
+  end
+
+  # TODO: document
+  def begins_at?(line)
+    match = @start.match(line)
+    @start_match = match unless match.nil?
+    !match.nil?
+  end
+
+  # TODO: document
+  def ends_at?(line)
+    match = !(@ending[:pattern][@start_match] =~ line).nil?
+    match == (@ending[:until] == :match)
+  end
+
+  # TODO make failable (e.g. EOF)
+  # @param [Array<String>] lines
+  # @return [Array<(LogMessage, Int)>]
+  def read(lines) # TODO: How useful is this? Not very, I'm afraid... there should be functions for source file, line, and level?
+    raise NotImplementedError if @ending.nil?
+
+    ending = lines[1, lines.size].find_index { |l| ends_at?(l) }
+    ending += 1 if @ending[:inclusive]
+
+    # Use ending+1 since ending is the index when we drop the first line!
+    msg = LogMessage.new(message: lines[0, ending+1].join, preformatted: false, level: nil)
+    [msg, ending + 1]
+  end
+end

data/lib/tex_log_parser/patterns/bad_hbox_warning.rb

@@ -0,0 +1,8 @@
+require "#{File.expand_path(__dir__)}/../log_pattern"
+
+# TODO: document
+class BadHboxWarning
+  include RegExpPattern
+
+  # TODO: implement
+end

data/lib/tex_log_parser/patterns/file_line_error.rb

@@ -0,0 +1,27 @@
+require "#{File.expand_path(__dir__)}/../log_pattern"
+
+# Matches messages of this form:
+#
+#   ./plain.tex:31: Undefined control sequence.
+#   l.31 ...t contains some \ref{warnings} and \errors
+#                                                       for testing.
+class FileLineError
+  include RegExpPattern
+
+  def initialize
+    super(/^(\/?(?:.*?\/)*[^\/]+):(\d+):/)
+  end
+
+  def read(lines)
+    # @type [LogMessage] msg
+    msg, consumed = super(lines)
+
+    msg.source_file = @start_match[1]
+    line = @start_match[2].to_i
+    msg.source_lines = { from: line, to: line}
+    msg.preformatted = true
+    msg.level = :error
+
+    [msg, consumed]
+  end
+end

data/lib/tex_log_parser/patterns/fontspec_error.rb

@@ -0,0 +1,8 @@
+require "#{File.expand_path(__dir__)}/../log_pattern"
+
+# TODO: document
+class FontspecError
+  include RegExpPattern
+
+  # TODO: implement
+end

data/lib/tex_log_parser/patterns/prefixed_multi_line_pattern.rb

@@ -0,0 +1,51 @@
+require "#{File.expand_path(__dir__)}/../log_pattern"
+
+# Matches messages of this form:
+#
+#     Package tocbasic Info: omitting babel extension for `toc'
+#     (tocbasic)             because of feature `nobabel' available
+#     (tocbasic)             for `toc' on input line 132.
+#
+# Note: currently fails if lines get broken badly, e.g. in 000.log:634.
+class PrefixedMultiLinePattern
+  include RegExpPattern
+
+  def initialize
+    super(/(Package|Class|\w+TeX)\s+(?:(\w+)\s+)?(Warning|Error|Info|Message)/,
+          { pattern: ->(m) { /^\s*\(#{m[2]}\)/ }, # BROKEN_BY_LINEBREAKS
+            until: :mismatch,
+            inclusive: false })
+  end
+
+  def read(lines)
+    # @type [LogMessage] msg
+    # @type [Int] consumed
+    msg, consumed = super(lines)
+
+    case @start_match[3]
+    when 'Error'
+      msg.level = :error
+    when 'Warning'
+      msg.level = :warning
+    when 'Info', 'Message'
+      msg.level = :info
+    else
+      # TODO: abort?
+      # TODO: debug output
+    end
+
+    # source file from scope, parser does it
+
+    # BROKEN_BY_LINEBREAKS
+    # TODO: may be split across lines --> remove whitespace before extracting
+    suffix_match = /on input line\s+(\d+)(?:\.\s*)?\z/.match(msg.message)
+    unless suffix_match.nil?
+      line = suffix_match[1].to_i
+      msg.source_lines = { from: line, to: line }
+    end
+
+    # TODO: message itself contains useless line prefixes --> remove
+
+    [msg, consumed]
+  end
+end

data/lib/tex_log_parser/patterns/runaway_parameter_error.rb

@@ -0,0 +1,8 @@
+require "#{File.expand_path(__dir__)}/../log_pattern"
+
+# TODO: document
+class RunawayParameterError
+  include RegExpPattern
+
+  # TODO: implement
+end

data/lib/tex_log_parser.rb

@@ -0,0 +1,41 @@
+require 'tex_log_parser/log_parser'
+Dir["#{File.expand_path(__dir__)}/tex_log_parser/patterns/*.rb"].each { |p| require p }
+
+# TODO: document
+class TexLogParser
+  include LogParser
+
+  def patterns
+    [FileLineError.new, PrefixedMultiLinePattern.new]
+  end
+
+  def scope_changes(line)
+    ops = 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)
+            [$1, :pop] + ($2.strip.empty? ? [] : scope_changes($2))
+          when /^\s*\(([^()]+?)\s*$/
+            # A scope opened and will be closed later.
+            # Happens on a dedicated line
+            [$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] * $1.length) + scope_changes($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
+
+    # puts line # TODO: debug mode
+    # puts ops.to_s
+    # puts ""
+    ops
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: tex_log_parser
+version: !ruby/object:Gem::Version
+  version: 1.0.0.pre.1
+platform: ruby
+authors:
+- Raphael Reitzig
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Parses log files of (La)TeX engines
+email: 4246780+reitzig@users.noreply.github.com
+executables:
+- texlogparser
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/texlogparser
+- lib/tex_log_parser.rb
+- lib/tex_log_parser/log_message.rb
+- 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/file_line_error.rb
+- lib/tex_log_parser/patterns/fontspec_error.rb
+- lib/tex_log_parser/patterns/prefixed_multi_line_pattern.rb
+- lib/tex_log_parser/patterns/runaway_parameter_error.rb
+homepage: http://github.com/reitzig/texlogparser
+licenses:
+- MIT
+metadata:
+  yard.run: yri
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.1
+signing_key: 
+specification_version: 4
+summary: Parses log files of (La)TeX engines
+test_files: []