jekyll_frontmatter_tests 0.0.13 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d5c718f92a10c456fc3de9200cb9ee118be1ae6d
-  data.tar.gz: 30a742446ac86710459c13c3134f30dbf73b7bc2
+  metadata.gz: 00fc0de9a96a87565919528bf16f8cecad3c3df6
+  data.tar.gz: aa548a8fc5dee79b5b7ff7907987a15a4024dfe6
 SHA512:
-  metadata.gz: 4b04dc99b1c587aa6f31fa96d519035584742fc8b85d243bd13cbf521066f5c717793c3c331e61f5b7e88eb563de0f15b5dd565622e06d12c4480c5ef431c903
-  data.tar.gz: 009eacfd2f6f535fa7a8402198e52761ad588a8bd3d9143066466bac8bcc3c4f5ef8f17e57ac67c00c1610d2a0ca1403f2423ed24be19baf1757432554860bf5
+  metadata.gz: 48ebfb873111a3966f5bf0e074d64f1a487f60a4ad9b25c1485ef93229db913920eba78dd1eabf9c740109fb93fb021b4559700f47b8426568af47a1517e5b33
+  data.tar.gz: b9ca0920616cc2e705313ef047827cb965925dae96fa0dbd75883b515c9afcfd56ec0bf9b83a27e19c134708837936afe9c2a53f069a5d1989e1fe37e3e3678d

data/jekyll-frontmatter-tests.gemspec

@@ -1,3 +1,7 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jekyll_frontmatter_tests/version'
+
 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'
@@ -6,7 +10,7 @@ Gem::Specification.new do |s|
   s.license     = 'CC0'
   s.authors     = ['Greg Boone']
   s.email       = ['gregory.boone@gsa.gov']
-  s.version     = '0.0.13'
+  s.version     = JekyllFrontmatterTests::VERSION
   s.files       = %w{
                    jekyll-frontmatter-tests.gemspec
                    Gemfile

data/lib/jekyll_frontmatter_tests.rb

@@ -6,6 +6,7 @@ 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_rules'
 require_relative 'jekyll_frontmatter_tests/jekyll_frontmatter_tests_validator'
 require_relative 'jekyll_frontmatter_tests/jekyll_frontmatter_tests_helper'
 

data/lib/jekyll_frontmatter_tests/jekyll_frontmatter_tests_helper.rb

@@ -16,11 +16,28 @@ class FrontmatterTests < Jekyll::Command
       end
     end
 
+    def follows_rules?(value, rules)
+      if rules.include?('no-dash') && rules.include?('lowercase')
+        FrontmatterRules.dashless?(value) && FrontmatterRules.lowercase?(value)
+      elsif rules.include?('no-dash') && !rules.include?('lowercase')
+        FrontmatterRules.dashless?(value)
+      elsif !rules.include?('no-dash') && rules.include?('lowercase')
+        FrontmatterRules.lowercase?(value)
+      end
+    end
+
     def required?(key, schema)
-      if schema['config']
-        !schema['config']['optional'].include? key
+      is_required = true
+      is_primary = schema[key]
+      schema['config'] = schema['config'] || { 'optional': [] }
+      is_optional = schema['config']['optional'].include?(key)
+
+      if is_primary && !is_optional
+        is_required
+      elsif (is_primary && is_optional) || (!is_primary && is_optional)
+        !is_required
       else
-        true
+        raise 'The key provided is not in the schema.'
       end
     end
   end

data/lib/jekyll_frontmatter_tests/jekyll_frontmatter_tests_rules.rb

@@ -0,0 +1,52 @@
+require 'pry'
+require 'yaml'
+
+class FrontmatterRules
+  class << self
+    # Returns true if there are no dashes in any of the values
+    def dashless?(values)
+      rules_config = RulesConfig.new
+      rules = rules_config.rules['no-dash'] || rules_config.empty_rule
+      exceptions = rules['exceptions'].compact
+      if values.instance_of?(Array)
+        no_dashes = values.map do |value|
+          (!value.include?('-') && !value.include?('–')) || exceptions.include?(value)
+        end
+        # no_dashes will only have false values if there are dashes present
+        !no_dashes.include? false
+      elsif values.instance_of?(String)
+        (!values.include?('-') && !values.include?('–')) || exceptions.include?(values)
+      end
+    end
+
+    # Returns true if there are no uppercase characters in any of the values
+    def lowercase?(values)
+      rules_config = RulesConfig.new
+      rules = rules_config.rules['lowercase'] || rules_config.empty_rule
+      exceptions = rules['exceptions'].compact
+      if values.instance_of?(Array)
+        all_lowercase = values.map do |value|
+          (value.downcase == value) || exceptions.include?(value)
+        end
+        # all_lowercase will only have false values if there are are uppercase
+        # characters present
+        !all_lowercase.include? false
+      elsif values.instance_of?(String)
+        (values.downcase === values) || exceptions.include?(values)
+      end
+    end
+  end
+end
+
+class RulesConfig
+  def initialize
+    rules_yml = File.join(Dir.pwd, 'tests', 'schema', 'rules.yml')
+    gem_path = $LOAD_PATH.select { |p| p.include? 'jekyll_frontmatter_tests' }
+    default_rules_yml = File.join(gem_path, 'rules.yml')
+    rules_config = File.exists?(rules_yml) ? rules_yml : default_rules_yml
+    @rules = YAML.load_file(rules_config)
+    @empty_rule = { "exceptions"=>[] }
+  end
+
+  attr_reader :rules, :empty_rule
+end

data/lib/jekyll_frontmatter_tests/jekyll_frontmatter_tests_validator.rb

@@ -27,6 +27,10 @@ class FrontmatterTests < Jekyll::Command
       end
     end
 
+    def basepath
+      File.join(Dir.pwd, 'tests', 'schema')
+    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
@@ -42,22 +46,16 @@ class FrontmatterTests < Jekyll::Command
                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
+          next unless value.keys.include?('one_of') || value.keys.include?('rules')
+          violate_one_of = check_one_of(data, key, value) == false
+          violate_rules = check_rules(data, key, value) == false
+          return false if violate_one_of || violate_rules
+
         elsif type == 'Array' && data[key].class == Array
           next
         elsif type == 'Boolean' && data[key].is_a?(Boolean)
@@ -67,11 +65,30 @@ class FrontmatterTests < Jekyll::Command
         elsif type == 'Date'
           next
         else
-          puts "    * '#{key}' is not a valid key in #{file}. " \
+          puts "    * invalid value for '#{key}' in #{file}. " \
                "Expected #{type} but was #{data[key].class}\n\n"
           return false
         end
       end
     end
+
+    def check_one_of(data, key, value)
+      if value.keys.include?('one_of') && !one_of?(data[key], value['one_of'])
+        puts "    * One of error: One of '#{data[key]}' was not".red
+        puts "                    in the list of expected values in".red
+        puts "                    #{File.join(basepath, value['one_of'])}\n".yellow
+
+        false
+      end
+    end
+
+    def check_rules(data, key, value)
+      if value.keys.include?('rules') && !follows_rules?(data[key], value['rules'])
+        puts "    * Rules error: One of '#{data[key]}'".red
+        puts "                   doesn't follow the rules defined in".red
+        puts "                   #{basepath}/rules.yml\n".yellow
+        false
+      end
+    end
   end
 end

data/lib/jekyll_frontmatter_tests/version.rb

@@ -0,0 +1,3 @@
+module JekyllFrontmatterTests
+  VERSION = '0.1.0'
+end

data/lib/rules.yml

@@ -0,0 +1,4 @@
+no-dash:
+  exceptions:
+lowercase:
+  exceptions:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_frontmatter_tests
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.1.0
 platform: ruby
 authors:
 - Greg Boone
@@ -172,8 +172,11 @@ files:
 - 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_rules.rb
 - lib/jekyll_frontmatter_tests/jekyll_frontmatter_tests_tester.rb
 - lib/jekyll_frontmatter_tests/jekyll_frontmatter_tests_validator.rb
+- lib/jekyll_frontmatter_tests/version.rb
+- lib/rules.yml
 homepage: https://rubygems.org/gems/jekyll_frontmatter_tests
 licenses:
 - CC0