Merge pull request #21 from keepsuit/strict-variables-improvements

Strict variables improvements

composer.json

@@ -45,8 +45,7 @@
     "scripts": {
         "test": "vendor/bin/pest",
         "test-coverage": "vendor/bin/pest --coverage",
-        "format": "vendor/bin/pint",
-        "lint": "vendor/bin/phpstan analyse",
+        "lint": "vendor/bin/pint && vendor/bin/phpstan analyse",
         "benchmark": "vendor/bin/phpbench run --report=aggregate --php-config=\"opcache.enable: 1, opcache.enable_cli: 1\"",
         "profile": "vendor/bin/phpbench xdebug:profile"
     },

performance/Shopify/PaginateTag.php

@@ -55,6 +55,7 @@ public function render(RenderContext $context): string
     {
         return $context->stack(function (RenderContext $context) {
             $currentPage = $context->get('current_page');
+            $currentPage = is_int($currentPage) ? $currentPage : 1;
 
             $collection = $context->get($this->collectionName);
             $collection = match (true) {

phpstan.neon

@@ -10,11 +10,9 @@ parameters:
         - tests/Stubs
     tmpDir: build/phpstan
     treatPhpDocTypesAsCertain: false
-    checkMissingIterableValueType: false
     checkGenericClassInNonGenericObjectType: true
     checkPhpDocMissingReturn: true
-    featureToggles:
-        disableCheckMissingIterableValueType: false
 
     ignoreErrors:
+        - identifier: missingType.iterableValue
         - '#Method .+ should return .+ but returns mixed#'

src/Nodes/VariableLookup.php

@@ -6,11 +6,11 @@
 use Keepsuit\Liquid\Contracts\HasParseTreeVisitorChildren;
 use Keepsuit\Liquid\Contracts\IsContextAware;
 use Keepsuit\Liquid\Exceptions\SyntaxException;
-use Keepsuit\Liquid\Exceptions\UndefinedVariableException;
 use Keepsuit\Liquid\Parse\LexerOptions;
 use Keepsuit\Liquid\Render\RenderContext;
 use Keepsuit\Liquid\Support\MissingValue;
 use Keepsuit\Liquid\Support\Str;
+use Keepsuit\Liquid\Support\UndefinedVariable;
 
 class VariableLookup implements CanBeEvaluated, HasParseTreeVisitorChildren
 {
@@ -65,7 +65,7 @@ public function toString(): string
             return $this->name;
         }
 
-        return sprintf('%s.%s', $this->name, implode('.', $this->lookups));
+        return implode('.', [$this->name, ...$this->lookups]);
     }
 
     public function __toString(): string
@@ -85,6 +85,10 @@ public function evaluate(RenderContext $context): mixed
         $variables = $context->findVariables($name);
 
         if ($this->lookups === []) {
+            if ($context->strictVariables && $variables === []) {
+                return new UndefinedVariable($this->toString());
+            }
+
             return $variables[0] ?? null;
         }
 
@@ -117,11 +121,7 @@ public function evaluate(RenderContext $context): mixed
             return $object;
         }
 
-        if ($context->strictVariables) {
-            throw new UndefinedVariableException($this->toString());
-        }
-
-        return null;
+        return $context->strictVariables ? new UndefinedVariable($this->toString()) : null;
     }
 
     protected function applyFilter(RenderContext $context, mixed $object, string $filter): mixed

src/Render/RenderContext.php

@@ -14,7 +14,6 @@
 use Keepsuit\Liquid\Exceptions\ResourceLimitException;
 use Keepsuit\Liquid\Exceptions\StackLevelException;
 use Keepsuit\Liquid\Exceptions\StandardException;
-use Keepsuit\Liquid\Exceptions\UndefinedVariableException;
 use Keepsuit\Liquid\FileSystems\BlankFileSystem;
 use Keepsuit\Liquid\Interrupts\Interrupt;
 use Keepsuit\Liquid\Nodes\VariableLookup;
@@ -168,9 +167,6 @@ public function has(string $key): bool
         return $this->get($key) !== null;
     }
 
-    /**
-     * @throws UndefinedVariableException
-     */
     public function findVariables(string $key): array
     {
         $variables = [];
@@ -183,10 +179,6 @@ public function findVariables(string $key): array
 
         $variables = array_values(array_filter($variables, fn (mixed $value) => ! $value instanceof MissingValue));
 
-        if ($variables === []) {
-            return $this->strictVariables ? throw new UndefinedVariableException($key) : [];
-        }
-
         foreach ($variables as $variable) {
             if ($variable instanceof IsContextAware) {
                 $variable->setContext($this);

src/Support/FilterRegistry.php

@@ -5,6 +5,7 @@
 use Keepsuit\Liquid\Contracts\IsContextAware;
 use Keepsuit\Liquid\Exceptions\InvalidArgumentException;
 use Keepsuit\Liquid\Exceptions\UndefinedFilterException;
+use Keepsuit\Liquid\Exceptions\UndefinedVariableException;
 use Keepsuit\Liquid\Render\RenderContext;
 
 class FilterRegistry
@@ -44,14 +45,22 @@ public function register(string $filterClass): static
     }
 
     /**
-     * @throws UndefinedFilterException
+     * @throws UndefinedFilterException|UndefinedVariableException
      */
     public function invoke(RenderContext $context, string $filterName, mixed $value, mixed ...$args): mixed
     {
         $filter = $this->filters[$filterName] ?? null;
 
         if ($filter !== null) {
-            return $filter($context, $value, ...$args);
+            try {
+                return $filter($context, $value, ...$args);
+            } catch (\TypeError $e) {
+                if ($value instanceof UndefinedVariable) {
+                    throw new UndefinedVariableException($value->variableName);
+                }
+
+                throw $e;
+            }
         }
 
         if ($context->strictVariables) {

src/Support/UndefinedVariable.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace Keepsuit\Liquid\Support;
+
+use Keepsuit\Liquid\Contracts\AsLiquidValue;
+use Keepsuit\Liquid\Contracts\CanBeRendered;
+use Keepsuit\Liquid\Exceptions\UndefinedVariableException;
+use Keepsuit\Liquid\Render\RenderContext;
+
+class UndefinedVariable implements AsLiquidValue, CanBeRendered
+{
+    public function __construct(public readonly string $variableName)
+    {
+    }
+
+    public function render(RenderContext $context): string
+    {
+        if ($context->strictVariables) {
+            throw new UndefinedVariableException($this->variableName);
+        }
+
+        return '';
+    }
+
+    public function toLiquidValue(): string|int|float|bool|null
+    {
+        return null;
+    }
+}