deadweight 0.1.1 → 0.1.2

data/README.rdoc

@@ -6,7 +6,11 @@ Deadweight is a CSS coverage tool. Given a set of stylesheets and a set of URLs,
 
 Ryan Bates has worked his magic once again. Head over here for an excellent introduction to deadweight: http://railscasts.com/episodes/180-finding-unused-css
 
-=== A Simple Example
+=== Install It
+
+  gem install deadweight -s http://gemcutter.org
+
+=== Make a Rake Task
 
   # lib/tasks/deadweight.rake
 
@@ -19,7 +23,7 @@ Ryan Bates has worked his magic once again. Head over here for an excellent intr
 
 Running <tt>rake deadweight</tt> will output all unused rules, one per line. Note that it looks at http://localhost:3000 by default, so you'll need to have <tt>script/server</tt> (or whatever your server command looks like) running.
 
-Alternately, you can run it from the command-line:
+=== Or Run it From the Command Line
 
   $ deadweight -s styles.css -s ie.css index.html about.html
 
@@ -31,15 +35,23 @@ And you can use it as an HTTP proxy:
 
   $ deadweight -l deadweight.log -s styles.css -w http://github.com/ -P
 
-=== How You Install It
+There's also experimental support for Lyndon (http://github.com/defunkt/lyndon) with <tt>-L</tt>.
 
-  gem install deadweight -s http://gemcutter.org
+=== Or Call it Directly
+
+  require 'deadweight'
+
+  dw = Deadweight.new
+  dw.stylesheets = %w( /stylesheets/style.css )
+  dw.pages = %w( / /page/1 /about )
+  puts dw.run
 
 === Things to Note
 
+- You can tell it what URL root to use (rather than <tt>http://localhost:3000</tt>) by setting +root+.
 - It's completely dumb about any classes, IDs or tags that are only added by your Javascript layer, but you can filter them out by setting +ignore_selectors+.
 - You can optionally tell it to use Mechanize, and set up more complicated targets for scraping by specifying them as Procs.
-- There is experimental support for Lyndon (http://github.com/defunkt/lyndon) with -L
+- If you have the <tt>colored</tt> gem installed, it'll spruce up the STDERR output.
 
 === A More Complex Example, In Light of All That
 

data/Rakefile

@@ -10,7 +10,6 @@ begin
     gem.homepage = "http://github.com/aanand/deadweight"
     gem.authors = ["Aanand Prasad"]
 
-    gem.add_dependency('css_parser')
     gem.add_dependency('hpricot')
   end
 

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/deadweight.gemspec

@@ -1,15 +1,15 @@
 # Generated by jeweler
-# DO NOT EDIT THIS FILE
-# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{deadweight}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Aanand Prasad"]
-  s.date = %q{2009-10-18}
+  s.date = %q{2009-12-15}
   s.default_executable = %q{deadweight}
   s.email = %q{aanand.prasad@gmail.com}
   s.executables = ["deadweight"]
@@ -35,12 +35,34 @@ Gem::Specification.new do |s|
      "test/fixtures/index2.html",
      "test/fixtures/style.css",
      "test/rake_task_test.rb",
-     "test/test_helper.rb"
+     "test/test_helper.rb",
+     "vendor/gems/css_parser-0.9.1/CHANGELOG",
+     "vendor/gems/css_parser-0.9.1/LICENSE",
+     "vendor/gems/css_parser-0.9.1/README",
+     "vendor/gems/css_parser-0.9.1/lib/css_parser.rb",
+     "vendor/gems/css_parser-0.9.1/lib/css_parser/parser.rb",
+     "vendor/gems/css_parser-0.9.1/lib/css_parser/regexps.rb",
+     "vendor/gems/css_parser-0.9.1/lib/css_parser/rule_set.rb",
+     "vendor/gems/css_parser-0.9.1/test/fixtures/import-circular-reference.css",
+     "vendor/gems/css_parser-0.9.1/test/fixtures/import-with-media-types.css",
+     "vendor/gems/css_parser-0.9.1/test/fixtures/import1.css",
+     "vendor/gems/css_parser-0.9.1/test/fixtures/simple.css",
+     "vendor/gems/css_parser-0.9.1/test/fixtures/subdir/import2.css",
+     "vendor/gems/css_parser-0.9.1/test/test_css_parser_basic.rb",
+     "vendor/gems/css_parser-0.9.1/test/test_css_parser_downloading.rb",
+     "vendor/gems/css_parser-0.9.1/test/test_css_parser_media_types.rb",
+     "vendor/gems/css_parser-0.9.1/test/test_css_parser_misc.rb",
+     "vendor/gems/css_parser-0.9.1/test/test_css_parser_regexps.rb",
+     "vendor/gems/css_parser-0.9.1/test/test_helper.rb",
+     "vendor/gems/css_parser-0.9.1/test/test_merging.rb",
+     "vendor/gems/css_parser-0.9.1/test/test_rule_set.rb",
+     "vendor/gems/css_parser-0.9.1/test/test_rule_set_creating_shorthand.rb",
+     "vendor/gems/css_parser-0.9.1/test/test_rule_set_expanding_shorthand.rb"
   ]
   s.homepage = %q{http://github.com/aanand/deadweight}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.4}
+  s.rubygems_version = %q{1.3.5}
   s.summary = %q{A coverage tool for finding unused CSS}
   s.test_files = [
     "test/cli_test.rb",
@@ -54,14 +76,12 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<css_parser>, [">= 0"])
       s.add_runtime_dependency(%q<hpricot>, [">= 0"])
     else
-      s.add_dependency(%q<css_parser>, [">= 0"])
       s.add_dependency(%q<hpricot>, [">= 0"])
     end
   else
-    s.add_dependency(%q<css_parser>, [">= 0"])
     s.add_dependency(%q<hpricot>, [">= 0"])
   end
 end
+

data/lib/deadweight.rb

@@ -1,7 +1,18 @@
+$LOAD_PATH.concat Dir.glob(File.expand_path('../../vendor/gems/*/lib', __FILE__))
+
 require 'css_parser'
 require 'hpricot'
 require 'open-uri'
-require 'logger'
+
+begin
+  require 'colored'
+rescue LoadError
+  class String
+    %w(red green blue yellow).each do |color|
+      define_method(color) { self }
+    end
+  end
+end
 
 class Deadweight
   attr_accessor :root, :stylesheets, :rules, :pages, :ignore_selectors, :mechanize, :log_file
@@ -21,13 +32,11 @@ class Deadweight
   def analyze(html)
     doc = Hpricot(html)
 
-    found_selectors = []
-
     @unused_selectors.collect do |selector, declarations|
       # We test against the selector stripped of any pseudo classes,
       # but we report on the selector with its pseudo classes.
       unless doc.search(strip(selector)).empty?
-        log.info("  #{selector}")
+        log.puts("  #{selector.green}")
         selector
       end
     end
@@ -45,12 +54,9 @@ class Deadweight
 
     @parsed_rules     = {}
     @unused_selectors = []
-    total_selectors   = 0
 
     css.each_selector do |selector, declarations, specificity|
       unless @unused_selectors.include?(selector)
-        total_selectors += 1
-
         unless selector =~ ignore_selectors
           @unused_selectors << selector
           @parsed_rules[selector] = declarations
@@ -67,7 +73,11 @@ class Deadweight
       end
     end
 
+    total_selectors = @unused_selectors.size
+
     pages.each do |page|
+      log.puts
+
       if page.respond_to?(:read)
         html = page.read
       elsif page.respond_to?(:call)
@@ -80,13 +90,20 @@ class Deadweight
                  @agent.page.body
                end
       else
-        html = fetch(page)
+        begin
+          html = fetch(page)
+        rescue FetchError => e
+          log.puts(e.message.red)
+          next
+        end
       end
 
       process!(html)
     end
 
-    log.info "found #{@unused_selectors.size} unused selectors out of #{total_selectors} total"
+    log.puts
+    log.puts "found #{@unused_selectors.size} unused selectors out of #{total_selectors} total".yellow
+    log.puts
 
     @unused_selectors
   end
@@ -108,17 +125,30 @@ class Deadweight
 
   # Fetch a path, using Mechanize if +mechanize+ is set to +true+.
   def fetch(path)
-    log.info(path)
+    log.puts(path)
 
     loc = root + path
 
     if @mechanize
       loc = "file://#{File.expand_path(loc)}" unless loc =~ %r{^\w+://}
-      page = agent.get(loc)
-      log.warn("#{path} redirected to #{page.uri}") unless page.uri.to_s == loc
+
+      begin
+        page = agent.get(loc)
+      rescue WWW::Mechanize::ResponseCodeError => e
+        raise FetchError.new("#{loc} returned a response code of #{e.response_code}")
+      end
+
+      log.puts("#{loc} redirected to #{page.uri}".red) unless page.uri.to_s == loc
+
       page.body
     else
-      open(loc).read
+      begin
+        open(loc).read
+      rescue Errno::ENOENT
+        raise FetchError.new("#{loc} was not found")
+      rescue OpenURI::HTTPError => e
+        raise FetchError.new("retrieving #{loc} raised an HTTP error: #{e.message}")
+      end
     end
   end
 
@@ -133,7 +163,11 @@ private
   end
 
   def log
-    @log ||= Logger.new(@log_file)
+    @log ||= if @log_file.respond_to?(:puts)
+               @log_file
+             else
+               open(@log_file, 'w+')
+             end
   end
 
   def initialize_agent
@@ -141,7 +175,7 @@ private
       require 'mechanize'
       return WWW::Mechanize.new
     rescue LoadError
-      log.info %{
+      log.puts %{
         =================================================================
         Couldn't load 'mechanize', which is required for remote scraping.
         Install it like so: gem install mechanize
@@ -151,6 +185,8 @@ private
       raise
     end
   end
+
+  class FetchError < StandardError; end
 end
 
 require 'deadweight/rake_task'

data/lib/deadweight/cli.rb

@@ -9,6 +9,7 @@ class Deadweight
 
     def self.execute(stdout, stdin, stderr, arguments = [])
       @options = {
+        :root       => "",
         :log_file   => stderr,
         :output     => stdout,
         :proxy_port => 8002
@@ -51,6 +52,11 @@ class Deadweight
           @options[:stylesheets] << v
         end
 
+        opts.on("-r", "--root URL-OR-PATH",
+                "Specify a root for all urls/paths") do |r|
+          @options[:root] = r
+        end
+
         opts.on("-w", "--whitelist URL-PREFIX",
                 "Specifies a prefix for URLs to process") do |v|
           @options[:whitelist] ||= []
@@ -88,7 +94,7 @@ class Deadweight
       dw = Deadweight.new
 
       # TODO this should be the default
-      dw.root = ""
+      dw.root = options[:root]
 
       dw.log_file = options[:log_file]
 
@@ -112,7 +118,7 @@ class Deadweight
       dw = Deadweight.new
 
       # TODO note the boilerplate shared with #process
-      dw.root = ""
+      dw.root = options[:root]
       dw.log_file = options[:log_file]
       dw.stylesheets = options[:stylesheets]
       dw.rules = stdin.read if stdin.stat.size > 0

data/test/cli_test.rb

@@ -1,18 +1,21 @@
 require 'test_helper'
 
 class CliTest < Test::Unit::TestCase
-  COMMAND = "ruby -rubygems -Ilib bin/deadweight -s test/fixtures/style.css test/fixtures/index.html 2>/dev/null"
+  COMMAND      = "ruby -rubygems -Ilib bin/deadweight"
+  FULL_COMMAND = "#{COMMAND} -s test/fixtures/style.css test/fixtures/index.html 2>/dev/null"
 
   should "output unused selectors on STDOUT" do
-    @result = `#{COMMAND}`
-
-    assert_correct_selectors_in_output(@result)
+    assert_correct_selectors_in_output(`#{FULL_COMMAND}`)
   end
 
   should "accept CSS rules on STDIN" do
-    @result = `echo ".something { display: block; }" | #{COMMAND}`
+    assert `echo ".something { display: block; }" | #{FULL_COMMAND}`.include?('.something')
+  end
 
-    assert @result.include?('.something')
+  should "accept a [-r | --root] argument and relative paths" do
+    %w(-r --root).each do |arg|
+      assert_correct_selectors_in_output(`#{COMMAND} #{arg} test/fixtures -s /style.css /index.html 2>/dev/null`)
+    end
   end
 end
 

data/test/test_helper.rb

@@ -28,13 +28,13 @@ class Test::Unit::TestCase
 
   def assert_reports_unused_selectors(output)
     UNUSED_SELECTORS.each do |s|
-      assert output.include?(s)
+      assert output.include?(s), "output is missing #{s.inspect}:\n#{output}"
     end
   end
 
   def assert_does_not_report_used_selectors(output)
     USED_SELECTORS.each do |s|
-      assert !output.include?(s)
+      assert !output.include?(s), "output should not contain #{s.inspect}:\n#{output}"
     end
   end
 

data/vendor/gems/css_parser-0.9.1/CHANGELOG

@@ -0,0 +1,13 @@
+=== Ruby CSS Parser CHANGELOG
+
+==== Version 0.9.1
+ * Fixed RuleSet#declaration_to_s so it would respect <tt>!important</tt> 
+   rules (thanks to Dana - http://github.com/DanaDanger)
+
+==== Version 0.9
+ * Initial version forked from Premailer project
+
+==== TODO: Future
+ * border shorthand/folding support
+ * re-implement caching on CssParser.merge
+ * correctly parse http://www.webstandards.org/files/acid2/test.html

data/vendor/gems/css_parser-0.9.1/LICENSE

@@ -0,0 +1,21 @@
+=== Ruby CSS Parser License
+
+Copyright (c) 2007 Alex Dunae
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/vendor/gems/css_parser-0.9.1/README

@@ -0,0 +1,58 @@
+=== Ruby CSS Parser
+
+Load, parse and cascade CSS rule sets in Ruby.
+
+==== Setup
+
+Install the gem from RubyGems.
+
+   gem install css_parser
+
+Done.
+
+==== An example
+  require 'css_parser'
+  include CssParser
+
+  parser = CssParser::Parser.new
+  parser.load_file!('http://example.com/styles/style.css')
+
+  # lookup a rule by a selector
+  parser.find('#content')
+  #=> 'font-size: 13px; line-height: 1.2;'
+
+  # lookup a rule by a selector and media type
+  parser.find('#content', [:screen, :handheld])
+
+  # iterate through selectors by media type
+  parser.each_selector(:screen) do |selector, declarations, specificity|
+    ...
+  end
+
+  # add a block of CSS
+  css = <<-EOT
+    body { margin: 0 1em; }
+  EOT
+
+  parser.add_block!(css)
+
+  # output all CSS rules in a single stylesheet
+  parser.to_s
+  => #content { font-size: 13px; line-height: 1.2; }
+     body { margin: 0 1em; }
+
+==== Testing
+
+You can run the suite of unit tests using <tt>rake test</tt>.
+
+The download/import tests require that WEBrick is installed.  The tests set up
+a temporary server on port 12000 and pull down files from the <tt>test/fixtures/</tt> 
+directory.
+
+==== Credits and code
+
+By Alex Dunae (dunae.ca, e-mail 'code' at the same domain), 2007-08.
+
+Thanks to Dana (http://github.com/DanaDanger) for the 0.9.1 update.
+
+Made on Vancouver Island.