search

sonata-project / SonataAdminBundle

The missing Symfony Admin Generator
https://docs.sonata-project.org/projects/SonataAdminBundle
MIT License
2.1k stars 1.26k forks source link

AdminMaker services should be defaulted by the set option #7897

Closed joerndyherrn closed 2 years ago

joerndyherrn commented 2 years ago

Environment

Sonata packages

show

``` sonata-project/admin-bundle 4.13.1 4.16.0 The missing Symfony Admin Generator sonata-project/block-bundle 4.14.0 4.16.0 Symfony SonataBlockBundle sonata-project/cache 2.2.0 2.2.0 Cache library Package sonata-project/cache is abandoned, you should avoid using it. No replacement was suggested. sonata-project/doctrine-extensions 1.17.0 2.0.1 Doctrine2 behavioral extensions sonata-project/doctrine-orm-admin-bundle 4.3.0 4.4.0 Integrate Doctrine ORM into the SonataAdminBundle sonata-project/exporter 2.13.0 3.0.0 Lightweight Exporter library sonata-project/form-extensions 1.17.1 1.18.0 Symfony form extensions sonata-project/translation-bundle 3.1.0 3.1.0 SonataTranslationBundle sonata-project/twig-extensions 1.10.0 2.0.0 Sonata twig extensions sonata-project/user-bundle 5.2.0 5.3.2 Symfony SonataUserBundle ```

Symfony packages

show

``` symfony/apache-pack v1.0.1 v1.0.1 A pack for Apache support in Symfony symfony/asset v6.0.7 v6.1.0 Manages URL generation and versioning of web assets such as CSS stylesheets, JavaScript files and image files symfony/browser-kit v6.0.3 v6.1.3 Simulates the behavior of a web browser, allowing you to make requests, click on links and submit forms programmatically symfony/cache v6.0.11 v6.1.3 Provides an extended PSR-6, PSR-16 (and tags) implementation symfony/cache-contracts v3.1.1 v3.1.1 Generic abstractions related to caching symfony/config v6.0.11 v6.1.3 Helps you find, load, combine, autofill and validate configuration values of any kind symfony/console v6.0.11 v6.1.3 Eases the creation of beautiful and testable command line interfaces symfony/css-selector v6.0.3 v6.1.3 Converts CSS selectors to XPath expressions symfony/debug-bundle v6.0.3 v6.1.3 Provides a tight integration of the Symfony VarDumper component and the ServerLogCommand from MonologBridge into the Symfony full-stack framework symfony/dependency-injection v6.0.11 v6.1.3 Allows you to standardize and centralize the way objects are constructed in your application symfony/deprecation-contracts v3.1.1 v3.1.1 A generic function and convention to trigger deprecation notices symfony/doctrine-bridge v6.0.11 v6.1.3 Provides integration for Doctrine with various Symfony components symfony/dom-crawler v6.0.9 v6.1.3 Eases DOM navigation for HTML and XML documents symfony/dotenv v6.0.5 v6.1.0 Registers environment variables from a .env file symfony/error-handler v6.0.11 v6.1.3 Provides tools to manage errors and ease debugging PHP code symfony/event-dispatcher v6.0.9 v6.1.0 Provides tools that allow your application components to communicate with each other by dispatching events and listening to them symfony/event-dispatcher-contracts v3.1.1 v3.1.1 Generic abstractions related to dispatching event symfony/expression-language v6.0.10 v6.1.3 Provides an engine that can compile and evaluate expressions symfony/filesystem v6.0.11 v6.1.3 Provides basic utilities for the filesystem symfony/finder v6.0.11 v6.1.3 Finds files and directories via an intuitive fluent interface symfony/flex v1.19.2 v2.2.2 Composer plugin for Symfony symfony/form v6.0.10 v6.1.3 Allows to easily create, process and reuse HTML forms symfony/framework-bundle v6.0.11 v6.1.3 Provides a tight integration between Symfony components and the Symfony full-stack framework symfony/http-client v6.0.9 v6.1.3 Provides powerful methods to fetch HTTP resources synchronously or asynchronously symfony/http-client-contracts v3.1.1 v3.1.1 Generic abstractions related to HTTP clients symfony/http-foundation v6.0.11 v6.1.3 Defines an object-oriented layer for the HTTP specification symfony/http-kernel v6.0.11 v6.1.3 Provides a structured process for converting a Request into a Response symfony/intl v6.0.8 v6.1.0 Provides a PHP replacement layer for the C intl extension that includes additional data from the ICU library symfony/mailer v6.0.10 v6.1.3 Helps sending emails symfony/maker-bundle v1.43.0 v1.45.0 Symfony Maker helps you create empty commands, controllers, form classes, tests and more so you can forget about writing boilerplate code. symfony/mime v6.0.11 v6.1.3 Allows manipulating MIME messages symfony/monolog-bridge v6.0.10 v6.1.2 Provides integration for Monolog with various Symfony components symfony/monolog-bundle v3.8.0 v3.8.0 Symfony MonologBundle symfony/options-resolver v6.0.3 v6.1.0 Provides an improved replacement for the array_replace PHP function symfony/password-hasher v6.0.8 v6.1.3 Provides password hashing utilities symfony/phpunit-bridge v6.1.2 v6.1.3 Provides utilities for PHPUnit, especially user deprecation notices management symfony/polyfill-ctype v1.26.0 v1.26.0 Symfony polyfill for ctype functions symfony/polyfill-intl-grapheme v1.26.0 v1.26.0 Symfony polyfill for intl's grapheme_* functions symfony/polyfill-intl-icu v1.26.0 v1.26.0 Symfony polyfill for intl's ICU-related data and classes symfony/polyfill-intl-idn v1.26.0 v1.26.0 Symfony polyfill for intl's idn_to_ascii and idn_to_utf8 functions symfony/polyfill-intl-normalizer v1.26.0 v1.26.0 Symfony polyfill for intl's Normalizer class and related functions symfony/polyfill-mbstring v1.26.0 v1.26.0 Symfony polyfill for the Mbstring extension symfony/polyfill-php72 v1.26.0 v1.26.0 Symfony polyfill backporting some PHP 7.2+ features to lower PHP versions symfony/polyfill-php80 v1.26.0 v1.26.0 Symfony polyfill backporting some PHP 8.0+ features to lower PHP versions symfony/polyfill-php81 v1.26.0 v1.26.0 Symfony polyfill backporting some PHP 8.1+ features to lower PHP versions symfony/process v6.0.8 v6.1.3 Executes commands in sub-processes symfony/property-access v6.0.8 v6.1.3 Provides functions to read and write from/to an object or array using a simple string notation symfony/property-info v6.0.10 v6.1.3 Extracts information about PHP class' properties using metadata of popular sources symfony/routing v6.0.11 v6.1.3 Maps an HTTP request to a set of configuration variables symfony/runtime v6.0.8 v6.1.3 Enables decoupling PHP applications from global state symfony/security-acl v3.3.1 v3.3.1 Symfony Security Component - ACL (Access Control List) symfony/security-bundle v6.0.9 v6.1.3 Provides a tight integration of the Security component into the Symfony full-stack framework symfony/security-core v6.0.8 v6.1.3 Symfony Security Component - Core Library symfony/security-csrf v6.0.9 v6.1.0 Symfony Security Component - CSRF Library symfony/security-http v6.0.10 v6.1.3 Symfony Security Component - HTTP Integration symfony/serializer v6.0.10 v6.1.3 Handles serializing and deserializing data structures, including object graphs, into array structures or other formats like XML and JSON. symfony/service-contracts v3.1.1 v3.1.1 Generic abstractions related to writing services symfony/stopwatch v6.0.5 v6.1.0 Provides a way to profile code symfony/string v6.0.11 v6.1.3 Provides an object-oriented API to strings and deals with bytes, UTF-8 code points and grapheme clusters in a unified way symfony/translation v6.0.9 v6.1.3 Provides tools to internationalize your application symfony/translation-contracts v2.5.2 v3.1.1 Generic abstractions related to translation symfony/twig-bridge v6.0.10 v6.1.3 Provides integration for Twig with various Symfony components symfony/twig-bundle v6.0.8 v6.1.1 Provides a tight integration of Twig into the Symfony full-stack framework symfony/validator v6.0.10 v6.1.3 Provides tools to validate values symfony/var-dumper v6.0.11 v6.1.3 Provides mechanisms for walking through any arbitrary PHP variable symfony/var-exporter v6.0.10 v6.1.3 Allows exporting any serializable PHP data structure to plain PHP code symfony/web-link v6.0.3 v6.1.0 Manages links between resources symfony/web-profiler-bundle v6.0.10 v6.1.2 Provides a development tool that gives detailed information about the execution of any request symfony/yaml v6.0.10 v6.1.3 Loads and dumps YAML files ```

PHP version

PHP 8.1.3 (cli) (built: Feb 18 2022 09:12:41) (NTS)
Copyright (c) The PHP Group
Zend Engine v4.1.3, Copyright (c) Zend Technologies
    with Zend OPcache v8.1.3, Copyright (c), by Zend Technologies

Subject

https://github.com/sonata-project/SonataAdminBundle/blob/18732411a37bd7d8831dcafcbb3f8fd462e8dd7a/src/Maker/AdminMaker.php#L161

Steps to reproduce

You need to execute the the maker command with the services option set

Expected results

sf make:sonata:admin -s packages/admin.yaml App\\Entity\\Test          

Welcome to the Sonata Admin
---------------------------

 The fully qualified model class [App\Entity\Test]:
 > 

 The admin class basename [TestAdmin]:
 > 

 Do you want to generate a controller? (yes/no) [no]:
 > 

 Do you want to update the services YAML configuration file? (yes/no) [yes]:
 > 

 The services YAML configuration file [packages/admin.yaml]:
 >

Actual results

sf make:sonata:admin -s packages/admin.yaml App\\Entity\\Test          

Welcome to the Sonata Admin
---------------------------

 The fully qualified model class [App\Entity\Test]:
 > 

 The admin class basename [TestAdmin]:
 > 

 Do you want to generate a controller? (yes/no) [no]:
 > 

 Do you want to update the services YAML configuration file? (yes/no) [yes]:
 > 

 The services YAML configuration file [services.yaml]:
 >
VincentLanglet commented 2 years ago

I don't understand the issue. We provide admin.yaml by default only if the file exists.

Also, it's not packages/admin.yaml but admin.yaml. Your file may not be proposed because it's not in the right place.

joerndyherrn commented 2 years ago

@VincentLanglet I think you didn't get the point When using the --services (-s) option it won't affect anything. Even though the description says that the -s option will set the admin.yaml path. From my point of view it shouldn't be interesting where we actually store our admin.yaml file. I think there are two option:

  1. Checking if the option is set in https://github.com/sonata-project/SonataAdminBundle/blob/18732411a37bd7d8831dcafcbb3f8fd462e8dd7a/src/Maker/AdminMaker.php#L161
  2. Removing the option from the Maker Command
VincentLanglet commented 2 years ago

I see, looking at others options it should be

$input->getOption('services') ?? is_file($path.'admin.yaml') ? 'admin.yaml' : 'services.yaml',

Do you confirm it would solve the issue ? Can you do a PR ? :)

joerndyherrn commented 2 years ago

@VincentLanglet confirming + done