Add twig pattern tfd7 render support

feat(patternkit)

Add support for twig patterns to be rendered with the Twig for Drupal 7
theme engine.

Author: cybtachyon

include/utility.inc

@@ -524,7 +524,8 @@ function _patternkit_merge_js(array $js1, array $js2) {
  * @return array|\PatternkitPattern
  *   Array of metadata objects found or object if specific module requested.
  *
- * @todo Add support for multiple library implementation of a pattern.
+ * @todo Add support for multiple library implementations of a pattern.
+ *   AKA namespacing.
  */
 function _patternkit_get_metadata($subtype = NULL, $reset = FALSE) {
   $metadata = array();

plugins/content_types/patternkit.inc

@@ -420,24 +420,19 @@ function _patternkit_render_block(
   $module,
   $instance_id,
   array $config,
-  array $context = NULL
-) {
-  if (isset($module->subtype)) {
-    $subtype = $module->subtype;
-  }
-  else {
-    return 'MISSING/BROKEN';
-  }
+  array $context = NULL) {
 
-  if ($config['presentation_style'] === 'webcomponent') {
-    $subtype = substr($subtype, 3);
-    $body = "<$subtype-pattern></$subtype-pattern>";
+  $body = 'MISSING/BROKEN';
+  if (!isset($module->subtype)) {
+    return $body;
   }
-  else {
-    $filename = "public://patternkit/$subtype/{$config['instance_id']}/body.html";
-    $body = file_get_contents($filename);
+  $subtype = $module->subtype;
+  $pattern = _patternkit_get_metadata($subtype);
+  if (!$pattern) {
+    return $body;
   }
-  return $body;
+  // @todo Handle context variable replacements.
+  return $pattern->getRenderedMarkup(new PatternkitEditorConfig($config));
 }
 
 /**

src/PatternkitDrupalCachedLib.php

@@ -13,6 +13,19 @@ abstract class PatternkitDrupalCachedLib implements PatternkitLibInterface {
    */
   abstract protected function getRawMetadata();
 
+  /**
+   * Creates a new pattern in this library.
+   *
+   * @param object|array $schema
+   *   Optional JSON Schema to preset the pattern.
+   *
+   * @return \PatternkitPattern
+   *   The new pattern.
+   */
+  public function createPattern($schema = array()) {
+    return new PatternkitPattern($this, $schema);
+  }
+
   /**
    * Utility function to get specified Patternkit module metadata.
    *

src/PatternkitDrupalTwigLib.php

@@ -38,6 +38,8 @@ public function __construct($title, $path) {
    */
   public function fetchPatternAssets(PatternkitPattern $pattern,
     \PatternkitEditorConfig $config) {
+    // @todo Add support for twig lib attachments such as JS and images.
+    $pattern->attachments = array();
     return $pattern;
   }
 
@@ -145,6 +147,7 @@ protected function getRawMetadata() {
       $dirs = explode(DIRECTORY_SEPARATOR, $file_path);
       // All JSON schema must be in an 'api' folder at this time.
       // @todo Add support for custom setups.
+      // @todo Look at a standard for JSON Schema + JSON Sample data.
       $num_dirs = count($dirs);
       if ($num_dirs < 2
         || array_pop($dirs) !== 'api') {
@@ -155,16 +158,16 @@ protected function getRawMetadata() {
         continue;
       }
       if ($file_contents = file_get_contents($file)) {
-        $pattern = new PatternkitPattern(json_decode($file_contents));
-        $pattern->library = &$this;
+        $pattern = $this->createPattern(json_decode($file_contents));
         $file_basename = $file->getBasename('.json');
         $subtype = "pk_$file_basename";
         $pattern->subtype = $subtype;
         $pattern->url = url("patternkit/ajax/$id/$subtype/schema");
         $twig_file = $file_path
           . DIRECTORY_SEPARATOR . $file_basename . '.twig';
         if (file_exists($twig_file)) {
-          $pattern->twig = file_get_contents($twig_file);
+          $pattern->filename = $twig_file;
+          $pattern->template = file_get_contents($twig_file);
         }
         $metadata[$file_basename] = $pattern;
       }
@@ -181,4 +184,25 @@ protected function getRawMetadata() {
     return $metadata;
   }
 
+  /**
+   * Returns rendered markup for a provided pattern.
+   *
+   * @param \PatternkitPattern $pattern
+   *   The pattern to render.
+   * @param \PatternkitEditorConfig $config
+   *   The editor configuration for the pattern.
+   *
+   * @return string
+   *   The rendered pattern HTML.
+   */
+  public function getRenderedPatternMarkup(PatternkitPattern $pattern,
+    PatternkitEditorConfig $config) {
+    if (empty($pattern->filename) || empty($config->fields)) {
+      return '';
+    }
+    $template = $pattern->filename;
+    $variables = $config->fields;
+    return twig_render_template($template, $variables);
+  }
+
 }

src/PatternkitEditorConfig.php

@@ -13,12 +13,11 @@ class PatternkitEditorConfig extends stdClass {
    */
   public function __construct($config = array()) {
     foreach ($config as $property => $value) {
-      if (property_exists($this, $property)) {
+      if (property_exists($this, (string) $property)) {
         $this->{$property} = $value;
         unset($config->{$property});
       }
     }
-    $this->fields->misc_data = !empty($config) ? $config : '';
   }
 
   /**

src/PatternkitLibInterface.php

@@ -5,6 +5,17 @@
  */
 interface PatternkitLibInterface {
 
+  /**
+   * Creates a new pattern in this library.
+   *
+   * @param object|array $schema
+   *   Optional JSON Schema to preset the pattern.
+   *
+   * @return \PatternkitPattern
+   *   The new pattern.
+   */
+  public function createPattern($schema = array());
+
   /**
    * Fetches all assets for a pattern.
    *
@@ -19,6 +30,20 @@ interface PatternkitLibInterface {
   public function fetchPatternAssets(PatternkitPattern $pattern,
     \PatternkitEditorConfig $config);
 
+  /**
+   * Returns rendered markup for a provided pattern.
+   *
+   * @param \PatternkitPattern $pattern
+   *   The pattern to render.
+   * @param \PatternkitEditorConfig $config
+   *   The editor configuration for the pattern.
+   *
+   * @return string
+   *   The rendered pattern HTML.
+   */
+  public function getRenderedPatternMarkup(PatternkitPattern $pattern,
+    PatternkitEditorConfig $config);
+
   /**
    * Returns the id of the Pattern Library.
    *

src/PatternkitPattern.php

@@ -8,27 +8,44 @@ class PatternkitPattern {
   /**
    * PatternkitPattern constructor.
    *
+   * @param \PatternkitLibInterface $library
+   *   The library the pattern belongs to.
+   *
    * @param object|array $schema
    *   An optional JSON Schema object to use.
    */
-  public function __construct($schema = array()) {
+  public function __construct(PatternkitLibInterface $library, $schema = array()) {
     $this->subtype = NULL;
     $this->title = NULL;
     $this->html = NULL;
-    $this->library = NULL;
     $this->version = NULL;
     $this->attachments = NULL;
     $this->schema = $schema;
     if (empty($schema)) {
       return;
     }
     foreach ($schema as $key => $value) {
-      if ($key !== 'schema' && property_exists($this, $key)) {
+      if ($key !== 'schema' && property_exists($this, (string) $key)) {
         $this->{$key} = $value;
       }
     }
+    $this->library = $library;
   }
 
+  /**
+   * The required minimum data for a pattern.
+   *
+   * @ingroup required
+   * @{
+   */
+
+  /**
+   * The Patternkit Library that loaded the pattern.
+   *
+   * @var \PatternkitLibInterface
+   */
+  public $library;
+
   /**
    * The subtype for the pattern. Typically "pk_$pattern".
    *
@@ -46,11 +63,8 @@ public function __construct($schema = array()) {
   public $title;
 
   /**
-   * An override TTL in ms for the pattern.
-   *
-   * @var int
+   * @}
    */
-  public $ttl;
 
   /**
    * Optional array of attached assets.
@@ -83,18 +97,18 @@ public function __construct($schema = array()) {
   public $body;
 
   /**
-   * Pre-rendered HTML using the configuration object, if available.
+   * The pattern template file.
    *
    * @var string
    */
-  public $html;
+  public $filename;
 
   /**
-   * The Patternkit Library that loaded the pattern.
+   * Pre-rendered HTML using the configuration object, if available.
    *
-   * @var \PatternkitLibInterface
+   * @var string
    */
-  public $library;
+  public $html;
 
   /**
    * The JSON Schema for the pattern.
@@ -105,6 +119,22 @@ public function __construct($schema = array()) {
    */
   public $schema;
 
+  /**
+   * Optional pattern template contents.
+   *
+   * Typically Twig or Nunjucks, others include Handlebars and Jinja.
+   *
+   * @var string
+   */
+  public $template;
+
+  /**
+   * An override TTL in ms for the pattern.
+   *
+   * @var int
+   */
+  public $ttl;
+
   /**
    * The API URL for the pattern.
    *
@@ -132,4 +162,17 @@ public function fetchAssets(PatternkitEditorConfig $config) {
     return $this;
   }
 
+  /**
+   * Renders the pattern and returns the generated markup.
+   *
+   * @param \PatternkitEditorConfig $config
+   *   The editor configuration for the pattern.
+   *
+   * @return string
+   *   The rendered HTML pattern markup.
+   */
+  public function getRenderedMarkup(PatternkitEditorConfig $config) {
+    return $this->library->getRenderedPatternMarkup($this, $config);
+  }
+
 }

src/PatternkitRESTLib.php

@@ -142,6 +142,34 @@ public function getId() {
     return 'patternkit_rest_api';
   }
 
+  /**
+   * Returns rendered markup for a provided pattern.
+   *
+   * @param \PatternkitPattern $pattern
+   *   The pattern to render.
+   * @param \PatternkitEditorConfig $config
+   *   The editor configuration for the pattern.
+   *
+   * @return string
+   *   The rendered pattern HTML.
+   */
+  public function getRenderedPatternMarkup(PatternkitPattern $pattern,
+    PatternkitEditorConfig $config) {
+    $subtype = $pattern->subtype;
+    if (empty($config['presentation_style']) || empty($config['instance_id'])) {
+      return '';
+    }
+    if ($config['presentation_style'] === 'webcomponent') {
+      $subtype = substr($subtype, 3);
+      $body = "<$subtype-pattern></$subtype-pattern>";
+    }
+    else {
+      $filename = "public://patternkit/$subtype/{$config['instance_id']}/body.html";
+      $body = file_get_contents($filename);
+    }
+    return $body;
+  }
+
   /**
    * Returns the title of the Pattern Library.
    *