Merge pull request #44 from dachcom-digital/p11

Pimcore 11 Support
dachcom-digital · Aug 30, 2023 · 7032a7d · 7032a7d
2 parents e1dff08 + 2e3a979
commit 7032a7d
Show file tree

Hide file tree

Showing 57 changed files with 307 additions and 461 deletions.
diff --git a/.github/workflows/codeception.yml b/.github/workflows/codeception.yml
@@ -15,7 +15,7 @@ jobs:
             TEST_PROJECT_ROOT_DIR: "${{ github.workspace }}"
 
             PIMCORE_CODECEPTION_FRAMEWORK: "${{ github.workspace }}/pimcore-codeception-framework"
-            PIMCORE_CODECEPTION_VERSION: "2.0"
+            PIMCORE_CODECEPTION_VERSION: "3.0"
 
             APP_ENV: test
             PIMCORE_TEST_DB_DSN: "mysql://test:[email protected]:3306/dachcom_bundle_test"
@@ -38,12 +38,12 @@ jobs:
                 options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3
         strategy:
             matrix:
-                php: [ 8.1 ]
-                symfony: [ ^5.4 ]
-                pimcore: [ ~10.6.0 ]
+                php: [ 8.2 ]
+                symfony: [ ^6.2 ]
+                pimcore: [ ~11.0.0 ]
                 include:
-                    -   pimcore: ~10.6.0
-                        template_tag: v10.2.5
+                    -   pimcore: ~11.0.0
+                        template_tag: v11.0.0
         steps:
             -   uses: actions/checkout@v2
                 with:

diff --git a/.github/workflows/ecs.yml b/.github/workflows/ecs.yml
@@ -15,7 +15,7 @@ jobs:
             TEST_PROJECT_ROOT_DIR: "${{ github.workspace }}"
 
             PIMCORE_CODECEPTION_FRAMEWORK: "${{ github.workspace }}/pimcore-codeception-framework"
-            PIMCORE_CODECEPTION_VERSION: "2.0"
+            PIMCORE_CODECEPTION_VERSION: "3.0"
 
             APP_ENV: test
             PIMCORE_TEST_DB_DSN: "mysql://root:[email protected]:3306/dachcom_bundle_test"
@@ -37,12 +37,12 @@ jobs:
                 options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3
         strategy:
             matrix:
-                php: [ 8.1 ]
-                symfony: [ ^5.4 ]
-                pimcore: [ ~10.6.0 ]
+                php: [ 8.2 ]
+                symfony: [ ^6.2 ]
+                pimcore: [ ~11.0.0 ]
                 include:
-                    -   pimcore: ~10.6.0
-                        template_tag: v10.2.5
+                    -   pimcore: ~11.0.0
+                        template_tag: v11.0.0
         steps:
             -   uses: actions/checkout@v2
                 with:

diff --git a/.github/workflows/php-stan.yml b/.github/workflows/php-stan.yml
@@ -15,7 +15,7 @@ jobs:
             TEST_PROJECT_ROOT_DIR: "${{ github.workspace }}"
 
             PIMCORE_CODECEPTION_FRAMEWORK: "${{ github.workspace }}/pimcore-codeception-framework"
-            PIMCORE_CODECEPTION_VERSION: "2.0"
+            PIMCORE_CODECEPTION_VERSION: "3.0"
 
             APP_ENV: test
             PIMCORE_TEST_DB_DSN: "mysql://root:[email protected]:3306/dachcom_bundle_test"
@@ -37,12 +37,12 @@ jobs:
                 options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3
         strategy:
             matrix:
-                php: [ 8.1 ]
-                symfony: [ ^5.4 ]
-                pimcore: [ ~10.6.0 ]
+                php: [ 8.2 ]
+                symfony: [ ^6.2 ]
+                pimcore: [ ~11.0.0 ]
                 include:
-                    -   pimcore: ~10.6.0
-                        template_tag: v10.2.5
+                    -   pimcore: ~11.0.0
+                        template_tag: v11.0.0
         steps:
             -   uses: actions/checkout@v2
                 with:

diff --git a/.gitignore b/.gitignore
@@ -52,4 +52,4 @@ php-cgi.core
 /tests/_output/*
 /tests/_data/*
 !/tests/_data/.gitkeep
-/tests/_support/_generated/*
+/tests/Support/_generated/*
diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md
@@ -1,9 +1,9 @@
-| Q                | A
-| ---------------- | -----
-| Bug report?      | yes/no
-| Feature request? | yes/no
-| BC Break report? | yes/no
-| RFC?             | yes/no
+| Q                | A      |
+|------------------|--------|
+| Bug report?      | yes/no |
+| Feature request? | yes/no |
+| BC Break report? | yes/no |
+| RFC?             | yes/no |
 
 <!--
 - Please fill in this template according to your issue.

diff --git a/LICENSE.md b/LICENSE.md
@@ -1,5 +1,5 @@
 # License
-Copyright (C) 2017 DACHCOM.DIGITAL
+Copyright (C) 2023 DACHCOM.DIGITAL
 
 This software is available under the GNU General Public License version 3 (GPLv3).
 

diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md
@@ -1,10 +1,10 @@
-| Q             | A
-| ------------- | ---
-| Bug fix?      | yes/no
-| New feature?  | yes/no
-| BC breaks?    | no
-| Deprecations? | yes/no
-| Fixed tickets | #...   <!-- #-prefixed issue number(s), if any -->
+| Q             | A                                                  |
+|---------------|----------------------------------------------------|
+| Bug fix?      | yes/no                                             |
+| New feature?  | yes/no                                             |
+| BC breaks?    | no                                                 |
+| Deprecations? | yes/no                                             |
+| Fixed tickets | #...   <!-- #-prefixed issue number(s), if any --> |
 
 <!--
 Write a short README entry for your feature/bugfix here (replace this comment block.)

diff --git a/README.md b/README.md
@@ -7,24 +7,32 @@
 [![PhpStan](https://img.shields.io/github/actions/workflow/status/dachcom-digital/pimcore-dynamic-search/.github/workflows/php-stan.yml?branch=master&style=flat-square&logo=github&label=phpstan%20level%204)](https://github.com/dachcom-digital/pimcore-emailizr/actions?query=workflow%3A%22PHP%20Stan%22)
 
 ### Requirements
-* Pimcore >= 10.1.0
-* PHP >= 8.0
+* Pimcore: ^11.0
+* PHP: >= 8.1
 
 ### Release Plan
 
-| Release | Supported Pimcore Versions | Supported Symfony Versions | Release Date | Maintained     | Branch     |
-|---------|----------------------------|----------------------------|--------------|----------------|------------|
-| **2.x** | `10.1` - `10.6`            | `^5.4`                     | 21.09.2021   | Feature Branch | dev-master |
-| **1.x** | `6.0` - `6.9`              | `3.4`, `^4.4`              | 06.12.2017   | No             | 1.x        |
+| Release | Supported Pimcore Versions | Supported Symfony Versions | Release Date | Maintained     | Branch                                                              |
+|---------|----------------------------|----------------------------|--------------|----------------|---------------------------------------------------------------------|
+| **3.x** | `11.0`                     | `^6.2`                     | --           | Feature Branch | master                                                              |
+| **2.x** | `10.1` - `10.6`            | `^5.4`                     | 21.09.2021   | Maintained     | [2.x](https://github.com/dachcom-digital/pimcore-emailizr/tree/2.x) |
+| **1.x** | `6.0` - `6.9`              | `3.4`, `^4.4`              | 06.12.2017   | No             | [1.x](https://github.com/dachcom-digital/pimcore-emailizr/tree/1.x) |
 
 ## Installation
 
 ```json
 "require" : {
-    "dachcom-digital/emailizr" : "~2.0.0",
+    "dachcom-digital/emailizr" : "~3.0.0",
 }
 ```
 
+Add Bundle to `bundles.php`:
+```php
+return [
+    EmailizrBundle\EmailizrBundle::class => ['all' => true],
+];
+```
+
 - Create valid email markup with inky and inline styles. 
 - Respect editables in pimcore edit mode.
 
@@ -38,7 +46,7 @@ Just extend the emailizr layout:
 This will include a markup like this. You may want to change it:
 ```twig
 {% apply spaceless %}
-{{ emailizr_style_collector.add('@EmailizrBundle/Resources/public/css/foundation-for-emails/foundation.min.css') }}
+{{ emailizr_style_collector.add('@EmailizrBundle/public/css/foundation-for-emails/foundation.min.css') }}
 {% emailizr_inline_style %}
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml">
@@ -53,7 +61,7 @@ This will include a markup like this. You may want to change it:
         </style>
     {% endblock %}
 </head>
-{% emailizr_inky %}
+{% apply inky_to_html %}
     <body>
         {% block body %}
             <table class="body">
@@ -70,7 +78,7 @@ This will include a markup like this. You may want to change it:
             <div style="display:none; white-space:nowrap; font:15px courier; line-height:0;"> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </div>
         {% endblock %}
         </body>
-{% end_emailizr_inky %}
+{% endapply %}
 </html>
 {% end_emailizr_inline_style %}
 {% endapply %}

diff --git a/UPGRADE.md b/UPGRADE.md
@@ -1,20 +1,15 @@
 # Upgrade Notes
+--
 
-## Version 2.0.3
-- Allow `pelago/emogrifier:^7.0`
-- Bump `lorenzo/pinky` to `1.0.9`
-
-## Version 2.0.2
-- Allow Pimcore 11
-- Fix parsing of variables in links (`<a href="{{ variable }}">link</a>`)
-
-## Version 2.0.1
-- [ENHANCEMENT] PHP 8.1 compatibility [@scrummer](https://github.com/dachcom-digital/pimcore-emailizr/pull/35)
-
-## Migrating from Version 1.x to Version 2.0.0
-- Pimcore X support only
-- PHP 8.0 support only
+## Migrating from Version 2.x to Version 3.0.0
+- Pimcore 11.0 support only
+- PHP >= 8.1 support only
+- [NEW FEATURE][BC BREAK] We're now using the symfony [inky parser](https://twig.symfony.com/doc/2.x/filters/inky_to_html.html) instead of `lorenzo/pinky` (which will be used by twig, but we want to stick with Symfony's recommended stack).
+  - replace `{% emailizr_inky %}` with `{% apply inky_to_html %}`
+  - replace `{% end_emailizr_inky %}` with `{% endapply %}`
+- [BC BREAK] `@Emailizr/layout.html.twig` is using inky markup by default
+- [BC BREAK] Include path `@EmailizrBundle/Resources/public/[...]` changed to `@EmailizrBundle/public/[...]`. Please change your includes accordingly
 
 ***
 
-Emailizr 1.x Upgrade Notes: https://github.com/dachcom-digital/pimcore-emailizr/blob/1.x/UPGRADE.md
+Emailizr 2.x Upgrade Notes: https://github.com/dachcom-digital/pimcore-emailizr/blob/2.x/UPGRADE.md
diff --git a/codeception.dist.yml b/codeception.dist.yml
@@ -1,14 +1,15 @@
 namespace: DachcomBundle\Test
+support_namespace: Support
 actor: Tester
 paths:
     tests: tests
-    output: tests/_output
-    data: tests/_data
-    support: tests/_support
     envs: tests/_envs
+    output: tests/_output
     log: tests/_output/var/logs
+    data: tests/_data
+    support: tests/Support
+bootstrap: _bootstrap.php
 settings:
-    bootstrap: _bootstrap.php
     memory_limit: -1
     colors: true
 params:

diff --git a/composer.json b/composer.json
@@ -15,7 +15,7 @@
     ],
     "autoload": {
         "psr-4": {
-            "EmailizrBundle\\": "src/EmailizrBundle"
+            "EmailizrBundle\\": "src/"
         }
     },
     "autoload-dev": {
@@ -28,19 +28,16 @@
             "bundles": [
                 "EmailizrBundle\\EmailizrBundle"
             ]
-        },
-        "branch-alias": {
-            "dev-master": "2.0-dev"
         }
     },
     "require": {
-        "pimcore/pimcore": "^10.1 || ^11.0",
-        "lorenzo/pinky": "^1.0.9",
-        "pelago/emogrifier": "^4.0 | ^5.0 | ^6.0 | ^7.0"
+        "pimcore/pimcore": "^11.0",
+        "twig/inky-extra": "^3.0",
+        "pelago/emogrifier": "^7.0"
     },
     "require-dev": {
-        "codeception/codeception": "^4.1",
-        "codeception/module-symfony": "^1.6",
+        "codeception/codeception": "^5.0",
+        "codeception/module-symfony": "^3.1",
         "phpstan/phpstan": "^1.0",
         "phpstan/phpstan-symfony": "^1.0",
         "symplify/easy-coding-standard": "^9.0"

diff --git a/config/services.yaml b/config/services.yaml
@@ -0,0 +1,2 @@
+imports:
+    - { resource: services/*.yaml }
diff --git a/...ndle/Resources/config/services/parser.yml → config/services/parser.yaml b/...ndle/Resources/config/services/parser.yml → config/services/parser.yaml
diff --git a/...dle/Resources/config/services/service.yml → config/services/service.yaml b/...dle/Resources/config/services/service.yml → config/services/service.yaml
diff --git a/...Bundle/Resources/config/services/twig.yml → config/services/twig.yaml b/...Bundle/Resources/config/services/twig.yml → config/services/twig.yaml
@@ -5,10 +5,6 @@ services:
         autoconfigure: true
         public: false
 
-    EmailizrBundle\Twig\Extension\InkyExtension:
-        tags:
-            - { name: twig.extension }
-
     EmailizrBundle\Twig\Extension\InlineStyleExtension:
         tags:
             - { name: twig.extension }
diff --git a/docs/10_FormBuilder.md b/docs/10_FormBuilder.md
@@ -9,7 +9,7 @@ Get FormBuilder [here](https://github.com/dachcom-digital/pimcore-formbuilder).
 
 ```twig
 {% apply spaceless %}
-{{ emailizr_style_collector.add('@YourBundle/Resources/public/css/style.css') }}
+{{ emailizr_style_collector.add('@YourBundle/public/css/style.css') }}
 {% emailizr_inline_style %}
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml">
@@ -24,7 +24,7 @@ Get FormBuilder [here](https://github.com/dachcom-digital/pimcore-formbuilder).
         </style>
     {% endblock %}
 </head>
-{% emailizr_inky %}
+{% apply inky_to_html %}
 
     {% if editmode %}
 
@@ -63,7 +63,7 @@ Get FormBuilder [here](https://github.com/dachcom-digital/pimcore-formbuilder).
         </container>
 
     {% endif %}
-{% end_emailizr_inky %}
+{% endapply %}
 </html>
 {% end_emailizr_inline_style %}
 {% endapply %}
@@ -75,11 +75,11 @@ Get FormBuilder [here](https://github.com/dachcom-digital/pimcore-formbuilder).
 ```twig
 {% apply spaceless %}
 
-    {{ emailizr_style_collector.add('@YourBundle/Resources/public/css/style.css') }}
+    {{ emailizr_style_collector.add('@YourBundle/public/css/style.css') }}
 
     {% emailizr_inline_style %}
 
-        {% emailizr_inky %}
+        {% apply inky_to_html %}
 
             <container>
 
@@ -105,7 +105,7 @@ Get FormBuilder [here](https://github.com/dachcom-digital/pimcore-formbuilder).
                 {% endfor %}
             </container>
 
-        {% end_emailizr_inky %}
+        {% endapply %}
 
     {% end_emailizr_inline_style %}
 

diff --git a/.../css/foundation-for-emails/foundation.css → .../css/foundation-for-emails/foundation.css b/.../css/foundation-for-emails/foundation.css → .../css/foundation-for-emails/foundation.css
diff --git a/.../foundation-for-emails/foundation.min.css → .../foundation-for-emails/foundation.min.css b/.../foundation-for-emails/foundation.min.css → .../foundation-for-emails/foundation.min.css
diff --git a/...EmailizrBundle/Collector/CssCollector.php → src/Collector/CssCollector.php b/...EmailizrBundle/Collector/CssCollector.php → src/Collector/CssCollector.php
@@ -11,7 +11,7 @@ public function add(string $file): void
         $this->cssFiles[] = $file;
     }
 
-    public function removeAll()
+    public function removeAll(): void
     {
         $this->cssFiles = [];
     }

diff --git a/...DependencyInjection/EmailizrExtension.php → ...DependencyInjection/EmailizrExtension.php b/...DependencyInjection/EmailizrExtension.php → ...DependencyInjection/EmailizrExtension.php
@@ -11,7 +11,7 @@ class EmailizrExtension extends Extension
 {
     public function load(array $configs, ContainerBuilder $container): void
     {
-        $loader = new YamlFileLoader($container, new FileLocator([__DIR__ . '/../Resources/config']));
-        $loader->load('services.yml');
+        $loader = new YamlFileLoader($container, new FileLocator([__DIR__ . '/../../config']));
+        $loader->load('services.yaml');
     }
 }
diff --git a/src/EmailizrBundle/EmailizrBundle.php → src/EmailizrBundle.php b/src/EmailizrBundle/EmailizrBundle.php → src/EmailizrBundle.php
@@ -4,24 +4,20 @@
 
 use Pimcore\Extension\Bundle\AbstractPimcoreBundle;
 use Pimcore\Extension\Bundle\Traits\PackageVersionTrait;
-use Symfony\Component\DependencyInjection\ContainerBuilder;
 
 class EmailizrBundle extends AbstractPimcoreBundle
 {
     use PackageVersionTrait;
 
-    const PACKAGE_NAME = 'dachcom-digital/emailizr';
+    public const PACKAGE_NAME = 'dachcom-digital/emailizr';
 
-    public function build(ContainerBuilder $container)
+    protected function getComposerPackageName(): string
     {
-        parent::build($container);
+        return self::PACKAGE_NAME;
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    protected function getComposerPackageName(): string
+    public function getPath(): string
     {
-        return self::PACKAGE_NAME;
+        return \dirname(__DIR__);
     }
 }
diff --git a/src/EmailizrBundle/Resources/config/services.yml b/src/EmailizrBundle/Resources/config/services.yml