sus-fixtures-console 0.3.1 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c5226ba5f04c0aaa7a85face6d5d5ddaf0553369a5c90dbea7714b2a12d1aaf
-  data.tar.gz: 1f07009379ae5acd0630c692656b18b555d1d2c2d6924c290268ab95f30e1a50
+  metadata.gz: 1e7cec179de60237b4aa5c02af965c5c408922527355fdc2a3ff4bb461af02c5
+  data.tar.gz: b0b6299b341defd1e00675e08188434456a6f06f63aa9fef38a879d867439e2a
 SHA512:
-  metadata.gz: f595232b9ce0f4b252345a77b574a4fa7b01a9bc76beca7cee0a7b7fc38fdffc3d3b183186fd20b10a4921bca00ef4b8862560cdb25ebd5d1caddcdfb36e0113
-  data.tar.gz: b4a4c3520d42adfa4a62828177b84d9d4fb69a1348d0b95da2121940ecd7ec32daa99b558097a16ee45a42e441b778fdae78bacdde4cb9f02d4b43c0773a1cb0
+  metadata.gz: e435cfb4bce7c62d9c94bbe46d74a347665870fd1ced6c5e8a52c6b072b85b8b67c9d81e67383ad0ec3c0ec04c8ea0214c25f78003c7c652b1c1d5863676d27b
+  data.tar.gz: c935ce69e39432c734c91de3fe09369b4475cc4ee7732db7af435148815bca90cacc6f613b40043fe5dc3eac5b92978cdaf2ed577e95447aab3d9b91a7c3a86b

data/context/getting-started.md

@@ -0,0 +1,87 @@
+# Getting Started
+
+This guide explains how to use the `Sus::Fixtures::Console` gem to redirect console logging output during tests.
+
+## Installation
+
+Add the gem to your project:
+
+``` bash
+$ bundle add sus-fixtures-console
+```
+
+## Core Concepts
+
+`sus-fixtures-console` provides two main fixtures:
+
+- {ruby Sus::Fixtures::Console::CapturedLogger} - Captures console output for inspection and testing.
+- {ruby Sus::Fixtures::Console::NullLogger} - Suppresses console output to reduce noise during test runs.
+
+## Usage
+
+### Capturing Console Output
+
+Here is a basic example of a test, that captures the log output:
+
+``` ruby
+require 'sus/fixtures/console/captured_logger'
+
+describe Sus::Fixtures::Console::CapturedLogger do
+	include_context Sus::Fixtures::Console::CapturedLogger
+	
+	it "should capture output" do
+		Console.debug("Hello, World!")
+		
+		expect(console_capture.last).to have_keys(
+			severity: be == :debug,
+			subject: be == "Hello, World!"
+		)
+	end
+end
+```
+
+### Ignoring Console Output
+
+If you want to ignore the console output, you can use the `Sus::Fixtures::Console::NullLogger` fixture:
+
+``` ruby
+describe Sus::Fixtures::Console::NullLogger do
+	include_context Sus::Fixtures::Console::NullLogger
+	
+	it "should capture output" do
+		expect($stderr).not.to receive(:puts)
+		expect($stderr).not.to receive(:write)
+		
+		Console.debug("Hello, World!")
+	end
+end
+```
+
+### Advanced Usage
+
+You can also use the `expect_console` helper method for more fluent test assertions:
+
+``` ruby
+describe Sus::Fixtures::Console::CapturedLogger do
+	include_context Sus::Fixtures::Console::CapturedLogger
+	
+	it "can use expect_console helper" do
+		Console.info("Processing complete")
+		
+		expect_console.to have_logged(
+			severity: be == :info,
+			subject: be == "Processing complete"
+		)
+	end
+end
+```
+
+### Setting a Default Log Level
+
+In many cases, you may wish to set a default log level that only prints warnings or above:
+
+``` ruby
+# In your `config/sus.rb` file:
+require 'console'
+Console.logger.warn!
+```

data/context/index.yaml

@@ -0,0 +1,13 @@
+# Automatically generated context index for Utopia::Project guides.
+# Do not edit then files in this directory directly, instead edit the guides and then run `bake utopia:project:agent:context:update`.
+---
+description: Test fixtures for capturing Console output.
+metadata:
+  documentation_uri: https://socketry.github.io/sus-fixtures-console/
+  funding_uri: https://github.com/sponsors/ioquatix/
+  source_code_uri: https://github.com/socketry/sus-fixtures-console.git
+files:
+- path: getting-started.md
+  title: Getting Started
+  description: This guide explains how to use the `Sus::Fixtures::Console` gem to
+    redirect console logging output during tests.

data/lib/sus/fixtures/console/captured_logger.rb

@@ -3,18 +3,23 @@
 # Released under the MIT License.
 # Copyright, 2024, by Samuel Williams.
 
-require 'sus/shared'
-require 'console'
-require 'console/capture'
-require 'console/logger'
+require "sus/shared"
+require "console"
+require "console/capture"
+require "console/logger"
 
 module Sus
 	module Fixtures
 		module Console
+			# Shared context for capturing console output during tests.
+			# Provides access to captured log messages and helper methods for testing console logging.
 			CapturedLogger = Sus::Shared("captured logger") do
+				# @attribute [Console::Capture] Captures console output for inspection.
 				let(:console_capture) {::Console::Capture.new}
+				# @attribute [Console::Logger] Logger configured to capture output at DEBUG level.
 				let(:console_logger) {::Console::Logger.new(console_capture, level: ::Console::Logger::DEBUG)}
 				
+				# Set up console logger before test execution and clean up afterwards.
 				def around
 					::Console.logger = console_logger
 					super
@@ -22,10 +27,15 @@ module Sus
 					::Console.logger = nil
 				end
 				
+				# Create an expectation for the console capture.
+				# @returns [Object] An expectation object for the console capture.
 				def expect_console
 					expect(console_capture)
 				end
 				
+				# Create a matcher for checking logged messages with specific fields.
+				# @parameter fields [Hash] Key-value pairs to match in logged messages.
+				# @returns [Object] A matcher that checks for logged messages containing the specified fields.
 				def have_logged(**fields)
 					have_value(have_keys(**fields))
 				end

data/lib/sus/fixtures/console/null_logger.rb

@@ -3,17 +3,21 @@
 # Released under the MIT License.
 # Copyright, 2024, by Samuel Williams.
 
-require 'sus/shared'
-require 'console'
-require 'console/capture'
-require 'console/logger'
+require "sus/shared"
+require "console"
+require "console/capture"
+require "console/logger"
 
 module Sus
 	module Fixtures
 		module Console
+			# Shared context for suppressing console output during tests.
+			# Redirects all console logging to a null output to prevent noise in test runs.
 			NullLogger = Sus::Shared("null logger") do
+				# @attribute [Console::Logger] Logger configured to suppress all output.
 				let(:console_logger) {::Console::Logger.new(::Console::Output::Null.new)}
 				
+				# Set up null logger before test execution and clean up afterwards.
 				def around
 					::Console.logger = console_logger
 					super

data/lib/sus/fixtures/console/version.rb

@@ -6,7 +6,7 @@
 module Sus
 	module Fixtures
 		module Console
-			VERSION = "0.3.1"
+			VERSION = "0.4.1"
 		end
 	end
 end

data/lib/sus/fixtures/console.rb

@@ -3,5 +3,16 @@
 # Released under the MIT License.
 # Copyright, 2024, by Samuel Williams.
 
-require_relative 'console/version'
-require_relative 'console/captured_logger'
+require_relative "console/version"
+require_relative "console/captured_logger"
+require_relative "console/null_logger"
+
+# @namespace
+module Sus
+	# @namespace
+	module Fixtures
+		# @namespace
+		module Console
+		end
+	end
+end

data/readme.md

@@ -16,6 +16,32 @@ Please see the [project documentation](https://socketry.github.io/sus-fixtures-c
 
   - [Getting Started](https://socketry.github.io/sus-fixtures-console/guides/getting-started/index) - This guide explains how to use the `Sus::Fixtures::Console` gem to redirect console logging output during tests.
 
+## Releases
+
+Please see the [project releases](https://socketry.github.io/sus-fixtures-console/releases/index) for all releases.
+
+### v0.4.0
+
+  - Add agent context.
+
+### v0.3.1
+
+  - Modernize gem structure and dependencies.
+
+### v0.3.0
+
+    - Add `expect_console` helper method for more fluent test assertions.
+    - Add `have_logged` predicate for checking logged messages with specific fields.
+
+### v0.2.0
+
+  - Avoid using nested fiber to prevent potential issues with fiber-based concurrency.
+
+### v0.1.0
+
+    - Add `Sus::Fixtures::Console::CapturedLogger` for capturing console output during tests.
+    - Add `Sus::Fixtures::Console::NullLogger` for suppressing console output during tests.
+
 ## Contributing
 
 We welcome contributions to this project.

data/releases.md

@@ -0,0 +1,23 @@
+# Releases
+
+## v0.4.0
+
+  - Add agent context.
+
+## v0.3.1
+
+  - Modernize gem structure and dependencies.
+
+## v0.3.0
+
+    - Add `expect_console` helper method for more fluent test assertions.
+    - Add `have_logged` predicate for checking logged messages with specific fields.
+
+## v0.2.0
+
+  - Avoid using nested fiber to prevent potential issues with fiber-based concurrency.
+
+## v0.1.0
+
+    - Add `Sus::Fixtures::Console::CapturedLogger` for capturing console output during tests.
+    - Add `Sus::Fixtures::Console::NullLogger` for suppressing console output during tests.

metadata

@@ -1,11 +1,10 @@
 --- !ruby/object:Gem::Specification
 name: sus-fixtures-console
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.1
 platform: ruby
 authors:
 - Samuel Williams
-autorequire:
 bindir: bin
 cert_chain:
 - |
@@ -37,7 +36,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-08-25 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: console
@@ -67,18 +66,19 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
-description:
-email:
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- context/getting-started.md
+- context/index.yaml
 - lib/sus/fixtures/console.rb
 - lib/sus/fixtures/console/captured_logger.rb
 - lib/sus/fixtures/console/null_logger.rb
 - lib/sus/fixtures/console/version.rb
 - license.md
 - readme.md
+- releases.md
 homepage: https://github.com/socketry/sus-fixtures-console
 licenses:
 - MIT
@@ -86,7 +86,6 @@ metadata:
   documentation_uri: https://socketry.github.io/sus-fixtures-console/
   funding_uri: https://github.com/sponsors/ioquatix/
   source_code_uri: https://github.com/socketry/sus-fixtures-console.git
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -94,15 +93,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Test fixtures for capturing Console output.
 test_files: []