Capture errors outside examples (#16)

In our efforts to improve RSpec output, we've lacked a way to easily parse errors when they occur outside of examples. Adding an easier way to access that information feels aligned with the goals of this gem.

This commit adds an "errors" key that populates with information (exception class, exception message, path, and line number) about errors that occur outside of examples.

Author: jelaniwoods

lib/rspec/enriched_json/formatters/enriched_json_formatter.rb

@@ -7,8 +7,20 @@ module RSpec
   module EnrichedJson
     module Formatters
       class EnrichedJsonFormatter < RSpec::Core::Formatters::JsonFormatter
+        ANSI_COLOR_REGEX = /\e\[[0-9;]*[mGKHF]/
+        EXCEPTION_DETECTOR_REGEX = /(Exception|Error|undefined method|uninitialized constant)/
+        PATH_AND_LINE_NUMBER_REGEX = /#?(?<path>.+?):(?<line_number>\d+)/
+        EXCEPTION_CLASS_AND_MESSAGE_REGEX = /^(?<exception_class>[A-Z]\w*Error|Exception):$\n(?<exception_message>(?<extra>^\s\s.*\n?)+)/
+
         RSpec::Core::Formatters.register self, :message, :dump_summary, :dump_profile, :stop, :seed, :close
 
+        def initialize(output)
+          super
+          @output_hash = {
+            errors: []
+          }
+        end
+
         def stop(group_notification)
           @output_hash[:examples] = group_notification.notifications.map do |notification|
             format_example(notification.example).tap do |hash|
@@ -36,6 +48,30 @@ def stop(group_notification)
           end
         end
 
+        def message(notification)
+          super
+
+          if notification.message.match?(EXCEPTION_DETECTOR_REGEX)
+            clean_message = notification.message.gsub(ANSI_COLOR_REGEX, "")
+
+            error_info = {
+              message: clean_message
+            }
+
+            if (match = clean_message.match(PATH_AND_LINE_NUMBER_REGEX))
+              error_info[:path] = match.named_captures["path"]
+              error_info[:line_number] = match.named_captures["line_number"]
+            end
+
+            if (match = clean_message.match(EXCEPTION_CLASS_AND_MESSAGE_REGEX))
+              error_info[:exception_class] = match.named_captures["exception_class"]
+              error_info[:exception_message] = match.named_captures["exception_message"]
+            end
+
+            @output_hash[:errors] << error_info
+          end
+        end
+
         private
 
         def add_metadata(hash, example)

lib/rspec/enriched_json/version.rb

@@ -2,6 +2,6 @@
 
 module RSpec
   module EnrichedJson
-    VERSION = "0.8.0"
+    VERSION = "0.8.1"
   end
 end