Twig-only rewrite with global data support

aleksip · aleksip · commit 50355e59db7d · 2016-07-02T14:40:07.000+03:00
diff --git a/README.md b/README.md
@@ -1,5 +1,8 @@
 # Data Transform Plugin for Pattern Lab PHP
 
+This plugin now only works with Twig PatternEngine. You can use old 0.x versions of the plugin for Mustache PatternEngine.
+
+
 ## Installation
 
 To install and use the plugin run:
@@ -13,12 +16,12 @@ composer require aleksip/plugin-data-transform
 
 ### Pattern-specific data file support for included patterns
 
-Pattern Lab currently only supports global data files and a pattern-specific data file for the main pattern. This plugin adds pattern-specific data file support for included patterns. This feature only works with Twig PatternEngine.
+Pattern Lab currently only supports global data files and a pattern-specific data file for the main pattern. This plugin adds pattern-specific data file support for included patterns.
 
 
 ### Data transform functions
 
-Currently the plugin provides 3 transform functions for the data read by Pattern Lab. The examples provided are in JSON but Pattern Lab supports YAML too! These functions should work with both Twig and Mustache PatternEngines.
+Currently the plugin provides 3 transform functions for the data read by Pattern Lab. The examples provided are in JSON but Pattern Lab supports YAML too!
 
 
 #### Include pattern files
@@ -87,6 +90,11 @@ The value of `key` will be replaced with the joined strings. Note that in the ex
 The value of `key` will be replaced with an [Attribute object](https://www.drupal.org/node/2513632).
 
 
+## Global data and includes
+
+If you are using global data from the `_data` directory and includes (in data files or Twig templates) please note that 1) pattern-specific data overwrites data from parent patterns by default and that 2) global data for an included pattern is considered to be pattern-specific data. If you want to override pattern-specific data of an included pattern you can do that by using the `with` keyword.
+
+
 ## More examples
 
 All features provided by this plugin are used extensively in [Shila Drupal Theme StarterKit](https://github.com/aleksip/starterkit-shila-drupal-theme).
diff --git a/composer.json b/composer.json
@@ -24,6 +24,7 @@
     },
     "require": {
         "php": ">=5.5.9",
-        "pattern-lab/patternengine-twig": "0.*"
+        "pattern-lab/core": "^2.3.0",
+        "pattern-lab/patternengine-twig": "^2.0.0"
     }
 }
diff --git a/src/aleksip/DataTransformPlugin/DataTransformer.php b/src/aleksip/DataTransformPlugin/DataTransformer.php
@@ -5,58 +5,82 @@
 use Drupal\Core\Template\Attribute;
 use PatternLab\Data;
 use PatternLab\PatternData;
-use PatternLab\PatternData\Helper as PatternDataHelper;
 use PatternLab\PatternEngine;
 
-class Helper extends PatternDataHelper
+class DataTransformer
 {
-    protected $patternLoader;
-    protected $store;
+    protected $env;
     protected $reservedKeys;
+    protected $patternDataStore;
     protected $processed;
 
-    public function __construct($options = array())
+    public function __construct(\Twig_Environment $env)
     {
-        parent::__construct($options);
-        $patternEngineBasePath = PatternEngine::getInstance()->getBasePath();
-        $patternLoaderClass = $patternEngineBasePath . '\Loaders\PatternLoader';
-        $this->patternLoader = new $patternLoaderClass($options);
-        $this->store = PatternData::get();
+        $this->env = $env;
         // TODO: Add an accessor function for $reservedKeys to the Data class?
-        $this->reservedKeys = array("listItems","cacheBuster","patternLink","patternSpecific","patternLabHead","patternLabFoot");
+        $this->reservedKeys = array("cacheBuster","link","patternSpecific","patternLabHead","patternLabFoot");
+        $this->patternDataStore = PatternData::get();
         $this->processed = array();
     }
 
     public function run()
     {
-        foreach (array_keys($this->store) as $patternStoreKey) {
-            $this->processPattern($patternStoreKey);
+        // Process global data.
+        $dataStore = $this->processData(Data::get());
+        Data::replaceStore($dataStore);
+        // Process pattern specific data.
+        foreach (array_keys($this->patternDataStore) as $pattern) {
+            $this->processPattern($pattern);
         }
     }
 
-    protected function isProcessed($patternStoreKey)
+    protected function isProcessed($pattern)
     {
-        return isset($this->processed[$patternStoreKey]);
+        return isset($this->processed[$pattern]);
     }
 
-    protected function setProcessed($patternStoreKey)
+    protected function setProcessed($pattern)
     {
-        $this->processed[$patternStoreKey] = true;
+        $this->processed[$pattern] = true;
     }
 
-    protected function processPattern($patternStoreKey)
+    protected function processPattern($pattern)
     {
-        $patternStoreData = $this->store[$patternStoreKey];
-        if ($patternStoreData["category"] == "pattern" && !$this->isProcessed($patternStoreKey)) {
-            $data = Data::getPatternSpecificData($patternStoreKey);
-            foreach (array_keys($data) as $key) {
-                if (!in_array($key, $this->reservedKeys)) {
-                    $data = $this->processKey($data, $key);
+        if (
+            $this->isProcessed($pattern)
+            || !isset($this->patternDataStore[$pattern])
+            || $this->patternDataStore[$pattern]['category'] != 'pattern'
+        ) {
+            return;
+        }
+        $patternSpecificData =
+            $this->processData(Data::getPatternSpecificData($pattern))
+        ;
+        // Clone objects in possible default global data.
+        $dataStore = Data::get();
+        foreach (array_keys($patternSpecificData) as $key) {
+            if (!isset($dataStore['patternSpecific'][$pattern]['data'][$key])) {
+                // Value is default global data.
+                // TODO: Array support.
+                if (is_object($dataStore[$key])) {
+                    $patternSpecificData[$key] = clone $dataStore[$key];
                 }
             }
-            Data::setPatternData($patternStoreKey, $data);
-            $this->setProcessed($patternStoreKey);
         }
+        Data::initPattern($pattern);
+        Data::setPatternData($pattern, $patternSpecificData);
+        $this->setProcessed($pattern);
+    }
+
+    protected function processData($data)
+    {
+        foreach (array_keys($data) as $key) {
+            if (!in_array($key, $this->reservedKeys)) {
+                $data = $this->processKey($data, $key);
+            }
+        }
+
+        return $data;
     }
 
     protected function processKey($data, $key)
@@ -71,7 +95,7 @@ protected function processKey($data, $key)
             }
             elseif (isset($value['include()']) && is_array($value['include()']) && isset($value['include()']['pattern'])) {
                 $pattern = $value['include()']['pattern'];
-                if (is_string($pattern) && isset($this->store[$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);
@@ -96,14 +120,14 @@ protected function processKey($data, $key)
                 $data[$key] = $value;
             }
         }
-        elseif (is_string($value) && isset($this->store[$value]) && $key !== 'pattern') {
+        elseif (is_string($value) && isset($this->patternDataStore[$value]) && $key !== 'pattern') {
             $data[$key] = $this->renderPattern($value, $this->getProcessedPatternSpecificData($value));
         }
 
         return $data;
     }
 
-    protected function getProcessedPatternSpecificData($pattern, $extraData = array())
+    public function getProcessedPatternSpecificData($pattern, $extraData = array())
     {
         $this->processPattern($pattern);
 
@@ -112,11 +136,11 @@ protected function getProcessedPatternSpecificData($pattern, $extraData = array(
 
     protected function renderPattern($pattern, $data)
     {
-        if (isset($this->store[$pattern]['patternRaw'])) {
-            $pattern = $this->patternLoader->render([
-                'pattern' => $this->store[$pattern]['patternRaw'],
-                'data' => $data
-            ]);
+        if (isset($this->patternDataStore[$pattern]['patternRaw'])) {
+            $pattern = $this->env->render(
+                $this->patternDataStore[$pattern]['patternRaw'],
+                $data
+            );
         }
 
         return $pattern;
diff --git a/src/aleksip/DataTransformPlugin/PatternLabListener.php b/src/aleksip/DataTransformPlugin/PatternLabListener.php
@@ -4,28 +4,24 @@
 
 use aleksip\DataTransformPlugin\Twig\PatternDataNodeVisitor;
 use PatternLab\Listener;
-use PatternLab\PatternData\Event;
 use PatternLab\PatternEngine\Twig\TwigUtil;
 
 class PatternLabListener extends Listener
 {
     public function __construct()
     {
-        $this->addListener('patternData.codeHelperStart', 'runHelper');
-        $this->addListener('twigPatternLoader.customize', 'addNodeVisitor');
+        $this->addListener(
+            'twigPatternLoader.customize',
+            'twigPatternLoaderCustomize'
+        );
     }
 
-    public function runHelper(Event $event)
+    public function twigPatternLoaderCustomize()
     {
-        $options = $event->getOptions();
-        $helper = new Helper($options);
-        $helper->run();
-    }
-
-    public function addNodeVisitor()
-    {
-        $instance = TwigUtil::getInstance();
-        $instance->addNodeVisitor(new PatternDataNodeVisitor());
-        TwigUtil::setInstance($instance);
+        $env = TwigUtil::getInstance();
+        $dt = new DataTransformer($env);
+        $env->addNodeVisitor(new PatternDataNodeVisitor($dt));
+        TwigUtil::setInstance($env);
+        $dt->run();
     }
 }
diff --git a/src/aleksip/DataTransformPlugin/Twig/PatternDataNodeVisitor.php b/src/aleksip/DataTransformPlugin/Twig/PatternDataNodeVisitor.php
@@ -2,10 +2,17 @@
 
 namespace aleksip\DataTransformPlugin\Twig;
 
-use PatternLab\Data;
+use aleksip\DataTransformPlugin\DataTransformer;
 
 class PatternDataNodeVisitor extends \Twig_BaseNodeVisitor
 {
+    protected $dt;
+
+    public function __construct(DataTransformer $dt)
+    {
+        $this->dt = $dt;
+    }
+
     protected function doEnterNode(\Twig_Node $node, \Twig_Environment $env)
     {
         return $node;
@@ -16,7 +23,7 @@ protected function doLeaveNode(\Twig_Node $node, \Twig_Environment $env)
         if ($node instanceof \Twig_Node_Include) {
             if ($node->hasNode('expr') && $node->getNode('expr')->hasAttribute('value')) {
                 $patternStoreKey = $node->getNode('expr')->getAttribute('value');
-                $data = Data::getPatternSpecificData($patternStoreKey);
+                $data = $this->dt->getProcessedPatternSpecificData($patternStoreKey);
                 if ($node instanceof \Twig_Node_Embed) {
                     $dataNode = new PatternDataEmbedNode($node, $data);
                 }

Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,7 @@`
`24`	`24`	`},`
`25`	`25`	`"require": {`
`26`	`26`	`"php": ">=5.5.9",`
`27`		`- "pattern-lab/patternengine-twig": "0.*"`
	`27`	`+ "pattern-lab/core": "^2.3.0",`
	`28`	`+ "pattern-lab/patternengine-twig": "^2.0.0"`
`28`	`29`	`}`
`29`	`30`	`}`