html5_validator 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in html5_validator.gemspec
+gemspec

data/README.rdoc

@@ -0,0 +1,68 @@
+= html5_validator
+
+* http://github.com/damian/html5_validator
+
+== DESCRIPTION:
+
+Ruby gem to test for valid HTML5 markup with RSpec. It also provides an interface validator.nu.
+
+== INSTALL:
+
+* gem install html5_validator
+
+== MAIN USAGE:
+
+  describe TestController do
+    render_views
+
+    it "should be valid html5" do
+      get :new
+      response.body.should be_valid_html5
+    end
+  end
+
+If your spec fails it outputs the validation error in your console.
+
+== OTHER USAGE:
+
+  @validator = Html5Validator::Validator.new
+   
+  # Validation a url
+  @validator.validate_uri('http://damiannicholson.com')
+
+  # Passing in an html string directly
+  @validator.validate_text(@html)
+
+  # Checking to see whether it's valid
+  @validator.valid?
+
+  # Viewing errors
+  @validator.errors
+
+
+See more examples in the spec folder.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2011 Damian Nicholson
+
+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/Rakefile

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

data/html5_validator.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "html5_validator/version"
+
+Gem::Specification.new do |s|
+  s.name        = "html5_validator"
+  s.version     = Html5Validator::VERSION
+  s.authors     = ["Damian Nicholson"]
+  s.email       = ["damian.nicholson21@gmail.com"]
+  s.homepage    = "http://github.com/damian/html5_validator"
+  s.summary     = %q{Ruby gem to test for valid HTML5 markup with RSpec}
+  s.description = %q{Ruby gem to test for valid HTML5 markup with RSpec}
+
+  s.rubyforge_project = "html5_validator"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.add_dependency "json"
+  s.add_dependency "rest-client"
+  s.add_dependency "rspec", "~> 2.6.0"
+  s.require_paths = ["lib"]
+end

data/lib/html5_validator.rb

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'bundler'
+Bundler.require
+require 'json'
+require 'rest_client'
+require 'rspec'
+require 'html5_validator/rspec'
+
+module Html5Validator
+  class Validator
+    BASE_URI = 'http://html5.validator.nu'
+    HEADERS = { 'Content-Type' => 'text/html; charset=utf-8', 'Content-Encoding' => 'UTF-8' }
+    attr_reader :errors
+
+    def initialize(proxy = nil)
+      RestClient.proxy = proxy unless proxy.nil?
+    end
+
+    # Validate the markup of a String
+    def validate_text(text)
+      response = RestClient.post "#{BASE_URI}/?out=json", text, HEADERS
+      @json = JSON.parse(response.body)
+      @errors = retrieve_errors
+    end
+
+    # Validate the markup of a URI
+    def validate_uri(uri)
+      response = RestClient.get BASE_URI, :params => { :doc => uri, :out => 'json' }
+      @json = JSON.parse(response.body)
+      @errors = retrieve_errors
+    end
+
+    # TODO - Flesh out the file upload method
+    # Validate the markup of a file
+    def validate_file(file)
+    end
+
+    def inspect
+      @errors.map do |err|
+        "- Error: #{err['message']}"
+      end.join("\n")
+    end
+
+    def valid?
+      @errors.length == 0
+    end
+
+    private
+
+    def retrieve_errors
+      @json['messages'].select { |mssg| mssg['type'] == 'error' }
+    end
+  end
+end

data/lib/html5_validator/rspec.rb

@@ -0,0 +1,12 @@
+# Assert that the response is valid HTML5
+RSpec::Matchers.define :be_valid_html5 do
+  validator = nil
+  match do |body|
+    validator = Html5Validator::Validator.new
+    validator.validate_text(body)
+    validator.valid?
+  end
+  failure_message_for_should do |actual|
+    validator.inspect
+  end
+end

data/lib/html5_validator/version.rb

@@ -0,0 +1,3 @@
+module Html5Validator
+  VERSION = "0.0.1"
+end

data/spec/fixtures/invalid_html.html

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Hello world</title>
+</head>
+<body>
+   <!-- Missing closing section tag -->
+  <section>
+</body>
+</html>

data/spec/fixtures/valid_html.html

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Hello world</title>
+</head>
+<body>
+  <section>
+    <a href="http://google.com">Google</a>
+  </section>
+</body>
+</html>

data/spec/html5_validator_spec.rb

@@ -0,0 +1,96 @@
+require 'html5_validator'
+
+describe "Html5Validator" do
+  
+  describe "when using the custom matcher" do
+    it "should not be valid html5 when supplied with invalid content" do
+      @html = File.open('spec/fixtures/invalid_html.html').read
+      @html.should_not be_valid_html5
+    end
+
+    it "should be valid html5 when supplied with valid content" do
+      @html = File.open('spec/fixtures/valid_html.html').read
+      @html.should be_valid_html5
+    end
+  end
+
+  before do
+    @validator = Html5Validator::Validator.new
+  end
+
+  it "should be an instance of Html5Validator::Validator" do
+    @validator.should be_an_instance_of Html5Validator::Validator
+  end
+
+  context "validating a uri" do
+    describe "when supplied with an invalid url" do
+
+      before do
+        @validator.validate_uri('http://google.co.uk')
+      end
+
+      it "should not be valid html5" do
+        @validator.valid?.should be_false
+      end
+
+      it "should return thirty-nine errors" do
+        @validator.errors.should have(39).items
+      end
+    end
+
+    describe "when supplied with a valid url" do
+
+      before do
+        @validator.validate_uri('http://damiannicholson.com')
+      end
+
+      it "should be valid html5" do
+        @validator.valid?.should be_true
+      end
+
+      it "should return zero errors" do
+        @validator.errors.should have(0).items
+      end
+    end
+  end
+
+  context "validating text" do
+    describe "when supplied with invalid html" do
+
+      before do
+        @html = File.open('spec/fixtures/invalid_html.html').read
+        @validator.validate_text(@html)
+      end
+
+      it "should not be valid html5" do
+         @validator.valid?.should be_false
+      end
+
+      it "should return two errors" do
+        @validator.errors.should have(2).items
+      end
+
+      it "should include an error complaining about the lack of a closing section tag" do
+        @validator.inspect.should include('Unclosed element')
+      end
+
+    end
+
+    describe "when supplied with valid html" do
+
+      before do
+        @html = File.open('spec/fixtures/valid_html.html').read
+        @validator.validate_text(@html)
+      end
+
+      it "should be valid html5" do
+         @validator.valid?.should be_true
+      end
+
+      it "should return no errors" do
+        @validator.errors.should have(0).items
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification 
+name: html5_validator
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Damian Nicholson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-03 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 2
+        - 6
+        - 0
+        version: 2.6.0
+  type: :runtime
+  version_requirements: *id003
+description: Ruby gem to test for valid HTML5 markup with RSpec
+email: 
+- damian.nicholson21@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- README.rdoc
+- Rakefile
+- html5_validator.gemspec
+- lib/html5_validator.rb
+- lib/html5_validator/rspec.rb
+- lib/html5_validator/version.rb
+- spec/fixtures/invalid_html.html
+- spec/fixtures/valid_html.html
+- spec/html5_validator_spec.rb
+homepage: http://github.com/damian/html5_validator
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: html5_validator
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Ruby gem to test for valid HTML5 markup with RSpec
+test_files: 
+- spec/fixtures/invalid_html.html
+- spec/fixtures/valid_html.html
+- spec/html5_validator_spec.rb