Merge pull request #5 from shadowhand/toggled-writer

Add writer that can be toggled

Author: shadowhand

CHANGELOG.md

@@ -14,6 +14,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - Added a `Log::append()` method to allow attaching multiple entries, without using `LogList`
+- Added `ToggledWriter` to enable or disable log writing at runtime
 
 ## [0.4.0]
 

README.md

@@ -306,6 +306,33 @@ The sampled writer ensures that:
 This is particularly useful for high-traffic applications where logging every successful request would be
 prohibitively expensive, while still capturing all errors for debugging.
 
+### ToggledWriter
+
+The `ToggledWriter` is a decorator that allows log writing to be enabled or disabled at runtime.
+
+```php
+use Knotlog\Writer\ToggledWriter;
+use Knotlog\Writer\FileWriter;
+
+// Enabled by default
+$writer = new ToggledWriter(new FileWriter());
+
+// Or start disabled
+$writer = new ToggledWriter(new FileWriter(), writeLogs: false);
+
+// Disable writing at any point
+$writer->disable();
+
+// Re-enable writing
+$writer->enable();
+
+// Only writes if enabled
+$writer->write($log);
+```
+
+This is useful for conditionally disabling log output based on runtime configuration, such as
+feature flags or environment-specific settings.
+
 ## License
 
 MIT License, see `LICENSE` file for details.

composer.json

@@ -72,6 +72,10 @@
     "scripts": {
         "analyze": "vendor/bin/mago analyze",
         "cover": "coverage-check build/phpunit/clover.xml 100",
+        "fix": [
+            "vendor/bin/mago lint --fix",
+            "vendor/bin/mago format"
+        ],
         "lint": "vendor/bin/mago lint",
         "test": "vendor/bin/phpunit",
         "check": [

src/Writer/ToggledWriter.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Knotlog\Writer;
+
+use Knotlog\Log;
+use Override;
+
+final class ToggledWriter implements LogWriter
+{
+    public function __construct(
+        private readonly LogWriter $logWriter,
+        private bool $writeLogs = true,
+    ) {}
+
+    public function enable(): void
+    {
+        $this->writeLogs = true;
+    }
+
+    public function disable(): void
+    {
+        $this->writeLogs = false;
+    }
+
+    #[Override]
+    public function write(Log $log): void
+    {
+        if ($this->writeLogs) {
+            $this->logWriter->write($log);
+        }
+    }
+}

tests/Writer/ToggledWriterTest.php

@@ -0,0 +1,67 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Knotlog\Tests\Writer;
+
+use Knotlog\Log;
+use Knotlog\Writer\LogWriter;
+use Knotlog\Writer\ToggledWriter;
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\TestCase;
+
+#[CoversClass(ToggledWriter::class)]
+final class ToggledWriterTest extends TestCase
+{
+    #[Test]
+    public function it_is_enabled_by_default(): void
+    {
+        $log = new Log();
+
+        $innerWriter = $this->createMock(LogWriter::class);
+        $innerWriter->expects($this->once())->method('write')->with($log);
+
+        $writer = new ToggledWriter($innerWriter);
+        $writer->write($log);
+    }
+
+    #[Test]
+    public function it_can_be_constructed_as_disabled(): void
+    {
+        $log = new Log();
+
+        $innerWriter = $this->createMock(LogWriter::class);
+        $innerWriter->expects($this->never())->method('write');
+
+        $writer = new ToggledWriter($innerWriter, writeLogs: false);
+        $writer->write($log);
+    }
+
+    #[Test]
+    public function it_does_not_write_when_disabled(): void
+    {
+        $log = new Log();
+
+        $innerWriter = $this->createMock(LogWriter::class);
+        $innerWriter->expects($this->never())->method('write');
+
+        $writer = new ToggledWriter($innerWriter);
+        $writer->disable();
+        $writer->write($log);
+    }
+
+    #[Test]
+    public function it_can_be_re_enabled_after_disabling(): void
+    {
+        $log = new Log();
+
+        $innerWriter = $this->createMock(LogWriter::class);
+        $innerWriter->expects($this->once())->method('write')->with($log);
+
+        $writer = new ToggledWriter($innerWriter);
+        $writer->disable();
+        $writer->enable();
+        $writer->write($log);
+    }
+}