v0.6.2 (#13)

* Bump dependency

* Refrain from adding newline in SVG's

* Update CHANGELOG.md with new version

* Add phpstan

* Configure phpstan

* Fix phpstan errors, remove test for now private properties

* Include phpstan in ci

* Change exclude pattern so that src/Blade.php isn't excluded

* Fix cs error

* Update squizlabs/php_codesniffer version

* Update CHANGELOG.md

* Add test for null responses to increase coverage

Author: fiskhandlarn

.editorconfig

@@ -13,3 +13,6 @@ indent_size = 4
 
 [*.md]
 trim_trailing_whitespace = false
+
+[*.svg]
+insert_final_newline = false

.github/workflows/ci.yml

@@ -8,7 +8,7 @@ jobs:
 
     strategy:
       matrix:
-        php: [7.3, 7.4, 8.0]
+        php: [7.3, 7.4, 8.0, 8.1]
 
     name: PHP ${{ matrix.php }}
 
@@ -24,6 +24,8 @@ jobs:
         run: composer install --prefer-dist --no-interaction
       - name: "Check coding standards"
         run: vendor/bin/phpcs
+      - name: "Analyze code with PHPStan"
+        run: vendor/bin/phpstan
       - name: "Run test suite"
         run: vendor/bin/phpunit --coverage-clover=coverage.xml
       - name: "Upload coverage to Codecov"

.phpcs.xml

@@ -3,7 +3,7 @@
     <file>src</file>
     <file>tests</file>
 
-    <exclude-pattern>*blade.php$</exclude-pattern>
+    <exclude-pattern>tests/views/*</exclude-pattern>
     <exclude-pattern>*/cache/*$</exclude-pattern>
 
     <arg name="basepath" value="."/>

CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## 0.6.2 (released 2022-07-14)
+
+- Added PHPStan
+- Updated squizlabs/php_codesniffer to 3.7
+- Updated illuminate/view to 8.83
+
 ## 0.6.1 (released 2021-05-25)
 
 - Updated illuminate/view to 8.42

composer.json

@@ -16,13 +16,14 @@
   ],
   "require": {
     "php": "^7.3 || ^8.0",
-    "illuminate/view": "^8.42",
+    "illuminate/view": "^8.83",
     "soberwp/controller": "^2.1"
   },
   "require-dev": {
     "10up/wp_mock": "^0.4.2",
+    "phpstan/phpstan": "^1.8",
     "phpunit/phpunit": "9.4.4",
-    "squizlabs/php_codesniffer": "^3.6"
+    "squizlabs/php_codesniffer": "^3.7"
   },
   "config": {
     "preferred-install": "dist",
@@ -51,8 +52,9 @@
     }
   },
   "scripts": {
+    "cs": "vendor/bin/phpcs",
     "test": "vendor/bin/phpunit",
-    "cs": "vendor/bin/phpcs"
+    "stan": "vendor/bin/phpstan"
   },
   "suggest": {
     "wordplate/wordplate": "WordPlate is a modern WordPress stack which simplifies WordPress development (^9.0)."

phpstan.neon

@@ -0,0 +1,13 @@
+parameters:
+  level: 3
+  paths:
+    - src
+    - tests
+  excludePaths:
+    - tests/cache
+  ignoreErrors:
+    - '#Function apply_filters not found\.#'
+    - '#Function get_current_blog_id not found\.#'
+    - '#Function is_multisite not found\.#'
+    - '#Call to an undefined static method Fiskhandlarn\\BladeFacade::[\w]+\(\)\.#'
+  reportUnmatchedIgnoredErrors: false

src/Blade.php

@@ -35,6 +35,19 @@
  */
 class Blade
 {
+    /**
+     * Path to compiled views.
+     *
+     * @var string
+     */
+    private $cachePath;
+
+    /**
+     * The compiler implementation.
+     *
+     * @var \Illuminate\View\Compilers\CompilerInterface
+     */
+    private $compiler;
 
     /**
      * The container.
@@ -71,11 +84,9 @@ class Blade
      * @param string             $cachePath
      * @param bool               $createCacheDirectory
      */
-    public function __construct($viewPaths, $cachePath, $createCacheDirectory = true)
+    public function __construct($viewPaths, string $cachePath, bool $createCacheDirectory = true)
     {
-        $this->viewPaths = $viewPaths;
         $this->cachePath = $cachePath;
-        $this->createCacheDirectory = $createCacheDirectory;
         $this->container = new Container();
 
         if (is_multisite()) {
@@ -92,15 +103,15 @@ public function __construct($viewPaths, $cachePath, $createCacheDirectory = true
             return $this->dispatcher;
         }, true);
 
-        $this->container->bindIf('config', function () {
+        $this->container->bindIf('config', function () use ($createCacheDirectory, $viewPaths) {
             $this->cleanCacheDirectory();
 
-            if ($this->createCacheDirectory && !$this->filesystem->isDirectory($this->cachePath)) {
+            if ($createCacheDirectory && !$this->filesystem->isDirectory($this->cachePath)) {
                 $this->filesystem->makeDirectory($this->cachePath, 0775, true, true);
             }
 
             return [
-                'view.paths' => (array) $this->viewPaths,
+                'view.paths' => (array) $viewPaths,
                 'view.compiled' => $this->cachePath,
             ];
         }, true);
@@ -120,7 +131,7 @@ public function __construct($viewPaths, $cachePath, $createCacheDirectory = true
      *
      * @return mixed
      */
-    public function __call($name, $arguments)
+    public function __call(string $name, array $arguments)
     {
         if (method_exists($this->compiler, $name)) {
             return $this->compiler->{$name}(...$arguments);
@@ -129,6 +140,8 @@ public function __call($name, $arguments)
         if (method_exists($this->container['view'], $name)) {
             return $this->container['view']->{$name}(...$arguments);
         }
+
+        return null;
     }
 
     public function cleanCacheDirectory()

src/BladeControllerLoader.php

@@ -53,32 +53,36 @@ private static function instance(): BladeControllerLoader
 
     public static function dataFromController(string $controllerClass, array $additionalData = []): ?array
     {
-        $class = self::getClassToRun(self::instance()->namespace, $controllerClass);
+        try {
+            $class = self::getClassToRun(self::instance()->namespace, $controllerClass);
+        } catch (\Exception $exception) {
+            // class not found
+            throw $exception;
+            return null;
+        }
 
-        if ($class !== null) {
-            $container = Container::getInstance();
+        $container = Container::getInstance();
 
-            // Recreate the class so that $post is included
-            $controller = $container->make($class);
+        // Recreate the class so that $post is included
+        $controller = $container->make($class);
 
-            // Params
-            $controller->__setParams();
+        // Params
+        $controller->__setParams();
 
-            // Lifecycle
-            $controller->__before();
+        // Lifecycle
+        $controller->__before();
 
-            // Data
-            $controller->__setData($additionalData);
+        // Data
+        $controller->__setData($additionalData);
 
-            // Lifecycle
-            $controller->__after();
+        // Lifecycle
+        $controller->__after();
 
-            // Return
-            return $controller->__getData();
-        }
+        // Return
+        return $controller->__getData();
     }
 
-    private static function getClassToRun(string $namespace, string $class): ?string
+    private static function getClassToRun(string $namespace, string $class): string
     {
         try {
             $reflection = new \ReflectionClass($namespace . '\\' . $class);

src/helpers.php

@@ -31,7 +31,7 @@
      *
      * @param string $view
      * @param array $data
-     * @param bool $data
+     * @param bool $echo
      *
      * @return string
      */
@@ -53,7 +53,8 @@ function blade(string $view, array $data = [], bool $echo = true): string
      *
      * @param string $view
      * @param string $controllerClass
-     * @param bool $data
+     * @param array $additionalData
+     * @param bool $echo
      *
      * @return string
      */

tests/BladeTest.php

@@ -26,8 +26,10 @@
 use App\Controllers\Variable;
 use App\Controllers\VariableDisabled;
 use Fiskhandlarn\Blade;
+use Fiskhandlarn\BladeControllerLoader;
 use Fiskhandlarn\BladeFacade;
 use Illuminate\Filesystem\Filesystem;
+use WP_Mock;
 use WP_Mock\Tools\TestCase;
 
 /**
@@ -42,22 +44,22 @@ class BladeTest extends TestCase
     public function setUp(): void
     {
         parent::setUp();
-        \WP_Mock::setUp();
+        WP_Mock::setUp();
 
         $this->blade = new Blade('tests/views', 'tests/cache');
 
-        \WP_Mock::onFilter('blade/view/paths')
+        WP_Mock::onFilter('blade/view/paths') /* @phpstan-ignore-line */
             ->with(BladeFacade::basePath('resources/views'))
             ->reply('tests/views');
 
-        \WP_Mock::onFilter('blade/cache/path')
+        WP_Mock::onFilter('blade/cache/path') /* @phpstan-ignore-line */
             ->with(BladeFacade::basePath('storage/views'))
             ->reply('tests/cache');
     }
 
     public function tearDown(): void
     {
-        \WP_Mock::tearDown();
+        WP_Mock::tearDown();
         parent::tearDown();
     }
 
@@ -66,21 +68,17 @@ public function testInstance()
         $this->assertInstanceOf(Blade::class, $this->blade);
     }
 
-    public function testDefaults()
+    public function testNullResponses()
     {
-        $this->assertEquals(
-            'tests/views',
-            $this->blade->viewPaths
+        $this->assertNull(
+            $this->blade->thisMethodDoesNotExists()
         );
 
-        $this->assertEquals(
-            'tests/cache/1',
-            $this->blade->cachePath
-        );
+        $this->expectException(\Exception::class);
+        $this->expectExceptionMessage('No such class found in namespace App\Controllers: NonExistingController');
 
-        $this->assertEquals(
-            true,
-            $this->blade->createCacheDirectory
+        $this->assertNull(
+            BladeControllerLoader::dataFromController('NonExistingController')
         );
     }