Add FrontMatterVariableMeetsLengthRequirements check

Author: mpchadwick

README.md

@@ -30,22 +30,47 @@ pre-commit:
     variables: ['description', 'image']
   - check: FrontMatterVariableIsNotDuplicate
     variables: ['description']
-  - check: DescriptionIsGoodLength
+  - check: FrontMatterVariableMeetsLengthRequirements
+    variables: ['description', 'title']
 ```
 
 ## Available Checks
 
 #### FrontMatterVariableExists
 
-This check ensures that any variable properties exist in the front matter of any post that is staged to be committed.
+This check ensures that any listed variables exist in the front matter of any post that is staged to be committed.
 
 #### FrontMatterVariableIsNotDuplicate
 
 This check ensures that any listed variable in the front matter of any post that is staged to be committed are unique amongst all the posts on your site.
 
-#### DescriptionIsGoodLength
+#### FrontMatterVariableMeetsLengthRequirements
 
-This check ensures that the `description` in the front matter of any post that is staged to be commited is a [good length](https://moz.com/learn/seo/meta-description). Specifically it checks that the description is between 145 and 165 characters.
+This check ensures that any listed variable in the front matter of any post that is staged to be committed meet the length requirements (in number of characters).
+
+This check includes the following defaults:
+
+**title**
+
+- max: 59
+
+**description**
+
+- min: 145
+- max: 165
+
+These can be overridden, or requirements can be specified for other variables in the following format...
+
+- `variable|min|max`
+
+For example...
+
+```yaml
+- check: FrontMatterVariableMeetsLengthRequirements
+  variables: ['title||50']
+```
+
+In the above, there would be a maximum length of 50 characters for the title (rather than the default of 59)
 
 ## Contributing
 

lib/jekyll-pre-commit.rb

@@ -9,4 +9,4 @@ module PreCommit
 require 'jekyll-pre-commit/checks/check.rb'
 require 'jekyll-pre-commit/checks/front_matter_variable_exists.rb'
 require 'jekyll-pre-commit/checks/front_matter_variable_is_not_duplicate.rb'
-require 'jekyll-pre-commit/checks/description_is_good_length.rb'
+require 'jekyll-pre-commit/checks/front_matter_variable_meets_length_requirements.rb'

lib/jekyll-pre-commit/checks/description_is_good_length.rb

@@ -2,7 +2,7 @@ module Jekyll
   module PreCommit
     module Check
       class FrontMatterVariableExists < Check
-        def Check(staged, not_staged, site, args)
+        def check(staged, not_staged, site, args)
           if !args["variables"]
             @result[:message] += "No variables to check."
             return @result

lib/jekyll-pre-commit/checks/front_matter_variable_exists.rb

@@ -2,7 +2,7 @@ module Jekyll
   module PreCommit
     module Check
       class FrontMatterVariableIsNotDuplicate < Check
-        def Check(staged, not_staged, site, args)
+        def check(staged, not_staged, site, args)
           if !args["variables"]
             @result[:message] += "No variables to check."
             return @result

lib/jekyll-pre-commit/checks/front_matter_variable_is_not_duplicate.rb

@@ -0,0 +1,54 @@
+module Jekyll
+  module PreCommit
+    module Check
+      class FrontMatterVariableMeetsLengthRequirements < Check
+
+        DEFAULT_LENGTH_REQUIREMENTS = {
+          "description" => {
+            "min" => 145,
+            "max" => 165,
+          },
+          "title" => {
+            "max" => 59
+          }
+        }
+
+        def check(staged, not_staged, site, args)
+          if !args["variables"]
+            @result[:message] += "No variables to check."
+            return @result
+          end
+
+          staged.each do |post|
+            args["variables"].each do |variable|
+              parts = variable.split('|')
+              next if !post.data[parts[0]]
+              # If use custom configuration if provided
+              if parts[1]
+                min = parts[1].to_i
+                max = parts[2].to_i
+              else
+                if DEFAULT_LENGTH_REQUIREMENTS[variable] && DEFAULT_LENGTH_REQUIREMENTS[variable]["min"]
+                  min = DEFAULT_LENGTH_REQUIREMENTS[variable]["min"]
+                end
+                if DEFAULT_LENGTH_REQUIREMENTS[variable] && DEFAULT_LENGTH_REQUIREMENTS[variable]["max"]
+                  max = DEFAULT_LENGTH_REQUIREMENTS[variable]["max"]
+                end
+              end
+
+              if min && post.data[parts[0]].length < min
+                @result[:ok] = false
+                @result[:message] += "#{post.data["title"]}'s #{parts[0]} is too short. "
+              elsif max && post.data[parts[0]].length > max
+                @result[:ok] = false
+                @result[:message] += "#{post.data["title"]}'s #{parts[0]} is too long. "
+              end
+            end
+          end
+
+          @result
+        end
+      end
+    end
+  end
+end

lib/jekyll-pre-commit/checks/front_matter_variable_meets_length_requirements.rb

@@ -35,7 +35,7 @@ def run(site, staged_files)
             result[:messages].push("The check #{c["check"]} does not exist! Please fix your configuration.")
             break
           end
-          r = o.Check(staged_posts, not_staged_posts, site, c)
+          r = o.check(staged_posts, not_staged_posts, site, c)
           if !r[:ok]
             result[:ok] = false
           end

lib/jekyll-pre-commit/runner.rb

@@ -0,0 +1,10 @@
+---
+layout: post
+title:  "description-is-too-long-for-custom-length-requirements"
+description: description-is-too-long-for-custom-length-requirements description-is-too-long-for-custom-length-requirements description-is-too-long-for-custom-length-requirements description-is-too-long-for-custom-length-requirements description-is-too-long-for-custom-length-requirements description-is-too-long-for-custom-length-requirements description-is-too-long-for-custom-length-requirements description-is-too-long-for-custom-length-requirements description-is-too-long-for-custom-length-requirements description-is-too-long-for-custom-length-requirements description-is-too-long-for-custom-length-requirements description-is-too-long-for-custom-length-requirements
+---
+
+!
+
+
+description-is-too-long-for-custom-length-requirements

spec/fixtures/_posts/2017-01-09-description-is-too-long-for-custom-length-requirements.md

@@ -136,8 +136,9 @@
     end
   end
 
-  context "with description is good length check" do
-    let(:site) { build_site({'pre-commit' => [{"check" => "DescriptionIsGoodLength"}]}) }
+  context "with FrontMatterVariableMeetsLengthRequirements checking description with default length settings" do
+    pre_commit_config = {"check" => "FrontMatterVariableMeetsLengthRequirements", "variables" => ["description"]}
+    let(:site) { build_site({ 'pre-commit' => [pre_commit_config] }) }
 
     it "fails if a staged post has a description that's too long" do
       result = runner.run(site, ["spec/fixtures/_posts/2017-01-06-description-is-too-long.md"])
@@ -158,6 +159,29 @@
     end
   end
 
+  context "with FrontMatterVariableMeetsLengthReqirements checking description with custom length settings" do
+    pre_commit_config = {"check" => "FrontMatterVariableMeetsLengthRequirements", "variables" => ["description||200"]}
+    let(:site) { build_site({ 'pre-commit' => [pre_commit_config] }) }
+
+    it "passes if a staged post is doesn't meet default requirements, but meets custom requirements" do
+      result = runner.run(site, ["spec/fixtures/_posts/2017-01-06-description-is-too-long.md"])
+      expect(result[:ok]).to eql(true)
+      expect(result[:messages]).to match_array([])
+    end
+
+    it "passes if a staged post is doesn't meet default requirements, but meets custom requirements - #2" do
+      result = runner.run(site, ["spec/fixtures/_posts/2017-01-06-description-is-too-short.md"])
+      expect(result[:ok]).to eql(true)
+      expect(result[:messages]).to match_array([])
+    end
+
+    it "fails if a staged post doesn't meet custom length requirements" do
+      result = runner.run(site, ["spec/fixtures/_posts/2017-01-09-description-is-too-long-for-custom-length-requirements.md"])
+      expect(result[:ok]).to eql(false)
+      expect(result[:messages]).to match_array(["description-is-too-long-for-custom-length-requirements's description is too long. "])
+    end
+  end
+
   context "with a check that doesn't exist" do
     pre_commit_config = {"check" => "Garbage"}
     let(:site) { build_site({ 'pre-commit' => [pre_commit_config] }) }