Added FeedStartingEvent and FeedFinishedEvent

Author: andrey-helldar

docs/laravel-feeds.tree

@@ -20,6 +20,9 @@
         <toc-element topic="advanced-usage.topic" />
         <toc-element topic="supported-formats.topic" />
     </toc-element>
+    <toc-element toc-title="Digging Deeper">
+        <toc-element topic="events.topic" />
+    </toc-element>
     <toc-element toc-title="Receipts">
         <toc-element topic="receipt-sitemap.topic" />
         <toc-element topic="receipt-instagram.topic" />

docs/topics/events.topic

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE topic
+        SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
+<topic
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
+        title="Events" id="events">
+
+    <link-summary>Events dispatched during feed generation</link-summary>
+    <card-summary>Events dispatched during feed generation</card-summary>
+    <web-summary>Events dispatched during feed generation</web-summary>
+
+    <show-structure depth="3" />
+
+    <p>
+        Feeds dispatch two events when running the command:
+    </p>
+
+    <deflist>
+        <def title="DragonCode\LaravelFeed\Events\FeedStartingEvent">
+            The <code>FeedStartingEvent</code> is dispatched immediately before the draft file is created.
+        </def>
+        <def title="DragonCode\LaravelFeed\Events\FeedFinishedEvent">
+            The <code>FeedFinishedEvent</code> is dispatched right after the feed file generation has completed.
+        </def>
+    </deflist>
+</topic>

src/Events/FeedFinishedEvent.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DragonCode\LaravelFeed\Events;
+
+use DragonCode\LaravelFeed\Feeds\Feed;
+
+class FeedFinishedEvent
+{
+    /**
+     * Create a new event instance.
+     *
+     * @param  class-string<Feed>  $feed  Reference to the feed class
+     * @param  string  $path  Path to the generated feed file
+     * @return void
+     */
+    public function __construct(
+        public string $feed,
+        public string $path,
+    ) {}
+}

src/Events/FeedStartingEvent.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DragonCode\LaravelFeed\Events;
+
+use DragonCode\LaravelFeed\Feeds\Feed;
+
+class FeedStartingEvent
+{
+    /**
+     * Create a new event instance.
+     *
+     * @param  class-string<Feed>  $feed  Reference to the feed class
+     * @return void
+     */
+    public function __construct(
+        public string $feed,
+    ) {}
+}

src/Services/GeneratorService.php

@@ -5,6 +5,8 @@
 namespace DragonCode\LaravelFeed\Services;
 
 use DragonCode\LaravelFeed\Converters\Converter;
+use DragonCode\LaravelFeed\Events\FeedFinishedEvent;
+use DragonCode\LaravelFeed\Events\FeedStartingEvent;
 use DragonCode\LaravelFeed\Exceptions\FeedGenerationException;
 use DragonCode\LaravelFeed\Feeds\Feed;
 use DragonCode\LaravelFeed\Helpers\ConverterHelper;
@@ -15,6 +17,7 @@
 use Throwable;
 
 use function blank;
+use function event;
 use function get_class;
 use function implode;
 
@@ -28,10 +31,9 @@ public function __construct(
 
     public function feed(Feed $feed, ?OutputStyle $output = null): void
     {
-        $file = $this->openFile(
-            $path = $feed->path()
-        );
         try {
+            $this->started($feed);
+
             $file = $this->openFile(
                 $path = $feed->path()
             );
@@ -45,8 +47,9 @@ public function feed(Feed $feed, ?OutputStyle $output = null): void
 
             $this->release($file, $path);
 
-        $this->setLastActivity($feed);
             $this->setLastActivity($feed);
+
+            $this->finished($feed, $path);
         } catch (Throwable $e) {
             throw new FeedGenerationException(get_class($feed), $e);
         }
@@ -162,4 +165,14 @@ protected function progressBar(int $count, ?OutputStyle $output): ?ProgressBar
     {
         return $output?->createProgressBar($count);
     }
+
+    protected function started(Feed $feed): void
+    {
+        event(new FeedStartingEvent(get_class($feed)));
+    }
+
+    protected function finished(Feed $feed, string $path): void
+    {
+        event(new FeedFinishedEvent(get_class($feed), $path));
+    }
 }

tests/Feature/Events/SuccessTest.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+use DragonCode\LaravelFeed\Commands\FeedGenerateCommand;
+use DragonCode\LaravelFeed\Events\FeedFinishedEvent;
+use DragonCode\LaravelFeed\Events\FeedStartingEvent;
+use DragonCode\LaravelFeed\Models\Feed;
+use Illuminate\Support\Facades\Event;
+
+use function Pest\Laravel\artisan;
+
+test('success', function () {
+    Event::fake();
+
+    artisan(FeedGenerateCommand::class)
+        ->assertSuccessful()
+        ->run();
+
+    getAllFeeds()->each(function (Feed $feed) {
+        Event::assertDispatched(FeedStartingEvent::class, static function (FeedStartingEvent $event) use ($feed) {
+            return $event->feed === $feed->class;
+        });
+
+        Event::assertDispatched(FeedFinishedEvent::class, static function (FeedFinishedEvent $event) use ($feed) {
+            return $event->feed === $feed->class
+                && $event->path === app($feed->class)->path();
+        });
+    });
+});

tests/Unit/Architecture/EventTest.php

@@ -0,0 +1,7 @@
+<?php
+
+declare(strict_types=1);
+
+arch()
+    ->expect('DragonCode\LaravelFeed\Events')
+    ->toHaveSuffix('Event');