Merge pull request #10 from pug-php/feature/dedicated-parsers

Implement relative path support

Author: kylekatarnls

.github/workflows/tests.yml

@@ -13,7 +13,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php: ['5.3', '5.4', '5.5', '5.6', '7.0', '7.1', '7.2', '7.3', '7.4', '8.0', '8.1']
+        php: ['5.3', '5.4', '5.5', '5.6', '7.0', '7.1', '7.2', '7.3', '7.4', '8.0', '8.1', '8.2', '8.3']
         setup: ['lowest', 'stable']
 
     name: PHP ${{ matrix.php }} - ${{ matrix.setup }}

composer.json

@@ -20,11 +20,16 @@
     },
     "require-dev": {
         "composer/composer": "^1.10.23 || ^2.1.9",
-        "phpunit/phpunit": "^4.8.36 || ^5.7.27 || ^8.5.15"
+        "phpunit/phpunit": "^4.8.36 || ^5.7.27 || ^8.5.31"
     },
     "autoload": {
         "psr-0": {
             "Pug\\": "src/"
         }
+    },
+    "config": {
+        "allow-plugins": {
+            "nodejs-php-fallback/nodejs-php-fallback": true
+        }
     }
 }

src/Pug/Keyword/Minify.php

@@ -98,16 +98,43 @@ protected function writeWith($parser, $path)
         $parser->write($path);
     }
 
-    protected function getPathInfo($path, $newExtension)
+    /**
+     * @param string      $path
+     * @param string      $newExtension
+     * @param string|null $relativePath
+     *
+     * @return string[]
+     */
+    protected function getPathInfo($path, $newExtension, $relativePath = null)
     {
-        $source = new Path($this->assetDirectory, $path);
+        $source = $this->getSourcePath($path, $relativePath);
         $extension = pathinfo($path, PATHINFO_EXTENSION);
         $path = substr($path, 0, -strlen($extension)) . $newExtension;
         $destination = $this->prepareDirectory(new Path($this->outputDirectory, $path));
 
         return array($extension, $path, (string) $source, $destination);
     }
 
+    /**
+     * @param string      $path
+     * @param string|null $relativePath
+     *
+     * @return Path
+     */
+    protected function getSourcePath($path, $relativePath = null)
+    {
+        if ($relativePath) {
+            $relativeSource = new Path($path);
+            $relativeSource = $relativeSource->relativeTo($relativePath);
+
+            if (file_exists((string) $relativeSource)) {
+                return $relativeSource;
+            }
+        }
+
+        return new Path($this->assetDirectory, $path);
+    }
+
     protected function needUpdate($source, $destination)
     {
         return !$this->dev || !file_exists($destination) || filemtime($source) >= filemtime($destination);
@@ -134,9 +161,9 @@ protected function prepareSource($params)
         }
     }
 
-    protected function parseScript($path)
+    protected function parseScript($path, $relativePath = null)
     {
-        list($extension, $path, $source, $destination) = $this->getPathInfo($path, 'js');
+        list($extension, $path, $source, $destination) = $this->getPathInfo($path, 'js', $relativePath);
         $params = (object) array(
             'extension'   => $extension,
             'type'        => 'script',
@@ -162,9 +189,9 @@ protected function parseScript($path)
         return null;
     }
 
-    protected function parseStyle($path)
+    protected function parseStyle($path, $relativePath = null)
     {
-        list($extension, $path, $source, $destination) = $this->getPathInfo($path, 'css');
+        list($extension, $path, $source, $destination) = $this->getPathInfo($path, 'css', $relativePath);
         $params = (object) array(
             'extension'   => $extension,
             'type'        => 'style',
@@ -314,10 +341,10 @@ private function triggerEventAction($action, $event, &$params = null)
         }
     }
 
-    public function linkExtractor($href, $rel)
+    public function linkExtractor($href, $rel, $relativePath = null)
     {
         if ($href && $rel === 'stylesheet') {
-            $path = $this->parseStyle($href);
+            $path = $this->parseStyle($href, $relativePath);
             if ($this->dev && $path) {
                 return array(
                     'href' => $path,
@@ -326,10 +353,10 @@ public function linkExtractor($href, $rel)
         }
     }
 
-    public function scriptExtractor($src)
+    public function scriptExtractor($src, $relativePath = null)
     {
         if ($src) {
-            $path = $this->parseScript($src);
+            $path = $this->parseScript($src, $relativePath);
             if ($this->dev && $path) {
                 return array(
                     'src'  => $path,

src/Pug/Keyword/Minify/BlockExtractor.php

@@ -6,6 +6,9 @@
 use Jade\Nodes\Node;
 use Jade\Nodes\Tag;
 use Phug\Formatter\Element\MarkupElement;
+use Phug\Formatter\ElementInterface;
+use Phug\Parser\NodeInterface;
+use Phug\Util\SourceLocationInterface;
 
 class BlockExtractor
 {
@@ -85,26 +88,54 @@ protected function setPug2NodeValue($node, $key, $value)
     protected function processNode($node)
     {
         $name = method_exists($node, 'getName') ? $node->getName() : $node->name;
+
         if (!isset($this->extractors[$name])) {
             return false;
         }
 
         list($extractor, $attributes) = $this->extractors[$name];
         $arguments = array();
+
         foreach ($attributes as $attribute) {
             $arguments[] = $this->getNodeValue($node, $attribute);
         }
+
+        $path = $this->getNodePath($node);
+
+        if ($path) {
+            $arguments[] = $path;
+        }
+
         $newAttributes = call_user_func_array($extractor, $arguments);
+
         if (!$newAttributes) {
             return true;
         }
+
         foreach ($newAttributes as $name => $value) {
             $this->setNodeValue($node, $name, $value);
         }
 
         return false;
     }
 
+    protected function getNodePath($node)
+    {
+        if ($node instanceof ElementInterface) {
+            $node = $node->getOriginNode();
+        }
+
+        if (!($node instanceof NodeInterface)) {
+            return null;
+        }
+
+        $location = $node->getSourceLocation();
+
+        return $location instanceof SourceLocationInterface
+            ? $location->getPath()
+            : null;
+    }
+
     protected function scrollBlock($block)
     {
         if (isset($block->nodes) && is_array($block->nodes)) {

src/Pug/Keyword/Minify/Path.php

@@ -11,6 +11,19 @@ public function __construct()
         $this->parts = array_filter(func_get_args());
     }
 
+    /**
+     * @param string $relativePath
+     *
+     * @return static
+     */
+    public function relativeTo($relativePath)
+    {
+        $path = new static(dirname($relativePath));
+        $path->parts = array_merge($path->parts, $this->parts);
+
+        return $path;
+    }
+
     public function __toString()
     {
         $parts = $this->parts;

tests/Minify/BlockExtractorTest.php

@@ -66,4 +66,14 @@ public function testSetNodeValue()
 
         self::assertSame("'after'", $fakeNode->getBarValue());
     }
+
+    public function testPathForWrongNode()
+    {
+        require_once __DIR__ . '/Fixture/FakeNode.php';
+        require_once __DIR__ . '/Fixture/BlockExtractorTester.php';
+
+        $extractor = new BlockExtractorTester((object) array());
+
+        self::assertNull($extractor->getPathForWrongNode());
+    }
 }

tests/Minify/Fixture/BlockExtractorTester.php

@@ -24,4 +24,9 @@ public function changeValue($node)
     {
         $this->setNodeValue($node, 'bar', 'after');
     }
+
+    public function getPathForWrongNode()
+    {
+        return $this->getNodePath(new \stdClass());
+    }
 }

tests/MinifyTest.php

@@ -187,7 +187,11 @@ public function testProductionWithMinify()
         $this->cleanTempDir();
     }
 
-    public function testProductionWithConcat()
+    /**
+     * @testWith ["test-concat"]
+     *           ["relative/test-root"]
+     */
+    public function testProductionWithConcat($path)
     {
         $this->cleanTempDir();
         $outputDirectory = $this->getTempDir();
@@ -201,7 +205,7 @@ public function testProductionWithConcat()
         ));
         $minify = new Minify($pug);
         $pug->addKeyword('concat', $minify);
-        $html = static::simpleHtml($this->renderFile($pug, __DIR__ . '/test-concat.pug'));
+        $html = static::simpleHtml($this->renderFile($pug, __DIR__ . '/' . $path . '.pug'));
         $expected = static::simpleHtml(file_get_contents(__DIR__ . '/prod-concat.html'));
 
         self::assertSimilar($expected, $html);
@@ -261,6 +265,45 @@ public function testMultipleAssetDirectories()
         $this->cleanTempDir();
     }
 
+    public function testRelativePath()
+    {
+        if (!class_exists('Phug\\Util\\SourceLocationInterface')) {
+            self::markTestSkipped('SourceLocationInterface needed to calculate relative path');
+        }
+
+        $this->cleanTempDir();
+        $outputDirectory = $this->getTempDir();
+
+        $pug = new Pug(array(
+            'environment'        => 'production',
+            'prettyprint'        => true,
+            'assetDirectory'     => array(dirname(__DIR__), __DIR__, __DIR__ . '/js'),
+            'outputDirectory'    => $outputDirectory,
+            'execution_max_time' => 300000,
+        ));
+        $minify = new Minify($pug);
+        $pug->addKeyword('minify', $minify);
+        $html = static::simpleHtml($this->renderFile($pug, __DIR__ . '/relative/test-inside.pug'));
+        $expected = static::simpleHtml(file_get_contents(__DIR__ . '/relative/test-inside.html'));
+
+        self::assertSimilar($expected, $html);
+
+        $file = $outputDirectory . '/js/top.min.js';
+        $javascript = static::fileGetAsset($file);
+        unlink($file);
+        self::assertSimilar(
+            "console.log(\"sub/test\");console.log(\"sub/test2\");",
+            str_replace(array("\n", "\r"), '', $javascript)
+        );
+
+        $file = $outputDirectory . '/css/top.min.css';
+        $style = static::fileGetAsset($file);
+        unlink($file);
+        self::assertSimilar('body{#foo { color:red}} body{.foo { color:lime}', trim($style));
+
+        $this->cleanTempDir();
+    }
+
     /**
      * @group hooks
      */

tests/relative/sub/test.js

@@ -0,0 +1 @@
+console.log('sub/test');

tests/relative/sub/test.scss

@@ -0,0 +1,5 @@
+body {
+  #foo {
+    color: red;
+  }
+}