Merge branch 'validate-data'

Author: PeterJCLaw

Rakefile

@@ -1,3 +1,5 @@
+require 'yaml'
+
 task :clean do
   sh('rm -rf _site')
 end
@@ -24,7 +26,23 @@ task :build => [:dependencies, :submodules] do
   sh('bundle exec jekyll build --config _config.yml')
 end
 
-task :validate => [:build] do
+task :validate_kit_versions do
+  data = YAML.load_file('_data/kit_versions.yml')
+  data.each do |entry|
+    actual = entry.keys.to_set
+    expected = ['version', 'released'].to_set
+    missing = expected - actual
+    extra = actual - expected
+    messages = []
+    messages << "Missing keys: #{missing.to_a.join(', ')}" if missing.size() > 0
+    messages << "Extra keys: #{extra.to_a.join(', ')}" if extra.size() > 0
+    raise "For entry\n#{entry}\n#{messages.join("\n")}\n\n" if messages.size() > 0
+  end
+
+  puts "Kit versions validated successfully"
+end
+
+task :validate_links => [:build] do
   # Explanation of arguments:
   # --assume-extension  # Tells html-proofer that `.html` files can be accessed without the `.html` part in the url.
   # --disable-external  # For speed. Ideally we'd check external links too, but ignoring for now.
@@ -33,3 +51,37 @@ task :validate => [:build] do
   # --url-swap          # Adjust for Jekyll's baseurl. See https://github.com/gjtorikian/html-proofer/issues/618 for more.
   sh('bundle exec htmlproofer _site --assume-extension --disable-external --empty-alt-ignore --allow-hash-href --url-swap "^/docs/:/"')
 end
+
+task :validate_sidebar_tree => [:build] do
+  # There are lots of things which this could validate, however we assume that
+  # most changes will be eyeballed by a human. We therefore just check the most
+  # nuanced case -- that the url must be an exact match for its target page.
+
+  def check_url(url)
+    if url.end_with?("/") then
+      return if File.directory?("_site#{url}")
+      raise "Imprecise target url '#{url}' in sidebar (did you mean '#{url[..-2]}'?)\n\n"
+    else
+      return if File.file?("_site#{url}.html")
+      raise "Imprecise target url '#{url}' in sidebar (did you mean '#{url}/'?)\n\n"
+    end
+  end
+
+  def check_nodes(node)
+    check_url(node['url'])
+    if node['tree'] then
+      node['tree'].each do |x|
+        check_nodes(x)
+      end
+    end
+  end
+
+  data = YAML.load_file('_data/sidebar_tree.yaml')
+  data['tree'].each do |x|
+    check_nodes(x)
+  end
+
+  puts "Sidebar links validated successfully"
+end
+
+task :validate => [:validate_kit_versions, :validate_links, :validate_sidebar_tree]

_data/sidebar_tree.yaml

@@ -63,7 +63,7 @@ tree:
         tree:
         - url: /programming/sr/vision/markers
           title: Markers
-    - url: /programming/editors
+    - url: /programming/editors/
       title: Code Editors
       tree:
       - url: /programming/editors/vscode