tex_log_parser 1.0.0.pre.1 → 1.0.0.pre.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4278834a923e4825ac4e56bcd07e6b7eeb681643
-  data.tar.gz: 38810767f39844e7ec8eac3b78a445f8ebdbf68c
+  metadata.gz: 062e87fb6cd767aacf4df4306f06812861c0f435
+  data.tar.gz: 36c8a772c8a16b79b112288a4673603050b181d2
 SHA512:
-  metadata.gz: 701b97b4ab74385a29286fbb30055296ee417881f636f00638d692ece7b74a4fa47b3e68a567c22c403279709240abcd4fad45df80f82d4c6be95fa4a643ab2d
-  data.tar.gz: 0aaa4a74adb27548e8e2487bbf2b3a8782481eb4cce192098b549e250ab39a4bb142ead0796eac745f5f940a3d90ee030274773d853ee7159cb940aad1a4f792
+  metadata.gz: d2dbe0b0507532726115f4c45652ba3d5d642db99ff43e9298a628f2fc3891d6e0b97e0fe4226cb91d1c81f8afa32be6bfc38093b2a6bb897edb6356e61eeb8f
+  data.tar.gz: 1251c33e7e6803f91f309b8d5920febfb45e6d0e4a14eb9c24bbaea5aa83a47f2fe290ae0d7d1b97e59d81170fc54ff71d35f7309c8741ba27afd9adb2cc7c03

data/README.md

@@ -1,6 +1,20 @@
 # TeXLogParser
 
-[![Gem Version](https://badge.fury.io/rb/texlogparser.svg)](https://rubygems.org/gems/texlogparser)
+[![Gem Version](https://badge.fury.io/rb/tex_log_parser.svg)](https://badge.fury.io/rb/tex_log_parser)
+[![Yard docs](http://img.shields.io/badge/yard-docs-green.svg)](http://www.rubydoc.info/gems/tex_log_parser/1.0.0.pre.1) **˙**
+[![Maintainability](https://api.codeclimate.com/v1/badges/748992a2c5f6570797d4/maintainability)](https://codeclimate.com/github/reitzig/texlogparser/maintainability) 
+[![Test Coverage](https://api.codeclimate.com/v1/badges/748992a2c5f6570797d4/test_coverage)](https://codeclimate.com/github/reitzig/texlogparser/test_coverage) **˙**
 [![Travis build status](https://api.travis-ci.org/reitzig/texlogparser.svg?branch=master)](https://travis-ci.org/reitzig/texlogparser)
+[![Inline docs](http://inch-ci.org/github/reitzig/texlogparser.svg?branch=master)](http://inch-ci.org/github/reitzig/texlogparser)
 
-TODO write
+Eases the many pains around logs from (La)TeX engines. 
+
+## Usage
+
+ * Use `texlogparser` on the CLI.
+ * Use `TexLogParser` from Ruby scripts.
+
+## Contributing
+
+ 1. TeXians: Report wrong parsing (w/ excerpt and full log incl expectations).
+ 2. Rubyists: Review API, documentation, gem setup, etc.

data/bin/texlogparser

@@ -1,6 +1,75 @@
 #!/usr/bin/env ruby
 
+if $PROGRAM_NAME == __FILE__
+  $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+end
+
 require 'tex_log_parser'
+require 'optparse'
+require 'json'
+
+# Defaults
+options = {
+  debug: false,
+  format: :file_line,
+  input: STDIN,
+  output: STDOUT
+}
+formats = [:file_line, :json]
+
+OptionParser.new do |opts|
+  opts.banner = 'Usage: texlogparser [options]'
+  opts.on('-d', '--debug', 'Output debug information') do
+    options[:debug] = true
+  end
+  opts.on('-f ENUM', '--format ENUM', formats,
+          'Output format', "One of: #{formats.map { |e| e.to_s }.join(", ")}") do |format|
+    options[:format] = format
+  end
+  opts.on('-i', '--input PATH', 'Read input from PATH') do |path|
+    unless File.file?(path)
+      STDERR.puts("No such file: #{path}")
+      exit 1
+    end
+
+    options[:input] = path
+  end
+  opts.on('-o', '--output PATH', 'Write output to PATH') do |path|
+    options[:output] = path
+  end
+  opts.on_tail('-h', '--help', 'Show this message') do
+    puts opts
+    exit
+  end
+  opts.on_tail('-v', '--version', 'Show version') do
+    puts TexLogParser::VERSION
+    exit
+  end
+
+  begin
+    opts.parse!
+  rescue => e
+    STDERR.puts e
+    exit 1
+  end
+
+  if !options[:input].is_a?(String) && STDIN.tty?
+    STDERR.puts opts.help
+    exit 1
+  end
+end
+
+input = STDIN
+input = File.open(options[:input], 'r') if options[:input].is_a?(String)
+parser = TexLogParser.new(input, options)
+messages = parser.parse
 
-# TODO read stdin, parse, write default format (file-line? json?) to stdout
-# TODO options for output format?
+output = STDOUT
+output = File.open(options[:output], 'w') if options[:output].is_a?(String)
+case options[:format]
+when :file_line
+  output.write(messages.map { |m| m.to_s }.join("\n\n"))
+when :json
+  output.write(JSON.pretty_generate(messages))
+end
+output.close

data/lib/tex_log_parser/log_buffer.rb

@@ -0,0 +1,56 @@
+class LogBuffer
+  # @param [Array<String>,IO] log
+  def initialize(log)
+    @buffer = []
+    @stream = nil
+
+    @buffer = log if log.is_a?(Array)
+    @stream = log if log.is_a?(IO) || log.is_a?(StringIO)
+  end
+
+  def empty?
+    @buffer.empty? && stream_is_done?
+  end
+
+  def first
+    self[0]
+  end
+
+  def find_index(starting_from = 0)
+    index = starting_from
+    element = self[index]
+
+    until element.nil?
+      return index if yield(element)
+      index += 1
+      element = self[index]
+    end
+
+    nil
+  end
+
+  def [](offset, length = nil)
+    base_length = length || 1
+    while offset + base_length > @buffer.size
+      return (length.nil? ? nil : @buffer[offset, @buffer.size]) if stream_is_done?
+      @buffer.push(@stream.readline.rstrip)
+    end
+
+    length.nil? ? @buffer[offset] : @buffer[offset, length]
+  end
+
+  def forward(offset = 1)
+    self[offset]
+    @buffer.slice!(0, offset)
+  end
+
+  def close
+    @stream.close unless @stream.nil? || @stream.closed?
+  end
+
+  private
+
+  def stream_is_done?
+    @stream.nil? || @stream.closed? || @stream.eof?
+  end
+end

data/lib/tex_log_parser/log_message.rb

@@ -1,17 +1,24 @@
+require 'json'
+
 # @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
+# @attr [Class] pattern
 class LogMessage
-  def initialize(message:, source_file: nil, source_lines: nil, log_lines: nil, preformatted: false, level: :info)
+  def initialize(message:, source_file: nil, source_lines: nil, log_lines: nil,
+                 preformatted: false, level: :info, pattern: nil)
     @message = message
     @source_file = source_file
     @source_lines = source_lines
     @log_lines = log_lines
     @preformatted = preformatted
     @level = level
+    @pattern = pattern
+
+    @debug = false # TODO: get option here
   end
 
   attr_accessor :message, :source_file, :source_lines, :log_lines,
@@ -19,14 +26,31 @@ class LogMessage
 
   def to_s
     lines = if @source_lines.nil?
-              ""
+              ''
             else
               # @type [Hash<Symbol, Int>] @source_lines
-              @source_lines.values.join("-")
+              ":#{@source_lines.values.uniq.join('-')}"
             end
+
+    message = @message
+    message = message.split("\n").map {|l| l.strip }.join("") unless @preformatted
+    message += "\nLog pattern: '#{@pattern}'" if @debug
+
     <<~MSG
-      #{@source_file}:#{lines} #{@level.to_s.capitalize}
-      #{@message}
+      #{@source_file}#{lines}: #{@level.to_s.upcase}
+      #{message}
     MSG
   end
+
+  def to_json(options={})
+    hash = {
+        level: @level,
+        source_file: @source_file,
+        source_lines: @source_lines,
+        message: @message,
+        log_lines: @log_lines,
+        preformatted: @preformatted
+    }
+    JSON.pretty_generate hash
+  end
 end

data/lib/tex_log_parser/log_parser.rb

@@ -1,7 +1,22 @@
+require "#{File.expand_path(__dir__)}/log_buffer.rb"
+
 # TODO: document
 module LogParser
-  def initialize
+  attr_reader :messages
+
+  # TODO: document
+  # @param [Array<String>,IO,StringIO] log
+  # @param [Hash] options
+  def initialize(log, options)
     @files = []
+
+    @messages = []
+    @log_line_number = 0
+    @lines = LogBuffer.new(log)
+
+    @debug = options.fetch(:debug, false)
+
+    puts "Parsing from '#{log}'" if @debug
   end
 
   # @return [Array<LogPattern>]
@@ -18,57 +33,78 @@ module LogParser
   end
 
   # TODO: document
-  # @param [Array<String>] log_lines
   # @return [Array<LogMessage>]
-  def parse(log_lines)
-    messages = []
+  def parse
+    raise 'Parser already ran!' unless @log_line_number.zero?
 
-    log_line_number = 1
-    until log_lines.empty?
-      line = log_lines.first
+    @log_line_number = 1
+    until @lines.empty?
+      line = @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
+        remove_consumed_lines 1
+        next
       end
 
-      # Forward the window
-      log_lines.slice!(0, consumed_lines)
-      log_line_number += consumed_lines
+      puts "\nLine: '#{line.strip}'" if @debug
+
+      # 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?
+        puts '- No pattern matches' if @debug
+        apply_scope_changes
+      else
+        puts "- Matched pattern: '#{matching_pattern.class}'" if @debug
+        consume_pattern(matching_pattern)
+      end
     end
 
-    #puts "Filestack: #{@files}" # TODO: debug mode
+    puts "\nFiles that did not close: #{@files}" if @debug
+    @lines.close
     messages
   end
+
+  private
+
+  def remove_consumed_lines(i)
+    @lines.forward(i)
+    @log_line_number += i
+  end
+
+  def consume_pattern(pattern)
+    # Apply the pattern, i.e. read the next message!
+    begin
+      # @type [LogMessage] message
+      message, consumed_lines = pattern.read(@lines)
+      message.log_lines = { from: @log_line_number,
+                            to: @log_line_number + consumed_lines - 1 }
+      message.source_file ||= @files.last
+
+      puts message if @debug
+      @messages.push(message)
+      remove_consumed_lines consumed_lines
+    rescue => e
+      puts "#{e}" if @debug
+      remove_consumed_lines 1
+    end
+  end
+
+  def apply_scope_changes
+    # In the hope that scope changes happen not on the same
+    # line as messages. Gulp.
+    scope_changes(@lines.first).each do |op|
+      if op == :pop
+        left = @files.pop
+        puts "- Finished source file: '#{left.nil? ? 'nil' : left}'" if @debug
+      else # op is file name
+        puts "- Entered source file: '#{op}'" if @debug
+        @files.push(op)
+      end
+    end
+
+    remove_consumed_lines 1
+  end
 end

data/lib/tex_log_parser/log_pattern.rb

@@ -29,11 +29,12 @@ module RegExpPattern
   # @option ending [Regexp] :pattern
   # @option ending [:match,:mismatch] :until
   # @option ending [true,false] :inclusive
-  def initialize(start, ending = { pattern: ->(_) { /^\s+$/ },
+  def initialize(start, ending = { pattern: ->(_) { /^\s*$/ },
                                    until: :match,
                                    inclusive: false })
     @start = start
     @ending = ending
+    @debug = false # TODO: Get the option here
   end
 
   # TODO: document
@@ -50,16 +51,17 @@ module RegExpPattern
   end
 
   # TODO make failable (e.g. EOF)
-  # @param [Array<String>] lines
+  # @param [LogBuffer] 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?
+  def read(lines)
     raise NotImplementedError if @ending.nil?
 
-    ending = lines[1, lines.size].find_index { |l| ends_at?(l) }
-    ending += 1 if @ending[:inclusive]
+    ending = lines.find_index(1) { |l| ends_at?(l) }
+    raise "Did not find end of message (pattern '#{self.class}')." if ending.nil?
+    ending -= 1 unless @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 = LogMessage.new(message: lines[0, ending + 1].join("\n"), preformatted: true, level: nil)
     [msg, ending + 1]
   end
 end

data/lib/tex_log_parser/patterns/prefixed_multi_line_pattern.rb

@@ -44,7 +44,7 @@ class PrefixedMultiLinePattern
       msg.source_lines = { from: line, to: line }
     end
 
-    # TODO: message itself contains useless line prefixes --> remove
+    # TODO: message itself contains useless line prefixes --> remove, preformatted = false
 
     [msg, consumed]
   end

data/lib/tex_log_parser/version.rb

@@ -0,0 +1,3 @@
+class TexLogParser
+  VERSION = '1.0.0.pre.2'
+end

data/lib/tex_log_parser.rb

@@ -1,4 +1,5 @@
 require 'tex_log_parser/log_parser'
+require 'tex_log_parser/version'
 Dir["#{File.expand_path(__dir__)}/tex_log_parser/patterns/*.rb"].each { |p| require p }
 
 # TODO: document
@@ -10,32 +11,27 @@ class TexLogParser
   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
+    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
   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.1
+  version: 1.0.0.pre.2
 platform: ruby
 authors:
 - Raphael Reitzig
@@ -14,44 +14,58 @@ dependencies:
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.10'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 description: Parses log files of (La)TeX engines
 email: 4246780+reitzig@users.noreply.github.com
 executables:
@@ -63,6 +77,7 @@ files:
 - README.md
 - bin/texlogparser
 - lib/tex_log_parser.rb
+- lib/tex_log_parser/log_buffer.rb
 - lib/tex_log_parser/log_message.rb
 - lib/tex_log_parser/log_parser.rb
 - lib/tex_log_parser/log_pattern.rb
@@ -71,6 +86,7 @@ files:
 - 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
+- lib/tex_log_parser/version.rb
 homepage: http://github.com/reitzig/texlogparser
 licenses:
 - MIT