Merge pull request #52 from TheDragonCode/1.x

Improved feed class generation

Author: andrey-helldar

composer.json

@@ -66,13 +66,7 @@
         "clear": "@php vendor/bin/testbench package:purge-skeleton --ansi",
         "prepare": "@php vendor/bin/testbench package:discover --ansi",
         "style": "vendor/bin/pint --parallel --ansi",
-        "test": [
-            "@clear",
-            "@php vendor/bin/pest --colors=always"
-        ],
-        "test:update": [
-            "@clear",
-            "@php vendor/bin/pest --colors=always --update-snapshots"
-        ]
+        "test": "@php vendor/bin/pest --colors=always",
+        "test:update": "@php vendor/bin/pest --colors=always --update-snapshots"
     }
 }

docs/topics/generation.topic

@@ -12,39 +12,64 @@
 
     <show-structure depth="2" />
 
-    <snippet id="generate">
+    <chapter title="Generate all feeds" id="generate_all_feeds">
+        <snippet id="generate">
+            <p>
+                To generate feeds, create the classes of feeds and its element, add links to the file
+                <code>%config-filename%</code>, next call the console command:
+            </p>
+
+            <code-block lang="bash">
+                %command-generate%
+            </code-block>
+        </snippet>
+    </chapter>
+
+    <chapter title="Generate a single feed" id="generate_a_single_feed">
+        <note>
+            Please note that the specified feed will be executed even if it is disabled in the settings file.
+        </note>
+
+        <p>
+            To generate a specific feed class, specify the class reference or name relative to the
+            <code>App\Feeds</code> namespace.
+        </p>
+
         <p>
-            To generate feeds, create the classes of feeds and its element, add links to the file
-            <code>%config-filename%</code>, next call the console command:
+            For example:
         </p>
 
         <code-block lang="bash">
-            %command-generate%
+            %command-generate% App\Feeds\UserFeed
+            %command-generate% UserFeed
+            %command-generate% User
         </code-block>
-    </snippet>
+    </chapter>
 
-    <p>
-        Each feed can be created in a certain folder of a certain storage.
-    </p>
+    <chapter title="Change location" id="change_location">
+        <p>
+            Each feed can be created in a certain folder of a certain storage.
+        </p>
 
-    <p>
-        To indicate the storage, override the property of <code>$storage</code> in the feed class:
-    </p>
+        <p>
+            To indicate the storage, override the property of <code>$storage</code> in the feed class:
+        </p>
 
-    <code-block lang="php" src="generation-feed-storage.php" include-lines="5-" />
+        <code-block lang="php" src="generation-feed-storage.php" include-lines="5-" />
 
-    <p>
-        By default, storage is <code>public</code>.
-    </p>
+        <p>
+            By default, storage is <code>public</code>.
+        </p>
 
-    <p>
-        The path to the file inside the storage is indicated in the <code>filename</code> method:
-    </p>
+        <p>
+            The path to the file inside the storage is indicated in the <code>filename</code> method:
+        </p>
 
-    <code-block lang="php" src="generation-feed-filename.php" include-lines="5-" />
+        <code-block lang="php" src="generation-feed-filename.php" include-lines="5-" />
 
-    <p>
-        By default, the class name in <code>kebab-case</code> is used.
-        For example, <code>user-feed.xml</code> for <code>UserFeed</code> class.
-    </p>
+        <p>
+            By default, the class name in <code>kebab-case</code> is used.
+            For example, <code>user-feed.xml</code> for <code>UserFeed</code> class.
+        </p>
+    </chapter>
 </topic>

src/Console/Commands/FeedGenerateCommand.php

@@ -4,6 +4,7 @@
 
 namespace DragonCode\LaravelFeed\Console\Commands;
 
+use DragonCode\LaravelFeed\Helpers\FeedHelper;
 use DragonCode\LaravelFeed\Services\Generator;
 use Illuminate\Console\Command;
 use Laravel\Prompts\Concerns\Colors;
@@ -18,24 +19,33 @@ class FeedGenerateCommand extends Command
 {
     use Colors;
 
-    public function handle(Generator $generator): void
+    public function handle(Generator $generator, FeedHelper $helper): void
     {
-        foreach ($this->feedable() as $feed => $enabled) {
+        foreach ($this->feedable($helper) as $feed => $enabled) {
             $enabled
                 ? $this->components->task($feed, fn () => $generator->feed(app($feed)))
                 : $this->components->twoColumnDetail($feed, $this->messageYellow('SKIP'));
         }
     }
 
-    protected function feedable(): array
+    protected function feedable(FeedHelper $helper): array
     {
-        if ($feed = $this->argument('class')) {
+        if ($feed = $this->resolveFeedClass($helper)) {
             return [$feed => true];
         }
 
         return config('feeds.channels');
     }
 
+    protected function resolveFeedClass(FeedHelper $helper): ?string
+    {
+        if (! $class = $this->argument('class')) {
+            return null;
+        }
+
+        return $helper->find((string) $class);
+    }
+
     protected function messageYellow(string $message): string
     {
         if ($this->option('no-ansi')) {

src/Exceptions/FeedNotFoundException.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DragonCode\LaravelFeed\Exceptions;
+
+use InvalidArgumentException;
+
+class FeedNotFoundException extends InvalidArgumentException
+{
+    public function __construct(string $class)
+    {
+        parent::__construct("Feed [$class] not found.");
+    }
+}

src/Exceptions/UnexpectedFeedException.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DragonCode\LaravelFeed\Exceptions;
+
+use DragonCode\LaravelFeed\Feeds\Feed;
+use UnexpectedValueException;
+
+class UnexpectedFeedException extends UnexpectedValueException
+{
+    public function __construct(string $class)
+    {
+        parent::__construct(
+            sprintf('The [%s] class must implement %s.', $class, Feed::class)
+        );
+    }
+}

src/Helpers/FeedHelper.php

@@ -0,0 +1,58 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DragonCode\LaravelFeed\Helpers;
+
+use DragonCode\LaravelFeed\Exceptions\FeedNotFoundException;
+use DragonCode\LaravelFeed\Exceptions\UnexpectedFeedException;
+use DragonCode\LaravelFeed\Feeds\Feed;
+use Illuminate\Foundation\Application;
+use Illuminate\Support\Str;
+
+use function class_exists;
+use function is_a;
+
+class FeedHelper
+{
+    public function __construct(
+        protected Application $laravel
+    ) {}
+
+    public function find(string $class): string
+    {
+        if (class_exists($class)) {
+            return $this->ensure($class);
+        }
+
+        if (class_exists($class = $this->resolve($class))) {
+            return $this->ensure($class);
+        }
+
+        throw new FeedNotFoundException($class);
+    }
+
+    protected function resolve(string $class): string
+    {
+        return Str::of($class)
+            ->replace('/', '\\')
+            ->ltrim('\\')
+            ->start($this->rootNamespace() . 'Feeds\\')
+            ->finish('Feed')
+            ->toString();
+    }
+
+    protected function ensure(string $class): string
+    {
+        if (! is_a($class, Feed::class, true)) {
+            throw new UnexpectedFeedException($class);
+        }
+
+        return $class;
+    }
+
+    protected function rootNamespace(): string
+    {
+        return $this->laravel->getNamespace();
+    }
+}

testbench.yaml

@@ -2,6 +2,7 @@ laravel: '@testbench'
 
 providers:
     - DragonCode\LaravelFeed\LaravelFeedServiceProvider
+    - Workbench\App\Providers\WorkbenchServiceProvider
 
 migrations:
     - workbench/database/migrations