Refactor to use new classes, improve error handling and messages

Author: aleksip

src/aleksip/DataTransformPlugin/DataTransformer.php

@@ -4,30 +4,26 @@
 
 use Drupal\Core\Template\Attribute;
 use Drupal\Core\Url;
-use PatternLab\Console;
 use PatternLab\Data;
 use PatternLab\PatternData;
 
-class PatternNotFoundException extends \Exception {}
-
 /**
  * @author Aleksi Peebles <[email protected]>
  */
 class DataTransformer
 {
+    use ErrorHandlerTrait;
+
     protected static $processed = array();
 
-    protected $verbose;
     protected $reservedKeys;
     protected $patternDataStore;
     protected $renderer;
     protected $hasRun;
     protected $currentPattern;
-    protected $renderError;
 
-    public function __construct($verbose = false)
+    public function __construct()
     {
-        $this->verbose = $verbose;
         // TODO: Add an accessor function for $reservedKeys to the Data class?
         $this->reservedKeys = array("cacheBuster","link","patternSpecific","patternLabHead","patternLabFoot");
         $this->patternDataStore = PatternData::get();
@@ -48,9 +44,7 @@ public function run(Renderer $renderer)
             $this->processPattern($pattern);
         }
         $this->hasRun = true;
-        if ($this->verbose) {
-            Console::writeInfo('[data transform plugin] processing done...');
-        }
+        DataTransformPlugin::writeInfo('processing done');
     }
 
     protected function isProcessed($pattern)
@@ -73,33 +67,31 @@ protected function processPattern($pattern)
             return;
         }
         $this->setProcessed($pattern);
-        try {
-            $patternSpecificData =
-              $this->processData(Data::getPatternSpecificData($pattern));
+        DataTransformPlugin::writeInfo("processing pattern '$pattern'");
+        $patternSpecificData =
+          $this->processData(Data::getPatternSpecificData($pattern));
 
 
-            $dataStore = Data::get();
-            foreach (array_keys($patternSpecificData) as $key) {
-              if (!isset($dataStore['patternSpecific'][$pattern]['data'][$key])) {
-                // Value is default global data.
-                if (isset($dataStore[$key]) && is_object($dataStore[$key])) {
-                  $patternSpecificData[$key] = clone $dataStore[$key];
-                }
-              }
+        $dataStore = Data::get();
+        foreach (array_keys($patternSpecificData) as $key) {
+          if (!isset($dataStore['patternSpecific'][$pattern]['data'][$key])) {
+            // Value is default global data.
+            if (isset($dataStore[$key]) && is_object($dataStore[$key])) {
+              $patternSpecificData[$key] = clone $dataStore[$key];
             }
-            Data::initPattern($pattern);
-            Data::setPatternData($pattern, $patternSpecificData);
-        }
-        catch (PatternNotFoundException $exception) {
-            throw new PatternNotFoundException("Pattern '$pattern': " . $exception->getMessage());
+          }
         }
+        Data::initPattern($pattern);
+        Data::setPatternData($pattern, $patternSpecificData);
     }
 
     protected function processData($data)
     {
         foreach (array_keys($data) as $key) {
             if (!in_array($key, $this->reservedKeys)) {
+                $this->setErrorHandler();
                 $data = $this->processKey($data, $key);
+                $this->restoreErrorHandler("error processing key '$key'");
             }
         }
 
@@ -115,43 +107,53 @@ protected function processKey($data, $key)
             }
             if (isset($value['Attribute()']) && is_array($value['Attribute()'])) {
                 $data[$key] = new Attribute($value['Attribute()']);
+                DataTransformPlugin::writeInfo('created Attribute object', true);
             }
             elseif (isset($value['Url()']['url'])) {
               $options = isset($value['Url()']['options']) && is_array($value['Url()']['options']) ? $value['Url()']['options'] : [];
               $data[$key] = Url::fromUri($value['Url()']['url'], $options);
+                DataTransformPlugin::writeInfo('created Url object', true);
             }
             elseif (isset($value['include()']) && is_array($value['include()']) && isset($value['include()']['pattern'])) {
                 $pattern = $value['include()']['pattern'];
-                if (is_string($pattern) && isset($this->patternDataStore[$pattern])) {
-                    if (!isset($value['include()']['with']) || !is_array($value['include()']['with'])) {
-                        if (!isset($value['include()']['only'])) {
-                            $patternData = $this->getProcessedPatternSpecificData($pattern);
+                if (is_string($pattern)) {
+                    if (isset($this->patternDataStore[$pattern])) {
+                        if (!isset($value['include()']['with']) || !is_array($value['include()']['with'])) {
+                            if (!isset($value['include()']['only'])) {
+                                $patternData = $this->getProcessedPatternSpecificData($pattern);
+                            }
+                            else {
+                                $patternData = array();
+                            }
+                        }
+                        elseif (!isset($value['include()']['only'])) {
+                            $patternData = $this->getProcessedPatternSpecificData($pattern, $value['include()']['with']);
                         }
                         else {
-                            $patternData = array();
+                            $patternData = $value['include()']['with'];
                         }
-                    }
-                    elseif (!isset($value['include()']['only'])) {
-                        $patternData = $this->getProcessedPatternSpecificData($pattern, $value['include()']['with']);
+                        $data[$key] = $this->renderPattern($pattern, $patternData);
+                        DataTransformPlugin::writeInfo("included pattern '$pattern'", true);
                     }
                     else {
-                        $patternData = $value['include()']['with'];
+                        DataTransformPlugin::writeWarning("could not find '$pattern' to include", DataTransformPlugin::isVerbose());
                     }
-                    $data[$key] = $this->renderPattern($pattern, $patternData);
                 }
                 else {
-                  throw new PatternNotFoundException("Could not find pattern '$pattern' to include!");
+                    DataTransformPlugin::writeWarning('include() pattern key value was not a string', DataTransformPlugin::isVerbose());
                 }
             }
             elseif (isset($value['join()']) && is_array($value['join()'])) {
                 $data[$key] = join($value['join()']);
+                DataTransformPlugin::writeInfo("joined data under key '$key'", true);
             }
             else {
                 $data[$key] = $value;
             }
         }
         elseif (is_string($value) && isset($this->patternDataStore[$value]) && $key !== 'pattern') {
             $data[$key] = $this->renderPattern($value, $this->getProcessedPatternSpecificData($value));
+            DataTransformPlugin::writeInfo("included pattern '$value'", true);
         }
 
         return $data;
@@ -164,31 +166,17 @@ public function getProcessedPatternSpecificData($pattern, $extraData = array())
         return Data::getPatternSpecificData($pattern, $extraData);
     }
 
-    public function renderErrorHandler($errno, $errstr) {
-        $this->renderError = $errstr;
-
-        return TRUE;
-    }
-
     protected function renderPattern($pattern, $data)
     {
         $rendered = '';
         if (isset($this->patternDataStore[$pattern]['patternRaw'])) {
             foreach (array_keys($data) as $key) {
                 $data = $this->cloneObjects($data, $key);
             }
-            $this->renderError = NULL;
-            set_error_handler(array($this, 'renderErrorHandler'));
             $rendered = $this->renderer->render(
                 $this->patternDataStore[$pattern]['patternRaw'],
                 $data
             );
-            restore_error_handler();
-            if (isset($this->renderError)) {
-                Console::writeWarning('[data transform plugin] pattern ' . $this->currentPattern);
-                Console::writeWarning('error rendering ' . $pattern, true);
-                Console::writeWarning($this->renderError, true);
-            }
         }
 
         return $rendered;

src/aleksip/DataTransformPlugin/PatternLabListener.php

@@ -3,8 +3,8 @@
 namespace aleksip\DataTransformPlugin;
 
 use aleksip\DataTransformPlugin\Twig\PatternDataNodeVisitor;
+use aleksip\DataTransformPlugin\Twig\TwigEnvironmentDecorator;
 use PatternLab\Config;
-use PatternLab\Console;
 use PatternLab\Listener;
 use PatternLab\PatternEngine;
 use PatternLab\PatternEngine\Twig\TwigUtil;
@@ -23,58 +23,40 @@ public function __construct()
     {
         $this->addListener('patternData.codeHelperStart', 'dataTransformer');
         $this->addListener('twigPatternLoader.customize', 'addNodeVisitor', -99);
-        if ($this->isVerbose()) {
-            Console::writeLine('[data transform plugin] listeners added...');
-        }
+        DataTransformPlugin::writeInfo('listeners added');
     }
 
     public function dataTransformer()
     {
-        if (!$this->isEnabled()) {
+        if (!DataTransformPlugin::isEnabled()) {
             return;
         }
 
-        $this->dataTransformer = new DataTransformer($this->isVerbose());
+        $this->dataTransformer = new DataTransformer();
 
         if (Config::getOption('patternExtension') !== 'twig') {
             $patternEngineBasePath = PatternEngine::getInstance()->getBasePath();
             $patternLoaderClass = $patternEngineBasePath.'\Loaders\PatternLoader';
-            $patternLoader = new $patternLoaderClass(array());
+            $patternLoader = new $patternLoaderClass([]);
             $this->dataTransformer->run(new Renderer($patternLoader));
         }
     }
 
     public function addNodeVisitor()
     {
-        if (!$this->isEnabled()) {
+        if (!DataTransformPlugin::isEnabled()) {
             return;
         }
 
         $nodeVisitor = new PatternDataNodeVisitor($this->dataTransformer);
 
         $env = TwigUtil::getInstance();
+        if (DataTransformPlugin::isVerbose()) {
+            $env = new TwigEnvironmentDecorator($env);
+        }
         $env->addNodeVisitor($nodeVisitor);
         TwigUtil::setInstance($env);
 
         $this->dataTransformer->run(new Renderer($env));
     }
-
-    protected function isEnabled()
-    {
-        $enabled = Config::getOption('plugins.dataTransform.enabled');
-        $enabled = (is_null($enabled) || (bool)$enabled);
-
-        if ($this->isVerbose() && !$enabled) {
-            Console::writeLine('[data transform plugin] plugin is disabled...');
-        }
-
-        return $enabled;
-    }
-
-    protected function isVerbose()
-    {
-        $verbose = Config::getOption('plugins.dataTransform.verbose');
-
-        return (!is_null($verbose) && (bool)$verbose);
-    }
 }

src/aleksip/DataTransformPlugin/Renderer.php

@@ -2,6 +2,8 @@
 
 namespace aleksip\DataTransformPlugin;
 
+use aleksip\DataTransformPlugin\Twig\TwigEnvironmentDecorator;
+
 /**
  * @author Aleksi Peebles <[email protected]>
  */
@@ -16,7 +18,7 @@ public function __construct($renderer)
 
     public function render($pattern, $data = array())
     {
-        if ($this->renderer instanceof \Twig_Environment) {
+        if ($this->renderer instanceof \Twig_Environment || $this->renderer instanceof TwigEnvironmentDecorator) {
             return $this->renderer->render($pattern, $data);
         }
         else {