guides_style_18f 0.1.10 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4ec06589d99c8ef75a5ca6fe9c89ec8851294fc9
-  data.tar.gz: 452a1cd611819aaed7b7adf051c3ac2921a543c3
+  metadata.gz: b865432024e19d9efd28bbd172864cbd05617067
+  data.tar.gz: 5c90ae1698a6598a898aa00af9660913d9a14784
 SHA512:
-  metadata.gz: 368e204227dcb1711ff7579b4b407e89846f2284e58dc543845107483b2723075c0dc7a7f5ec46dbc85f41abf0573043bdf744695d6e62f5fc4a9b6d402f4166
-  data.tar.gz: 5cea0ecbd854accbf789b551e308a92c500cbfdf41791e76ac0bdb223a924e27c647b9e224652f730022ce3a99aac89afdc2291c58f664f3b0324b3baec9cb23
+  metadata.gz: 421affe591c3bbc4b6551b4362281aa5abdd1cbc44989c55e909f6dd1a8ac071a5726b00706f45e336fee7a4e270fd08134325505dcaf491ea836baa19a19abb
+  data.tar.gz: 33cf1a0b7ffe68fbcc3a2dabb0da5853024a3e5e596c4dfe52b3f5ff84305a6e141f6dc4d25ea5eb9ce1d0925a6cfa4a9be0d030c1d70602aff05c2a4eba7ab0

data/lib/guides_style_18f/navigation.rb

@@ -1,13 +1,18 @@
 # @author Mike Bland (michael.bland@gsa.gov)
 
+require 'jekyll'
 require 'safe_yaml'
 
 module GuidesStyle18F
   module FrontMatter
     def self.load(basedir)
-      Dir[File.join basedir, 'pages', '**', '*.md'].map do |f|
-        [f[basedir.size + 1..-1], SafeYAML.load_file(f, safe: true)]
-      end.to_h
+      # 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
+      # navigation menu is concerned. Any nil values that remain after merging
+      # with the site_file_to_front_matter map will result in a validation
+      # error.
+      init_file_to_front_matter_map(basedir).merge(
+        site_file_to_front_matter(init_site(basedir)))
     end
 
     def self.validate_with_message_upon_error(front_matter)
@@ -23,17 +28,76 @@ module GuidesStyle18F
 
     def self.validate(front_matter)
       front_matter.map do |file, data|
-        next [file, ['no front matter defined']] unless data.instance_of? Hash
+        next [file, ['no front matter defined']] if data.nil?
         errors = missing_property_errors(data) + permalink_errors(data)
         [file, errors] unless errors.empty?
       end.compact.to_h
     end
 
+    private
+
+    def self.init_site(basedir)
+      Dir.chdir(basedir) do
+        config = SafeYAML.load_file('_config.yml', safe: true)
+        adjust_config_paths(basedir, config)
+        site = Jekyll::Site.new(Jekyll.configuration(config))
+        site.reset
+        site.read
+        site
+      end
+    end
+
+    def self.adjust_config_paths(basedir, config)
+      source = config['source']
+      config['source'] = source.nil? ? basedir : File.join(basedir, source)
+      destination = config['destination']
+      destination = '_site' if destination.nil?
+      config['destination'] = File.join(basedir, destination)
+    end
+
+    def self.site_file_to_front_matter(site)
+      site_pages(site).map do |page|
+        [page.relative_path,  page.data]
+      end.to_h
+    end
+
+    # We're supporting two possible configurations:
+    #
+    # - a `pages/` directory in which documents appear as part of the regular
+    #   site.pages collection; we have to filter by page.relative_path, and we
+    #   do not assign a permalink so that validation (in a later step) will
+    #   ensure that each page has a permalink assigned
+    #
+    # - an actual `pages` collection, stored in a `_pages` directory; no
+    #   filtering is necessary, and we can reliably set the permalink to
+    #   page.url as a default
+    def self.site_pages(site)
+      pages = site.collections['pages']
+      if pages.nil?
+        site.pages.select do |page|
+          page.relative_path.start_with?('/pages') || page.url == '/'
+        end
+      else
+        pages.docs.each { |page| page.data['permalink'] ||= page.url }
+      end
+    end
+
+    def self.init_file_to_front_matter_map(basedir)
+      file_to_front_matter = {}
+      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)
+          file_to_front_matter[file_name] = nil
+        end
+      end
+      file_to_front_matter
+    end
+
     def self.missing_property_errors(data)
       properties = %w(title permalink)
       properties.map { |p| "no `#{p}:` property" unless data[p] }.compact
     end
-    private_class_method :missing_property_errors
 
     def self.permalink_errors(data)
       pl = data['permalink']
@@ -43,7 +107,6 @@ module GuidesStyle18F
       errors << "`permalink:` does not end with '/'" unless pl.end_with? '/'
       errors
     end
-    private_class_method :permalink_errors
   end
 
   # Automatically updates the `navigation:` field in _config.yml.
@@ -60,6 +123,8 @@ module GuidesStyle18F
     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 }
@@ -67,7 +132,6 @@ module GuidesStyle18F
     update_parent_nav_data nav_data, pages_data['parents']
     add_children_to_parents nav_data, pages_data['children']
   end
-  private_class_method :update_navigation_data
 
   def self.pages_front_matter(basedir)
     front_matter = FrontMatter.load basedir
@@ -79,7 +143,6 @@ module GuidesStyle18F
     %w(parents children).each { |category| pages_data[category] ||= [] }
     pages_data
   end
-  private_class_method :pages_front_matter
 
   def self.update_parent_nav_data(nav_data, parents)
     nav_by_title = nav_data_by_title nav_data
@@ -93,27 +156,29 @@ module GuidesStyle18F
       end
     end
   end
-  private_class_method :update_parent_nav_data
 
   def self.nav_data_by_title(nav_data)
     nav_data.map { |nav| [nav['text'].downcase, nav] }.to_h
   end
-  private_class_method :nav_data_by_title
 
   def self.page_nav(front_matter)
-    { 'text' => front_matter['title'],
-      'url' => "#{front_matter['permalink'].split('/').last}/",
+    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
-  private_class_method :page_nav
 
   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
   end
-  private_class_method :add_children_to_parents
 
   def self.add_child_to_parent(child, parents_by_title)
     child_nav_data = page_nav child
@@ -128,7 +193,6 @@ module GuidesStyle18F
       children << child_nav_data
     end
   end
-  private_class_method :add_child_to_parent
 
   def self.parent(child, parents_by_title)
     parent = parents_by_title[child['parent'].downcase]
@@ -136,7 +200,6 @@ module GuidesStyle18F
     fail StandardError, 'Parent page not present in existing ' \
       "config: \"#{child['parent']}\" needed by: \"#{child['title']}\""
   end
-  private_class_method :parent
 
   def self.write_navigation_data_to_config_file(config_path, nav_data)
     lines = []
@@ -146,7 +209,6 @@ module GuidesStyle18F
     end
     File.write config_path, lines.join
   end
-  private_class_method :write_navigation_data_to_config_file
 
   def self.process_line(line, lines, nav_data, in_navigation = false)
     if !in_navigation && line.start_with?('navigation:')
@@ -160,5 +222,4 @@ module GuidesStyle18F
     end
     in_navigation
   end
-  private_class_method :process_line
 end

data/lib/guides_style_18f/repository.rb

@@ -5,13 +5,13 @@ require 'fileutils'
 
 module GuidesStyle18F
   TEMPLATE_FILES = %w(
-    pages/baseurl.md
-    pages/child-page.md
-    pages/config.md
-    pages/github.md
-    pages/images.md
-    pages/new-page.md
-    pages/posting.md
+    _pages/add-a-new-page/make-a-child-page.md
+    _pages/add-a-new-page.md
+    _pages/add-images.md
+    _pages/github-setup.md
+    _pages/post-your-guide.md
+    _pages/update-the-config-file/understanding-baseurl.md
+    _pages/update-the-config-file.md
     images/18f-pages.png
     images/description.png
     images/gh-add-guide.png

data/lib/guides_style_18f/version.rb

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

metadata

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