Merge pull request #13 from merkle-open/feat/php-8-1-support

Add support for PHP 8.0;8.1 and Twig 3.x.

.github/workflows/workflow.yml

@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        php_version: ['7.3', '7.4']
+        php_version: ['8.0', '8.1']
 
     steps:
       - name: Setup PHP ${{ matrix.php_version }}

README.md

@@ -18,8 +18,8 @@ $ composer require namics/terrific-twig
 ## Requirements
 
 The following versions of PHP are currently supported.
-* 7.3
-* 7.4
+* 8.0
+* 8.1
 
 ## Setup
 Step 1: Implement `TemplateInformationProvider`
@@ -46,7 +46,7 @@ Step 2: Implement `ContextProviderInterface`
 ```php
 class ContextProvider implements ContextProviderInterface
 {
-    public function compile(Twig_Compiler $compiler, Twig_Node $component, Twig_Node $dataVariant, $only) {
+    public function compile(\Twig\Compiler $compiler, \Twig\Node\Node $component, \Twig\Node\Node $dataVariant, $only) {
         // ...
     }
 }
@@ -55,13 +55,13 @@ class ContextProvider implements ContextProviderInterface
 Step 3: Add `TerrificLoader`
 ```php
 $loader = ...;
-$chain = new Twig_Loader_Chain([$loader, new TerrificLoader(new TemplateInformationProvider)]);
-$twig = new Twig_Environment($chain);
+$chain = new \Twig\Loader\ChainLoader([$loader, new TerrificLoader(new TemplateInformationProvider)]);
+$twig = new \Twig\Environment($chain);
 ```
 
 Step 4: Add `TerrificExtension`
 ```php
-$twig = new Twig_Environment($chain);
+$twig = new \Twig\Environment($chain);
 $twig->addExtension(new TerrificExtension(new ContextProvider));
 ```
 

composer.json

@@ -30,11 +30,11 @@
         }
     },
     "require": {
-        "php": ">=7.3",
-        "twig/twig": "^2.13"
+        "php": ">=8.0",
+        "twig/twig": "^3.6"
     },
     "require-dev": {
-        "phpunit/phpunit": "^6.0"
+        "phpunit/phpunit": "^9.0"
     },
     "scripts": {
         "tests": [

phpunit.xml

@@ -8,7 +8,6 @@
          convertWarningsToExceptions="true"
          processIsolation="false"
          stopOnFailure="false"
-         syntaxCheck="false"
          bootstrap="vendor/autoload.php"
         >
     <testsuites>

src/Config/ConfigReader.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Namics\Terrific\Config;
 
 use DomainException;
@@ -26,7 +28,7 @@ final class ConfigReader {
    *
    * @var array
    */
-  private $config = [];
+  private array $config = [];
 
   /**
    * ConfigReader constructor.
@@ -36,7 +38,7 @@ final class ConfigReader {
    *
    * @throws DomainException Thrown if Configuration could not be loaded correctly.
    */
-  public function __construct($terrificDir) {
+  public function __construct(string $terrificDir) {
     $path = $terrificDir . '/' . self::TERRIFIC_NITRO_FILE_NAME;
     $this->readConfig($path);
   }
@@ -56,8 +58,9 @@ public function getConfig(): array {
    *
    * @param string $path
    *   The path to the config file.
+   * @return void
    */
-  protected function readConfig(string $path) {
+  protected function readConfig(string $path): void {
     if (is_readable($path)) {
       try {
         $this->config = json_decode(file_get_contents($path), TRUE);
@@ -67,7 +70,7 @@ protected function readConfig(string $path) {
         }
       }
       catch (DomainException $e) {
-        throw $e;
+        throw new DomainException($e->getMessage());
       }
     }
   }

src/Provider/ContextProviderInterface.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Namics\Terrific\Provider;
 
 use Twig\Compiler;

src/Provider/TemplateInformationProviderInterface.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Namics\Terrific\Provider;
 
 /**

src/Twig/Data/VariableNameAndArrayKeysPair.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Namics\Terrific\Twig\Data;
 
 use Twig\Error\Error;
@@ -16,7 +18,7 @@ class VariableNameAndArrayKeysPair {
    *
    * @var string
    */
-  protected $variableName;
+  protected string $variableName;
 
   /**
    * Array of array keys for given variableName variable.
@@ -25,7 +27,7 @@ class VariableNameAndArrayKeysPair {
    *
    * @var string[]
    */
-  protected $arrayKeys;
+  protected array $arrayKeys;
 
   /**
    * VariableNameAndArrayKeysPair constructor.
@@ -137,6 +139,7 @@ public function toTwigContextArrayKeysString(): string {
    *
    * @return string
    *   E.g. myVariable['aKey']['anotherKey'].
+   * @throws Error
    */
   public function toTwigVariableString(): string {
     if (!$this->isVariableNameEmpty()) {

src/Twig/Extension/TerrificExtension.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Namics\Terrific\Twig\Extension;
 
 use Namics\Terrific\Provider\ContextProviderInterface;
@@ -25,7 +27,7 @@ final class TerrificExtension extends AbstractExtension {
    *
    * @var \Namics\Terrific\Provider\ContextProviderInterface
    */
-  private $ctxProvider;
+  private ContextProviderInterface $ctxProvider;
 
   /**
    * TerrificExtension constructor.

src/Twig/Loader/TerrificLoader.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Namics\Terrific\Twig\Loader;
 
 use Namics\Terrific\Provider\TemplateInformationProviderInterface;

src/Twig/Node/ComponentNode.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Namics\Terrific\Twig\Node;
 
 use Namics\Terrific\Provider\ContextProviderInterface;
@@ -28,7 +30,7 @@ final class ComponentNode extends Node implements NodeOutputInterface {
    *
    * @var \Namics\Terrific\Provider\ContextProviderInterface
    */
-  private $ctxProvider;
+  private ContextProviderInterface $ctxProvider;
 
   /**
    * The expression handler.
@@ -38,7 +40,7 @@ final class ComponentNode extends Node implements NodeOutputInterface {
    *
    * @var \Namics\Terrific\Twig\Utility\ExpressionHandler
    */
-  private $expressionHandler;
+  private ExpressionHandler $expressionHandler;
 
   /**
    * ComponentNode constructor.
@@ -60,9 +62,9 @@ public function __construct(
     Node $component,
     ContextProviderInterface $ctxProvider,
     Node $data,
-    $only = FALSE,
-    $lineno,
-    $tag = NULL
+    int $lineno,
+    bool $only = FALSE,
+    string $tag = NULL
   ) {
     parent::__construct(
       ['component' => $component, 'data' => $data],
@@ -129,8 +131,9 @@ protected function createTerrificContext(TerrificCompilerInterface $terrificComp
    * IMPORTANT: Has to be executed after the Terrific context was created
    * (ComponentNode::createTerrificContext).
    *
-   * @param \Namics\Terrific\Twig\TerrificCompilerInterface $terrificCompiler
+   * @param TerrificCompilerInterface $terrificCompiler
    *   The Terrific Twig compiler.
+   * @throws SyntaxError
    */
   protected function addGetTemplate(TerrificCompilerInterface $terrificCompiler): void {
     $twigCompiler = $terrificCompiler->getTwigCompiler();
@@ -161,7 +164,7 @@ protected function compileComponentName(TerrificCompilerInterface $terrificCompi
     $node = $this->getNode('component');
 
     /* If a variable is used for component name,
-    use it's value (is inside Terrifc context "$tContext") for template name.
+    use its value (is inside Terrifc context "$tContext") for template name.
     E.g. {% component myTwigComponentName { dataItem: 'my string' } %} */
     if ($node instanceof NameExpression) {
       $terrificCompiler->compileNameExpressionAsContextVariable($node);
@@ -173,7 +176,7 @@ protected function compileComponentName(TerrificCompilerInterface $terrificCompi
       $terrificCompiler->getTwigCompiler()->subcompile($node);
     }
     /* If an object object/array used for component name,
-    use it's value (is inside Terrifc context "$tContext") for template name.
+    use its value (is inside Terrifc context "$tContext") for template name.
     E.g. {% component myTwigObject.anObjectProperty.myTwigComponentName { dataItem: 'my string' } %} */
     elseif ($node instanceof GetAttrExpression) {
       $terrificCompiler->compileGetAttrExpressionAsContextVariable($node);

src/Twig/TerrificCompiler.php

@@ -1,12 +1,15 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Namics\Terrific\Twig;
 
 use Namics\Terrific\Provider\ContextProviderInterface;
 use Namics\Terrific\Twig\Data\VariableNameAndArrayKeysPair;
 use Namics\Terrific\Twig\Extension\TerrificExtension;
 use Namics\Terrific\Twig\Utility\ExpressionHandler;
 use Twig\Compiler;
+use Twig\Error\Error;
 use Twig\Node\Expression\GetAttrExpression;
 use Twig\Node\Expression\NameExpression;
 
@@ -22,7 +25,7 @@ class TerrificCompiler implements TerrificCompilerInterface {
    *
    * @var \Twig\Compiler
    */
-  protected $compiler;
+  protected Compiler $compiler;
 
   /**
    * The expression handler.
@@ -32,7 +35,7 @@ class TerrificCompiler implements TerrificCompilerInterface {
    *
    * @var \Namics\Terrific\Twig\Utility\ExpressionHandler
    */
-  private $expressionHandler;
+  private ExpressionHandler $expressionHandler;
 
   /**
    * TerrificCompiler constructor.
@@ -62,6 +65,7 @@ public static function create(Compiler $compiler): self {
    * @param string $contextVariable
    *   The PHP variable to use as base for adding the array keys.
    *   Defaults to the Terrific context.
+   * @throws Error
    */
   public function compileNameExpressionAsContextVariable(NameExpression $expression, string $contextVariable = ContextProviderInterface::TERRIFIC_CONTEXT_VARIABLE): void {
     $variableName = $this->getExpressionHandler()->getVariableNameFromNameExpression($expression);
@@ -138,13 +142,14 @@ public function compileAndMergeGetAttrExpressionToContext(GetAttrExpression $exp
   /**
    * Checks if given variable exists, and adds it to the context.
    *
-   * So it it's data is available in the compiled component.
+   * So it its data is available in the compiled component.
    *
-   * @param \Namics\Terrific\Twig\Data\VariableNameAndArrayKeysPair $variableNameAndArrayKeysPair
+   * @param VariableNameAndArrayKeysPair $variableNameAndArrayKeysPair
    *   Object containing the variable name and optionally array keys.
    * @param string|null $variableDoesNotExistErrorMessage
    *   Custom error message that is used as exception message
    *   when the given variable does not exist.
+   * @throws Error
    */
   public function compileAndMergeVariableToContext(VariableNameAndArrayKeysPair $variableNameAndArrayKeysPair, ?string $variableDoesNotExistErrorMessage = NULL): void {
     $twigCompiler = $this->getTwigCompiler();

src/Twig/TerrificCompilerInterface.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Namics\Terrific\Twig;
 
 use Namics\Terrific\Twig\Utility\ExpressionHandler;

src/Twig/TokenParser/ComponentTokenParser.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Namics\Terrific\Twig\TokenParser;
 
 use Namics\Terrific\Provider\ContextProviderInterface;
@@ -21,7 +23,7 @@ final class ComponentTokenParser extends AbstractTokenParser {
    *
    * @var \Namics\Terrific\Provider\ContextProviderInterface
    */
-  private $ctxProvider;
+  private ContextProviderInterface $ctxProvider;
 
   /**
    * ComponentTokenParser constructor.
@@ -44,7 +46,7 @@ public function parse(Token $token): ComponentNode {
     $component = $this->parser->getExpressionParser()->parseExpression();
     list($data, $only) = $this->parseArguments();
 
-    return new ComponentNode($component, $this->ctxProvider, $data, $only, $token->getLine(), $this->getTag());
+    return new ComponentNode($component, $this->ctxProvider, $data, $token->getLine(), $only, $this->getTag());
   }
 
   /**

src/Twig/Utility/ExpressionHandler.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Namics\Terrific\Twig\Utility;
 
 use Namics\Terrific\Twig\Data\VariableNameAndArrayKeysPair;
@@ -88,12 +90,10 @@ public function buildGetAttrExpressionArrayKeys(Node $expression): array {
    *
    * @return bool
    *   TRUE if nested object.
-   *   Otherwise FALSE.
+   *   Otherwise, FALSE.
    */
   public function isNestedObject(Node $expression): bool {
-    $isNestedObject = $expression->hasNode('node') && $expression->getNode('node') instanceof GetAttrExpression;
-
-    return $isNestedObject;
+    return $expression->hasNode('node') && $expression->getNode('node') instanceof GetAttrExpression;
   }
 
   /**

test/Twig/Extension/TerrificExtensionTest.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Namics\Test\Terrific\Twig\Extension;
 
 use Namics\Terrific\Twig\TokenParser\ComponentTokenParser;