jekyll_frontmatter_tests 0.0.8 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c9e76205b63d8e4f08abe86ad6a2aa28e6d29842
-  data.tar.gz: c3ec5df610e5fd02c70e72facd953b731c0db75f
+  metadata.gz: d5c718f92a10c456fc3de9200cb9ee118be1ae6d
+  data.tar.gz: 30a742446ac86710459c13c3134f30dbf73b7bc2
 SHA512:
-  metadata.gz: acd380e46f385ca0a2bded057d9fcecd665fdce5ad075660e23acd33c5b9b83edff1009520892ba906bb347d4e4b94bc2d2ec500188971307753979500d0e240
-  data.tar.gz: d3796f082cee72b41f6ea2695a1901ed7faf2a31a575a134de39a58f2b4c6b957dabae5e5cd7b7f28bc3b9799bbdeab731b502789a19e5ec6633dc26269339a5
+  metadata.gz: 4b04dc99b1c587aa6f31fa96d519035584742fc8b85d243bd13cbf521066f5c717793c3c331e61f5b7e88eb563de0f15b5dd565622e06d12c4480c5ef431c903
+  data.tar.gz: 009eacfd2f6f535fa7a8402198e52761ad588a8bd3d9143066466bac8bcc3c4f5ef8f17e57ac67c00c1610d2a0ca1403f2423ed24be19baf1757432554860bf5

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+ruby RUBY_VERSION
+
+gemspec

data/jekyll-frontmatter-tests.gemspec

@@ -0,0 +1,28 @@
+Gem::Specification.new do |s|
+  s.description = 'Tests the frontmatter of posts and other collection documents against a schema'
+  s.summary     = 'Tests jekyll documents for proper frontmatter'
+  s.name        = 'jekyll_frontmatter_tests'
+  s.date        = '2015-09-10'
+  s.license     = 'CC0'
+  s.authors     = ['Greg Boone']
+  s.email       = ['gregory.boone@gsa.gov']
+  s.version     = '0.0.13'
+  s.files       = %w{
+                   jekyll-frontmatter-tests.gemspec
+                   Gemfile
+                 } +
+                 Dir.glob("lib/**/*")
+  s.homepage    = 'https://rubygems.org/gems/jekyll_frontmatter_tests'
+  s.bindir = 'bin'
+  s.post_install_message = "Happy testing!"
+  s.add_dependency "jekyll", [">= 2.0", "< 4.0"]
+  s.add_development_dependency "bundler", "~> 1.7"
+  s.add_development_dependency "rspec", "~> 3.0"
+  s.add_development_dependency "pry", '~> 0'
+  s.add_development_dependency "capybara", '~> 2.11'
+  s.add_development_dependency "chromedriver-helper", '~> 1.0'
+  s.add_development_dependency "rack-jekyll", '~> 0.5'
+  s.add_development_dependency "rb-readline", '~> 0.5.3'
+  s.add_development_dependency "selenium-webdriver", '~> 3.0'
+  s.add_development_dependency "rubocop", '~> 0.47.1'
+end

data/lib/jekyll_frontmatter_tests.rb

@@ -1,207 +1,14 @@
 require 'yaml'
-class FrontmatterTests < Jekyll::Command
-  class << self
-    # 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(@schema['path'], file)
-    	if File.exists?(schema)
-        YAML.load_file(schema)
-      else
-        puts "No schema for #{file}"
-        exit 1
-      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 = Array.new
-    	Dir.open(dir).each do |f|
-    		file = File.open(File.join(dir, f))
-    		unless schema['config']['ignore'].include?(f)
-    			data = YAML.load_file(file)
-    			passfail.push check_keys(data, schema.keys, f)
-    			passfail.push check_types(data, schema)
-    		end
-    	end
-      passfail.keep_if { |p| p == false }
-    	if passfail.empty?
-    		return true
-    	else
-        puts "There were #{passfail.count} errors".red
-    		return false
-    	end
-    end
-
-    # 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 target.respond_to?('keys')
-    		puts "The file #{title} is missing all frontmatter.".red
-    		return false
-    	end
-    	diff = keys - target.keys
-      if diff.empty?
-    		return true
-    	else
-    		puts "\nThe file #{title} is missing the following keys:".red
-    		for k in diff
-    			puts "    * #{k}".red
-    		end
-    		return false
-    	end
-    end
-
-    # Public: tests all documents that are "posts"
-    #
-    # Loads a schema called _posts.yml and processes all post documents against
-    # it.
-    def test_posts
-      puts 'testing posts'.green
-      yepnope = Array.new.push process(loadschema('_posts.yml'))
-      puts 'Finished testing'.green
-      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
-      for c in collections
-        puts "Testing #{c}".green
-        yepnope.push process(loadschema("_#{c}.yml"))
-        puts "Finished testing #{c}".green
-      end
-      yepnope
-    end
-
-    # Public: Tests all collections described by a schema file at
-    # `deploy/tests/scema`
-    def test_everything
-      schema = Dir.open(@schema['path'])
-      yepnope = Array.new
-      schema.each { |s|
-        if s.start_with?('_')
-          puts "Testing #{s}".green
-          yepnope.push process(loadschema(s))
-          puts "Finished testing #{s}".green
-        end
-      }
-      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'
-      if options['posts']
-        results = test_posts
-      elsif options['collections']
-        collections = options['collections'].split(',')
-        results = test_collections(collections)
-      else
-        results = test_everything
-      end
-      unless results.find_index{ |r| r == false }
-        puts 'Tests finished!'
-        exit 0
-      else
-        puts "The test exited with errors, see above."
-        exit 1
-      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)
-      config = Jekyll.configuration
-      unless config.key?('frontmatter_tests')
-        config['frontmatter_tests'] = {'path' => File.join("deploy", "tests", "schema")}
-      end
-      @schema ||= config['frontmatter_tests']
-      prog.command(:test) do |c|
-        c.syntax "test [options]"
-        c.description 'Test your site for frontmatter.'
-
-        c.option 'posts', '-p', 'Target only posts'
-        c.option 'collections', '-c [COLLECTION]', 'Target a specific collection'
-        c.option 'all', '-a', 'Test all collections (Default)'
-
-        c.action do |args, options|
-          if options.empty?
-            options = {"all" => true}
-          end
-          test_frontmatter(args, options)
-        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"
-    			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
+require 'jekyll'
+
+require_relative 'jekyll_frontmatter_tests/jekyll_frontmatter_tests_config'
+require_relative 'jekyll_frontmatter_tests/jekyll_frontmatter_tests_initializer'
+require_relative 'jekyll_frontmatter_tests/jekyll_frontmatter_tests_tester'
+require_relative 'jekyll_frontmatter_tests/jekyll_frontmatter_tests_loader'
+require_relative 'jekyll_frontmatter_tests/jekyll_frontmatter_tests_processor'
+require_relative 'jekyll_frontmatter_tests/jekyll_frontmatter_tests_validator'
+require_relative 'jekyll_frontmatter_tests/jekyll_frontmatter_tests_helper'
+
+module Boolean; end
+class TrueClass; include Boolean; end
+class FalseClass; include Boolean; end

data/lib/jekyll_frontmatter_tests/jekyll_frontmatter_tests_config.rb

@@ -0,0 +1,13 @@
+require 'jekyll'
+
+class FrontmatterTests < Jekyll::Command
+  class << self
+    def schema_config
+      config = Jekyll.configuration
+      unless config.key?('frontmatter_tests')
+        config['frontmatter_tests'] = { 'path' => File.join('deploy', 'tests', 'schema') }
+      end
+      config['frontmatter_tests']
+    end
+  end
+end

data/lib/jekyll_frontmatter_tests/jekyll_frontmatter_tests_helper.rb

@@ -0,0 +1,27 @@
+require 'pry'
+require 'yaml'
+
+class FrontmatterTests < Jekyll::Command
+  class << self
+    def one_of?(data, schema)
+      if schema.instance_of?(Array) && data.instance_of?(Array)
+        (schema & data).count == data.count
+      elsif schema.include? '.yml'
+        schema_list = YAML.load_file(File.join(Dir.pwd, 'tests', 'schema', schema))
+        (schema_list & data).count == data.count
+      elsif schema.instance_of?(String) && data.instance_of?(Array)
+        false
+      else
+        schema == data
+      end
+    end
+
+    def required?(key, schema)
+      if schema['config']
+        !schema['config']['optional'].include? key
+      else
+        true
+      end
+    end
+  end
+end

data/lib/jekyll_frontmatter_tests/jekyll_frontmatter_tests_initializer.rb

@@ -0,0 +1,27 @@
+require 'pry'
+require 'yaml'
+require 'jekyll'
+
+class FrontmatterTests < Jekyll::Command
+  class << self
+    # 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]'
+        c.description 'Test your site for frontmatter.'
+
+        c.option 'posts', '-p', 'Target only posts'
+        c.option 'collections', '-c [COLLECTION]', 'Target a specific collection'
+        c.option 'all', '-a', 'Test all collections (Default)'
+
+        c.action do |args, options|
+          options = { 'all' => true } if options.empty?
+          test_frontmatter(args, options)
+        end
+      end
+    end
+  end
+end

data/lib/jekyll_frontmatter_tests/jekyll_frontmatter_tests_loader.rb

@@ -0,0 +1,27 @@
+require 'pry'
+require 'yaml'
+
+class FrontmatterTests < Jekyll::Command
+  class << self
+    # 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 load_schema(file)
+      # binding.pry
+      schema = File.join(Dir.pwd, schema_config['path'], file)
+      # binding.pry
+      if File.exist?(schema)
+        YAML.load_file(schema)
+      else
+        puts "No schema for #{file}"
+        exit 1
+      end
+    end
+  end
+end

data/lib/jekyll_frontmatter_tests/jekyll_frontmatter_tests_processor.rb

@@ -0,0 +1,38 @@
+require 'pry'
+require 'yaml'
+
+class FrontmatterTests < Jekyll::Command
+  class << self
+    # Public: processes a collection against a schema
+    #
+    # schema - 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.
+    #
+    # NOTE - As it iterates through files, subdirectories will be ignored
+    #
+    # Returns true or false depending on the success of the check.
+    def process(schema)
+      dir = File.join(schema['config']['path'])
+      passfail = []
+      Dir.open(dir).each do |f|
+        next if File.directory?(File.join(dir, f))
+        file = File.open(File.join(dir, f))
+        next if schema['config']['ignore'].include?(f)
+        data = YAML.load_file(file)
+
+        passfail.push check_keys(data, schema.keys, f)
+        passfail.push check_types(data, schema, File.join(dir, f))
+      end
+      passfail.keep_if { |p| p == false }
+      if passfail.empty?
+        return true
+      else
+        puts "There were #{passfail.count} errors".red
+        return false
+      end
+    end
+  end
+end

data/lib/jekyll_frontmatter_tests/jekyll_frontmatter_tests_tester.rb

@@ -0,0 +1,79 @@
+require 'pry'
+require 'yaml'
+
+class FrontmatterTests < Jekyll::Command
+  class << self
+    # 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'
+      if options['posts']
+        results = test_posts
+      elsif options['collections']
+        collections = options['collections'].split(',')
+        results = test_collections(collections)
+      else
+        results = test_everything
+      end
+      if results.find_index { |r| r == false }
+        puts 'The test exited with errors, see above.'
+        exit 1
+      else
+        puts 'Tests finished!'
+        exit 0
+      end
+    end
+
+    # Public: tests all documents that are "posts"
+    #
+    # Loads a schema called _posts.yml and processes all post documents against
+    # it.
+    def test_posts
+      puts 'testing posts'.green
+      yepnope = [].push process(load_schema('_posts.yml'))
+      puts 'Finished testing'.green
+      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 = []
+      for c in collections
+        puts "Testing #{c}".green
+        yepnope.push process(load_schema("_#{c}.yml"))
+        puts "Finished testing #{c}".green
+      end
+      yepnope
+    end
+
+    # Public: Tests all collections described by a schema file at
+    # `deploy/tests/schema`
+    def test_everything
+      schema = Dir.open(schema_config['path'])
+      yepnope = []
+      schema.each do |s|
+        next unless s.start_with?('_')
+        puts "Testing #{s}".green
+        yepnope.push process(load_schema(s))
+        puts "Finished testing #{s}".green
+      end
+      yepnope
+    end
+  end
+end

data/lib/jekyll_frontmatter_tests/jekyll_frontmatter_tests_validator.rb

@@ -0,0 +1,77 @@
+require 'pry'
+require 'yaml'
+
+class FrontmatterTests < Jekyll::Command
+  class << self
+    # 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 -= ['config']
+      unless target.respond_to?('keys')
+        puts "The file #{title} is missing all frontmatter.".red
+        return false
+      end
+      diff = keys - target.keys
+      if diff.empty?
+        return true
+      else
+        puts "\nThe file #{title} is missing the following keys:".red
+        for k in diff
+          puts "    * #{k}".red
+        end
+        return false
+      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, file)
+      return false unless data.respond_to?('keys')
+      schema.each do |s|
+        key = s[0]
+        value = s[1]
+        type = if value.class == Hash
+                 value['type']
+               else
+                 value
+               end
+        next unless required?(key, schema)
+        if key == 'config'
+          next
+        elsif value.class == Hash
+          if value.keys.include? 'one_of'
+            if !one_of?(data[key], value['one_of'])
+              puts "    * '#{data[key]}' was not in the list " \
+                   "of expected values in #{file}.".red
+              puts "      expected one of the following: #{s[1]['one_of']}\n".red
+              return false
+            else
+              next
+            end
+          else
+            next
+          end
+        elsif type == 'Array' && data[key].class == Array
+          next
+        elsif type == 'Boolean' && data[key].is_a?(Boolean)
+          next
+        elsif type == 'String' && data[key].class == String
+          next
+        elsif type == 'Date'
+          next
+        else
+          puts "    * '#{key}' is not a valid key in #{file}. " \
+               "Expected #{type} but was #{data[key].class}\n\n"
+          return false
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_frontmatter_tests
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.13
 platform: ruby
 authors:
 - Greg Boone
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-29 00:00:00.000000000 Z
+date: 2015-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -72,6 +72,90 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: chromedriver-helper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rack-jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: rb-readline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.47.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.47.1
 description: Tests the frontmatter of posts and other collection documents against
   a schema
 email:
@@ -80,12 +164,21 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- Gemfile
+- jekyll-frontmatter-tests.gemspec
 - lib/jekyll_frontmatter_tests.rb
+- lib/jekyll_frontmatter_tests/jekyll_frontmatter_tests_config.rb
+- lib/jekyll_frontmatter_tests/jekyll_frontmatter_tests_helper.rb
+- lib/jekyll_frontmatter_tests/jekyll_frontmatter_tests_initializer.rb
+- lib/jekyll_frontmatter_tests/jekyll_frontmatter_tests_loader.rb
+- lib/jekyll_frontmatter_tests/jekyll_frontmatter_tests_processor.rb
+- lib/jekyll_frontmatter_tests/jekyll_frontmatter_tests_tester.rb
+- lib/jekyll_frontmatter_tests/jekyll_frontmatter_tests_validator.rb
 homepage: https://rubygems.org/gems/jekyll_frontmatter_tests
 licenses:
 - CC0
 metadata: {}
-post_install_message: 
+post_install_message: Happy testing!
 rdoc_options: []
 require_paths:
 - lib
@@ -101,7 +194,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Tests jekyll documents for proper frontmatter