jekyll_frontmatter_tests 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3390788fc5e626d8e51c6abcddc9f25f0e9ba7b4
-  data.tar.gz: ea25e2525dd9916fb809bb7e2090b9d610534345
+  metadata.gz: 88e4c74f874f32f982b5e0023f1ddaa4f98b41ae
+  data.tar.gz: 4e91934e6e0d3071e829b02cbf665a2da0843dcc
 SHA512:
-  metadata.gz: 59ea56ad63966372f43ddb55f8f11d815bd2c9d172e6363abf89e9460bc6fa8ea20857a5d9bbf64c32296ba9986c583f1a5d5f4c14e00bba1419374552adb8b2
-  data.tar.gz: 92a55b109b7b71607f44dced8fb8d8c29f5ac2a481d076783be7110840d357d22e4ff971e0eef4dcd71fdefe028e093e5a8d7af4cf389435f625686453cc70c3
+  metadata.gz: d13d39f28494afb64a01d87ae1833d8ff8af4a2a721757f8cd7396d2ee462ef58fdd4db8826165a9f8d2c8ce6f2eb3c746ffc50f213f9dba84d05dda0e5fece8
+  data.tar.gz: 899b45eeab1d52196e8468fe6b2a65c543840e153da30c2011c93f39f2674380fbe37d03277cb1286577df50dae840c6cd6b3b432ddf8a7033c5a26712f47db8

data/lib/jekyll_frontmatter_tests.rb

@@ -1,9 +1,22 @@
 require 'yaml'
 class FrontmatterTests < Jekyll::Command
   class << self
+    # Public: load the configuration file
+    #
+    # Assumes this is a standard jekyll site
     def config
     	@config ||= YAML.load_file '_config.yml'
     end
+
+    # Public: Load a schema from file.
+    #
+    # file - a string containing a filename
+    #
+    # Used throughout to load a specific file. In the future the directories
+    # where these schema files are located could be loaded from _config.yml
+    #
+    # Returns a hash loaded from the YAML doc or exits 1 if no schema file
+    # exists.
     def loadschema(file)
       schema = File.join("deploy", "tests", "schema", file)
     	if File.exists?(schema)
@@ -14,6 +27,15 @@ class FrontmatterTests < Jekyll::Command
       end
     end
 
+    # Public: processes a collection against a schema
+    #
+    # schmea - the hash-representation of a schema file
+    #
+    # Opens each file in the collection's expected directory and checks the
+    # file's frontmatter for the expected keys and the expected format of the
+    # values.
+    #
+    # Returns true or false depending on the success of the check.
     def process(schema)
     	dir = File.join(schema['config']['path'])
     	passfail = nil
@@ -32,13 +54,19 @@ class FrontmatterTests < Jekyll::Command
     	end
     end
 
-    def check_keys(data, keys, title)
+    # Public: checks a hash for expected keys
+    #
+    # target - the hash under test
+    # keys - an array of keys the data is expected to have, usually loaded from
+    #        a schema file by loadschema()
+    # title - A string representing `data`'s name
+    def check_keys(target, keys, title)
     	keys = keys - ['config']
-    	unless data.respond_to?('keys')
+    	unless target.respond_to?('keys')
     		puts "The file #{title} is missing all frontmatter.".red
     		return false
     	end
-    	diff = keys - data.keys
+    	diff = keys - target.keys
     	if diff == []
     		return true
     	else
@@ -50,37 +78,10 @@ class FrontmatterTests < Jekyll::Command
     	end
     end
 
-    # Works in progress: eventually, validate that the *values* match expected types
+    # Public: tests all documents that are "posts"
     #
-    # For example, if we expect the `date` key to be in yyyy-mm-dd format, validate
-    # that it's been entered in that format. If we expect authors to be an array,
-    # make sure we're getting an array.
-    def check_types(data, schema)
-    	unless data.respond_to?('keys')
-    		return false
-    	end
-    	for s in schema
-    		key  = s[0]
-    		if s[1].class == Hash
-    			type = s[1]['type']
-    		else
-    			type = s[1]
-    		end
-
-    		if type == "Array" and data[key].class == Array
-    			return true
-    		elsif type == "String" and data[key].class == String
-    			return true
-    		elsif type == "Date"
-          require 'pry'; binding.pry
-    			return true
-    		else
-    			puts "    * Data is of the wrong type for key #{key}, expected #{type} but was #{data[key].class}\n\n"
-    			return false
-    		end
-    	end
-    end
-
+    # Loads a schema called _posts.yml and processes all post documents against
+    # it.
     def test_posts
       puts 'testing posts'.green
       yepnope = process(loadschema('_posts.yml'))
@@ -88,6 +89,12 @@ class FrontmatterTests < Jekyll::Command
       yepnope
     end
 
+    # Public: Tests only specific collection documents
+    #
+    # collections - a comma separated string of collection names.
+    #
+    # `collections` is split into an array and each document is loaded and
+    # processed against its respective schema.
     def test_collections(collections)
       yepnope = Array.new
       unless collections.class == Array
@@ -101,6 +108,8 @@ class FrontmatterTests < Jekyll::Command
       yepnope
     end
 
+    # Public: Tests all collections described by a schema file at
+    # `deploy/tests/scema`
     def test_everything
       schema = Dir.open('deploy/tests/schema')
       yepnope = Array.new
@@ -114,6 +123,19 @@ class FrontmatterTests < Jekyll::Command
       yepnope
     end
 
+    # Public: Processes options passed throguh the command line, runs
+    # the appropriate tests.
+    #
+    # args - command line arguments (example: jekyll test [ARG])
+    # options - command line options (example: jekyll test -[option] [value])
+    #
+    # Depending on the flag passed (see `init_with_program`), runs the expected # test.
+    #
+    # Example: the following comamnd `jekyll test -p` will pass ``{'posts' =>
+    #          true}` as `options`. This will cause `test_frontmatter` to
+    #          compare all docs in _posts with the provided schema.
+    #
+    # The test runner pushes the result of each test into a `results` array and # exits `1` if any tests fail or `0` if all is well.
     def test_frontmatter(args, options)
       puts 'starting tests'
       results = Array.new
@@ -135,6 +157,10 @@ class FrontmatterTests < Jekyll::Command
       end
     end
 
+    # Internal: fired when `jekyll test` is run.
+    #
+    # When `jekyll test` runs, `test_frontmatter` is fired with options and args
+    # passed from the command line.
     def init_with_program(prog)
       prog.command(:test) do |c|
         c.syntax "test [options]"
@@ -152,5 +178,35 @@ class FrontmatterTests < Jekyll::Command
         end
       end
     end
+    # Internal: eventually, validate that the *values* match expected types
+    #
+    # For example, if we expect the `date` key to be in yyyy-mm-dd format, validate
+    # that it's been entered in that format. If we expect authors to be an array,
+    # make sure we're getting an array.
+    def check_types(data, schema)
+    	unless data.respond_to?('keys')
+    		return false
+    	end
+    	for s in schema
+    		key  = s[0]
+    		if s[1].class == Hash
+    			type = s[1]['type']
+    		else
+    			type = s[1]
+    		end
+
+    		if type == "Array" and data[key].class == Array
+    			return true
+    		elsif type == "String" and data[key].class == String
+    			return true
+    		elsif type == "Date"
+          require 'pry'; binding.pry
+    			return true
+    		else
+    			puts "    * Data is of the wrong type for key #{key}, expected #{type} but was #{data[key].class}\n\n"
+    			return false
+    		end
+    	end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_frontmatter_tests
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Greg Boone
@@ -19,7 +19,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/jekyll_frontmatter_tests.rb
-homepage: 
+homepage: https://github.com/18f/jekyll-frontmatter-tests
 licenses:
 - CC0
 metadata: {}