tex_log_parser 1.0.0.pre.2 → 1.0.0.pre.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 062e87fb6cd767aacf4df4306f06812861c0f435
-  data.tar.gz: 36c8a772c8a16b79b112288a4673603050b181d2
+  metadata.gz: 1771cd7fe895030d25eb1487e9af597b0617e5ff
+  data.tar.gz: acb8d3e74d985533efd9e45b613dfcf086aaf75d
 SHA512:
-  metadata.gz: d2dbe0b0507532726115f4c45652ba3d5d642db99ff43e9298a628f2fc3891d6e0b97e0fe4226cb91d1c81f8afa32be6bfc38093b2a6bb897edb6356e61eeb8f
-  data.tar.gz: 1251c33e7e6803f91f309b8d5920febfb45e6d0e4a14eb9c24bbaea5aa83a47f2fe290ae0d7d1b97e59d81170fc54ff71d35f7309c8741ba27afd9adb2cc7c03
+  metadata.gz: 740853668e14c12939f5284030a9adce6cc43e3eca3db4f837a3220d01a31734adaed14e87379fd16962472337c67a0148f38642f444672e7d4c40f84ead69b4
+  data.tar.gz: c47346069d27184a711e51b66c63ac9a2c55f622f08f1b227173baa4808571909eafddddfab3c4493f338b8dab2be9068b3b9f939b69aba076f8972d4b32b6a4

data/README.md

@@ -1,7 +1,7 @@
 # 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) **˙**
+[![Yard docs](http://img.shields.io/badge/yard-docs-green.svg)](http://www.rubydoc.info/gems/tex_log_parser/1.0.0.pre.2) **˙**
 [![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)

data/bin/texlogparser

@@ -1,29 +1,26 @@
 #!/usr/bin/env ruby
-
-if $PROGRAM_NAME == __FILE__
-  $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-end
+# frozen_string_literal: true
 
 require 'tex_log_parser'
+require 'tex_log_parser/version'
 require 'optparse'
 require 'json'
 
 # Defaults
 options = {
-  debug: false,
   format: :file_line,
   input: STDIN,
   output: STDOUT
 }
-formats = [:file_line, :json]
+formats = %i[file_line json]
 
 OptionParser.new do |opts|
   opts.banner = 'Usage: texlogparser [options]'
   opts.on('-d', '--debug', 'Output debug information') do
-    options[:debug] = true
+    Logger.debugging = true
   end
   opts.on('-f ENUM', '--format ENUM', formats,
-          'Output format', "One of: #{formats.map { |e| e.to_s }.join(", ")}") do |format|
+          'Output format', "One of: #{formats.map(&:to_s).join(', ')}") do |format|
     options[:format] = format
   end
   opts.on('-i', '--input PATH', 'Read input from PATH') do |path|
@@ -48,7 +45,7 @@ OptionParser.new do |opts|
 
   begin
     opts.parse!
-  rescue => e
+  rescue StandardError => e
     STDERR.puts e
     exit 1
   end
@@ -68,8 +65,9 @@ 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"))
+  output.write(messages.map(&:to_s).join("\n\n"))
+  # TODO: print summary?
 when :json
   output.write(JSON.pretty_generate(messages))
 end
-output.close
+output.close

data/lib/logger.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# A simple helper, probably to be replaced by a proper logging library
+# at some point.
+#
+# @attr [true,false] debug
+class Logger
+  class << self
+    attr_accessor :debugging
+
+    # Logs the given message to STDOUT if `debug` is true.
+    # @param [String] message
+    def debug(message)
+      puts message if debugging || !ENV['DEBUG'].nil?
+    end
+  end
+end

data/lib/tex_log_parser/log_buffer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class LogBuffer
   # @param [Array<String>,IO] log
   def initialize(log)
@@ -12,6 +14,10 @@ class LogBuffer
     @buffer.empty? && stream_is_done?
   end
 
+  def buffer_size
+    @buffer.size
+  end
+
   def first
     self[0]
   end
@@ -53,4 +59,4 @@ class LogBuffer
   def stream_is_done?
     @stream.nil? || @stream.closed? || @stream.eof?
   end
-end
+end

data/lib/tex_log_parser/log_message.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 
 # @attr [String] message
@@ -17,8 +19,6 @@ class LogMessage
     @preformatted = preformatted
     @level = level
     @pattern = pattern
-
-    @debug = false # TODO: get option here
   end
 
   attr_accessor :message, :source_file, :source_lines, :log_lines,
@@ -33,8 +33,8 @@ class LogMessage
             end
 
     message = @message
-    message = message.split("\n").map {|l| l.strip }.join("") unless @preformatted
-    message += "\nLog pattern: '#{@pattern}'" if @debug
+    message = message.split("\n").map(&:strip).join(' ') unless @preformatted
+    message += "\nLog pattern: '#{@pattern}'" if Logger.debugging
 
     <<~MSG
       #{@source_file}#{lines}: #{@level.to_s.upcase}
@@ -42,15 +42,16 @@ class LogMessage
     MSG
   end
 
-  def to_json(options={})
+  def to_json(_options = {})
     hash = {
-        level: @level,
-        source_file: @source_file,
-        source_lines: @source_lines,
-        message: @message,
-        log_lines: @log_lines,
-        preformatted: @preformatted
+      level: @level,
+      source_file: @source_file,
+      source_lines: @source_lines,
+      message: @message,
+      log_lines: @log_lines,
+      preformatted: @preformatted
     }
+    hash[:pattern] = @pattern if Logger.debugging
     JSON.pretty_generate hash
   end
-end
+end

data/lib/tex_log_parser/log_parser.rb

@@ -1,4 +1,4 @@
-require "#{File.expand_path(__dir__)}/log_buffer.rb"
+# frozen_string_literal: true
 
 # TODO: document
 module LogParser
@@ -6,17 +6,15 @@ module LogParser
 
   # TODO: document
   # @param [Array<String>,IO,StringIO] log
-  # @param [Hash] options
-  def initialize(log, options)
+  # @param [Hash] _options
+  def initialize(log, _options = {})
     @files = []
 
     @messages = []
-    @log_line_number = 0
+    @log_line_number = 1
     @lines = LogBuffer.new(log)
 
-    @debug = options.fetch(:debug, false)
-
-    puts "Parsing from '#{log}'" if @debug
+    Logger.debug "Parsing from '#{log}'"
   end
 
   # @return [Array<LogPattern>]
@@ -24,72 +22,92 @@ module LogParser
     raise NotImplementedError
   end
 
-  # @param [String] line
+  # @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)
+  def scope_changes(_line)
     raise NotImplementedError
   end
 
+  def empty?
+    @lines.empty?
+  end
+
   # TODO: document
   # @return [Array<LogMessage>]
   def parse
-    raise 'Parser already ran!' unless @log_line_number.zero?
+    skip_empty_lines
+    until empty?
+      parse_next_lines
+      skip_empty_lines
+    end
 
-    @log_line_number = 1
-    until @lines.empty?
-      line = @lines.first
+    @messages
+  end
 
-      if line.strip.empty?
-        remove_consumed_lines 1
-        next
-      end
+  private
 
-      puts "\nLine: '#{line.strip}'" if @debug
+  def skip_empty_lines
+    @lines.first
 
-      # 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) }
+    first_nonempty_line = @lines.find_index { |line| /[^\s]/ =~ line }
+    remove_consumed_lines(first_nonempty_line || @lines.buffer_size)
+  end
 
-      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
+  # TODO: document
+  # @return [LogMessage,nil]
+  def parse_next_lines
+    raise 'Parse already done!' if @lines.empty?
+
+    line = @lines.first
+    Logger.debug "\nLine: '#{line.strip}'"
+    msg = nil
+
+    # 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?
+      Logger.debug '- No pattern matches'
+      apply_scope_changes
+    else
+      Logger.debug "- Matched pattern: '#{matching_pattern.class}'"
+      msg = consume_pattern(matching_pattern)
+      @messages.push(msg) unless msg.nil?
     end
 
-    puts "\nFiles that did not close: #{@files}" if @debug
-    @lines.close
-    messages
-  end
+    if @lines.empty?
+      @lines.close
+      Logger.debug "\nFiles that did not close: #{@files}"
+    end
 
-  private
+    msg
+  end
 
   def remove_consumed_lines(i)
     @lines.forward(i)
     @log_line_number += i
   end
 
+  # @return [LogMessage,nil]
   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
+
+    # @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
+
+    Logger.debug message
+    remove_consumed_lines consumed_lines
+    return message
+  rescue StandardError => e
+    Logger.debug e.to_s
+    remove_consumed_lines 1
+    return nil
   end
 
   def apply_scope_changes
@@ -98,13 +116,13 @@ module LogParser
     scope_changes(@lines.first).each do |op|
       if op == :pop
         left = @files.pop
-        puts "- Finished source file: '#{left.nil? ? 'nil' : left}'" if @debug
+        Logger.debug "- Finished source file: '#{left.nil? ? 'nil' : left}'"
       else # op is file name
-        puts "- Entered source file: '#{op}'" if @debug
+        Logger.debug "- Entered source file: '#{op}'"
         @files.push(op)
       end
     end
 
     remove_consumed_lines 1
   end
-end
+end

data/lib/tex_log_parser/log_pattern.rb

@@ -1,18 +1,18 @@
-require "#{File.expand_path(__dir__)}/log_message.rb"
+# frozen_string_literal: true
 
 # TODO: Document
 module LogPattern
   # TODO: Document
-  # @param [String] line
+  # @param [String] _line
   # @return [true,false]
-  def begins_at?(line)
+  def begins_at?(_line)
     raise NotImplementedError
   end
 
   # TODO: Document
-  # @param [Array<String>] lines
+  # @param [Array<String>] _lines
   # @return [Array<(LogMessage, Int)>]
-  def read(lines)
+  def read(_lines)
     raise NotImplementedError
   end
 end
@@ -34,7 +34,7 @@ module RegExpPattern
                                    inclusive: false })
     @start = start
     @ending = ending
-    @debug = false # TODO: Get the option here
+    @ending = ending
   end
 
   # TODO: document
@@ -50,7 +50,7 @@ module RegExpPattern
     match == (@ending[:until] == :match)
   end
 
-  # TODO make failable (e.g. EOF)
+  # TODO: make failable (e.g. EOF)
   # @param [LogBuffer] lines
   # @return [Array<(LogMessage, Int)>]
   def read(lines)
@@ -61,7 +61,8 @@ module RegExpPattern
     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("\n"), preformatted: true, level: nil)
+    msg = LogMessage.new(message: lines[0, ending + 1].join("\n"),
+                         preformatted: true, level: nil, pattern: self.class)
     [msg, ending + 1]
   end
-end
+end

data/lib/tex_log_parser/patterns/bad_hbox_warning.rb

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

data/lib/tex_log_parser/patterns/file_line_error.rb

@@ -1,4 +1,4 @@
-require "#{File.expand_path(__dir__)}/../log_pattern"
+# frozen_string_literal: true
 
 # Matches messages of this form:
 #
@@ -9,7 +9,7 @@ class FileLineError
   include RegExpPattern
 
   def initialize
-    super(/^(\/?(?:.*?\/)*[^\/]+):(\d+):/)
+    super(%r{^(/?(?:.*?/)*[^/]+):(\d+):})
   end
 
   def read(lines)
@@ -18,10 +18,10 @@ class FileLineError
 
     msg.source_file = @start_match[1]
     line = @start_match[2].to_i
-    msg.source_lines = { from: line, to: line}
+    msg.source_lines = { from: line, to: line }
     msg.preformatted = true
     msg.level = :error
 
     [msg, consumed]
   end
-end
+end

data/lib/tex_log_parser/patterns/fontspec_error.rb

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

data/lib/tex_log_parser/patterns/prefixed_multi_line_pattern.rb

@@ -1,4 +1,4 @@
-require "#{File.expand_path(__dir__)}/../log_pattern"
+# frozen_string_literal: true
 
 # Matches messages of this form:
 #
@@ -31,7 +31,7 @@ class PrefixedMultiLinePattern
       msg.level = :info
     else
       # TODO: abort?
-      # TODO: debug output
+      Logger.debug 'Unhandled message type!'
     end
 
     # source file from scope, parser does it
@@ -48,4 +48,4 @@ class PrefixedMultiLinePattern
 
     [msg, consumed]
   end
-end
+end

data/lib/tex_log_parser/patterns/runaway_parameter_error.rb

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

data/lib/tex_log_parser/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class TexLogParser
-  VERSION = '1.0.0.pre.2'
-end
+  VERSION = '1.0.0.pre.7'
+end

data/lib/tex_log_parser.rb

@@ -1,5 +1,10 @@
+# frozen_string_literal: true
+
+require 'logger'
+require 'tex_log_parser/log_buffer'
+require 'tex_log_parser/log_message'
 require 'tex_log_parser/log_parser'
-require 'tex_log_parser/version'
+require 'tex_log_parser/log_pattern'
 Dir["#{File.expand_path(__dir__)}/tex_log_parser/patterns/*.rb"].each { |p| require p }
 
 # TODO: document
@@ -16,22 +21,22 @@ class TexLogParser
       # 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))
+      [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
-      [$1]
+      [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] * $1.length) + scope_changes($2)
+      ([: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.
+      ['dummy'] # Compensate the bad pop that will happen next line.
     else
       []
     end
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tex_log_parser
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.2
+  version: 1.0.0.pre.7
 platform: ruby
 authors:
 - Raphael Reitzig
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-01 00:00:00.000000000 Z
+date: 2018-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -76,6 +76,7 @@ files:
 - LICENSE
 - README.md
 - bin/texlogparser
+- lib/logger.rb
 - lib/tex_log_parser.rb
 - lib/tex_log_parser/log_buffer.rb
 - lib/tex_log_parser/log_message.rb