[Config] allow changing the path separator #22253

bburnichon · 2017-04-03T14:38:30Z

Q	A
Branch?	master
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	#22268
License	MIT
Doc PR

In bundles configuration, no dots are allowed in key names, but as a standalone config, there is no such limitation that should be enforced.

By using current NodeBuilder it should be possible to change path separator used (for example: /)

nicolas-grekas

missing tests and CHANGELOG entry

nicolas-grekas · 2017-07-12T06:54:49Z

src/Symfony/Component/Config/Definition/BaseNode.php

 {
+    const DEFAULT_PATH_SEPARATOR = '.';
+
+    private $pathSeparator;


since all other props are protected, should we make this one protected also, and use it directly in child nodes?

I would keep it private if it does not need to be protected. It is easier for our BC policy

nicolas-grekas · 2017-07-12T06:57:14Z

src/Symfony/Component/Config/Definition/Builder/TreeBuilder.php

+     * @var NodeDefinition|null
+     */
    protected $root;
-    protected $builder;


this should be deprecated instead with an annotation (no need for runtime BC layer since this is useless, WDYT?)

nicolas-grekas · 2017-07-12T06:58:42Z

src/Symfony/Component/Config/Definition/Builder/NodeDefinition.php

 */
 abstract class NodeDefinition implements NodeParentInterface
 {
+    private $pathSeparator = BaseNode::DEFAULT_PATH_SEPARATOR;


nicolas-grekas · 2017-07-12T07:00:12Z

src/Symfony/Component/Config/Definition/BaseNode.php

+    public function __construct($name, NodeInterface $parent = null, $pathSeparator = self::DEFAULT_PATH_SEPARATOR)
    {
-        if (false !== strpos($name, '.')) {
-            throw new \InvalidArgumentException('The name must not contain ".".');


this should be kept, but the dot replaced by the pathSeparator

Why not, but this is the only place where the name is checked. In prototyped node, name property is not enforced and make Node inconsistent. See 7be490f

@bburnichon would you mind reverting this change (and using the $pathSeparator of course). Better not remove an existing check.

nicolas-grekas · 2017-07-12T07:02:42Z

src/Symfony/Component/Config/Definition/Builder/TreeBuilder.php

+    /**
+     * @throws \RuntimeException if root node is not defined.
+     */
+    private function assertTreeHasRootNode()


I think doing removing this an doing the check inline would be fine

It is currently called twice. It is done this way to keep code DRY.

nicolas-grekas · 2017-10-09T08:12:08Z

Rebase needed (we don't merge PRs when they contain merge commit)

bburnichon · 2017-10-09T08:30:34Z

Tests are failing on Form Component which I did not change. Is it a known issue?

nicolas-grekas

(tests back to green)

xabbuh · 2017-10-09T12:03:32Z

src/Symfony/Component/Config/Definition/BaseNode.php

    /**
-     * @param string        $name   The name of the node
-     * @param NodeInterface $parent The parent of this node
+     * Constructor.


Didn't we recently remove all comments like this?

Maybe it was reintroduced by my rebase. I will remove it.

xabbuh · 2017-10-09T12:05:23Z

src/Symfony/Component/Config/Definition/Builder/ChildrenAwareNodeDefinitionInterface.php

+    /**
+     * @return NodeDefinition[]
+     */
+    public function getChildrenNodeDefinitions();


This reads weird to me, what about getChildNodeDefinitions() or getChildNodesDefinitions()?

I wonder if we really need this interface or if we shouldn't rather check for the method to exist. We could then add this method to the ParentNodeDefinitionInterface in 4.0.

I don't have strong opinion about how to name this method. Actually, I already had a hard time finding this one. The same is true for the whole interface.
In case checking for the method to exist, how would you mark deprecation notice though?

nicolas-grekas · 2017-10-09T12:46:07Z

src/Symfony/Component/Config/Definition/Builder/NodeDefinition.php

+     */
+    public function setPathSeparator($separator)
+    {
+        if ($this instanceof ChildrenAwareNodeDefinitionInterface) {


if ($this instanceof ArrayNodeDefinition) { would be enough for the purpose, isn't it?
about the method, my preference is getChildNodeDefinitions

xabbuh · 2017-10-09T13:06:40Z

We will also need to update the UPGRADE-3.4.md (explain that implementing the interface without the added method is deprecated) and UPGRADE-4.0.md (mention the added method) files.

xabbuh · 2017-10-10T14:13:05Z

UPGRADE-4.0.md

+Config
+------
+
+ * Implementing `ParentNodeDefinitionInterface` without the `getChildNodeDefinitions()` is now forbidden.


I would rewrite this to be like this:

Added the getChildNodeDefinitions() method to ParentNodeDefinitionInterface.

bburnichon · 2017-10-10T16:29:29Z

Twig and VarDumper failure don't seem to be related to my PR. Are failures expected?

xabbuh · 2017-10-10T16:37:27Z

The Twig failure should be fixable by rebasing on the latest 3.4 branch and the VarDumper tests are currently failing on the 3.4 branch too.

nicolas-grekas · 2017-10-24T12:10:15Z

Moving to 4.1 as 3.4 is now in beta, thus closed for new feats.

bburnichon · 2017-10-25T08:31:52Z

Failures do not seem linked to my changes.

bburnichon · 2017-10-30T09:11:49Z

Rebased after merge of deprecation and removal of TreeBuilder::$builder

nicolas-grekas · 2018-01-08T15:02:13Z

@bburnichon please rebase: we don't merge PR with merge commits.

bburnichon · 2018-01-08T15:07:59Z

Sorry I did update via github interface.

javiereguiluz · 2018-01-11T09:50:44Z

I like this feature, but I wonder if "path separator" is the best name for this option. Path is strongly related to "file paths". Maybe "name separator" or "key separator" or "children separator" etc.

nicolas-grekas · 2018-01-11T09:53:23Z

@javiereguiluz "path" is the correct term, already used a lot in the component:

$ grep path src/Symfony/Component/Config/ -ri | wc -l
219

nicolas-grekas · 2018-01-21T15:18:07Z

Thank you @bburnichon.

This PR was merged into the 4.1-dev branch. Discussion ---------- [Config] allow changing the path separator | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #22268 | License | MIT | Doc PR | In bundles configuration, no dots are allowed in key names, but as a standalone config, there is no such limitation that should be enforced. By using current `NodeBuilder` it should be possible to change path separator used (for example: `/`) Commits ------- 15e05e1 Add feature allowing change of Path Separator

carsonbot added the Status: Needs Review label Apr 3, 2017

bburnichon changed the title ~~Config allow dots in node names~~ [Config] allow dots in node names Apr 4, 2017

bburnichon force-pushed the config-allow-dots branch from d5798f5 to bef2bb0 Compare April 4, 2017 14:59

bburnichon changed the base branch from 2.7 to master April 4, 2017 15:00

bburnichon mentioned this pull request Apr 4, 2017

[Config] Support dots in node names #22268

Closed

bburnichon force-pushed the config-allow-dots branch 2 times, most recently from 9f680c6 to bcf4039 Compare April 5, 2017 09:50

nicolas-grekas modified the milestone: 3.4 Apr 10, 2017

nicolas-grekas reviewed Jul 12, 2017

View reviewed changes

nicolas-grekas changed the title ~~[Config] allow dots in node names~~ [Config] allow changing the path separator Jul 12, 2017

bburnichon force-pushed the config-allow-dots branch from bcf4039 to 66545c5 Compare July 12, 2017 15:42

bburnichon changed the base branch from master to 3.4 July 12, 2017 15:43

bburnichon force-pushed the config-allow-dots branch 3 times, most recently from 69db47b to 669122c Compare July 13, 2017 09:15

ogizanagi self-requested a review September 25, 2017 12:08

bburnichon force-pushed the config-allow-dots branch from 10a8911 to 7e38a5c Compare October 9, 2017 08:19

nicolas-grekas approved these changes Oct 9, 2017

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels Oct 9, 2017

xabbuh reviewed Oct 9, 2017

View reviewed changes

nicolas-grekas reviewed Oct 9, 2017

View reviewed changes

xabbuh reviewed Oct 10, 2017

View reviewed changes

xabbuh approved these changes Oct 10, 2017

View reviewed changes

bburnichon force-pushed the config-allow-dots branch from 6b99f9b to 5f39fba Compare October 12, 2017 12:05

nicolas-grekas added the Ready label Oct 12, 2017

nicolas-grekas modified the milestones: 3.4, 4.1 Oct 24, 2017

bburnichon force-pushed the config-allow-dots branch from 5f39fba to b05c98f Compare October 25, 2017 08:04

bburnichon changed the base branch from 3.4 to master October 25, 2017 08:04

bburnichon force-pushed the config-allow-dots branch 2 times, most recently from 2e54486 to 5f29f79 Compare October 30, 2017 09:10

bburnichon force-pushed the config-allow-dots branch from 5f29f79 to 0652c7f Compare November 13, 2017 08:50

bburnichon force-pushed the config-allow-dots branch 2 times, most recently from 18664f4 to 14d6f78 Compare November 21, 2017 14:07

bburnichon force-pushed the config-allow-dots branch from 9a1e4fe to e5e70ec Compare January 8, 2018 15:12

javiereguiluz approved these changes Jan 11, 2018

View reviewed changes

bburnichon force-pushed the config-allow-dots branch from e5e70ec to 03f8804 Compare January 15, 2018 14:15

Add feature allowing change of Path Separator

15e05e1

nicolas-grekas force-pushed the config-allow-dots branch from 03f8804 to 15e05e1 Compare January 21, 2018 15:12

nicolas-grekas merged commit 15e05e1 into symfony:master Jan 21, 2018

javiereguiluz mentioned this pull request Jan 21, 2018

[Config] allow changing the path separator symfony/symfony-docs#9090

Closed

bburnichon deleted the config-allow-dots branch January 24, 2018 15:49

fabpot mentioned this pull request May 7, 2018

Release v4.1.0-BETA1 #27181

Merged

Uh oh!

[Config] allow changing the path separator #22253

[Config] allow changing the path separator #22253

Uh oh!

Conversation

bburnichon commented Apr 3, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nicolas-grekas left a comment

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bburnichon Jul 12, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

nicolas-grekas commented Oct 9, 2017

Uh oh!

bburnichon commented Oct 9, 2017

Uh oh!

nicolas-grekas left a comment

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nicolas-grekas Oct 9, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

xabbuh commented Oct 9, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bburnichon commented Oct 10, 2017

Uh oh!

xabbuh commented Oct 10, 2017

Uh oh!

nicolas-grekas commented Oct 24, 2017

Uh oh!

bburnichon commented Oct 25, 2017

Uh oh!

bburnichon commented Oct 30, 2017

Uh oh!

nicolas-grekas commented Jan 8, 2018

Uh oh!

bburnichon commented Jan 8, 2018

Uh oh!

javiereguiluz commented Jan 11, 2018

Uh oh!

nicolas-grekas commented Jan 11, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nicolas-grekas commented Jan 21, 2018

Uh oh!

Reviewers

Assignees

Labels

bburnichon commented Apr 3, 2017 •

edited

Loading

bburnichon Jul 12, 2017 •

edited

Loading

nicolas-grekas Oct 9, 2017 •

edited

Loading

nicolas-grekas commented Jan 11, 2018 •

edited

Loading