Add logger to the store

Automatically add the crawler's logger to the `Store` so you can also
log messages from there. This can be breaking as the `StoreInterface`
now also requires the `addLogger` method. The new abstract `Store` class
already implements it, so you can just extend it.
Also prepare for v0.4 release tag.

CHANGELOG.md

@@ -5,6 +5,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+
+## [0.4.0] - 2022-05-06
 ### Added
 * The `BaseStep` class now has `where()` and `orWhere()` methods to
   filter step outputs. You can set multiple filters that will be
@@ -19,6 +21,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   `onSameDomain()`, `notOnSameDomain()`, `onDomain()`,
   `onSameHost()`, `notOnSameHost()`, `onHost()` to restrict the
   which links to find.
+* Automatically add the crawler's logger to the `Store` so you can
+  also log messages from there. This can be breaking as the
+  `StoreInterface` now also requires the `addLogger` method. The
+  new abstract `Store` class already implements it, so you can just
+  extend it.
 
 ### Changed
 * The `Csv` step can now also be used without defining a column

README.md

@@ -2,12 +2,12 @@
 
 This package provides kind of a framework and a lot of ready
 to use, so-called steps, that you can combine to build your
-own crawlers or scrapers with.
+own crawlers and scrapers with.
 
 ## Documentation
 
 You can find the documentation at 
-[crwlr.software](https://www.crwlr.software/packages/crawler/v0.2/getting-started).
+[crwlr.software](https://www.crwlr.software/packages/crawler/v0.4/getting-started).
 
 ## Contributing
 

src/Crawler.php

@@ -80,6 +80,8 @@ public function getLoader(): LoaderInterface
 
     public function setStore(StoreInterface $store): static
     {
+        $store->addLogger($this->logger);
+
         $this->store = $store;
 
         return $this;

src/Stores/SimpleCsvFileStore.php

@@ -5,13 +5,13 @@
 use Crwlr\Crawler\Result;
 use Exception;
 
-class SimpleCsvFileStore implements StoreInterface
+class SimpleCsvFileStore extends Store
 {
     private int $createTimestamp;
 
     private bool $isFirstResult = true;
 
-    public function __construct(private string $storePath, private ?string $filePrefix = null)
+    public function __construct(private readonly string $storePath, private readonly ?string $filePrefix = null)
     {
         $this->createTimestamp = time();
 
@@ -35,6 +35,8 @@ public function store(Result $result): void
         fputcsv($fileHandle, array_values($result->toArray()));
 
         fclose($fileHandle);
+
+        $this->logger?->info('Stored a result');
     }
 
     public function filePath(): string

src/Stores/Store.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Crwlr\Crawler\Stores;
+
+use Psr\Log\LoggerInterface;
+
+abstract class Store implements StoreInterface
+{
+    protected ?LoggerInterface $logger = null;
+
+    public function addLogger(LoggerInterface $logger): static
+    {
+        $this->logger = $logger;
+
+        return $this;
+    }
+}

src/Stores/StoreInterface.php

@@ -3,8 +3,11 @@
 namespace Crwlr\Crawler\Stores;
 
 use Crwlr\Crawler\Result;
+use Psr\Log\LoggerInterface;
 
 interface StoreInterface
 {
     public function store(Result $result): void;
+
+    public function addLogger(LoggerInterface $logger): static;
 }

tests/CrawlerTest.php

@@ -12,6 +12,7 @@
 use Crwlr\Crawler\Steps\Loading\LoadingStepInterface;
 use Crwlr\Crawler\Steps\Step;
 use Crwlr\Crawler\Steps\StepInterface;
+use Crwlr\Crawler\Stores\Store;
 use Crwlr\Crawler\Stores\StoreInterface;
 use Crwlr\Crawler\UserAgents\BotUserAgent;
 use Crwlr\Crawler\UserAgents\UserAgentInterface;
@@ -384,6 +385,8 @@ protected function loader(UserAgentInterface $userAgent, LoggerInterface $logger
 it('sends all results to the Store when there is one and still yields the results', function () {
     $store = Mockery::mock(StoreInterface::class);
 
+    $store->shouldReceive('addLogger');
+
     $store->shouldReceive('store')->times(3);
 
     $crawler = helper_getDummyCrawler();
@@ -415,6 +418,8 @@ function () {
 
         $store = Mockery::mock(StoreInterface::class);
 
+        $store->shouldReceive('addLogger');
+
         $store->shouldNotReceive('store');
 
         $crawler = helper_getDummyCrawler()
@@ -426,7 +431,7 @@ function () {
 
         $store = Mockery::mock(StoreInterface::class);
 
-        $store->shouldReceive('store')->once();
+        $store->shouldReceive('store', 'addLogger')->once();
 
         $crawler = helper_getDummyCrawler()
             ->addStep($step)
@@ -472,10 +477,18 @@ protected function invoke(mixed $input): Generator
             }
         };
 
+        $store = new class () extends Store {
+            public function store(Result $result): void
+            {
+                $this->logger?->info('Stored a result');
+            }
+        };
+
         $crawler = helper_getDummyCrawler()
             ->inputs(['input1', 'input2'])
             ->addStep('foo', $step1)
-            ->addStep('bar', $step2);
+            ->addStep('bar', $step2)
+            ->setStore($store);
 
         $crawler->runAndTraverse();
 
@@ -489,11 +502,19 @@ protected function invoke(mixed $input): Generator
 
         expect($outputLines[2])->toContain('step2 called');
 
-        expect($outputLines[3])->toContain('step1 called');
+        expect($outputLines[3])->toContain('Stored a result');
+
+        expect($outputLines[4])->toContain('Stored a result');
+
+        expect($outputLines[5])->toContain('step1 called');
+
+        expect($outputLines[6])->toContain('step2 called');
+
+        expect($outputLines[7])->toContain('step2 called');
 
-        expect($outputLines[4])->toContain('step2 called');
+        expect($outputLines[8])->toContain('Stored a result');
 
-        expect($outputLines[5])->toContain('step2 called');
+        expect($outputLines[9])->toContain('Stored a result');
     }
 );