Port complete. Tests working. Initial enhancements

Author: yorkshire-pudding

README.md

@@ -18,7 +18,6 @@ Gist Filter allows gists from Github to be embedded anywhere in the text using
 a token format to embed as either a link, a 'code' block or embedded using one
 of a range of themes.
 
-
 Installation
 ------------
 <!--
@@ -29,6 +28,11 @@ necessary.
 - Install this module using the official Backdrop CMS instructions at
   https://docs.backdropcms.org/documentation/extend-with-modules.
 - Enable the Gist Filter in each text format where you want to use it.
+- In the order of filters (weight) within each text format you use it, Gist
+Filter must come BEFORE
+[Token Filter](https://backdropcms.org/project/token_filter) and AFTER 'Limit
+allowed HTML tags'. The module will attempt to set this but double check this
+if you run into problems.
 
 Usage
 -------------
@@ -47,13 +51,15 @@ following patterns:
 - `[gistlink:123abc456def7890]` - embed the gist as a link.
 - `[gistembed:123abc456def7890]` - embed the gist using a script.
 The gist ID is the string after the gist owner. For the examples above the gist
-URL would be `https://gist.github.com/yorkshire-pudding/123abc456def7890`.
+URL might be `https://gist.github.com/yorkshire-pudding/123abc456def7890`.
 3. To add a specific file use `[gist:123abc456def7890:myfile.sh]` or the
 equivalent with a `gistcode`, `gistlink` or `gistembed` prefix.
 4. Go to `/admin/config/content/gist-filter` where you can select a theme for
 the embed display (you will need to clear the page cache to apply a change
 here), and also add a GitHub Personal Access token to give your site a higher
 limit for retrieving gists.
+5. Clearing the 'Page and else' cache may be necessary to see the effects of a
+change.
 
 Issues
 ------

config/gist_filter.settings.json

@@ -1,5 +1,6 @@
 {
   "_config_name": "gist_filter.settings",
   "github_token": "",
-  "gist_embed_theme": "default"
+  "gist_embed_theme": "default",
+  "enable_noscript_display": 1
 }

gist_filter.info

@@ -6,5 +6,5 @@ type = module
 package = Input filters
 tags[] = Filters
 tags[] = Content
-
-files[] = gist_filter.test
+tags[] = GitHub
+tags[] = Gist

gist_filter.module

@@ -9,14 +9,43 @@
  * the gist itself.
  */
 
+/**
+ * Implements hook_filter_info().
+ */
+function gist_filter_filter_info() {
+  $filters['gist_filter'] = array(
+    'title' => t('Gist filter (Github Gists)'),
+    'description' => t('Substitutes [gist:xx] tags with the gist located at https://gist.github.com/user/xx.'),
+    'process callback' => 'gist_filter_gist_filter_process',
+    'default settings' => array(
+      'gist_filter_display_method' => 'embed',
+    ),
+    'settings callback' => 'gist_filter_gist_filter_settings',
+    'tips callback' => 'gist_filter_filter_tips',
+    'cache' => TRUE,
+    'weight' => 0,
+  );
+  return $filters;
+}
+
+/**
+ * Implements hook_filter_info_alter().
+ */
+function gist_filter_filter_info_alter(&$info) {
+  if (module_exists('token_filter')) {
+    $info['filter_tokens']['weight'] = 1;
+  }
+}
+
+
  /**
  * Implements hook_menu().
  *
  */
 function gist_filter_menu() {
   $items = array();
   $items['admin/config/content/gist-filter'] = array(
-    'title' => 'Gist Filter settings',
+    'title' => 'Gist Filter Global settings',
     'description' => 'Enter global settings for the Gist Filter module',
     'page callback' => 'backdrop_get_form',
     'page arguments' => array('gist_filter_config_form'),
@@ -62,25 +91,7 @@ function gist_filter_theme() {
 }
 
 /**
- * Implements hook_filter_info().
- */
-function gist_filter_filter_info() {
-  $filters['gist_filter'] = array(
-    'title' => t('Gist filter (Github Gists)'),
-    'description' => t('Substitutes [gist:xx] tags with the gist located at https://gist.github.com/user/xx.'),
-    'process callback' => 'gist_filter_gist_filter_process',
-    'default settings' => array(
-      'gist_filter_display_method' => 'embed',
-    ),
-    'settings callback' => 'gist_filter_gist_filter_settings',
-    'tips callback' => 'gist_filter_filter_tips',
-    'cache' => TRUE,
-  );
-  return $filters;
-}
-
-/**
- * Process callback for hook_filter_info().
+ * Process callback for gist_filter.
  */
 function gist_filter_gist_filter_process($text, $filter, $format) {
   // Get the default display method for the text format.
@@ -110,11 +121,13 @@ function gist_filter_gist_filter_process($text, $filter, $format) {
 }
 
  /**
- * Settings callback for gist_filter_config_form
+ * Global settings page callback for gist_filter.
  */
 function gist_filter_config_form($form, &$form_state) {
   $form = array();
-  $form['#config'] = 'gist_filter.settings';
+  $config_file = 'gist_filter.settings';
+  $form['#config'] = $config_file;
+  $config = config($config_file);
 
   // Container for 'code' display settings.
   $form['code'] = array(
@@ -137,7 +150,7 @@ function gist_filter_config_form($form, &$form_state) {
   $form['code']['github_token'] = array(
     '#type' => 'textfield',
     '#title' => 'GitHub Personal Access Token',
-    '#default_value' => config_get('gist_filter.settings', 'github_token', ''),
+    '#default_value' => $config->get('github_token', ''),
     '#description' => $description,
   );
 
@@ -170,13 +183,21 @@ function gist_filter_config_form($form, &$form_state) {
     '#type' => 'select',
     '#title' => 'Gist Embed Theme',
     '#options' => $gist_themes,
-    '#default_value' => config_get('gist_filter.settings', 'gist_embed_theme'),
+    '#default_value' => $config->get('gist_embed_theme'),
     '#description' => t("Themes are from <a href='@developer'>Will Boyd</a> and can be previewed on <a href='@preview-page'>this page</a>.", array(
       '@developer' => 'https://github.com/lonekorean/gist-syntax-themes',
       '@preview-page' => 'https://lonekorean.github.io/gist-syntax-themes/',
     )),
   );
 
+  // Allow disabling the 'noscript' display of code block to save on API calls.
+  $form['embed']['enable_noscript_display'] = array(
+    '#type' => 'checkbox',
+    '#title' => "Display 'code' version if Javascript is disabled.",
+    '#description' => t("If Javascript is disabled, then enabling this option will use 'code' display of the gist. This may cause additional calls to the GitHub API if the gist is not in the cache."),
+    '#default_value' => $config->get('enable_noscript_display'),
+  );
+
   return system_settings_form($form);
 }
 
@@ -198,7 +219,7 @@ function gist_filter_gist_filter_settings($form, $form_state, $filter, $format)
 }
 
 /**
- * Implements hook_filter_tips().
+ * Filter tip callback for gist_filter.
  */
 function gist_filter_filter_tips($filter, $format, $long = FALSE) {
   $display = $filter->settings['gist_filter_display_method'];
@@ -229,6 +250,7 @@ function gist_filter_filter_tips($filter, $format, $long = FALSE) {
   // Define the tip for the default display method.
   $default_tip = array(t('Use [gist:####] where #### is your gist number to %action.</br>To add a specific file use [gist:123abc456def7890:myfile.sh] or the
   equivalent from the examples below.', array('%action' => $default_action)));
+  // Merge and return the tips.
   $tips = array_merge($default_tip, $override_tips);
   return implode('</br>', $tips);
 }
@@ -281,15 +303,17 @@ function _gist_display_code($matches) {
  */
 function _gist_display_embed($matches) {
   // Get the embed theme setting.
-  $theme = config_get('gist_filter.settings', 'gist_embed_theme');
+  $config_file = 'gist_filter.settings';
+  $config = config($config_file);
+  $theme = $config->get('gist_embed_theme');
 
   // Make the url agnostic to the scheme so gist will embed on http and https.
   $gist_url = '//gist.github.com/' . $matches[1];
   $gist_url = isset($matches[2]) && !empty($matches[2]) ? $gist_url . '.js?file=' . $matches[2] : $gist_url . '.js';
 
   // Also grab the content and display it in code tags (in case the user does
-  // not have Javascript).
-  $output = '<noscript>' . _gist_display_code($matches) . '</noscript>';
+  // not have Javascript) if enabled.
+  $output = ($config->get('enable_noscript_display')) ? '<noscript>' . _gist_display_code($matches) . '</noscript>' : '';
 
   // If the theme is not default then use javascript to add the CSS.
   if ($theme != 'default') {
@@ -341,7 +365,7 @@ function gist_filter_get_gist($id) {
       $gist = $cached->data;
     }
     else {
-      // Not available in the cache, so retrive the gist from Github.
+      // Not available in the cache, so retrieve the gist from Github.
       // Define standard header.
       $headers = array();
       $headers['Content-Type'] = 'application/json';
@@ -358,7 +382,7 @@ function gist_filter_get_gist($id) {
       $gist = backdrop_json_decode($response->data);
 
       // Cache the gist until the next cache flush.
-      cache_set($cid, $gist, 'cache', CACHE_TEMPORARY);
+      cache_set($cid, $gist, 'cache', CACHE_PERMANENT);
     }
     // Return the cached or retrieved gist.
     $gists[$id] = $gist;