Test JSON output format.

 - Adds JSON Schema.
 - Slight changes to output generation.
    - `Message.source_lines` can be `null`.

Author: reitzig

lib/log_parser/log_parser.rb

@@ -168,7 +168,6 @@ def consume_pattern(pattern)
     message.log_lines = { from: @log_line_number,
                           to: @log_line_number + consumed_lines - 1 }
     message.source_file ||= @files.last
-    message.source_lines ||= { from: nil, to: nil }
 
     Logger.debug message
     remove_consumed_lines consumed_lines

lib/version.rb

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

resources/message.schema.json

@@ -1,14 +1,71 @@
 {
-  "level": "info",
-  "source_file": "/usr/local/texlive/2016/texmf-dist/tex/latex/base/fleqn.clo",
-  "source_lines": {
-    "from": 51,
-    "to": 51
+  "title": "(La)TeX Log",
+  "description": "Content of a (La)TeX log as parsed by texlogparser.",
+  "$schema": "http://json-schema.org/draft-06/schema#",
+
+  "definitions": {
+    "lines": {
+      "type": "object",
+      "properties": {
+        "from": {
+          "type": "integer"
+        },
+        "to": {
+          "type": "integer"
+        }
+      },
+      "required": [
+        "from",
+        "to"
+      ]
+    }
   },
-  "message": "LaTeX Info: Redefining \\[ on input line 51.",
-  "log_lines": {
-    "from": 15,
-    "to": 15
-  },
-  "preformatted": true
+
+  "type": "array",
+  "items": {
+    "type": "object",
+    "properties": {
+      "level": {
+        "type": "string",
+        "enum": [
+          "error",
+          "warning",
+          "info"
+        ]
+      },
+      "message": {
+        "type": "string"
+      },
+      "source_file": {
+        "oneOf": [
+          {
+            "type": "string"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "source_lines": {
+        "oneOf": [
+          {
+            "$ref": "#/definitions/lines"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "log_lines": {
+        "$ref": "#/definitions/lines"
+      },
+      "preformatted": {
+        "type": "boolean"
+      }
+    },
+    "required": [
+      "level",
+      "message"
+    ]
+  }
 }

test/test_jsonlog.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'minitest/autorun'
+require 'json-schema'
+require 'tex_log_parser'
+
+# Tests whether {LogParser::Buffer} works correctly when reading from arrays.
+class JsonLogTests < Minitest::Test
+  def initialize(param)
+    super(param)
+
+    schema = "#{File.expand_path(__dir__)}/../resources/message.schema.json"
+    @schema = File.read(schema)
+  end
+
+  def test_schema_valid
+    meta_schema = JSON::Validator.validator_for_uri('http://json-schema.org/draft-06/schema#').metaschema
+    errors = JSON::Validator.fully_validate(meta_schema, @schema)
+    errors.each { |e| puts e.to_s }
+    assert(errors.empty?, 'We should have a valid schema.')
+  end
+
+  def test_validity_against_schema
+    Dir["#{File.expand_path(__dir__)}/texlogs/*.log"].each do |log|
+      LogParser::Logger.debug "\n\nValidating #{log}"
+      json = JSON.pretty_generate(TexLogParser.new(File.open(log, 'r')).parse)
+      LogParser::Logger.debug json
+      errors = JSON::Validator.fully_validate(@schema, json)
+      errors.each { |e| puts e.to_s }
+      assert(errors.empty?, "JSON output of parsed '#{log}' should be valid.")
+    end
+  end
+end

texlogparser.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
   s.files       = Dir['lib/**/*.rb', 'bin/*', 'LICENSE', '*.md']
 
   s.add_development_dependency 'github-markup', '~> 2.0'
+  s.add_development_dependency 'json-schema', '~> 2.8'
   s.add_development_dependency 'minitest', '~> 5.10'
   s.add_development_dependency 'rake', '~> 12.3'
   s.add_development_dependency 'redcarpet', '~> 3.4'