alexdunae-w3c_validators 1.0.0

data/lib/w3c_validators/results.rb

@@ -0,0 +1,62 @@
+module W3CValidators
+  class Results
+    attr_reader :uri, :checked_by, :doctype, :css_level, :charset, :validity, :debug_messages
+
+    def initialize(options = {})
+      @messages       = []
+      @uri            = options[:uri]
+      @checked_by     = options[:checked_by]
+      @doctype        = options[:doctype]
+      @css_level      = options[:css_level]
+      @charset        = options[:charset]
+      if options[:validity].kind_of?(String)
+        @validity     = options[:validity].downcase.strip == 'true'
+      else
+        @validity     = options[:validity]
+      end
+      @debug_messages = {}
+    end
+
+    def add_message(type, params = {})
+      uri = params[:uri] ||= @uri
+      @messages << Message.new(uri, type, params)
+    end    
+
+    def add_error(params = {})
+      add_message(:error, params)
+    end
+
+    def add_warning(params = {})
+      add_message(:warning, params)
+    end
+
+    def add_debug_message(key, val)
+      @debug_messages[key] = val
+    end
+
+    # Returns either the +DOCTYPE+ or CSS level, whichever is present.
+    def checked_against
+      return @doctype if @doctype
+      return @css_level if @css_level
+      nil
+    end
+
+    def is_valid?
+      @validity
+    end
+
+    # Returns an array of Message objects.
+    def errors
+      errors = []
+      @messages.each { |msg| errors << msg if msg.is_error? }
+      errors
+    end
+
+    # Returns an array of Message objects.
+    def warnings
+      errors = []
+      @messages.each { |msg| errors << msg if msg.is_warning? }
+      errors
+    end
+  end
+end

data/lib/w3c_validators/validator.rb

@@ -0,0 +1,160 @@
+require 'cgi'
+require 'net/http'
+require 'uri'
+require 'rexml/document'
+
+require 'w3c_validators/exceptions'
+require 'w3c_validators/constants'
+require 'w3c_validators/results'
+require 'w3c_validators/message'
+
+module W3CValidators
+  # Base class for MarkupValidator and FeedValidator.
+  class Validator
+    VERSION                   = '0.9.3'
+    USER_AGENT                = "Ruby W3C Validators/#{Validator::VERSION} (http://code.dunae.ca/w3c_validators/)"
+    HEAD_STATUS_HEADER        = 'X-W3C-Validator-Status'
+    HEAD_ERROR_COUNT_HEADER   = 'X-W3C-Validator-Errors'
+    SOAP_OUTPUT_PARAM         = 'soap12'
+
+    attr_reader :results, :validator_uri
+
+    # Create a new instance of the Validator.
+    def initialize(options = {})
+      @options = options
+    end
+
+  protected
+    # Perform a validation request.
+    #
+    # +request_mode+ must be either <tt>:get</tt>, <tt>:head</tt> or <tt>:post</tt>.
+    #
+    # Returns Net::HTTPResponse.
+    def send_request(options, request_mode = :get)
+      response = nil
+      results = nil
+
+      Net::HTTP.start(@validator_uri.host, @validator_uri.port) do |http|
+        case request_mode
+          when :head
+            # perform a HEAD request
+            raise ArgumentError, "a URI must be provided for HEAD requests." unless options[:uri]
+            query = create_query_string_data(options)
+            response = http.request_head(@validator_uri.path + '?' + query)
+          when :get 
+            # send a GET request
+            query = create_query_string_data(options)          
+            response = http.get(@validator_uri.path + '?' + query)
+          when :post
+            # send a multipart form request
+            query, boundary = create_multipart_data(options)
+            response = http.post2(@validator_uri.path, query, "Content-type" => "multipart/form-data; boundary=" + boundary)
+          else
+            raise ArgumentError, "request_mode must be either :get, :head or :post"
+        end
+      end
+
+      response.value
+      return response
+
+      rescue Exception => e
+        handle_exception e
+    end
+
+    def create_multipart_data(options) # :nodoc:
+      boundary = '349832898984244898448024464570528145'
+
+      # added 2008-03-12: HTML5 validator expects 'file' and 'content' to be the last fields so
+      # we process those params separately
+      last_params = []
+
+      # added 2008-03-12: HTML5 validator expects 'file' instead of 'uploaded_file'
+      if options[:file] and !options[:uploaded_file]
+        options[:uploaded_file] = options[:file]
+      end
+
+      if options[:uploaded_file]
+        filename = options[:file_path] ||= 'temp.html'
+        content = options[:uploaded_file]
+        last_params << "Content-Disposition: form-data; name=\"uploaded_file\"; filename=\"#{filename}\"\r\n" + "Content-Type: text/html\r\n" + "\r\n" + "#{content}\r\n"
+        options.delete(:uploaded_file)
+        options.delete(:file_path)
+      end
+      
+      if options[:content]
+          last_params << "Content-Disposition: form-data; name=\"#{CGI::escape('content')}\"\r\n" + "\r\n" + "#{options[:content]}\r\n"
+      end
+
+      misc_params = []
+      options.each do |key, value|
+        if value
+          misc_params << "Content-Disposition: form-data; name=\"#{CGI::escape(key.to_s)}\"\r\n" + "\r\n" + "#{value}\r\n"
+        end
+      end
+
+      params = misc_params + last_params
+
+      multipart_query = params.collect {|p| '--' + boundary + "\r\n" + p}.join('') + "--" + boundary + "--\r\n" 
+
+      [multipart_query, boundary]
+    end
+
+    def create_query_string_data(options) # :nodoc:
+      qs = ''
+      options.each do |key, value| 
+        if value
+          qs += "#{key}=" + CGI::escape(value.to_s) + "&"
+        end
+      end
+      qs
+    end
+
+    def read_local_file(file_path) # :nodoc:
+      fh = File.new(file_path, 'r+')
+      src = fh.read
+      fh.close
+      src
+    end
+
+  private
+    #--
+    # Big thanks to ara.t.howard and Joel VanderWerf on Ruby-Talk for the exception handling help.
+    #++
+    def handle_exception(e, msg = '') # :nodoc:
+      case e      
+        when Net::HTTPServerException, SocketError
+          msg = "unable to connect to the validator at #{@validator_uri} (response was #{e.message})."
+          raise ValidatorUnavailable, msg, caller
+        when REXML::ParseException
+          msg = "unable to parse the response from the validator."
+          raise ParsingError, msg, caller
+        else
+          raise e
+      end
+
+      if e.respond_to?(:error_handler_before)
+        fcall(e, :error_handler_before, self)
+      end
+
+      if e.respond_to?(:error_handler_instead)
+        fcall(e, :error_handler_instead, self)
+      else
+        if e.respond_to? :status
+          exit_status(( e.status ))
+        end
+
+        if SystemExit === e
+          stderr.puts e.message unless(SystemExit === e and e.message.to_s == 'exit') ### avoids double message for abort('message')
+        end
+      end
+
+      if e.respond_to?(:error_handler_after)
+        fcall(e, :error_handler_after, self)
+      end
+
+      exit_status(( exit_failure )) if exit_status == exit_success
+      exit_status(( Integer(exit_status) rescue(exit_status ? 0 : 1) ))
+      exit exit_status
+    end 
+  end
+end

data/test/test_css_validator.rb

@@ -0,0 +1,51 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+# Test cases for the CSSValidator.
+class CSSValidatorTests < Test::Unit::TestCase
+  include W3CValidators
+  def setup
+    @v = CSSValidator.new
+
+    @invalid_fragment = <<-EOT
+    a { color: white; }
+    body { margin: blue; }
+    
+    EOT
+
+    sleep 1
+  end
+
+  def test_overriding_css_profile
+    @v.set_profile!(:svgbasic)
+    r = @v.validate_text(@invalid_fragment)
+    assert_equal 'svgbasic', r.css_level
+  end
+
+  def test_validating_file
+    file_path = File.expand_path(File.dirname(__FILE__) + '/fixtures/invalid_css.css')
+    r = @v.validate_file(file_path)
+    assert_equal 1, r.errors.length
+  end
+
+  def test_validating_uri
+    @v.set_profile!(:svgbasic)
+    r = @v.validate_text(@invalid_fragment)
+    assert_equal 1, r.errors.length
+  end
+ 
+  def test_validating_text
+    r = @v.validate_text(@invalid_fragment)
+    assert_equal 1, r.errors.length
+  end
+
+  def test_validating_text_via_file
+    file_path = File.expand_path(File.dirname(__FILE__) + '/fixtures/invalid_css.css')
+    fh = File.new(file_path, 'r+')    
+    r = @v.validate_file(fh)
+    fh.close
+    assert_equal 1, r.errors.length
+  end
+
+
+ 
+end

data/test/test_exceptions.rb

@@ -0,0 +1,35 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class ExceptionTests < Test::Unit::TestCase
+  include W3CValidators
+
+  def setup
+    @valid_fragment = <<-EOV
+      <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+      <title>Test</title>
+      <body>
+      <div class="example">This is a test</div>
+      </body>
+    EOV
+  end
+
+  def test_bad_validator_uri
+    ['http://noexist/', 'http://noexist.badtld/', 
+     'http://example.com/noexist'].each do |uri|
+      v = MarkupValidator.new(:validator_uri => uri)
+      assert_raise ValidatorUnavailable do
+        r = v.validate_text(@valid_fragment)
+      end
+    end
+  end
+
+  def test_bad_soap_response
+    return # need to set up a test host
+    [].each do |uri|
+      v = MarkupValidator.new(:validator_uri => uri)
+      assert_raise ParsingError do
+        r = v.validate_text(@valid_fragment)
+      end
+    end
+  end
+end

data/test/test_feed_validator.rb

@@ -0,0 +1,61 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+# Test cases for the FeedValidator.
+class FeedValidatorTests < Test::Unit::TestCase
+  include W3CValidators
+  def setup
+    @v = FeedValidator.new
+    sleep 1
+  end
+
+  def test_validating_uri_with_soap
+    r = @v.validate_uri('http://code.dunae.ca/w3c_validators/test/invalid_feed.xml')
+    assert_equal 1, r.errors.length
+    assert_equal 1, r.warnings.length
+  end
+ 
+  def test_validating_file
+    file_path = File.expand_path(File.dirname(__FILE__) + '/fixtures/invalid_feed.xml')
+    r = @v.validate_file(file_path)
+    assert_equal 1, r.errors.length
+  end
+ 
+  def test_validating_text
+    fragment = <<-EOT
+    <?xml version="1.0" encoding="utf-8"?>
+    <feed xmlns="http://www.w3.org/2005/Atom">
+     <title>Example Feed</title>
+     <subtitle>A subtitle.</subtitle>
+     <link href="http://example.org/feed/" rel="self"/>
+     <link href="http://example.org/"/>
+     <updated>2003-12-13T18:30:02Z</updated>
+     <author>
+       <email>johndoe@example.com</email>
+     </author>
+     <id>urn:uuid:60a76c80-d399-11d9-b91C-0003939e0af6</id>
+     <entry>
+       <title>Atom-Powered Robots Run Amok</title>
+       <link href="http://example.org/2003/12/13/atom03"/>
+       <id>urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efa6a</id>
+       <updated>2003-12-13T18:30:02Z</updated>
+       <summary>Some text.</summary>
+     </entry>
+    </feed>
+    EOT
+
+    r = @v.validate_text(fragment)
+    assert_equal 1, r.errors.length
+  end
+
+
+  def test_validating_text_via_file
+    file_path = File.expand_path(File.dirname(__FILE__) + '/fixtures/invalid_feed.xml')
+    fh = File.new(file_path, 'r+')    
+    r = @v.validate_file(fh)
+    fh.close
+    assert_equal 1, r.errors.length
+  end
+
+
+ 
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__), '../'))
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__), '../lib/'))
+
+require 'rubygems'
+require 'test/unit'
+require 'w3c_validators'

data/test/test_html5_validator.rb

@@ -0,0 +1,64 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+# Test cases for the HTML5Validator.
+class HTML5ValidatorTests < Test::Unit::TestCase
+  include W3CValidators
+  def setup
+    @v = NuValidator.new
+    sleep 1
+  end
+
+  def test_getting_request_data
+    r = @v.validate_uri('http://code.dunae.ca/w3c_validators/test/valid_html5.html')
+    assert_equal :html5, r.doctype
+    assert_equal 'http://code.dunae.ca/w3c_validators/test/valid_html5.html', r.uri
+    assert_equal 0, r.errors.length
+    assert_equal 0, r.warnings.length
+    assert r.is_valid?
+  end
+
+  def test_validating_uri
+    r = @v.validate_uri('http://code.dunae.ca/w3c_validators/test/invalid_html5.html')
+    assert_equal 1, r.errors.length
+    assert_equal 1, r.warnings.length
+    assert !r.is_valid?
+  end
+
+  def test_validating_file
+    file = File.dirname(__FILE__) + '/fixtures/invalid_html5.html'
+    r = @v.validate_file(file)
+    assert_equal 1, r.errors.length
+  end
+
+  def test_validating_text
+    valid_fragment = <<-EOV
+    <!DOCTYPE html>
+    <html lang="en-ca">
+      <head>
+        <title>HTML 5 Example</title>
+      </head>
+      <body>
+        <!-- should have one error (missing </section>) -->
+        <p>This is a sample HTML 5 document.</p>
+        <section>
+        <h1>Example of paragraphs</h1>
+        This is the <em>first</em> paragraph in this example.
+        <p>This is the second.</p>
+        <p>Test<br>test</p>
+      </body>
+    </html>
+    EOV
+    
+    r = @v.validate_text(valid_fragment)
+    assert_equal 1, r.errors.length
+  end
+
+  #def test_validating_text_via_file
+  #  fh = File.new(File.dirname(__FILE__) + '/fixtures/invalid_html5.html', 'r+')    
+  #  r = @v.validate_file(fh)
+  #  fh.close
+  #  assert_equal 1, r.errors.length
+  #end
+
+
+end

data/test/test_markup_validator.rb

@@ -0,0 +1,94 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+# Test cases for the MarkupValidator.
+class MarkupValidatorTests < Test::Unit::TestCase
+  include W3CValidators
+  def setup
+    @v = MarkupValidator.new
+    sleep 1
+  end
+
+  def test_overriding_doctype
+    @v.set_doctype!(:html32, false)
+    r = @v.validate_uri('http://code.dunae.ca/w3c_validators/test/invalid_markup.html')
+    assert_equal '-//W3C//DTD HTML 3.2 Final//EN', r.doctype
+  end
+
+  def test_overriding_doctype_for_fallback_only
+    @v.set_doctype!(:html32, true)
+    r = @v.validate_uri('http://code.dunae.ca/w3c_validators/test/invalid_markup.html')
+    assert_not_equal '-//W3C//DTD HTML 3.2 Final//EN', r.doctype
+  end
+
+  def test_overriding_charset
+    @v.set_charset!(:utf_16, false)
+    r = @v.validate_uri('http://code.dunae.ca/w3c_validators/test/invalid_markup.html')
+    assert_equal 'utf-16', r.charset
+  end
+
+  def test_overriding_charset_for_fallback_only
+    @v.set_doctype!(:utf_16, true)
+    r = @v.validate_uri('http://code.dunae.ca/w3c_validators/test/invalid_markup.html')
+    assert_not_equal 'utf-16', r.charset
+  end
+
+  def test_validating_uri_with_head_request
+    r = @v.validate_uri_quickly('http://code.dunae.ca/w3c_validators/test/invalid_markup.html')
+    assert_equal 1, r.errors.length
+    assert_equal 0, r.warnings.length
+  end
+
+  def test_validating_uri_with_soap
+    r = @v.validate_uri('http://code.dunae.ca/w3c_validators/test/invalid_markup.html')
+    assert_equal 1, r.errors.length
+    assert_equal 0, r.warnings.length
+  end
+
+  def test_debugging_uri
+    @v.set_debug!
+    r = @v.validate_uri('http://code.dunae.ca/w3c_validators/test/invalid_markup.html')
+    assert r.debug_messages.length > 0
+  end
+
+  def test_validating_file
+    file = File.dirname(__FILE__) + '/fixtures/invalid_markup.html'
+    r = @v.validate_file(file)
+    assert_equal 1, r.errors.length
+    
+    assert r.uri =~ /fixtures\/invalid_markup\.html$/
+  end
+
+  def test_validating_text
+    valid_fragment = <<-EOV
+      <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+      <title>Test</title>
+      <body>
+      <div class="example">This is a test</div>
+      </body>
+    EOV
+    
+    r = @v.validate_text(valid_fragment)
+    assert_equal 0, r.errors.length
+    assert_equal 0, r.warnings.length
+  end
+
+  def test_validating_text_via_file
+    fh = File.new(File.dirname(__FILE__) + '/fixtures/invalid_markup.html', 'r+')    
+    r = @v.validate_file(fh)
+    fh.close
+    assert_equal 1, r.errors.length
+  end
+
+
+  def test_validator_abort
+    @v.set_debug!
+    assert_nothing_raised do
+      r = @v.validate_uri('http://code.dunae.ca/w3c_validators/test/invalid_encoding.html')
+      assert !r.is_valid?
+      assert_equal 1, r.errors.length
+      assert_equal [], r.warnings
+    end
+  end
+
+
+end