aanand-deadweight 0.0.3 → 0.1.0

data/README.rdoc

@@ -2,6 +2,10 @@
 
 Deadweight is RCov for CSS, kind of. Given a set of stylesheets and a set of URLs, it determines which selectors are actually used and reports which can be "safely" deleted.
 
+=== Screencast!
+
+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
 
   # lib/tasks/deadweight.rake
@@ -16,7 +20,19 @@ Deadweight is RCov for CSS, kind of. Given a set of stylesheets and a set of URL
     puts dw.run
   end
 
-This will output all unused selectors, one per line.
+This will output all unused rules, one per line.
+
+Alternately, you can run it from the command-line:
+
+  $ deadweight -s styles.css -s ie.css index.html about.html
+
+You can pipe in CSS rules from STDIN:
+
+  $ cat styles.css | deadweight index.html
+
+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
 
@@ -28,6 +44,7 @@ This will output all unused selectors, one per line.
 - By default, it looks at http://localhost:3000.
 - 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
 
 === A More Complex Example, In Light of All That
 

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.1.0

data/bin/deadweight

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require 'deadweight/cli'
+
+Deadweight::CLI.execute(STDOUT, STDIN, STDERR, ARGV.dup)
+

data/deadweight.gemspec

@@ -1,13 +1,18 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{deadweight}
-  s.version = "0.0.3"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Aanand Prasad"]
-  s.date = %q{2009-08-18}
+  s.date = %q{2009-09-24}
+  s.default_executable = %q{deadweight}
   s.email = %q{aanand.prasad@gmail.com}
+  s.executables = ["deadweight"]
   s.extra_rdoc_files = [
     "LICENSE",
      "README.rdoc"
@@ -19,8 +24,11 @@ Gem::Specification.new do |s|
      "README.rdoc",
      "Rakefile",
      "VERSION",
+     "bin/deadweight",
      "deadweight.gemspec",
      "lib/deadweight.rb",
+     "lib/deadweight/cli.rb",
+     "test/cli_test.rb",
      "test/deadweight_test.rb",
      "test/fixtures/index.html",
      "test/fixtures/index2.html",
@@ -33,7 +41,8 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.4}
   s.summary = %q{RCov for CSS}
   s.test_files = [
-    "test/deadweight_test.rb",
+    "test/cli_test.rb",
+     "test/deadweight_test.rb",
      "test/test_helper.rb"
   ]
 

data/lib/deadweight.rb

@@ -4,17 +4,34 @@ require 'open-uri'
 require 'logger'
 
 class Deadweight
-  attr_accessor :root, :stylesheets, :pages, :ignore_selectors, :mechanize, :log_file
+  attr_accessor :root, :stylesheets, :rules, :pages, :ignore_selectors, :mechanize, :log_file
+  attr_reader :unused_selectors
 
   def initialize
     @root = 'http://localhost:3000'
     @stylesheets = []
     @pages = []
+    @rules = ""
     @ignore_selectors = []
     @mechanize = false
     @log_file = STDERR
   end
 
+  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}")
+        selector
+      end
+    end
+  end
+
   # Find all unused CSS selectors and return them as an array.
   def run
     css = CssParser::Parser.new
@@ -23,28 +40,31 @@ class Deadweight
       css.add_block!(fetch(path))
     end
 
-    unused_selectors = []
+    css.add_block!(rules)
+
+    @unused_selectors = {}
     total_selectors = 0
 
     css.each_selector do |selector, declarations, specificity|
-      unless unused_selectors.include?(selector)
+      unless @unused_selectors[selector]
         total_selectors += 1
-        unused_selectors << selector unless selector =~ ignore_selectors
+        @unused_selectors[selector] = declarations unless selector =~ ignore_selectors
       end
     end
 
     # Remove selectors with pseudo classes that already have an equivalent
     # without the pseudo class. Keep the ones that don't, we need to test
     # them.
-    unused_selectors.reject! do |selector|
-      has_pseudo_classes(selector) && unused_selectors.include?(strip(selector))
+    @unused_selectors.keys.each do |selector|
+      if has_pseudo_classes(selector) && @unused_selectors.include?(strip(selector))
+        @unused_selectors.delete(selector)
+      end
     end
 
     pages.each do |page|
-      case page
-      when String
-        html = fetch(page)
-      else
+      if page.respond_to?(:read)
+        html = page.read
+      elsif page.respond_to?(:call)
         result = instance_eval(&page)
 
         html = case result
@@ -53,27 +73,22 @@ class Deadweight
                else
                  @agent.page.body
                end
+      else
+        html = fetch(page)
       end
 
-      doc = Hpricot(html)
+      process!(html)
+    end
 
-      found_selectors = []
+    log.info "found #{@unused_selectors.size} unused selectors out of #{total_selectors} total"
 
-      unused_selectors.each do |selector|
-        # 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}")
-          found_selectors << selector
-        end
-      end
+    @unused_selectors
+  end
 
-      unused_selectors -= found_selectors
+  def process!(html)
+    analyze(html).each do |selector|
+      @unused_selectors.delete(selector)
     end
-
-    log.info "found #{unused_selectors.size} unused selectors out of #{total_selectors} total"
-
-    unused_selectors
   end
 
   # Returns the Mechanize instance, if +mechanize+ is set to +true+.

data/lib/deadweight/cli.rb

@@ -0,0 +1,187 @@
+require 'optparse'
+require 'deadweight'
+
+class Deadweight
+  class CLI
+    attr_reader :stdout, :stdin, :stderr
+    attr_reader :arguments, :options
+    attr_reader :output
+
+    def self.execute(stdout, stdin, stderr, arguments = [])
+      @options = {
+        :log_file   => stderr,
+        :output     => stdout,
+        :proxy_port => 8002
+      }
+
+      self.parse_options(arguments)
+      self.new(stdout, stdin, stderr, arguments, @options).execute!
+    end
+
+    def self.option_parser
+      @option_parser ||= OptionParser.new do |opts|
+        opts.banner = "Usage: #{$0} [options] <url> [<url> ...]"
+
+        @options[:stylesheets] = []
+
+        opts.on("-L", "--lyndon", "Pre-process HTML with Lyndon") do
+          @options[:lyndon] = true
+        end
+
+        opts.on("-l", "--log FILE", "Where to write log messages") do |v|
+          @options[:log_file] = v
+        end
+
+        opts.on("-P", "--proxy", "Run in proxy mode") do
+          @options[:proxy] = true
+        end
+
+        opts.on("-p", "--proxy-port", "Port to run the proxy on") do |v|
+          @options[:proxy] = true
+          @options[:proxy_port] = v.to_i
+        end
+
+        opts.on("-O", "--output FILE",
+                "Where to output orphaned CSS rules") do |v|
+          @options[:output] = File.new(v, "w")
+        end
+
+        opts.on("-s", "--stylesheet FILE",
+                "Apply the specified stylesheet to the target") do |v|
+          @options[:stylesheets] << v
+        end
+
+        opts.on("-w", "--whitelist URL-PREFIX",
+                "Specifies a prefix for URLs to process") do |v|
+          @options[:whitelist] ||= []
+          @options[:whitelist] << v
+        end
+      end
+    end
+
+    def self.parse_options(arguments = [])
+      self.option_parser.parse!(arguments)
+      @options
+    end
+
+    def initialize(stdout, stdin, stderr, arguments = [], options = {})
+      @stdout = stdout
+      @stdin  = stdin
+      @stderr = stderr
+      @arguments = arguments
+      @options = options
+      @output = options[:output]
+    end
+
+    def execute!
+      if options[:proxy]
+        proxy
+      elsif arguments.empty?
+        stdout.puts self.class.option_parser.help
+      else
+        process
+      end
+    end
+
+    def process
+      # TODO pass stylesheets + pages as args
+      dw = Deadweight.new
+
+      # TODO this should be the default
+      dw.root = ""
+
+      dw.log_file = options[:log_file]
+
+      dw.stylesheets = options[:stylesheets]
+
+      dw.rules = stdin.read if stdin.stat.size > 0
+
+      if options[:lyndon]
+        arguments.each do |file|
+          dw.pages << IO.popen("cat #{file} | lyndon 2> /dev/null")
+        end
+      else
+        dw.pages = arguments
+      end
+
+      unused_rules = dw.run
+      unused_rules.each do |k,v|
+        output.puts "#{k} { #{v} }"
+      end
+    end
+
+    def proxy
+      dw = Deadweight.new
+
+      # TODO note the boilerplate shared with #process
+      dw.root = ""
+      dw.log_file = options[:log_file]
+      dw.stylesheets = options[:stylesheets]
+      dw.rules = stdin.read if stdin.stat.size > 0
+
+      # initialize selectors
+      dw.run
+
+      stdout.puts "#{dw.unused_selectors.length} rules loaded."
+
+      require 'webrick/httpproxy'
+
+      @proxy = WEBrick::HTTPProxyServer.new \
+        :AccessLog           => [
+          [options[:log_file], WEBrick::AccessLog::COMMON_LOG_FORMAT],
+          [options[:log_file], WEBrick::AccessLog::REFERER_LOG_FORMAT]
+        ],
+        :Logger              => WEBrick::Log.new(options[:log_file]),
+        :Port                => options[:proxy_port],
+        :ProxyContentHandler => lambda { |request, response|
+
+          parse_this = false
+
+          if options[:whitelist]
+            options[:whitelist].each do |x|
+              sliced_request_uri = response.request_uri.to_s[0..x.length - 1]
+              if sliced_request_uri.downcase == x.downcase
+                parse_this = true
+                break 
+              end
+            end
+          else
+            parse_this = true
+          end
+
+          if parse_this && response.header["content-type"] =~ /text\/html/
+            # TODO this slows things down significantly; better would be to
+            # remove the Accept-Encoding header during the request phase
+            body = if response.header["content-encoding"] == "gzip"
+              Zlib::GzipReader.new(StringIO.new(response.body)).read
+            elsif response.header["content-encoding"] == "deflate"
+              Zlib::Inflate.inflate(response.body)
+            else
+              response.body
+            end
+            dw.process!(body)
+
+            stdout.puts "After reviewing <#{response.request_uri}>, there were #{dw.unused_selectors.length} rules left"
+            # stdout.puts "After reviewing <#{response.request_uri}>, these were left:"
+            # dw.unused_selectors.each do |k,v|
+            #   stdout.puts "#{k} { #{v} }"
+            # end
+          end
+        }
+
+      trap('INT') do
+        @proxy.shutdown 
+
+        # dump the remaining CSS rules if output is set
+        unless options[:output] == STDOUT
+          dw.unused_selectors.each do |k,v|
+            output.puts "#{k} { #{v} }"
+          end
+        end
+      end
+
+      @proxy.start
+    end
+  end
+end
+

data/test/cli_test.rb

@@ -0,0 +1,20 @@
+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"
+
+  should "output unused selectors on STDOUT" do
+    @result = `#{COMMAND}`.split("\n")
+
+    assert_equal 1, @result.grep(/^#foo \.bar \.baz \{/).length
+    assert_equal 0, @result.grep(/^#foo \{/).length
+    assert_equal 0, @result.grep(/^#foo .bar \{/).length
+  end
+
+  should "accept CSS rules on STDIN" do
+    @result = `echo ".something { display: block; }" | #{COMMAND}`.split("\n")
+
+    assert_equal 1, @result.grep(/^\.something \{/).length
+  end
+end
+

data/test/deadweight_test.rb

@@ -41,4 +41,20 @@ class DeadweightTest < Test::Unit::TestCase
 
     assert @dw.run.empty?
   end
+
+  should "accept IO objects as targets" do
+    @dw.pages << File.new(File.dirname(__FILE__) + '/fixtures/index2.html')
+
+    assert @dw.run.empty?
+  end
+
+  should "allow individual CSS rules to be appended" do
+    @dw.rules = ".something { display: block; }"
+
+    assert @dw.run.include?(".something")
+  end
+
+  should 'provide the results of its last run with #unused_selectors' do
+    assert_equal @result, @dw.unused_selectors
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: aanand-deadweight
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors: 
 - Aanand Prasad
@@ -9,8 +9,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-18 00:00:00 -07:00
-default_executable: 
+date: 2009-09-24 00:00:00 -07:00
+default_executable: deadweight
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: css_parser
@@ -34,8 +34,8 @@ dependencies:
     version: 
 description: 
 email: aanand.prasad@gmail.com
-executables: []
-
+executables: 
+- deadweight
 extensions: []
 
 extra_rdoc_files: 
@@ -48,8 +48,11 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- bin/deadweight
 - deadweight.gemspec
 - lib/deadweight.rb
+- lib/deadweight/cli.rb
+- test/cli_test.rb
 - test/deadweight_test.rb
 - test/fixtures/index.html
 - test/fixtures/index2.html
@@ -83,5 +86,6 @@ signing_key:
 specification_version: 3
 summary: RCov for CSS
 test_files: 
+- test/cli_test.rb
 - test/deadweight_test.rb
 - test/test_helper.rb