w3c_validators 1.3.1 → 1.3.6

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YWFjNTU0OWFlMTA4ZGZlYTliNjRkYWE0MjE2ZjQ1N2RjMjA4ODU4OA==
-  data.tar.gz: !binary |-
-    YTQwZjFlNWI4MWViYzhlZmQwYmY5ZmUxODJhMTU0YjJlZmUyN2I0NA==
+SHA256:
+  metadata.gz: 93c24630d8eff576b83949a26d71d048d5a126bc17829576c3fbe00f7715239f
+  data.tar.gz: 25513e9917618bdc76488ffe559a5366c2ebe87f465d53babedcac4467fe4d81
 SHA512:
-  metadata.gz: !binary |-
-    NjY2OGFjOTAwNmNiNGFmNGFhMTNkMWY4MWNmNzViYzU4ZTRhYmUyNzkyYzYw
-    YTFjMDI5NWZjZGU3ZTUyOTc3NDcwZTFlNWI1OWRkNjZlOTE3OTFlY2Y4OTY0
-    OWJhOTVhZWU5NWMwY2VlNGI2OTM5NmQyYTA1MjZjNGU3ZGVlYjU=
-  data.tar.gz: !binary |-
-    OTE1OGJhNzhhYWYwYTNjOGEyYThkMmZhZTU1Nzg5ODFlNWYzNGNhZGJhMWNk
-    Nzk5MDRlYzRhYWE4NWE5Zjk3N2U1Njg0MDY0MGE5MDJlZjY2OGI1NzdmZmY1
-    ZjhmYWI2NmViMzViYjBiNGU0ZjliNmVmOGQwY2Y4MGExMGZkNzI=
+  metadata.gz: 60350bd80921cabf33d2b7407b89c9f42cf141df15089549f4a7d088a78be6fbf6393506c4ca0d65b497558eb41c3e93407d130430b493834853244386b55b05
+  data.tar.gz: 6a135e36f46733b84ccfae834a7e1c4ac69734bc69735ff9ee81ac2af72225df823651e05655d6836993afc48ab42377f5f91c3c0357b186795dc777e4dd5c8a

data/.gitignore

@@ -2,4 +2,4 @@ docs/
 *.gem
 .ruby-version
 .ruby-gemset
-.Gemfile.lock
+Gemfile.lock

data/.travis.yml

@@ -1,7 +1,9 @@
 language: ruby
 rvm:
-  - 2.3.1
-  - 2.2.5
-  - 2.1.9
-  - 2.0.0
+  - ruby-head
+  - 2.7.1
+  - 2.6.6
+  - 2.5.8
+  - 2.4.10
+  - 2.3.8
 

data/CHANGELOG

@@ -54,3 +54,25 @@
  * update gemspec
  * update test to point to project gh-pages
 
+== Version 1.3.2
+ * relax constraint on json gem to >=1.8 instead of ~>2.0
+ * add test of ruby 2.4.0 + drop test of ruby 2.0.0
+
+== Version 1.3.3
+ * add deprecation warning for class MarkupValidator
+ * raise ValidatorUnavailable when connection to uri is refused
+ * Change the Nu Validator URL to "https://validator.w3.org/nu/" (https://validator.nu is returning 502)
+
+== Version 1.3.4
+ * migrate css validator to https (instead of http)
+ * add test of ruby 2.5
+ * remove unused variable in nu validator code
+
+== Version 1.3.5
+ * replace Net::HTTPServerException (deprecated) by Net::HTTPClientException
+ * fix bad indentation of rescue in validators classes
+ * add test for ruby 2.6, update 2.5, 2.4, 2.3 tested version and remove 2.2 and 2.1 versions
+
+== Version 1.3.6
+ * update README to clarify usage with Ruby frameworks
+ * update dependencies to be ready for ruby 3.0

data/README.md

@@ -148,6 +148,36 @@ You can use a proxy server by passing in its information in the contructor.
     puts "#{key}: #{value}"
   end
 ```
+
+### Examples with Ruby Frameworks
+
+```
+# you can easily incorporate this in your ruby based frameworks:
+
+# Gemfile
+group :test do
+    gem 'w3c_validators'
+end
+
+# And in your relevant test file:
+
+require 'w3c_validators'
+
+class FoosControllerTest < ActionDispatch::IntegrationTest
+  setup do  
+    @validator = W3CValidators::NuValidator.new
+  end
+  
+  test "index" do
+    get foos_url
+    assert_equal 0, @validator.validate_text(response.body).errors.length
+  end
+end
+
+# granted it's not perfect, but hopefully that will at least get you going
+# you might want to customise things so that it delivers a particular output in case an error shows up.
+```
+
 ### Tests
 
 Run unit tests using <tt>rake test</tt>.  Note that there is a one second delay 

data/lib/w3c_validators/css_validator.rb

@@ -1,6 +1,6 @@
 module W3CValidators
   class CSSValidator < Validator
-    CSS_VALIDATOR_URI      = 'http://jigsaw.w3.org/css-validator/validator'
+    CSS_VALIDATOR_URI      = 'https://jigsaw.w3.org/css-validator/validator'
 
     # Create a new instance of the CSSValidator.
     #

data/lib/w3c_validators/markup_validator.rb

@@ -14,6 +14,7 @@ module W3CValidators
     #
     # See Validator#new for proxy server options.
     def initialize(options = {})
+      puts "The MarkupValidator class is deprecated (cf. https://validator.w3.org/docs/obsolete-api.html) as it cannot process HTML5 documents.\nPlease prefer the NuValidator class instead."
       if options[:validator_uri]
         @validator_uri = URI.parse(options[:validator_uri])
         options.delete(options[:validator_uri])
@@ -153,7 +154,7 @@ protected
 
       # 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)
+        if options.has_key?(k) and not options[k].kind_of?(Integer)
           options[k] = options[k] ? 1 : 0
         end
       end
@@ -201,8 +202,8 @@ protected
       end
       return results
 
-      rescue Exception => e
-        handle_exception e
+    rescue Exception => e
+      handle_exception e
     end
 
     # Parse the HEAD response into HTMLValidator::Results.

data/lib/w3c_validators/nu_validator.rb

@@ -2,7 +2,7 @@ require 'json'
 
 module W3CValidators
   class NuValidator < Validator
-    MARKUP_VALIDATOR_URI      = 'https://validator.nu/'
+    MARKUP_VALIDATOR_URI      = 'https://validator.w3.org/nu/'
 
     # Create a new instance of the NuValidator.
     #
@@ -44,17 +44,15 @@ module W3CValidators
     
     # Validate the markup of a local file.
     #
-    # +file_path+ may be either the fully-expanded path to the file or
+    # +file+ may be either the fully-expanded path to the file or
     # an IO object (like File).
     #
     # Returns W3CValidators::Results.
     def validate_file(file)
       if file.respond_to? :read
         src = file.read
-        file_path = file.path ||= nil
       else
         src = read_local_file(file)
-        file_path = file
       end 
 
       return validate_text(src)
@@ -142,8 +140,8 @@ protected
 
       return results
 
-      rescue Exception => e
-        handle_exception e
+    rescue Exception => e
+      handle_exception e
     end
   end
 end

data/lib/w3c_validators/validator.rb

@@ -16,6 +16,7 @@ module W3CValidators
     HEAD_STATUS_HEADER        = 'X-W3C-Validator-Status'
     HEAD_ERROR_COUNT_HEADER   = 'X-W3C-Validator-Errors'
     SOAP_OUTPUT_PARAM         = 'soap12'
+    USE_NEW_EXCEPTION         = Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.6')
 
     attr_reader :results, :validator_uri
 
@@ -112,8 +113,8 @@ module W3CValidators
       response.value
       return response
 
-      rescue Exception => e
-        handle_exception e
+    rescue Exception => e
+      handle_exception e
     end
 
     def create_multipart_data(options) # :nodoc:
@@ -173,8 +174,13 @@ module W3CValidators
     # Big thanks to ara.t.howard and Joel VanderWerf on Ruby-Talk for the exception handling help.
     #++
     def handle_exception(e, msg = '') # :nodoc:
+      if USE_NEW_EXCEPTION
+        http_exception = Net::HTTPClientException
+      else
+        http_exception = Net::HTTPServerException
+      end
       case e
-        when Net::HTTPServerException, SocketError
+        when http_exception, SocketError, Errno::ECONNREFUSED
           msg = "unable to connect to the validator at #{@validator_uri} (response was #{e.message})."
           raise ValidatorUnavailable, msg, caller
         when JSON::ParserError, Nokogiri::XML::SyntaxError

data/lib/w3c_validators/version.rb

@@ -1,3 +1,3 @@
 module W3CValidators
-  VERSION = "1.3.1"
+  VERSION = "1.3.6"
 end

data/test/http_recording/css_context.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: post
-    uri: http://jigsaw.w3.org/css-validator/validator
+    uri: https://jigsaw.w3.org/css-validator/validator
     body:
       encoding: UTF-8
       string: "--349832898984244898448024464570528145\r\nContent-Disposition: form-data;
@@ -27,7 +27,7 @@ http_interactions:
       Cache-Control:
       - no-cache
       Date:
-      - Thu, 27 Oct 2016 20:13:57 GMT
+      - Fri, 10 Aug 2018 19:59:10 GMT
       Pragma:
       - no-cache
       Transfer-Encoding:
@@ -37,20 +37,37 @@ http_interactions:
       Content-Type:
       - application/soap+xml;charset=utf-8
       Server:
-      - Jigsaw/2.3.0-beta2
+      - Jigsaw/2.3.0-beta3
       Vary:
       - Accept-Language
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Headers:
+      - content-type,accept-charset
+      Access-Control-Allow-Methods:
+      - GET, HEAD, POST, OPTIONS
+      Access-Control-Max-Age:
+      - '600'
       X-W3c-Validator-Errors:
       - '1'
       X-W3c-Validator-Status:
       - Invalid
+      Strict-Transport-Security:
+      - max-age=15552015; includeSubDomains; preload
+      Public-Key-Pins:
+      - pin-sha256="cN0QSpPIkuwpT6iP2YjEo1bEwGpH/yiUn6yhdy+HNto="; pin-sha256="WGJkyYjx1QMdMe0UqlyOKXtydPDVrk7sl2fV+nNm1r4=";
+        pin-sha256="LrKdTxZLRTvyHM4/atX2nquX9BeHRZMCxg3cf4rhc2I="; max-age=864000
+      X-Frame-Options:
+      - deny
+      X-Xss-Protection:
+      - 1; mode=block
     body:
       encoding: UTF-8
       string: "<?xml version='1.0' encoding=\"utf-8\"?>\n<env:Envelope xmlns:env=\"http://www.w3.org/2003/05/soap-envelope\">\n
         \   <env:Body>\n        <m:cssvalidationresponse\n            env:encodingStyle=\"http://www.w3.org/2003/05/soap-encoding\"\n
         \           xmlns:m=\"http://www.w3.org/2005/07/css-validator\">\n            <m:uri>TextArea</m:uri>\n
         \           <m:checkedby>http://jigsaw.w3.org/css-validator/</m:checkedby>\n
-        \           <m:csslevel>css3</m:csslevel>\n            <m:date>2016-10-27T08:13:57Z</m:date>\n
+        \           <m:csslevel>css3</m:csslevel>\n            <m:date>2018-08-10T07:59:10Z</m:date>\n
         \           <m:validity>false</m:validity>\n            <m:result>\n                <m:errors
         xml:lang=\"en\">\n                    <m:errorcount>1</m:errorcount>\n                                                                    \n
         \               <m:errorlist>\n                    <m:uri>file://localhost/TextArea</m:uri>\n
@@ -61,12 +78,12 @@ http_interactions:
         \                               blue\n                            </m:skippedstring>\n
         \                           <m:type>value</m:type>\n        \n                            <m:message>\n
         \       \n                                Value Error :  margin (nullbox.html#propdef-margin)\n
-        \       \n                                blue is not a margin value : \n
-        \                           </m:message>\n                        </m:error>\n
+        \       \n                                &#8220;blue&#8221; is not a &#8220;margin&#8221;
+        value : \n                            </m:message>\n                        </m:error>\n
         \           \n                    </m:errorlist>\n        \n                </m:errors>\n
         \               <m:warnings xml:lang=\"en\">\n                    <m:warningcount>0</m:warningcount>\n
         \               </m:warnings>\n            </m:result>\n        </m:cssvalidationresponse>\n
         \   </env:Body>\n</env:Envelope>\n\n"
     http_version: 
-  recorded_at: Thu, 27 Oct 2016 20:13:57 GMT
+  recorded_at: Fri, 10 Aug 2018 19:59:10 GMT
 recorded_with: VCR 3.0.3

data/test/http_recording/css_overriding_css_profile.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: http://jigsaw.w3.org/css-validator/validator?output=soap12&profile=css21&text=%20%20%20%20a%20%7B%20color:%20white%3B%20%7D%0A%20%20%20%20body%20%7B%20margin:%20blue%3B%20%7D%0A%20%20%20%20%0A
+    uri: https://jigsaw.w3.org/css-validator/validator?output=soap12&profile=css21&text=%20%20%20%20a%20%7B%20color:%20white%3B%20%7D%0A%20%20%20%20body%20%7B%20margin:%20blue%3B%20%7D%0A%20%20%20%20%0A
     body:
       encoding: US-ASCII
       string: ''
@@ -10,7 +10,7 @@ http_interactions:
       Accept-Encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
       Accept:
-      - ! '*/*'
+      - "*/*"
       User-Agent:
       - Ruby
   response:
@@ -21,7 +21,7 @@ http_interactions:
       Cache-Control:
       - no-cache
       Date:
-      - Mon, 24 Oct 2016 21:28:26 GMT
+      - Fri, 10 Aug 2018 19:59:11 GMT
       Pragma:
       - no-cache
       Transfer-Encoding:
@@ -34,17 +34,34 @@ http_interactions:
       - Jigsaw/2.3.0-beta3
       Vary:
       - Accept-Language
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Headers:
+      - content-type,accept-charset
+      Access-Control-Allow-Methods:
+      - GET, HEAD, POST, OPTIONS
+      Access-Control-Max-Age:
+      - '600'
       X-W3c-Validator-Errors:
       - '1'
       X-W3c-Validator-Status:
       - Invalid
+      Strict-Transport-Security:
+      - max-age=15552015; includeSubDomains; preload
+      Public-Key-Pins:
+      - pin-sha256="cN0QSpPIkuwpT6iP2YjEo1bEwGpH/yiUn6yhdy+HNto="; pin-sha256="WGJkyYjx1QMdMe0UqlyOKXtydPDVrk7sl2fV+nNm1r4=";
+        pin-sha256="LrKdTxZLRTvyHM4/atX2nquX9BeHRZMCxg3cf4rhc2I="; max-age=864000
+      X-Frame-Options:
+      - deny
+      X-Xss-Protection:
+      - 1; mode=block
     body:
-      encoding: US-ASCII
-      string: ! "<?xml version='1.0' encoding=\"utf-8\"?>\n<env:Envelope xmlns:env=\"http://www.w3.org/2003/05/soap-envelope\">\n
+      encoding: UTF-8
+      string: "<?xml version='1.0' encoding=\"utf-8\"?>\n<env:Envelope xmlns:env=\"http://www.w3.org/2003/05/soap-envelope\">\n
         \   <env:Body>\n        <m:cssvalidationresponse\n            env:encodingStyle=\"http://www.w3.org/2003/05/soap-encoding\"\n
         \           xmlns:m=\"http://www.w3.org/2005/07/css-validator\">\n            <m:uri>file://localhost/TextArea</m:uri>\n
         \           <m:checkedby>http://jigsaw.w3.org/css-validator/</m:checkedby>\n
-        \           <m:csslevel>css21</m:csslevel>\n            <m:date>2016-10-24T09:28:26Z</m:date>\n
+        \           <m:csslevel>css21</m:csslevel>\n            <m:date>2018-08-10T07:59:11Z</m:date>\n
         \           <m:validity>false</m:validity>\n            <m:result>\n                <m:errors
         xml:lang=\"en\">\n                    <m:errorcount>1</m:errorcount>\n                                                                    \n
         \               <m:errorlist>\n                    <m:uri>file://localhost/TextArea</m:uri>\n
@@ -54,13 +71,13 @@ http_interactions:
         \                           </m:errorsubtype>\n                            <m:skippedstring>\n
         \                               blue\n                            </m:skippedstring>\n
         \                           <m:type>value</m:type>\n        \n                            <m:message>\n
-        \       \n                                Value Error :  margin (http://www.w3.org/TR/2011/REC-CSS2-20110607/box.html#propdef-margin)\n
-        \       \n                                blue is not a margin value : \n
-        \                           </m:message>\n                        </m:error>\n
+        \       \n                                Value Error :  margin ([error]box.html#propdef-margin)\n
+        \       \n                                &#8220;blue&#8221; is not a &#8220;margin&#8221;
+        value : \n                            </m:message>\n                        </m:error>\n
         \           \n                    </m:errorlist>\n        \n                </m:errors>\n
         \               <m:warnings xml:lang=\"en\">\n                    <m:warningcount>0</m:warningcount>\n
         \               </m:warnings>\n            </m:result>\n        </m:cssvalidationresponse>\n
         \   </env:Body>\n</env:Envelope>\n\n"
     http_version: 
-  recorded_at: Mon, 24 Oct 2016 21:28:26 GMT
+  recorded_at: Fri, 10 Aug 2018 19:59:11 GMT
 recorded_with: VCR 3.0.3

data/test/http_recording/css_skippedstring.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: post
-    uri: http://jigsaw.w3.org/css-validator/validator
+    uri: https://jigsaw.w3.org/css-validator/validator
     body:
       encoding: UTF-8
       string: "--349832898984244898448024464570528145\r\nContent-Disposition: form-data;
@@ -27,7 +27,7 @@ http_interactions:
       Cache-Control:
       - no-cache
       Date:
-      - Thu, 27 Oct 2016 20:14:00 GMT
+      - Fri, 10 Aug 2018 19:59:12 GMT
       Pragma:
       - no-cache
       Transfer-Encoding:
@@ -37,20 +37,37 @@ http_interactions:
       Content-Type:
       - application/soap+xml;charset=utf-8
       Server:
-      - Jigsaw/2.3.0-beta2
+      - Jigsaw/2.3.0-beta4
       Vary:
       - Accept-Language
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Headers:
+      - content-type,accept-charset
+      Access-Control-Allow-Methods:
+      - GET, HEAD, POST, OPTIONS
+      Access-Control-Max-Age:
+      - '600'
       X-W3c-Validator-Errors:
       - '1'
       X-W3c-Validator-Status:
       - Invalid
+      Strict-Transport-Security:
+      - max-age=15552015; includeSubDomains; preload
+      Public-Key-Pins:
+      - pin-sha256="cN0QSpPIkuwpT6iP2YjEo1bEwGpH/yiUn6yhdy+HNto="; pin-sha256="WGJkyYjx1QMdMe0UqlyOKXtydPDVrk7sl2fV+nNm1r4=";
+        pin-sha256="LrKdTxZLRTvyHM4/atX2nquX9BeHRZMCxg3cf4rhc2I="; max-age=864000
+      X-Frame-Options:
+      - deny
+      X-Xss-Protection:
+      - 1; mode=block
     body:
       encoding: UTF-8
       string: "<?xml version='1.0' encoding=\"utf-8\"?>\n<env:Envelope xmlns:env=\"http://www.w3.org/2003/05/soap-envelope\">\n
         \   <env:Body>\n        <m:cssvalidationresponse\n            env:encodingStyle=\"http://www.w3.org/2003/05/soap-encoding\"\n
         \           xmlns:m=\"http://www.w3.org/2005/07/css-validator\">\n            <m:uri>TextArea</m:uri>\n
         \           <m:checkedby>http://jigsaw.w3.org/css-validator/</m:checkedby>\n
-        \           <m:csslevel>css3</m:csslevel>\n            <m:date>2016-10-27T08:14:00Z</m:date>\n
+        \           <m:csslevel>css3</m:csslevel>\n            <m:date>2018-08-10T07:59:12Z</m:date>\n
         \           <m:validity>false</m:validity>\n            <m:result>\n                <m:errors
         xml:lang=\"en\">\n                    <m:errorcount>1</m:errorcount>\n                                                                    \n
         \               <m:errorlist>\n                    <m:uri>file://localhost/TextArea</m:uri>\n
@@ -61,12 +78,12 @@ http_interactions:
         \                               blue\n                            </m:skippedstring>\n
         \                           <m:type>value</m:type>\n        \n                            <m:message>\n
         \       \n                                Value Error :  margin (nullbox.html#propdef-margin)\n
-        \       \n                                blue is not a margin value : \n
-        \                           </m:message>\n                        </m:error>\n
+        \       \n                                &#8220;blue&#8221; is not a &#8220;margin&#8221;
+        value : \n                            </m:message>\n                        </m:error>\n
         \           \n                    </m:errorlist>\n        \n                </m:errors>\n
         \               <m:warnings xml:lang=\"en\">\n                    <m:warningcount>0</m:warningcount>\n
         \               </m:warnings>\n            </m:result>\n        </m:cssvalidationresponse>\n
         \   </env:Body>\n</env:Envelope>\n\n"
     http_version: 
-  recorded_at: Thu, 27 Oct 2016 20:14:00 GMT
+  recorded_at: Fri, 10 Aug 2018 19:59:12 GMT
 recorded_with: VCR 3.0.3