Hooks (#5)

* #3 Implements hooks

* Align array values

* Test public trigger method call

Author: kylekatarnls

src/Pug/Keyword/Minify.php

@@ -39,6 +39,11 @@ class Minify
      */
     protected $css;
 
+    /**
+     * @var array
+     */
+    protected $events;
+
     /**
      * @var Pug|Jade
      */
@@ -135,74 +140,117 @@ protected function needUpate($source, $destination)
     protected function parseScript($path)
     {
         list($extension, $path, $source, $destination) = $this->getPathInfo($path, 'js');
-        if ($this->needUpate($source, $destination)) {
-            switch ($extension) {
+        $params = (object) array(
+            'extension'   => $extension,
+            'type'        => 'script',
+            'path'        => $path,
+            'source'      => $source,
+            'destination' => $destination,
+        );
+        if ($this->needUpate($params->source, $params->destination)) {
+            switch ($params->extension) {
+                case 'jsxp':
+                    $params->contents = preg_replace_callback('/(?<!\s)(\s*)::`(([^`]+|(?<!`)`(?!`))*?)`(?!`)/', array($this, 'parsePugInJsx'), file_get_contents($params->source));
+                    break;
+                case 'cofp':
+                    $params->contents = preg_replace_callback('/(?<!\s)(\s*)::"""([\s\S]*?)"""/', array($this, 'parsePugInCoffee'), file_get_contents($params->source));
+                    break;
+            }
+            $this->trigger('pre-parse', $params);
+            switch ($params->extension) {
                 case 'jsxp':
-                    $contents = preg_replace_callback('/(?<!\s)(\s*)::`(([^`]+|(?<!`)`(?!`))*?)`(?!`)/', array($this, 'parsePugInJsx'), file_get_contents($source));
-                    $this->writeWith(new React($contents), $destination);
+                    $this->writeWith(new React($params->contents), $destination);
                     break;
                 case 'jsx':
-                    $this->writeWith(new React($source), $destination);
+                    $this->writeWith(new React($params->source), $params->destination);
                     break;
                 case 'cofp':
-                    $contents = preg_replace_callback('/(?<!\s)(\s*)::"""([\s\S]*?)"""/', array($this, 'parsePugInCoffee'), file_get_contents($source));
-                    $this->writeWith(new Coffeescript($contents), $destination);
+                    $this->writeWith(new Coffeescript($params->contents), $params->destination);
                     break;
                 case 'coffee':
-                    $this->writeWith(new Coffeescript($source), $destination);
+                    $this->writeWith(new Coffeescript($params->source), $params->destination);
                     break;
                 default:
-                    copy($source, $destination);
+                    copy($params->source, $params->destination);
             }
+            $this->trigger('post-parse', $params);
         }
         if ($this->dev) {
-            return $path . '?' . time();
+            return $params->path . '?' . time();
         }
         $this->js[] = $destination;
     }
 
     protected function parseStyle($path)
     {
         list($extension, $path, $source, $destination) = $this->getPathInfo($path, 'css');
-        if ($this->needUpate($source, $destination)) {
-            switch ($extension) {
+        $params = (object) array(
+            'extension'   => $extension,
+            'type'        => 'style',
+            'path'        => $path,
+            'source'      => $source,
+            'destination' => $destination,
+        );
+        if ($this->needUpate($params->source, $params->destination)) {
+            $this->trigger('pre-parse', $params);
+            switch ($params->extension) {
                 case 'styl':
-                    $this->writeWith(new Stylus($source), $destination);
+                    $this->writeWith(new Stylus($params->source), $params->destination);
                     break;
                 case 'less':
-                    $this->writeWith(new Less($source), $destination);
+                    $this->writeWith(new Less($params->source), $params->destination);
                     break;
                 default:
-                    copy($source, $destination);
+                    copy($params->source, $params->destination);
             }
+            $this->trigger('post-parse', $params);
         }
         if ($this->dev) {
-            return $path . '?' . time();
+            return $params->path . '?' . time();
         }
-        $this->css[] = $destination;
+        $this->css[] = $params->destination;
     }
 
-    protected function uglify($language, $path)
+    protected function uglify(&$params)
     {
+        $params->concat = true;
+        $params->minify = true;
+        $language = $params->language;
+        $path = $params->path;
         $outputFile = $language . '/' . $path . '.min.' . $language;
         $uglify = new Uglify($this->$language);
-        $path = $this->path($this->outputDirectory, $outputFile);
-        $uglify->write($this->prepareDirectory($path));
-
-        return $outputFile;
+        $uglify->setModeFromPath($outputFile);
+        $params->outputDirectory = $this->outputDirectory;
+        $params->outputFile = $outputFile;
+        $params->content = $uglify->getResult();
+        $this->trigger('pre-write', $params);
+        $path = $this->path($params->outputDirectory, $params->outputFile);
+        $path = $this->prepareDirectory($path);
+        $params->outputPath = $path;
+        file_put_contents($path, $params->content);
+        $this->trigger('post-write', $params);
     }
 
-    protected function concat($language, $path)
+    protected function concat(&$params)
     {
+        $params->concat = true;
+        $params->minify = false;
+        $language = $params->language;
+        $path = $params->path;
         $outputFile = $language . '/' . $path . '.' . $language;
         $output = '';
         foreach ($this->$language as $path) {
             $output .= file_get_contents($path) . "\n";
         }
-        $path = $this->path($this->outputDirectory, $outputFile);
-        file_put_contents($this->prepareDirectory($path), $output);
-
-        return $outputFile;
+        $params->outputDirectory = $this->outputDirectory;
+        $params->outputFile = $outputFile;
+        $params->content = $output;
+        $this->trigger('pre-write', $params);
+        $path = $this->path($params->outputDirectory, $params->outputFile);
+        $path = $this->prepareDirectory($path);
+        $params->outputPath = $path;
+        file_put_contents($path, $params->content);
+        $this->trigger('post-write', $params);
     }
 
     protected function getOption($option, $defaultValue = null)
@@ -226,6 +274,37 @@ protected function initializeRendering()
         $this->css = array();
     }
 
+    public function on($event, $action)
+    {
+        $event = strtolower(str_replace('-', '', $event));
+
+        if (!isset($this->events[$event])) {
+            $this->events[$event] = array();
+        }
+
+        $this->events[$event][] = $action;
+    }
+
+    public function trigger($event, &$params = null)
+    {
+        $event = strtolower(str_replace('-', '', $event));
+
+        if (!is_object($params)) {
+            $params = (object) (is_array($params) ? $params : array());
+        }
+
+        if (isset($this->events[$event])) {
+            foreach ($this->events[$event] as $action) {
+                if (is_callable($action)) {
+                    $newParams = call_user_func($action, $params, $event, $this);
+                    if (is_object($newParams)) {
+                        $params = $newParams;
+                    }
+                }
+            }
+        }
+    }
+
     public function linkExtractor($href, $rel)
     {
         if ($href && $rel === 'stylesheet') {
@@ -259,27 +338,52 @@ public function __invoke($arguments, $block, $keyword)
             return '';
         }
 
-        $extractor = new BlockExtractor($block);
+        $renderParams = (object) array(
+            'minify'    => !in_array(strtolower(str_replace('-', '', $keyword)), array('concat', 'concatto')),
+            'keyword'   => $keyword,
+            'arguments' => $arguments,
+            'block'     => $block,
+        );
+        $this->trigger('pre-render', $renderParams);
+
+        $extractor = new BlockExtractor($renderParams->block);
         $extractor->registerTagExtractor('link', array($this, 'linkExtractor'), 'href', 'rel');
         $extractor->registerTagExtractor('script', array($this, 'scriptExtractor'), 'src');
         $extractor->extract();
 
         $html = '';
 
         if (count($this->js) || count($this->css)) {
-            $compilation = in_array(strtolower(str_replace('-', '', $keyword)), array('concat', 'concatto'))
-                ? 'concat'
-                : 'uglify';
+            $compilation = $renderParams->minify ? 'uglify' : 'concat';
+            $event = $renderParams->minify ? 'minify' : 'concat';
 
             if (count($this->js)) {
-                $html .= '<script src="' . $this->$compilation('js', $arguments) . '"></script>';
+                $params = (object) array(
+                    'language' => 'js',
+                    'path'     => $renderParams->arguments,
+                );
+                $this->trigger('pre-' . $event, $params);
+                $this->$compilation($params);
+                $this->trigger('post-' . $event, $params);
+
+                $html .= '<script src="' . $params->outputFile . '"></script>';
             }
 
             if (count($this->css)) {
-                $html .= '<link rel="stylesheet" href="' . $this->$compilation('css', $arguments) . '">';
+                $params = (object) array(
+                    'language' => 'css',
+                    'path'     => $renderParams->arguments,
+                );
+                $this->trigger('pre-' . $event, $params);
+                $this->$compilation($params);
+                $this->trigger('post-' . $event, $params);
+
+                $html .= '<link rel="stylesheet" href="' . $params->outputFile . '">';
             }
         }
+        $renderParams->html = $html;
+        $this->trigger('post-render', $renderParams);
 
-        return $html;
+        return $renderParams->html;
     }
 }

tests/MinifyTest.php

@@ -217,4 +217,88 @@ public function testMultipleAssetDirectories()
 
         $this->cleanTempDir();
     }
+
+    /**
+     * @group hooks
+     */
+    public function testHooks()
+    {
+        $this->cleanTempDir();
+        $outputDirectory = $this->getTempDir();
+
+        $pug = new Pug(array(
+            'prettyprint'     => true,
+            'assetDirectory'  => __DIR__,
+            'outputDirectory' => $outputDirectory,
+            'environment'     => 'production',
+        ));
+        $minify = new Minify($pug);
+        $minify->on('pre-write', function ($params) {
+            $params->content = str_replace('42', '43', $params->content);
+
+            return $params;
+        });
+        $minify->on('post-parse', function ($params) {
+            $contents = file_get_contents($params->destination);
+            $contents = str_replace('Hello', 'Bye', $contents);
+            file_put_contents($params->destination, $contents);
+        });
+        $minifications = 0;
+        $customCalled = false;
+        $minify->on('pre-minify', function ($params, $event, $ref) use (&$minifications, &$customCalled) {
+            if ($ref instanceof Minify) {
+                $minifications++;
+            }
+            if (isset($params->custom)) {
+                $customCalled = true;
+            }
+        });
+        $minify->on('post-minify', function ($params) {
+            $params->outputPath .= '.copy';
+
+            return $params;
+        });
+        $minify->on('pre-render', function ($params) {
+            if ($params->arguments === 'top') {
+                $params->arguments = 'up';
+
+                return $params;
+            }
+        });
+        $minify->on('post-render', function ($params) {
+            $params->html .= "\n<!-- Bye -->";
+
+            return $params;
+        });
+        $pug->addKeyword('minify', $minify);
+        $html = static::simpleHtml($pug->render(__DIR__ . '/test-minify.pug'));
+        $expected = static::simpleHtml(file_get_contents(__DIR__ . '/hooks.html'));
+
+        $this->assertSame($expected, $html);
+        $this->assertSame(3, $minifications, 'CSS and JS on the top + JS on the bottom should trigger the pre-minify event 3 times.');
+
+        $file = $outputDirectory . '/js/up.min.js';
+        $javascript = static::fileGetAsset($file);
+        unlink($file);
+        $this->assertSame(static::fileGetAsset(__DIR__ . '/js/up.min.js.copy'), $javascript);
+
+        $file = $outputDirectory . '/js/bottom.min.js';
+        $javascript = static::fileGetAsset($file);
+        unlink($file);
+        $this->assertSame(str_replace('Hello', 'Bye', static::fileGetAsset(__DIR__ . '/js/bottom.min.js')), $javascript);
+
+        $file = $outputDirectory . '/css/up.min.css';
+        $style = static::fileGetAsset($file);
+        unlink($file);
+        $this->assertSame(str_replace('Hello', 'Bye', static::fileGetAsset(__DIR__ . '/css/up.min.css')), $style);
+
+        $this->cleanTempDir();
+
+        $params = array(
+            'custom' => 'foobar',
+        );
+        $this->assertFalse($customCalled, 'Hooks should be callable from outside the rendring.');
+        $minify->trigger('pre-minify', $params);
+        $this->assertTrue($customCalled, 'Hooks should be callable from outside the rendring.');
+    }
 }

tests/css/up.min.css

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Foo</title>
+    <script src="js/up.min.js"></script>
+    <link rel="stylesheet" href="css/up.min.css">
+    <!-- Bye -->
+    <meta name="foo" content="bar">
+  </head>
+  <body>
+    <h1>Foobar</h1>
+    <script src="js/bottom.min.js"></script>
+    <!-- Bye -->
+  </body>
+</html>

tests/hooks.html

@@ -0,0 +1 @@
+console.log("Bye");var cubes,list,math,num,number,opposite,race,square,slice=[].slice;number=43;opposite=true;if(opposite){number=-43}square=function(x){return x*x};list=[1,2,3,4,5];math={root:Math.sqrt,square:square,cube:function(x){return x*square(x)}};race=function(){var runners,winner;winner=arguments[0],runners=2<=arguments.length?slice.call(arguments,1):[];return print(winner,runners)};if(typeof elvis!=="undefined"&&elvis!==null){alert("I knew it!")}cubes=function(){var i,len,results;results=[];for(i=0,len=list.length;i<len;i++){num=list[i];results.push(math.cube(num))}return results}();var dom=React.createElement;ReactDOM.render(dom("h1",null,"Bye,",dom("em",null,"world!"),"  ",dom("button",{className:"btn btn-primary"},"OK")),document.getElementById("main"));