jekyll-test 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 260d065347629dc86581f4b787ffd66e30950ba1
-  data.tar.gz: f8ba273a7265db21789b070c1cf2a2fb061b198b
+  metadata.gz: b006f21b3357879ec08439ed3f0edb01761887d9
+  data.tar.gz: 760706b545b80f1d402ca05bcd5c721a8b5950aa
 SHA512:
-  metadata.gz: 228766922c22133195c45e44be99d8799af6d20b34e07c58a82aa41e32ec333d96563041b9ac5df25ed40779f8ace1a0cba386693b757e307201ba89b21fa78d
-  data.tar.gz: 76a872d57401fed3a10eb7c7544ebdd46e81715fd346bfc9a88ecf8e132d38af8e4d429a4650fd4495fa247c24e1fbea32e8df4b4f97ab63bbd1042e4495f9d1
+  metadata.gz: 43c75fed06e6ab263e3cdcd24b9db4ff7f5acaf53930cdc76570c12e1ab34ad13e75947bcb5d91715538b76606999325d26b00697f82d97b2b62179b53cad75e
+  data.tar.gz: 7bab9b15c9a9e8a1eae2163e324a5f358ebd4182b62de59ba94660d87d980cf87d78affdf175065328e04a1e1e16b9e2396bc71e257e7296da27ec318ec42b33

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+# v0.2.0
+
+* Add Rake tasks to check validity and links
+
+# v0.1.0
+
+* initial release, pulls in required dependencies for testing

data/README.md

@@ -1,39 +1,44 @@
-# Jekyll::Test
+# Jekyll-Test
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/jekyll/test`. To experiment with that code, run `bin/console` for an interactive prompt.
+`jekyll-test` is a highly opinionated test configuration for Jekyll sites to let you create well-formed sites with minimal configuration.
 
-TODO: Delete this and the text above, and describe your gem
+It provides two rake tasks:
 
-## Installation
+`jekyll:check` will test your site for HTML validity, internal link correctness, alt tags, OpenGraph validity, https usage, and a load more. It will complain about as much as it can. You want this to pass.
 
-Add this line to your application's Gemfile:
+`jekyll:check_external_links` will check all outgoing links as well. This is a separate task as this often fails due to network errors, etc, and you don't want to depend on it passing. Use it for information only.
 
-```ruby
-gem 'jekyll-test'
-```
-
-And then execute:
+## Usage
 
-    $ bundle
+Add this line to your site's Gemfile and run `bundle`:
 
-Or install it yourself as:
+```ruby
+group :test do
+  gem 'jekyll-test'
+end
+```
 
-    $ gem install jekyll-test
+In your Rakefile, then add:
 
-## Usage
+```ruby
+require 'jekyll/test/tasks'
+```
 
-TODO: Write usage instructions here
+We suggest making `jekyll:check` your default task by adding this to your Rakefile:
 
-## Development
+```rake
+task default: "jekyll:check"
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+## Coming soon
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+* travis setup for using these tasks in a CI environment
+* spellchecking
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jekyll-test. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/Floppy/jekyll-test. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## Code of Conduct
 
-Everyone interacting in the Jekyll::Test project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/jekyll-test/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Jekyll::Test project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/jekyll-test/blob/master/CODE_OF_CONDUCT.md).

data/lib/jekyll/test/jekyll.rake

@@ -0,0 +1,40 @@
+require 'html-proofer'
+
+def check_site(options = {})
+  defaults = {
+    assume_extension: ".html",
+    typhoeus: {
+      ssl_verifypeer: false, 
+      ssl_verifyhost: 0,
+      timeout: 3,
+    }, 
+  }
+  HTMLProofer.check_directory("./_site", defaults.merge(options)).run
+end
+
+namespace :jekyll do
+
+  task :rebuild do
+    sh "rm -rf _site"
+    sh "bundle exec jekyll build"
+  end
+
+  task :check => :rebuild do
+    check_site(
+      check_html: true, 
+      check_favicon: true,
+      #check_sri: true, #soon!
+      check_img_http: true,
+      check_opengraph: true,
+      disable_external: true,
+    )
+  end
+
+  task :check_external_links => :rebuild do
+    check_site(
+      url_ignore: [],
+      check_external_hash: true,
+    )
+  end
+  
+end

data/lib/jekyll/test/tasks.rb

@@ -0,0 +1,2 @@
+$VERBOSE = nil
+Dir["#{File.dirname(__FILE__)}/*.rake"].each { |ext| load ext }

data/lib/jekyll/test/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-test
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - James Smith
@@ -90,6 +90,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - README.md
@@ -98,6 +99,8 @@ files:
 - bin/setup
 - jekyll-test.gemspec
 - lib/jekyll/test.rb
+- lib/jekyll/test/jekyll.rake
+- lib/jekyll/test/tasks.rb
 - lib/jekyll/test/version.rb
 homepage: https://github.com/Floppy/jekyll-test
 licenses: []