sus-fixtures-console 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69305106d7c6e8321664a3ea8f8a30c95699e4ab01a6d620a59300ba5c990980
-  data.tar.gz: d4951bd83195be5cc001d2f1580a6d9b356a782d38ef50bc29ea51cee4f4dad0
+  metadata.gz: 866c9717a17e7c6a2bb6a9e5c0100c5f2f3873987c1c61aaab238c3753790e0e
+  data.tar.gz: 3ec4c6a398935168f9666b192661e9223069ba501d02cd65514e9d80773fba83
 SHA512:
-  metadata.gz: 5ee6e5089fcfd9c9b287a281384a068a986b055933dded04b24e65577f293b2d6aee8e582f1493d97e6f6544b1249597c091a1830c3cef1293b5ae34bc5f7492
-  data.tar.gz: c47d11911df531b80c918364f8cf7fb23512c9af36ea655fddc5aecc3f20c76448e263c1943c0cffe01c74ebbe095bdec84e27a12b6538198d199a4ec7701907
+  metadata.gz: 3907c7561299fad43950dcfbb1cbd53cb6add6648f3ca79d92b33079e011d2c3a4c917beb4da698fa7c1bb95bdb3f1c14c539abd76f185056be4cd89eb6e1e52
+  data.tar.gz: a02d2e1fdd9c1735429afee13b7be05d4014cd37c01354024db87c2f1ec2698d90f1d6f70df61b9fd89794b95daa9f6d20e98dedabd7df7e0f0594dcd48100bf

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.0"
+			VERSION = "0.4.0"
 		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

@@ -2,7 +2,7 @@
 
 Provides a convenient fixture for capturing or ignoring [console](https://github.com/socketry/console) logging.
 
-[![Development Status](https://github.com/sus-rb/sus-fixtures-console/workflows/Test/badge.svg)](https://github.com/sus-rb/sus-fixtures-console/actions?workflow=Test)
+[![Development Status](https://github.com/socketry/sus-fixtures-console/workflows/Test/badge.svg)](https://github.com/socketry/sus-fixtures-console/actions?workflow=Test)
 
 ## Installation
 
@@ -12,9 +12,35 @@ $ bundle add sus-fixtures-console
 
 ## Usage
 
-Please see the [project documentation](https://sus-rb.github.io/sus-fixtures-console/) for more details.
+Please see the [project documentation](https://socketry.github.io/sus-fixtures-console/) for more details.
 
-  - [Getting Started](https://sus-rb.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.
+  - [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
 

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.0
+  version: 0.4.0
 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-07-17 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: console
@@ -67,8 +66,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
-description:
-email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -79,14 +76,14 @@ files:
 - lib/sus/fixtures/console/version.rb
 - license.md
 - readme.md
-homepage: https://github.com/sus-rb/sus-fixtures-console
+- releases.md
+homepage: https://github.com/socketry/sus-fixtures-console
 licenses:
 - MIT
 metadata:
-  documentation_uri: https://sus-rb.github.io/sus-fixtures-console/
+  documentation_uri: https://socketry.github.io/sus-fixtures-console/
   funding_uri: https://github.com/sponsors/ioquatix/
-  source_code_uri: https://github.com/sus-rb/sus-fixtures-console.git
-post_install_message:
+  source_code_uri: https://github.com/socketry/sus-fixtures-console.git
 rdoc_options: []
 require_paths:
 - lib
@@ -94,15 +91,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: []