Merge pull request #1 from cybtachyon/feature/jassmith/RefactorTwigLib

Refactored to use twig from library folder

Author: cybtachyon

README.md

@@ -9,12 +9,52 @@ When pattern configurations are saved, the template is downloaded locally (to mi
 
 Rendered twigs may contain drupal tokens, which are then processed in context.
 
+## Installation
+Install the patternkit module as usual, and review the important variables below to determine if you would like to change the defaults.
+
+Install the Twig library into /sites/all/libraries/Twig
+```
+git clone git://github.com/twigphp/Twig.git -b 1.x /tmp/Twig
+mv /tmp/Twig/lib/Twig ${DRUPALDIR}/sites/all/libraries/
+rm -rf /tmp/Twig
+```
+
+The patternkit module by itself only provides the glue for other modules to present components. Define one by implementing ```hook_patternkit_library```
+
+An example implementation follows
+```
+/**
+ * Implements hook_patternkit_library().
+ */
+function webrh_patternkit_library() {
+  $libraries = array();
+
+  $namespaces = array(
+    'Web RH Patterns' => 'webrh/src/library',
+  );
+
+  $module_path = drupal_get_path('module', 'webrh');
+  foreach ($namespaces as $namespace => $path) {
+    $lib_path = $module_path . DIRECTORY_SEPARATOR . $path;
+    $libraries[] = new PatternkitDrupalTwigLib($namespace, $lib_path);
+  }
+
+  return $libraries;
+}
+```
+
+There are two different plugins currently available, 
+* PatternkitRESTLib
+* PatternkitDrupalTwigLib
+
+Use the former for dynamic REST based components, and the latter for locally sourced.
+
 ## Important Variables
-* patternkit_cache_enabled - Whether or not the metadata and render cache are enabled. (Disable during development)
-* patternkit_pl_host - The scheme://hostname:port/ of the PatternLab library host.
-* patternkit_default_module_ttl - How long the rendered pattern should be cached.
-* patternkit_show_errors - Whether or not to display messages on the site.
-* patternkit_log_errors - Whether or not to log errors to php error log. 
+* ```patternkit_cache_enabled``` - Whether or not the metadata and render cache are enabled. (Disable during development)
+* ```patternkit_pl_host``` - The scheme://hostname:port/ of the PatternLab library host.
+* ```patternkit_default_module_ttl``` - How long the rendered pattern should be cached.
+* ```patternkit_show_errors``` - Whether or not to display messages on the site.
+* ```patternkit_log_errors``` - Whether or not to log errors to php error log. 
 
 ## TODOs
 * https://github.com/drupal-pattern-lab/roadmap/issues/8 Solve the problem of mapping Drupal fields to pattern Variables.

include/utility.inc

@@ -5,7 +5,6 @@
  * Utility functions for Patternkit.
  */
 
-
 /**
  * Fetch and cache assets to render this pattern.
  *

lib/example.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "category": "atom",
+  "title": "Example",
+  "type": "object",
+  "format": "grid",
+  "properties": {
+    "text": {
+      "title": "Text",
+      "type": "string",
+      "options": {
+        "grid_columns": 4
+      }
+    }
+  }
+}

lib/example.twig

@@ -0,0 +1,2 @@
+Test sample twig template.
+{{- string|striptags('')|raw -}}

patternkit.info

@@ -1,12 +1,16 @@
-name="Patternkit"
-description="Adds Patternkit patterns to panels as content types."
-package="Presentation Framework"
-core=7.x
+name        = "Patternkit"
+description = "Adds Patternkit patterns to panels as content types."
+package     = "Presentation Framework"
+core        = 7.x
+version     = 7.x-1.1
+
 dependencies[] = ctools
 dependencies[] = panels
+
 files[] = src/PatternkitDrupalCachedLib.php
 files[] = src/PatternkitDrupalTwigLib.php
 files[] = src/PatternkitEditorConfig.php
 files[] = src/PatternkitLibInterface.php
+files[] = src/PatternkitTwigWrapper.php
 files[] = src/PatternkitPattern.php
 files[] = src/PatternkitRESTLib.php

patternkit.module

@@ -69,18 +69,41 @@ function patternkit_flush_metadata_cache() {
  *   An array of Pattern Kit Library objects.
  */
 function patternkit_pattern_libraries() {
-  // @todo Add caching.
-  return module_invoke_all('patternkit_library');
+  static $libraries;
+
+  // If undefined, create the libraries metadata.
+  if (is_null($libraries)) {
+    if ($cache = cache_get('patternkit_libraries')) {
+      $libraries = $cache->data;
+    }
+    else {
+      $libraries = module_invoke_all('patternkit_library');
+
+      if (!empty($libraries)) {
+        // Cache for one day.
+        cache_set('patternkit_library', $libraries, time() + 60 * 60 * 24);
+      }
+    }
+  }
+
+  // Triggers initialization of the Twig wrapper.
+  PatternkitTwigWrapper::getInstance($libraries);
+
+  return $libraries;
 }
 
 /**
  * Implements hook_patternkit_library().
  */
 function patternkit_patternkit_library() {
-  // @todo Replace with a Service that calls a Factory.
-  $rest_lib = new PatternkitRESTLib();
-  $libraries = array($rest_lib);
-  /** @var object $theme */
+  $libraries = array();
+
+  // Load patterns from this module for testing.
+  $module_path = drupal_get_path('module', 'patternkit');
+  $lib_path = $module_path . DIRECTORY_SEPARATOR . 'lib';
+  $libraries[] = new PatternkitDrupalTwigLib('Example', $lib_path);
+
+  // Load patterns from themes exposing namespaces.
   foreach (list_themes() as $theme_name => $theme) {
     if ($theme->engine !== 'twig' || !isset($theme->info['namespaces'])) {
       continue;

src/PatternkitDrupalCachedLib.php

@@ -65,13 +65,15 @@ public function getCachedMetadata($subtype = NULL, $reset = FALSE) {
     // If we are requesting data for a specific module type, return just
     // that data.
     if ($subtype !== NULL && strtolower($subtype) !== 'none') {
-      $lookup = substr($subtype, 3);
-      if (!empty($cached_metadata[strtolower($lookup)])) {
-        return $cached_metadata[strtolower($lookup)];
+      if (substr($subtype, 0, 3) == 'pk_') {
+        $subtype = substr($subtype, 3);
+      }
+      if (!empty($cached_metadata[strtolower($subtype)])) {
+        return $cached_metadata[strtolower($subtype)];
       }
       _patternkit_show_error(
         'Patternkit module does not appear to exist (%module), verify module info/usage.',
-        array('%module' => $lookup)
+        array('%module' => $subtype)
       );
 
       return NULL;