[DIC] Better handling of enableable configurations #6852

vicb · 2013-01-23T16:08:11Z

Q	A
Bug fix?	yes
New feature?	no
BC breaks?	no, this feature has not been released yet
Deprecations?	no
Tests pass?	yes
Fixed tickets	-
License	MIT
Doc PR	-

My definition of bug fix might be discussable. The thing which I think is not discussable is that this PR fixes the semantic - and I think it is important for a "semantic configuration": before this PR, some nodes had ->canBeDisabled for nodes that were actually disabled by default. Those nodes now have ->canBeEnabled which sounds right.

Edit: Jan 28, 2013 - history:

See the related comments.

I think Symfony must get the configuration right as we can expect of lot of devs to use this as a template when writting their own configuration.

@schmittjoh could you please give me your feedback on this change considering the rationale.

see symfony#6829

stof · 2013-01-23T16:10:33Z

@vicb your links are broken as they are pointing to the PR creation page

stof · 2013-01-23T16:10:55Z

and to create a TODO list, it has to be a list first

stof · 2013-01-23T16:12:04Z

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

@@ -91,10 +91,10 @@ private function addFormSection(ArrayNodeDefinition $rootNode)
            ->children()
                ->arrayNode('form')
                    ->info('form configuration')
-                    ->canBeDisabled()
+                    ->canBeEnabled()


This is not BC with 2.1. You need to add treatNullLike(array('enabled' => true))

This is the default: https://github.com/symfony/symfony/pull/6852/files#L4L226

ah indeed, I forgot it

I have tried to keep BC as much as possible (some other configs should probably get updated later) but it still needs a careful review !

vicb · 2013-01-23T16:31:10Z

@stof thanks for reporting the broken links, they are fixed /cc @schmittjoh

vicb · 2013-01-23T16:31:50Z

@Tobion please submit a PR to my repo, I don't have much time to work on this. Thanks !

schmittjoh · 2013-01-23T17:23:42Z

src/Symfony/Component/Config/CHANGELOG.md

@@ -4,6 +4,9 @@ CHANGELOG
 2.2.0
 -----

+ * [BC BREAK] changed ArrayNodeDefinition::canBeEnabled() and ArrayNodeDefinition::canBeDisabled()
+   to set the defaults when the node is not set - the methods were ineffective
+   if ArrayNodeDefinition::setDefaultsIfNotSet() was not explicitely called.


Small typo here add not set.

Regarding the change itself, it seems fine to me.

Thanks for the review, I'll update tomorrow

vicb · 2013-01-25T15:14:47Z

@fabpot @schmittjoh I'd like your feedback on the latest commit, rationale is in the method phpDoc. It better matches what we do now and seem the most sensible thing to do.

edit: with this you can no more disable the node explicitly, I have to find a better solution

schmittjoh · 2013-01-25T15:20:13Z

Looks good.

On Fri, Jan 25, 2013 at 4:15 PM, Victor Berchet notifications@github.comwrote:

@fabpot https://github.com/fabpot @schmittjohhttps://github.com/schmittjohI'd like your feedback on the latest commit, rationale is in the method
phpDoc. It better matches what we do now and seem the most sensible thing
to do.

—
Reply to this email directly or view it on GitHubhttps://github.com//pull/6852#issuecomment-12704585.

stof · 2013-01-26T00:25:08Z

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php

-
-        if (isset($config['router_proxy'])) {
-            $this->registerRouterProxyConfiguration($config['router_proxy'], $container, $loader);
+        if (isset($config['templating'])) {


why keeping a isset here while you use an early return in other methods ?

@stof For now this PR only fixes the current config and templating is not an enableable node as of today.

vicb · 2013-01-28T14:37:57Z

@fabpot I know I keep insisting on this one and I am sorry for that but I think this should be considered as a bug fix (see the PR header for details) and should be merged in 2.2. I think the Symfony core should be exemplary as it is used by many developers as a template when creating their own bundle. This PR is no more a WIP and can be merged right now.

In addition to fixing the enableable nodes, this PR contain new UTs and some fixes to the code / tests.

fabpot · 2013-01-28T16:42:18Z

src/Symfony/Component/Config/CHANGELOG.md

@@ -4,6 +4,9 @@ CHANGELOG
 2.2.0
 -----

+ * [BC BREAK] changed ArrayNodeDefinition::canBeEnabled() and ArrayNodeDefinition::canBeDisabled()


Actually, this is not a BC break as those methods have been introduced in 2.2 (see #5688). So, this can be replaced with something like "added ArrayNodeDefinition::canBeEnabled() and ArrayNodeDefinition::canBeDisabled() to simplify optional configuration management"

fabpot · 2013-01-28T16:43:42Z

@vicb As explained in a comment, this is not a BC break as this feature does not exist in 2.1. So, I can make the change to the CHANGELOG if you want after merging, or I can let you make the change.

vicb · 2013-01-28T16:46:33Z

I am going to change it right now !

vicb · 2013-01-28T16:46:56Z

(and thanks for having checked this)

The features has not been released yet -> not a BC break

vicb · 2013-01-28T16:54:37Z

@fabpot I have updated the changelog and the PR header.

I am not sure if the commits should be squashed or not. On one side the multiple commits can help understand the changes but on the other side that's a lot of small commits which could pollute history. I let you choose what to do.

@schmittjoh

This PR was squashed before being merged into the master branch (closes #6852). Commits ------- fde7585 [DIC] Better handling of enableable configurations Discussion ---------- [DIC] Better handling of enableable configurations | Q | A | ------------- | --- | Bug fix? | yes | New feature? | no | BC breaks? | no, this feature has not been released yet | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - My definition of bug fix might be discussable. The thing which I think is not discussable is that this PR fixes the semantic - and I think it is important for a "semantic configuration": before this PR, some nodes had `->canBeDisabled` for nodes that were actually disabled by default. Those nodes now have `->canBeEnabled` which sounds right. **Edit: Jan 28, 2013** - history: See [the related comments](symfony/symfony#6829 (comment)). I think Symfony **must** get the configuration right as we can expect of lot of devs to use this as a template when writting their own configuration. @schmittjoh could you please give me your feedback on [this change](https://github.com/symfony/symfony/pull/6852/files#L4R224) considering [the rationale](https://github.com/symfony/symfony/pull/6852/files#L3R7). --------------------------------------------------------------------------- by stof at 2013-01-23T16:10:33Z @vicb your links are broken as they are pointing to the PR creation page --------------------------------------------------------------------------- by stof at 2013-01-23T16:10:55Z and to create a TODO list, it has to be a list first --------------------------------------------------------------------------- by vicb at 2013-01-23T16:31:10Z @stof thanks for reporting the broken links, they are fixed /cc @schmittjoh --------------------------------------------------------------------------- by vicb at 2013-01-23T16:31:50Z @Tobion please submit a PR to my repo, I don't have much time to work on this. Thanks ! --------------------------------------------------------------------------- by vicb at 2013-01-25T15:14:47Z @fabpot @schmittjoh I'd like your feedback on the latest commit, rationale is in the method phpDoc. It better matches what we do now and seem the most sensible thing to do. edit: with this you can no more disable the node explicitly, I have to find a better solution --------------------------------------------------------------------------- by schmittjoh at 2013-01-25T15:20:13Z Looks good. On Fri, Jan 25, 2013 at 4:15 PM, Victor Berchet <notifications@github.com>wrote: > @fabpot <https://github.com/fabpot> @schmittjoh<https://github.com/schmittjoh>I'd like your feedback on the latest commit, rationale is in the method > phpDoc. It better matches what we do now and seem the most sensible thing > to do. > > — > Reply to this email directly or view it on GitHub<symfony/symfony#6852 (comment)>. > > --------------------------------------------------------------------------- by vicb at 2013-01-28T14:37:57Z @fabpot I know I keep insisting on this one and I am sorry for that but I think this should be considered as a bug fix (see the PR header for details) and should be merged in 2.2. I think the Symfony core should be exemplary as it is used by many developers as a template when creating their own bundle. *This PR is no more a WIP and can be merged right now*. In addition to fixing the enableable nodes, this PR contain new UTs and some fixes to the code / tests. --------------------------------------------------------------------------- by fabpot at 2013-01-28T16:43:42Z @vicb As explained in a comment, this is not a BC break as this feature does not exist in 2.1. So, I can make the change to the CHANGELOG if you want after merging, or I can let you make the change. --------------------------------------------------------------------------- by vicb at 2013-01-28T16:46:33Z I am going to change it right now ! --------------------------------------------------------------------------- by vicb at 2013-01-28T16:46:56Z (and thanks for having checked this) --------------------------------------------------------------------------- by vicb at 2013-01-28T16:54:37Z @fabpot I have updated the changelog and the PR header. I am not sure if the commits should be squashed or not. On one side the multiple commits can help understand the changes but on the other side that's a lot of small commits which could pollute history. I let you choose what to do.

vicb added 3 commits January 23, 2013 15:18

[FrameworkBundle] Fix the DI config

728dd93

see symfony#6829

[DIC] tweaks

868dc27

[WIP][DIC] Better handling of enableable array nodes

2c2521a

stof reviewed Jan 23, 2013
View reviewed changes

schmittjoh reviewed Jan 23, 2013
View reviewed changes

vicb added 4 commits January 24, 2013 09:29

implement feedback

ccbabff

[FrameworkBundle] Fix the configuration info

1fb6ede

fixes

30167b3

tweak the enableable nodes

4979960

stof reviewed Jan 26, 2013
View reviewed changes

vicb added 4 commits January 28, 2013 13:31

[Config] Tweak tests

f714095

[Config] Tweak the Processor

ea94ab0

[ArrayNode] Allow explicitely disabling Enableable nodes, UTs

1f540c0

[FrameworkBundle] Update the UTs

c274274

fabpot reviewed Jan 28, 2013
View reviewed changes

[Config] Fix the changelog

58f221a

The features has not been released yet -> not a BC break

fabpot closed this in c1037b1 Jan 28, 2013

Uh oh!

[DIC] Better handling of enableable configurations #6852

[DIC] Better handling of enableable configurations #6852

Uh oh!

Conversation

vicb commented Jan 23, 2013

Uh oh!

stof commented Jan 23, 2013

Uh oh!

stof commented Jan 23, 2013

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vicb commented Jan 23, 2013

Uh oh!

vicb commented Jan 23, 2013

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vicb commented Jan 25, 2013

Uh oh!

schmittjoh commented Jan 25, 2013

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vicb commented Jan 28, 2013

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fabpot commented Jan 28, 2013

Uh oh!

vicb commented Jan 28, 2013

Uh oh!

vicb commented Jan 28, 2013

Uh oh!

vicb commented Jan 28, 2013

Uh oh!

Uh oh!