Issue #2945643 by cyb.tachyon, jlovato, Silicon.Valet: Drupal 8 Port

Author: cyb.tachyon

js/twigeditor.js

@@ -1,3 +1,14 @@
+/**
+ * @file
+ * Provides Twig Pattern Library Editing Functionality.
+ *
+ * @external Drupal
+ *
+ * @external jQuery
+ *
+ * @external JSONEditor
+ */
+
 (function ($, Drupal) {
   Drupal.behaviors.patternkitEditor = {
     attach: function (context, settings) {

modules/patternkit_example/lib/patternkit/Gulpfile.js

@@ -1,6 +1,6 @@
 /**
  * @file
- * Gulp theme compilation script for rhc_ops_ui.
+ * Gulp theme compilation script for patternkit_example.
  */
 
 /* eslint-env node */
@@ -58,7 +58,7 @@ options.tslint = {
 
 options.styleguide = {
   builder: 'node_modules/kss/builder/twig',
-  namespace: 'rhcOpsLib:' + options.theme.patterns,
+  namespace: 'patternkit:' + options.theme.patterns,
   source: [
     options.theme.patterns
   ],
@@ -67,7 +67,7 @@ options.styleguide = {
   // The css and js paths are URLs, like '/misc/jquery.js'.
   // The following paths are relative to the generated style guide.
   css: [
-    path.relative(options.paths.styleguide, options.theme.css + '/rhc_ops_ui.css'),
+    path.relative(options.paths.styleguide, options.theme.css + '/patternkit.css'),
     path.relative(options.paths.styleguide, options.theme.css + '/patternfly.min.css'),
     path.relative(options.paths.styleguide, options.theme.css + '/patternfly-additions.min.css')
   ],
@@ -91,7 +91,7 @@ options.styleguide = {
     path.relative(options.paths.styleguide, options.theme.js + '/patternfly-functions.min.js'),
     path.relative(options.paths.styleguide, options.theme.js + '/patternfly-settings.min.js')
   ],
-  title: 'RHC Ops UI Style Guide'
+  title: 'Patternkit UI Style Guide'
 };
 
 options.gulpWatchOptions = {};

src/Pattern.php

@@ -2,6 +2,9 @@
 
 namespace Drupal\patternkit;
 
+use function is_string;
+use function PHPSTORM_META\type;
+
 /**
  * A collection of a JSON schema and renderable markup.
  *
@@ -11,35 +14,6 @@
  */
 class Pattern {
 
-  /**
-   * PatternkitPattern constructor.
-   *
-   * @param string $name
-   *   The name of the pattern.
-   * @param object|array $schema
-   *   An optional JSON Schema object to use.
-   */
-  public function __construct($name, $schema = NULL) {
-    $this->name        = $name;
-    $this->category    = 'default';
-    $this->title       = NULL;
-    $this->html        = NULL;
-    $this->version     = NULL;
-    $this->attachments = NULL;
-    $this->schema      = $schema;
-
-    // If schema is undefined, initialize empty.
-    if (empty($schema)) {
-      return;
-    }
-
-    // Walk the provided schemas and generate the pattern.
-    foreach ($schema as $key => $value) {
-      if ($key !== 'schema' && property_exists($this, (string) $key)) {
-        $this->{$key} = $value;
-      }
-    }
-  }
 
   /**
    * The required minimum data for a pattern.
@@ -161,6 +135,36 @@ public function __construct($name, $schema = NULL) {
    */
   protected $libraryPluginId;
 
+  /**
+   * PatternkitPattern constructor.
+   *
+   * @param string $name
+   *   The name of the pattern.
+   * @param object|array $schema
+   *   An optional JSON Schema object to use.
+   */
+  public function __construct($name, $schema = NULL) {
+    $this->name        = $name;
+    $this->category    = 'default';
+    $this->title       = NULL;
+    $this->html        = NULL;
+    $this->version     = NULL;
+    $this->attachments = NULL;
+    $this->schema      = $schema;
+
+    // If schema is undefined, initialize empty.
+    if (empty($schema)) {
+      return;
+    }
+
+    // Walk the provided schemas and generate the pattern.
+    foreach ($schema as $key => $value) {
+      if ($key !== 'schema' && property_exists($this, (string) $key)) {
+        $this->{$key} = $value;
+      }
+    }
+  }
+
   /**
    * Returns the pattern description.
    *
@@ -188,7 +192,7 @@ public function getId(): string {
    *   The label of the pattern.
    */
   public function getLabel(): string {
-    return !empty($this->title) ? $this->title : $this->name;
+    return !empty($this->title) && is_string($this->title) ? $this->title : $this->name;
   }
 
   /**

src/PatternLibraryParser/TwigPatternLibraryParser.php

@@ -9,11 +9,6 @@
 use Drupal\patternkit\Pattern;
 use Drupal\patternkit\PatternEditorConfig;
 use Drupal\patternkit\PatternLibraryParserBase;
-use function dump;
-use function file_exists;
-use function get_call_stack;
-use function kint_trace;
-use function strlen;
 use Symfony\Component\Finder\Iterator\RecursiveDirectoryIterator;
 
 /**
@@ -163,11 +158,6 @@ public function parseLibraryInfo($library, $path, array $library_data = []): arr
       if (!empty($data['json']) && $file_contents = file_get_contents($data['json'])) {
         $pattern = $this->createPattern($name, (array) $this->serializer::decode($file_contents) + $library_data);
         $pattern->name = $name;
-        // URL is redundant for the twig based components, so we use it to
-        // store namespace.
-        $pattern->url = $library;
-        // @todo add default of library version fallback to extension version.
-        $pattern->version = $pattern->version ?? 'VERSION';
       }
       else {
         // Create the pattern from defaults.
@@ -190,6 +180,11 @@ public function parseLibraryInfo($library, $path, array $library_data = []): arr
         if (file_exists($twig_file)) {
           $pattern->filename = trim(substr($twig_file, strlen($path)), '/\\');
           $pattern->template = file_get_contents($twig_file);
+          // URL is redundant for the twig based components, so we use it to
+          // store namespace.
+          $pattern->url = $library;
+          // @todo add default of library version fallback to extension version.
+          $pattern->version = $pattern->version ?? 'VERSION';
         }
       }
 

src/Plugin/PatternLibrary/PatternLibraryTwig.php

@@ -9,6 +9,9 @@
 use Drupal\patternkit\PatternEditorConfig;
 use Drupal\patternkit\PatternLibraryParser\TwigPatternLibraryParser;
 use Drupal\patternkit\PatternLibraryPluginDefault;
+use function print_r;
+use function strchr;
+use function strlen;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
 /**
@@ -97,7 +100,13 @@ public static function create(ContainerInterface $container, array $configuratio
   public function getEditor(Pattern $pattern = NULL,
     PatternEditorConfig $config = NULL) {
     $hostname = $_SERVER['HTTP_HOST'];
-    $pattern_schema = $pattern ? $pattern->schema : new \stdClass();
+    $pattern_schema = $pattern->schema ?? new \stdClass();
+    if (empty($pattern_schema['properties'])) {
+      $filename = $pattern->filename ?? '';
+      $filename = substr($filename, 0, -(int) strrchr($filename, '.'));
+      $this->messenger()->addStatus($this->t('You need to manually add pattern fields since none were found in a proper JSON Schema properties value in @filename.json.',
+        ['@filename' => $filename]));
+    }
     $schema_json = $this->serializer::encode($pattern_schema);
     $starting_json = $config !== NULL
       ? $this->serializer::encode($config->fields)
@@ -154,9 +163,10 @@ public function getMetadata(Extension $extension, $library, $path): array {
   public function render(array $assets): array {
     $elements = [];
     foreach ($assets as $pattern) {
-      if (empty($pattern->filename) || empty($pattern->config)) {
+      if (empty($pattern->filename)) {
         return [];
       }
+      // @todo Allow filename to cache the template contents based on settings.
       $template = $pattern->filename;
       // Add the namespace, if provided.
       if (!empty($pattern->url)) {
@@ -172,7 +182,7 @@ public function render(array $assets): array {
       /** @var \Drupal\Core\Template\TwigEnvironment $twig */
       $twig       = \Drupal::service('twig');
       $template   = $twig->load("$namespace/$pattern->filename");
-      $elements[] = $template->render($pattern->config);
+      $elements[] = $template->render($pattern->config ?? []);
     }
     return $elements;
   }