cesspit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 969ed71d9c70ae5d9d2487b78ba3c2fb26c0e46c
+  data.tar.gz: 5c8d0730941808d903a13d89e61c6fc2110c417e
+SHA512:
+  metadata.gz: 44822c6d1fe2d558a36af08c8aef6e63803ed69b8d36f344063015c8d58ff75e0fabdcbe8ae704887b989eb3dad0a028e363e89f2217a5dae5e77665e3bc9b1d
+  data.tar.gz: cd0e24857d9d053f78889530fb79ddaa72b5f1771fc1532ab2aa82abd5b595fcc77f50002f90f8a94ee369c6f07e4def864ed0f7852bb5c5c20dea6979c557fd

data/README.markdown

@@ -0,0 +1,70 @@
+Cesspit
+=======
+
+Clean up your stinking pit of css.
+
+Cesspit finds unused CSS by comparing your css to examples of your HTML.  You can either provide HTML files, or integrate Cesspit with existing test suites.
+
+Standalone Usage 
+----------------
+
+You can analyze CSS using the standalone `cesspit` script:
+
+~~~ shell
+$ cesspit --css test/fixtures/colors.css --html test/fixtures/red.html
+test/fixtures/colors.css
+	.blue
+~~~
+
+You may pass as many CSS and HTML documents as you like in.  When Cesspit is done, it will print out unused selectors and the CSS files they were declared in.
+
+Test Integration 
+----------------
+
+Why bother generating piles of HTML documents when your tests already do it for you?
+
+Cesspit integrates with Minitest.
+
+~~~ ruby
+# When run individually
+ruby test/home_controller_test.rb --cesspit public/application.css
+
+# With Rake:
+TESTOPTS="--cesspit public/application.css" rake test
+~~~
+
+TODO
+----
+
+* Add support for other test frameworks.
+
+LICENSE:
+--------
+
+(The MIT License)
+
+Copyright (c) Adam Sanderson
+
+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.
+
+
+-----
+
+Adam Sanderson, http://www.monkeyandcrow.com

data/bin/cesspit

@@ -0,0 +1,60 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require_relative '../lib/cesspit'
+require_relative '../lib/cesspit/cli'
+
+options = {
+  html_paths: [],
+  css_paths: [],
+}
+read_from_stdin = nil
+
+opts = OptionParser.new
+
+opts.banner = "Usage: #{$0} --html a.html,b.html --css a.css,b.css"
+
+opts.on("--html PATHS", Array, "Comma separated list of html documents to scan") do |paths|
+  options[:html_paths] += paths
+end
+
+opts.on("--css PATHS", Array, "Comma separated list of css paths to scan") do |paths|
+  options[:css_paths] += paths
+end
+
+opts.on("--[no]-stream", "Read files from STDIN, delimited by ASCII:\\28") do |enabled|
+  read_from_stdin = enabled
+end
+
+opts.on("-v","--version", "Print version") do |enabled|
+  puts Cesspit::VERSION
+  exit
+end
+
+opts.on_tail("-h", "--help", "Show this message") do
+  puts opts
+  exit
+end
+
+opts.parse!(ARGV)
+
+if options[:css_paths].empty?
+  puts "--css is required.\n"
+  puts opts
+  exit 1
+end
+
+unless read_from_stdin === false
+  if ARGV.last == "--"
+    ARGV.pop
+    read_from_stdin = true
+  elsif !STDIN.tty?
+    read_from_stdin = true
+  end
+end
+
+options[:html_paths] += ARGV
+
+cli = Cesspit::CLI.new(options)
+cli.read_from(STDIN) if read_from_stdin
+cli.report

data/lib/cesspit.rb

@@ -0,0 +1,111 @@
+require 'nokogiri'
+require 'css_parser'
+require_relative './version'
+
+class Cesspit
+  # http://en.wikipedia.org/wiki/Delimiter#ASCII_delimited_text
+  FILE_DELIMITER = 28.chr
+  IGNORED_PSEUDO_SELECTORS = /
+    (:active)|(:hover)|(:focus)|(:disabled)|(:checked) # Ignore stateful selectors
+    (\:before)|(:after)                                # Ignore content selectors
+    |(\:\:[\w+\-]+)                                    # Ignore pseudo elements
+  /xi
+  
+  attr_reader :selectors_by_source
+  attr_accessor :io
+  
+  def initialize
+    @selectors_by_source = {}
+    @io = STDERR
+  end
+  
+  def read_css(path)
+    open(path, "r") do |io|
+      add_css(io.read, path)
+    end
+  end
+  
+  def add_css(text, path=nil)
+    path ||= "anonymous_#{selectors_by_source.length}.css"
+    
+    if !has_css_path?(path)
+      @selectors_by_source[path] = extract_selectors(text)
+    end
+  end
+  
+  def has_css_path?(path)
+    selectors_by_source.has_key? path
+  end
+  
+  def read_html(path)
+    open(path, "r") do |io|
+      scan_html(io.read)
+    end
+  end
+  
+  def scan_html(html)
+    doc = Nokogiri::HTML(html)
+    
+    selectors_by_source.each do |path, selectors|
+      selectors.reject! do |selector|
+        begin
+          doc.at_css(selector)
+        rescue StandardError => ex
+          io.puts "Could not process #{selector.inspect}"
+          true
+        end
+      end
+    end
+  end
+  
+  def unmatched_selectors
+    selectors_by_source.values.flatten
+  end
+  
+  def to_s
+    out = []
+    selectors_by_source.each do |path, selectors|
+      if !selectors.empty?
+        out << "#{path} (#{selectors.length})"
+        
+        selectors.each do |selector|
+          out << "\t#{selector}"
+        end
+      end
+    end
+    
+    if out.empty?
+      ""
+    else
+      "Cesspit:\n" + out.join("\n")
+    end
+  end
+  
+  private
+  
+  def extract_selectors(text)
+    parser = CssParser::Parser.new(
+      :absolute_paths => false,
+      :import => false
+    )
+    
+    all_selectors = []
+    parser.add_block!(text)
+    parser.each_selector do |selector, declarations, specificity, media_types|
+      scrubbed = rewrite_pseudo_selectors(selector)
+      all_selectors << scrubbed
+    end
+    
+    all_selectors
+  end
+  
+  def rewrite_pseudo_selectors(selector)
+    selector.gsub(IGNORED_PSEUDO_SELECTORS) do |match|
+      if $`[-1] =~ /[\w\*\]]/
+        ""  # .div:hover
+      else
+        "*" # .div > :hover
+      end
+    end
+  end
+end

data/lib/cesspit/cli.rb

@@ -0,0 +1,32 @@
+class Cesspit::CLI
+  attr_reader :cesspit
+  attr_reader :in, :out
+  
+  def initialize(options)
+    @cesspit = Cesspit.new
+    @in  = options[:in]
+    @out = options[:out] || STDOUT
+    
+    options[:css_paths].each do |path| 
+      cesspit.read_css(path)
+    end
+    
+    if options[:html_paths]
+      options[:html_paths].each do |path|
+        cesspit.read_html(path)
+      end
+    end
+    
+  end
+  
+  def read_from(stream)
+    stream.each(Cesspit::FILE_DELIMITER) do |html|
+      cesspit.scan_html(html)
+    end
+  end
+  
+  def report
+    out.puts(cesspit.to_s)
+  end
+  
+end

data/lib/cesspit/minitest_scanner.rb

@@ -0,0 +1,31 @@
+require_relative '../cesspit'
+
+module Cesspit::MinitestScanner
+  
+  def self.cesspit= cesspit
+    @cesspit = cesspit
+  end
+  
+  def self.cesspit
+    @cesspit ||= Cesspit.new
+  end
+  
+  def before_teardown
+    response = instance_variable_get(:@response)
+    response ||= self.response if respond_to?(:response)
+
+    if response &&
+       response.respond_to?(:body)         &&
+       response.respond_to?(:content_type) &&
+       response.respond_to?(:status)
+    
+      if response.content_type.to_s.downcase == "text/html" &&
+         (response.status/100 != 3)
+         
+         Cesspit::MinitestScanner.cesspit.scan_html(response.body)
+      end
+    end
+  
+    super
+  end
+end

data/lib/minitest/cesspit_plugin.rb

@@ -0,0 +1,31 @@
+require_relative '../cesspit/minitest_scanner'
+
+# Minitest Plugin for Minitest 5.x
+module Minitest
+  def self.plugin_cesspit_options(opts, options)
+    opts.on "--cesspit PATHS", Array, "Enable Cesspit response scanning" do |paths|
+      options[:cesspit] = paths
+    end
+  end
+
+  def self.plugin_cesspit_init(options)
+    paths = options[:cesspit] || []
+    if !paths.empty?
+      # Include hooks for MinitestScanner
+      Minitest::Test.send :include, Cesspit::MinitestScanner
+      cesspit = Cesspit::MinitestScanner.cesspit
+      
+      paths.each{|path| cesspit.read_css(path) }
+      
+      # Set up CesspitReporter
+      self.reporter << CesspitReporter.new(options[:io], options)
+    end
+  end
+  
+  class CesspitReporter < Minitest::Reporter
+    def report
+      io.puts Cesspit::MinitestScanner.cesspit
+    end
+  end
+  
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+class Cesspit
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: cesspit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adam Sanderson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: css_parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: Scans and finds unused css declarations.
+email:
+- netghost@gmail.com
+executables:
+- cesspit
+extensions: []
+extra_rdoc_files: []
+files:
+- README.markdown
+- bin/cesspit
+- lib/cesspit.rb
+- lib/cesspit/cli.rb
+- lib/cesspit/minitest_scanner.rb
+- lib/minitest/cesspit_plugin.rb
+- lib/version.rb
+homepage: https://github.com/adamsanderson/cesspit
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Clean up your stinking CeSSPit (see that's a joke there).
+test_files: []