Allow EasyAdmin 2.2.0 and upper (#166)

* Allow Sf 5.0 + EA >= 2.2

* Rename parameter for request list filters

* Targeting v3.0.0 instead of v2.2.0

* Remove role based menu filtering (replaced by native one)

* CI get PHPStan level 5 analysis

* default values for tests

* Min version for EasyAdmin is 2.2.2 (with menu permissions)

Author: alterphp

.travis.yml

@@ -1,60 +1,65 @@
 language: php
-dist: precise
 sudo: false
-git:
-    depth: 1
 
 cache:
     directories:
-        - $HOME/.composer/cache
-        - $HOME/.app/cache
+        - $HOME/.composer/cache/files
+        - $HOME/symfony-bridge/.phpunit
 
 env:
     global:
-        - deps="no"
-        - SYMFONY_VERSION=""
-        - CHECK_PHP_SYNTAX="no"
-        - SYMFONY_DEPRECATIONS_HELPER="weak"
         - ENABLE_CODE_COVERAGE="false"
+        - PHPUNIT_FLAGS="-v"
+        - SYMFONY_PHPUNIT_DIR="$HOME/symfony-bridge/.phpunit"
+        - SYMFONY_DEPRECATIONS_HELPER="999999"
 
 matrix:
     fast_finish: true
     include:
-        # bleeding edge (unreleased dev versions where failures are allowed)
-        - php: nightly
-          env:
-            - STABILITY=dev
-            - SYMFONY_VERSION="4.*"
-        # stable (most recent stable versions)
+        - php: 7.1
+          env: CHECK_PHP_SYNTAX="true"
+               COMPOSER_FLAGS="--prefer-stable --prefer-lowest" SYMFONY_DEPRECATIONS_HELPER=weak
+               SYMFONY_VERSION="4.2.*"
+               TWIG_VERSION="^2.4"
+
         - php: 7.2
-          env:
-            - SYMFONY_VERSION="4.1.*"
-            - TWIG_VERSION="^2.4"
-            - ENABLE_CODE_COVERAGE="true"
+          env: COMPOSER_FLAGS="--ignore-platform-reqs"
+
+        - php: 7.3
+          env: COMPOSER_FLAGS="--prefer-stable --prefer-lowest" SYMFONY_DEPRECATIONS_HELPER=weak
+               SYMFONY_VERSION="4.2.*"
+               TWIG_VERSION="^2.4"
+               ENABLE_CODE_COVERAGE="true"
+
+          # Latest commit to master
+        - php: nightly
+          env: COMPOSER_FLAGS="--ignore-platform-reqs" SYMFONY_PHPUNIT_VERSION=8.4
     allow_failures:
-        # code coverage is very slow; allow a failure to get the Travis result early
+          # Dev-master is allowed to fail.
         - php: nightly
 
 before_install:
-    - stty cols 120
-    - INI_FILE=~/.phpenv/versions/$(phpenv version-name)/etc/conf.d/travis.ini
-    - echo memory_limit = -1 >> $INI_FILE
-    - echo session.gc_probability = 0 >> $INI_FILE
-    - echo opcache.enable_cli = 1 >> $INI_FILE
-    - if [[ "$SYMFONY_VERSION" == 3.3.* ]]; then export SYMFONY_DEPRECATIONS_HELPER="strict"; fi;
+    - phpenv config-rm xdebug.ini || true
+    - if [[ "$CHECK_PHP_SYNTAX" == "true" ]]; then wget https://cs.symfony.com/download/php-cs-fixer-v2.phar -O php-cs-fixer; fi
+    - phpenv global 7.2; composer global require --prefer-dist --no-progress --no-scripts --no-plugins symfony/flex dev-master; phpenv global $TRAVIS_PHP_VERSION
     - if [[ "$ENABLE_CODE_COVERAGE" != "true" && "$TRAVIS_EVENT_TYPE" != "cron" ]]; then rm -f ~/.phpenv/versions/$(phpenv version-name)/etc/conf.d/xdebug.ini; fi;
-    - composer self-update
-    - if [[ "$SYMFONY_VERSION" != "" ]]; then composer require "symfony/symfony:${SYMFONY_VERSION}" --no-update; fi;
-    - if [[ "$TWIG_VERSION" != "" ]]; then composer require "twig/twig:${TWIG_VERSION}" --no-update; fi;
-    - if [[ "$STABILITY" != "" ]]; then composer config minimum-stability $STABILITY; fi
 
 install:
-    - if [[ "$CHECK_PHP_SYNTAX" == "yes" ]]; then composer require --dev --no-update friendsofphp/php-cs-fixer; fi;
-    - composer update --prefer-dist --no-interaction --no-suggest --no-progress --ansi $COMPOSER_FLAGS
+    - composer update $COMPOSER_FLAGS --no-interaction
+    - phpenv global 7.2; ./vendor/bin/simple-phpunit install; phpenv global $TRAVIS_PHP_VERSION
     - if [[ "$ENABLE_CODE_COVERAGE" == "true" ]]; then composer require --dev php-coveralls/php-coveralls; fi
 
 script:
-    - if [[ $ENABLE_CODE_COVERAGE == "true" ]]; then vendor/bin/phpunit --coverage-text --coverage-clover build/logs/clover.xml; else vendor/bin/phpunit; fi
+    - composer validate --strict --no-check-lock
+    - if [[ "$CHECK_PHP_SYNTAX" == "true" ]]; then php php-cs-fixer --no-interaction --dry-run --diff -v fix; fi
+    # this run PHPStan level 5 static analysis
+    - vendor/bin/phpstan analyse -c phpstan.neon --level=5 src
+    # this checks that the Twig template files contain no syntax errors
+    - ./tests/bin/console lint:twig "src" "tests"
+    # this checks that the YAML config files contain no syntax errors
+    - ./tests/bin/console lint:yaml "tests"
+
+    - if [[ $ENABLE_CODE_COVERAGE == "true" ]]; then vendor/bin/simple-phpunit $PHPUNIT_FLAGS --coverage-text --coverage-clover build/logs/clover.xml; else vendor/bin/simple-phpunit $PHPUNIT_FLAGS; fi
     - if [[ "$CHECK_PHP_SYNTAX" == "yes" ]]; then php vendor/bin/php-cs-fixer --no-interaction --dry-run --diff -v fix; fi;
     - if [[ "$CHECK_PHP_SYNTAX" == "yes" ]]; then mv ./.php_cs.cache $HOME/.app/cache/.php_cs.cache 2> /dev/null; fi;
 

README.md

@@ -5,11 +5,12 @@ EasyAdmin Extension
 
 EasyAdmin Extension provides some useful extensions to [EasyAdmin](https://github.com/EasyCorp/EasyAdminBundle) admin generator for Symfony.
 
-:exclamation: Branch `2.2.x` of this bundle requires at least __PHP 7.1__ and __Symfony 4.2__ components or stack and is suitable for EasyAdmin `^2.2.0`. It allows installation of EasyAdmin `2.2.0` or upper and Symfony 5 as well. __Extension bundle implementation of list filters is NOT COMPATIBLE with EasyAdmin dynamic list filters !__ Use extension implementation if you want to use embedded list, OR do not use embedded list.
+* Branch `3.x` of this bundle requires at least __PHP 7.1__ and __Symfony 4.2__ components or stack and is suitable for EasyAdmin `^2.2.2` (Versions v2.2.0 and v2.2.1 are not allowed as they don't have native menu permissions). It allows installation of EasyAdmin `2.2.0` or upper and Symfony 5 as well. __Extension bundle implementation of list filters is NOT COMPATIBLE with EasyAdmin dynamic list filters !__ That's why we introduced the following change :
+    > :exclamation: __BC BREAK__ list filters implemented by this extension bundle now use `ext_filters` query/form parameter, as `filters` is now used by native EasyAdmin for its own implementation of dynamic list filters.
 
-:exclamation: Branch `2.0.x` and `2.1.x` of this bundle requires at least __PHP 7.1__ and __Symfony 4.1__ components or stack and is suitable for EasyAdmin `2.0.x` and `2.1.x`. __It does not allow installation of EasyAdmin `2.2.0` or upper !__
+* Branch `2.x` of this bundle requires at least __PHP 7.1__ and __Symfony 4.1__ components or stack and is suitable for EasyAdmin `2.0.x` and `2.1.x`. __It does not allow installation of EasyAdmin `2.2.0` or upper !__
 
-:exclamation: Branch `1.x` of this bundle requires at least __PHP 7.0__ and __Symfony 3.0__ components or stack and is suitable for EasyAdmin `1.x`.
+* Branch `1.x` of this bundle requires at least __PHP 7.0__ and __Symfony 3.0__ components or stack and is suitable for EasyAdmin `1.x`.
 
 
 
@@ -210,9 +211,9 @@ Available built-in operators are listed in `AlterPHP\EasyAdminExtensionBundle\Mo
 
 * EasyAdmin allows filtering list with `dql_filter` configuration entry. But this is not dynamic and must be configured as an apart list in `easy_admin` configuration.*
 
-This extension allows to __dynamically filter lists__ by adding `filters` parameter in the URL parameters. Having a list of books at URL `<url-to-admin>?action=list&entity=Book` with a releaseYear field, you can filter on books releasd in 2016 by requesting `<url-to-admin>?action=list&entity=Book&filters[entity.releaseDate]=2016`. It only matches exact values, but you can chain them. To request books released in 2015 and 2016, you must request `<url-to-admin>?action=list&entity=Book&filters[entity.releaseDate][]=2015&filters[entity.releaseDate][]=2016`.
+This extension allows to __dynamically filter lists__ by adding `ext_filters` parameter in the URL parameters. Having a list of books at URL `<url-to-admin>?action=list&entity=Book` with a releaseYear field, you can filter on books releasd in 2016 by requesting `<url-to-admin>?action=list&entity=Book&ext_filters[entity.releaseDate]=2016`. It only matches exact values, but you can chain them. To request books released in 2015 and 2016, you must request `<url-to-admin>?action=list&entity=Book&ext_filters[entity.releaseDate][]=2015&ext_filters[entity.releaseDate][]=2016`.
 
-This `filters` parameter is transmitted to the referer used for post update/delete/create redirection AND for search !
+This `ext_filters` parameter is transmitted to the referer used for post update/delete/create redirection AND for search !
 
 ### Register your own form types with a short name (aliasing form types)
 
@@ -237,7 +238,7 @@ Embedded lists are useful to show relations to en entity in its *NEW/EDIT/FORM*
 Available options are :
 
 - `entity`: Entity config name (key under the EasyAdmin `entities` config)
-- `filters`: Request filters to apply on the list
+- `ext_filters`: Request filters to apply on the list
 - `hidden_fields`: List of fields (columns) to hide from list fields config
 - `max_results`: Number of items par page (list.max_results config is used if not defined)
 - `sort`: Sort to apply
@@ -266,7 +267,7 @@ easy_admin:
                 fields:
                     # ...
                     - { type: group, label: Events, css_class: 'col-sm-12', icon: calendar }
-                    - { property: events, label: '', type: embedded_list, type_options: { entity: Event, filters: { 'entity.promoter': 'form:parent.data.id' } } }
+                    - { property: events, label: '', type: embedded_list, type_options: { entity: Event, ext_filters: { 'entity.promoter': 'form:parent.data.id' } } }
 
 ```
 
@@ -377,17 +378,6 @@ easy_admin:
 
 Entity _role_prefix_ defines all actions required roles by appending the action name to the prefix.
 
-#### Hiding *not-entity-based* menu entries on __role__ option
-
-```yaml
-easy_admin:
-        menu:
-            - { label: 'Administrator', role: ROLE_SUPER_ADMIN } # Hidden if user is not granted ROLE_SUPER_ADMIN
-            - { label: 'App action', route: 'app_action', role: ROLE_ADMIN } # Hidden if user is not granted ROLE_ADMIN
-```
-
-:warning: __Beware this ONLY HIDE the menu entry and do not secure secure access to the targeted URL/route !__
-
 #### Per entity field role permissions in form
 
 You can also define role permissions per entity field in a form:
@@ -494,7 +484,7 @@ Locally with Docker :
 
 Locally with Docker :
 
-    docker-compose run --rm php /app/vendor/bin/phpstan analyse -c /app/phpstan.neon --level=6 /app/src
+    docker-compose run --rm php /app/vendor/bin/phpstan analyse -c /app/phpstan.neon --level=5 /app/src
 
 License
 -------

UPGRADE.md

@@ -1,5 +1,83 @@
 # UPGRADE guide for EasyAdminExtension bundle
 
+## v3.0.0
+
+This version unlocks dependency to EasyAdmin by allowing __EasyAdmin ^2.2.0__. As this version of EasyAdmin introduce its own implementation of list filters (using query parameter `filter`), and considering it is not compatible with extension bundle's implementation : __I decided to rename the parameter to pass filters used by the extension__. This is an important BC BREAK.
+
+### Renamed query parameter for list filters (BC break)
+
+`filter` is now used by native EasyAdmin implementation. Use `ext_filters` for extension implementation (for embedded lists) !
+
+__BEFORE__
+
+`<url-to-admin>?action=list&entity=Book&filters[entity.releaseDate]=2016`
+
+__AFTER__
+
+`<url-to-admin>?action=list&entity=Book&ext_filters[entity.releaseDate]=2016`
+
+
+__BEFORE__
+
+```yaml
+easy_admin:
+    entities:
+        Event:
+            class: App\Entity\Event
+        Promoter:
+            class: App\Entity\Promoter
+            form:
+                fields:
+                    # ...
+                    - { type: group, label: Events, css_class: 'col-sm-12', icon: calendar }
+                    - { property: events, label: '', type: embedded_list, type_options: { entity: Event, filters: { 'entity.promoter': 'form:parent.data.id' } } }
+
+```
+
+__AFTER__
+
+```yaml
+easy_admin:
+    entities:
+        Event:
+            class: App\Entity\Event
+        Promoter:
+            class: App\Entity\Promoter
+            form:
+                fields:
+                    # ...
+                    - { type: group, label: Events, css_class: 'col-sm-12', icon: calendar }
+                    - { property: events, label: '', type: embedded_list, type_options: { entity: Event, ext_filters: { 'entity.promoter': 'form:parent.data.id' } } }
+
+```
+
+### Use of native role based menu permissions
+
+Replace `role` option in menu configuration by `permission` (native EasyAdmin implementation). Empty menu folders are not pruned nor re-indexed with EasyAdmin implementation.
+
+__BEFORE__
+
+```yaml
+easy_admin:
+    design:
+        menu:
+            - { label: Dashboard, route: admin_dashboard, icon: home, default: true }
+            - { label: Challenges, entity: Challenge, icon: running, role: ROLE_CHALLENGE_LIST }
+```
+
+__AFTER__
+
+```yaml
+easy_admin:
+    design:
+        menu:
+            - { label: Dashboard, route: admin_dashboard, icon: home, default: true }
+            - { label: Challenges, entity: Challenge, icon: running, permission: ROLE_CHALLENGE_LIST }
+```
+
+Note that `prune_menu_items` Twig function and `MenuHelper` service have been removed too.
+
+
 ## v2.1.0
 
 List filters form have been improved, with minor BC breaks :

composer.json

@@ -1,7 +1,7 @@
 {
     "name": "alterphp/easyadmin-extension-bundle",
     "type": "symfony-bundle",
-    "description": "This bundle provides some extensions to javiereguiluz/easyadmin-bundle",
+    "description": "This bundle provides some extensions to easycorp/easyadmin-bundle",
     "keywords": ["backend", "admin", "generator"],
     "homepage": "https://github.com/alterphp/EasyAdminExtensionBundle",
     "license": "MIT",
@@ -15,44 +15,49 @@
         "php": "^7.1.3",
         "doctrine/collections": "^1.5",
         "doctrine/common": "^2.8",
-        "doctrine/doctrine-bundle": "^1.8",
+        "doctrine/doctrine-bundle": "^1.8|^2.0",
         "doctrine/orm": "^2.6",
-        "easycorp/easyadmin-bundle": "^2.0,<2.2.0",
+        "easycorp/easyadmin-bundle": "^2.2.2",
         "league/uri-manipulations": "^1.3",
         "league/uri-schemes": "^1.2",
-        "symfony/config": "^4.1",
-        "symfony/dependency-injection": "^4.1",
-        "symfony/event-dispatcher": "^4.1",
-        "symfony/form": "^4.1",
-        "symfony/framework-bundle": "^4.1",
-        "symfony/http-foundation": "^4.1",
-        "symfony/http-kernel": "^4.1",
-        "symfony/property-access": "^4.1",
-        "symfony/validator": "^4.1",
-        "twig/twig": "^2.4"
+        "symfony/config": "^4.2|^5.0",
+        "symfony/dependency-injection": "^4.2|^5.0",
+        "symfony/event-dispatcher": "^4.2|^5.0",
+        "symfony/form": "^4.2|^5.0",
+        "symfony/framework-bundle": "^4.2|^5.0",
+        "symfony/http-foundation": "^4.2|^5.0",
+        "symfony/http-kernel": "^4.2|^5.0",
+        "symfony/property-access": "^4.2|^5.0",
+        "symfony/validator": "^4.2|^5.0",
+        "twig/twig": "^2.11.3|^3.0"
     },
     "require-dev": {
+        "doctrine/data-fixtures": "^1.3",
         "doctrine/doctrine-fixtures-bundle": "^3.0",
         "friendsofphp/php-cs-fixer": "^2.11",
         "php-coveralls/php-coveralls": "^2.0",
-        "phpstan/phpstan": "^0.9.2",
-        "phpunit/phpunit": "~5",
+        "phpstan/phpstan": "dev-master",
         "psr/log": "~1.0",
-        "symfony/browser-kit": "^4.1",
-        "symfony/console": "^4.1",
-        "symfony/css-selector": "^4.1",
-        "symfony/dom-crawler": "^4.1",
-        "symfony/phpunit-bridge": "^4.1",
-        "symfony/polyfill": "^1.7",
-        "symfony/security-bundle": "^4.1",
-        "symfony/templating": "^4.1",
-        "symfony/thanks": "^1.0",
-        "symfony/twig-bundle": "^4.1",
-        "symfony/var-dumper": "^4.1"
+        "symfony/browser-kit": "^4.2|^5.0",
+        "symfony/console": "^4.2|^5.0",
+        "symfony/css-selector": "^4.2|^5.0",
+        "symfony/dom-crawler": "^4.2|^5.0",
+        "symfony/phpunit-bridge": "^4.3.5|^5.0",
+        "symfony/polyfill-mbstring": "^1.7",
+        "symfony/security-bundle": "^4.2|^5.0",
+        "symfony/templating": "^4.2|^5.0",
+        "symfony/thanks": "^1.2.4",
+        "symfony/twig-bundle": "^4.2|^5.0",
+        "symfony/var-dumper": "^4.2|^5.0",
+        "symfony/yaml": "^4.2|^5.0"
+    },
+    "conflict": {
+        "easycorp/easyadmin-bundle": "<2.2.2"
     },
     "config": {
         "sort-packages": true,
         "platform": {
+            "php": "7.1.3",
             "ext-intl": "1.0"
         }
     },
@@ -68,7 +73,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "2.1.x-dev"
+            "dev-master": "3.0.x-dev"
         }
     }
 }

docker-compose.yml.dist

@@ -7,14 +7,8 @@ services:
         volumes:
             - ./:/app
         entrypoint:
-          - php
-          - /app/vendor/bin/simple-phpunit
+          - 'php'
+          - '/app/vendor/bin/simple-phpunit'
+          - '-c'
+          - '/app/phpunit.xml.dist'
 
-    php-cs-fixer:
-        image: ekreative/php-cs-fixer
-        volumes:
-            - ./:/app
-        entrypoint:
-          - /usr/local/bin/php-cs-fixer
-          - fix
-          - /app

docker/phpunit/Dockerfile

@@ -1,4 +1,9 @@
-FROM phpunit/phpunit:latest
+FROM php:7.1
 
-RUN apk --no-cache add php7-iconv
-RUN apk --no-cache add php7-simplexml
+RUN apt-get update && \
+    apt-get install -y --no-install-recommends git zip
+
+RUN curl --silent --show-error https://getcomposer.org/installer | php
+
+# RUN apk --no-cache add php7-iconv
+# RUN apk --no-cache add php7-simplexml