see-less-ess-ess 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ..gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Glen Mailer
+
+MIT License
+
+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/README.md

@@ -0,0 +1,13 @@
+# See-less-ess-ess
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your compass config.rb
+
+    gem 'see-less-ess-ess'
+
+## Usage
+
+TODO: Write usage instructions here

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/see-less-ess-ess.rb

@@ -0,0 +1,169 @@
+require 'sass'
+require 'nokogiri'
+
+module SeeLessEssEss
+  VERSION = '0.0.1'
+
+  class Extractor
+    def initialize(location)
+      @location = location
+    end
+
+    def css_classes
+      @css_classes ||= extract_css_classes!
+    end
+
+    protected
+
+    def files
+      Dir.glob("#{@location}/*.html")
+    end
+    def extract_css_classes!
+      files.map do |file|
+        collector = Collector.new()
+        parser = Nokogiri::HTML::SAX::Parser.new(collector)
+        contents = open(file, 'rb').read
+        parser.parse(contents)
+        collector.css_classes
+      end.flatten
+    end
+
+    class Collector < Nokogiri::XML::SAX::Document
+      def css_classes
+        @css_classes ||= []
+      end
+      def start_element(name, attrs = [])
+        attrs.each do |name, value|
+          if name == "class"
+            css_classes << value.split
+          end
+        end
+      end
+    end
+  end
+
+  class Checker
+
+    def initialize(extractor, used_classes)
+      @extractor = extractor
+      @used_classes = used_classes
+    end
+
+    def does_not_use(sequence)
+      selectors = sequence.members.reject { |s| s.is_a?(String) }
+      selectors.any? do |selector|
+        selector.members.any? do |simple|
+          unused(simple)
+        end
+      end
+    end
+
+    def unused(simple)
+      if simple.is_a?(Sass::Selector::Class)
+        !css_classes_whitelist.include?(simple.name[0].to_s)
+      else
+        false
+      end
+    end
+
+    def css_classes_whitelist
+      @whitelist ||= @extractor.css_classes + @used_classes
+    end
+  end
+
+  class RemoveUnusedRules < Sass::Tree::Visitors::Base
+
+    def initialize(checker)
+      @checker = checker
+    end
+
+    # If an exception is raised, this adds proper metadata to the backtrace.
+    def visit(node)
+      super(node)
+    rescue Sass::SyntaxError => e
+      e.modify_backtrace(:filename => node.filename, :line => node.line)
+      raise e
+    end
+
+    def remove_unused_children(node)
+      # Strip out any unused rules
+      node.children.reject! do |child|
+        if child.invisible?
+          # Already wont be shown
+          false
+        elsif not child.respond_to? :resolved_rules
+          # Only mess with RuleNodes
+          false
+        else
+          child.resolved_rules.members.reject! do |sequence|
+            @checker.does_not_use(sequence)
+          end
+
+          # Remove if there's nothing left
+          child.resolved_rules.members.empty?
+        end
+      end
+
+      yield
+    end
+
+    def visit_root(node, &block)
+      remove_unused_children(node, &block)
+    end
+    def visit_media(node, &block)
+      remove_unused_children(node, &block)
+    end
+
+  end
+
+  def self.initialised?
+    @@initialised ||= false
+  end
+  def self.init
+    if not defined? ::Compass or initialised?
+      return
+    end
+    @@initialised = true
+
+    Compass::Configuration.add_configuration_property(
+      :templates_location, "Directory to scan for template files") do
+
+      project_path
+    end
+    Compass::Configuration.add_configuration_property(
+      :used_css_classes, "CSS classes to explicity declare as 'used'") do
+
+      []
+    end
+
+    Sass::Engine.class_eval do
+      alias_method :_slss_to_tree, :_to_tree
+      def _to_tree
+        conf = Compass.configuration
+        extractor = SeeLessEssEss::Extractor.new(conf.templates_location)
+        checker = SeeLessEssEss::Checker.new(extractor, conf.used_css_classes)
+
+        tree = _slss_to_tree
+        if @options[:filename] == @options[:original_filename]
+          meta = class << tree; self; end
+          meta.send(:define_method, :render) do
+            # Taken verbatim from real #render
+            Sass::Tree::Visitors::CheckNesting.visit(self)
+            result = Sass::Tree::Visitors::Perform.visit(self)
+            # Check again to validate mixins
+            Sass::Tree::Visitors::CheckNesting.visit(result)
+            result, extends = Sass::Tree::Visitors::Cssize.visit(result)
+            Sass::Tree::Visitors::Extend.visit(result, extends)
+            # The next line is our modification
+            SeeLessEssEss::RemoveUnusedRules.new(checker).visit(result)
+            result.to_s
+          end
+        end
+        tree
+      end
+    end
+
+  end
+end
+
+SeeLessEssEss.init

data/see-less-ess-ess.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |gem|
+  gem.name          = "see-less-ess-ess"
+  gem.version       = '0.0.1'
+  gem.authors       = ["Glen Mailer"]
+  gem.email         = ["glenjamin@gmail.com"]
+  gem.description   = %q{Remove unused CSS rules from a compass project by scanning template files}
+  gem.summary       = %q{Remove unused CSS rules from a compass project}
+  gem.homepage      = "https://github.com/glenjamin/see-less-ess-ess"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency('sass')
+  gem.add_dependency('nokogiri')
+
+  gem.add_development_dependency('rspec')
+end

data/spec/checker_spec.rb

@@ -0,0 +1,78 @@
+require File.expand_path('../../lib/see-less-ess-ess.rb', __FILE__)
+
+module SeeLessEssEss
+  describe "Checker" do
+    let(:extractor) do
+      mock("Extractor").tap do |m|
+        m.stub!(:css_classes).and_return(parsed_css_classes)
+      end
+    end
+    let(:parsed_css_classes) { %w(row columns one two top-bar) }
+    let(:used_css_classes) { %w(zebra) }
+
+    let(:subject) { Checker.new(extractor, used_css_classes) }
+
+    describe "does_not_use" do
+
+      it "should keep .row" do
+        subject.does_not_use(
+          sequence(simple_sequence(className('row')))
+        ).should be_false
+      end
+      it "should keep body.row" do
+        subject.does_not_use(
+          sequence(simple_sequence(tag('body'), className('row')))
+        ).should be_false
+      end
+      it "should keep .zebra td" do
+        subject.does_not_use(
+          sequence(
+            simple_sequence(className('zebra')),
+            simple_sequence(tag('td'))
+          )
+        ).should be_false
+      end
+      it "should keep body" do
+        subject.does_not_use(
+          sequence(simple_sequence(tag('body')))
+        ).should be_false
+      end
+      it "should keep #id" do
+        subject.does_not_use(
+          sequence(simple_sequence(id('id')))
+        ).should be_false
+      end
+
+      it "should reject .class" do
+        subject.does_not_use(
+          sequence(simple_sequence(className('class')))
+        ).should be_true
+      end
+      it "should reject .row .class" do
+        subject.does_not_use(
+          sequence(
+            simple_sequence(className('row')),
+            simple_sequence(className('class'))
+          )
+        ).should be_true
+      end
+
+      def sequence(*args)
+        Sass::Selector::Sequence.new(args)
+      end
+      def simple_sequence(*args)
+        Sass::Selector::SimpleSequence.new(args, false)
+      end
+      def className(name)
+        Sass::Selector::Class.new([name])
+      end
+      def tag(name)
+        Sass::Selector::Element.new([name], nil)
+      end
+      def id(id)
+        Sass::Selector::Id.new([id])
+      end
+
+    end
+  end
+end

data/spec/extractor_spec.rb

@@ -0,0 +1,14 @@
+require File.expand_path('../../lib/see-less-ess-ess.rb', __FILE__)
+
+module SeeLessEssEss
+  describe "Extractor" do
+
+    let(:subject) { Extractor.new(location) }
+    let(:location) { File.expand_path('../fixtures', __FILE__) }
+
+    it "should read all css classes from html files in location" do
+      subject.css_classes.should include(*%w(body1 body2 title main left lead))
+    end
+
+  end
+end

data/spec/fixtures/test.html

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+    <title>Page Title</title>
+</head>
+
+<body class="body1">
+    <h1 class="title main left">
+        Title!
+    </h1>
+    <p class="lead" data-something="not used">And some body text</p>
+</body>
+</html>

data/spec/fixtures/test2.html

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+    <title>Page Title</title>
+</head>
+
+<body class="body2">
+    <h1 class="title main left">
+        Title!
+    </h1>
+    <p class="lead" data-something="not used">And some body text</p>
+</body>
+</html>

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: see-less-ess-ess
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Glen Mailer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sass
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Remove unused CSS rules from a compass project by scanning template files
+email:
+- glenjamin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/see-less-ess-ess.rb
+- see-less-ess-ess.gemspec
+- spec/checker_spec.rb
+- spec/extractor_spec.rb
+- spec/fixtures/test.html
+- spec/fixtures/test2.html
+- spec/spec_helper.rb
+homepage: https://github.com/glenjamin/see-less-ess-ess
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Remove unused CSS rules from a compass project
+test_files:
+- spec/checker_spec.rb
+- spec/extractor_spec.rb
+- spec/fixtures/test.html
+- spec/fixtures/test2.html
+- spec/spec_helper.rb