Resolve stripping media tags (#14)

* Maintenance notice

* Correct issue where @media files are being removed.

* Upgrade depends

* Upgrade depends

---------

Co-authored-by: Pete Cooper <pete@petecoop.co.uk>

Author: SimplyCorey

.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: composer
+    directory: /
+    schedule:
+      interval: weekly
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: weekly

.github/workflows/laravel-package.yml

@@ -6,29 +6,44 @@ on:
 
 jobs:
   laravel:
-    name: Laravel Package (PHP ${{ matrix.php-versions }} on ${{ matrix.operating-system }})
+    name: Laravel ${{ matrix.laravel }} (PHP ${{ matrix.php-version }} on ${{ matrix.operating-system }})
 
     runs-on: ${{ matrix.operating-system }}
 
     strategy:
+      fail-fast: false
       matrix:
-        operating-system: [ubuntu-latest]
-        php-versions: ['8.4']
+        include:
+          - operating-system: ubuntu-latest
+            php-version: '8.4'
+            laravel: '12'
+            illuminate-version: '^12.55'
+            testbench-version: '^10.11'
+          - operating-system: ubuntu-latest
+            php-version: '8.4'
+            laravel: '13'
+            illuminate-version: '^13.10'
+            testbench-version: '^11.1'
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v1
+        uses: actions/checkout@v4
 
       - name: Setup PHP, with composer and extensions
         uses: shivammathur/setup-php@v2
         with:
-          php-version: ${{ matrix.php-versions }}
+          php-version: ${{ matrix.php-version }}
+
+      - name: Configure Laravel dependencies
+        run: |
+          composer require --no-interaction --no-progress --no-update "illuminate/support:${{ matrix.illuminate-version }}" "illuminate/view:${{ matrix.illuminate-version }}"
+          composer require --dev --no-interaction --no-progress --no-update "orchestra/testbench:${{ matrix.testbench-version }}"
 
       - name: Install Composer dependencies
-        run: composer install --no-progress --no-suggest --prefer-dist --optimize-autoloader
+        run: composer update --no-interaction --no-progress --prefer-dist --optimize-autoloader
 
       - name: Check styling with PHP CS Fixer
-        uses: StephaneBour/actions-php-cs-fixer@1.0
+        run: vendor/bin/php-cs-fixer fix --dry-run --diff --config=.php-cs-fixer.dist.php
 
       - name: Test with phpunit
-        run: vendor/bin/phpunit --coverage-text
+        run: vendor/bin/phpunit

.gitignore

@@ -4,6 +4,7 @@ composer.lock
 /.vscode
 npm-debug.log
 .php_cs.cache
+.php-cs-fixer.cache
 .phpunit.result.cache
 .DS_Store
 /.phpunit.cache/

.php-cs-fixer.dist.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+use PhpCsFixer\Config;
+use PhpCsFixer\Finder;
+
+return (new Config())
+    ->setRiskyAllowed(false)
+    ->setRules([
+        '@PSR12' => true,
+        'new_with_parentheses' => false,
+    ])
+    ->setFinder(
+        Finder::create()
+            ->in([
+                __DIR__ . '/src',
+                __DIR__ . '/tests',
+            ])
+    );

composer.json

@@ -16,14 +16,15 @@
     "require": {
         "php": "^8.4",
         "incentfit/inky": "1.3.6.5",
-        "illuminate/support": "^11.0|^12.0|^13.0",
-        "illuminate/view": "^11.0|^12.0|^13.0",
-        "symfony/dom-crawler": "^2.7|^3.0|^4.0|^5.0|^7.0",
-        "tijsverkoyen/css-to-inline-styles": "^2.2"
+        "illuminate/support": "^12.55|^13.10",
+        "illuminate/view": "^12.55|^13.10",
+        "symfony/dom-crawler": "^7.4.12|^8.0.12",
+        "tijsverkoyen/css-to-inline-styles": "^2.4"
     },
     "require-dev": {
-        "phpunit/phpunit": "^8.0|^9.0|^10.5|^11.0",
-        "graham-campbell/testbench": "^5.3|^6.1"
+        "phpunit/phpunit": ">=13.1 <13.2",
+        "orchestra/testbench": "^10.11|^11.1",
+        "friendsofphp/php-cs-fixer": "^3.95"
     },
     "autoload": {
         "psr-4": {

phpunit.xml.dist

@@ -1,5 +1,5 @@
 <?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" stopOnError="false" stopOnFailure="false" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd" cacheDirectory=".phpunit.cache" backupStaticProperties="false">
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" backupGlobals="false" bootstrap="vendor/autoload.php" colors="true" processIsolation="false" stopOnError="false" stopOnFailure="false" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/13.1/phpunit.xsd" cacheDirectory=".phpunit.cache" backupStaticProperties="false">
   <testsuites>
     <testsuite name="Laravel Inky Test Suite">
       <directory suffix="Test.php">./tests</directory>

readme.md

@@ -1,12 +1,10 @@
-[![Actions Status](https://github.com/rsvpify/laravel-inky/workflows/Testing%20Laravel%20Package/badge.svg)](https://github.com/rsvpify/laravel-inky/actions)
-
-Allows you to use Foundation's [Inky](http://foundation.zurb.com/emails/docs/inky.html) email templates nicely in Laravel 6-11.
+Allows you to use Foundation's [Inky](http://foundation.zurb.com/emails/docs/inky.html) email templates nicely in Laravel 12-13. Requires PHP 8.4+.
 
 Any views with a `.inky.php` extension will be compiled with both Inky and Blade, allowing you to use both templating engines seamlessly together. CSS is automatically inlined so styles work in email clients that don't support external stylesheets.
 
 ## Installation
 
-Require with composer
+Require with composer.
 ```
 composer require rsvpify/laravel-inky
 ```

src/InkyCompiler.php

@@ -5,25 +5,23 @@
 use IncentFit\Inky\Inky;
 use Illuminate\Filesystem\Filesystem;
 use Illuminate\View\Compilers\Compiler;
+use Illuminate\View\Compilers\BladeCompiler;
 use Illuminate\View\Compilers\CompilerInterface;
 
 class InkyCompiler extends Compiler implements CompilerInterface
 {
-    protected $inky;
+    protected Inky $inky;
 
-    protected $blade;
+    protected ?string $path = null;
 
-    protected $path;
-
-    public function __construct(Compiler $blade, Filesystem $files, $cachePath)
+    public function __construct(protected BladeCompiler $blade, Filesystem $files, string $cachePath)
     {
         parent::__construct($files, $cachePath);
 
-        $this->blade = $blade;
         $this->inky = new Inky;
     }
 
-    public function compile($path = null)
+    public function compile($path = null): void
     {
         if ($path) {
             $this->setPath($path);
@@ -36,29 +34,29 @@ public function compile($path = null)
         }
     }
 
-    public function getPath()
+    public function getPath(): ?string
     {
         return $this->path;
     }
 
-    public function setPath($path)
+    public function setPath(string $path): static
     {
         $this->path = $path;
 
         return $this;
     }
 
-    public function compileString($value)
+    public function compileString(string $value): string
     {
         return $this->blade->compileString($this->inky->releaseTheKraken($value));
     }
 
-    public function getFiles()
+    public function getFiles(): Filesystem
     {
         return $this->files;
     }
 
-    public function getBlade()
+    public function getBlade(): BladeCompiler
     {
         return $this->blade;
     }

src/InkyCompilerEngine.php

@@ -2,6 +2,7 @@
 
 namespace Rsvpify\LaravelInky;
 
+use Illuminate\Support\Str;
 use Illuminate\Filesystem\Filesystem;
 use Symfony\Component\DomCrawler\Crawler;
 use Illuminate\View\Engines\CompilerEngine;
@@ -10,21 +11,15 @@
 
 class InkyCompilerEngine extends CompilerEngine
 {
-    protected $filesystem;
-
-    public function __construct(CompilerInterface $compiler, Filesystem $filesystem)
+    public function __construct(CompilerInterface $compiler, protected Filesystem $filesystem)
     {
         parent::__construct($compiler);
-
-        $this->filesystem = $filesystem;
     }
 
-    public function get($inkyFilePath, array $data = [])
+    public function get($inkyFilePath, array $data = []): string
     {
-        // Compiles the inky template as if it were a regular blade file
         $html = parent::get($inkyFilePath, $data);
 
-        // remove css stylesheet links from email's HTML
         $crawler = new Crawler;
         $crawler->addHtmlContent($html);
         $cssLinks = $crawler->filter('link[rel=stylesheet]');
@@ -37,18 +32,44 @@ public function get($inkyFilePath, array $data = [])
 
         $htmlWithoutLinks = $crawler->html();
 
-        // Combine all stylesheets into 1 string of CSS
-        $combinedStyles = collect(config('inky.stylesheets'))->map(function ($path) {
-            return $this->filesystem->get(base_path($path));
-        })->implode("\n\n");
+        $combinedStyles = collect(config('inky.stylesheets'))
+            ->map(fn ($path) => $this->filesystem->get(base_path($path)))
+            ->implode("\n\n");
 
         $inliner = new CssToInlineStyles;
 
-        return $inliner->convert($htmlWithoutLinks, $combinedStyles);
+        return $inliner->convert(
+            $this->appendExternalMediaQueries($htmlWithoutLinks, $combinedStyles),
+            $combinedStyles
+        );
     }
 
-    public function getFiles()
+    public function getFiles(): Filesystem
     {
         return $this->filesystem;
     }
+
+    protected function appendExternalMediaQueries(string $html, string $css): string
+    {
+        if (($mediaQueries = $this->extractMediaQueries($css)) === '') {
+            return $html;
+        }
+
+        $styleTag = "<style>\n{$mediaQueries}\n</style>";
+
+        if (Str::contains($html, '</head>')) {
+            return Str::replaceFirst('</head>', "{$styleTag}\n</head>", $html);
+        }
+
+        return "{$styleTag}\n{$html}";
+    }
+
+    protected function extractMediaQueries(string $css): string
+    {
+        return Str::of($css)
+            ->matchAll('/@media[^{]*+{(?:[^{}]++|{[^{}]*+})*+}/i')
+            ->map(fn ($query) => trim($query))
+            ->filter()
+            ->implode("\n\n");
+    }
 }

src/InkyServiceProvider.php

@@ -6,12 +6,7 @@
 
 class InkyServiceProvider extends ServiceProvider
 {
-    /**
-     * Bootstrap the application services.
-     *
-     * @return void
-     */
-    public function boot()
+    public function boot(): void
     {
         $this->registerExtension();
 
@@ -20,12 +15,7 @@ public function boot()
         ]);
     }
 
-    /**
-     * Register the application services.
-     *
-     * @return void
-     */
-    public function register()
+    public function register(): void
     {
         $app = $this->app;
         $resolver = $app['view.engine.resolver'];
@@ -36,12 +26,10 @@ public function register()
             return new InkyCompiler($app['blade.compiler'], $app['files'], $cache);
         });
 
-        $resolver->register('inky', function () use ($app) {
-            return new InkyCompilerEngine($app['inky.compiler'], $app['files']);
-        });
+        $resolver->register('inky', fn () => new InkyCompilerEngine($app['inky.compiler'], $app['files']));
     }
 
-    protected function registerExtension()
+    protected function registerExtension(): void
     {
         $this->app['view']->addExtension('inky.php', 'inky');
     }