jekyll-pre-commit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ba0866d2499fbb528292ed308379b106d0fdab53
+  data.tar.gz: ceb1d3b4cb328cecbfe37fb562dd228ab082af83
+SHA512:
+  metadata.gz: 24773f04d3fdbdc8528969df8057e6a695e822366d40fa04ed995472f071af191f37ccceff70a6fdee92dde7ddd4c835bcd9b75febcfcfefb4ee10eda5694582
+  data.tar.gz: 080f9210aee062769c4f7f1500452a5b77b4dafd73b416eb9490ae989f518b492285bb45fbc4ba17b45dc18a57102381aacfb1093aac81a0757fb104db50865f

data/.editorconfig

@@ -0,0 +1,16 @@
+# EditorConfig is awesome: http://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+[*.rb]
+indent_style = space
+indent_size = 2
+
+[pre-commit]
+indent_style = space
+indent_size = 2

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jekyll-pre-commit.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Max Chadwick
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,115 @@
+# jekyll-pre-commit
+
+A Jekyll plugin to make sure your post is _really_ ready for publishing.
+
+![Terminal showing failed check](http://i.imgur.com/9PzDMiB.jpg)
+
+## Installation
+
+Add this line to your `Gemfile`:
+
+```ruby
+group :jekyll_plugins do
+  gem 'jekyll-migrate-permalink'
+end
+```
+
+Then execute the `bundle` command to install the gem.
+
+Next run `bundle exec jekyll pre-commit init` in the root of your Jekyll site. 
+
+This will symlink this plugin's `pre-commit` file to the `.git/hooks/` directory of your project.
+
+If you provide the `--force` flag when running `bundle exec jekyll pre-commit init` any existing `pre-commit` file will be deleted.
+
+## Usage
+
+Once installed you may choose the pre-commit checks you would like to use by listing them in your site's `_config.yml`.
+
+```yaml
+pre-commit:
+  - check: FrontMatterVariableExists
+    variables: ['description', 'image']
+  - check: FrontMatterVariableIsNotDuplicate
+    variables: ['description']
+  - check: FrontMatterVariableMeetsLengthRequirements
+    variables: ['description', 'title']
+```
+
+## Available Checks
+
+#### FrontMatterVariableExists
+
+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 variables are unique amongst all the posts on your site in the front matter of any post that is staged to be committed.
+
+#### FrontMatterVariableMeetsLengthRequirements
+
+This check ensures that any listed variables meet the length requirements (in number of characters) in the front matter of any post that is staged to be committed.
+
+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)
+
+## Roll Your Own
+
+You can also add your own checks. To do so, create a class in the `Jekyll::PreCommit::Checks` module and and define a `check` method. Your class should extend the `Jekyll::PreCommit::Checks::Check` class and return the `@result` instance variable. 
+
+For example...
+
+```ruby
+module Jekyll
+  module PreCommit
+    module Checks
+      class DoesNothing < Check
+        def check(staged, not_staged, site, args)
+          @result
+        end
+      end
+    end
+  end
+end
+```
+
+Put this file in your plugins_path (which is _plugins by default) and `jekyll-pre-commit` will load it automatically. Then just specify that you'd like to run this check in your front matter.
+
+```yaml
+pre-commit:
+  - check: DoesNothing
+```
+
+As you can probably tell by the name, this check doesn't actually do anything. Review the checks in `lib/jekyll-pre-commit/checks` for some more useful examples.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mpchadwick/jekyll-pre-commit.
+
+Please ensure tests pass (using rspec) before submitting a pull request and provide test coverage for any new features.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/jekyll-pre-commit.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jekyll-pre-commit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-pre-commit"
+  spec.version       = Jekyll::PreCommit::VERSION
+  spec.authors       = ["Max Chadwick"]
+  spec.email         = ["mpchadwick@gmail.com"]
+
+  spec.summary       = %q{A Jekyll plugin to make sure your post is _really_ ready for publishing}
+  spec.homepage      = "https://github.com/mpchadwick/jekyll-pre-commit"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/jekyll-pre-commit/checks/check.rb

@@ -0,0 +1,11 @@
+module Jekyll
+  module PreCommit
+    module Checks
+      class Check
+        def initialize
+          @result = { :ok => true, :message => "" }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+module Jekyll
+  module PreCommit
+    module Checks
+      class FrontMatterVariableExists < Check
+        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|
+              if !post.data[variable]
+                @result[:ok] = false
+                @result[:message] += "#{post.data["title"]} was missing a #{variable}. "
+              end
+            end
+          end
+
+          @result
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+module Jekyll
+  module PreCommit
+    module Checks
+      class FrontMatterVariableIsNotDuplicate < Check
+        def check(staged, not_staged, site, args)
+          if !args["variables"]
+            @result[:message] += "No variables to check."
+            return @result
+          end
+
+          existing = Hash.new
+          not_staged.each do |post|
+            args["variables"].each do |variable|
+              if !existing[variable]
+                existing[variable] = Array.new
+              end
+              existing[variable].push(post.data[variable]) if post.data[variable]
+            end
+          end
+
+          staged.each do |post|
+            args["variables"].each do |variable|
+              if existing[variable].include? post.data[variable]
+                @result[:ok] = false
+                @result[:message] += "#{post.data["title"]}'s #{variable} was already used. "
+              end
+            end
+          end
+
+          @result
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+module Jekyll
+  module PreCommit
+    module Checks
+      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

data/lib/jekyll-pre-commit/commands.rb

@@ -0,0 +1,37 @@
+module Jekyll
+  module Commands
+    class PreCommit < Command
+      class << self
+        def init_with_program(prog)
+          prog.command(:"pre-commit") do |c|
+            c.syntax 'pre-commit SUBCOMMAND'
+            c.description 'Runs SUBCOMMAND'
+            c.option "force", "--force", "Overwrites an existing pre-commit if one already exists"
+
+            c.action do |args, options|
+              raise ArgumentError, "You must provide a subcommand" if args.empty?
+              if args.include? "init"
+                dest = "#{Dir.pwd}/.git/hooks/pre-commit"
+                if (File.exist?(dest) && !options["force"])
+                  Jekyll.logger.abort_with "An existing pre-commit file already exists. If you'd like" \
+                    " to overwrite that file (e.g. you're upgrading) pass the --force flag."
+                end
+
+                if (File.exist?(dest))
+                  File.delete(dest)
+                end
+
+                # Is there a better way to resolve this path?
+                src = `bundle show jekyll-pre-commit`
+                src = src.strip + "/lib/jekyll-pre-commit/pre-commit"
+
+                File.symlink src, dest
+                puts "pre-commit hook file created!"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jekyll-pre-commit/pre-commit

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+
+$VERBOSE = nil
+
+require "jekyll"
+
+Jekyll.logger.adjust_verbosity(
+  :quiet => true
+)
+
+Jekyll::PluginManager.require_from_bundler
+
+config = Jekyll.configuration
+config["future"] = true
+
+site = Jekyll::Site.new(config)
+site.reset
+site.read
+
+staged_files = `git diff --cached --name-only --diff-filter=ACM`.split("\n")
+
+runner = Jekyll::PreCommit::Runner.new
+result = runner.run(site, staged_files)
+
+if result[:ok]
+  exit(0)
+end
+
+puts "There were failed checks 😥"
+result[:messages].each do |c|
+  puts c
+end
+exit(1)

data/lib/jekyll-pre-commit/runner.rb

@@ -0,0 +1,51 @@
+module Jekyll
+  module PreCommit
+    class Runner
+
+      def run(site, staged_files)
+        result = { :ok => true, :messages => [] }
+        if !site.config["pre-commit"] || site.config["pre-commit"].empty?
+          # Bail if there are no pre-commit checks enabled
+          result[:messages].push("No pre-commit checks enabled")
+          return result
+        end
+
+        staged_posts = Array.new
+        not_staged_posts = Array.new
+
+        site.posts.docs.each do |p|
+          if (staged_files.include? p.path.gsub(Dir.pwd + "/", ""))
+            staged_posts.push(p)
+          else
+            not_staged_posts.push(p)
+          end
+        end
+
+        if staged_posts.empty?
+          # If no posts are being committed. Safe to commit.
+          result[:messages].push("No posts staged")
+          return result
+        end
+
+        site.config["pre-commit"].each do |c|
+          begin
+            o = Object.const_get("Jekyll::PreCommit::Checks::" + c["check"]).new
+          rescue
+            result[:ok] = false
+            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)
+          if !r[:ok]
+            result[:ok] = false
+          end
+          if r[:message] != ""
+            result[:messages].push(r[:message])
+          end
+        end
+
+        return result
+      end
+    end
+  end
+end

data/lib/jekyll-pre-commit/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module PreCommit
+    VERSION = "0.1.0"
+  end
+end

data/lib/jekyll-pre-commit.rb

@@ -0,0 +1,12 @@
+module Jekyll
+  module PreCommit
+    autoload :VERSION, 'jekyll-pre-commit/version.rb'
+  end
+end
+
+require 'jekyll-pre-commit/runner.rb'
+require 'jekyll-pre-commit/commands.rb'
+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/front_matter_variable_meets_length_requirements.rb'

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-pre-commit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Max Chadwick
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- mpchadwick@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .editorconfig
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- jekyll-pre-commit.gemspec
+- lib/jekyll-pre-commit.rb
+- lib/jekyll-pre-commit/checks/check.rb
+- lib/jekyll-pre-commit/checks/front_matter_variable_exists.rb
+- lib/jekyll-pre-commit/checks/front_matter_variable_is_not_duplicate.rb
+- lib/jekyll-pre-commit/checks/front_matter_variable_meets_length_requirements.rb
+- lib/jekyll-pre-commit/commands.rb
+- lib/jekyll-pre-commit/pre-commit
+- lib/jekyll-pre-commit/runner.rb
+- lib/jekyll-pre-commit/version.rb
+homepage: https://github.com/mpchadwick/jekyll-pre-commit
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14.1
+signing_key: 
+specification_version: 4
+summary: A Jekyll plugin to make sure your post is _really_ ready for publishing
+test_files: []