headhunter 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8102daaade0c10e0c06ae81c5bc10d209109d2e3
-  data.tar.gz: b05a93b7d16ac6e504be2e4ef2e0f3f562466361
+  metadata.gz: acb7d65c5957cda5253ba5d8a1e15844e29d93ac
+  data.tar.gz: d64796a9aa68bd8e2ceb68b94ab4f477d625abac
 SHA512:
-  metadata.gz: 4c0a62b10ad5a9b9415ca6c8e574e6c6a157379a1711f4a5838a01c915662e9c936747d0d668815ecd1349afe4f70e5fe3b0f03f56d9553f94305533acaebd13
-  data.tar.gz: 0c82cca1d97bda609576f19b658e681352d8506a0c53e9f847ea4cd94dae53cc19738db1a18fa3ea29bbd445ef2253f8f19a5a54d4d390d8f4a16567764e809c
+  metadata.gz: 38fdf1b08a700c7576b924315ab38717fd5b4b3777ca129b5ab6c0afbd88237cf013e04477dc1cabf82abd365e5910c942b1f1d00215dd3b037b27f31833b9b1
+  data.tar.gz: 04fd8d0f39ab2afda16600fc407310532a61545b703ea5adb80f774276d06df738f6c3ebb0075d9ea00fc699e2cd9d6ce86ef0872fcd5d6ad62886a945d78ddd

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    headhunter (0.0.2)
+    headhunter (0.0.8)
       colorize
       css_parser (~> 1.2.6)
       html_validation

data/README.md

@@ -8,6 +8,8 @@ Headhunter is an HTML and CSS validation tool that injects itself into your Rail
 
 In addition, it also looks out for unused (and therefore superfluous) CSS selectors.
 
+This is all done **locally**, so no external service is used.
+
 ## How to use
 
 Add Headhunter to your `Gemfile`:
@@ -20,9 +22,9 @@ end
 
 Just set the environment variable `HEADHUNTER` to `true` when running your tests, e.g.:
 
-- `rake HEADHUNTER=true`
-- `rspec HEADHUNTER=true`
-- `cucumber HEADHUNTER=true`
+```
+$ rake HEADHUNTER=true
+```
 
 Headhunter doesn't keep your tests from passing if invalid HTML or unused CSS is found. Instead it displays a short statistic after the tests are run.
 
@@ -43,7 +45,7 @@ Headhunter doesn't keep your tests from passing if invalid HTML or unused CSS is
     Validated 1 stylesheets.
     1 stylesheet is invalid.
       application.css:
-      - Invalid css: line 1: Property bla doesn't exist
+      - Line 1: Property bla doesn't exist
 
     Found 23 CSS selectors.
     20 selectors are in use.
@@ -61,22 +63,22 @@ For being able to validate CSS, `rake assets:precompile` is triggered at the beg
 
 **[Tidy HTML](http://tidy.sourceforge.net/)** should be installed on a typical OSX and Linux installation already. You're not developing on a Windows machine, are you?! If you want to validate HTML5 (and you should want to!), install the HTML5 version like described here: [homebrew tidy html5](http://techblog.willshouse.com/2013/10/21/homebrew-tidy-html5/).
 
-You need a **working internet connection** to run CSS validation. As a Rails application typically contains one single CSS file (`application.css`), this won't have much impact on the speed of your tests.
+You need a **Java Runtime Environment** to run CSS validation. This should normally already be available on OSX and Linux machines, too. A local copy (`[css-validator.jar](http://jigsaw.w3.org/css-validator/DOWNLOAD.html)`) of the [W3 CSS Validation Service](http://jigsaw.w3.org/css-validator/) is used.
 
 ## Known issues and future plans
 
 - It would be nice to use Rails' own assets compilation that's executed when the first JavaScript test is run. Anyone has an idea on how to do this?
-- At the moment, in addition to precompiling and removing your assets, `rake assets:clobber` is run also **before** precompiling! The issue is explained here: [Rake assets are generated twice when precompiling them once from command line and once from within a Ruby script](http://stackoverflow.com/questions/20938891/rake-assets-are-generated-twice-when-precompiling-them-once-from-command-line-an)
-- Instead of running `rake assets:clobber`, it may be also sufficient to simply remove all *.css files from `public/assets/stylesheets` manually. This would save some compilation time.
-- Instead of using the online CSS validation service of ???, it would be nice to have a local CSS validator. Is there anything like this? TotalValidator seems to be able to do something like this, but it's not free for CSS validation and I don't know how to use it.
-- HTML and CSS sources should not be compressed, to allow more concise error messages
+- HTML and CSS sources should not be uglified, to allow more concise error messages
 - Would be really useful to have the concrete URL of every validated HTML page. But can't find a way to extract it from Rack response.
 - There are not tests yet. I first want to see whether this gem would be appreciated by the community, and if so, I will definitely add tests.
 - Didn't try this with AJAX requests yet. Would be great if such responses would be validated, too!
+- In feature tests, the same views are getting rendered again and again. These same sources shouldn't be validated over and over again!
+- More configuration options needed! CSS1, CSS2, CSS2.1, CSS3! XHTML, HTML5, etc.
+- Better output needed! With context lines, etc.
 
 ## Disclaimer
 
-Headhunter is heavily inspired by Aanand Prasad's (outdated) [Deadweight](https://github.com/aanand/deadweight) gem and by Unboxed Consulting's [be_valid_asset](https://github.com/unboxed/be_valid_asset) gem. Thank you for your pioneering work!
+Headhunter is heavily inspired by Aanand Prasad's [Deadweight gem](https://github.com/aanand/deadweight), Eric Beland's [HTML Validation gem](https://github.com/ericbeland/html_validation) and Unboxed Consulting's [be\_valid\_asset gem](https://github.com/unboxed/be_valid_asset). Thank you for your pioneering work!
 
 **USE THIS GEM AT YOUR OWN RISK!**
 

data/lib/headhunter/css_validator.rb

@@ -2,7 +2,28 @@ require 'net/http'
 require 'rexml/document'
 
 module Headhunter
+  class LocalResponse
+    attr_reader :body
+
+    def initialize(body)
+      @body = body
+      @headers = {'x-w3c-validator-status' => valid?(body)}
+    end
+
+    def [](key)
+      @headers[key]
+    end
+
+    private
+
+    def valid?(body)
+      REXML::Document.new(body).root.each_element('//m:validity') { |e| return e.text == 'true' }
+    end
+  end
+
   class CssValidator
+    USE_LOCAL_VALIDATOR = true
+
     def initialize(stylesheets)
       @profile = 'css3' # TODO: Option for profile css1 and css21
       @stylesheets = stylesheets
@@ -31,6 +52,8 @@ module Headhunter
 
         messages.each { |message| log.puts "  - #{message}".red }
       end
+
+      log.puts
     end
 
     private
@@ -53,10 +76,18 @@ module Headhunter
       @messages_per_stylesheet[file] = []
 
       REXML::Document.new(response.body).root.each_element('//m:error') do |e|
-        @messages_per_stylesheet[file] << "#{error_line_prefix}: line #{e.elements['m:line'].text}: #{e.elements['m:message'].get_text.value.strip}\n"
+        @messages_per_stylesheet[file] << "Line #{extract_line_from_error(e)}: #{extract_message_from_error(e)}"
       end
     end
 
+    def extract_line_from_error(e)
+      e.elements['m:line'].text
+    end
+
+    def extract_message_from_error(e)
+      e.elements['m:message'].get_text.value.strip[0..-2]
+    end
+
     def fetch(path) # TODO: Move to Headhunter!
       loc = path
 
@@ -71,24 +102,50 @@ module Headhunter
 
     def get_validation_response(query_params)
       query_params.merge!({:output => 'soap12'})
-      get_validator_response(query_params)
+
+      if USE_LOCAL_VALIDATOR
+        call_local_validator(query_params)
+      else
+        call_remote_validator(query_params)
+      end
     end
 
     def response_indicates_valid?(response)
       response['x-w3c-validator-status'] == 'Valid'
     end
 
-    def get_validator_response(query_params = {})
-      response = call_validator(query_params)
+    def call_remote_validator(query_params = {})
+      boundary = Digest::MD5.hexdigest(Time.now.to_s)
+      data = encode_multipart_params(boundary, query_params)
+      response = http_start(validator_host).post2(validator_path,
+                                                  data,
+                                                  'Content-type' => "multipart/form-data; boundary=#{boundary}")
 
       raise "HTTP error: #{response.code}" unless response.is_a? Net::HTTPSuccess
-      return response
+      response
     end
 
-    def call_validator(query_params)
-      boundary = Digest::MD5.hexdigest(Time.now.to_s)
-      data = encode_multipart_params(boundary, query_params)
-      return http_start(validator_host).post2(validator_path, data, "Content-type" => "multipart/form-data; boundary=#{boundary}" )
+    def call_local_validator(query_params)
+      path         = Gem.loaded_specs['headhunter'].full_gem_path + '/lib/css-validator/'
+      css_file     = 'tmp.css'
+      results_file = 'results'
+      results      = nil
+
+      Dir.chdir(path) do
+        File.open(css_file, 'a') { |f| f.write query_params[:text] }
+
+        # See http://stackoverflow.com/questions/1137884/is-there-an-open-source-css-validator-that-can-be-run-locally
+        if system "java -jar css-validator.jar --output=soap12 file:#{css_file} > #{results_file}"
+          results = IO.read results_file
+        else
+          raise 'Could not execute local validation!'
+        end
+
+        File.delete css_file
+        File.delete results_file
+      end
+
+      LocalResponse.new(results)
     end
 
     def encode_multipart_params(boundary, params = {})

data/lib/headhunter/version.rb

@@ -1,3 +1,3 @@
 module Headhunter
-  VERSION = '0.0.8'
+  VERSION = '0.0.9'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: headhunter
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Joshua Muheim
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-19 00:00:00.000000000 Z
+date: 2014-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -145,6 +145,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/css-validator/css-validator.jar
+- lib/css-validator/lib/commons-collections-3.2.1.jar
+- lib/css-validator/lib/commons-lang-2.6.jar
+- lib/css-validator/lib/jigsaw.jar
+- lib/css-validator/lib/velocity-1.7.jar
 - lib/headhunter/css_hunter.rb
 - lib/headhunter/css_validator.rb
 - lib/headhunter/html_validator.rb