w3c_validators 1.2 → 1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9cc7b916dd4e54b2c9c76269ad51c2cec12cb76c
+  data.tar.gz: efb3a5044a1fa78ea07eeadbcb793deb179f8cda
+SHA512:
+  metadata.gz: 4be45ecae869797669466162849f2518c8501a8edb6bf413c385d8def5e84fafc4598bb4d8a7ee59db3cb44278f34e0b037a79b1afef8f70e392a26738f7dae1
+  data.tar.gz: cc89e2ffb16c24e9fa066e6a4b5bd3040a279e5767400e76cf06bd7b029f583a95ab3024027519e9b2f0ca80592c8863c4fa482bbc6abb6fd1eec261648b74cf

data/.gitignore

@@ -0,0 +1,4 @@
+docs/
+*.gem
+.ruby-version
+.ruby-gemset

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.3.1
+  - 2.2.5
+  - 2.1.9
+  - 2.0.0
+

data/CHANGELOG

@@ -30,8 +30,20 @@
 == Version 1.1
  * Ruby 1.9 compatibility
  * Switched to Nokogiri for XML parsing
- 
+
 == Version 1.2
  * Use CSS3 as default profile 
  * Use Bundler and update to new RDoc command 
- * Use POST in feed validator
+ 
+== Version 1.3 (not yet published)
+ * drop ruby 1.9 compatibility
+ * Move markup and nu validators to https
+ * Use POST for file validation (avoid crash for big files)
+ * Use POST with x-www-form-urlencoded instead of multipart/form-data for feed validation
+ * Mock test with VCR to prevent w3c abuse ban when replaying tests
+ * Add support for context and skippedstring to CSS messages
+ * Create gemspec
+ * Move README from rdoc format to markdown format
+ * Add capability to manage vendor extension as warning or error
+ * Activate travis-ci build
+

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    w3c_validators (1.3)
+      json (~> 2.0)
+      nokogiri (~> 1.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.0)
+      public_suffix (~> 2.0, >= 2.0.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    hashdiff (0.3.1)
+    json (2.0.2)
+    mini_portile2 (2.1.0)
+    nokogiri (1.6.8.1)
+      mini_portile2 (~> 2.1.0)
+    power_assert (0.4.1)
+    public_suffix (2.0.4)
+    rake (11.3.0)
+    safe_yaml (1.0.4)
+    test-unit (3.2.3)
+      power_assert
+    vcr (3.0.3)
+    webmock (2.1.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake
+  test-unit
+  vcr
+  w3c_validators!
+  webmock
+
+BUNDLED WITH
+   1.13.6

data/{README.rdoc → README.md}

@@ -1,50 +1,57 @@
-= W3C Validators Gem README
+# W3C Validators Gem README
+[![Build Status](https://travis-ci.org/w3c-validators/w3c_validators.svg?branch=master)](https://travis-ci.org/w3c-validators/w3c_validators)
 
 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
+### Installation
 
+```bash
   gem install w3c_validators
+```
 
-=== Usage
+### Usage
 
-There are three main validator classes available, the W3CValidators::MarkupValidator 
-(used for HTML), the W3CValidators::FeedValidator and the 
-W3CValidators::CSSValidator.
+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
+* `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 
+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
+#### 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:
 
+```ruby
   validator = MarkupValidator.new(:validator_uri => 'http://localhost/check')
+```
 
-==== Using a proxy server
+#### Using a proxy server
 
 You can use a proxy server by passing in its information in the contructor.
 
-  validator = MarkupValidator.new(:proxy_server => 'proxy.example.com',
-                                  :proxy_port   => 80,
-                                  :proxy_user   => 'optional',
-                                  :proxy_pass   => 'optional')
+```ruby
+  validator = MarkupValidator.new(:proxy_host => 'proxy.example.com',
+                                  :proxy_port => 80,
+                                  :proxy_user => 'optional',
+                                  :proxy_pass => 'optional')
+```
 
-=== Examples
+### Examples
 
-==== Example #1: Markup validator, local file
+#### Example #1: Markup validator, local file
 
+```ruby
   require 'w3c_validators'
   
   include W3CValidators
@@ -73,10 +80,12 @@ You can use a proxy server by passing in its information in the contructor.
   results.debug_messages.each do |key, value|
     puts "#{key}: #{value}"
   end
+```
 
 
-==== Example #2: Feed validator, remote file
+#### Example #2: Feed validator, remote file
 
+```ruby
   require 'w3c_validators'
   
   include W3CValidators
@@ -92,9 +101,11 @@ You can use a proxy server by passing in its information in the contructor.
   else
     puts 'Valid!'
   end
+```
 
-==== Example #3: CSS validator, text fragment
+#### Example #3: CSS validator, text fragment
 
+```ruby
   require 'w3c_validators'
   
   include W3CValidators
@@ -110,23 +121,24 @@ You can use a proxy server by passing in its information in the contructor.
   else
     puts 'Valid!'
   end
+```
 
-=== Tests
+### 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
+### Credits and code
 
-Documentation is available at {http://code.dunae.ca/w3c_validators}[http://code.dunae.ca/w3c_validators].
+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]
+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.
+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/) 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.
+Thanks to [Ryan King](http://theryanking.com/), [Jonathan Julian](http://jonathanjulian.org/) and Sylvain LaFleur for creating the 0.9.3 update.
 
-Thanks to {James Rosen}[http://github.com/jamesarosen] and {Roman Shterenzon}[http://github.com/romanbsd] for creating the 1.0.1 update.
+Thanks to [James Rosen](http://github.com/jamesarosen) and [Roman Shterenzon](http://github.com/romanbsd) for creating the 1.0.1 update.

data/Rakefile

@@ -0,0 +1,64 @@
+require 'rubygems'
+require 'bundler/setup'
+
+$: << File.expand_path(File.dirname(__FILE__))
+$: << File.expand_path(File.dirname(__FILE__)) + '/test'
+
+require 'rake'
+require 'rdoc/task'
+require 'rake/testtask'
+require 'lib/w3c_validators'
+require 'fileutils'
+
+include W3CValidators
+
+desc 'Run the unit tests.'
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.libs << 'lib/test'
+  t.test_files = FileList['test/test*.rb'].exclude('test_helper.rb')
+  t.verbose = true
+end
+
+desc 'Generate documentation for W3C Validators.'
+RDoc::Task.new do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title    = 'Ruby W3C Validators'
+  rdoc.options << '--all' << '--inline-source' << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('LICENSE')
+  rdoc.rdoc_files.include('CHANGELOG')
+  rdoc.rdoc_files.include('lib/*.rb')
+  rdoc.rdoc_files.include('lib/w3c_validators/*.rb')
+end
+
+desc 'Create the gem spec'
+task :create_gemspec do
+  File.open("w3c_validators.gemspec","w") do |file|
+    file.puts <<-EOH
+# Auto-generated gemspec
+# Run 'rake generate_gemspec' to re-generate
+Gem::Specification.new do |s|
+  s.name     = "w3c_validators"
+  s.platform = Gem::Platform::RUBY
+  s.version  = "1.1.1"
+  s.date     = "2010-10-20"
+  s.summary  = "Wrapper for the World Wide Web Consortium's online validation services."
+  s.email    = "code@dunae.ca"
+  s.homepage = "http://code.dunae.ca/w3c_validators"
+  s.description = "W3C Validators is a Ruby wrapper for the World Wide Web Consortium's online validation services."
+  s.has_rdoc = true
+  s.author  = "Alex Dunae"
+  s.add_dependency('nokogiri', 'json')
+  s.extra_rdoc_files = ['README.rdoc', 'CHANGELOG', 'LICENSE']
+  s.rdoc_options << '--all' << '--inline-source' << '--line-numbers' << '--charset' << 'utf-8'
+EOH
+  
+    file.puts "  s.test_files = ['" +  Dir.glob('test/test_*.rb').join("','") + "']"
+    file.puts "  s.files = ['" +  FileList["{lib}/**/*"].join("','") + "']"
+    file.puts 'end'
+  end
+end
+
+task :default => :test
+

data/lib/w3c_validators.rb

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

data/lib/w3c_validators/css_validator.rb

@@ -5,7 +5,7 @@ module W3CValidators
     # Create a new instance of the CSSValidator.
     #
     # ==== Options
-    # You can pass in your own validator's URI (i.e. 
+    # You can pass in your own validator's URI (i.e.
     # <tt>CSSValidator.new(:validator_uri => 'http://localhost/check')</tt>).
     #
     # See Validator#new for proxy server options.
@@ -19,7 +19,7 @@ module W3CValidators
       options[:profile] ||= 'css3'
       super(options)
     end
-    
+
     # The CSS profile used for the validation.
     #
     # +charset+ can be a string or a symbl from the W3CValidators::CSS_PROFILES hash.
@@ -51,6 +51,13 @@ module W3CValidators
       @options[:lang] = lang
     end
 
+    # whether to treat presence of CSS vendor extension as error or merely a warning
+    def set_vendor_extension_warning!(level = 'Default')
+      @options[:vextwarning] = nil     if level.to_s.downcase == 'default'
+      @options[:vextwarning] = 'true'  if level.to_s.downcase == 'warnings'
+      @options[:vextwarning] = 'false' if level.to_s.downcase == 'errors'
+    end
+
     # Validate the CSS of an URI.
     #
     # Returns W3CValidators::Results.
@@ -61,10 +68,10 @@ module W3CValidators
     # Validate the CSS of a string.
     #
     # Returns W3CValidators::Results.
-    def validate_text(text)
-      return validate({:text => text})
+    def validate_text(text, request_mode = :get)
+      return validate({:text => text}, request_mode)
     end
-    
+
     # Validate the CSS of a local file.
     #
     # +file_path+ may be either the fully-expanded path to the file or
@@ -77,14 +84,16 @@ module W3CValidators
       else
         src = read_local_file(file_path)
       end 
-      return validate_text(src)
+      # we force the :post mode otherwise it fails for
+      # big files
+      return validate_text(src, :post)
     end
 
 
 protected
-    def validate(options) # :nodoc:
+    def validate(options, request_mode = :get) # :nodoc:
       options = get_request_options(options)
-      response = send_request(options, :get)
+      response = send_request(options, request_mode)
       @results = parse_soap_response(response.body)
       @results
     end
@@ -92,9 +101,9 @@ protected
     # 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
@@ -111,11 +120,11 @@ protected
 
     def parse_soap_response(response) # :nodoc:
       doc = Nokogiri::XML(response)
-      doc.remove_namespaces! 
+      doc.remove_namespaces!
 
       result_params = {}
 
-      {:uri => 'uri', :checked_by => 'checkedby', :validity => 'validity', :css_level => 'csslevel'}.each do |local_key, remote_key|        
+      {:uri => 'uri', :checked_by => 'checkedby', :validity => 'validity', :css_level => 'csslevel'}.each do |local_key, remote_key|
         if val = doc.at('cssvalidationresponse ' + remote_key)
           result_params[local_key] = val.text
         end
@@ -124,7 +133,7 @@ protected
       results = Results.new(result_params)
 
       ['warninglist', 'errorlist'].each do |list_type|
-        doc.css(list_type).each do |message_list|        
+        doc.css(list_type).each do |message_list|
 
           if uri_node = message_list.at('uri')
             uri = uri_node.text
@@ -147,7 +156,5 @@ protected
     rescue Exception => e
       handle_exception e
     end
-
-  
   end
-end
+end

data/lib/w3c_validators/feed_validator.rb

@@ -23,7 +23,7 @@ module W3CValidators
     #
     # Returns W3CValidators::Results.
     def validate_uri(url)
-      return validate({:url => url})
+      return validate({:url => url}, :get)
     end
 
     # Validate a feed from a string.
@@ -49,9 +49,9 @@ module W3CValidators
     end
 
 protected
-    def validate(options) # :nodoc:
+    def validate(options, mode = :post_url_encode) # :nodoc:
       options = get_request_options(options)
-      response = send_request(options, :post)
+      response = send_request(options, mode)
       @results = parse_soap_response(response.body)
       @results
     end
@@ -110,4 +110,4 @@ protected
       handle_exception e
     end
   end
-end
+end

data/lib/w3c_validators/markup_validator.rb

@@ -1,15 +1,15 @@
 module W3CValidators
   class MarkupValidator < Validator
-    MARKUP_VALIDATOR_URI      = 'http://validator.w3.org/check'
+    MARKUP_VALIDATOR_URI      = 'https://validator.w3.org/check'
 
     # Create a new instance of the MarkupValidator.
     #
     # ==== Options
-    # The +options+ hash allows you to set request parameters (see 
-    # http://validator.w3.org/docs/api.html#requestformat) quickly. Request 
+    # The +options+ hash allows you to set request parameters (see
+    # http://validator.w3.org/docs/api.html#requestformat) quickly. Request
     # parameters can also be set using set_charset!, set_debug! and set_doctype!.
     #
-    # You can pass in your own validator's URI (i.e. 
+    # You can pass in your own validator's URI (i.e.
     # <tt>MarkupValidator.new(:validator_uri => 'http://localhost/check')</tt>).
     #
     # See Validator#new for proxy server options.
@@ -22,14 +22,14 @@ module W3CValidators
       end
       super(options)
     end
-    
-    # Specify the character encoding to use when parsing the document. 
+
+    # Specify the character encoding to use when parsing the document.
     #
-    # When +only_as_fallback+ is +true+, the given encoding will only be 
-    # used as a fallback value, in case the +charset+ is absent or unrecognized. 
+    # When +only_as_fallback+ is +true+, the given encoding will only be
+    # used as a fallback value, in case the +charset+ is absent or unrecognized.
     #
-    # +charset+ can be a string (e.g. <tt>set_charset!('utf-8')</tt>) or 
-    # a symbol (e.g. <tt>set_charset!(:utf_8)</tt>) from the 
+    # +charset+ can be a string (e.g. <tt>set_charset!('utf-8')</tt>) or
+    # a symbol (e.g. <tt>set_charset!(:utf_8)</tt>) from the
     # W3CValidators::CHARSETS hash.
     #
     # Has no effect when using validate_uri_quickly.
@@ -45,14 +45,14 @@ module W3CValidators
       @options[:fbc] = only_as_fallback
     end
 
-    # Specify the Document Type (+DOCTYPE+) to use when parsing the document. 
+    # Specify the Document Type (+DOCTYPE+) to use when parsing the document.
     #
-    # When +only_as_fallback+ is +true+, the given document type will only be 
-    # used as a fallback value, in case the document's +DOCTYPE+ declaration 
+    # When +only_as_fallback+ is +true+, the given document type will only be
+    # used as a fallback value, in case the document's +DOCTYPE+ declaration
     # is missing or unrecognized.
     #
-    # +doctype+ can be a string (e.g. <tt>set_doctype!('HTML 3.2')</tt>) or 
-    # a symbol (e.g. <tt>set_doctype!(:html32)</tt>) from the 
+    # +doctype+ can be a string (e.g. <tt>set_doctype!('HTML 3.2')</tt>) or
+    # a symbol (e.g. <tt>set_doctype!(:html32)</tt>) from the
     # W3CValidators::DOCTYPES hash.
     #
     # Has no effect when using validate_uri_quickly.
@@ -68,11 +68,11 @@ module W3CValidators
       @options[:fbd] = only_as_fallback
     end
 
-    # When set the validator will output some extra debugging information on 
-    # the validated resource (such as HTTP headers) and validation process 
+    # When set the validator will output some extra debugging information on
+    # the validated resource (such as HTTP headers) and validation process
     # (such as parser used, parse mode, etc.).
     #
-    # Debugging information is stored in the Results +debug_messages+ hash. 
+    # Debugging information is stored in the Results +debug_messages+ hash.
     # Custom debugging messages can be set with Results#add_debug_message.
     #
     # Has no effect when using validate_uri_quickly.
@@ -100,7 +100,7 @@ module W3CValidators
     def validate_text(text)
       return validate({:fragment => text}, false)
     end
-    
+
     # Validate the markup of a local file.
     #
     # +file_path+ may be either the fully-expanded path to the file or
@@ -112,7 +112,7 @@ module W3CValidators
         src = file_path.read
       else
         src = read_local_file(file_path)
-      end 
+      end
 
       return validate({:uploaded_file => src, :file_path => file_path}, false)
     end
@@ -138,9 +138,9 @@ protected
     # 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[:uploaded_file] or options[:fragment]
         raise ArgumentError, "an uri, uploaded file or fragment is required."
       end
@@ -150,7 +150,7 @@ protected
       if options[:uri] and not options[:uri].kind_of?(String)
         options[:uri] = options[:uri].to_s
       end
-      
+
       # Convert booleans to integers
       [:fbc, :fbd, :verbose, :debug, :ss, :outline].each do |k|
         if options.has_key?(k) and not options[k].kind_of?(Fixnum)
@@ -169,12 +169,12 @@ protected
     # Returns W3CValidators::Results.
     def parse_soap_response(response) # :nodoc:
       doc = Nokogiri::XML(response)
-      doc.remove_namespaces! 
+      doc.remove_namespaces!
 
       result_params = {}
 
-      {:doctype => 'doctype', :uri => 'uri', :charset => 'charset', 
-       :checked_by => 'checkedby', :validity => 'validity'}.each do |local_key, remote_key|        
+      {:doctype => 'doctype', :uri => 'uri', :charset => 'charset',
+       :checked_by => 'checkedby', :validity => 'validity'}.each do |local_key, remote_key|
         if val = doc.css(remote_key)
           result_params[local_key] = val.text
         end
@@ -195,7 +195,7 @@ protected
       doc.css("Fault Reason Text").each do |message|
         results.add_message(:error, {:mesage => message.text})
       end
-      
+
       doc.css("markupvalidationresponse debug").each do |debug|
         results.add_debug_message(debug.attribute('name').value, debug.text)
       end
@@ -212,7 +212,7 @@ protected
     # Returns Results.
     def parse_head_response(response, validated_uri = nil) # :nodoc:
       validity = (response[HEAD_STATUS_HEADER].downcase == 'valid')
-      
+
       results = Results.new(:uri => validated_uri, :validity => validity)
 
       # Fill the results with empty error messages so we can count them
@@ -222,6 +222,6 @@ protected
       results
     end
 
-  
+
   end
 end