Refactoring + Stricter Type hinting + Updated tests

Author: Daniyal Hamid

composer.json

@@ -20,6 +20,7 @@
     },
     "scripts": {
         "style": "vendor/bin/phpcs --standard=PSR12 src",
+        "style-fix": "vendor/bin/phpcbf --standard=PSR12 src",
         "check": "vendor/bin/phpstan analyse src --level=5 -c phpstan.neon",
         "md": "vendor/bin/phpmd src text cleancode,unusedcode,codesize,design,naming",
         "test": "vendor/bin/phpunit --configuration phpunit.xml --testsuite bitframe_renderer"

src/Data.php

@@ -27,13 +27,7 @@ class Data
 
     protected array $templateSpecificVars = [];
 
-    /**
-     * @param  array $data
-     * @param  null|string|array $templates
-     *
-     * @return $this
-     */
-    public function add(array $data, $templates = null): self
+    public function add(array $data, null|string|array $templates = null): self
     {
         if (null === $templates) {
             $this->shareWithAll($data);

src/RenderContext.php

@@ -22,10 +22,6 @@ class RenderContext
     /** @var callable */
     private $fetchTpl;
 
-    private array $data;
-
-    private ?Sections $sections;
-
     public ?string $currSectionName = null;
 
     public string $newSectionMode = Sections::ADD;
@@ -34,18 +30,13 @@ class RenderContext
 
     private array $parentData = [];
 
-    private string $childContent;
-
     public function __construct(
         callable $fetchTpl,
-        array $data = [],
-        ?Sections $sections = null,
-        string $childContent = ''
+        private array $data = [],
+        private ?Sections $sections = null,
+        private string $childContent = '',
     ) {
         $this->fetchTpl = $fetchTpl;
-        $this->data = $data;
-        $this->sections = $sections;
-        $this->childContent = $childContent;
     }
 
     public function parent(string $name, array $data = []): void
@@ -126,7 +117,7 @@ public function fetch(string $name, array $data = []): string
      *
      * @return mixed
      */
-    public function apply($subject, string $functions)
+    public function apply(mixed $subject, string $functions): mixed
     {
         $functionsList = explode('|', $functions);
 

src/Renderer.php

@@ -25,15 +25,12 @@ class Renderer
 
     protected string $fileExt;
 
-    protected array $paths = [];
-
     protected Data $data;
 
     public function __construct(
-        array $paths,
-        string $fileExt = self::DEFAULT_FILE_EXT
+        protected array $paths = [],
+        string $fileExt = self::DEFAULT_FILE_EXT,
     ) {
-        $this->paths = $paths;
         $this->fileExt = $fileExt ?: self::DEFAULT_FILE_EXT;
         $this->data = new Data();
     }
@@ -43,13 +40,7 @@ public function createTemplate(string $name, ?Sections $sections = null): Templa
         return new Template($name, $this, $sections);
     }
 
-    /**
-     * @param  array $data
-     * @param  null|string|array $tplNames
-     *
-     * @return $this
-     */
-    public function withData(array $data, $tplNames = null): self
+    public function withData(array $data, null|string|array $tplNames = null): self
     {
         $this->data->add($data, $tplNames);
         return $this;

src/Sections.php

@@ -23,11 +23,8 @@ final class Sections
     /** @var string */
     public const PREPEND = 'prepend';
 
-    private array $sections;
-
-    public function __construct(array $sections = [])
+    public function __construct(private array $sections = [])
     {
-        $this->sections = $sections;
     }
 
     public function add(string $name, string $content): void

src/Template.php

@@ -38,8 +38,6 @@ class Template
     /** @var string */
     private const NAME_SEPARATOR = '::';
 
-    protected Renderer $engine;
-
     protected string $filePath;
 
     protected array $data = [];
@@ -50,10 +48,9 @@ class Template
 
     public function __construct(
         string $name,
-        Renderer $engine,
-        ?Sections $sections = null
+        protected Renderer $engine,
+        ?Sections $sections = null,
     ) {
-        $this->engine = $engine;
         $this->setFilePathFromName($name)->withData($this->engine->getData($name));
         $this->sections = $sections ?? new Sections();
     }
@@ -133,7 +130,7 @@ public function getPath(): string
      *
      * @return mixed
      */
-    public function getVar(string $name, $default = null)
+    public function getVar(string $name, mixed $default = null): mixed
     {
         return $this->getData()[$name] ?? $default;
     }
@@ -180,7 +177,7 @@ private function setFilePathFromName(string $name): self
      *
      * @throws Throwable
      */
-    private function buffer(callable $wrap)
+    private function buffer(callable $wrap): false|string
     {
         $level = ob_get_level();
 

test/DataTest.php

@@ -15,7 +15,7 @@
 use stdClass;
 use PHPUnit\Framework\TestCase;
 use BitFrame\Renderer\Data;
-use InvalidArgumentException;
+use TypeError;
 
 use function array_merge;
 
@@ -87,7 +87,7 @@ public function dataProvider(): array
     public function testAddAndGet(
         array $sharedVars,
         array $tplSpecificVars,
-        $template
+        $template,
     ): void {
         $this->data->add($sharedVars);
         $this->data->add($tplSpecificVars, $template);
@@ -142,9 +142,9 @@ public function invalidTemplateProvider(): array
      *
      * @param mixed $template
      */
-    public function testAddingInvalidTemplateTypeShouldThrowException($template): void
+    public function testAddingInvalidTemplateTypeShouldThrowException(mixed $template): void
     {
-        $this->expectException(InvalidArgumentException::class);
+        $this->expectException(TypeError::class);
         $this->data->add(['foo' => 'bar'], $template);
     }
 }

test/RendererTest.php

@@ -140,7 +140,7 @@ public function dataProvider(): array
     public function testAddAndGetData(
         array $sharedVars,
         array $tplSpecificVars,
-        $template
+        $template,
     ): void {
         $this->renderer->withData($sharedVars);
         $this->renderer->withData($tplSpecificVars, $template);