From 3624e0bc1abf96b19708dc2158cb032b41afbe48 Mon Sep 17 00:00:00 2001
From: ebremner <ebremner@uwaterloo.ca>
Date: Tue, 22 Dec 2020 16:11:32 -0500
Subject: [PATCH] ISTWCMS-4487: adding gesso helper
---
gesso_helper/composer.json | 21 ++
gesso_helper/drush.services.yml | 5 +
gesso_helper/gesso_helper.info.yml | 9 +
gesso_helper/gesso_helper.services.yml | 6 +
.../src/Commands/GessoHelperCommands.php | 216 ++++++++++++++++++
.../TwigExtension/GessoExtensionAdapter.php | 31 +++
.../TwigExtension/GessoExtensionLoader.php | 56 +++++
7 files changed, 344 insertions(+)
create mode 100644 gesso_helper/composer.json
create mode 100644 gesso_helper/drush.services.yml
create mode 100644 gesso_helper/gesso_helper.info.yml
create mode 100644 gesso_helper/gesso_helper.services.yml
create mode 100644 gesso_helper/src/Commands/GessoHelperCommands.php
create mode 100644 gesso_helper/src/TwigExtension/GessoExtensionAdapter.php
create mode 100644 gesso_helper/src/TwigExtension/GessoExtensionLoader.php
diff --git a/gesso_helper/composer.json b/gesso_helper/composer.json
new file mode 100644
index 00000000..e2d5c690
--- /dev/null
+++ b/gesso_helper/composer.json
@@ -0,0 +1,21 @@
+{
+ "name": "forumone/gesso_helper",
+ "description": "Provides additional functionality for the Gesso theme.",
+ "type": "drupal-drush",
+ "authors": [
+ {
+ "name": "Forum One",
+ "email": "author@example.com"
+ }
+ ],
+ "require": {
+ "php": ">=5.6.0"
+ },
+ "extra": {
+ "drush": {
+ "services": {
+ "drush.services.yml": "^9"
+ }
+ }
+ }
+}
diff --git a/gesso_helper/drush.services.yml b/gesso_helper/drush.services.yml
new file mode 100644
index 00000000..f1db4168
--- /dev/null
+++ b/gesso_helper/drush.services.yml
@@ -0,0 +1,5 @@
+services:
+ gesso_helper.commands:
+ class: \Drupal\gesso_helper\Commands\GessoHelperCommands
+ tags:
+ - { name: drush.command }
diff --git a/gesso_helper/gesso_helper.info.yml b/gesso_helper/gesso_helper.info.yml
new file mode 100644
index 00000000..080abf6f
--- /dev/null
+++ b/gesso_helper/gesso_helper.info.yml
@@ -0,0 +1,9 @@
+name: Gesso Helper
+description: Provides additional functionality for the Gesso theme
+type: module
+core_version_requirement: ^8 || ^9
+
+# Information added by drupal-composer/info-rewrite; date of revision: 2020-12-22T18:23:54+00:00.
+version: '8.x-1.x-ISTWCMS-4487-ebremner-relocate-gesso'
+project: 'uw_fdsu_theme_resp'
+datestamp: 1608661434
diff --git a/gesso_helper/gesso_helper.services.yml b/gesso_helper/gesso_helper.services.yml
new file mode 100644
index 00000000..b4464936
--- /dev/null
+++ b/gesso_helper/gesso_helper.services.yml
@@ -0,0 +1,6 @@
+services:
+ gesso_helper.gesso_twig_extension:
+ arguments: ['@renderer']
+ class: Drupal\gesso_helper\TwigExtension\GessoExtensionAdapter
+ tags:
+ - { name: twig.extension }
diff --git a/gesso_helper/src/Commands/GessoHelperCommands.php b/gesso_helper/src/Commands/GessoHelperCommands.php
new file mode 100644
index 00000000..ba6a1e7b
--- /dev/null
+++ b/gesso_helper/src/Commands/GessoHelperCommands.php
@@ -0,0 +1,216 @@
+<?php
+
+/**
+ * @file
+ * Gesso helper commands.
+ *
+ * phpcs:ignoreFile
+ */
+
+namespace Drupal\gesso_helper\Commands;
+
+use Consolidation\SiteAlias\SiteAliasManagerAwareInterface;
+use Consolidation\SiteAlias\SiteAliasManagerAwareTrait;
+use Drush\Drush;
+use Drush\Commands\DrushCommands;
+use Webmozart\PathUtil\Path;
+
+/**
+ * A Drush commandfile.
+ *
+ * In addition to this file, you need a drush.services.yml
+ * in root of your module, and a composer.json file that provides the name
+ * of the services file to use.
+ *
+ * See these files for an example of injecting Drupal services:
+ * - http://cgit.drupalcode.org/devel/tree/src/Commands/DevelCommands.php
+ * - http://cgit.drupalcode.org/devel/tree/drush.services.yml
+ */
+class GessoHelperCommands extends DrushCommands implements SiteAliasManagerAwareInterface {
+
+ use SiteAliasManagerAwareTrait;
+
+ /**
+ * Create a new theme based on the Gesso theme.
+ *
+ * @param $name
+ * The name of your theme.
+ * @param array $options
+ * An associative array of options whose values come from cli, aliases, config, etc.
+ * @option description
+ * A short description of your new theme.
+ * @option machine-name
+ * The machine-readable name of your new theme. This will be auto-generated from the human-readable name if omitted.
+ * @usage drush gesso "New Theme Name"
+ * Creates a new theme called "New Theme Name" with a machine name of "new_theme_name".
+ * @usage drush gesso "New Theme Name" --machine-name=new_theme
+ * Creates a new theme called "New Theme Name" with a machine name of "new_theme".
+ *
+ * @command gesso
+ * @throws \Exception
+ */
+ public function gesso($name, array $options = ['description' => NULL, 'machine-name' => NULL]) {
+ // Get new theme options.
+ if (!isset($name)) {
+ $name = $options['name'];
+ }
+ $machine_name = $options['machine-name'] ?: $this->gesso_machine_name($name);
+ $description = $options['description'];
+
+ // Validate the command.
+ if (!$this->gesso_theme_exists('gesso')) {
+ throw new \Exception(dt('Where is the Gesso theme? I could not find it.'));
+ }
+
+ if ($this->gesso_theme_exists($machine_name)) {
+ throw new \Exception(dt('A theme with that name already exists. The machine-readable name must be unique.'));
+ }
+
+ if (!$machine_name || !preg_match('/^[a-z][a-z0-9_]*$/', $machine_name)) {
+ throw new \Exception(dt('The machine name was invalid or could not be generated properly. It must start '
+ . 'with a letter and may only contain lowercase letters, numbers, and underscores.'));
+ }
+
+ // Get theme paths.
+ $drupalRoot = Drush::bootstrapManager()->getRoot();
+ $gesso_path = Path::join($drupalRoot, drupal_get_path('theme', 'gesso'));
+ $theme_path = substr($gesso_path, 0, strrpos($gesso_path, '/'));
+ $new_path = Path::join($theme_path, $machine_name);
+
+ // Copy the Gesso theme directory recursively to the new theme’s location.
+ drush_op('drush_copy_dir', $gesso_path, $new_path);
+
+ // Remove Gesso’s helper module from the new theme.
+ $this->gesso_recursive_rm(Path::join($new_path, 'gesso_helper'));
+
+ // Rename the .info.yml file.
+ $gesso_info_file = Path::join($new_path, 'gesso.info.yml');
+ $new_info_file = Path::join($new_path, $machine_name . '.info.yml');
+ drush_op('rename', $gesso_info_file, $new_info_file);
+
+ // Update the .info.yml file based on the command options.
+ $changes = [
+ 'Gesso' => $name,
+ 'Sass-based starter theme.' => $description,
+ 'gesso' => $machine_name,
+ ];
+ $this->gesso_file_str_replace($new_info_file, array_keys($changes), $changes);
+
+ // Rename the .breakpoints.yml file.
+ $gesso_info_file = Path::join($new_path, 'gesso.breakpoints.yml');
+ $new_info_file = Path::join($new_path, $machine_name . '.breakpoints.yml');
+ drush_op('rename', $gesso_info_file, $new_info_file);
+
+ // Rename the .libraries.yml file.
+ $gesso_libraries_file = Path::join($new_path, 'gesso.libraries.yml');
+ $new_libraries_file = Path::join($new_path, $machine_name . '.libraries.yml');
+ drush_op('rename', $gesso_libraries_file, $new_libraries_file);
+
+ // Rename the .theme file.
+ $gesso_theme_file = Path::join($new_path, 'gesso.theme');
+ $new_theme_file = Path::join($new_path, $machine_name . '.theme');
+ drush_op('rename', $gesso_theme_file, $new_theme_file);
+
+ // Replace all occurrences of 'gesso' with the machine name of the new theme.
+ $breakpoints_file = $machine_name . '.breakpoints.yml';
+ $libraries_file = $machine_name . '.libraries.yml';
+ $theme_file = $machine_name . '.theme';
+ $files = [
+ $breakpoints_file,
+ $libraries_file,
+ $theme_file,
+ 'js/scripts.js',
+ 'includes/block.inc',
+ 'includes/field.inc',
+ 'includes/form.inc',
+ 'includes/html.inc',
+ 'includes/navigation.inc',
+ 'includes/taxonomy.inc',
+ 'includes/views.inc',
+ ];
+ foreach ($files as $file) {
+ $this->gesso_file_str_replace(Path::join($new_path, $file), 'gesso', $machine_name);
+ }
+
+ // Notify user of the newly created theme.
+ $this->io()->block(dt(
+ "\nThe \"!name\" theme has been created in: !path\n",
+ [
+ '!name' => $name,
+ '!path' => $new_path,
+ ]
+ ), 'SUCCESS', 'fg=black;bg=green', ' ! ');
+
+ // Warn the user that they might have some additional steps.
+ $this->io()->caution(dt('If you want to remove the gesso theme entirely, be sure to copy and rename the '
+ . 'gesso_helper module first.'));
+ $this->io()->note(dt('The gulp commands for !name are still gessoBuild and gessoWatch. If you want to change '
+ . 'those, you will need to modify the gulpfile and any build processes and/or CI tools.', [
+ '!name' => $name,
+ ]));
+ }
+
+ /**
+ * Converts $name to a machine-readable format.
+ */
+ private function gesso_machine_name($name) {
+ $name = str_replace(' ', '_', strtolower($name));
+ $search = [
+ // Remove characters not valid in function names.
+ '/[^a-z0-9_]/',
+ // Functions must begin with an alpha character.
+ '/^[^a-z]+/',
+ ];
+ $name = preg_replace($search, '', $name);
+ $name = str_replace('__', '_', $name);
+ $name = trim($name, '_');
+
+ return $name;
+ }
+
+ /**
+ * Checks if $theme_name already exists in Drupal.
+ */
+ private function gesso_theme_exists($theme_name) {
+ $theme_handler = \Drupal::service('theme_handler');
+ $themes = $theme_handler->listInfo();
+
+ return isset($themes[$theme_name]);
+ }
+
+ /**
+ * Replace strings in a file.
+ */
+ private function gesso_file_str_replace($file_path, $find, $replace) {
+ $file_path = Path::normalize($file_path);
+ $file_contents = file_get_contents($file_path);
+ $file_contents = str_replace($find, $replace, $file_contents);
+ drush_op('file_put_contents', $file_path, $file_contents);
+ }
+
+ /**
+ * Recursively removes all files and subfolders in a directory,
+ * before finally deleting the directory itself.
+ *
+ * @param string $path
+ * Path to the top-level directory.
+ */
+ private function gesso_recursive_rm($path) {
+ if (is_dir($path)) {
+ $dir_contents = scandir($path);
+ foreach ($dir_contents as $item) {
+ if ($item !== '.' && $item !== '..') {
+ $subpath = Path::join($path, $item);
+ if (is_dir($subpath)) {
+ $this->gesso_recursive_rm($subpath);
+ }
+ else {
+ drush_op('unlink', $subpath);
+ }
+ }
+ }
+ drush_op('rmdir', $path);
+ }
+ }
+
+}
diff --git a/gesso_helper/src/TwigExtension/GessoExtensionAdapter.php b/gesso_helper/src/TwigExtension/GessoExtensionAdapter.php
new file mode 100644
index 00000000..5bfbcfd1
--- /dev/null
+++ b/gesso_helper/src/TwigExtension/GessoExtensionAdapter.php
@@ -0,0 +1,31 @@
+<?php
+
+/**
+ * @file
+ * Gesso helper commands.
+ *
+ * phpcs:ignoreFile
+ */
+
+namespace Drupal\gesso_helper\TwigExtension;
+
+/**
+ * Load custom twig functions from Pattern Lab.
+ */
+class GessoExtensionAdapter extends \Twig_Extension {
+
+ /**
+ *
+ */
+ public function __construct() {
+ GessoExtensionLoader::init();
+ }
+
+ /**
+ *
+ */
+ public function getFunctions() {
+ return GessoExtensionLoader::get();
+ }
+
+}
diff --git a/gesso_helper/src/TwigExtension/GessoExtensionLoader.php b/gesso_helper/src/TwigExtension/GessoExtensionLoader.php
new file mode 100644
index 00000000..e9e79cf5
--- /dev/null
+++ b/gesso_helper/src/TwigExtension/GessoExtensionLoader.php
@@ -0,0 +1,56 @@
+<?php
+
+/**
+ * @file
+ * Gesso helper commands.
+ *
+ * phpcs:ignoreFile
+ */
+
+namespace Drupal\gesso_helper\TwigExtension;
+
+/**
+ * Load custom twig functions from Pattern Lab.
+ */
+class GessoExtensionLoader {
+
+ static $objects = [];
+
+ /**
+ *
+ */
+ public static function init() {
+ if (!self::$objects) {
+ static::loadAll();
+ }
+ }
+
+ /**
+ *
+ */
+ public static function get() {
+ return !empty(self::$objects) ? self::$objects : [];
+ }
+
+ /**
+ *
+ */
+ protected static function loadAll() {
+ //$theme = \Drupal::config('system.theme')->get('default');
+ //$themeLocation = drupal_get_path('theme', $theme);
+ //$themePath = DRUPAL_ROOT . '/' . $themeLocation . '/';
+ $uw_wcms_gesso_path = DRUPAL_ROOT . '/' . drupal_get_path('module', 'uw_wcms_gesso') . '/';
+ //$fullPath = $themePath . 'source/_twig-components/functions/';
+ $fullPath = $uw_wcms_gesso_path . 'source/_twig-components/functions/';
+ static::load($fullPath . 'add_attributes.function.drupal.php');
+ }
+
+ /**
+ *
+ */
+ protected static function load($file) {
+ include $file;
+ self::$objects[] = $function;
+ }
+
+}
--
GitLab