Feature/codebase enhancement

.github/FUNDING.yml

@@ -0,0 +1,2 @@
+github: MoamenEltouny
+buy_me_a_coffee: moameneltouny

.github/workflows/php-cs-fixer.yml

@@ -0,0 +1,23 @@
+name: PHP Coding Standards Fixer
+
+on: [push]
+
+jobs:
+  php-cs-fixer:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.head_ref }}
+
+      - name: Run PHP CS Fixer
+        uses: docker://oskarstark/php-cs-fixer-ga
+        with:
+          args: --config=.php-cs-fixer.dist.php --allow-risky=yes
+
+      - name: Commit changes
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          commit_message: Fixing php-cs

.github/workflows/build.yml → .github/workflows/tests.yml

@@ -1,14 +1,17 @@
-name: build
+name: Tests
 
-on: [push, pull_request]
+on:
+  push:
+    branches: [ main, develop ]
+  pull_request:
 
 jobs:
   run:
     runs-on: ${{ matrix.operating-system }}
     strategy:
       matrix:
         operating-system: [ubuntu-latest]
-        php-versions: ["8.1", "8.2", "8.3"]
+        php-versions: ['8.2', '8.3', '8.4']
     name: PHP ${{ matrix.php-versions }} Test on ${{ matrix.operating-system }}
 
     steps:
@@ -19,7 +22,7 @@ jobs:
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php-versions }}
-          extensions: mbstring, pdo, pdo_sqlite, sqlite3, intl, zip
+          extensions: mbstring, pdo, intl, zip
           coverage: none
 
       - name: Check PHP Version
@@ -35,7 +38,7 @@ jobs:
         run: composer validate
 
       - name: Install dependencies
-        run: composer install --prefer-dist --no-progress --no-suggest
+        run: composer install --prefer-dist --no-progress
 
       - name: Run test suite
-        run: vendor/bin/phpunit
+        run: vendor/bin/phpunit --testdox

.gitignore

@@ -1,3 +1,4 @@
-vendor
+/vendor
 composer.lock
-.phpunit.cache
+.phpunit.result.cache
+.php-cs-fixer.cache

.php-cs-fixer.dist.php

@@ -0,0 +1,39 @@
+<?php
+
+$finder = Symfony\Component\Finder\Finder::create()
+    ->notPath('bootstrap/*')
+    ->notPath('storage/*')
+    ->notPath('storage/*')
+    ->notPath('resources/view/mail/*')
+    ->in([
+        __DIR__ . '/src',
+        __DIR__ . '/tests',
+    ])
+    ->name('*.php')
+    ->notName('*.blade.php')
+    ->ignoreDotFiles(true)
+    ->ignoreVCS(true);
+
+return (new PhpCsFixer\Config())
+    ->setRules([
+        '@PSR12' => true,
+        'indentation_type' => true,
+        'array_syntax' => ['syntax' => 'short'],
+        'ordered_imports' => ['sort_algorithm' => 'alpha'],
+        'no_unused_imports' => true,
+        'not_operator_with_successor_space' => true,
+        'trailing_comma_in_multiline' => true,
+        'phpdoc_scalar' => true,
+        'unary_operator_spaces' => true,
+        'binary_operator_spaces' => true,
+        'blank_line_before_statement' => [
+            'statements' => ['break', 'continue', 'declare', 'return', 'throw', 'try'],
+        ],
+        'phpdoc_single_line_var_spacing' => true,
+        'phpdoc_var_without_name' => true,
+        'method_argument_space' => [
+            'on_multiline' => 'ensure_fully_multiline',
+            'keep_multiple_spaces_after_comma' => true,
+        ],
+    ])
+    ->setFinder($finder);

README.md

@@ -1,13 +1,11 @@
 <p align="center"><a href="https://pharaonic.io" target="_blank"><img src="https://raw.githubusercontent.com/Pharaonic/logos/main/executor.jpg"></a></p>
 
 <p align="center">
-  <a href="https://laravel.com" target="_blank"><img src="https://img.shields.io/static/v1?label=Laravel&message=10.x, 11.x&color=F05340&style=flat-square" alt="Laravel Version : 10.x, 11.x"></a>
-  <img src="https://img.shields.io/static/v1?label=License&message=MIT&color=brightgreen&style=flat-square" alt="License">
-  <img src="https://img.shields.io/github/actions/workflow/status/pharaonic/laravel-executor/build.yml" alt="GitHub Actions Workflow Status">
-  <br>
-  <a href="https://packagist.org/packages/Pharaonic/laravel-executor" target="_blank"><img src="https://img.shields.io/static/v1?label=Packagist&message=pharaonic/laravel-executor&color=blue&logo=packagist&logoColor=white" alt="Source"></a>
-  <a href="https://packagist.org/packages/pharaonic/laravel-executor" target="_blank"><img src="https://poser.pugx.org/pharaonic/laravel-executor/v" alt="Packagist Version"></a>
-  <a href="https://packagist.org/packages/pharaonic/laravel-executor" target="_blank"><img src="https://poser.pugx.org/pharaonic/laravel-executor/downloads" alt="Packagist Downloads"></a>
+<a href="https://github.com/Pharaonic/laravel-executor/actions"><img src="https://github.com/Pharaonic/laravel-executor/workflows/tests/badge.svg" alt="Build Status"></a>
+<a href="https://laravel.com" target="_blank"><img src="https://img.shields.io/static/v1?label=Laravel&message=11.x&color=F05340&style=flat-square" alt="Laravel Version : 11.x"></a>
+  <a href="https://packagist.org/packages/pharaonic/laravel-executor" target="_blank"><img src="https://poser.pugx.org/pharaonic/laravel-executor/downloads" alt="Total Downloads"></a>
+<a href="https://packagist.org/packages/Pharaonic/laravel-executor"><img src="https://img.shields.io/packagist/v/Pharaonic/laravel-executor" alt="Latest Stable Version"></a>
+<a href="https://packagist.org/packages/Pharaonic/laravel-executor"><img src="https://img.shields.io/static/v1?label=License&message=MIT&color=brightgreen&style=flat-square" alt="License"></a>
 </p>
 
 <h3 align="center">Allows you to execute commands, actions, jobs, and automated tasks on your production server.</h3>

composer.json

@@ -24,11 +24,12 @@
         }
     ],
     "require": {
-        "php": ">=8.1",
-        "laravel/framework": ">=10.0"
+        "php": "~8.2|~8.3|~8.4",
+        "laravel/framework": "^11.0",
+        "pharaonic/php-dot-array": "^2.0"
     },
     "require-dev": {
-        "orchestra/testbench": "^8.0"
+        "orchestra/testbench": "^9.15"
     },
     "config": {
         "sort-packages": true

config/executor.php

@@ -0,0 +1,13 @@
+<?php
+
+return [
+    /**
+     * The database connection that should be used by the executor.
+     */
+    'connection' => env('EXECUTOR_CONNECTION', config('database.default')),
+
+    /**
+     * The table that should be used to store the executors.
+     */
+    'table' => env('EXECUTOR_TABLE', 'executors'),
+];

database/migrations/2024_07_07_000001_create_executors_table.php

@@ -14,15 +14,17 @@ class CreateExecutorsTable extends Migration
      */
     public function up()
     {
-        Schema::create('executors', function (Blueprint $table) {
-            $table->id();
-            $table->unsignedTinyInteger('type')->default(ExecutorType::Always);
-            $table->string('executor');
-            $table->string('tag')->nullable();
-            $table->integer('batch')->default(1);
-            $table->integer('executed')->default(0);
-            $table->timestamp('last_executed_at')->nullable();
-        });
+        Schema::connection(config('pharaonic.executor.connection', config('database.default')))
+            ->create(config('pharaonic.executor.table', 'executors'), function (Blueprint $table) {
+                $table->id();
+                $table->unsignedTinyInteger('type')->default(ExecutorType::Always);
+                $table->string('name');
+                $table->json('tags')->nullable();
+                $table->json('servers')->nullable();
+                $table->integer('batch')->nullable();
+                $table->integer('executed')->default(0);
+                $table->timestamp('last_executed_at')->nullable();
+            });
     }
 
     /**
@@ -32,6 +34,7 @@ public function up()
      */
     public function down()
     {
-        Schema::dropIfExists('executors');
+        Schema::connection(config('pharaonic.executor.connection', config('database.default')))
+            ->dropIfExists(config('pharaonic.executor.table', 'executors'));
     }
 }

phpunit.xml.dist

@@ -1,13 +1,13 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" backupGlobals="false" bootstrap="vendor/autoload.php" colors="true" processIsolation="false" stopOnFailure="false" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd" cacheDirectory=".phpunit.cache" backupStaticProperties="false">
-  <testsuites>
-    <testsuite name="laravel-executor Test Suite">
-      <directory suffix="Test.php">./tests/</directory>
-    </testsuite>
-  </testsuites>
-  <source>
-    <include>
-      <directory suffix=".php">./src/</directory>
-    </include>
-  </source>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/11.0/phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+         colors="true">
+
+    <testsuites>
+        <testsuite name="laravel-executor Test Suite">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+
 </phpunit>

src/Executor.php → src/Classes/Executor.php

@@ -1,15 +1,24 @@
 <?php
 
-namespace Pharaonic\Laravel\Executor;
+namespace Pharaonic\Laravel\Executor\Classes;
 
+use Illuminate\Console\Concerns\InteractsWithIO;
 use Illuminate\Console\OutputStyle;
 use Illuminate\Foundation\Bus\PendingDispatch;
 use Illuminate\Support\Facades\Artisan;
 use Pharaonic\Laravel\Executor\Enums\ExecutorType;
-use Pharaonic\Laravel\Executor\Traits\InteractsWithIO;
 use Symfony\Component\Console\Input\ArgvInput;
 use Symfony\Component\Console\Output\ConsoleOutput;
 
+/**
+ * @property ExecutorType $type
+ * @property array $tags
+ * @property array $servers
+ * @method void up()
+ * @method void down()
+ * @method PendingDispatch job(string|object $job, ...$arguments)
+ * @method int command(string $command, array $parameters = [])
+ */
 abstract class Executor
 {
     use InteractsWithIO;
@@ -22,32 +31,50 @@ abstract class Executor
     public $type = ExecutorType::Always;
 
     /**
-     * The tag of the executor.
+     * The tags of the executor.
      *
-     * @var string|null
+     * @var array
      */
-    public $tag = null;
+    public $tags = [];
 
     /**
-     * Execute it.
-     * 
+     * The servers of the executor.
+     *
+     * @var array
+     */
+    public $servers = [];
+
+    /**
+     * Run the executor.
+     *
      * @return void
      */
-    abstract public function handle(): void;
+    abstract public function up(): void;
+
+    /**
+     * Reverse the executor.
+     *
+     * @return void
+     */
+    abstract public function down(): void;
 
     /**
      * Create a new Executor instance.
-     * 
+     *
      * @return void
      */
     public function __construct()
     {
-        if (!($this->type instanceof ExecutorType)) {
+        if (! ($this->type instanceof ExecutorType)) {
             throw new \Exception('The type of the executor must be an instance of ExecutorType.');
         }
 
-        if (!is_null($this->tag) && !is_string($this->tag) && !is_array($this->tag)) {
-            throw new \Exception('The tag of the executor must be a string or an array or null.');
+        if (! is_array($this->tags)) {
+            throw new \Exception('The tags of the executor must be an array.');
+        }
+
+        if (! is_array($this->servers)) {
+            throw new \Exception('The servers of the executor must be an array of ips.');
         }
 
         $this->output = new OutputStyle(new ArgvInput(), new ConsoleOutput());