!!![TASK] Rename the AnchorReducer into AnchorNormalizer

linawolf · jaapio · commit 655b960ca146 · 2024-01-14T16:48:07.000+01:00
This should make the usage more clear
diff --git a/packages/guides-restructured-text/src/RestructuredText/Directives/ConfvalDirective.php b/packages/guides-restructured-text/src/RestructuredText/Directives/ConfvalDirective.php
@@ -6,7 +6,7 @@
 
 use phpDocumentor\Guides\Nodes\CollectionNode;
 use phpDocumentor\Guides\Nodes\Node;
-use phpDocumentor\Guides\ReferenceResolvers\AnchorReducer;
+use phpDocumentor\Guides\ReferenceResolvers\AnchorNormalizer;
 use phpDocumentor\Guides\RestructuredText\Nodes\ConfvalNode;
 use phpDocumentor\Guides\RestructuredText\Parser\BlockContext;
 use phpDocumentor\Guides\RestructuredText\Parser\Directive;
@@ -30,7 +30,7 @@ final class ConfvalDirective extends SubDirective
     public function __construct(
         protected Rule $startingRule,
         GenericLinkProvider $genericLinkProvider,
-        private readonly AnchorReducer $anchorReducer,
+        private readonly AnchorNormalizer $anchorReducer,
         private readonly InlineParser $inlineParser,
     ) {
         parent::__construct($startingRule);
diff --git a/packages/guides-restructured-text/src/RestructuredText/Directives/OptionDirective.php b/packages/guides-restructured-text/src/RestructuredText/Directives/OptionDirective.php
@@ -6,7 +6,7 @@
 
 use phpDocumentor\Guides\Nodes\CollectionNode;
 use phpDocumentor\Guides\Nodes\Node;
-use phpDocumentor\Guides\ReferenceResolvers\AnchorReducer;
+use phpDocumentor\Guides\ReferenceResolvers\AnchorNormalizer;
 use phpDocumentor\Guides\RestructuredText\Nodes\OptionNode;
 use phpDocumentor\Guides\RestructuredText\Parser\BlockContext;
 use phpDocumentor\Guides\RestructuredText\Parser\Directive;
@@ -31,7 +31,7 @@ final class OptionDirective extends SubDirective
     public function __construct(
         protected Rule $startingRule,
         GenericLinkProvider $genericLinkProvider,
-        private readonly AnchorReducer $anchorReducer,
+        private readonly AnchorNormalizer $anchorReducer,
     ) {
         parent::__construct($startingRule);
 
diff --git a/packages/guides-restructured-text/src/RestructuredText/TextRoles/GenericReferenceTextRole.php b/packages/guides-restructured-text/src/RestructuredText/TextRoles/GenericReferenceTextRole.php
@@ -6,7 +6,7 @@
 
 use phpDocumentor\Guides\Nodes\Inline\AbstractLinkInlineNode;
 use phpDocumentor\Guides\Nodes\Inline\ReferenceNode;
-use phpDocumentor\Guides\ReferenceResolvers\AnchorReducer;
+use phpDocumentor\Guides\ReferenceResolvers\AnchorNormalizer;
 use phpDocumentor\Guides\RestructuredText\Parser\Interlink\InterlinkParser;
 
 use function array_keys;
@@ -15,7 +15,7 @@ class GenericReferenceTextRole extends AbstractReferenceTextRole
 {
     public function __construct(
         private readonly GenericLinkProvider $genericLinkProvider,
-        private readonly AnchorReducer $anchorReducer,
+        private readonly AnchorNormalizer $anchorReducer,
         private readonly InterlinkParser $interlinkParser,
     ) {
     }
diff --git a/packages/guides-theme-bootstrap/src/Bootstrap/Directives/TabsDirective.php b/packages/guides-theme-bootstrap/src/Bootstrap/Directives/TabsDirective.php
@@ -18,7 +18,7 @@
 use phpDocumentor\Guides\Nodes\CollectionNode;
 use phpDocumentor\Guides\Nodes\InlineCompoundNode;
 use phpDocumentor\Guides\Nodes\Node;
-use phpDocumentor\Guides\ReferenceResolvers\AnchorReducer;
+use phpDocumentor\Guides\ReferenceResolvers\AnchorNormalizer;
 use phpDocumentor\Guides\RestructuredText\Directives\SubDirective;
 use phpDocumentor\Guides\RestructuredText\Parser\BlockContext;
 use phpDocumentor\Guides\RestructuredText\Parser\Directive;
@@ -35,7 +35,7 @@ class TabsDirective extends SubDirective
     public function __construct(
         protected Rule $startingRule,
         private readonly LoggerInterface $logger,
-        private readonly AnchorReducer $anchorReducer,
+        private readonly AnchorNormalizer $anchorReducer,
     ) {
         parent::__construct($startingRule);
     }
diff --git a/packages/guides/resources/config/guides.php b/packages/guides/resources/config/guides.php
@@ -23,7 +23,7 @@
 use phpDocumentor\Guides\NodeRenderers\OutputAwareDelegatingNodeRenderer;
 use phpDocumentor\Guides\Parser;
 use phpDocumentor\Guides\ReferenceResolvers\AnchorHyperlinkResolver;
-use phpDocumentor\Guides\ReferenceResolvers\AnchorReducer;
+use phpDocumentor\Guides\ReferenceResolvers\AnchorNormalizer;
 use phpDocumentor\Guides\ReferenceResolvers\AnchorReferenceResolver;
 use phpDocumentor\Guides\ReferenceResolvers\DelegatingReferenceResolver;
 use phpDocumentor\Guides\ReferenceResolvers\DocReferenceResolver;
@@ -36,7 +36,7 @@
 use phpDocumentor\Guides\ReferenceResolvers\PageHyperlinkResolver;
 use phpDocumentor\Guides\ReferenceResolvers\ReferenceResolver;
 use phpDocumentor\Guides\ReferenceResolvers\ReferenceResolverPreRender;
-use phpDocumentor\Guides\ReferenceResolvers\SluggerAnchorReducer;
+use phpDocumentor\Guides\ReferenceResolvers\SluggerAnchorNormalizer;
 use phpDocumentor\Guides\Renderer\HtmlRenderer;
 use phpDocumentor\Guides\Renderer\InMemoryRendererFactory;
 use phpDocumentor\Guides\Renderer\InterlinkObjectsRenderer;
@@ -193,8 +193,8 @@
         ->arg('$renderSets', tagged_iterator('phpdoc.renderer.typerenderer', 'format'))
         ->alias(TypeRendererFactory::class, InMemoryRendererFactory::class)
 
-        ->set(SluggerAnchorReducer::class)
-        ->alias(AnchorReducer::class, SluggerAnchorReducer::class)
+        ->set(SluggerAnchorNormalizer::class)
+        ->alias(AnchorNormalizer::class, SluggerAnchorNormalizer::class)
 
         ->set('phpdoc.guides.output_node_renderer', OutputAwareDelegatingNodeRenderer::class)
         ->arg('$nodeRenderers', tagged_iterator('phpdoc.guides.output_node_renderer', 'format'))
diff --git a/packages/guides/src/Compiler/NodeTransformers/CollectLinkTargetsTransformer.php b/packages/guides/src/Compiler/NodeTransformers/CollectLinkTargetsTransformer.php
@@ -13,7 +13,7 @@
 use phpDocumentor\Guides\Nodes\MultipleLinkTargetsNode;
 use phpDocumentor\Guides\Nodes\Node;
 use phpDocumentor\Guides\Nodes\SectionNode;
-use phpDocumentor\Guides\ReferenceResolvers\AnchorReducer;
+use phpDocumentor\Guides\ReferenceResolvers\AnchorNormalizer;
 use SplStack;
 use Webmozart\Assert\Assert;
 
@@ -24,7 +24,7 @@ final class CollectLinkTargetsTransformer implements NodeTransformer
     private readonly SplStack $documentStack;
 
     public function __construct(
-        private readonly AnchorReducer $anchorReducer,
+        private readonly AnchorNormalizer $anchorReducer,
     ) {
         /*
          * TODO: remove stack here, as we should not have sub documents in this way, sub documents are
diff --git a/packages/guides/src/Interlink/DefaultInventoryLoader.php b/packages/guides/src/Interlink/DefaultInventoryLoader.php
@@ -4,8 +4,8 @@
 
 namespace phpDocumentor\Guides\Interlink;
 
-use phpDocumentor\Guides\ReferenceResolvers\AnchorReducer;
-use phpDocumentor\Guides\ReferenceResolvers\NullAnchorReducer;
+use phpDocumentor\Guides\ReferenceResolvers\AnchorNormalizer;
+use phpDocumentor\Guides\ReferenceResolvers\NullAnchorNormalizer;
 use Psr\Log\LoggerInterface;
 use Symfony\Component\HttpClient\Exception\ClientException;
 
@@ -18,7 +18,7 @@ final class DefaultInventoryLoader implements InventoryLoader
     public function __construct(
         private readonly LoggerInterface $logger,
         private readonly JsonLoader $jsonLoader,
-        private readonly AnchorReducer $anchorReducer,
+        private readonly AnchorNormalizer $anchorReducer,
         private readonly string $pathToJson = 'objects.inv.json',
     ) {
     }
@@ -27,20 +27,20 @@ public function __construct(
     public function loadInventoryFromJson(Inventory $inventory, array $json): void
     {
         foreach ($json as $groupKey => $groupArray) {
-            $groupAnchorReducer = $this->anchorReducer;
+            $groupAnchorNormalizer = $this->anchorReducer;
             if ($groupKey === 'std:doc') {
                 // Do not reduce Document names
-                $groupAnchorReducer = new NullAnchorReducer();
+                $groupAnchorNormalizer = new NullAnchorNormalizer();
             }
 
-            $group = new InventoryGroup($groupAnchorReducer);
+            $group = new InventoryGroup($groupAnchorNormalizer);
             if (is_array($groupArray)) {
                 foreach ($groupArray as $linkKey => $linkArray) {
                     if (!is_array($linkArray) || count($linkArray) < 4) {
                         continue;
                     }
 
-                    $reducedLinkKey = $groupAnchorReducer->reduceAnchor(strval($linkKey));
+                    $reducedLinkKey = $groupAnchorNormalizer->reduceAnchor(strval($linkKey));
                     $link = new InventoryLink($linkArray[0], $linkArray[1], $linkArray[2], $linkArray[3]);
                     $group->addLink($reducedLinkKey, $link);
                 }
diff --git a/packages/guides/src/Interlink/DefaultInventoryRepository.php b/packages/guides/src/Interlink/DefaultInventoryRepository.php
@@ -6,7 +6,7 @@
 
 use phpDocumentor\Guides\Interlink\Exception\InterlinkInventoryNotFound;
 use phpDocumentor\Guides\Interlink\Exception\InterlinkNotFound;
-use phpDocumentor\Guides\ReferenceResolvers\AnchorReducer;
+use phpDocumentor\Guides\ReferenceResolvers\AnchorNormalizer;
 
 use function array_key_exists;
 
@@ -17,12 +17,12 @@ final class DefaultInventoryRepository implements InventoryRepository
 
     /** @param array<int, array<string, string>> $inventoryConfigs */
     public function __construct(
-        private readonly AnchorReducer $anchorReducer,
+        private readonly AnchorNormalizer $anchorNormalizer,
         private readonly InventoryLoader $inventoryLoader,
         array $inventoryConfigs,
     ) {
         foreach ($inventoryConfigs as $inventory) {
-            $this->inventories[$this->anchorReducer->reduceAnchor($inventory['id'])] = new Inventory($inventory['url'], $anchorReducer);
+            $this->inventories[$this->anchorNormalizer->reduceAnchor($inventory['id'])] = new Inventory($inventory['url'], $anchorNormalizer);
         }
     }
 
@@ -37,15 +37,15 @@ public function getLink(string $inventoryKey, string $groupKey, string $linkKey)
 
     public function hasInventory(string $key): bool
     {
-        $reducedKey = $this->anchorReducer->reduceAnchor($key);
+        $reducedKey = $this->anchorNormalizer->reduceAnchor($key);
 
         return array_key_exists($reducedKey, $this->inventories);
     }
 
     /** @throws InterlinkInventoryNotFound */
     public function getInventory(string $key): Inventory
     {
-        $reducedKey = $this->anchorReducer->reduceAnchor($key);
+        $reducedKey = $this->anchorNormalizer->reduceAnchor($key);
         if (!$this->hasInventory($reducedKey)) {
             throw new InterlinkInventoryNotFound('Inventory with key ' . $reducedKey . ' not found. ', 1_671_398_986);
         }
@@ -57,7 +57,7 @@ public function getInventory(string $key): Inventory
 
     public function addInventory(string $key, Inventory $inventory): void
     {
-        $reducedKey = $this->anchorReducer->reduceAnchor($key);
+        $reducedKey = $this->anchorNormalizer->reduceAnchor($key);
         $this->inventories[$reducedKey] = $inventory;
     }
 }
diff --git a/packages/guides/src/Interlink/Inventory.php b/packages/guides/src/Interlink/Inventory.php
@@ -6,7 +6,7 @@
 
 use phpDocumentor\Guides\Interlink\Exception\InterlinkGroupNotFound;
 use phpDocumentor\Guides\Interlink\Exception\InterlinkNotFound;
-use phpDocumentor\Guides\ReferenceResolvers\AnchorReducer;
+use phpDocumentor\Guides\ReferenceResolvers\AnchorNormalizer;
 
 use function array_key_exists;
 use function sprintf;
@@ -18,7 +18,7 @@ final class Inventory
 
     private bool $isLoaded = false;
 
-    public function __construct(private readonly string $baseUrl, private readonly AnchorReducer $anchorReducer)
+    public function __construct(private readonly string $baseUrl, private readonly AnchorNormalizer $anchorNormalizer)
     {
     }
 
@@ -29,7 +29,7 @@ public function getBaseUrl(): string
 
     public function addGroup(string $key, InventoryGroup $group): void
     {
-        $reducedKey = $this->anchorReducer->reduceAnchor($key);
+        $reducedKey = $this->anchorNormalizer->reduceAnchor($key);
         $this->groups[$reducedKey] = $group;
     }
 
@@ -42,7 +42,7 @@ public function getGroups(): array
     /** @throws InterlinkNotFound */
     public function getGroup(string $key): InventoryGroup
     {
-        $reducedKey = $this->anchorReducer->reduceAnchor($key);
+        $reducedKey = $this->anchorNormalizer->reduceAnchor($key);
         if (!$this->hasGroup($reducedKey)) {
             throw new InterlinkGroupNotFound(
                 sprintf('Inventory group with key "%s" (%s) not found. ', $key, $reducedKey),
@@ -60,7 +60,7 @@ public function getLink(string $groupKey, string $key): InventoryLink
 
     public function hasGroup(string $key): bool
     {
-        $reducedKey = $this->anchorReducer->reduceAnchor($key);
+        $reducedKey = $this->anchorNormalizer->reduceAnchor($key);
 
         return array_key_exists($reducedKey, $this->groups);
     }
diff --git a/packages/guides/src/Interlink/InventoryGroup.php b/packages/guides/src/Interlink/InventoryGroup.php
@@ -6,7 +6,7 @@
 
 use phpDocumentor\Guides\Interlink\Exception\InterlinkNotFound;
 use phpDocumentor\Guides\Interlink\Exception\InterlinkTargetNotFound;
-use phpDocumentor\Guides\ReferenceResolvers\AnchorReducer;
+use phpDocumentor\Guides\ReferenceResolvers\AnchorNormalizer;
 
 use function array_key_exists;
 use function sprintf;
@@ -16,27 +16,27 @@ final class InventoryGroup
     /** @var InventoryLink[]  */
     private array $links = [];
 
-    public function __construct(private readonly AnchorReducer $anchorReducer)
+    public function __construct(private readonly AnchorNormalizer $anchorNormalizer)
     {
     }
 
     public function addLink(string $key, InventoryLink $link): void
     {
-        $reducedKey = $this->anchorReducer->reduceAnchor($key);
+        $reducedKey = $this->anchorNormalizer->reduceAnchor($key);
         $this->links[$reducedKey] = $link;
     }
 
     public function hasLink(string $key): bool
     {
-        $reducedKey = $this->anchorReducer->reduceAnchor($key);
+        $reducedKey = $this->anchorNormalizer->reduceAnchor($key);
 
         return array_key_exists($reducedKey, $this->links);
     }
 
     /** @throws InterlinkNotFound */
     public function getLink(string $key): InventoryLink
     {
-        $reducedKey = $this->anchorReducer->reduceAnchor($key);
+        $reducedKey = $this->anchorNormalizer->reduceAnchor($key);
         if (!array_key_exists($reducedKey, $this->links)) {
             throw new InterlinkTargetNotFound(sprintf('Inventory link with key "%s" (%s) not found. ', $key, $reducedKey), 1_671_398_986);
         }
diff --git a/packages/guides/src/ReferenceResolvers/AnchorHyperlinkResolver.php b/packages/guides/src/ReferenceResolvers/AnchorHyperlinkResolver.php
@@ -19,7 +19,7 @@ class AnchorHyperlinkResolver implements ReferenceResolver
     public final const PRIORITY = -100;
 
     public function __construct(
-        private readonly AnchorReducer $anchorReducer,
+        private readonly AnchorNormalizer $anchorReducer,
         private readonly UrlGeneratorInterface $urlGenerator,
     ) {
     }
diff --git a/packages/guides/src/ReferenceResolvers/AnchorNormalizer.php b/packages/guides/src/ReferenceResolvers/AnchorNormalizer.php
@@ -5,11 +5,11 @@
 namespace phpDocumentor\Guides\ReferenceResolvers;
 
 /**
- * Reduces the complexity of raw data used to generate anchors.
+ * Normalizes raw data used to generate anchors.
  *
  * Can be used to ignore case and special signs.
  */
-interface AnchorReducer
+interface AnchorNormalizer
 {
     public function reduceAnchor(string $rawAnchor): string;
 }
diff --git a/packages/guides/src/ReferenceResolvers/AnchorReferenceResolver.php b/packages/guides/src/ReferenceResolvers/AnchorReferenceResolver.php
@@ -19,7 +19,7 @@ class AnchorReferenceResolver implements ReferenceResolver
     public final const PRIORITY = -100;
 
     public function __construct(
-        private readonly AnchorReducer $anchorReducer,
+        private readonly AnchorNormalizer $anchorReducer,
         private readonly UrlGeneratorInterface $urlGenerator,
     ) {
     }
diff --git a/packages/guides/src/ReferenceResolvers/NullAnchorNormalizer.php b/packages/guides/src/ReferenceResolvers/NullAnchorNormalizer.php
@@ -4,7 +4,7 @@
 
 namespace phpDocumentor\Guides\ReferenceResolvers;
 
-class NullAnchorReducer implements AnchorReducer
+class NullAnchorNormalizer implements AnchorNormalizer
 {
     public function reduceAnchor(string $rawAnchor): string
     {
diff --git a/packages/guides/src/ReferenceResolvers/SluggerAnchorNormalizer.php b/packages/guides/src/ReferenceResolvers/SluggerAnchorNormalizer.php
@@ -8,7 +8,7 @@
 
 use function strtolower;
 
-class SluggerAnchorReducer implements AnchorReducer
+class SluggerAnchorNormalizer implements AnchorNormalizer
 {
     public function reduceAnchor(string $rawAnchor): string
     {
diff --git a/packages/guides/tests/unit/Compiler/NodeTransformers/CollectLinkTargetsTransformerTest.php b/packages/guides/tests/unit/Compiler/NodeTransformers/CollectLinkTargetsTransformerTest.php
@@ -10,21 +10,21 @@
 use phpDocumentor\Guides\Nodes\DocumentTree\DocumentEntryNode;
 use phpDocumentor\Guides\Nodes\ProjectNode;
 use phpDocumentor\Guides\Nodes\TitleNode;
-use phpDocumentor\Guides\ReferenceResolvers\AnchorReducer;
+use phpDocumentor\Guides\ReferenceResolvers\AnchorNormalizer;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 
 class CollectLinkTargetsTransformerTest extends TestCase
 {
-    private AnchorReducer&MockObject $anchorReducer;
+    private AnchorNormalizer&MockObject $anchorReducer;
     private CompilerContext $context;
     private ProjectNode&MockObject $projectNode;
 
     protected function setUp(): void
     {
         $this->projectNode = $this->createMock(ProjectNode::class);
         $this->context = $this->getCompilerContext('some-path');
-        $this->anchorReducer = $this->createMock(AnchorReducer::class);
+        $this->anchorReducer = $this->createMock(AnchorNormalizer::class);
     }
 
     private function getCompilerContext(string $path): CompilerContext
diff --git a/packages/guides/tests/unit/Interlink/InventoryLoaderTest.php b/packages/guides/tests/unit/Interlink/InventoryLoaderTest.php
diff --git a/packages/guides/tests/unit/ReferenceResolvers/AnchorReferenceResolverTest.php b/packages/guides/tests/unit/ReferenceResolvers/AnchorReferenceResolverTest.php
diff --git a/packages/guides/tests/unit/ReferenceResolvers/SluggerAnchorReducerTest.php b/packages/guides/tests/unit/ReferenceResolvers/SluggerAnchorReducerTest.php

Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`
`7`	`7`	`use phpDocumentor\Guides\Interlink\Exception\InterlinkInventoryNotFound;`
`8`	`8`	`use phpDocumentor\Guides\Interlink\Exception\InterlinkNotFound;`
`9`		`-use phpDocumentor\Guides\ReferenceResolvers\AnchorReducer;`
	`9`	`+use phpDocumentor\Guides\ReferenceResolvers\AnchorNormalizer;`
`10`	`10`
`11`	`11`	`use function array_key_exists;`
`12`	`12`
`@@ -17,12 +17,12 @@ final class DefaultInventoryRepository implements InventoryRepository`
`17`	`17`
`18`	`18`	`/** @param array<int, array<string, string>> $inventoryConfigs */`
`19`	`19`	`public function __construct(`
`20`		`- private readonly AnchorReducer $anchorReducer,`
	`20`	`+ private readonly AnchorNormalizer $anchorNormalizer,`
`21`	`21`	`private readonly InventoryLoader $inventoryLoader,`
`22`	`22`	`array $inventoryConfigs,`
`23`	`23`	`) {`
`24`	`24`	`foreach ($inventoryConfigs as $inventory) {`
`25`		`- $this->inventories[$this->anchorReducer->reduceAnchor($inventory['id'])] = new Inventory($inventory['url'], $anchorReducer);`
	`25`	`+ $this->inventories[$this->anchorNormalizer->reduceAnchor($inventory['id'])] = new Inventory($inventory['url'], $anchorNormalizer);`
`26`	`26`	`}`
`27`	`27`	`}`
`28`	`28`
`@@ -37,15 +37,15 @@ public function getLink(string $inventoryKey, string $groupKey, string $linkKey)`
`37`	`37`
`38`	`38`	`public function hasInventory(string $key): bool`
`39`	`39`	`{`
`40`		`- $reducedKey = $this->anchorReducer->reduceAnchor($key);`
	`40`	`+ $reducedKey = $this->anchorNormalizer->reduceAnchor($key);`
`41`	`41`
`42`	`42`	`return array_key_exists($reducedKey, $this->inventories);`
`43`	`43`	`}`
`44`	`44`
`45`	`45`	`/** @throws InterlinkInventoryNotFound */`
`46`	`46`	`public function getInventory(string $key): Inventory`
`47`	`47`	`{`
`48`		`- $reducedKey = $this->anchorReducer->reduceAnchor($key);`
	`48`	`+ $reducedKey = $this->anchorNormalizer->reduceAnchor($key);`
`49`	`49`	`if (!$this->hasInventory($reducedKey)) {`
`50`	`50`	`throw new InterlinkInventoryNotFound('Inventory with key ' . $reducedKey . ' not found. ', 1_671_398_986);`
`51`	`51`	`}`
`@@ -57,7 +57,7 @@ public function getInventory(string $key): Inventory`
`57`	`57`
`58`	`58`	`public function addInventory(string $key, Inventory $inventory): void`
`59`	`59`	`{`
`60`		`- $reducedKey = $this->anchorReducer->reduceAnchor($key);`
	`60`	`+ $reducedKey = $this->anchorNormalizer->reduceAnchor($key);`
`61`	`61`	`$this->inventories[$reducedKey] = $inventory;`
`62`	`62`	`}`
`63`	`63`	`}`