w3clove 0.0.1

data/.gitignore

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

data/Gemfile

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

data/README.rdoc

@@ -0,0 +1,19 @@
+= w3clove
+
+This is my {Ruby Mendicant University}[http://university.rubymendicant.com/] personal project, and is currently in alpha status.
+
+I want to build a site-wide markup validator, a Ruby gem that lets you validate a whole web site against the W3C Markup Validator, from the command line, and generate a comprehensive report of all errors found.
+
+Currently, the official {W3C Validator site}[http://validator.w3.org/] only lets you validate one URL at a time, so when you want to validate all the pages on a web site, it can be a tedious process. There is a {related tool}[http://www.htmlhelp.com/tools/validator/batch.html.en] that lets you use a batch mode for this and submit a list of URLs to be checked, but it is still a semi-manual process, and the output is not very useful.
+
+My plan then is building a command line utility that would accept as input a XML sitemap file, or its URL, expecting it to be on the {Google Sitemap format}[http://en.wikipedia.org/wiki/Google_Sitemaps]. This utility will then check the markup validation of each URL on this sitemap querying the W3C Validator, and store all detected errors and warnings. After checking all the URLs, it will generate as output an HTML file, with a style similar to what RCov[https://github.com/relevance/rcov] produces, showing all these errors on an easy to read format, grouping common errors together, sorting them by popularity, and linking to the URLs and to the explanations on how to correct them.
+
+Internally, it would use the {w3c_validators gem}[http://rubygems.org/gems/w3c_validators] to do the individual checks, so my gem would be concerned only with the XML sitemap parsing, building the queue, storing the errors, grouping and sorting them, and producing the HTML output.
+
+I've already done something similar to this, I sent {a little contribution to docrails}[https://github.com/lifo/docrails/blob/master/railties/guides/w3c_validator.rb] that checks the generated guides using this gem.
+
+= Bonus points:
+
+* in addition to an XML file, accept as input the URL of a site and crawl the site to find all internal links
+* validate the markup locally, without querying the W3C site, for more speed and to not saturate the W3C site
+* store the results on a local database, so on subsequent checks, only the pages that had errors are re-checked (unless a --checkall force flag is passed). This way developers can check the whole site, get the errors, deploy the corrections, and recheck the site.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/bin/w3clove

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# -*- encoding: utf-8 -*-
+
+require_relative '../lib/w3clove'
+
+begin
+  W3clove.check_sitemap(ARGV[0])
+rescue
+  puts "There was an error processing your request"
+  puts "USAGE: w3clove url_of_xml_sitemap"
+end

data/heatup/01_single_validation.rb

@@ -0,0 +1,16 @@
+# Example of validation of a single URL
+
+require 'w3c_validators'
+include W3CValidators
+validator = MarkupValidator.new
+
+url = 'http://university.rubymendicant.com/'
+puts "Validating markup of #{url}"
+
+results = validator.validate_uri(url)
+
+if results.errors.length > 0
+  puts "There are #{results.errors.length} validation errors"
+else
+  puts 'Valid!'
+end

data/heatup/02_multiple_validation.rb

@@ -0,0 +1,25 @@
+# Example of validation of a list of URLs
+
+require 'w3c_validators'
+include W3CValidators
+validator = MarkupValidator.new
+
+urls = %w{http://university.rubymendicant.com/
+          http://university.rubymendicant.com/changelog.html
+          http://university.rubymendicant.com/alumni.html}
+totals = {:errors => 0, :warnings => 0}
+
+urls.each do |url|
+  puts "\nValidating markup of #{url}"
+  results = validator.validate_uri(url)
+  puts "#{results.errors.count} errors, #{results.warnings.count} warnings"
+  totals[:errors] += results.errors.count
+  totals[:warnings] += results.warnings.count
+end
+
+puts "\nTOTAL:#{totals[:errors]} errors, #{totals[:warnings]} warnings"
+
+
+
+
+

data/heatup/03_multiple_validation_from_text_file.rb

@@ -0,0 +1,23 @@
+# Example of validation of a list of URLs from a text file
+
+require 'w3c_validators'
+include W3CValidators
+validator = MarkupValidator.new
+
+totals = {:errors => 0, :warnings => 0}
+File.open("urls.txt", "r") do |file|
+  file.each_line do |url|
+    puts "\nValidating markup of #{url}"
+    results = validator.validate_uri(url)
+    puts "#{results.errors.count} errors, #{results.warnings.count} warnings"
+    totals[:errors] += results.errors.count
+    totals[:warnings] += results.warnings.count
+  end
+end
+
+puts "\nTOTAL:#{totals[:errors]} errors, #{totals[:warnings]} warnings"
+
+
+
+
+

data/heatup/04_multiple_validations_from_xml_file.rb

@@ -0,0 +1,24 @@
+# Example of validation of a list of URLs from a local XML sitemap file
+
+require 'nokogiri'
+require 'w3c_validators'
+include W3CValidators
+validator = MarkupValidator.new
+
+totals = {:errors => 0, :warnings => 0}
+
+doc = Nokogiri::XML(File.open("sitemap.xml"))
+doc.css('loc').collect {|item| item.text}.each do |url|
+  puts "\nValidating markup of #{url}"
+  results = validator.validate_uri(url)
+  puts "#{results.errors.count} errors, #{results.warnings.count} warnings"
+  totals[:errors] += results.errors.count
+  totals[:warnings] += results.warnings.count
+end
+
+puts "\nTOTAL:#{totals[:errors]} errors, #{totals[:warnings]} warnings"
+
+
+
+
+

data/heatup/05_multiple_validations_from_remote_xml_sitemap.rb

@@ -0,0 +1,25 @@
+# Example of validation of a list of URLs from a remote XML sitemap
+
+require 'open-uri'
+require 'nokogiri'
+require 'w3c_validators'
+include W3CValidators
+validator = MarkupValidator.new
+
+totals = {:errors => 0, :warnings => 0}
+
+doc = Nokogiri::XML(open('https://github.com/jaimeiniesta/w3clove/raw/master/heatup/sitemap.xml'))
+doc.css('loc').collect {|item| item.text}.each do |url|
+  puts "\nValidating markup of #{url}"
+  results = validator.validate_uri(url)
+  puts "#{results.errors.count} errors, #{results.warnings.count} warnings"
+  totals[:errors] += results.errors.count
+  totals[:warnings] += results.warnings.count
+end
+
+puts "\nTOTAL:#{totals[:errors]} errors, #{totals[:warnings]} warnings"
+
+
+
+
+

data/heatup/sitemap.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+  <url>
+    <loc>http://university.rubymendicant.com/</loc>
+  </url>
+  <url>
+    <loc>http://university.rubymendicant.com/changelog.html</loc>
+  </url>
+  <url>
+    <loc>http://university.rubymendicant.com/alumni.html</loc>
+  </url>
+</url>

data/heatup/urls.txt

@@ -0,0 +1,3 @@
+http://university.rubymendicant.com/
+http://university.rubymendicant.com/changelog.html
+http://university.rubymendicant.com/alumni.html

data/lib/w3clove/version.rb

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

data/lib/w3clove.rb

@@ -0,0 +1,27 @@
+module W3clove
+  require 'open-uri'
+  require 'nokogiri'
+  require 'w3c_validators'
+  include W3CValidators
+
+  extend self
+
+  ##
+  # Parses a remote xml sitemap and checks markup validation for each url within
+  def check_sitemap(sitemap_url)
+    validator = MarkupValidator.new
+
+    totals = {:errors => 0, :warnings => 0}
+
+    doc = Nokogiri::XML(open(sitemap_url))
+    doc.css('loc').collect {|item| item.text}.each do |url|
+      puts "\nValidating markup of #{url}"
+      results = validator.validate_uri(url)
+      puts "#{results.errors.count} errors, #{results.warnings.count} warnings"
+      totals[:errors] += results.errors.count
+      totals[:warnings] += results.warnings.count
+    end
+
+    puts "\nTOTAL:#{totals[:errors]} errors, #{totals[:warnings]} warnings"
+  end
+end

data/w3clove.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "w3clove/version"
+
+Gem::Specification.new do |s|
+  s.name        = "w3clove"
+  s.version     = W3clove::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jaime Iniesta"]
+  s.email       = ["jaimeiniesta@gmail.com"]
+  s.homepage    = "https://github.com/jaimeiniesta/w3clove/"
+  s.summary     = %q{ command-line tool to validate the markup of a whole site against the W3C validator }
+  s.description = %q{ this tool allows you to check the markup validation of a whole site passing an XML sitemap,
+and outputs a detailed report with all errors and warnings }
+
+  s.rubyforge_project = "w3clove"
+
+  s.add_dependency 'w3c_validators'
+  s.add_dependency 'nokogiri'
+
+  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.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification 
+name: w3clove
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jaime Iniesta
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-15 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: w3c_validators
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: " this tool allows you to check the markup validation of a whole site passing an XML sitemap,\n\
+  and outputs a detailed report with all errors and warnings "
+email: 
+- jaimeiniesta@gmail.com
+executables: 
+- w3clove
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.rdoc
+- Rakefile
+- bin/w3clove
+- heatup/01_single_validation.rb
+- heatup/02_multiple_validation.rb
+- heatup/03_multiple_validation_from_text_file.rb
+- heatup/04_multiple_validations_from_xml_file.rb
+- heatup/05_multiple_validations_from_remote_xml_sitemap.rb
+- heatup/sitemap.xml
+- heatup/urls.txt
+- lib/w3clove.rb
+- lib/w3clove/version.rb
+- w3clove.gemspec
+has_rdoc: true
+homepage: https://github.com/jaimeiniesta/w3clove/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: w3clove
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: command-line tool to validate the markup of a whole site against the W3C validator
+test_files: []
+