headhunter 0.0.2 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79ba313e9b12c21aa35c4fc74bfe40f86801c9fd
-  data.tar.gz: afc84375e5fb68c8fe8af5d4e5af6f30826c0d51
+  metadata.gz: 8e083d2cf2ed28ecd66e9fd0b7317c39565f996c
+  data.tar.gz: 874442a4314a680b9582be26ff1ac475590b3079
 SHA512:
-  metadata.gz: d6c891576972b9fba784d4985f874308a639c8f27973b4813c9542eb08eaca6ef8e5a5a68ac7218e9fb72d5760d36da761ecc67bb5a4f8b24322f86a22314ea2
-  data.tar.gz: 1c8dc6fed4c64758bb0dc3b07756fcd19b8b76ceb53a912cf7c64e09e4abe03b88397eaedc0c732e8795d81c93906c935166deb6d9d7b7f048488db0566ef800
+  metadata.gz: 3ba8f645a5d4843b2e9e5df932dfe68cc91e2383e0cceb71c85b2c857c0b622e0f476957cadf321614c5302532f764f71056b7e0f6d45b7c2934af15a30c9282
+  data.tar.gz: 7a4e13c8f0df5a84980e24d6ccfe1bd1333152cbbf66b8e754349be72d12a3732d22f6f4b44a31d276e645babef849e00e4eac37c8bde4bb5fd1fb9dd0f8cca2

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    headhunter (0.0.2)
+      colorize
+      css_parser (~> 1.2.6)
+      html_validation
+      nokogiri
+      rspec
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.5)
+    colorize (0.6.0)
+    css_parser (1.2.6)
+      addressable
+      rdoc
+    diff-lcs (1.2.5)
+    fuubar (1.3.2)
+      rspec (>= 2.14.0, < 3.1.0)
+      ruby-progressbar (~> 1.3)
+    gem-release (0.7.1)
+    html_validation (1.0.0)
+    json (1.8.1)
+    mini_portile (0.5.2)
+    nokogiri (1.6.1)
+      mini_portile (~> 0.5.0)
+    rake (10.1.1)
+    rdoc (4.1.1)
+      json (~> 1.4)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    ruby-progressbar (1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fuubar
+  gem-release
+  headhunter!
+  rake
+  rspec (>= 2.0)

data/README.md

@@ -0,0 +1,84 @@
+# Headhunter
+
+[![Gem Version](https://badge.fury.io/rb/headhunter.png)](http://badge.fury.io/rb/headhunter)
+[![Code Climate](https://codeclimate.com/github/jmuheim/headhunter.png)](https://codeclimate.com/github/jmuheim/headhunter)
+[![Travis CI](https://api.travis-ci.org/jmuheim/headhunter.png)](https://travis-ci.org/jmuheim/headhunter)
+
+Headhunter is an HTML and CSS validation tool that injects itself into your Rails feature tests and automagically checks all your generated HTML and CSS for validity.
+
+In addition, it also looks out for unused (and therefore superfluous) CSS selectors.
+
+## How to use
+
+Add Headhunter to your `Gemfile`:
+
+```ruby
+group :test do
+  gem 'headhunter'
+end
+```
+
+Just set the environment variable `HEADHUNTER` to `true` when running your tests, e.g.:
+
+- `rake HEADHUNTER=true`
+- `rspec HEADHUNTER=true`
+- `cucumber 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.
+
+    30/30 |============================= 100 ==============================>| Time: 00:00:02
+
+    Finished in 2.65 seconds
+    30 examples, 0 failures
+
+    Validated 42 HTML pages.
+    41 pages are valid.
+    1 page is invalid.
+    Open .validation/results.html to view full results.
+
+    Validated 1 stylesheets.
+    1 stylesheet is invalid.
+      application.css:
+      - Invalid css: line 1: Property bla doesn't exist
+
+    Found 23 CSS selectors.
+    20 selectors are in use.
+    3 selectors are not in use: a img, #flash.failure, input[type='file']
+
+## How it works
+
+Headhunter registers itself as middleware in the Rack stack and triggers validation for every HTML response.
+
+For every `.css` file, validation is also triggered. In addition, it iterates over every HTML page's selectors to see whether there exist any unused CSS definitions in your `.css` files.
+
+For being able to validate CSS, `rake assets:precompile` is triggered at the beginning of running tests. This may slow down starting your tests a bit. (Notice: after the tests have finished, the precompiled assets are also removed automatically by running `rake assets:clobber`.)
+
+## Requirements
+
+### Tidy HTML
+
+[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/).
+
+### Working internet connection
+
+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.
+
+## 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
+- 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.
+
+## 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!
+
+**USE THIS GEM AT YOUR OWN RISK!**
+
+All provided functionality is provided "as is". You are highly welcome to file issues, feature requests and pull requests.

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+# Run RSpec code examples as the default rake task
+task default: :spec

data/lib/headhunter.rb

@@ -2,54 +2,4 @@ require 'headhunter/css_hunter'
 require 'headhunter/css_validator'
 require 'headhunter/html_validator'
 require 'headhunter/rails'
-# require 'rack/utils'
-
-class Headhunter
-  attr_accessor :results
-
-  def initialize(root)
-    @root = root
-
-    precompile_assets!
-
-    @html_validator = HtmlValidator.new
-    @css_validator  = CssValidator.new(stylesheets)
-    @css_hunter     = CssHunter.new(stylesheets)
-
-    @css_validator.process!
-  end
-
-  def process!(url, html)
-    @html_validator.process!(url, html)
-    @css_hunter.process!(url, html)
-  end
-
-  def clean_up!
-    remove_assets!
-  end
-
-  def report
-    @html_validator.prepare_results_html
-
-    @html_validator.report
-    @css_validator.report
-    @css_hunter.report
-  end
-
-  private
-
-  def precompile_assets!
-    # Remove existing assets! This seems to be necessary to make sure that they don't exist twice, see http://stackoverflow.com/questions/20938891
-    system 'rake assets:clobber HEADHUNTER=false &> /dev/null'
-
-    system 'rake assets:precompile HEADHUNTER=false &> /dev/null'
-  end
-
-  def remove_assets!
-    system 'rake assets:clobber HEADHUNTER=false &> /dev/null'
-  end
-
-  def stylesheets
-    Dir.chdir(@root) { Dir.glob('public/assets/*.css') }
-  end
-end
+require 'headhunter/runner'

data/lib/headhunter/css_hunter.rb

@@ -2,7 +2,7 @@ require 'css_parser'
 require 'nokogiri'
 require 'open-uri'
 
-class Headhunter
+module Headhunter
   class CssHunter
     def initialize(stylesheets)
       @stylesheets      = stylesheets
@@ -52,8 +52,6 @@ class Headhunter
     end
 
     def fetch(path)
-      log.puts(path)
-
       loc = path
 
       begin

data/lib/headhunter/css_validator.rb

@@ -1,7 +1,7 @@
 require 'net/http'
 require 'rexml/document'
 
-class Headhunter
+module Headhunter
   class CssValidator
     def initialize(stylesheets)
       @profile = 'css3' # TODO: Option for profile css1 and css21
@@ -58,8 +58,6 @@ class Headhunter
     end
 
     def fetch(path) # TODO: Move to Headhunter!
-      log.puts(path)
-
       loc = path
 
       begin

data/lib/headhunter/html_validator.rb

@@ -1,6 +1,6 @@
 require 'html_validation'
 
-class Headhunter
+module Headhunter
   class HtmlValidator
     def initialize
       @valid_results   = []

data/lib/headhunter/rails.rb

@@ -2,11 +2,11 @@ require 'headhunter'
 require 'headhunter/rack/capturing_middleware'
 
 if ENV['HEADHUNTER'] == 'true'
-  class Headhunter
+  module Headhunter
     module Rails
       class Railtie < ::Rails::Railtie
         initializer "headhunter.hijack" do |app|
-          head_hunter = Headhunter.new(::Rails.root)
+          head_hunter = Runner.new(::Rails.root)
 
           at_exit do
             head_hunter.report

data/lib/headhunter/runner.rb

@@ -0,0 +1,51 @@
+module Headhunter
+  class Runner
+    attr_accessor :results
+
+    def initialize(root)
+      @root = root
+
+      precompile_assets!
+
+      @html_validator = HtmlValidator.new
+      @css_validator  = CssValidator.new(stylesheets)
+      @css_hunter     = CssHunter.new(stylesheets)
+
+      @css_validator.process!
+    end
+
+    def process!(url, html)
+      @html_validator.process!(url, html)
+      @css_hunter.process!(url, html)
+    end
+
+    def clean_up!
+      remove_assets!
+    end
+
+    def report
+      @html_validator.prepare_results_html
+
+      @html_validator.report
+      @css_validator.report
+      @css_hunter.report
+    end
+
+    private
+
+    def precompile_assets!
+      # Remove existing assets! This seems to be necessary to make sure that they don't exist twice, see http://stackoverflow.com/questions/20938891
+      system 'rake assets:clobber HEADHUNTER=false &> /dev/null'
+
+      system 'rake assets:precompile HEADHUNTER=false &> /dev/null'
+    end
+
+    def remove_assets!
+      system 'rake assets:clobber HEADHUNTER=false &> /dev/null'
+    end
+
+    def stylesheets
+      Dir.chdir(@root) { Dir.glob('public/assets/*.css') }
+    end
+  end
+end

data/lib/headhunter/version.rb

@@ -0,0 +1,3 @@
+module Headhunter
+  VERSION = '0.0.5'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: headhunter
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.5
 platform: ruby
 authors:
 - Joshua Muheim
@@ -94,6 +94,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: gem-release
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -136,9 +150,15 @@ files:
 - lib/headhunter/html_validator.rb
 - lib/headhunter/rack/capturing_middleware.rb
 - lib/headhunter/rails.rb
+- lib/headhunter/runner.rb
 - lib/headhunter/templates/result.html
 - lib/headhunter/templates/results.html
+- lib/headhunter/version.rb
 - lib/headhunter.rb
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- README.md
 homepage: http://github.com/jmuheim/headhunter
 licenses:
 - MIT