jekyll-pre-commit 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba0866d2499fbb528292ed308379b106d0fdab53
-  data.tar.gz: ceb1d3b4cb328cecbfe37fb562dd228ab082af83
+  metadata.gz: 048585b617af221517a1f0e0291d0d8da5b100c2
+  data.tar.gz: 8b8fd1f8fa90be529c30f97ca2742005c79e8429
 SHA512:
-  metadata.gz: 24773f04d3fdbdc8528969df8057e6a695e822366d40fa04ed995472f071af191f37ccceff70a6fdee92dde7ddd4c835bcd9b75febcfcfefb4ee10eda5694582
-  data.tar.gz: 080f9210aee062769c4f7f1500452a5b77b4dafd73b416eb9490ae989f518b492285bb45fbc4ba17b45dc18a57102381aacfb1093aac81a0757fb104db50865f
+  metadata.gz: d12aaa2cd8e9dfc8530edc47fc12951bcf842933005ccd400694ac6587ca14dcfd70c7193e4f1ae6084c2cb4e8af7ed01a07d61dfcbf7b8793480ec8d3b3cfd8
+  data.tar.gz: 87d9ac132740f26266df781c8a0941a9354eaf745c2b57b230ec0016aac7fcf28819a27b241877e079a4978dd42283223621c4412174ecc8392a727f67322b03

data/.rubocop.yml

@@ -0,0 +1,6 @@
+AllCops:
+  Exclude:
+    - spec/**/*
+    - jekyll-pre-commit.gemspec
+    - Gemfile
+    - Rakefile

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.2
+cache: bundler
+sudo: false
+before_script: bundle update
+script: ./script/cibuild
+notifications:
+  email: false

data/Gemfile

@@ -2,3 +2,7 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in jekyll-pre-commit.gemspec
 gemspec
+
+if ENV["JEKYLL_VERSION"]
+  gem "jekyll", "~> #{ENV["JEKYLL_VERSION"]}"
+end

data/README.md

@@ -1,5 +1,7 @@
 # jekyll-pre-commit
 
+[![Build Status](https://travis-ci.org/mpchadwick/jekyll-pre-commit.svg?branch=master)](https://travis-ci.org/mpchadwick/jekyll-pre-commit) [![Gem Version](https://badge.fury.io/rb/jekyll-pre-commit.svg)](https://badge.fury.io/rb/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)
@@ -10,7 +12,7 @@ Add this line to your `Gemfile`:
 
 ```ruby
 group :jekyll_plugins do
-  gem 'jekyll-migrate-permalink'
+  gem 'jekyll-pre-commit'
 end
 ```
 
@@ -34,6 +36,7 @@ pre-commit:
     variables: ['description']
   - check: FrontMatterVariableMeetsLengthRequirements
     variables: ['description', 'title']
+  - check: NoDuplicateTags
 ```
 
 ## Available Checks
@@ -74,6 +77,10 @@ For example...
 
 In the above, there would be a maximum length of 50 characters for the title (rather than the default of 59)
 
+#### NoDuplicateTags
+
+Checks that you have not accidentally introduced a duplicate tag. For example, if you have posts that are already using "MySQL" as a tag and you attempt to commit a post with the tag "mysql"  (notice the difference in case-sensitivity) you will not be allowed to commit.
+
 ## 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. 

data/Rakefile

@@ -1 +1,6 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/jekyll-pre-commit.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   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 "jekyll", ">= 3.3.0"
+  spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
 end

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

@@ -1,9 +1,11 @@
 module Jekyll
   module PreCommit
     module Checks
+      # The baseline check class
+      # All checks should extend this class
       class Check
         def initialize
-          @result = { :ok => true, :message => "" }
+          @result = { ok: true, message: '' }
         end
       end
     end

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

@@ -0,0 +1,41 @@
+module Jekyll
+  module PreCommit
+    module Checks
+      class NoDuplicateTags < Check
+        def check(staged, not_staged, site, args)
+          raw = Hash.new
+          normalized = Hash.new
+          not_staged.each do |post|
+            if post.data["tags"].size > 0
+              post.data["tags"].each do |tag|
+                if !raw[tag]
+                  raw[tag] = post.relative_path
+                end
+
+                n = Jekyll::Utils.slugify(tag)
+                if !normalized[n]
+                  normalized[n] = post.relative_path
+                end
+              end
+            end
+          end
+
+          staged.each do |post|
+            if post.data["tags"].size > 0
+              post.data["tags"].each do |tag|
+                n = Jekyll::Utils.slugify(tag)
+
+                if normalized[n] && !raw[tag]
+                  @result[:ok] = false
+                  @result[:message] += "#{tag} appears to be duplicated in #{normalized[n]}!"
+                end
+              end
+            end
+          end
+
+          @result
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module Jekyll
+  module PreCommit
+    module Checks
+      # This is a work-in-progress.
+      class SpellCheck < Check
+        def check(staged, not_staged, site, args)
+          staged.each do |post|
+            rendered = Jekyll::Renderer.new(site, post).run
+            rendered.gsub!('"', '\"')
+            mispells = `echo "#{rendered}" | sed "s/’/'/g" | aspell list -H --add-html-skip=pre --add-html-skip=code`
+            puts mispells
+          end
+          exit 1
+        end
+      end
+    end
+  end
+end

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

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

data/lib/jekyll-pre-commit.rb

@@ -10,3 +10,4 @@ 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'
+require 'jekyll-pre-commit/checks/no_duplicate_tags.rb'

data/script/cibuild

@@ -0,0 +1,6 @@
+#! /bin/bash
+
+set -e
+
+bundle exec rspec
+bundle exec rake build

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-pre-commit
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Max Chadwick
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-11 00:00:00.000000000 Z
+date: 2017-07-24 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.3.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
 description: 
 email:
 - mpchadwick@gmail.com
@@ -48,6 +76,8 @@ files:
 - .editorconfig
 - .gitignore
 - .rspec
+- .rubocop.yml
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -58,10 +88,13 @@ files:
 - 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/checks/no_duplicate_tags.rb
+- lib/jekyll-pre-commit/checks/spell_check.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
+- script/cibuild
 homepage: https://github.com/mpchadwick/jekyll-pre-commit
 licenses:
 - MIT