sus-fixtures-console 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 866c9717a17e7c6a2bb6a9e5c0100c5f2f3873987c1c61aaab238c3753790e0e
-  data.tar.gz: 3ec4c6a398935168f9666b192661e9223069ba501d02cd65514e9d80773fba83
+  metadata.gz: 1e7cec179de60237b4aa5c02af965c5c408922527355fdc2a3ff4bb461af02c5
+  data.tar.gz: b0b6299b341defd1e00675e08188434456a6f06f63aa9fef38a879d867439e2a
 SHA512:
-  metadata.gz: 3907c7561299fad43950dcfbb1cbd53cb6add6648f3ca79d92b33079e011d2c3a4c917beb4da698fa7c1bb95bdb3f1c14c539abd76f185056be4cd89eb6e1e52
-  data.tar.gz: a02d2e1fdd9c1735429afee13b7be05d4014cd37c01354024db87c2f1ec2698d90f1d6f70df61b9fd89794b95daa9f6d20e98dedabd7df7e0f0594dcd48100bf
+  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/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sus-fixtures-console
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 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