guides_style_18f 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea930944731dbf4c720382a295ad2f8d1298db6f
-  data.tar.gz: 5f462e287ce9fee7fc67bbd2ec146b991bdc56db
+  metadata.gz: cd5d447399f636ae03c629d890ffcb51ff356411
+  data.tar.gz: 631d01dd0ade29050945220ba2a7754205e4af62
 SHA512:
-  metadata.gz: 308c09132a3f41e8fb39cc4b897753c3fc4cee371f13dce3ea4c44ed0152fc7e1df605ff7d3c91ce8623d0c905e599ca482a5125fcec2fa1883415b1d1916e2c
-  data.tar.gz: 9164d3b7762a6c7c7f0ace8e095ccc55f5824776a6c95e68b5e86cc1cac46fabc6a0888b9192c65222d10a8d60e93789bd3c017ef940912072190f81211885da
+  metadata.gz: fe1e5f02a9eed69c042d4c7ec71a17757aadd476e186f42540f0f6216b165a0986afbe20f8ccac897b2d35ce10ed6a1020b859df41fd4b5d484341bd673765c2
+  data.tar.gz: 85baa1f257bdcc03fd4d2b126ae5e4d4ac11c667ed73a919d3bafe44a7087cd74faa374188852ea2ab861b9f49592ec2178bcd255042018c110ce9397f5de31b

data/lib/guides_style_18f/navigation.rb

@@ -3,6 +3,49 @@
 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
+    end
+
+    def self.validate_with_message_upon_error(front_matter)
+      files_with_errors = validate front_matter
+      return if files_with_errors.empty?
+      message = ['The following files have errors in their front matter:']
+      files_with_errors.each do |file, errors|
+        message << "  #{file}:"
+        message.concat errors.map { |error| "    #{error}" }
+      end
+      message.join "\n" unless message.size == 1
+    end
+
+    def self.validate(front_matter)
+      front_matter.map do |file, data|
+        next [file, ['no front matter defined']] unless data.instance_of? Hash
+        errors = missing_property_errors(data) + permalink_errors(data)
+        [file, errors] unless errors.empty?
+      end.compact.to_h
+    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']
+      return [] if pl.nil?
+      errors = []
+      errors << "`permalink:` does not begin with '/'" unless pl.start_with? '/'
+      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.
   #
   # Does this by parsing the front matter from files in `pages/`. Preserves the
@@ -27,10 +70,10 @@ module GuidesStyle18F
   private_class_method :update_navigation_data
 
   def self.pages_front_matter(basedir)
-    front_matter = Dir[File.join basedir, 'pages', '**', '*.md'].map do |f|
-      SafeYAML.load_file f, safe: true
-    end
-    pages_data = front_matter.group_by do |fm|
+    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] ||= [] }

data/lib/guides_style_18f/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: guides_style_18f
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Mike Bland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-28 00:00:00.000000000 Z
+date: 2015-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll