sus-fixtures-console 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 866c9717a17e7c6a2bb6a9e5c0100c5f2f3873987c1c61aaab238c3753790e0e
-  data.tar.gz: 3ec4c6a398935168f9666b192661e9223069ba501d02cd65514e9d80773fba83
+  metadata.gz: f7422fc0acabbaaab2d3cf9f23b802989e50c3a8aeadc4889270288c7fe4b6bc
+  data.tar.gz: 320c04a418a41a2f536d8a3b4919439b45e06a3b1b709966c03663c9cbf8b992
 SHA512:
-  metadata.gz: 3907c7561299fad43950dcfbb1cbd53cb6add6648f3ca79d92b33079e011d2c3a4c917beb4da698fa7c1bb95bdb3f1c14c539abd76f185056be4cd89eb6e1e52
-  data.tar.gz: a02d2e1fdd9c1735429afee13b7be05d4014cd37c01354024db87c2f1ec2698d90f1d6f70df61b9fd89794b95daa9f6d20e98dedabd7df7e0f0594dcd48100bf
+  metadata.gz: aefade50186e2ed0af3e6c3d0c81a270bb4645b63aaa999c650fe4c4113418c867ac513273d487293c4810f7624af30facfc0b6e6bba5ff385dd8579b975d52e
+  data.tar.gz: 72883f4c29cbd9e34df52befc688c68a51f55a73994568a378062c9f4f50a87d930e72288f4ef4d67830382d4e0c1099c9b17fc89d22fd92124270fd78b36eb8

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 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 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 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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2024, by Samuel Williams.
+# Copyright, 2024-2025, by Samuel Williams.
 
 require "sus/shared"
 require "console"
@@ -13,11 +13,16 @@ module Sus
 		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)}
+			module CapturedLogger
+				# @returns [Console::Capture] Captures console output for inspection.
+				def console_capture
+					@console_capture ||= ::Console::Capture.new
+				end
+				
+				# @returns [Console::Logger] Logger configured to capture output at DEBUG level.
+				def console_logger
+					@console_logger ||= ::Console::Logger.new(console_capture, level: ::Console::Logger::DEBUG)
+				end
 				
 				# Set up console logger before test execution and clean up afterwards.
 				def around

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2024, by Samuel Williams.
+# Copyright, 2024-2025, by Samuel Williams.
 
 require "sus/shared"
 require "console"
@@ -13,9 +13,11 @@ module Sus
 		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)}
+			module NullLogger
+				# @returns [Console::Logger] Logger configured to suppress all output.
+				def console_logger
+					@console_logger ||= ::Console::Logger.new(::Console::Output::Null.new)
+				end
 				
 				# Set up null logger before test execution and clean up afterwards.
 				def around

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

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2024, by Samuel Williams.
+# Copyright, 2024-2025, by Samuel Williams.
 
 module Sus
 	module Fixtures
 		module Console
-			VERSION = "0.4.0"
+			VERSION = "0.5.0"
 		end
 	end
 end

data/lib/sus/fixtures/console.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2024, by Samuel Williams.
+# Copyright, 2024-2025, by Samuel Williams.
 
 require_relative "console/version"
 require_relative "console/captured_logger"

data/license.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright, 2024, by Samuel Williams.  
+Copyright, 2024-2025, by Samuel Williams.  
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/readme.md

@@ -20,6 +20,11 @@ Please see the [project documentation](https://socketry.github.io/sus-fixtures-c
 
 Please see the [project releases](https://socketry.github.io/sus-fixtures-console/releases/index) for all releases.
 
+### v0.5.0
+
+  - Prefer modules over `Sus::Shared` contexts for better integration.
+      - Use `include Sus::Fixtures::Console::NullLogger` instead of `include_context Sus::Fixtures::Console::NullLogger`.
+
 ### v0.4.0
 
   - Add agent context.

data/releases.md

@@ -1,5 +1,10 @@
 # Releases
 
+## v0.5.0
+
+  - Prefer modules over `Sus::Shared` contexts for better integration.
+      - Use `include Sus::Fixtures::Console::NullLogger` instead of `include_context Sus::Fixtures::Console::NullLogger`.
+
 ## v0.4.0
 
   - Add agent context.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sus-fixtures-console
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -70,6 +70,8 @@ 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
@@ -98,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.7.2
 specification_version: 4
 summary: Test fixtures for capturing Console output.
 test_files: []