guides_style_18f 0.1.11 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b865432024e19d9efd28bbd172864cbd05617067
-  data.tar.gz: 5c90ae1698a6598a898aa00af9660913d9a14784
+  metadata.gz: 7ed8884311059c0f0419dea17f6622f5e56b357a
+  data.tar.gz: 8bac760301892a270a60742dc76e28247159c01c
 SHA512:
-  metadata.gz: 421affe591c3bbc4b6551b4362281aa5abdd1cbc44989c55e909f6dd1a8ac071a5726b00706f45e336fee7a4e270fd08134325505dcaf491ea836baa19a19abb
-  data.tar.gz: 33cf1a0b7ffe68fbcc3a2dabb0da5853024a3e5e596c4dfe52b3f5ff84305a6e141f6dc4d25ea5eb9ce1d0925a6cfa4a9be0d030c1d70602aff05c2a4eba7ab0
+  metadata.gz: 8c29860082cc18fdd88eaf8305fb408ed839612a43959dfb13d1189866287955debe83b0186387a5c9b6ca8cfc091181a39f28a9355b8a7c279c03c657eccd6e
+  data.tar.gz: 0f955271cc7d346e506b41d05bccdf9714dd4d50b8929154785f29f4a0b9426fbefcb4ade3621b3f06ebcb3fc3460a48bc540f736650454b0c65e239c12016d5

data/lib/guides_style_18f/navigation.rb

@@ -119,46 +119,33 @@ module GuidesStyle18F
     config_data = SafeYAML.load_file config_path, safe: true
     return unless config_data
     nav_data = config_data['navigation'] || []
-    nav_data = update_navigation_data nav_data, basedir
-    write_navigation_data_to_config_file config_path, nav_data
+    update_navigation_data(nav_data, basedir)
+    write_navigation_data_to_config_file(config_path, nav_data)
   end
 
   private
 
   def self.update_navigation_data(nav_data, basedir)
-    pages_data = pages_front_matter basedir
-    children = pages_data['children'].map { |child| child['title'].downcase }
-    nav_data.reject! { |nav| children.include? nav['text'].downcase }
-    update_parent_nav_data nav_data, pages_data['parents']
-    add_children_to_parents nav_data, pages_data['children']
+    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.pages_front_matter(basedir)
-    front_matter = FrontMatter.load basedir
-    errors = FrontMatter.validate_with_message_upon_error front_matter
-    abort errors + "\n_config.yml not updated" if errors
-    pages_data = front_matter.values.group_by do |fm|
-      fm['parent'].nil? ? 'parents' : 'children'
-    end
-    %w(parents children).each { |category| pages_data[category] ||= [] }
-    pages_data
-  end
-
-  def self.update_parent_nav_data(nav_data, parents)
-    nav_by_title = nav_data_by_title nav_data
-    parents.each do |page|
-      page_nav = page_nav page
-      title = page_nav['text'].downcase
-      if nav_by_title.member? title
-        nav_by_title[title].merge! page_nav
-      else
-        nav_data << page_nav
-      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'] || []))
     end
   end
 
-  def self.nav_data_by_title(nav_data)
-    nav_data.map { |nav| [nav['text'].downcase, nav] }.to_h
+  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)
@@ -174,31 +161,42 @@ module GuidesStyle18F
     result
   end
 
-  def self.add_children_to_parents(nav_data, children)
-    parents_by_title = nav_data_by_title nav_data
-    children.each { |child| add_child_to_parent child, parents_by_title }
-    nav_data
+  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'] }
   end
 
-  def self.add_child_to_parent(child, parents_by_title)
-    child_nav_data = page_nav child
-    title = child_nav_data['text'].downcase
-    parent = parent child, parents_by_title
-    children = parent['children'] ||= []
-    children_by_title = children.map { |c| [c['text'].downcase, c] }.to_h
+  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
 
-    if children_by_title.member? title
-      children_by_title[title].merge! child_nav_data
+  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
-      children << child_nav_data
+      (parent['children'] ||= []) << nav
     end
   end
 
-  def self.parent(child, parents_by_title)
-    parent = parents_by_title[child['parent'].downcase]
-    return parent unless parent.nil?
-    fail StandardError, 'Parent page not present in existing ' \
-      "config: \"#{child['parent']}\" needed by: \"#{child['title']}\""
+  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
 
   def self.write_navigation_data_to_config_file(config_path, nav_data)
@@ -212,7 +210,7 @@ module GuidesStyle18F
 
   def self.process_line(line, lines, nav_data, in_navigation = false)
     if !in_navigation && line.start_with?('navigation:')
-      lines << line << nav_data.to_yaml["---\n".size..-1]
+      lines << line << format_navigation_section(nav_data)
       in_navigation = true
     elsif in_navigation
       in_navigation = line.start_with?(' ') || line.start_with?('-')
@@ -222,4 +220,10 @@ module GuidesStyle18F
     end
     in_navigation
   end
+
+  YAML_PREFIX = "---\n"
+
+  def self.format_navigation_section(nav_data)
+    nav_data.empty? ? '' : nav_data.to_yaml[YAML_PREFIX.size..-1]
+  end
 end

data/lib/guides_style_18f/version.rb

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

metadata

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