Merge pull request #7 from xvilo/twig-3-support

Twig 3 support

Author: sserbin

.gitignore

@@ -1,5 +1,6 @@
 /vendor/
 composer.lock
+.phpunit.result.cache
 
 # Created by https://www.gitignore.io/api/vim
 

.travis.yml

@@ -8,9 +8,9 @@ cache:
     - vendor
 
 php:
-  - 7.1
-  - 7.2
-  - 7.3
+  - 7.2 # EOL: 20 Nov 2020
+  - 7.3 # EOL: 6 Dec 2021
+  - 7.4 # EOL: 28 Nov 2022
 
 matrix:
   fast_finish: true

composer.json

@@ -16,10 +16,10 @@
         "psr-4": { "Sserbin\\TwigLinter\\Tests\\": "tests/"}
     },
     "require": {
-        "php": "~7.1",
+        "php": "~7.2",
         "symfony/console": "^4.1",
         "symfony/finder": "^4.1",
-        "twig/twig": "^2.5",
+        "twig/twig": "^2.5 || ^3",
         "ocramius/package-versions": "^1.3"
     },
     "require-dev": {

src/Command/LintCommand.php

@@ -1,5 +1,7 @@
 <?php
+
 declare(strict_types=1);
+
 /*
  * This file is part of the Symfony package.
  *

src/StubEnvironment.php

@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Sserbin\TwigLinter;
@@ -11,9 +12,10 @@
 class StubEnvironment extends Environment
 {
     /**
-     * {@inheritdoc}
+     * @param string $name
+     * @psalm-suppress ImplementedReturnTypeMismatch
      */
-    public function getFilter($name)
+    public function getFilter($name): ?TwigFilter
     {
         /**
          * @var string[]
@@ -24,7 +26,7 @@ public function getFilter($name)
 
         if ($isDefault) { // don't attempt to stub twig's builtin filter
             /** @psalm-suppress InternalMethod */
-            return parent::getFilter($name);
+            return parent::getFilter($name) ?: null;
         }
 
         return new TwigFilter((string)$name, $this->noop(), [
@@ -33,9 +35,10 @@ public function getFilter($name)
     }
 
     /**
-     * {@inheritdoc}
+     * @param string $name
+     * @psalm-suppress ImplementedReturnTypeMismatch
      */
-    public function getFunction($name)
+    public function getFunction($name): ?TwigFunction
     {
         /**
          * @var string[]
@@ -46,7 +49,7 @@ public function getFunction($name)
 
         if ($isDefault) { // don't attempt to stub twig's builtin function
             /** @psalm-suppress InternalMethod */
-            return parent::getFunction($name);
+            return parent::getFunction($name) ?: null;
         }
 
         return new TwigFunction((string)$name, $this->noop(), [
@@ -55,9 +58,10 @@ public function getFunction($name)
     }
 
     /**
-     * {@inheritdoc}
+     * @param string $name
+     * @psalm-suppress ImplementedReturnTypeMismatch
      */
-    public function getTest($name)
+    public function getTest($name): ?TwigTest
     {
         /**
          * @var string[]
@@ -68,7 +72,16 @@ public function getTest($name)
 
         if ($isDefault) { // don't attempt to stub twig's builtin test
             /** @psalm-suppress InternalMethod */
-            return parent::getTest($name);
+            $parentTest = parent::getTest($name);
+
+            if ($parentTest instanceof TwigTest) {
+                return $parentTest;
+            }
+
+            // In twig 2.x this can return `false`.
+            // Lets just force it here as null because
+            // of the added typehint for Twig 3.x
+            return null;
         }
 
         return new TwigTest((string)$name, $this->noop(), [
@@ -80,13 +93,15 @@ private function noop(): callable
     {
         /**
          * @param mixed $_
+         * @param array $arg
          */
         return function ($_ = null, array $arg = []): void {
         };
     }
 
     /**
      * @param string[] $list
+     * @return bool
      */
     private function listContainsSubstring(array $list, string $needle): bool
     {

tests/LintCommandTest.php

@@ -1,4 +1,5 @@
 <?php
+
 /*
  * This file is part of the Symfony package.
  *
@@ -10,14 +11,12 @@
 namespace Sserbin\TwigLinter\Tests;
 
 use PHPUnit\Framework\TestCase;
-
+use RuntimeException;
 use Symfony\Component\Console\Application;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Tester\CommandTester;
-
 use Twig\Environment;
 use Twig\Loader\FilesystemLoader;
-
 use Sserbin\TwigLinter\Command\LintCommand;
 
 class LintCommandTest extends TestCase
@@ -36,7 +35,7 @@ public function testLintCorrectFile(): void
         );
 
         $this->assertEquals(0, $ret, 'Returns 0 in case of success');
-        $this->assertContains('OK in', trim($tester->getDisplay()));
+        $this->assertStringContainsString('OK in', trim($tester->getDisplay()));
     }
 
     public function testLintIncorrectFile(): void
@@ -50,11 +49,9 @@ public function testLintIncorrectFile(): void
         $this->assertRegExp('/ERROR  in \S+ \(line /', trim($tester->getDisplay()));
     }
 
-    /**
-     * @expectedException \RuntimeException
-     */
     public function testLintFileNotReadable(): void
     {
+        $this->expectException(RuntimeException::class);
         $tester = $this->createCommandTester();
         $filename = $this->createFile('');
         unlink($filename);