alexdunae-w3c_validators 1.0.0

data/CHANGELOG

@@ -0,0 +1,19 @@
+= CHANGELOG
+
+== Version 0.9.0
+ * initial version
+
+== Version 0.9.1
+ * fixed include path bug
+
+== Version 0.9.2 (the Ryan King edition)
+ * added check for HTML validator being unable to parse a file
+
+== Version 0.9.3 (the Ryan King/Jonathan Julian/Sylvain LaFleur edition)
+ * MarkupValidator::validate_file now returns file path as Results.uri
+ * All validate_file methods now allow a file path or an IO object (e.g. File)
+
+== Version 1.0.0 (the GitHub edition)
+ * Gemspec is now generated by a rake task to allow dynamic file lists
+ * Updated docs
+ 

data/LICENSE

@@ -0,0 +1,60 @@
+= W3C Validators License
+
+W3C Validators is copyrighted free software by Alex Dunae (http://dunae.ca/).
+You can redistribute it and/or modify it under either the terms of the GPL 
+or the conditions below:
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+	  modifications to Usenet or an equivalent medium, or by allowing
+	  the author to include your modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) rename any non-standard executables so the names do not conflict
+	  with standard executables, which must also be provided.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or executable
+     form, provided that you do at least ONE of the following:
+
+       a) distribute the executables and library files of the software,
+	  together with instructions (in the manual page or equivalent)
+	  on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+	  the software.
+
+       c) give non-standard executables non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial).  But some files in the distribution
+     are not written by the author, so that they are not under this terms.
+
+     They are gc.c(partly), utils.c(partly), regex.[ch], st.[ch] and some
+     files under the ./missing directory.  See each file for the copying
+     condition.
+
+  5. The scripts and library files supplied as input to or produced as 
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them, 
+     and may be sold commercially, and may be aggregated with this
+     software.
+
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.
+

data/README.rdoc

@@ -0,0 +1,122 @@
+= W3C Validators Gem README
+
+W3C Validators is a Ruby wrapper for the World Wide Web Consortium's online 
+validation services.
+
+It supports the markup validator, the feed validator and the CSS validator.
+
+=== Installation
+
+  gem sources -a http://gems.github.com
+  gem install alexdunae-w3c_validators
+
+=== Usage
+
+There are three main validator classes available, the W3CValidators::MarkupValidator 
+(used for HTML), the W3CValidators::FeedValidator and the 
+W3CValidators::CSSValidator.
+
+Each validator has offers three different validation methods.
+
+* +validate_text+ methods take a string
+* +validate_file+ methods take a path to a file or an IO object
+* +validate_uri+ methods take a published URL
+
+In addition, the W3CValidators::MarkupValidator has a validate_uri_quickly method, which 
+performs a HEAD request against the markup validation service.  The Results 
+of this call give an error count but no error details.
+
+==== Using a local validator
+
+Each of the three validators allows you to specify a custom path to the 
+validator.  You can set your own validator like this:
+
+  validator = MarkupValidator.new(:validator_uri => 'http://localhost/check')
+
+=== Examples
+
+==== Example #1: Markup validator, local file
+
+  require 'w3c_validators'
+  
+  include W3CValidators
+
+  @validator = MarkupValidator.new
+  
+  # override the DOCTYPE
+  @validator.set_doctype!(:html32)
+  
+  # turn on debugging messages
+  @validator.set_debug!(true)
+
+  file = File.dirname(__FILE__) + '/fixtures/markup.html'
+  results = @validator.validate_file(fp)
+
+  if results.errors.length > 0
+    results.errors.each do |err|
+      puts err.to_s
+    end
+  else
+    puts 'Valid!'
+  end
+  
+  puts 'Debugging messages'
+  
+  results.debug_messages.each do |key, value|
+    puts "#{key}: #{value}"
+  end
+
+
+==== Example #2: Feed validator, remote file
+
+  require 'w3c_validators'
+  
+  include W3CValidators
+
+  @validator = FeedValidator.new
+
+  results = @validator.validate_uri('http://example.com/feed.xml')
+
+  if results.errors.length > 0
+    results.errors.each do |err|
+      puts err.to_s
+    end
+  else
+    puts 'Valid!'
+  end
+
+==== Example #3: CSS validator, text fragment
+
+  require 'w3c_validators'
+  
+  include W3CValidators
+
+  @validator = CSSValidator.new
+
+  results = @validator.validate_text('body { margin: 0px; }')
+
+  if results.errors.length > 0
+    results.errors.each do |err|
+      puts err.to_s
+    end
+  else
+    puts 'Valid!'
+  end
+
+=== Tests
+
+Run unit tests using <tt>rake test</tt>.  Note that there is a one second delay 
+between each call to the W3C's validators per their request.
+
+
+=== Credits and code
+
+Documentation is available at {http://code.dunae.ca/w3c_validators}[http://code.dunae.ca/w3c_validators].
+
+Source is available on {GitHub}[https://github.com/alexdunae/w3c-validators]
+
+Written by Alex Dunae ({dunae.ca}[http://dunae.ca/], e-mail 'code' at the same domain), 2007.
+
+Thanks to {Ryan King}[http://theryanking.com/] for creating the 0.9.2 update.
+
+Thanks to {Ryan King}[http://theryanking.com/], {Jonathan Julian}[http://jonathanjulian.org/] and Sylvain LaFleur for creating the 0.9.3 update.

data/lib/w3c_validators.rb

@@ -0,0 +1,6 @@
+$:.unshift File.dirname(__FILE__)
+require 'w3c_validators/validator'
+require 'w3c_validators/markup_validator'
+require 'w3c_validators/nu_validator'
+require 'w3c_validators/feed_validator'
+require 'w3c_validators/css_validator'

data/lib/w3c_validators/constants.rb

@@ -0,0 +1,80 @@
+module W3CValidators
+  CSS_PROFILES = { :css1 => 'CSS 1',
+                   :css2 => 'CSS 2.0',
+                   :css21 => 'CSS 1.0',
+                   :css3 => 'CSS 3.0',
+                   :svg => 'SVG',
+                   :svgbasic => 'SVG Basic',
+                   :svgtiny => 'SVG Tiny',
+                   :mobile => 'Mobile',
+                   :atsc_tv => 'ATSC TV',
+                   :tv => 'TV'
+                 }
+
+  DOCTYPES = { :xhtml10_strict => 'XHTML 1.0 Strict',
+               :xhtml10_transitional => 'XHTML 1.0 Transitional',
+               :xhtml10_frameset => 'XHTML 1.0 Frameset',
+               :xhtml401_strict => 'HTML 4.01 Strict',
+               :xhtml401_transitional => 'HTML 4.01 Transitional',
+               :xhtml401_framest => 'HTML 4.01 Frameset',
+               :html5 => 'HTML 5',
+               :html32 => 'HTML 3.2',
+               :html20 => 'HTML 2.0',
+               :iso_html => 'ISO/IEC 15445:2000 ("ISO HTML")',
+               :xhtml11 => 'XHTML 1.1',
+               :xhtml_basic10 => 'XHTML Basic 1.0',
+               :xhtml_print10 => 'XHTML-Print 1.0',
+               :xhtml11_plus_mathml20  => 'XHTML 1.1 plus MathML 2.0',
+               :xhtml11_plus_mathml20_plus_svg11 => 'XHTML 1.1 plus MathML 2.0 plus SVG 1.1',
+               :mathml20=> 'MathML 2.0',
+               :svg10 => 'SVG 1.0',
+               :svg11 => 'SVG 1.1',
+               :svg11tiny => 'SVG 1.1 Tiny',
+               :svg11_basic => 'SVG 1.1 Basic',
+               :smil10 => 'SMIL 1.0',
+               :smil20 => 'SMIL 2.0'
+             }
+
+  CHARSETS = {  :utf_8 => 'utf-8',
+                :utf_16 => 'utf-16',
+                :iso_8859_1 => 'iso-8859-1',
+                :iso_8859_2 => 'iso-8859-2',
+                :iso_8859_3 => 'iso-8859-3',
+                :iso_8859_4 => 'iso-8859-4',
+                :iso_8859_5 => 'iso-8859-5',
+                :iso_8859_6i => 'iso-8859-6-i',
+                :iso_8859_7 => 'iso-8859-7',
+                :iso_8859_8 => 'iso-8859-8',
+                :iso_8859_8i => 'iso-8859-8-i',
+                :iso_8859_9 => 'iso-8859-9',
+                :iso_8859_10 => 'iso-8859-10',
+                :iso_8859_11 => 'iso-8859-11',
+                :iso_8859_13 => 'iso-8859-13',
+                :iso_8859_14 => 'iso-8859-14',
+                :iso_8859_15 => 'iso-8859-15',
+                :iso_8859_16 => 'iso-8859-16',
+                :us_ascci => 'us-ascii',
+                :euc_jp => 'euc-jp',
+                :shift_jis => 'shift_jis',
+                :iso_2022_hp => 'iso-2022-jp',
+                :euc_jr => 'euc-kr',
+                :ksk_5601 => 'ksc_5601',
+                :gb_2312 => 'gb2312',
+                :gb_18030 => 'gb18030',
+                :big5 => 'big5',
+                :big5_hkscs => 'big5-HKSCS',
+                :tis_620 => 'tis-620',
+                :koi8_r => 'koi8-r',
+                :koi8_u => 'koi8-u',
+                :iso_ir_111 => 'iso-ir-111',
+                :macintosh => 'macintosh',
+                :windows_1250 => 'windows-1250',
+                :windows_1251 => 'windows-1251',
+                :windows_1252 => 'windows-1252',
+                :windows_1253 => 'windows-1253',
+                :windows_1254 => 'windows-1254',
+                :windows_1255 => 'windows-1255',
+                :windows_1256 => 'windows-1256',
+                :windows_1257 => 'windows-1257'
+              }
+end

data/lib/w3c_validators/css_validator.rb

@@ -0,0 +1,149 @@
+module W3CValidators
+  class CSSValidator < Validator
+    CSS_VALIDATOR_URI      = 'http://jigsaw.w3.org/css-validator/validator'
+
+    # Create a new instance of the CSSValidator.
+    #
+    # ==== Options
+    # You can pass in your own validator's URI (i.e. 
+    # <tt>CSSValidator.new(:validator_uri => 'http://localhost/check')</tt>).
+    def initialize(options = {})
+      if options[:validator_uri]
+        @validator_uri = URI.parse(options[:validator_uri])
+        options.delete(options[:validator_uri])
+      else
+        @validator_uri = URI.parse(CSS_VALIDATOR_URI)
+      end
+      super(options)
+    end
+    
+    # The CSS profile used for the validation.
+    #
+    # +charset+ can be a string or a symbl from the W3CValidators::CSS_PROFILES hash.
+    #
+    # ==== Example
+    #   set_profile!('css1')
+    #   set_profile!(:css1)
+    def set_profile!(profile)
+      if profile.kind_of?(Symbol)
+        if CSS_PROFILES.has_key?(profile)
+          profile = profile.to_s
+        else
+          return
+        end
+      end
+      @options[:profile] = profile
+    end
+
+    # The warning level, no for no warnings, 0 for less warnings, 1or 2 for more warnings
+    def set_warn_level!(level = 2)
+      warn_levels = ['0','1','2','no']
+      return unless warn_levels.include?(level.to_s.downcase)
+
+      @options[:warning] = level
+    end
+
+    # The language used for the response.
+    def set_language!(lang = 'en')
+      @options[:lang] = lang
+    end
+
+    # Validate the CSS of an URI.
+    #
+    # Returns W3CValidators::Results.
+    def validate_uri(uri)
+      return validate({:uri => uri})
+    end
+
+    # Validate the CSS of a string.
+    #
+    # Returns W3CValidators::Results.
+    def validate_text(text)
+      return validate({:text => text})
+    end
+    
+    # Validate the CSS of a local file.
+    #
+    # +file_path+ may be either the fully-expanded path to the file or
+    # an IO object (like File).
+    #
+    # Returns W3CValidators::Results.
+    def validate_file(file_path)
+      if file_path.respond_to? :read
+        src = file_path.read
+      else
+        src = read_local_file(file_path)
+      end 
+      return validate_text(src)
+    end
+
+
+protected
+    def validate(options) # :nodoc:
+      options = get_request_options(options)
+      response = send_request(options, :get)
+      @results = parse_soap_response(response.body)
+      @results
+    end
+
+    # Perform sanity checks on request params
+    def get_request_options(options) # :nodoc:
+      options = @options.merge(options)
+     
+      options[:output] = SOAP_OUTPUT_PARAM
+      
+      unless options[:uri] or options[:text]
+        raise ArgumentError, "an uri or text is required."
+      end
+
+      # URI should be a string.  If it is a URI object, .to_s will
+      # be seamless; if it is not an exception will be raised.
+      if options[:uri] and not options[:uri].kind_of?(String)
+        options[:uri] = options[:uri].to_s
+      end
+
+      options
+    end
+
+
+    def parse_soap_response(response) # :nodoc:
+      doc = REXML::Document.new(response)
+
+      result_params = {}
+
+      {:uri => 'uri', :checked_by => 'checkedby', :validity => 'validity', :css_level => 'csslevel'}.each do |local_key, remote_key|        
+        if val = doc.elements["//*[local-name()='cssvalidationresponse']/*[local-name()='#{remote_key.to_s}']"]
+          result_params[local_key] = val.text
+        end
+      end
+
+      results = Results.new(result_params)
+
+      ['warninglist', 'errorlist'].each do |list_type|
+        doc.elements.each("//*[local-name()='#{list_type.to_s}']") do |message_list|        
+
+          if uri_node = message_list.elements["*[local-name()='uri']"]
+            uri = uri_node.text
+          end
+
+          [:warning, :error].each do |msg_type|
+            message_list.elements.each("*[local-name()='#{msg_type.to_s}']") do |message|
+              message_params = {}
+              message.each_element_with_text do |el|
+                message_params[el.name.to_sym] = el.text
+              end
+              message_params[:uri] = uri
+              results.add_message(msg_type, message_params)
+            end
+          end
+        end
+      end
+      return results
+
+    rescue Exception => e
+      handle_exception e
+    end
+
+  
+  end
+end

data/lib/w3c_validators/exceptions.rb

@@ -0,0 +1,4 @@
+module W3CValidators
+  class ValidatorUnavailable < StandardError; end
+  class ParsingError < StandardError; end
+end