guides_style_18f 0.1.13 → 0.1.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e8e90ac6e098d4a7f00a3bba6b02feef2ca7b31
-  data.tar.gz: 55f98a82961b0653128999fc82606640d9f97fd5
+  metadata.gz: dce17bb3ce830151e80b02ba3d972d29d2d52eaf
+  data.tar.gz: 56b84fb06608302738694a29f9a74cb7dade21c2
 SHA512:
-  metadata.gz: 033076c750131294a897ca24db5d4badf8b46b8711976024d92f02fd09c52e468199a0e1c10de4581cb388f73562a9f5b58b88924acd990eb6189f7db6dc394b
-  data.tar.gz: 60a3142ec6eb987c7bb37f507bc7e515f10b324560ce0c7490778ce93f1bb5076dd5e8d3e20c9a512fb3db34032c0d4321a61971bd632281fdacf9b044549432
+  metadata.gz: eb9110487567bca200583b368fc657b7677d70074efa224d08fa475ec9ebf6416a851f185906b1e43e5ab66969dd5f309b8a24e7ac56789c3379b0fb381dbed4
+  data.tar.gz: eb7dcebc6877231d7e8d2b1244b00c709f47fc27e53d0f1b77a895241830018a91a36ed8f78744c7dd2fe5dfc31d027d5e9424412cc9bae7212ab90060a3bbae

data/README.md

@@ -58,6 +58,10 @@ back_link:
 
 # If you use Analytics, add your code here:
 google_analytics_ua: UA-????????-??
+
+# If you want all of the navigation bar entries expanded by default, add this
+# property and it to true:
+expand_nav: true
 ```
 
 ### Additional scripts and styles
@@ -66,6 +70,18 @@ If you'd like to add additional scripts or styles to every page on the site,
 you can add `styles:` and `scripts:` lists to `_config.yml`. To add them to a
 particular page, add these lists to the page's front matter.
 
+### Alternate navigation bar titles
+
+If you want a page to have a different title in the navigation bar than that
+of the page itself, add a `navtitle:` property to the page's front matter:
+
+```md
+---
+title: Since brevity is the soul of wit, I'll be brief.
+navtitle: Polonius's advice
+---
+```
+
 ### Development
 
 First, choose a Jekyll site you'd like to use to view the impact of your

data/lib/guides_style_18f/includes/sidebar-children.html

@@ -7,9 +7,9 @@
     aria-hidden="{% if expand_nav == 'true' %}false{% else %}true{% endif %}">
   {% for child in parent.children %}
   {% capture child_url %}{{ parent_url }}{{ child.url }}{% endcapture %}
-    <li class="{% if page.title == child.text %}sidebar-nav-active{% endif %}">
+    <li class="{% if page.url == child_url %}sidebar-nav-active{% endif %}">
       <a href="{% if child.internal == true %}{{ site.baseurl }}{{ child_url }}{% else %}{{ child.url }}{% endif %}"
-        title="{% if page.title == child.text %}Current Page{% else %}{{ child.text }}{% endif %}">{{ child.text }}</a>
+        title="{% if page.url == child_url %}Current Page{% else %}{{ child.text }}{% endif %}">{{ child.text }}</a>
       {% assign parent = child %}{% assign parent_url = child_url %}
       {% guides_style_18f_include sidebar-children.html %}
       {% capture parent_url %}{% guides_style_18f_pop_last_url_component parent_url %}{% endcapture %}

data/lib/guides_style_18f/includes/sidebar.html

@@ -1,13 +1,12 @@
 <aside>
   <p class="intro">{{ site.subtitle }}</p>
   <nav class="sidebar-nav" role="navigation">
-    <ul>{% for link in site.navigation %}
-        <li class="group {% if page.title == link.text %}sidebar-nav-active{% endif %}">
+    <ul>{% for link in site.navigation %}{% capture parent_url %}/{{ link.url }}{% endcapture %}
+        <li class="group {% if page.url == parent_url %}sidebar-nav-active{% endif %}">
           <a href="{% if link.internal == true %}{{ site.baseurl }}/{% endif %}{{ link.url }}"  
-            title="{% if page.title == link.text %}Current Page
+            title="{% if page.url == parent_url %}Current Page
                   {% else %}{{ link.text }}{% endif %}">{{ link.text }}</a>
           {% assign parent = link %}
-          {% capture parent_url %}/{{ link.url }}{% endcapture %}
           {% guides_style_18f_include sidebar-children.html %}
         </li>{% endfor %}
     </ul>

data/lib/guides_style_18f/navigation.rb

@@ -5,6 +5,8 @@ require 'safe_yaml'
 
 module GuidesStyle18F
   module FrontMatter
+    EXTNAMES = %w(.md .html)
+
     def self.load(basedir)
       # init_file_to_front_matter_map is initializing the map with a nil value
       # for every file that _should_ contain front matter as far as the
@@ -87,7 +89,8 @@ module GuidesStyle18F
       Dir.chdir(basedir) do
         pages_dir = Dir.exist?('_pages') ? '_pages' : 'pages'
         Dir[File.join(pages_dir, '**', '*')].each do |file_name|
-          next unless File.file?(file_name)
+          extname = File.extname(file_name)
+          next unless File.file?(file_name) && EXTNAMES.include?(extname)
           file_to_front_matter[file_name] = nil
         end
       end
@@ -119,111 +122,121 @@ module GuidesStyle18F
     config_data = SafeYAML.load_file config_path, safe: true
     return unless config_data
     nav_data = config_data['navigation'] || []
-    update_navigation_data(nav_data, basedir)
-    write_navigation_data_to_config_file(config_path, nav_data)
+    NavigationMenu.update_navigation_data(nav_data, basedir)
+    NavigationMenu.write_navigation_data_to_config_file(config_path, nav_data)
   end
 
   private
 
-  def self.update_navigation_data(nav_data, basedir)
-    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)
-  end
+  module NavigationMenu
+    def self.update_navigation_data(nav_data, basedir)
+      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)
+    end
 
-  def self.map_nav_items_by_url(parent_url, nav_data)
-    nav_data.flat_map do |nav|
-      url = File.join('', parent_url, nav['url'] || '')
-      [[url, nav]].concat(map_nav_items_by_url(url, nav['children'] || []))
+    def self.map_nav_items_by_url(parent_url, nav_data)
+      nav_data.flat_map do |nav|
+        url = File.join('', parent_url, nav['url'] || '')
+        [[url, nav]].concat(map_nav_items_by_url(url, nav['children'] || []))
+      end
     end
-  end
 
-  def self.updated_nav_data(basedir)
-    front_matter = FrontMatter.load basedir
-    errors = FrontMatter.validate_with_message_upon_error front_matter
-    abort errors + "\n_config.yml not updated" if errors
-    front_matter.values.sort_by { |fm| fm['permalink'] }
-      .map { |fm| [fm['permalink'], page_nav(fm)] }.to_h
-  end
+    def self.updated_nav_data(basedir)
+      front_matter = FrontMatter.load basedir
+      errors = FrontMatter.validate_with_message_upon_error front_matter
+      abort errors + "\n_config.yml not updated" if errors
+      front_matter.values.sort_by { |fm| fm['permalink'] }
+        .map { |fm| [fm['permalink'], page_nav(fm)] }.to_h
+    end
 
-  def self.page_nav(front_matter)
-    url_components = front_matter['permalink'].split('/')[1..-1]
-    result = {
-      'text' => front_matter['title'],
-      'url' => "#{url_components.nil? ? '' : url_components.last}/",
-      'internal' => true,
-    }
-    # Delete the root URL so we don't have an empty `url:` property laying
-    # around.
-    result.delete 'url' if result['url'] == '/'
-    result
-  end
+    def self.page_nav(front_matter)
+      url_components = front_matter['permalink'].split('/')[1..-1]
+      result = {
+        'text' => front_matter['navtitle'] || front_matter['title'],
+        'url' => "#{url_components.nil? ? '' : url_components.last}/",
+        'internal' => true,
+      }
+      # Delete the root URL so we don't have an empty `url:` property laying
+      # around.
+      result.delete 'url' if result['url'] == '/'
+      result
+    end
 
-  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']
+    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']
+      end
+      original.delete_if { |_url, nav| nav['delete'] }
+      nav_data.delete_if { |nav| nav['delete'] }
+      nav_data.each { |nav| remove_stale_children(nav) }
     end
-    original.delete_if { |_url, nav| nav['delete'] }
-    nav_data.delete_if { |nav| nav['delete'] }
-  end
 
-  def self.apply_nav_update(url, nav, nav_data, original)
-    orig = original[url]
-    if orig.nil?
-      apply_new_nav_item(url, nav, nav_data, original)
-    else
-      orig['text'] = nav['text']
+    def self.remove_stale_children(parent)
+      children = (parent['children'] || [])
+      children.delete_if { |nav| nav['delete'] }
+      parent.delete 'children' if children.empty?
+      children.each { |child| remove_stale_children(child) }
+    end
+
+    def self.apply_nav_update(url, nav, nav_data, original)
+      orig = original[url]
+      if orig.nil?
+        apply_new_nav_item(url, nav, nav_data, original)
+      else
+        orig['text'] = nav['text']
+      end
     end
-  end
 
-  def self.apply_new_nav_item(url, nav, nav_data, original)
-    parent_url = File.dirname(url || '/')
-    parent = original["#{parent_url}/"]
-    if parent_url == '/'
-      nav_data << (original[url] = nav)
-    elsif parent.nil?
-      nav_data << { orphan_url: url }
-    else
-      (parent['children'] ||= []) << nav
+    def self.apply_new_nav_item(url, nav, nav_data, original)
+      parent_url = File.dirname(url || '/')
+      parent = original["#{parent_url}/"]
+      if parent_url == '/'
+        nav_data << (original[url] = nav)
+      elsif parent.nil?
+        nav_data << { orphan_url: url }
+      else
+        (parent['children'] ||= []) << nav
+      end
     end
-  end
 
-  def self.check_for_orphaned_items(nav_data)
-    orphans = nav_data.map { |nav| nav[:orphan_url] }.compact
-    unless orphans.empty?
-      fail(StandardError, "Parent pages missing for the following:\n  " +
-        orphans.join("\n  "))
+    def self.check_for_orphaned_items(nav_data)
+      orphans = nav_data.map { |nav| nav[:orphan_url] }.compact
+      unless orphans.empty?
+        fail(StandardError, "Parent pages missing for the following:\n  " +
+          orphans.join("\n  "))
+      end
     end
-  end
 
-  def self.write_navigation_data_to_config_file(config_path, nav_data)
-    lines = []
-    in_navigation = false
-    open(config_path).each_line do |line|
-      in_navigation = process_line line, lines, nav_data, in_navigation
+    def self.write_navigation_data_to_config_file(config_path, nav_data)
+      lines = []
+      in_navigation = false
+      open(config_path).each_line do |line|
+        in_navigation = process_line line, lines, nav_data, in_navigation
+      end
+      File.write config_path, lines.join
     end
-    File.write config_path, lines.join
-  end
 
-  def self.process_line(line, lines, nav_data, in_navigation = false)
-    if !in_navigation && line.start_with?('navigation:')
-      lines << line << format_navigation_section(nav_data)
-      in_navigation = true
-    elsif in_navigation
-      in_navigation = line.start_with?(' ') || line.start_with?('-')
-      lines << line unless in_navigation
-    else
-      lines << line
-    end
-    in_navigation
-  end
+    def self.process_line(line, lines, nav_data, in_navigation = false)
+      if !in_navigation && line.start_with?('navigation:')
+        lines << line << format_navigation_section(nav_data)
+        in_navigation = true
+      elsif in_navigation
+        in_navigation = line.start_with?(' ') || line.start_with?('-')
+        lines << line unless in_navigation
+      else
+        lines << line
+      end
+      in_navigation
+    end
 
-  YAML_PREFIX = "---\n"
+    YAML_PREFIX = "---\n"
 
-  def self.format_navigation_section(nav_data)
-    nav_data.empty? ? '' : nav_data.to_yaml[YAML_PREFIX.size..-1]
+    def self.format_navigation_section(nav_data)
+      nav_data.empty? ? '' : nav_data.to_yaml[YAML_PREFIX.size..-1]
+    end
   end
 end

data/lib/guides_style_18f/repository.rb

@@ -9,6 +9,7 @@ module GuidesStyle18F
     _pages/add-a-new-page.md
     _pages/add-images.md
     _pages/github-setup.md
+    _pages/images.png
     _pages/post-your-guide.md
     _pages/update-the-config-file/understanding-baseurl.md
     _pages/update-the-config-file.md
@@ -19,7 +20,6 @@ module GuidesStyle18F
     images/gh-default-branch.png
     images/gh-settings-button.png
     images/gh-webhook.png
-    images/images.png
   )
 
   def self.clear_template_files_and_create_new_repository(

data/lib/guides_style_18f/tags.rb

@@ -13,6 +13,7 @@ module GuidesStyle18F
     end
 
     def render(context)
+      return true if context['site']['expand_nav']
       scope = context.scopes.detect { |s| s.member?(reference) }
       parent_url = scope[reference]
       page_url = context['page']['url']

data/lib/guides_style_18f/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: guides_style_18f
 version: !ruby/object:Gem::Version
-  version: 0.1.13
+  version: 0.1.14
 platform: ruby
 authors:
 - Mike Bland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-13 00:00:00.000000000 Z
+date: 2016-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll