nanoc-checking-checks-vnu 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ad4c0d699cfa5e1136fa03973964622358f460cf079d1a6696e191bea5d37ab2
+  data.tar.gz: fefd405f6288d68d109e03a4e76e941a01b4bb212c7815523f6c6ecda47a0b91
+SHA512:
+  metadata.gz: 032f077d4ab1c2946d98c759a9732ff5909d05245bf0508acdd0a9a703e02c08d96b4460d832da8952e96f176c92a728f043348984e1afd98e2f0bec2886e56b
+  data.tar.gz: 857946058026e6a5862479ec14f6ffbb482add9225b68053d69cccf1ed8fc2fe82b51c327382cc74f3367e320f433f0d78ca54a867ba57d974662c22326f0d57

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "rake", "~> 12.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Roger Que
+
+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,54 @@
+# Nanoc::Checking::Checks::Vnu
+
+A [nanoc check][nanoc-check] that validates HTML, CSS, and SVG output files
+locally with [the Nu Html Checker][vnu] (v.Nu).
+
+[nanoc-check]: https://nanoc.ws/doc/testing/
+[vnu]: https://validator.github.io/validator/
+
+## Installation
+
+Install v.Nu and place the `vnu` executable on your `PATH`.
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nanoc-checking-checks-vnu'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install nanoc-checking-checks-vnu
+
+## Usage
+
+Add this line to a Ruby file inside your site's `lib` directory:
+
+```ruby
+require 'nanoc-checking-checks-vnu'
+```
+
+Then execute:
+
+    $ nanoc check vnu  # prefix with `bundle exec` as appropriate
+
+You can automatically this check at deploy time by adding `vnu` to [the
+`checking` section of `nanoc.yaml`][nanoc-check-deploy].
+
+[nanoc-check-deploy]: https://nanoc.ws/doc/testing/#running-checks-before-deploying
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+<https://github.com/query/nanoc-checking-checks-vnu>.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License][mit].
+
+[mit]: https://opensource.org/licenses/MIT

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/lib/nanoc/checking/checks/vnu.rb

@@ -0,0 +1,20 @@
+module Nanoc
+  module Checking
+    module Checks
+      class Vnu < ::Nanoc::Checking::Check
+        identifier :vnu
+
+        def run
+          args = ['vnu',
+                  '--skip-non-html', '--also-check-css', '--also-check-svg',
+                  '--errors-only', '--format', 'json',
+                  @config.output_dir]
+          output = JSON.load(IO.popen(args, err: [:child, :out], &:read))
+          output['messages'].each do |m|
+            add_issue(m['message'], subject: m['url'].sub(/^file:/, ''))
+          end
+        end
+      end
+    end
+  end
+end

data/nanoc-checking-checks-vnu.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |spec|
+  spec.name          = "nanoc-checking-checks-vnu"
+  spec.version       = "1.0.0"
+  spec.authors       = ["Roger Que"]
+  spec.email         = ["git@alerante.net"]
+
+  spec.summary       = "A nanoc check for validating HTML, CSS, and SVG " \
+                       "files with the v.Nu validator."
+  spec.homepage      = "https://github.com/query/nanoc-checking-checks-vnu"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"]    = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  spec.add_dependency "nanoc-checking", "~> 1.0.0"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: nanoc-checking-checks-vnu
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Roger Que
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-06-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nanoc-checking
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description:
+email:
+- git@alerante.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/nanoc/checking/checks/vnu.rb
+- nanoc-checking-checks-vnu.gemspec
+homepage: https://github.com/query/nanoc-checking-checks-vnu
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/query/nanoc-checking-checks-vnu
+  source_code_uri: https://github.com/query/nanoc-checking-checks-vnu
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: A nanoc check for validating HTML, CSS, and SVG files with the v.Nu validator.
+test_files: []