dss_tech_docs 0.1.0

data/lib/assets/javascripts/_govuk/modules.js

@@ -0,0 +1,57 @@
+(function($, root) {
+  "use strict";
+  root.GOVUK = root.GOVUK || {};
+  GOVUK.Modules = GOVUK.Modules || {};
+
+  GOVUK.modules = {
+    find: function(container) {
+      var modules,
+          moduleSelector = '[data-module]',
+          container = container || $('body');
+
+      modules = container.find(moduleSelector);
+
+      // Container could be a module too
+      if (container.is(moduleSelector)) {
+        modules = modules.add(container);
+      }
+
+      return modules;
+    },
+
+    start: function(container) {
+      var modules = this.find(container);
+
+      for (var i = 0, l = modules.length; i < l; i++) {
+        var module,
+            element = $(modules[i]),
+            type = camelCaseAndCapitalise(element.data('module')),
+            started = element.data('module-started');
+
+
+        if (typeof GOVUK.Modules[type] === "function" && !started) {
+          module = new GOVUK.Modules[type]();
+          module.start(element);
+          element.data('module-started', true);
+        }
+      }
+
+      // eg selectable-table to SelectableTable
+      function camelCaseAndCapitalise(string) {
+        return capitaliseFirstLetter(camelCase(string));
+      }
+
+      // http://stackoverflow.com/questions/6660977/convert-hyphens-to-camel-case-camelcase
+      function camelCase(string) {
+        return string.replace(/-([a-z])/g, function (g) {
+          return g[1].toUpperCase();
+        });
+      }
+
+      // http://stackoverflow.com/questions/1026069/capitalize-the-first-letter-of-string-in-javascript
+      function capitaliseFirstLetter(string) {
+        return string.charAt(0).toUpperCase() + string.slice(1);
+      }
+    }
+  }
+})(jQuery, window);

data/lib/assets/javascripts/_modules/anchored-headings.js

@@ -0,0 +1,18 @@
+(function($, Modules) {
+  'use strict';
+
+  Modules.AnchoredHeadings = function() {
+    this.start = function($element) {
+      var headings = $element.find('h1, h2, h3, h4, h5, h6');
+      headings.each(injectAnchor);
+    };
+
+    function injectAnchor() {
+      var $this = $(this);
+      $this.addClass('anchored-heading');
+      $this.prepend(
+        '<a href="#' + $this.attr('id') + '" class="anchored-heading__icon" aria-hidden="true"></a>'
+      );
+    };
+  };
+})(jQuery, window.GOVUK.Modules);

data/lib/assets/javascripts/_modules/collapsible-navigation.js

@@ -0,0 +1,95 @@
+(function($, Modules) {
+  'use strict';
+
+  Modules.CollapsibleNavigation = function () {
+
+    var $contentPane;
+    var $nav;
+    var $topLevelItems;
+    var $headings;
+    var $listings;
+
+    var $openLink;
+    var $closeLink;
+
+    this.start = function ($element) {
+      $contentPane = $('.app-pane__content');
+      $nav = $element;
+      $topLevelItems = $nav.find('> ul > li');
+      $headings = $topLevelItems.find('> a');
+      $listings = $topLevelItems.find('> ul');
+
+      // Attach collapsible heading functionality,on mobile and desktop
+      collapsibleHeadings();
+      openActiveHeading();
+      $contentPane.on('scroll', _.debounce(openActiveHeading, 100, { maxWait: 100 }));
+
+    };
+
+    function collapsibleHeadings() {
+      for (var i = $topLevelItems.length - 1; i >= 0; i--) {
+        var $topLevelItem = $($topLevelItems[i]);
+        var $heading = $topLevelItem.find('> a');
+        var $listing = $topLevelItem.find('> ul');
+        var id = 'toc-' + $heading.text().toLowerCase().replace(' ', '-');
+        // Only add collapsible functionality if there are children.
+        if ($listing.length == 0) {
+          continue;
+        }
+        $topLevelItem.addClass('collapsible');
+        $listing.addClass('collapsible__body')
+        .attr('id', id)
+        .attr('aria-expanded', 'false');
+        $heading.addClass('collapsible__heading')
+        .after('<button class="collapsible__toggle" aria-controls="' + id +'"><span class="collapsible__toggle-label">Expand ' + $heading.text() + '</span><span class="collapsible__toggle-icon" aria-hidden="true"></button>')
+        $topLevelItem.on('click', '.collapsible__toggle', function(e) {
+          e.preventDefault();
+          var $parent = $(this).parent();
+          toggleHeading($parent);
+        });
+      }
+    }
+
+    function toggleHeading($topLevelItem) {
+      var isOpen = $topLevelItem.hasClass('is-open');
+      var $heading = $topLevelItem.find('> a');
+      var $body = $topLevelItem.find('.collapsible__body');
+      var $toggleLabel = $topLevelItem.find('.collapsible__toggle-label');
+
+      $topLevelItem.toggleClass('is-open', !isOpen);
+      $body.attr('aria-expanded', isOpen ? 'false' : 'true');
+      $toggleLabel.text(isOpen ? 'Expand ' + $heading.text() : 'Collapse ' + $heading.text());
+    }
+
+    function openActiveHeading() {
+      var $activeElement;
+      var currentPath = window.location.pathname;
+      var isActiveTrail = '[href*="' + currentPath + '"]';
+      // Add an exception for the root page, as every href includes /
+      if(currentPath == '/') {
+        isActiveTrail = '[href="' + currentPath + window.location.hash + '"]'
+      }
+      for (var i = $topLevelItems.length - 1; i >= 0; i--) {
+        var $element = $($topLevelItems[i]);
+        var $heading = $element.find('> a');
+        // Check if this item href matches
+        if($heading.is(isActiveTrail)) {
+          $activeElement = $element;
+          break;
+        }
+        // Otherwise check the children
+        var $children = $element.find('li > a');
+        var $matchingChildren = $children.filter(isActiveTrail);
+        if ($matchingChildren.length) {
+          $activeElement = $element;
+          break;
+        }
+      }
+      if($activeElement && !$activeElement.hasClass('is-open')) {
+        toggleHeading($activeElement);
+      }
+    }
+
+
+  };
+})(jQuery, window.GOVUK.Modules);

data/lib/assets/javascripts/_modules/in-page-navigation.js

@@ -0,0 +1,132 @@
+(function($, Modules) {
+  'use strict';
+
+  Modules.InPageNavigation = function InPageNavigation() {
+    var $tocPane;
+    var $contentPane;
+    var $tocItems;
+    var $targets;
+
+    this.start = function start($element) {
+      $tocPane = $element.find('.app-pane__toc');
+      $contentPane = $element.find('.app-pane__content');
+      $tocItems = $('.js-toc-list').find('a');
+      $targets = $contentPane.find('[id]');
+
+      $contentPane.on('scroll', _.debounce(handleScrollEvent, 100, { maxWait: 100 }));
+
+      if (Modernizr.history) {
+        // Popstate is triggered when using the back button to navigate 'within'
+        // the page, i.e. changing the anchor part of the URL.
+        $(window).on('popstate', function (event) {
+          restoreScrollPosition(event.originalEvent.state);
+        });
+
+        if (history.state && history.state.scrollTop) {
+          // Restore existing state when e.g. using the back button to return to
+          // this page
+          restoreScrollPosition(history.state);
+        } else {
+          // Store the initial position so that we can restore it even if we
+          // never scroll.
+          handleInitialLoadEvent();
+        }
+      }
+    };
+
+    function restoreScrollPosition(state) {
+      if (state && typeof state.scrollTop !== 'undefined') {
+        $contentPane.scrollTop(state.scrollTop);
+      }
+    }
+
+    function handleInitialLoadEvent() {
+      var fragment = fragmentForTargetElement();
+
+      if (!fragment) {
+        fragment = fragmentForFirstElementInView();
+      }
+
+      handleChangeInActiveItem(fragment);
+    }
+
+    function handleScrollEvent() {
+      handleChangeInActiveItem(fragmentForFirstElementInView());
+    }
+
+    function handleChangeInActiveItem(fragment) {
+      storeCurrentPositionInHistoryApi(fragment);
+      highlightActiveItemInToc(fragment);
+    }
+
+    function storeCurrentPositionInHistoryApi(fragment) {
+      if (Modernizr.history && fragment) {
+        history.replaceState(
+          { scrollTop: $contentPane.scrollTop() },
+          "",
+          fragment
+        );
+      }
+    }
+
+    function highlightActiveItemInToc(fragment) {
+      // Navigation items for single page navigation don't necessarily include the path name, but
+      // navigation items for multipage navigation items do include it. This checks for either case.
+      var $activeTocItem = $tocItems.filter(
+        '[href="' + window.location.pathname + fragment + '"],[href="' + fragment + '"]'
+      );
+      // Navigation items with children don't contain fragments in their url
+      // Check to see if any nav items contain just the path name.
+      if(!$activeTocItem.get(0)) {
+        $activeTocItem = $tocItems.filter('[href="' + window.location.pathname + '"]');
+      }
+      if ($activeTocItem.get(0)) {
+        $tocItems.removeClass('toc-link--in-view');
+        $activeTocItem.addClass('toc-link--in-view');
+        scrollTocToActiveItem($activeTocItem);
+      }
+    }
+
+    function scrollTocToActiveItem($activeTocItem) {
+      var paneHeight = $tocPane.height();
+      var linkTop = $activeTocItem.position().top;
+      var linkBottom = linkTop + $activeTocItem.outerHeight();
+
+      var offset = null;
+
+      if (linkTop < 0) {
+        offset = linkTop;
+      } else if (linkBottom >= paneHeight) {
+        offset = -(paneHeight - linkBottom);
+      } else {
+        return;
+      }
+
+      var newScrollTop = $tocPane.scrollTop() + offset;
+
+      $tocPane.scrollTop(newScrollTop);
+    }
+
+    function fragmentForTargetElement() {
+      return window.location.hash;
+    }
+
+    function fragmentForFirstElementInView() {
+      var result = null;
+
+      $($targets.get().reverse()).each(function checkIfInView(index) {
+        if (result) {
+          return;
+        }
+
+        var $this = $(this);
+
+        if (Math.floor($this.position().top) <= 0) {
+          result = $this;
+        }
+      });
+
+      return result ? '#' + result.attr('id') : false;
+    }
+  };
+})(jQuery, window.GOVUK.Modules);

data/lib/assets/javascripts/_modules/navigation.js

@@ -0,0 +1,34 @@
+(function($, Modules) {
+  'use strict';
+
+  Modules.Navigation = function () {
+    var $html = $('html');
+
+    var $navToggle;
+    var $nav;
+
+    this.start = function ($element) {
+      $navToggle = $('.js-nav-toggle', $element);
+      $nav = $('.js-nav', $element);
+
+      updateAriaAttributes();
+
+      $navToggle.on('click', toggleNavigation);
+      $(window).on('resize', updateAriaAttributes);
+    }
+
+    function updateAriaAttributes() {
+      var navIsVisible = $nav.is(':visible');
+
+      $navToggle.attr('aria-expanded', navIsVisible ? 'true' : 'false');
+      $nav.attr('aria-hidden', navIsVisible ? 'false' : 'true');
+    }
+
+    function toggleNavigation() {
+      var navIsVisible = !$html.hasClass('nav-open');
+
+      $html.toggleClass('nav-open', navIsVisible);
+      updateAriaAttributes();
+    }
+  };
+})(jQuery, window.GOVUK.Modules);

data/lib/assets/javascripts/_modules/page-expiry.js

@@ -0,0 +1,15 @@
+(function($, Modules) {
+  'use strict';
+
+  Modules.PageExpiry = function PageExpiry() {
+    this.start = function start($element) {
+      var rawDate = $element.data('last-reviewed-on');
+      var isExpired = Date.parse(rawDate) < new Date();
+
+      if (isExpired) {
+        $element.find('.page-expiry--not-expired').hide(0);
+        $element.find('.page-expiry--expired').show(0);
+      }
+    };
+  };
+})(jQuery, window.GOVUK.Modules);

data/lib/assets/javascripts/_modules/search.js

@@ -0,0 +1,367 @@
+//= require lunr.min
+//= require _vendor/jquery.mark.js
+(function($, Modules) {
+  'use strict';
+
+  Modules.Search = function Search() {
+    var s = this;
+    var $html = $('html');
+    s.lunrIndex;
+    s.lunrData;
+    var $searchForm;
+    var $searchLabel;
+    var $searchInput;
+    var $searchResults;
+    var $searchResultsTitle;
+    var $searchResultsWrapper;
+    var $searchResultsClose;
+    var results;
+    var query;
+    var queryTimer;
+    var maxSearchEntries = 20;
+
+    this.start = function start($element) {
+      $searchForm = $element.find('form');
+      $searchInput = $element.find('#search');
+      $searchLabel = $element.find('.search__label');
+      $searchResultsWrapper = $element.find('.search-results')
+      $searchResults = $searchResultsWrapper.find('.search-results__content');
+      $searchResultsTitle = $searchResultsWrapper.find('.search-results__title');
+      $searchResultsClose = $searchResultsWrapper.find('.search-results__close');
+      s.downloadSearchIndex();
+      attach();
+      changeSearchLabel();
+    };
+
+    this.downloadSearchIndex = function downloadSearchIndex() {
+      updateTitle('Loading search index')
+      $.ajax({
+        url: '/search.json',
+        cache: true,
+        method: 'GET',
+        success: function(data) {
+          s.lunrData = data;
+          s.lunrIndex = lunr.Index.load(s.lunrData.index);
+          replaceStopWordFilter();
+          $(document).trigger('lunrIndexLoaded');
+        }
+      });
+    }
+
+    function attach() {
+      // Search functionality on search text input
+      $searchInput.on('input', function (e) {
+        e.preventDefault();
+        query = $(this).val();
+        s.search(query, function(r) {
+          results = r;
+          renderResults(query);
+          updateTitle();
+        });
+        if(window.ga) {
+          window.clearTimeout(queryTimer);
+          queryTimer = window.setTimeout(sendQueryToAnalytics, 1000);
+        }
+      });
+
+      // Set focus on the first search result instead of submiting the search
+      // form to Google
+      $searchForm.on('submit', function(e) {
+        e.preventDefault();
+        showResults();
+        $searchResults.find('.search-result__title a').first().focus();
+      });
+
+      // Closing the search results, move focus back to the search input
+      $searchResultsClose.on('click', function(e) {
+        e.preventDefault();
+        $searchInput.focus();
+        hideResults();
+      });
+
+      // Attach analytics events to search result clicks
+      if(window.ga) {
+        $searchResults.on('click', '.search-result__title a', function() {
+          var href = $(this).attr('href');
+          ga('send', {
+            hitType: 'event',
+            eventCategory: 'Search result',
+            eventAction: 'click',
+            eventLabel: href,
+            transport: 'beacon'
+          });
+        });
+      }
+
+      // When selecting navigation link, close the search results.
+      $('.toc').on('click','a', function(e) {
+        hideResults();
+      })
+    }
+
+    function changeSearchLabel() {
+      $searchLabel.text('Search');
+    }
+
+    function getResults(query) {
+      var results = [];
+      s.lunrIndex.search(query).forEach( function (item, index) {
+        if ( index < maxSearchEntries ) {
+          results.push(s.lunrData.docs[item.ref]);
+        }
+      });
+      return results;
+    }
+
+    this.search = function search(query, callback) {
+      if(query === '') {
+        hideResults();
+        return;
+      }
+      showResults();
+      // The index has not been downloaded yet, exit early and wait.
+      if(!s.lunrIndex) {
+        $(document).on('lunrIndexLoaded', function() {
+          s.search(query, callback);
+        });
+        return;
+      }
+      callback(getResults(query));
+    }
+
+    function renderResults(query) {
+      var output = '';
+      if (results.length == 0) {
+        output += '<p>Nothing found</p>';
+      }
+      output += '<ul>';
+      for(var index in results) {
+        var result = results[index];
+        var content = s.processContent(result.content, query);
+        output += '<li class="search-result">';
+        output += '<h3 class="search-result__title">';
+        output += '<a href="' + result.url + '">';
+        output += result.title;
+        output += '</a>';
+        output += '</h3>';
+        if(typeof content !== 'undefined') {
+          output += '<p>' + content + '</p>';
+        }
+        output += '</li>';
+      }
+      output += '</ul>';
+
+      $searchResults.html( output );
+    }
+
+    this.processContent = function processContent(content, query) {
+      var output;
+      content = '<div>'+  content + '</div>';
+      content = $(content).mark(query);
+
+      // Split content by sentence.
+      var sentences = content.html().replace(/(\.+|\:|\!|\?|\r|\n)(\"*|\'*|\)*|}*|]*)/gm, "|").split("|");
+
+      // Select the first five sentences that contain a <mark>
+      var selectedSentences = [];
+      for (var i = 0; i < sentences.length; i++) {
+        if(selectedSentences.length === 5) {
+          break;
+        }
+
+        var sentence = sentences[i].trim();
+        var containsMark = sentence.includes('mark>');
+        if (containsMark && (selectedSentences.indexOf(sentence) == -1)) {
+          selectedSentences.push(sentence);
+        }
+      }
+      if(selectedSentences.length > 0) {
+        output = ' … ' + selectedSentences.join(' … ') + ' … ';
+      }
+      return output;
+    }
+
+    // Default text is to display the number of search results
+    function updateTitle(text) {
+      if(typeof text == "undefined") {
+        var count = results.length;
+        var text = count + ' results';
+      }
+      $searchResultsTitle.text(text);
+    }
+
+    function showResults() {
+      $searchResultsWrapper.addClass('is-open')
+      .attr('aria-hidden', 'false');
+      $html.addClass('has-search-results-open');
+    }
+
+    function hideResults() {
+      $searchResultsWrapper.removeClass('is-open')
+      .attr('aria-hidden', 'true');
+      $html.removeClass('has-search-results-open');
+    }
+
+    function sendQueryToAnalytics() {
+      if(query === '') {
+        return;
+      }
+      var stripped = window.stripPIIFromString(query)
+      ga('send', {
+        hitType: 'event',
+        eventCategory: 'Search query',
+        eventAction: 'type',
+        eventLabel: stripped,
+        transport: 'beacon'
+      });
+    }
+
+    function replaceStopWordFilter() {
+      // Replace the default stopWordFilter as it excludes useful words like
+      // 'get'
+      // See: https://lunrjs.com/docs/stop_word_filter.js.html#line43
+      s.lunrIndex.pipeline.remove(lunr.stopWordFilter);
+      s.lunrIndex.pipeline.add(s.govukStopWorldFilter);
+    }
+
+   this.govukStopWorldFilter = lunr.generateStopWordFilter([
+      'a',
+      'able',
+      'about',
+      'across',
+      'after',
+      'all',
+      'almost',
+      'also',
+      'am',
+      'among',
+      'an',
+      'and',
+      'any',
+      'are',
+      'as',
+      'at',
+      'be',
+      'because',
+      'been',
+      'but',
+      'by',
+      'can',
+      'cannot',
+      'could',
+      'dear',
+      'did',
+      'do',
+      'does',
+      'either',
+      'else',
+      'ever',
+      'every',
+      'for',
+      'from',
+      'got',
+      'had',
+      'has',
+      'have',
+      'he',
+      'her',
+      'hers',
+      'him',
+      'his',
+      'how',
+      'however',
+      'i',
+      'if',
+      'in',
+      'into',
+      'is',
+      'it',
+      'its',
+      'just',
+      'least',
+      'let',
+      'like',
+      'likely',
+      'may',
+      'me',
+      'might',
+      'most',
+      'must',
+      'my',
+      'neither',
+      'no',
+      'nor',
+      'not',
+      'of',
+      'off',
+      'often',
+      'on',
+      'only',
+      'or',
+      'other',
+      'our',
+      'own',
+      'rather',
+      'said',
+      'say',
+      'says',
+      'she',
+      'should',
+      'since',
+      'so',
+      'some',
+      'than',
+      'that',
+      'the',
+      'their',
+      'them',
+      'then',
+      'there',
+      'these',
+      'they',
+      'this',
+      'tis',
+      'to',
+      'too',
+      'twas',
+      'us',
+      'wants',
+      'was',
+      'we',
+      'were',
+      'what',
+      'when',
+      'where',
+      'which',
+      'while',
+      'who',
+      'whom',
+      'why',
+      'will',
+      'with',
+      'would',
+      'yet',
+      'you',
+      'your'
+    ])
+  };
+
+  // Polyfill includes
+  if (!String.prototype.includes) {
+    String.prototype.includes = function(search, start) {
+      'use strict';
+      if (typeof start !== 'number') {
+        start = 0;
+      }
+
+      if (start + search.length > this.length) {
+        return false;
+      } else {
+        return this.indexOf(search, start) !== -1;
+      }
+    };
+  }
+})(jQuery, window.GOVUK.Modules);
+
+
+