New test. RuboCop-induced style improvements.

 - RegExpPattern felt fragile, so I added a unit test.
 - A bunch of auto-fixes.
 - Some re-configuration where I didn't like the defaults.
 - Actually simplifies some methods.
 - Moves debug printing to a separate class.

Author: reitzig

.rubocop.yml

@@ -1,2 +1,18 @@
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.3
+
+# The default, 80, is a nice-to-have but not really all that relevant
+# on today's wide screens. Use 120 as a "hard" cap and try to be shorter.
+Metrics/LineLength:
+  Max: 120
+
+# The default, 10, seems silly here.
+Metrics/MethodLength:
+  Max: 25
+
+Style/RegexpLiteral:
+  EnforcedStyle: mixed
+
+# I'd rather have empty else branches than forget one.
+Style/EmptyElse:
+  Enabled: false

Gemfile

@@ -1,2 +1,4 @@
-source "https://rubygems.org"
-gemspec
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+gemspec

Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rake/testtask'
 require 'yard'
 
@@ -10,8 +12,8 @@ end
 
 desc 'Build documentation'
 YARD::Rake::YardocTask.new do |t|
-  #t.files   = ['lib/**/*.rb', OTHER_PATHS]   # optional
-  #t.options = ['--any', '--extra', '--opts'] # optional
+  # t.files   = ['lib/**/*.rb', OTHER_PATHS]   # optional
+  # t.options = ['--any', '--extra', '--opts'] # optional
 end
 
-task :default => :test
+task default: :test

bin/texlogparser

@@ -1,25 +1,26 @@
 #!/usr/bin/env ruby
+# 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|
@@ -44,7 +45,7 @@ OptionParser.new do |opts|
 
   begin
     opts.parse!
-  rescue => e
+  rescue StandardError => e
     STDERR.puts e
     exit 1
   end
@@ -64,9 +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

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

lib/tex_log_parser.rb

@@ -1,6 +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/log_pattern"
+require 'tex_log_parser/log_pattern'
 Dir["#{File.expand_path(__dir__)}/tex_log_parser/patterns/*.rb"].each { |p| require p }
 
 # TODO: document
@@ -17,22 +21,22 @@ def scope_changes(line)
       # 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

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 @@ def empty?
     @buffer.empty? && stream_is_done?
   end
 
+  def buffer_size
+    @buffer.size
+  end
+
   def first
     self[0]
   end
@@ -53,4 +59,4 @@ def close
   def stream_is_done?
     @stream.nil? || @stream.closed? || @stream.eof?
   end
-end
+end

lib/tex_log_parser/log_message.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 
 # @attr [String] message
@@ -17,8 +19,6 @@ def initialize(message:, source_file: nil, source_lines: nil, log_lines: nil,
     @preformatted = preformatted
     @level = level
     @pattern = pattern
-
-    @debug = false # TODO: get option here
   end
 
   attr_accessor :message, :source_file, :source_lines, :log_lines,
@@ -33,24 +33,25 @@ def to_s
             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}
       #{message}
     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