Merge pull request #42 from gsteel/deprecations

Deprecate `addPaths` and `getPaths`

Author: gsteel

psalm-baseline.xml

@@ -1,11 +1,32 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<files psalm-version="5.9.0@8b9ad1eb9e8b7d3101f949291da2b9f7767cd163">
+<files psalm-version="6.13.1@1e3b7f0a8ab32b23197b91107adc0a7ed8a05b51">
   <file src="src/TemplateRendererInterface.php">
+    <DeprecatedClass>
+      <code><![CDATA[TemplatePath[]]]></code>
+    </DeprecatedClass>
     <PossiblyUnusedMethod>
-      <code>addDefaultParam</code>
-      <code>addPath</code>
-      <code>getPaths</code>
-      <code>render</code>
+      <code><![CDATA[addDefaultParam]]></code>
+      <code><![CDATA[addPath]]></code>
+      <code><![CDATA[getPaths]]></code>
+      <code><![CDATA[render]]></code>
     </PossiblyUnusedMethod>
   </file>
+  <file src="test/TemplatePathAssertionsTrait.php">
+    <DeprecatedClass>
+      <code><![CDATA[TemplatePath]]></code>
+      <code><![CDATA[TemplatePath]]></code>
+      <code><![CDATA[TemplatePath]]></code>
+      <code><![CDATA[TemplatePath]]></code>
+      <code><![CDATA[TemplatePath]]></code>
+      <code><![CDATA[TemplatePath]]></code>
+    </DeprecatedClass>
+  </file>
+  <file src="test/TemplatePathTest.php">
+    <DeprecatedClass>
+      <code><![CDATA[new TemplatePath('/tmp')]]></code>
+      <code><![CDATA[new TemplatePath('/tmp')]]></code>
+      <code><![CDATA[new TemplatePath('/tmp', 'test')]]></code>
+      <code><![CDATA[new TemplatePath('/tmp', 'test')]]></code>
+    </DeprecatedClass>
+  </file>
 </files>

src/TemplatePath.php

@@ -6,7 +6,12 @@
 
 use Stringable;
 
-/** @final */
+/**
+ * @deprecated Since 2.12.0. This class will be removed in 3.0.0 when the relevant methods in TemplateRendererInterface
+ *             are removed.
+ *
+ * @final
+ */
 class TemplatePath implements Stringable
 {
     public function __construct(protected string $path, protected ?string $namespace = null)

src/TemplateRendererInterface.php

@@ -29,12 +29,18 @@ public function render(string $name, $params = []): string;
      *
      * Adds a template path, with optional namespace the templates in that path
      * provide.
+     *
+     * @deprecated Since 2.12.0. Template file paths are not the concern of a template renderer in this context. The
+     *             method will be removed in 3.0.0
      */
     public function addPath(string $path, ?string $namespace = null): void;
 
     /**
      * Retrieve configured paths from the engine.
      *
+     * @deprecated  Since 2.12.0. Template file paths are not the concern of a template renderer in this context. The
+     *              method will be removed in 3.0.0
+     *
      * @return TemplatePath[]
      */
     public function getPaths(): array;