Make ancestorClass option consistency to underscore

.github/workflows/build.yaml

@@ -62,7 +62,7 @@ jobs:
  with:
  php-version: ${{ matrix.php }}
  - run: |
- sed -ri 's/"symfony\/(.+)": "(.+)"/"symfony\/\1": "'${{ matrix.symfony }}'"/' composer.json;
+ sed -ri '/symfony\/deprecation-contracts/!s/"symfony\/(.+)\symfony\/deprecation-contracts/;": "(.+)"/"symfony\/\1": "'${{ matrix.symfony }}'"/' composer.json;
  if: matrix.symfony
  - run: composer config minimum-stability dev && composer config prefer-stable true
  if: matrix.dev

composer.json

@@ -20,7 +20,8 @@
  }
  ],
  "require": {
- "php": "^7.3 || ^8.0"
+ "php": "^7.3 || ^8.0",
+ "symfony/deprecation-contracts": "^2.4"
  },
  "conflict": {
  "twig/twig": "<1.40 || >=2,<2.9"

doc/01-Basic-Menus.md

@@ -238,7 +238,7 @@ the second argument to the `render()` method:
  is an ancestor of the current item.
 * `currentAsLink` (default: `true`): Whether to render the "current" menu item as link or as span.
 * `currentClass` (default: `current`)
-* `ancestorClass` (default: `current_ancestor`)
+* `ancestor_class` (default: `current_ancestor`) (alias: ancestorClass, currently deprecated)
 * `firstClass` (default: `first`)
 * `lastClass` (default: `last`)
 * `compressed` (default: `false`)

doc/examples/01_apply_active_class_to_whole_tree.md

@@ -7,12 +7,12 @@ render method of your used renderer:
 
 ```php
 <?php
-$renderer->render($item, ['currentClass' => 'active', 'ancestorClass' => 'active']);
+$renderer->render($item, ['currentClass' => 'active', 'ancestor_class' => 'active']);
 ```
 
 or pass it as argument to the constructor of the used renderer:
 
 ```php
 <?php
-$renderer = new Renderer($matcher, ['currentClass' => 'active', 'ancestorClass' => 'active']);
+$renderer = new Renderer($matcher, ['currentClass' => 'active', 'ancestor_class' => 'active']);
 ```

src/Knp/Menu/Renderer/ListRenderer.php

@@ -31,7 +31,7 @@ public function __construct(MatcherInterface $matcher, array $defaultOptions = [
  'matchingDepth' => null,
  'currentAsLink' => true,
  'currentClass' => 'current',
- 'ancestorClass' => 'current_ancestor',
+ 'ancestor_class' => 'current_ancestor',
  'firstClass' => 'first',
  'lastClass' => 'last',
  'compressed' => false,
@@ -48,6 +48,13 @@ public function render(ItemInterface $item, array $options = []): string
  {
  $options = \array_merge($this->defaultOptions, $options);
 
+ // Avoid duplication of current_ancestor class. Overwrite value in old config to new one
+ if (isset($options['ancestorClass'])) {
+ $options['ancestor_class'] = $options['ancestorClass']; 
+ unset($options['ancestorClass']);
+ trigger_deprecation('knplabs/knp-menu', '3.3', 'Using "%s" option is deprecated, use "%s" instead.', 'ancestorClass', 'ancestor_class');
+ }
+
  $html = $this->renderList($item, $item->getChildrenAttributes(), $options);
 
  if ($options['clear_matcher']) {
@@ -130,7 +137,11 @@ protected function renderItem(ItemInterface $item, array $options): string
  if ($this->matcher->isCurrent($item)) {
  $class[] = $options['currentClass'];
  } elseif ($this->matcher->isAncestor($item, $options['matchingDepth'])) {
- $class[] = $options['ancestorClass'];
+ if (isset($options['ancestorClass'])) { // Deprecated: it will be removed in future (@see: ancestor_class)
+ trigger_deprecation('knplabs/knp-menu', '3.3', 'Using "%s" option is deprecated, use "%s" instead.', 'ancestorClass', 'ancestor_class');
+ $options['ancestor_class'] = $options['ancestorClass'];
+ }
+ $class[] = $options['ancestor_class'];
  }
 
  if ($item->actsLikeFirst()) {

src/Knp/Menu/Renderer/RendererInterface.php

@@ -16,7 +16,7 @@ interface RendererInterface
  * 1: only direct children
  * - currentAsLink: whether the current item should be a link
  * - currentClass: class added to the current item
- * - ancestorClass: class added to the ancestors of the current item
+ * - ancestor_class: class added to the ancestors of the current item (alias: ancestorClass, deprecated in a future)
  * - firstClass: class added to the first child
  * - lastClass: class added to the last child
  *

src/Knp/Menu/Renderer/TwigRenderer.php

@@ -39,7 +39,7 @@ public function __construct(
  'matchingDepth' => null,
  'currentAsLink' => true,
  'currentClass' => 'current',
- 'ancestorClass' => 'current_ancestor',
+ 'ancestor_class' => 'current_ancestor',
  'firstClass' => 'first',
  'lastClass' => 'last',
  'template' => $template,
@@ -55,6 +55,13 @@ public function render(ItemInterface $item, array $options = []): string
  {
  $options = \array_merge($this->defaultOptions, $options);
 
+ // Avoid duplication of current_ancestor class. Overwrite value in old config to new one
+ if (isset($options['ancestorClass'])) {
+ $options['ancestor_class'] = $options['ancestorClass']; 
+ unset($options['ancestorClass']);
+ trigger_deprecation('knplabs/knp-menu', '3.3', 'Using "%s" option is deprecated, use "%s" instead.', 'ancestorClass', 'ancestor_class');
+ }
+
  $html = $this->environment->render($options['template'], ['item' => $item, 'options' => $options, 'matcher' => $this->matcher]);
 
  if ($options['clear_matcher']) {

src/Knp/Menu/Resources/views/knp_menu.html.twig

@@ -55,7 +55,11 @@
  {%- if matcher.isCurrent(item) %}
  {%- set classes = classes|merge([options.currentClass]) %}
  {%- elseif matcher.isAncestor(item, options.matchingDepth) %}
- {%- set classes = classes|merge([options.ancestorClass]) %}
+ {%- set classes = classes|merge([options.ancestor_class]) %}
+ {%- if options.ancestorClass is not empty %}
+ {% deprecated 'knplabs/knp-menu 3.3: Using "ancestorClass" option is deprecated, use "ancestor_class" instead.' %}
+ {%- set classes = classes|merge([options.ancestorClass]) %}
+ {%- endif %}
  {%- endif %}
  {%- if item.actsLikeFirst %}
  {%- set classes = classes|merge([options.firstClass]) %}

tests/Knp/Menu/Tests/Renderer/AbstractRendererTest.php

@@ -202,7 +202,7 @@ public function testRenderWithClassAndTitle(): void
  $this->assertEquals($rendered, $this->renderer->render($this->menu));
  }
 
- public function testRenderWithCurrentItem(): void
+ public function testLegacyRenderWithCurrentItem(): void
  {
  $this->ch2->setCurrent(true);
  $rendered = '<ul class="root"><li class="current_ancestor first"><span>Parent 1</span><ul class="menu_level_1"><li class="first"><span>Child 1</span></li><li class="current"><span>Child 2</span></li><li class="last"><span>Child 3</span></li></ul></li><li class="last"><span>Parent 2</span><ul class="menu_level_1"><li class="first last"><span>Child 4</span><ul class="menu_level_2"><li class="first last"><span>Grandchild 1</span></li></ul></li></ul></li></ul>';
@@ -326,7 +326,7 @@ public function testMatchingDepth1(): void
  $this->assertEquals($rendered, $this->renderer->render($this->menu, ['depth' => 1, 'matchingDepth' => 2]));
  }
 
- public function testMatchingDepth2(): void
+ public function testLegacyMatchingDepth2(): void
  {
  $this->menu['Parent 1']['Child 1']->setCurrent(true);
  $rendered = '<ul class="root"><li class="first"><span>Parent 1</span></li><li class="last"><span>Parent 2</span></li></ul>';