jekyll-test 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b006f21b3357879ec08439ed3f0edb01761887d9
-  data.tar.gz: 760706b545b80f1d402ca05bcd5c721a8b5950aa
+  metadata.gz: 57a20ed116645e39f276c63220bc22fa4c49f2af
+  data.tar.gz: eb980c363e9b903d170c641ef14ce973489a379d
 SHA512:
-  metadata.gz: 43c75fed06e6ab263e3cdcd24b9db4ff7f5acaf53930cdc76570c12e1ab34ad13e75947bcb5d91715538b76606999325d26b00697f82d97b2b62179b53cad75e
-  data.tar.gz: 7bab9b15c9a9e8a1eae2163e324a5f358ebd4182b62de59ba94660d87d980cf87d78affdf175065328e04a1e1e16b9e2396bc71e257e7296da27ec318ec42b33
+  metadata.gz: 13cfd511ae8e100fe13afe56ebcc9157a68e76cf784158d4ba99ed57a29c6ad64f6bf9b2f990240800cc9f0350c313bfe0431704244396027b7b3fd87cbf039d
+  data.tar.gz: a52484d8a079cd4f7ab576d32e1df412ca93027b66c57ea1595bdc77557f56d9794406906c493c1510302aa066eadb1f864526e910de02a34bbb5a29a4cfccfe

data/CHANGELOG.md

@@ -1,9 +1,15 @@
 # Changelog
 
-# v0.2.0
+## 1.0.0
 
-* Add Rake tasks to check validity and links
+* Added `jekyll:configure:travis` task to automatically configure travis matrix builds.
+* Added jekyll itself as a dependency
+* Use correct destination directory for builds and tests
 
-# v0.1.0
+## 0.2.0
 
-* initial release, pulls in required dependencies for testing
+* Add Rake tasks to check validity and links.
+
+## 0.1.0
+
+* initial release, pulls in required dependencies for testing.

data/LICENSE.md

@@ -0,0 +1,22 @@
+## Copyright (c) 2017 jekyll-test contributors
+
+# MIT License
+
+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

@@ -30,9 +30,22 @@ We suggest making `jekyll:check` your default task by adding this to your Rakefi
 task default: "jekyll:check"
 ```
 
+### Travis configuration
+
+To configure a travis build to run these tests, run:
+
+```
+rake jekyll:configure:travis
+```
+
+This will initialise your repo for use on travis, if necessary, then write a multi-build configuration which will run both checks together. The link check is allowed to fail, so it will not impact your CI success / failure.
+
+WARNING: This will aggressively overwrite bits of `.travis.yml`, so if you already have one, make sure it's committed or backed up so you can check the changes.
+
+It's a good idea to run the task with each new release of this gem to get the latest configuration.
+
 ## Coming soon
 
-* travis setup for using these tasks in a CI environment
 * spellchecking
 
 ## Contributing

data/jekyll-test.gemspec

@@ -6,6 +6,7 @@ require "jekyll/test/version"
 Gem::Specification.new do |spec|
   spec.name          = "jekyll-test"
   spec.version       = Jekyll::Test::VERSION
+  spec.licenses      = ['MIT']
   spec.authors       = ["James Smith"]
   spec.email         = ["james@floppy.org.uk"]
 
@@ -28,9 +29,11 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ["~> 2.2", "< 2.5"]
 
+  spec.add_dependency "jekyll", "~> 3.0"
   spec.add_dependency "rspec", "~> 3.0"
   spec.add_dependency "rake", "~> 12.0"
   spec.add_dependency 'html-proofer', "~> 3.7"
+  spec.add_dependency 'travis', "~> 1.8"
   spec.add_dependency 'rspec-html-matchers', "~> 0.9"
 
   spec.add_development_dependency "bundler", "~> 1.15"

data/lib/jekyll/test/jekyll.rake

@@ -9,13 +9,22 @@ def check_site(options = {})
       timeout: 3,
     }, 
   }
-  HTMLProofer.check_directory("./_site", defaults.merge(options)).run
+  HTMLProofer.check_directory(jekyll_site_directory, defaults.merge(options)).run
+end
+
+def jekyll_site_directory
+  dir = "./_site"
+  if File.exist?('_config.yml')
+    config = YAML.load_file("_config.yml")
+    dir = config["destination"] || dir
+  end
+  dir
 end
 
 namespace :jekyll do
 
   task :rebuild do
-    sh "rm -rf _site"
+    sh "rm -rf #{jekyll_site_directory}"
     sh "bundle exec jekyll build"
   end
 
@@ -36,5 +45,5 @@ namespace :jekyll do
       check_external_hash: true,
     )
   end
-  
+
 end

data/lib/jekyll/test/travis.rake

@@ -0,0 +1,34 @@
+namespace :jekyll do
+
+  namespace :configure do
+  
+    task :travis do
+      # Initialise travis
+      unless File.exist?(".travis.yml")
+        sh "bundle exec travis init"
+      end
+      # Load existing configuration
+      travis = {}
+      travis = YAML.load_file(".travis.yml") 
+      # Update configuration
+      travis["rvm"] = ["2.4.1"]
+      travis["sudo"] = false
+      travis["cache"] = "bundler"
+      travis["env"] = [
+        %Q{TASK='jekyll:check'},
+        %Q{TASK='jekyll:check_external_links'},
+      ]
+      travis["matrix"] = {
+        "fast_finish" => true,
+        "allow_failures" => [{
+          "env" => %Q{TASK='jekyll:check_external_links'}
+        }]
+      }
+      travis["script"] = "bundle exec rake $TASK"
+      # Output
+      File.write(".travis.yml", travis.to_yaml)
+    end
+  
+  end
+  
+end

data/lib/jekyll/test/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-test
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - James Smith
@@ -10,6 +10,20 @@ bindir: exe
 cert_chain: []
 date: 2017-08-17 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: travis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: rspec-html-matchers
   requirement: !ruby/object:Gem::Requirement
@@ -93,6 +121,7 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
+- LICENSE.md
 - README.md
 - Rakefile
 - bin/console
@@ -101,9 +130,11 @@ files:
 - lib/jekyll/test.rb
 - lib/jekyll/test/jekyll.rake
 - lib/jekyll/test/tasks.rb
+- lib/jekyll/test/travis.rake
 - lib/jekyll/test/version.rb
 homepage: https://github.com/Floppy/jekyll-test
-licenses: []
+licenses:
+- MIT
 metadata:
   allowed_push_host: https://rubygems.org
 post_install_message: