lumberjack_capture_device 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee398d1d45c445f0afb2469285cfbbfc6896313251078684619ca5a12bbcc0e3
-  data.tar.gz: c81bc5da733d88a2213e7b6459d8b0be81a9501484862043dea0d3761c364b57
+  metadata.gz: 9147e66264c0eeebb01f7c04df1b6e18ab64bc4db3337e968d6cd1d2201fef7f
+  data.tar.gz: f01bf2e332024e9ef26ef703b374956e5f17c6bb4f351cb4518b1591b62dd992
 SHA512:
-  metadata.gz: 790bc14321e6e30426098616d96ee5425d63b58b9041e251001856dc0b1abb8549a220f892570df4c1c85ca398002a3e94de37f395f45fb84b406c5331ccf655
-  data.tar.gz: 2512ec2c40dbefe1242abe07d3c7b0a391e9a425c18abc54247d9a76195f73a548f6a080d51d8463caa92512c34b96d9bff81e06179b60fc0569d98c4b1fc50f
+  metadata.gz: 5e5ae9f94313a18f793b299998c9760aaa8d7bf5d8f462f48b4519f83c8844893ff894e5b570e31b15d55dc1ad9d25ee723529dc72e51db83d5060a4bcf1597c
+  data.tar.gz: 06a11ff5e4c5f3afed7cda12fa2f5f9bf94369f6c5b382d7118622136b7f1507d67c1e68ca472c6c38d1bf38cd3aa6db66f4859a145f78b9b69a8f9f4024a634

data/CHANGELOG.md

@@ -4,6 +4,17 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 1.2.2
+
+### Changed
+
+- Improved failure message on RSpec matcher.
+
+### Added
+
+- `Lumberjack::CaptureDevice` now acts as an enumerable object.
+- Exposed helper methods for formatting log entries.
+
 ## 1.2.1
 
 ### Changed

data/VERSION

@@ -1 +1 @@
-1.2.1
+1.2.2

data/lib/lumberjack/capture_device/include_log_entry_matcher.rb

@@ -16,7 +16,7 @@ class Lumberjack::CaptureDevice::IncludeLogEntryMatcher
 
   def failure_message
     if valid_captured_logger?
-      formatted_failure_message(@captured_logger, @expected_hash, negated: false)
+      formatted_failure_message(@captured_logger, @expected_hash)
     else
       wrong_object_type_message(@captured_logger)
     end
@@ -24,7 +24,7 @@ class Lumberjack::CaptureDevice::IncludeLogEntryMatcher
 
   def failure_message_when_negated
     if valid_captured_logger?
-      formatted_failure_message(@captured_logger, @expected_hash, negated: true)
+      formatted_negated_failure_message(@captured_logger, @expected_hash)
     else
       wrong_object_type_message(@captured_logger)
     end
@@ -44,23 +44,35 @@ class Lumberjack::CaptureDevice::IncludeLogEntryMatcher
     "Expected a Lumberjack::CaptureDevice object, but received a #{captured_logger.class}."
   end
 
-  def formatted_failure_message(captured_logger, expected_hash, negated:)
-    closest_match = captured_logger.closest_match(**expected_hash)
-    message = "expected logs did not include expected entry.\n\n" \
-      "Expected entry:\n-----------\n#{Lumberjack::CaptureDevice.formatted_expectation(expected_hash)}\n\n" \
-      "Captured logs:\n-----------\n#{captured_logger.inspect}"
+  def formatted_failure_message(captured_logger, expected_hash)
+    message = +"expected logs to include entry:\n" \
+      "#{Lumberjack::CaptureDevice.formatted_expectation(expected_hash, indent: 2)}\n\n" \
+      "Captured #{captured_logger.length} log #{(captured_logger.length == 1) ? "entry" : "entries"}"
+
+    if captured_logger.length > 0
+      message << "\n----------------------\n"
+      captured_logger.each do |entry|
+        message << "#{Lumberjack::CaptureDevice.formatted_entry(entry)}\n"
+      end
+    end
 
+    closest_match = captured_logger.closest_match(**expected_hash)
     if closest_match
-      # Convert the entry to a hash format for formatted_expectation
-      closest_match_hash = {
-        level: closest_match.severity_label,
-        message: closest_match.message,
-        progname: closest_match.progname,
-        tags: closest_match.tags
-      }.compact
-
-      message = "#{message}\n\nClosest match found:\n-----------\n" \
-        "#{Lumberjack::CaptureDevice.formatted_expectation(closest_match_hash)}"
+      message = "#{message}\n\nClosest match found:" \
+        "#{Lumberjack::CaptureDevice.formatted_expectation(closest_match, indent: 2)}"
+    end
+
+    message
+  end
+
+  def formatted_negated_failure_message(captured_logger, expected_hash)
+    message = "expected logs not to include entry:\n" \
+      "#{Lumberjack::CaptureDevice.formatted_expectation(expected_hash, indent: 2)}"
+
+    match = captured_logger.match(**expected_hash)
+    if match
+      message = "#{message}\n\nFound entry:\n" \
+        "#{Lumberjack::CaptureDevice.formatted_expectation(match, indent: 2)}"
     end
 
     message

data/lib/lumberjack/capture_device.rb

@@ -8,8 +8,9 @@ module Lumberjack
   class CaptureDevice < Lumberjack::Device
     VERSION = File.read(File.join(__dir__, "..", "..", "VERSION"))
 
-    attr_reader :buffer
+    include Enumerable
 
+    attr_reader :buffer
     class << self
       # Capture the entries written by the logger within a block. Within the block all log
       # entries will be written to a CaptureDevice rather than to the normal output for
@@ -48,18 +49,51 @@ module Lumberjack
         device
       end
 
-      def formatted_expectation(expectation)
+      # Helper method to format a log entry for display.
+      #
+      # @param entry [Lumberjack::LogEntry] The log entry to format.
+      # @param indent [Integer] The indentation to prefix on every line.
+      # @return [String] The formatted log entry.
+      def formatted_entry(entry, indent: 0)
+        indent_str = " " * indent
+        timestamp = entry.time.strftime("%Y-%m-%d %H:%M:%S")
+        formatted = +"#{indent_str}#{timestamp} #{entry.severity_label}: #{entry.message}"
+        formatted << "\n#{indent_str}  progname: #{entry.progname}" if entry.progname.to_s != ""
+        if entry.tags && !entry.tags.empty?
+          Lumberjack::Utils.flatten_tags(entry.tags).to_a.sort_by(&:first).each do |name, value|
+            formatted << "\n#{indent_str}  #{name}: #{value}"
+          end
+        end
+        formatted
+      end
+
+      # Format a log entry or expectation hash into a more human readable format.
+      #
+      # @param expectation [Hash, Lumberjack::LogEntry] The expectation or log entry to format.
+      # @return [String] A formatted string representation of the expectation or log entry.
+      def formatted_expectation(expectation, indent: 0)
+        if expectation.is_a?(Lumberjack::LogEntry)
+          expectation = {
+            "level" => expectation.severity_label,
+            "message" => expectation.message,
+            "progname" => expectation.progname,
+            "tags" => expectation.tags
+          }
+        end
+
         expectation = expectation.transform_keys(&:to_s).compact
+
         message = []
-        message << "level: #{expectation["level"].inspect}" if expectation.include?("level")
-        message << "message: #{expectation["message"].inspect}" if expectation.include?("message")
-        message << "progname: #{expectation["progname"].inspect}" if expectation.include?("progname")
+        indent_str = " " * indent
+        message << "#{indent_str}level: #{expectation["level"].inspect}" if expectation.include?("level")
+        message << "#{indent_str}message: #{expectation["message"].inspect}" if expectation.include?("message")
+        message << "#{indent_str}progname: #{expectation["progname"].inspect}" if expectation.include?("progname")
         if expectation["tags"].is_a?(Hash) && !expectation["tags"].empty?
           tags = Lumberjack::Utils.flatten_tags(expectation["tags"])
           prefix = "tags: "
-          tags.each do |name, value|
+          tags.sort_by(&:first).each do |name, value|
             message << "#{prefix} #{name}: #{value.inspect}"
-            prefix = "      "
+            prefix = "#{indent_str}      "
           end
         end
         message.join("\n")
@@ -107,7 +141,7 @@ module Lumberjack
     # @option args [String] :progname The program name to match against the log entries.
     # @return [Boolean] True if any entries match the specified filters, false otherwise.
     def include?(args)
-      !extract(**args.merge(limit: 1)).empty?
+      !!match(**args)
     end
 
     # Return all the captured entries that match the specified filters. These filters are
@@ -120,8 +154,8 @@ module Lumberjack
     #   `{foo: {bar: "value"}}`).
     # @param limit [Integer, nil] The maximum number of entries to return. If nil, all matching entries
     #   will be returned.
-    # @return [Array<Lumberjack::Entry>] An array of log entries that match the specified filters.
-    def extract(message: nil, level: nil, tags: nil, limit: nil, progname: nil)
+    # @return [Array<Lumberjack::LogEntry>] An array of log entries that match the specified filters.
+    def extract(message: nil, level: nil, tags: nil, progname: nil, limit: nil)
       matches = []
 
       if level
@@ -139,6 +173,17 @@ module Lumberjack
       matches
     end
 
+    # Return the first entry that matches the specified filters.
+    #
+    # @param message [String, Regexp, nil] The message to match against the log entries.
+    # @param level [String, Symbol, Integer, nil] The log level to match against the log entries.
+    # @param tags [Hash, nil] A hash of tag names to values to match against the log entries.
+    # @param progname [String, nil] The program name to match against the log entries.
+    # @return [Lumberjack::LogEntry, nil] The log entry that most closely matches the filters, or nil if no entry meets minimum criteria.
+    def match(message: nil, level: nil, tags: nil, progname: nil)
+      extract(message: message, level: level, tags: tags, progname: progname, limit: 1).first
+    end
+
     # Return the log entry that most closely matches the specified filters. This method
     # uses fuzzy matching logic to find the best match when no exact match exists.
     # The matching score is calculated based on how many criteria are met and how closely
@@ -148,10 +193,13 @@ module Lumberjack
     # @param level [String, Symbol, Integer, nil] The log level to match against the log entries.
     # @param tags [Hash, nil] A hash of tag names to values to match against the log entries.
     # @param progname [String, nil] The program name to match against the log entries.
-    # @return [Lumberjack::Entry, nil] The log entry that most closely matches the filters, or nil if no entry meets minimum criteria.
+    # @return [Lumberjack::LogEntry, nil] The log entry that most closely matches the filters, or nil if no entry meets minimum criteria.
     def closest_match(message: nil, level: nil, tags: nil, progname: nil)
       return nil if @buffer.empty?
 
+      exact_match = match(message: message, level: level, tags: tags, progname: progname)
+      return exact_match if exact_match
+
       # Normalize level filter
       if level
         level = (level.is_a?(Integer) ? level : Lumberjack::Severity.label_to_level(level))
@@ -174,7 +222,7 @@ module Lumberjack
     def inspect
       message = +"<##{self.class.name} #{@buffer.size} #{(@buffer.size == 1) ? "entry" : "entries"} captured:"
       @buffer.each do |entry|
-        message << "\n  #{formatted_entry(entry)}"
+        message << "\n  #{Lumberjack::CaptureDevice.formatted_entry(entry)}"
       end
       message << "\n>"
       message
@@ -184,6 +232,16 @@ module Lumberjack
       "<##{self.class.name} #{@buffer.size} #{(@buffer.size == 1) ? "entry" : "entries"} captured>"
     end
 
+    def length
+      @buffer.length
+    end
+
+    alias_method :size, :length
+
+    def each(&block)
+      @buffer.each(&block)
+    end
+
     private
 
     def matched?(entry, message_filter, level_filter, tags_filter, progname_filter)
@@ -243,18 +301,6 @@ module Lumberjack
         hash
       end
     end
-
-    def formatted_entry(entry)
-      timestamp = entry.time.strftime("%Y-%m-%d %H:%M:%S")
-      formatted = +"#{timestamp} #{entry.severity_label}: #{entry.message}"
-      formatted << "\n    progname: #{entry.progname}" if entry.progname.to_s != ""
-      if entry.tags && !entry.tags.empty?
-        Lumberjack::Utils.flatten_tags(entry.tags).to_a.sort_by(&:first).each do |name, value|
-          formatted << "\n    #{name}: #{value}"
-        end
-      end
-      formatted
-    end
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lumberjack_capture_device
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Brian Durand
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-07-27 00:00:00.000000000 Z
+date: 2025-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lumberjack