Add central/singleton Factory and deprecate FactoryTrait trait #221

mvorisek · 2020-06-04T20:34:23Z

no BC break

merge after: atk4/ui#1251 (one line fix needed for ui/Template because of php7.2 limitation of traits)

By using single point factory we can offer extreme magic - user can inject own Factory and he can return any implementation he wants for any object (based on stacktrace even different) thru the whole project.

For these reasons you should never use direct instantiation:

new Class($arg1, $args2, ...)

in Atk code but always create new instance thru \atk4\core\Factory like:

Factory::factory([Class::class, $arg1, $rg2, ...])

FactoryTrait was quite a bad design pattern - there is currently no need to remove it, as it can be deprecated only for now without any negative side effect.

DarkSide666 · 2020-06-06T20:55:41Z

This one I definitely would like @romaninsh to review too.

romaninsh

Agree that this is not a BC, however updating other core classes to use new Factory trait would cause BC..

It's better if we plan it and suggest users how to update their code.

georgehristov · 2020-06-06T11:33:43Z

src/Core.php

+    /**
+     * See \atk4\core\Factory::factory().
+     */
+    public static function factory($seed, $defaults = [], /* remove in 2021-jun, catch passed but no longer supported prefix */...$extraArgs): object


How about renaming this create for semantic purposes?

I am not against, but I would like to see analysis from top 10 frameworks to decise if it is worth or not.

You should always use ClWithDi::fromSeed, thus renaming this method does not help with daily usage...

georgehristov · 2020-06-06T11:34:56Z

src/Core.php

+    /**
+     * See \atk4\core\Factory::mergeSeeds().
+     */
+    public static function mergeSeeds(...$seeds)


How about using only merge?

Current name is much more self explaning, I prefer to keep it.

georgehristov · 2021-04-06T06:52:32Z

src/DIContainerTrait.php

+     */
+    public static function fromSeed($seed = [], $defaults = [])// :static supported by PHP8+
+    {
+        if (func_num_args() > 2) { // prevent bad usage


You can reduce code here by simpy calling

$object = static::fromSeedUnsafe($seed, $defaults); static::assertInstanceOf($object); return $object;

⚠️ Can, but do not want - this way, assertInstanceOf is computed even before the object is even created, which implies stronger security! (as seed can be an user input)

What I see the assertInstanceOf is called before the $object is returned only?
The rest of the code is the same.

⚠️ No! _fromSeedPrecheck is called BEFORE object is constructed. Be very carefull around this and test for this behaviour will be highly welcomed.

PR for test: #311

mvorisek force-pushed the allow_to_use_fromseed_almost_everywhere branch from 972d269 to 90216fc Compare June 4, 2020 21:22

mvorisek requested a review from DarkSide666 June 4, 2020 21:22

mvorisek force-pushed the allow_to_use_fromseed_almost_everywhere branch 4 times, most recently from 2d9503e to 6491150 Compare June 4, 2020 23:38

mvorisek changed the title ~~Move fromSeed and related methods to DIContainerTrait trait~~ Add single point factory Jun 4, 2020

mvorisek changed the title ~~Add single point factory~~ Add single point (potentionally customizeable) factory Jun 4, 2020

mvorisek changed the title ~~Add single point (potentionally customizeable) factory~~ Add single point (customizeable) factory Jun 4, 2020

mvorisek changed the title ~~Add single point (customizeable) factory~~ Replace FactoryTrait with singleton factory Jun 4, 2020

mvorisek changed the title ~~Replace FactoryTrait with singleton factory~~ Replace FactoryTrait with singleton Factory Jun 4, 2020

mvorisek added the BC-break label Jun 4, 2020

mvorisek force-pushed the allow_to_use_fromseed_almost_everywhere branch from a2ec463 to 72c69cc Compare June 4, 2020 23:58

mvorisek changed the title ~~Replace FactoryTrait with singleton Factory~~ Deprecate FactoryTrait with singleton Factory Jun 5, 2020

mvorisek removed the BC-break label Jun 5, 2020

mvorisek force-pushed the allow_to_use_fromseed_almost_everywhere branch 2 times, most recently from e2a9803 to 20cf93f Compare June 5, 2020 11:23

This was referenced Jun 6, 2020

Remove trait identification property #227

Merged

Better factory prefix detection/throw #219

Closed

mvorisek force-pushed the allow_to_use_fromseed_almost_everywhere branch from 5bec9f4 to 9a4817b Compare June 6, 2020 10:57

mvorisek requested review from romaninsh, abbadon1334 and georgehristov June 6, 2020 10:57

mvorisek changed the title ~~Deprecate FactoryTrait with singleton Factory~~ Add central/singleton Factory and deprecate FactoryTrait trait Jun 6, 2020

mvorisek force-pushed the allow_to_use_fromseed_almost_everywhere branch 6 times, most recently from d23ce41 to 5da2218 Compare June 6, 2020 12:14

mvorisek force-pushed the allow_to_use_fromseed_almost_everywhere branch from 42e0087 to 3fa4b31 Compare June 6, 2020 20:10

mvorisek marked this pull request as ready for review June 6, 2020 20:11

mvorisek force-pushed the allow_to_use_fromseed_almost_everywhere branch from 3fa4b31 to 18cd07c Compare June 6, 2020 20:12

mvorisek added RTM and removed RTM labels Jun 6, 2020

mvorisek marked this pull request as draft June 6, 2020 20:13

mvorisek added 5 commits June 6, 2020 22:30

Add central/singleton Factory and deprecate FactoryTrait trait

97d7f5b

fix exception renderer fallback message

a39a696

fix vendor dir when core is used as main project

6e9134f

fix CS

9dd9446

simplify

8bd3aef

mvorisek force-pushed the allow_to_use_fromseed_almost_everywhere branch from fc78823 to 8bd3aef Compare June 6, 2020 20:31

mvorisek marked this pull request as ready for review June 6, 2020 20:32

mvorisek added the RTM label Jun 6, 2020

improve translatability

96cff5f

mvorisek force-pushed the allow_to_use_fromseed_almost_everywhere branch from ffaf5c9 to 96cff5f Compare June 6, 2020 20:35

small improvements

6b0478b

mvorisek force-pushed the allow_to_use_fromseed_almost_everywhere branch from 049e3e8 to 6b0478b Compare June 6, 2020 20:42

mvorisek mentioned this pull request Jun 7, 2020

Fix missing DIContainerTrait when StaticAddToTrait is used atk4/ui#1251

Merged

mvorisek added waitingForAnotherPR RTM and removed RTM labels Jun 7, 2020

romaninsh approved these changes Jun 7, 2020

View reviewed changes

mvorisek merged commit 9ee73d8 into develop Jun 7, 2020

mvorisek deleted the allow_to_use_fromseed_almost_everywhere branch June 7, 2020 16:44

mvorisek removed the waitingForAnotherPR label Jun 12, 2020

atk4 deleted a comment from codecov bot Apr 5, 2021

georgehristov reviewed Apr 6, 2021

View reviewed changes

mvorisek mentioned this pull request Apr 6, 2021

Add early/before constructor subtype test #311

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add central/singleton Factory and deprecate FactoryTrait trait #221

Add central/singleton Factory and deprecate FactoryTrait trait #221

mvorisek commented Jun 4, 2020 •

edited

Loading

DarkSide666 commented Jun 6, 2020

romaninsh left a comment

georgehristov Jun 6, 2020

mvorisek Apr 6, 2021

mvorisek Apr 6, 2021

georgehristov Jun 6, 2020

mvorisek Apr 6, 2021

georgehristov Apr 6, 2021

mvorisek Apr 6, 2021

georgehristov Apr 6, 2021

mvorisek Apr 6, 2021

mvorisek Apr 6, 2021

Add central/singleton Factory and deprecate FactoryTrait trait #221

Add central/singleton Factory and deprecate FactoryTrait trait #221

Conversation

mvorisek commented Jun 4, 2020 • edited Loading

DarkSide666 commented Jun 6, 2020

romaninsh left a 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

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

mvorisek commented Jun 4, 2020 •

edited

Loading