Merge pull request #2551 from BinarCode/2.x

binaryk · web-flow · commit 0f0e4a8c6f4e · 2021-06-07T19:28:55.000+03:00
2.x
diff --git a/.github/workflows/php-cs-fixer.yml b/.github/workflows/php-cs-fixer.yml
@@ -3,27 +3,21 @@ name: Check & fix styling
 on: [push]
 
 jobs:
-    style:
+    php-cs-fixer:
         runs-on: ubuntu-latest
 
         steps:
-            -   name: Checkout code
-                uses: actions/checkout@v1
+            - name: Checkout code
+              uses: actions/checkout@v2
+              with:
+                  ref: ${{ github.head_ref }}
 
-            -   name: Fix style
-                uses: docker://oskarstark/php-cs-fixer-ga
-                with:
-                    args: --config=.php_cs --allow-risky=yes
+            - name: Run PHP CS Fixer
+              uses: docker://oskarstark/php-cs-fixer-ga
+              with:
+                  args: --config=.php_cs.dist.php --allow-risky=yes
 
-            -   name: Extract branch name
-                shell: bash
-                run: echo "##[set-output name=branch;]$(echo ${GITHUB_REF#refs/heads/})"
-                id: extract_branch
-
-            -   name: Commit changes
-                uses: stefanzweifel/git-auto-commit-action@v2.3.0
-                with:
-                    commit_message: Fix styling
-                    branch: ${{ steps.extract_branch.outputs.branch }}
-                env:
-                    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+            - name: Commit changes
+              uses: stefanzweifel/git-auto-commit-action@v4
+              with:
+                  commit_message: Fix styling
diff --git a/.github/workflows/psalm.yml b/.github/workflows/psalm.yml
@@ -0,0 +1,33 @@
+name: Psalm
+
+on:
+  push:
+    paths:
+      - '**.php'
+      - 'psalm.xml.dist'
+
+jobs:
+  psalm:
+    name: psalm
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.0'
+          extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, bcmath, soap, intl, gd, exif, iconv, imagick
+          coverage: none
+
+      - name: Cache composer dependencies
+        uses: actions/cache@v2
+        with:
+          path: vendor
+          key: composer-${{ hashFiles('composer.lock') }}
+
+      - name: Run composer install
+        run: composer install -n --prefer-dist
+
+      - name: Run psalm
+        run: ./vendor/bin/psalm --output-format=github
diff --git a/.github/workflows/run-tests.yml b/.github/workflows/run-tests.yml
@@ -9,14 +9,12 @@ jobs:
       fail-fast: true
       matrix:
         os: [ubuntu-latest]
-        php: [8.0, 7.4]
-        laravel: [^8.0, ^7.0]
+        php: [8.0]
+        laravel: [^8.0]
         dependency-version: [prefer-stable]
         include:
           - laravel: ^8.0
             testbench: ^6.0
-          - laravel: ^7.0
-            testbench: ^5.2
 
     name: P${{ matrix.php }} - L${{ matrix.laravel }} - ${{ matrix.dependency-version }} - ${{ matrix.os }}
 
diff --git a/.gitignore b/.gitignore
@@ -1,10 +1,14 @@
-build
-composer.lock
-vendor
-coverage
 .idea
-output
-docs/node_modules
-docs/.vuepress/dist
+.php_cs
 .php_cs.cache
 .phpunit.result.cache
+build
+composer.lock
+coverage
+docs
+phpunit.xml
+psalm.xml
+testbench.yaml
+vendor
+node_modules
+.php-cs-fixer.cache
diff --git a/.php_cs.dist.php b/.php_cs.dist.php
@@ -1,10 +1,6 @@
 <?php
 
 $finder = Symfony\Component\Finder\Finder::create()
-    ->notPath('bootstrap/*')
-    ->notPath('storage/*')
-    ->notPath('storage/*')
-    ->notPath('resources/view/mail/*')
     ->in([
         __DIR__ . '/src',
         __DIR__ . '/tests',
@@ -14,14 +10,14 @@
     ->ignoreDotFiles(true)
     ->ignoreVCS(true);
 
-return PhpCsFixer\Config::create()
+return (new PhpCsFixer\Config())
     ->setRules([
         '@PSR2' => true,
         'array_syntax' => ['syntax' => 'short'],
-        'ordered_imports' => ['sortAlgorithm' => 'alpha'],
+        'ordered_imports' => ['sort_algorithm' => 'alpha'],
         'no_unused_imports' => true,
         'not_operator_with_successor_space' => true,
-        'trailing_comma_in_multiline_array' => true,
+        'trailing_comma_in_multiline' => true,
         'phpdoc_scalar' => true,
         'unary_operator_spaces' => true,
         'binary_operator_spaces' => true,
@@ -30,9 +26,15 @@
         ],
         'phpdoc_single_line_var_spacing' => true,
         'phpdoc_var_without_name' => true,
+        'class_attributes_separation' => [
+            'elements' => [
+                'method' => 'one',
+            ],
+        ],
         'method_argument_space' => [
             'on_multiline' => 'ensure_fully_multiline',
             'keep_multiple_spaces_after_comma' => true,
-        ]
+        ],
+        'single_trait_insert_per_statement' => true,
     ])
     ->setFinder($finder);
diff --git a/README.md b/README.md
@@ -154,6 +154,29 @@ $scheduler = MailatorSchedule::init('Invoice reminder.')
 
 The `CustomAction` should implement the `Binarcode\LaravelMailator\Actions\Action` class.
 
+### Target
+
+You can link the scheduler with any entity like this:
+
+```php
+        MailatorSchedule::init('Invoice reminder.')
+            ->mailable(new InvoiceReminderMailable())
+            ->days(1)
+            ->target($invoice)
+            ->save();
+```
+
+and then in the `Invoice` model you can get all emails related to it: 
+
+```php
+// app/Models/Invoice.php
+public function schedulers() 
+{
+        return $this->morphMany(Binarcode\LaravelMailator\Models\MailatorSchedule::class, 'targetable');
+}
+...
+```
+
 ### Testing
 
 ``` bash
diff --git a/composer.json b/composer.json
@@ -17,17 +17,18 @@
         }
     ],
     "require": {
-        "php": "^7.4|^8.0",
-        "illuminate/support": "^7.0|^8.0",
-        "opis/closure": "^3.5",
-        "tijsverkoyen/css-to-inline-styles": "^2.2"
+        "php": "^8.0",
+        "illuminate/contracts": "^8.37",
+        "opis/closure": "^3.6"
     },
     "require-dev": {
-        "friendsofphp/php-cs-fixer": "^2.16",
-        "laravel/legacy-factories": "^1.0",
-        "orchestra/testbench": "^5.2|^6.0",
-        "phpunit/phpunit": "^9.0",
-        "spatie/test-time": "^1.2"
+        "brianium/paratest": "^6.2",
+        "nunomaduro/collision": "^5.3",
+        "orchestra/testbench": "^6.15",
+        "phpunit/phpunit": "^9.3",
+        "spatie/laravel-ray": "^1.9",
+        "spatie/test-time": "^1.2",
+        "vimeo/psalm": "^4.4"
     },
     "autoload": {
         "psr-4": {
@@ -40,9 +41,9 @@
         }
     },
     "scripts": {
-        "test": "vendor/bin/phpunit",
-        "test-coverage": "vendor/bin/phpunit --coverage-html coverage",
-        "format": "vendor/bin/php-cs-fixer fix --allow-risky=yes"
+        "psalm": "vendor/bin/psalm",
+        "test": "./vendor/bin/testbench package:test --parallel --no-coverage",
+        "test-coverage": "vendor/bin/phpunit --coverage-html coverage"
     },
     "config": {
         "sort-packages": true
diff --git a/database/migrations/create_mailator_tables.php.stub b/database/migrations/create_mailator_tables.php.stub
@@ -15,6 +15,7 @@ class CreateMailatorTables extends Migration
 
             $table->string('name', 100)->nullable();
             $table->text('mailable_class')->nullable();
+            $table->nullableMorphs('targetable');
             $table->text('action')->nullable();
             $table->unsignedInteger('delay_minutes')->nullable()->comment('Number of hours/days.');
             $table->enum('time_frame_origin', [
diff --git a/psalm.xml.dist b/psalm.xml.dist
@@ -1,21 +1,16 @@
 <?xml version="1.0"?>
 <psalm
-    errorLevel="4"
+    errorLevel="6"
     findUnusedVariablesAndParams="true"
     resolveFromConfigFile="true"
-    useDocblockPropertyTypes="true"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xmlns="https://getpsalm.org/schema/config"
     xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
 >
     <projectFiles>
         <directory name="src"/>
+        <ignoreFiles>
+            <directory name="vendor"/>
+        </ignoreFiles>
     </projectFiles>
-
-    <issueHandlers>
-    </issueHandlers>
-
-    <plugins>
-        <pluginClass class="Psalm\LaravelPlugin\Plugin"/>
-    </plugins>
 </psalm>
diff --git a/src/Jobs/SendMailJob.php b/src/Jobs/SendMailJob.php
@@ -13,7 +13,10 @@
 
 class SendMailJob implements ShouldQueue
 {
-    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
+    use Dispatchable;
+    use InteractsWithQueue;
+    use Queueable;
+    use SerializesModels;
 
     public bool $deleteWhenMissingModels = true;
 
diff --git a/src/Models/Concerns/HasTarget.php b/src/Models/Concerns/HasTarget.php
@@ -0,0 +1,28 @@
+<?php
+
+namespace Binarcode\LaravelMailator\Models\Concerns;
+
+use Binarcode\LaravelMailator\Models\MailatorSchedule;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\MorphTo;
+
+/**
+ * Trait HasTarget
+ * @mixin MailatorSchedule
+ * @package Binarcode\LaravelMailator\Models\Concerns
+ */
+trait HasTarget
+{
+    public function targetable(): MorphTo
+    {
+        return $this->morphTo();
+    }
+
+    public function target(Model $target): self
+    {
+        $this->targetable_type = $target::class;
+        $this->targetable_id = $target->getKey();
+
+        return $this;
+    }
+}
diff --git a/src/Models/MailTemplateable.php b/src/Models/MailTemplateable.php
@@ -6,8 +6,6 @@
 
 interface MailTemplateable
 {
-    public function htmlWithInlinedCss(): string;
-
     public function placeholders();
 
     public function preparePlaceholders(): Collection;
diff --git a/src/Models/MailatorSchedule.php b/src/Models/MailatorSchedule.php
@@ -7,20 +7,22 @@
 use Binarcode\LaravelMailator\Exceptions\InstanceException;
 use Binarcode\LaravelMailator\Jobs\SendMailJob;
 use Binarcode\LaravelMailator\Models\Concerns\ConstraintsResolver;
+use Binarcode\LaravelMailator\Models\Concerns\HasTarget;
 use Carbon\Carbon;
 use Carbon\CarbonInterface;
 use Closure;
 use Illuminate\Contracts\Mail\Mailable;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Support\Arr;
-use Illuminate\Support\Facades\Config;
 use Illuminate\Support\Facades\Validator;
 use Illuminate\Support\Str;
 use Opis\Closure\SerializableClosure;
 
 /**
  * Class MailatorSchedule.
  *
+ * @property string targetable_type
+ * @property string targetable_id
  * @property string mailable_class
  * @property string delay_minutes
  * @property string time_frame_origin
@@ -34,6 +36,7 @@
 class MailatorSchedule extends Model
 {
     use ConstraintsResolver;
+    use HasTarget;
 
     public function getTable()
     {
diff --git a/src/Models/PlainHtmlTemplate.php b/src/Models/PlainHtmlTemplate.php
diff --git a/tests/Fixtures/ExternalHtml/SendGrid.php b/tests/Fixtures/ExternalHtml/SendGrid.php
diff --git a/tests/Fixtures/ExternalHtml/WelcomeMailable.php b/tests/Fixtures/ExternalHtml/WelcomeMailable.php
diff --git a/tests/Fixtures/WelcomeMailatorMailable.php b/tests/Fixtures/WelcomeMailatorMailable.php
diff --git a/tests/TestCase.php b/tests/TestCase.php
diff --git a/tests/database/factories/MailatorScheduleFactory.php b/tests/database/factories/MailatorScheduleFactory.php

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,10 @@`
`13`	`13`
`14`	`14`	`class SendMailJob implements ShouldQueue`
`15`	`15`	`{`
`16`		`- use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;`
	`16`	`+ use Dispatchable;`
	`17`	`+ use InteractsWithQueue;`
	`18`	`+ use Queueable;`
	`19`	`+ use SerializesModels;`
`17`	`20`
`18`	`21`	`public bool $deleteWhenMissingModels = true;`
`19`	`22`