next release

.github/workflows/ci.yaml

@@ -1,4 +1,4 @@
-name: CoreBundle
+name: PHP Symfony CI
 
 on:
     push:
@@ -7,18 +7,46 @@ on:
         branches: [ main, develop ]
 
 jobs:
-    phpunit:
+    build:
         runs-on: ubuntu-latest
+
+        strategy:
+            matrix:
+                php: [8.1, 8.2, 8.3]
+                symfony: [6.4.*, 7.0.*, 7.1.*]
+                exclude:
+                    - php: 8.1
+                      symfony: 7.1.*
+                    - php: 8.1
+                      symfony: 7.0.*
+
+        services:
+            mysql:
+                image: mysql:latest
+                env:
+                    MYSQL_ROOT_PASSWORD: root
+                ports:
+                    - 3306:3306
+                options: >-
+                    --health-cmd "mysqladmin ping --silent"
+                    --health-interval 10s
+                    --health-timeout 5s
+                    --health-retries 3
+
         steps:
-            - uses: shivammathur/setup-php@2cb9b829437ee246e9b3cac53555a39208ca6d28
+            - uses: actions/checkout@v4
+            - name: Setup PHP ${{ matrix.php }}
+              uses: shivammathur/setup-php@v2
               with:
-                  php-version: '8.1'
-            - uses: actions/checkout@v2
-            - name: Install Dependencies
-              run: composer install -q --no-ansi --no-interaction --no-scripts --no-progress --prefer-dist
-            - name: Execute tests (Unit and Feature tests) via PHPUnit
+                  php-version: ${{ matrix.php }}
+                  tools: flex
+            - name: Download dependencies
+              env:
+                  SYMFONY_REQUIRE: ${{ matrix.symfony }}
+              uses: ramsey/composer-install@v2
+            - name: Run test suite on PHP ${{ matrix.php }} and Symfony ${{ matrix.symfony }}
               run: vendor/bin/simple-phpunit
-            - name: Check Code Styles
+            - name: Run ECS
               run: vendor/bin/ecs
-            - name: Check PHP Stan
+            - name: Run PHPStan
               run: vendor/bin/phpstan analyse src tests

CHANGELOG.md

@@ -1,5 +1,12 @@
 # CHANGELOG
 
+## v1.2.0
+ - Removed symfony ^5.4 support
+ - Introduced `FlashBagExecption` to handle flash messages in a more flexible way
+ - Introduced `BadgeFormatter` to display badges in a standardized way
+ - Improved `datetime_controller.js` to handle more date formats
+ - Introduced `input-mask_controller.js` to handle input masks like Money or Security-Numbers
+
 ## v1.0.6
  - More documentation and better styling of the documentation
  - Deprecated methods `getContainer` and `get` of `BaseCommand`

composer.json

@@ -18,26 +18,26 @@
         "php":                       ">=8.1",
         "ext-bcmath":                "*",
         "doctrine/collections":      "~1.0|~2.0",
-        "symfony/console":           "^5.4|^6.4|^7.0",
-        "symfony/framework-bundle":  "^5.4|^6.4|^7.0",
-        "symfony/http-kernel":       "^5.4|^6.4|^7.0",
-        "symfony/intl" :             "^5.4|^6.4|^7.0",
-        "symfony/options-resolver" : "^5.4|^6.4|^7.0",
+        "symfony/console":           "^6.4|^7.0",
+        "symfony/framework-bundle":  "^6.4|^7.0",
+        "symfony/http-kernel":       "^6.4|^7.0",
+        "symfony/intl" :             "^6.4|^7.0",
+        "symfony/options-resolver" : "^6.4|^7.0",
         "whatwedo/twig-bootstrap-icons": "^1.0.0",
-        "symfony/translation": "^5.4|^6.4|^7.0",
-        "symfony/form": "^5.4|^6.4|^7.0",
-        "symfony/stopwatch": "^5.4|^6.4|^7.0",
+        "symfony/translation": "^6.4|^7.0",
+        "symfony/form": "^6.4|^7.0",
+        "symfony/stopwatch": "^6.4|^7.0",
         "symfony/test-pack": "^1.1.0",
         "symfony/orm-pack": "^2.4.1"
     },
     "require-dev": {
-        "symfony/phpunit-bridge": "^5.4|^6.4|^7.0",
-        "symfony/config": "^5.4|^6.4|^7.0",
-        "symfony/dependency-injection": "^5.4|^6.4|^7.0",
-        "symfony/yaml": "^5.4|^6.4|^7.0",
+        "symfony/phpunit-bridge": "^6.4|^7.0",
+        "symfony/config": "^6.4|^7.0",
+        "symfony/dependency-injection": "^6.4|^7.0",
+        "symfony/yaml": "^6.4|^7.0",
         "doctrine/doctrine-bundle": "^2.5.5",
         "whatwedo/php-coding-standard": "^1.0",
-        "symfony/twig-bundle": "^5.4|^6.4|^7.0",
+        "symfony/twig-bundle": "^6.4|^7.0",
         "phpstan/phpstan": "^1.7"
     },
     "autoload": {

docs/index.html

@@ -79,7 +79,19 @@
     <!-- Source: https://github.com/Leward/mermaid-docsify -->
     <script type="module">
         import mermaid from "https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.esm.min.mjs";
-        mermaid.initialize({ startOnLoad: true });
+        mermaid.initialize({
+            startOnLoad: true,
+            theme: 'base',
+            themeVariables: {
+                darkMode: true,
+                primaryColor: '#5b47d1',
+                primaryTextColor: '#ffffff',
+                primaryBorderColor: '#1b1447',
+                lineColor: '#fc00ff',
+                secondaryColor: '#fc00ff',
+                tertiaryColor: '#fc00ff',
+            },
+        });
         window.mermaid = mermaid;
     </script>
     <script src="https://unpkg.com/docsify-mermaid@2.0.0/dist/docsify-mermaid.js"></script>

src/DependencyInjection/araiseCoreExtension.php

@@ -6,8 +6,8 @@
 
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Extension\Extension;
 use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
-use Symfony\Component\HttpKernel\DependencyInjection\Extension;
 
 /**
  * This is the class that loads and manages your bundle configuration.

src/Exception/FlashBagExecption.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace araise\CoreBundle\Exception;
+
+
+class FlashBagExecption extends \Exception
+{
+    private string $flashType;
+
+    public function __construct(string $flashType, string $flashMessage, string $message = '', int $code = 0, ?\Throwable $previous = null)
+    {
+        $this->flashType = $flashType;
+        parent::__construct($message !== '' ? $message : $flashMessage, $code, $previous);
+    }
+
+    public function getFlashType(): string
+    {
+        return $this->flashType;
+    }
+
+    public function getFlashMessage(): string
+    {
+        return $this->message;
+    }
+}

src/Formatter/BadgeFormatter.php

@@ -0,0 +1,60 @@
+<?php
+
+namespace araise\CoreBundle\Formatter;
+
+use araise\CoreBundle\Util\StringConverter;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+class BadgeFormatter extends TwigFormatter
+{
+    public const OPT_BACKGROUND_COLOR_CLASS = 'background_color_class';
+
+    public const OPT_BACKGROUND_COLOR_HEX = 'background_color_hex';
+
+    public const OPT_TYPE = 'type';
+
+    public const OPT_LINK = 'link';
+
+    public const OPT_CONFIGURATION = 'configuration';
+
+    public function getString(mixed $value): string
+    {
+        return StringConverter::toString($value);
+    }
+
+    public function getHtml(mixed $value): string
+    {
+        $this->processOptions(($this->options[self::OPT_CONFIGURATION])($value, $this->options));
+        return $this->twig->render($this->options[self::OPT_TEMPLATE], [
+            'value' => $this->getString($value),
+            'type' => $this->options[self::OPT_TYPE],
+            'background_color_class' => $this->options[self::OPT_BACKGROUND_COLOR_CLASS],
+            'background_color_hex' => $this->options[self::OPT_BACKGROUND_COLOR_HEX],
+            'link' => $this->options[self::OPT_LINK],
+        ]);
+    }
+
+    protected function configureOptions(OptionsResolver $resolver): void
+    {
+        $resolver->setDefault(self::OPT_TEMPLATE, '@araiseCore/formatter/badge.html.twig');
+        $resolver->setDefaults([
+            self::OPT_BACKGROUND_COLOR_CLASS => null,
+            self::OPT_BACKGROUND_COLOR_HEX => null,
+            self::OPT_TYPE => 'neutral',
+            self::OPT_LINK => null,
+            self::OPT_CONFIGURATION => static fn (mixed $value, array $options): array => $options,
+        ]);
+        $resolver->setAllowedTypes(self::OPT_BACKGROUND_COLOR_CLASS, ['string', 'null']);
+        $resolver->setAllowedTypes(self::OPT_BACKGROUND_COLOR_HEX, ['string', 'null']);
+        $resolver->setAllowedTypes(self::OPT_TYPE, 'string');
+        $resolver->setAllowedTypes(self::OPT_LINK, ['string', 'null']);
+        $resolver->setAllowedTypes(self::OPT_CONFIGURATION, 'callable');
+        $resolver->setAllowedValues(self::OPT_TYPE, [
+            'primary',
+            'neutral',
+            'error',
+            'warning',
+            'success',
+        ]);
+    }
+}

src/Manager/FormatterManager.php

@@ -30,7 +30,7 @@
 namespace araise\CoreBundle\Manager;
 
 use araise\CoreBundle\Formatter\FormatterInterface;
-use Symfony\Component\DependencyInjection\Attribute\TaggedIterator;
+use Symfony\Component\DependencyInjection\Attribute\AutowireIterator;
 
 class FormatterManager
 {
@@ -43,7 +43,8 @@ class FormatterManager
      * @param FormatterInterface[] $formatters
      */
     public function __construct(
-        #[TaggedIterator('araise_core.formatter')] iterable $formatters
+        #[AutowireIterator('araise_core.formatter')]
+        iterable $formatters
     ) {
         foreach ($formatters as $formatter) {
             $this->formatters[$formatter::class] = $formatter;

src/Resources/assets/controllers/datetime_controller.js

@@ -4,8 +4,16 @@ import easepickStyle from '!!raw-loader!@easepick/bundle/dist/index.css'
 
 export default class extends Controller {
     static values = {
-        lang: String
+        /**
+         * The language to use within the date picker (translation of months and days)
+         */
+        lang: String,
+        /**
+         * The format passed from the server to correctly parse the date
+         */
+        format: String
     }
+
     connect() {
         if (this.element.tagName !== 'INPUT') {
             return;
@@ -14,14 +22,15 @@ export default class extends Controller {
         const enableTime = type === 'time' || type === 'datetime-local';
         let plugins = [KbdPlugin];
 
-        if(enableTime) {
+        if (enableTime) {
             plugins.push(TimePlugin);
         }
 
         const picker = new easepick.create({
             element: this.element,
             css: easepickStyle,
             lang: this.langValue || 'de-DE',
+            format: this.formatValue || (enableTime ? "YYYY-MM-DDTHH:mm" : "YYYY-MM-DD"),
             readonly: false,
             plugins: plugins,
             calendars: type === 'time' ? 0 : 1,

src/Resources/assets/controllers/dropdown_controller.js

@@ -17,10 +17,9 @@ export default class extends Controller {
     }
 
     toggle (event) {
-        event.stopPropagation();
-
         const dropdownDiv = this.menuTarget;
         if (this.hasMenuTarget && dropdownDiv.classList.contains('hidden')) {
+            window.dispatchEvent(new Event('araise-dropdown:open'));
             dropdownDiv.classList.remove('hidden');
         } else {
             dropdownDiv.classList.add('hidden');

src/Resources/assets/controllers/input-mask_controller.js

@@ -0,0 +1,31 @@
+import { Controller } from "@hotwired/stimulus"
+
+const typeMapping = {
+    'Number': Number,
+};
+export default class extends Controller {
+    static values = {
+        mask: String,
+        scale: { type: Number, default: 2 },
+        radix: { type: String, default: '.' },
+        thousandsSeparator: { type: String, default: '\'' },
+        normalizeZeros: { type: Boolean, default: false },
+        min: Number,
+        max: Number,
+    };
+    async connect() {
+        const { default: IMask } = await import('imask');
+        this.mask = IMask(this.element, {
+            mask: typeMapping[this.maskValue] || this.maskValue,
+            scale: this.scaleValue,
+            radix: this.radixValue,
+            thousandsSeparator: this.thousandsSeparatorValue,
+            normalizeZeros: this.normalizeZerosValue,
+            min: this.hasMinValue ? this.minValue : null,
+            max: this.hasMaxValue ? this.maxValue : null,
+        });
+    }
+    disconnect() {
+        this.mask?.destroy();
+    }
+}

src/Resources/assets/package.json

@@ -6,13 +6,19 @@
             "combobox": {
                 "main": "controllers/combobox_controller.js",
                 "webpackMode": "eager",
-                "fetch": "eager",
+                "fetch": "lazy",
                 "enabled": true
             },
             "datetime": {
                 "main": "controllers/datetime_controller.js",
                 "webpackMode": "eager",
-                "fetch": "eager",
+                "fetch": "lazy",
+                "enabled": true
+            },
+            "input-mask": {
+                "main": "controllers/input-mask_controller.js",
+                "webpackMode": "eager",
+                "fetch": "lazy",
                 "enabled": true
             },
             "dropdown": {
@@ -24,7 +30,7 @@
             "modal-form": {
                 "main": "controllers/modal-form_controller.js",
                 "webpackMode": "eager",
-                "fetch": "eager",
+                "fetch": "lazy",
                 "enabled": true
             },
             "reload-content": {
@@ -36,7 +42,7 @@
             "modal": {
                 "main": "controllers/modal_controller.js",
                 "webpackMode": "eager",
-                "fetch": "eager",
+                "fetch": "lazy",
                 "enabled": true
             }
         }
@@ -51,6 +57,7 @@
     "dependencies": {
         "@easepick/bundle": "^1.2.1",
         "flatpickr": "^4.6.9",
+        "imask": "^7.6.1",
         "raw-loader": "^4.0.2",
         "stimulus-dropdown": "^2.0.0",
         "stimulus-use": "^0.51.1",