guides_style_18f 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b6425173ee18142282aaba8e6b3793be82673cc7
-  data.tar.gz: 5d279c26bb50028d66123be800494747c84ebabc
+  metadata.gz: 7c8d5fbef0f481d350fa56a00fb2913d58d78cf7
+  data.tar.gz: e23bc6918f8c88349835ff681bf110a556f64547
 SHA512:
-  metadata.gz: 24c45ba00326245afb55fb835220cae61b8a24d6772f1cc97896831a42324b7160c24cb350aa0ea88f1b25286497e9446169970327356dc5f5bf02213fae4e6d
-  data.tar.gz: 6dcfea31eeb9326ad81008502205f828488c43fee20e6c8bb3016e14b6e46091dfa56d7f1b63edbaa1bb96451c4e62965f4301cc9f7896617fce03489d002dcf
+  metadata.gz: 45ca1f1854395173e91cfd614555e1afb3a568d463a1fea19e070de56ac113707d685bbc2831b0d42840bce43d7edf5764ab382a148efc64e79bdec857172436
+  data.tar.gz: bf04bff3b13442dc3ab69648f8efd181cca82d192d9cded13c03f94a0afa2530ee15965eaf0f7621388fff8cd84f6ef1cb41fef60d7bc1e27ac3002204388c0b

data/lib/guides_style_18f.rb

@@ -1,6 +1,7 @@
 # @author Mike Bland (michael.bland@gsa.gov)
 
 require 'guides_style_18f/assets'
+require 'guides_style_18f/breadcrumbs'
 require 'guides_style_18f/generator'
 require 'guides_style_18f/includes'
 require 'guides_style_18f/layouts'

data/lib/guides_style_18f/breadcrumbs.rb

@@ -0,0 +1,28 @@
+require 'jekyll'
+require 'safe_yaml'
+
+module GuidesStyle18F
+  class Breadcrumbs
+    def self.generate(site, docs)
+      breadcrumbs = create_breadcrumbs(site)
+      docs.each do |page|
+        page.data['breadcrumbs'] = breadcrumbs[page.permalink || page.url]
+      end
+    end
+
+    def self.create_breadcrumbs(site)
+      (site.config['navigation'] || []).flat_map do |nav|
+        Breadcrumbs.generate_breadcrumbs(nav, '/', [])
+      end.to_h
+    end
+
+    def self.generate_breadcrumbs(nav, parent_url, parents)
+      url = parent_url + (nav['url'] || '')
+      crumbs = parents + [{ 'url' => url, 'text' => nav['text'] }]
+      child_crumbs = (nav['children'] || []).flat_map do |child|
+        generate_breadcrumbs(child, url, crumbs)
+      end
+      [[url, crumbs]] + child_crumbs
+    end
+  end
+end

data/lib/guides_style_18f/generated_nodes.rb

@@ -0,0 +1,63 @@
+module GuidesStyle18F
+  class GeneratedNodes
+    # Params:
+    #   url_to_nav: Mapping from original document URL to "nav item" objects,
+    #     i.e. { 'text' => '...', 'url' => '...', 'internal' => true }
+    #   nav_data: Array of nav item objects contained in `url_to_nav` after
+    #     applying updates, possibly containing "orphan" items marked with an
+    #     `:orphan_url` property
+    #
+    # Returns:
+    #   nav_data with orphans properly nested within automatically-generated
+    #     parent nodes marked with `'generated' => true`
+    def self.create_homes_for_orphans(url_to_nav, nav_data)
+      orphans = nav_data.select { |nav| nav[:orphan_url] }
+      orphans.each { |nav| create_home_for_orphan(nav, nav_data, url_to_nav) }
+      nav_data.reject! { |nav| nav[:orphan_url] }
+      prune_childless_parents(nav_data)
+    end
+
+    def self.create_home_for_orphan(nav, nav_data, url_to_nav)
+      parents = nav[:orphan_url].split('/')[1..-1]
+      nav['url'] = parents.pop + '/'
+      child_url = '/'
+      immediate_parent = parents.reduce(nil) do |parent, child|
+        child_url = child_url + child + '/'
+        find_or_create_node(nav_data, child_url, parent, child, url_to_nav)
+      end
+      assign_orphan_to_home(nav, immediate_parent, url_to_nav)
+    end
+
+    def self.find_or_create_node(nav_data, child_url, parent, child, url_to_nav)
+      child_nav = url_to_nav[child_url]
+      if child_nav.nil?
+        child_nav = generated_node(child)
+        url_to_nav[child_url] = child_nav
+        (parent.nil? ? nav_data : (parent['children'] ||= [])) << child_nav
+      end
+      child_nav
+    end
+
+    def self.generated_node(parent_slug)
+      { 'text' => parent_slug.split('-').join(' ').capitalize,
+        'url' => parent_slug + '/',
+        'internal' => true,
+        'generated' => true,
+      }
+    end
+
+    def self.assign_orphan_to_home(nav, immediate_parent, url_to_nav)
+      nav_copy = {}.merge(nav)
+      url_to_nav[nav_copy.delete(:orphan_url)] = nav_copy
+      (immediate_parent['children'] ||= []) << nav_copy
+    end
+
+    def self.prune_childless_parents(nav_data)
+      (nav_data || []).reject! do |nav|
+        children = (nav['children'] || [])
+        prune_childless_parents(children)
+        nav['generated'] && children.empty?
+      end
+    end
+  end
+end

data/lib/guides_style_18f/generated_pages.rb

@@ -0,0 +1,38 @@
+require_relative './layouts'
+
+module GuidesStyle18F
+  class GeneratedPages
+    DEFAULT_LAYOUT = 'guides_style_18f_generated_home_redirect'
+
+    def self.generate_pages_from_navigation_data(site)
+      layout = site.config['generate_nodes']
+      return if layout.nil? || layout == false
+      layout = DEFAULT_LAYOUT if layout == true
+      nav_data = site.config['navigation']
+      generate_pages_from_generated_nodes(site, layout, nav_data, '/')
+    end
+
+    def self.generate_pages_from_generated_nodes(
+      site, layout, nav_data, parent_url)
+      (nav_data || []).select { |nav| nav['generated'] }.each do |nav|
+        site.pages << GeneratedPage.new(site, layout, nav, parent_url)
+        children = nav['children']
+        next_url = parent_url + nav['url']
+        generate_pages_from_generated_nodes(site, layout, children, next_url)
+      end
+    end
+  end
+
+  class GeneratedPage < ::Jekyll::Page
+    def initialize(site, layout, nav, parent_url)
+      @site = site
+      @name = 'index.html'
+
+      process(@name)
+      @data = {}
+      data['title'] = nav['text']
+      data['permalink'] = parent_url + nav['url']
+      data['layout'] = layout
+    end
+  end
+end

data/lib/guides_style_18f/generator.rb

@@ -1,12 +1,23 @@
 # @author Mike Bland (michael.bland@gsa.gov)
 
+require_relative './assets'
+require_relative './breadcrumbs'
+require_relative './generated_pages'
+require_relative './layouts'
+require_relative './namespace_flattener'
+
 require 'jekyll'
 
 module GuidesStyle18F
   class Generator < ::Jekyll::Generator
     def generate(site)
-      Layouts.register site
-      Assets.copy_to_site site
+      Layouts.register(site)
+      Assets.copy_to_site(site)
+      GeneratedPages.generate_pages_from_navigation_data(site)
+      pages = site.collections['pages']
+      docs = (pages.nil? ? [] : pages.docs) + site.pages
+      Breadcrumbs.generate(site, docs)
+      NamespaceFlattener.flatten_url_namespace(site, docs)
     end
   end
 end

data/lib/guides_style_18f/includes/breadcrumbs.html

@@ -0,0 +1,8 @@
+<nav class="nav-main">
+  <div class="wrapper">
+    <ol class="breadcrumbs">
+    {% for breadcrumb in page.breadcrumbs %}<li>{% if forloop.last %}{{ breadcrumb.text }}{% else %}<a href="{{ site.baseurl}}{{ breadcrumb.url }}">{{ breadcrumb.text }}</a>{% endif %}</li>
+    {% endfor %}
+    </div>
+  </div>
+</nav>

data/lib/guides_style_18f/layouts.rb

@@ -7,11 +7,14 @@ module GuidesStyle18F
   # We have to essentially recreate the ::Jekyll::Layout constructor to loosen
   # the default restriction that layouts be included in the site source.
   class Layouts < ::Jekyll::Layout
+    LAYOUTS_DIR = File.join(File.dirname(__FILE__), 'layouts')
+    SEARCH_RESULTS_LAYOUT = 'search-results'
+
     private_class_method :new
 
-    def initialize(site, layout_file)
+    def initialize(site, subdir, layout_file)
       @site = site
-      @base = File.join File.dirname(__FILE__), 'layouts'
+      @base = File.join(LAYOUTS_DIR, subdir)
       @name = "#{layout_file}.html"
       @path = File.join @base, @name
       parse_content_and_data File.join(@base, name)
@@ -20,7 +23,7 @@ module GuidesStyle18F
 
     def parse_content_and_data(file_path)
       self.data = {}
-      self.content = File.read file_path
+      self.content = File.read(file_path)
 
       front_matter_pattern = /^(---\n.*)---\n/m
       front_matter_match = front_matter_pattern.match content
@@ -32,7 +35,18 @@ module GuidesStyle18F
     private :parse_content_and_data
 
     def self.register(site)
-      site.layouts['guides_style_18f_default'] = new site, 'default'
+      site.layouts['guides_style_18f_default'] = new(site, '', 'default')
+      site.layouts['guides_style_18f_generated_home_redirect'] = new(
+        site, 'generated', 'home-redirect')
+      register_search_results_layout(site)
+    end
+
+    def self.register_search_results_layout(site)
+      layouts_dir = File.join(site.source, site.config['layouts_dir'])
+      if !File.exist?(File.join(layouts_dir, "#{SEARCH_RESULTS_LAYOUT}.html"))
+        site.layouts[SEARCH_RESULTS_LAYOUT] = new(
+          site, '', SEARCH_RESULTS_LAYOUT)
+      end
     end
   end
 end

data/lib/guides_style_18f/layouts/generated/home-redirect.html

@@ -0,0 +1,6 @@
+<!DOCTYPE html>
+<html>
+<head><meta http-equiv="refresh" content="0;URL='{{ site.baseurl }}/#{{ page.title | slugify }}'">
+</head>
+<body></body>
+</html>

data/lib/guides_style_18f/layouts/search-results.html

@@ -0,0 +1,4 @@
+---
+layout: guides_style_18f_default
+---
+{% jekyll_pages_api_search_results %}

data/lib/guides_style_18f/namespace_flattener.rb

@@ -0,0 +1,39 @@
+module GuidesStyle18F
+  class NamespaceFlattener
+    def self.flatten_url_namespace(site, docs)
+      flatten_urls(docs) if site.config['flat_namespace']
+    end
+
+    def self.flatten_urls(docs)
+      flat_to_orig = {}
+      docs.each { |page| flatten_page_urls(page, flat_to_orig) }
+      check_for_collisions(flat_to_orig)
+    end
+
+    def self.flatten_page_urls(page, flat_to_orig)
+      orig_url = page.permalink || page.url
+      flattened_url = flat_url(orig_url)
+      (flat_to_orig[flattened_url] ||= []) << orig_url
+      page.data['permalink'] = flattened_url
+      (page.data['breadcrumbs'] || []).each do |crumb|
+        crumb['url'] = flat_url(crumb['url'])
+      end
+    end
+
+    def self.flat_url(url)
+      url == '/' ? url : "/#{url.split('/')[1..-1].last}/"
+    end
+
+    def self.check_for_collisions(flat_to_orig)
+      collisions = flat_to_orig.map do |flattened, orig|
+        [flattened, orig] if orig.size != 1
+      end.compact
+
+      return if collisions.empty?
+
+      messages = collisions.map { |flat, orig| "#{flat}: #{orig.join(', ')}" }
+      fail(StandardError, "collisions in flattened namespace between\n  " +
+        messages.join("\n  "))
+    end
+  end
+end

data/lib/guides_style_18f/navigation.rb

@@ -1,5 +1,7 @@
 # @author Mike Bland (michael.bland@gsa.gov)
 
+require_relative './generated_nodes'
+
 require 'jekyll'
 require 'safe_yaml'
 
@@ -99,7 +101,7 @@ module GuidesStyle18F
 
     def self.missing_property_errors(data)
       properties = %w(title permalink)
-      properties.map { |p| "no `#{p}:` property" unless data[p] }.compact
+      properties.map { |p| "no `#{p}:` property" if data[p].nil? }.compact
     end
 
     def self.permalink_errors(data)
@@ -122,19 +124,22 @@ module GuidesStyle18F
     config_data = SafeYAML.load_file config_path, safe: true
     return unless config_data
     nav_data = config_data['navigation'] || []
-    NavigationMenu.update_navigation_data(nav_data, basedir)
-    NavigationMenu.write_navigation_data_to_config_file(config_path, nav_data)
+    NavigationMenu.update_navigation_data(nav_data, basedir, config_data)
+    NavigationMenuWriter.write_navigation_data_to_config_file(
+      config_path, nav_data)
   end
 
-  private
-
   module NavigationMenu
-    def self.update_navigation_data(nav_data, basedir)
+    def self.update_navigation_data(nav_data, basedir, config_data)
       original = map_nav_items_by_url('/', nav_data).to_h
       updated = updated_nav_data(basedir)
       remove_stale_nav_entries(nav_data, original, updated)
       updated.map { |url, nav| apply_nav_update(url, nav, nav_data, original) }
-      check_for_orphaned_items(nav_data)
+      if config_data['generate_nodes']
+        GeneratedNodes.create_homes_for_orphans(original, nav_data)
+      else
+        check_for_orphaned_items(nav_data)
+      end
     end
 
     def self.map_nav_items_by_url(parent_url, nav_data)
@@ -168,7 +173,9 @@ module GuidesStyle18F
     def self.remove_stale_nav_entries(nav_data, original, updated)
       # Remove old entries whose pages have been deleted
       original.each do |url, nav|
-        nav['delete'] = true if !updated.member?(url) && nav['internal']
+        if !updated.member?(url) && nav['internal'] && !nav['generated']
+          nav['delete'] = true
+        end
       end
       original.delete_if { |_url, nav| nav['delete'] }
       nav_data.delete_if { |nav| nav['delete'] }
@@ -188,6 +195,7 @@ module GuidesStyle18F
         apply_new_nav_item(url, nav, nav_data, original)
       else
         orig['text'] = nav['text']
+        orig.delete('generated')
       end
     end
 
@@ -197,20 +205,22 @@ module GuidesStyle18F
       if parent_url == '/'
         nav_data << (original[url] = nav)
       elsif parent.nil?
-        nav_data << { orphan_url: url }
+        nav_data << nav.merge(orphan_url: url)
       else
         (parent['children'] ||= []) << nav
       end
     end
 
     def self.check_for_orphaned_items(nav_data)
-      orphans = nav_data.map { |nav| nav[:orphan_url] }.compact
-      unless orphans.empty?
+      orphan_urls = nav_data.map { |nav| nav[:orphan_url] }.compact
+      unless orphan_urls.empty?
         fail(StandardError, "Parent pages missing for the following:\n  " +
-          orphans.join("\n  "))
+          orphan_urls.join("\n  "))
       end
     end
+  end
 
+  class NavigationMenuWriter
     def self.write_navigation_data_to_config_file(config_path, nav_data)
       lines = []
       in_navigation = false

data/lib/guides_style_18f/sass/_guides_style_18f_main.scss

@@ -366,39 +366,8 @@ header div.wrap div.back-link a:hover{ text-decoration: none; }
         overflow: hidden;
         white-space: nowrap;
     }
-    header div.search-interface{
-        width: 30%;
-        float: right;
-    }
 }
 
-
-header div.search-interface input{
-    display: block;
-    -webkit-box-sizing: border-box;
-    width: 100%;
-    padding: 6px 4px;
-    padding-left: 2em;
-    font: inherit;
-    border-radius: 3px;
-    border: 1px solid #ccc;
-    background: url(../svg/search.svg) 6px 45% no-repeat;
-    background-size: 16px;
-}
-
-ul.searchresultspopup{ border-radius: 3px; }
-ul.searchresultspopup li{ padding: 0; }
-ul.searchresultspopup li a{
-    padding: 4px;
-    display: block;
-    color: inherit;
-}
-ul.searchresultspopup li.ng-scope.selected a{
-    background: #333;
-    color: white;
-}
-
-
 .main-content img {
   max-width: 100%;
 }

data/lib/guides_style_18f/version.rb

@@ -1,5 +1,5 @@
 # @author Mike Bland (michael.bland@gsa.gov)
 
 module GuidesStyle18F
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: guides_style_18f
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Mike Bland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-28 00:00:00.000000000 Z
+date: 2016-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -194,13 +194,15 @@ files:
 - assets/js/vendor/anchor.min.js
 - assets/js/vendor/jquery-1.11.2.min.js
 - assets/js/vendor/private-eye-1.0.0.js
-- assets/png/search.png
-- assets/svg/search.svg
 - lib/guides_style_18f.rb
 - lib/guides_style_18f/assets.rb
+- lib/guides_style_18f/breadcrumbs.rb
+- lib/guides_style_18f/generated_nodes.rb
+- lib/guides_style_18f/generated_pages.rb
 - lib/guides_style_18f/generator.rb
 - lib/guides_style_18f/includes.rb
 - lib/guides_style_18f/includes/analytics.html
+- lib/guides_style_18f/includes/breadcrumbs.html
 - lib/guides_style_18f/includes/footer.html
 - lib/guides_style_18f/includes/header.html
 - lib/guides_style_18f/includes/scripts.html
@@ -208,6 +210,9 @@ files:
 - lib/guides_style_18f/includes/sidebar.html
 - lib/guides_style_18f/layouts.rb
 - lib/guides_style_18f/layouts/default.html
+- lib/guides_style_18f/layouts/generated/home-redirect.html
+- lib/guides_style_18f/layouts/search-results.html
+- lib/guides_style_18f/namespace_flattener.rb
 - lib/guides_style_18f/navigation.rb
 - lib/guides_style_18f/repository.rb
 - lib/guides_style_18f/sass.rb

data/assets/svg/search.svg

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!-- Generated by IcoMoon.io -->
-<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
-<svg version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="26" height="28" viewBox="0 0 26 28">
-<path fill="#444" d="M18 13q0-2.891-2.055-4.945t-4.945-2.055-4.945 2.055-2.055 4.945 2.055 4.945 4.945 2.055 4.945-2.055 2.055-4.945zM26 26q0 0.812-0.594 1.406t-1.406 0.594q-0.844 0-1.406-0.594l-5.359-5.344q-2.797 1.937-6.234 1.937-2.234 0-4.273-0.867t-3.516-2.344-2.344-3.516-0.867-4.273 0.867-4.273 2.344-3.516 3.516-2.344 4.273-0.867 4.273 0.867 3.516 2.344 2.344 3.516 0.867 4.273q0 3.437-1.937 6.234l5.359 5.359q0.578 0.578 0.578 1.406z"></path>
-</svg>