tex_log_parser 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5349c90251df9e2fe46d639060b8a85f3bbbe4a412d21dffdcc893e97c1182cf
-  data.tar.gz: 3ccac71aab3d842cbd7e4e2e569404828b4ca2f68875368cbe59f7edabc04a7f
+  metadata.gz: 6d2c2a92c84683d3392c7372ea2a3920d14a285193aedfd96deffdb2298a9d1a
+  data.tar.gz: 8e700667425901781af7e0a4d297fc92973502d7da6e2fc266ba40d8937202ae
 SHA512:
-  metadata.gz: a6398999fd6f0d6f53e8d65d537751fe901bcc610100cdc72d5f9056ecef22c7cc36065d54dbceb881b7e365d34858b7c235dd434c1c98f84b9bf39099ce1139
-  data.tar.gz: 514733d5618560983580c9918adc40c064f9a4f1cb59e8f28d234e94a4abf363ff3920c06f47e56eb57dbe35435bb44d0655413ed86f04c689f5fdf42e04595a
+  metadata.gz: b8895e5afd489068f5f6eb20974ca1beca2838d87499c4193d68f2d6bffa0b5e8323d021a16fdd4624e24f0de9650617b6d26d4c4a4a89736068828806fb847d
+  data.tar.gz: 03f913573f1e1cfc49ea63a196b88deae53f314cadbe49b22aa04b13e24d36878822ec737b0d22c2e6ea8f06add4fe8a4dee23a0036c92cbcdedb0bc07caadd7

data/README.md

@@ -40,6 +40,10 @@ This adds so little runtime overhead that there are few reasons _not_ to use it.
 Note that the original log file will still be written to `example.log`, 
 so no information is lost.
 
+**Important:** Without `nonstopmode`, `pdflatex` et al. stop on errors to interact
+with the user; `texlogparser` is not prepared to play the middle man for that and
+will block.
+
 You can also read from and/or write to files:
 
 ```bash
@@ -51,16 +55,38 @@ cat example.log | texlogparser -o example.simple.log # From stdin, to file
 If you want to use the output programmatically, you may want to add option `-f json`.
 It does just what it sounds like.
 
- 
 ### Ruby API
 
+The interface is rather narrow; your main entry point is class 
+    [TexLogParser](http://www.rubydoc.info/gems/tex_log_parser/TexLogParser).
+Calling `parse` on it will yield a list of 
+    [Message](http://www.rubydoc.info/gems/tex_log_parser/LogParser/Message) 
+objects.
+
+Here is a minimal yet complete example:
+
+```ruby
+require 'tex_log_parser'
+
+log = File.readlines('example.log')
+parser = TexLogParser.new(log)
+puts parser.parse[0]
+```
+
 ### Recommendations
 
+Here are some tips on how to generate logs that do not trip up parsing unnecessarily:
+
  * Use `_latex` option `-file-line-error` to get higher accuracy regarding source files and lines.
  * [Increase the maximum line length](https://tex.stackexchange.com/a/52994/3213) as much as possible
     to improve overall efficacy. Bad linebreaks are 
         [bad](https://github.com/reitzig/texlogparser/search?utf8=%E2%9C%93&q=BROKEN_BY_LINEBREAKS&type=).
  * Avoid parentheses and whitespace in file paths.
+ * The shell output of the initial run of `pdflatex` et al. on a new file can 
+    contain output of subprograms, and be complicated in other ways as well. 
+    It is therefore more robust to use the log file as written to disk, and/or 
+    the output resp. log file produced by a subsequent run. 
+    (Don't worry, real errors will stick around!) 
 
 ## Contributing
 
@@ -109,4 +135,10 @@ very appreciated. Particular areas of interest include:
  * Does the documentation cover all your questions?
  * Is the Gem structured properly?
  * What can be improved to encourage code contributions?
- * Does the CLI script have problems on any platform?
+ * Does the CLI script have problems on any platform?
+ 
+### Contributors
+
+ * [egreg](https://tex.stackexchange.com/users/4427/egreg) and
+   [David Carlisle](https://tex.stackexchange.com/users/1090/david-carlisle)
+   provided helpful test cases and insight in LaTeX Stack Exchange chat. 

data/lib/tex_log_parser/patterns/bad_hbox_warning.rb

@@ -17,8 +17,8 @@ class TexLogParser
 
     # Creates a new instance.
     def initialize
-      super(/^(Over|Under)full \\hbox.*at lines (\d+)--(\d+)/,
-            { pattern: ->(_) { /^\s*\[\]\s*$/ }, until: :match, inclusive: false }
+      super(/^(Over|Under)full \\hbox.*at line(?:s)? (\d+)(?:--(\d+))?/,
+            { pattern: ->(_) { /^\s*(\[\])?\s*$/ }, until: :match, inclusive: false }
       )
     end
 
@@ -27,8 +27,9 @@ class TexLogParser
       # @type [Message] msg
       msg, consumed = super(lines)
 
-      msg.source_lines = { from: @start_match[2].to_i,
-                           to: @start_match[3].to_i }
+      from_line = @start_match[2].to_i
+      end_line = @start_match[3].nil? ? from_line :  @start_match[3].to_i
+      msg.source_lines = { from: from_line, to: end_line }
       msg.preformatted = true
       msg.level = :warning
 

data/lib/version.rb

@@ -3,5 +3,5 @@
 # @attr [String] VERSION
 #   The version of TexLogParser.
 class TexLogParser
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tex_log_parser
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Raphael Reitzig