deadweight 0.1.0 → 0.1.1

data/README.rdoc

@@ -12,15 +12,12 @@ Ryan Bates has worked his magic once again. Head over here for an excellent intr
 
   require 'deadweight'
 
-  desc "run Deadweight (script/server needs to be running)"
-  task :deadweight do
-    dw = Deadweight.new
+  Deadweight::RakeTask.new do |dw|
     dw.stylesheets = %w( /stylesheets/style.css )
     dw.pages = %w( / /page/1 /about )
-    puts dw.run
   end
 
-This will output all unused rules, one per line.
+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:
 
@@ -36,12 +33,10 @@ And you can use it as an HTTP proxy:
 
 === How You Install It
 
-  gem sources -a http://gems.github.com
-  sudo gem install aanand-deadweight
+  gem install deadweight -s http://gemcutter.org
 
 === Things to Note
 
-- 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
@@ -52,10 +47,7 @@ And you can use it as an HTTP proxy:
 
   require 'deadweight'
 
-  desc "run Deadweight on staging server"
-  task :deadweight do
-    dw = Deadweight.new
-
+  Deadweight::RakeTask.new do |dw|
     dw.mechanize = true
 
     dw.root = 'http://staging.example.com'
@@ -74,8 +66,6 @@ And you can use it as an HTTP proxy:
     }
 
     dw.ignore_selectors = /hover|lightbox|superimposed_kittens/
-
-    puts dw.run
   end
 
 == Copyright

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/deadweight.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{deadweight}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Aanand Prasad"]
-  s.date = %q{2009-09-25}
+  s.date = %q{2009-10-18}
   s.default_executable = %q{deadweight}
   s.email = %q{aanand.prasad@gmail.com}
   s.executables = ["deadweight"]
@@ -28,11 +28,13 @@ Gem::Specification.new do |s|
      "deadweight.gemspec",
      "lib/deadweight.rb",
      "lib/deadweight/cli.rb",
+     "lib/deadweight/rake_task.rb",
      "test/cli_test.rb",
      "test/deadweight_test.rb",
      "test/fixtures/index.html",
      "test/fixtures/index2.html",
      "test/fixtures/style.css",
+     "test/rake_task_test.rb",
      "test/test_helper.rb"
   ]
   s.homepage = %q{http://github.com/aanand/deadweight}
@@ -43,6 +45,7 @@ Gem::Specification.new do |s|
   s.test_files = [
     "test/cli_test.rb",
      "test/deadweight_test.rb",
+     "test/rake_task_test.rb",
      "test/test_helper.rb"
   ]
 

data/lib/deadweight.rb

@@ -5,7 +5,7 @@ require 'logger'
 
 class Deadweight
   attr_accessor :root, :stylesheets, :rules, :pages, :ignore_selectors, :mechanize, :log_file
-  attr_reader :unused_selectors
+  attr_reader :unused_selectors, :parsed_rules
 
   def initialize
     @root = 'http://localhost:3000'
@@ -15,6 +15,7 @@ class Deadweight
     @ignore_selectors = []
     @mechanize = false
     @log_file = STDERR
+    yield self and run if block_given?
   end
 
   def analyze(html)
@@ -42,20 +43,25 @@ class Deadweight
 
     css.add_block!(rules)
 
-    @unused_selectors = {}
-    total_selectors = 0
+    @parsed_rules     = {}
+    @unused_selectors = []
+    total_selectors   = 0
 
     css.each_selector do |selector, declarations, specificity|
-      unless @unused_selectors[selector]
+      unless @unused_selectors.include?(selector)
         total_selectors += 1
-        @unused_selectors[selector] = declarations unless selector =~ ignore_selectors
+
+        unless selector =~ ignore_selectors
+          @unused_selectors << selector
+          @parsed_rules[selector] = declarations
+        end
       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.keys.each do |selector|
+    @unused_selectors.each do |selector|
       if has_pseudo_classes(selector) && @unused_selectors.include?(strip(selector))
         @unused_selectors.delete(selector)
       end
@@ -85,6 +91,10 @@ class Deadweight
     @unused_selectors
   end
 
+  def dump(output)
+    output.puts(@unused_selectors)
+  end
+
   def process!(html)
     analyze(html).each do |selector|
       @unused_selectors.delete(selector)
@@ -143,3 +153,5 @@ private
   end
 end
 
+require 'deadweight/rake_task'
+

data/lib/deadweight/cli.rb

@@ -104,10 +104,8 @@ class Deadweight
         dw.pages = arguments
       end
 
-      unused_rules = dw.run
-      unused_rules.each do |k,v|
-        output.puts "#{k} { #{v} }"
-      end
+      dw.run
+      dw.dump(output)
     end
 
     def proxy

data/lib/deadweight/rake_task.rb

@@ -0,0 +1,12 @@
+class Deadweight
+  class RakeTask
+    def initialize output=STDOUT, &block
+      desc "run deadweight"
+      task :deadweight do
+        dw = Deadweight.new(&block)
+        dw.dump(output)
+      end
+    end
+  end
+end
+

data/test/cli_test.rb

@@ -4,17 +4,15 @@ 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")
+    @result = `#{COMMAND}`
 
-    assert_equal 1, @result.grep(/^#foo \.bar \.baz \{/).length
-    assert_equal 0, @result.grep(/^#foo \{/).length
-    assert_equal 0, @result.grep(/^#foo .bar \{/).length
+    assert_correct_selectors_in_output(@result)
   end
 
   should "accept CSS rules on STDIN" do
-    @result = `echo ".something { display: block; }" | #{COMMAND}`.split("\n")
+    @result = `echo ".something { display: block; }" | #{COMMAND}`
 
-    assert_equal 1, @result.grep(/^\.something \{/).length
+    assert @result.include?('.something')
   end
 end
 

data/test/deadweight_test.rb

@@ -3,23 +3,31 @@ require 'test_helper'
 class DeadweightTest < Test::Unit::TestCase
   def setup
     @dw = Deadweight.new
-    @dw.log_file = 'test.log'
-    @dw.root = File.dirname(__FILE__) + '/fixtures'
-    @dw.stylesheets << '/style.css'
-    @dw.pages << '/index.html'
-
+    default_settings(@dw)
     @result = @dw.run
   end
 
-  should "report unused selectors" do
-    assert @result.include?('#foo .bar .baz')
-  end
+  context "when initialized with a block" do
+    setup do
+      @dwb = Deadweight.new do |dw|
+        default_settings(dw)
+      end
+
+      @result = @dwb.run
+    end
+
+    should "have the same attributes" do
+      assert_equal(@dw.log_file,    @dwb.log_file)
+      assert_equal(@dw.root,        @dwb.root)
+      assert_equal(@dw.stylesheets, @dwb.stylesheets)
+      assert_equal(@dw.pages,       @dwb.pages)
+    end
 
-  should "not report used selectors" do
-    assert !@result.include?('#foo')
-    assert !@result.include?('#foo .bar')
+    should_correctly_report_selectors
   end
 
+  should_correctly_report_selectors
+
   should 'strip pseudo classes from selectors' do
     # #oof:hover (#oof does not exist)
     assert @result.include?('#oof:hover'), @result.inspect
@@ -57,4 +65,8 @@ class DeadweightTest < Test::Unit::TestCase
   should 'provide the results of its last run with #unused_selectors' do
     assert_equal @result, @dw.unused_selectors
   end
+
+  should 'provide the parsed CSS rules with #parsed_rules' do
+    assert_equal 'color: green;', @dw.parsed_rules['#foo']
+  end
 end

data/test/rake_task_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+require 'rake'
+
+class RakeTaskTest < Test::Unit::TestCase
+  context "Deadweight::RakeTask.new" do
+    setup do
+      @io = StringIO.new("", "w")
+
+      Deadweight::RakeTask.new(@io) do |d|
+        default_settings(d)
+      end
+
+      @task_names = Rake::Task.tasks.map { |t| t.name }
+      @task = Rake::Task.tasks.find { |t| t.name == 'deadweight' }
+    end
+
+    should "define a `deadweight` task that automatically runs" do
+      assert @task, "no deadweight task found in: #{@task_names.inspect}"
+
+      @task.execute
+      @io.close
+
+      assert_correct_selectors_in_output(@io.string)
+    end
+  end
+end

data/test/test_helper.rb

@@ -7,4 +7,41 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'deadweight'
 
 class Test::Unit::TestCase
+  UNUSED_SELECTORS = ['#foo .bar .baz']
+  USED_SELECTORS   = ['#foo', '#foo .bar']
+
+  def self.should_correctly_report_selectors
+    should "report unused selectors" do
+      assert_reports_unused_selectors(@result)
+    end
+
+    should "not report used selectors" do
+      assert_does_not_report_used_selectors(@result)
+    end
+  end
+
+  def assert_correct_selectors_in_output(output)
+    selectors = output.split("\n")
+    assert_reports_unused_selectors(selectors)
+    assert_does_not_report_used_selectors(selectors)
+  end
+
+  def assert_reports_unused_selectors(output)
+    UNUSED_SELECTORS.each do |s|
+      assert output.include?(s)
+    end
+  end
+
+  def assert_does_not_report_used_selectors(output)
+    USED_SELECTORS.each do |s|
+      assert !output.include?(s)
+    end
+  end
+
+  def default_settings(dw)
+    dw.log_file = 'test.log'
+    dw.root = File.dirname(__FILE__) + '/fixtures'
+    dw.stylesheets << '/style.css'
+    dw.pages << '/index.html'
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: deadweight
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Aanand Prasad
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-25 00:00:00 -04:00
+date: 2009-10-18 00:00:00 -04:00
 default_executable: deadweight
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -52,11 +52,13 @@ files:
 - deadweight.gemspec
 - lib/deadweight.rb
 - lib/deadweight/cli.rb
+- lib/deadweight/rake_task.rb
 - test/cli_test.rb
 - test/deadweight_test.rb
 - test/fixtures/index.html
 - test/fixtures/index2.html
 - test/fixtures/style.css
+- test/rake_task_test.rb
 - test/test_helper.rb
 has_rdoc: true
 homepage: http://github.com/aanand/deadweight
@@ -89,4 +91,5 @@ summary: A coverage tool for finding unused CSS
 test_files: 
 - test/cli_test.rb
 - test/deadweight_test.rb
+- test/rake_task_test.rb
 - test/test_helper.rb