Add maker command to generate data providers/persisters #3850

antograssiot · 2020-11-26T17:24:02Z

Q	A
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tickets	fixes #3849
License	MIT
Doc PR	no yet

I had this ready since a year probably for discussion

soyuka · 2020-11-26T17:40:39Z

This is a really good start thanks! Maybe some improvements for later:

generate the support methods by asking what entity this data provider / persister targets
DataProvider: choose if you want to do collections, items or both (not sure if this is possible)

antograssiot · 2020-11-26T18:01:37Z

I'll look into this soon

dunglas

This looks great!

src/Bridge/Symfony/Maker/MakeDataPersister.php

src/Bridge/Symfony/Maker/MakeDataProvider.php

src/Bridge/Symfony/Maker/Resources/skeleton/DataProvider.tpl.php

weaverryan · 2020-11-27T18:53:08Z

I love this idea!

What about asking a question related to decoration? I commonly want a data persister or data provider simply so that I can decorate the core persister/provider to add some functionality - this is mostly useful with entities. The question could be:

Will this data persister be used for an entity class?

(if yes):

Choose which entity:

A) Foo
B) Bar
C) Other entities...

And then... I think we wouldn't even need to ask them if they want to "decorate"/call the core persister... I would think that if you have an entity then you always would.

Or, another option would be to ask:

Choose which API Resource class this data persister will be used for?

A) Foo
B) Bar
C) ... list all other API Resource classes
D) None/other (in case the user is doing something super custom)

Then, if the class is an entity, we decorate the core entity persister.

It definitely adds significant complexity... but it would also be very nice, so I wanted to at least mention the idea :).

Thanks!

antograssiot · 2020-11-27T20:36:22Z

I've improved the initial proposal by including @soyuka and @dunglas proposals

You can now choose in data providers it you only want to generate item or collection data providers
I'va also added a new question regarding the target resource class with auto-completion

src/Bridge/Symfony/Maker/Resources/skeleton/DataPersister.tpl.php

src/Bridge/Symfony/Maker/Resources/skeleton/DataProvider.tpl.php

src/Bridge/Symfony/Maker/Resources/skeleton/DataPersister.tpl.php

antograssiot · 2020-12-03T05:12:17Z

updated as requested, I've also improve code coverage and rebased @dunglas
I like @weaverryan suggestion on the decoration but it might fit in a future PR, I'm not sure when I'll have time to work on this, probably not before Christmas holidays

alanpoulain · 2021-02-17T15:17:19Z

src/Bridge/Symfony/Bundle/DependencyInjection/Configuration.php

+            ->arrayNode('maker')
+            ->{class_exists(MakerBundle::class) ? 'canBeDisabled' : 'canBeEnabled'}()
+            ->end()


Suggested change

->arrayNode('maker')

->{class_exists(MakerBundle::class) ? 'canBeDisabled' : 'canBeEnabled'}()

->end()

->arrayNode('maker')

->{class_exists(MakerBundle::class) ? 'canBeDisabled' : 'canBeEnabled'}()

->end()

alanpoulain · 2021-02-17T15:35:27Z

src/Bridge/Symfony/Maker/MakeDataPersister.php

+    {
+        return 'make:data-persister';
+    }
+


You should add the getCommandDescription static method instead of a call to setDescription (seems new to make it lazy).

alanpoulain · 2021-02-17T15:37:42Z

src/Bridge/Symfony/Maker/MakeDataProvider.php

+            ->addOption('collection-only', null, InputOption::VALUE_NONE, 'Generate only a collection data provider')
+            ->setHelp(file_get_contents(__DIR__.'/Resources/help/MakeDataProvider.txt'));
+
+        $inputConfig->setArgumentAsNonInteractive('name');


Why not using the automatic prompt for the name?

alanpoulain · 2021-02-17T15:39:07Z

src/Bridge/Symfony/Maker/Resources/help/MakeDataPersister.txt

@@ -0,0 +1,5 @@
+The <info>%command.name%</info> command generates a new data persister class.


Suggested change

The <info>%command.name%</info> command generates a new data persister class.

The <info>%command.name%</info> command generates an API Platform data persister class.

alanpoulain · 2021-02-17T15:39:19Z

src/Bridge/Symfony/Maker/Resources/help/MakeDataProvider.txt

@@ -0,0 +1,5 @@
+The <info>%command.name%</info> command generates a new data provider class.


Suggested change

The <info>%command.name%</info> command generates a new data provider class.

The <info>%command.name%</info> command generates an API Platform data provider class.

alanpoulain · 2021-02-17T15:39:35Z

src/Bridge/Symfony/Maker/Resources/skeleton/DataPersister.tpl.php

@@ -0,0 +1,47 @@
+<?= "<?php\n" ?>
+


No strict type?

alanpoulain · 2021-02-17T15:41:34Z

src/Bridge/Symfony/Maker/Resources/skeleton/DataPersister.tpl.php

+use <?= $resource_full_class_name ?>;
+<?php endif; ?>
+
+final class <?= $class_name ?> implements ContextAwareDataPersisterInterface


Shouldn't we add the ResumableDataPersisterInterface too by default?

alanpoulain · 2021-02-17T15:42:54Z

tests/Bridge/Symfony/Bundle/DependencyInjection/ApiPlatformExtensionTest.php

@@ -1265,6 +1265,9 @@ private function getBaseContainerBuilderProphecy(array $doctrineIntegrationsToLo
            'api_platform.json_schema.schema_factory',
            'api_platform.listener.view.validate',
            'api_platform.listener.view.validate_query_parameters',
+            'api_platform.maker.command.data_persister',
+            'api_platform.maker.command.data_provider',
+            'api_platform.mercure.listener.response.add_link_header',


Suggested change

'api_platform.mercure.listener.response.add_link_header',

alanpoulain · 2021-02-17T15:47:02Z

I love it! 😍
I think we can merge it as is and improve it later (for instance with @weaverryan's comment) later.
WDYT @antograssiot @api-platform/core-team?

soyuka · 2021-02-23T11:17:44Z

@alanpoulain feel free to continue working on this branch as @antograssiot doesn't have much time to continue!

- Add auto complete on resource class - Options to choose to generate only item/collection data provider

alanpoulain · 2021-06-18T12:51:09Z

Thank you very much @antograssiot!

…atform#3850)

dunglas requested changes Nov 26, 2020

View reviewed changes

weaverryan mentioned this pull request Nov 27, 2020

new Maker for api-platform data persisters symfony/maker-bundle#697

Closed

3 tasks

antograssiot force-pushed the maker branch 3 times, most recently from 9261275 to b7b972b Compare November 27, 2020 20:33

antograssiot force-pushed the maker branch 4 times, most recently from 2423cb8 to 32e1dbb Compare November 28, 2020 08:54

antograssiot marked this pull request as ready for review November 28, 2020 11:21

dunglas requested changes Dec 1, 2020

View reviewed changes

antograssiot force-pushed the maker branch from 3c89810 to 344e251 Compare December 3, 2020 04:57

antograssiot requested a review from dunglas December 5, 2020 10:02

antograssiot force-pushed the maker branch from 344e251 to 3ba3bd6 Compare December 7, 2020 17:57

Base automatically changed from master to main January 23, 2021 21:59

soyuka added this to the 2.7 milestone Feb 6, 2021

alanpoulain force-pushed the maker branch from 3ba3bd6 to 9d9dbe7 Compare February 17, 2021 15:15

alanpoulain reviewed Feb 17, 2021

View reviewed changes

src/Bridge/Symfony/Maker/Resources/skeleton/DataPersister.tpl.php

@@ -0,0 +1,47 @@

<?= "<?php\n" ?>

Copy link

Member

alanpoulain Feb 17, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No strict type?

alanpoulain reviewed Feb 17, 2021

View reviewed changes

alanpoulain force-pushed the maker branch from 9d9dbe7 to 607b99d Compare June 18, 2021 10:14

antograssiot and others added 9 commits June 18, 2021 14:28

Add maker command to generate data providers/persisters

56eb8ce

Add new features

da362fb

- Add auto complete on resource class - Options to choose to generate only item/collection data provider

Add tests for the new Maker commands

73eee07

Fix tests for PHP 7.1

85934bb

Try to fix test on windows

ef4eed9

Try to fix code coverage generation

a01bef2

Improve coverage and fix review

83e36f7

Fix indentation

ad1fb34

fix: minor changes

52c0b80

alanpoulain force-pushed the maker branch from 607b99d to 52c0b80 Compare June 18, 2021 12:29

alanpoulain merged commit e19c9be into api-platform:main Jun 18, 2021

LoicBoursin pushed a commit to LoicBoursin/core that referenced this pull request Aug 18, 2021

feat: add maker command to generate data providers/persisters (api-pl…

3e6e685

…atform#3850)

vincentchalamon pushed a commit to vincentchalamon/core that referenced this pull request Oct 15, 2021

feat: add maker command to generate data providers/persisters (api-pl…

d6cfce9

…atform#3850)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add maker command to generate data providers/persisters #3850

Add maker command to generate data providers/persisters #3850

antograssiot commented Nov 26, 2020

soyuka commented Nov 26, 2020

antograssiot commented Nov 26, 2020

dunglas left a comment

weaverryan commented Nov 27, 2020

antograssiot commented Nov 27, 2020

antograssiot commented Dec 3, 2020

alanpoulain Feb 17, 2021

alanpoulain Feb 17, 2021

alanpoulain Feb 17, 2021

alanpoulain Feb 17, 2021

alanpoulain Feb 17, 2021

alanpoulain Feb 17, 2021

alanpoulain Feb 17, 2021

alanpoulain Feb 17, 2021

alanpoulain commented Feb 17, 2021

soyuka commented Feb 23, 2021

alanpoulain commented Jun 18, 2021

		@@ -0,0 +1,5 @@
		The <info>%command.name%</info> command generates a new data persister class.

Add maker command to generate data providers/persisters #3850

Add maker command to generate data providers/persisters #3850

Conversation

antograssiot commented Nov 26, 2020

soyuka commented Nov 26, 2020

antograssiot commented Nov 26, 2020

dunglas left a comment

Choose a reason for hiding this comment

weaverryan commented Nov 27, 2020

antograssiot commented Nov 27, 2020

antograssiot commented Dec 3, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alanpoulain commented Feb 17, 2021

soyuka commented Feb 23, 2021

alanpoulain commented Jun 18, 2021