Merge pull request #58 from TheDragonCode/1.x

Added feed management via database

Author: andrey-helldar

README.md

@@ -16,46 +16,71 @@ consumers.
 > - Chunked queries to database
 > - Draft mode for a process
 > - Easy property mapping
-> - Generation of any XML (feeds, sitemaps, etc.)
+> - Generation of any feeds, sitemaps, etc.
 
 ## Installation
 
-To get the latest version of **Laravel Feeds**, simply require the project
-using [Composer](https://getcomposer.org):
+You can install the **Laravel Feeds** package via [Composer](https://getcomposer.org):
 
 ```Bash
 composer require dragon-code/laravel-feeds
 ```
 
-After that, publish the configuration file by call the console command:
+You should publish
+the [migration](database/migrations/2025_09_01_231655_create_feeds_table.php)
+and the [config/feeds.php](config/feeds.php) file with:
 
 ```bash
-php artisan vendor:publish --tag=feeds
+php artisan vendor:publish --tag="feeds"
 ```
 
+> [!WARNING]
+>
+> Before running migrations, check the database connection settings in the [config/feeds.php](config/feeds.php) file.
+
+Now you can run migrations and proceed to [create feeds](https://feeds.dragon-code.pro/create-feeds.html).
+
 ## Basic Usage
 
 ### Create Feeds
 
+To create a feed class, use the `make:feed` console command:
+
 ```bash
 php artisan make:feed User -t
 ```
 
 As a result of executing the console command, the files `app/Feeds/UserFeed.php` and `app/Feeds/Items/UserFeedItem.php`
 will be created.
 
-### Generate Feeds
+> [!TIP]
+> When creating a feed, an operation/migration will also be created to add it to the database.
+>
+> If the project uses the [Laravel Deploy Operations](https://deploy-operations.dragon-code.pro), then an operation
+> class will be created, otherwise a migration class will be created.
+>
+> This is necessary to add and manage information about feeds in the database.
+
+Check the [operation/migration](https://feeds.dragon-code.pro/create-feeds.html) file that was created for you and run
+the console command:
+
+```bash
+# For Laravel Deploy Operations
+php artisan operations
+
+# For Laravel Migrations
+php artisan migrate
+```
 
-To generate feeds, create the classes of feeds and its element, add links to the file `config/feeds.php`, next call the
-console command:
+To generate all active feeds, use the console command:
 
 ```bash
 php artisan feed:generate
 ```
 
 ## Documentation
 
-[📚 Check out the full documentation to learn everything that Laravel Feeds has to offer.](https://feeds.dragon-code.pro)
+📚 You will find full documentation on the dedicated [documentation](https://feeds.dragon-code.pro) site.
 
 ## License
 

composer.json

@@ -14,13 +14,16 @@
         "php": "^8.2",
         "ext-dom": "*",
         "ext-libxml": "*",
+        "dragonmantank/cron-expression": "^3.4",
         "illuminate/database": "^11.0 || ^12.0",
         "illuminate/filesystem": "^11.0 || ^12.0",
         "illuminate/support": "^11.0 || ^12.0",
         "laravel/prompts": ">=0.3.6"
     },
     "require-dev": {
         "dragon-code/codestyler": "^6.3",
+        "dragon-code/laravel-deploy-operations": "^7.1",
+        "mockery/mockery": "^1.6",
         "orchestra/testbench": "^9.0 || ^10.0",
         "pestphp/pest": "^3.0 || ^4.0",
         "pestphp/pest-plugin-laravel": "^3.0 || ^4.0",
@@ -36,7 +39,8 @@
         "psr-4": {
             "Tests\\": "tests/",
             "Workbench\\App\\": "workbench/app/",
-            "Workbench\\Database\\Factories\\": "workbench/database/factories/"
+            "Workbench\\Database\\Factories\\": "workbench/database/factories/",
+            "Workbench\\Database\\Seeders\\": "workbench/database/seeders/"
         }
     },
     "config": {
@@ -63,10 +67,12 @@
             "@clear",
             "@prepare"
         ],
+        "build": "@php vendor/bin/testbench workbench:build --ansi",
         "clear": "@php vendor/bin/testbench package:purge-skeleton --ansi",
+        "migrate": "@php vendor/bin/testbench migrate:fresh --seed --ansi",
         "prepare": "@php vendor/bin/testbench package:discover --ansi",
         "style": "vendor/bin/pint --parallel --ansi",
-        "test": "@php vendor/bin/pest --colors=always",
+        "test": "@php vendor/bin/pest --parallel --colors=always",
         "test:update": "@php vendor/bin/pest --colors=always --update-snapshots"
     }
 }

config/feeds.php

@@ -3,11 +3,52 @@
 declare(strict_types=1);
 
 return [
-    'channels' => [
-        // App\Feeds\FooFeed::class => (bool) env('FEED_FOO_ENABLED', true),
-        // App\Feeds\BarFeed::class => (bool) env('FEED_BAR_ENABLED', true),
-        // App\Feeds\BazFeed::class => (bool) env('FEED_BAZ_ENABLED', false),
+    /**
+     * Pretty-print the generated feed output.
+     *
+     * When enabled, the resulting XML/JSON will include indentation and
+     * human‑friendly formatting. Disable for slightly smaller payload size.
+     *
+     * By default, false
+     */
+    'pretty' => (bool) env('FEED_PRETTY', false),
+
+    /**
+     * Database table settings used by the package (e.g., for generation logs or state).
+     */
+    'table' => [
+        /**
+         * The database connection name to use.
+         *
+         * Should match a connection defined in config/database.php under
+         * the "connections" array.
+         */
+        'connection' => env('DB_CONNECTION', 'sqlite'),
+
+        /**
+         * The database table name used by the package.
+         */
+        'table' => env('FEED_TABLE', 'feeds'),
     ],
 
-    'pretty' => (bool) env('FEED_PRETTY', false),
+    /**
+     * Scheduling options for feed generation/update tasks.
+     */
+    'schedule' => [
+        /**
+         * Time To Live (in minutes) for the schedule lock or cache.
+         *
+         * Controls how frequently a scheduled job may be executed to avoid
+         * overlapping or excessively frequent runs.
+         */
+        'ttl' => (int) env('FEED_SCHEDULE_TTL', 1440),
+
+        /**
+         * Run scheduled jobs in the background.
+         *
+         * When true, tasks will be dispatched to run asynchronously so they do
+         * not block the current process. Set to false to run in the foreground.
+         */
+        'background' => (bool) env('FEED_SCHEDULE_RUN_BACKGROUND', true),
+    ],
 ];

database/migrations/2025_09_01_231655_create_feeds_table.php

@@ -0,0 +1,48 @@
+<?php
+
+declare(strict_types=1);
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Database\Schema\Builder;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration {
+    public function up(): void
+    {
+        $this->schema()->create($this->table(), function (Blueprint $table) {
+            $table->id();
+
+            $table->string('class')->unique();
+            $table->string('title');
+
+            $table->string('expression');
+
+            $table->boolean('is_active');
+
+            $table->timestamp('last_activity')->nullable();
+            $table->timestamps();
+            $table->softDeletes();
+        });
+    }
+
+    public function down(): void
+    {
+        $this->schema()->dropIfExists($this->table());
+    }
+
+    protected function schema(): Builder
+    {
+        return Schema::connection($this->connection());
+    }
+
+    protected function connection(): ?string
+    {
+        return config('feeds.table.connection');
+    }
+
+    protected function table(): string
+    {
+        return config('feeds.table.table');
+    }
+};

docs/images/laravel-idea.png

@@ -19,8 +19,8 @@
         <toc-element topic="advanced-usage.topic" />
     </toc-element>
     <toc-element toc-title="Receipts">
-        <toc-element topic="sitemap.topic" />
-        <toc-element topic="instagram.topic" />
-        <toc-element topic="yandex.topic" />
+        <toc-element topic="receipt-sitemap.topic" />
+        <toc-element topic="receipt-instagram.topic" />
+        <toc-element topic="receipt-yandex.topic" />
     </toc-element>
 </instance-profile>

docs/images/laravel-idea_dark.png

@@ -6,5 +6,8 @@
 
 class UserFeed extends Feed
 {
-    protected string $storage = 'public';
+    public function chunkSize(): int
+    {
+        return 500;
+    }
 }

docs/laravel-feeds.tree

@@ -2,8 +2,6 @@
 
 declare(strict_types=1);
 
-namespace App\Feeds;
-
 use DragonCode\LaravelFeed\Feeds\Feed;
 
 class UserFeed extends Feed
@@ -12,4 +10,9 @@ public function header(): string
     {
         return '<?xml version="1.0" encoding="UTF-8"?>';
     }
+
+    public function footer(): string
+    {
+        return '';
+    }
 }

docs/snippets/generation-feed-storage.php renamed to docs/snippets/advanced-feed-chunk.php

@@ -11,7 +11,8 @@ class UserFeedInfo extends FeedInfo
     public function toArray(): array
     {
         return [
-            // ...
+            'name'    => config('app.name'),
+            'company' => config('app.name'),
         ];
     }
 }