dead_css 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6cc29741d322c19a5cd25d7cdb78e80a8c41e023
+  data.tar.gz: 278ef9a7fcad61e9375ff0fc1c747b4788c5dbca
+SHA512:
+  metadata.gz: aac3fb05c60f6d3790f1bf86dd34799f223ffbd32cbe2a4de922219dd3032673d8407a567eb80d3e60ec248efff62c8f4fdd9aba7b8e440fd70514936743ed14
+  data.tar.gz: 643b099b04d9f054c64ca0574c94e236dfea1b1f244fbd2da76b9bc6542be0edcab087283b71164c7d6cf7d458577162c5791ec4bd9f2c013e86403ccf12faa1

data/bin/dead_css

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby
+
+require 'logger'
+require 'optparse'
+require 'dead_css'
+
+
+logger = Logger.new(STDOUT)
+logger.level = Logger::INFO
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = 'Usage: dead_css -c <path/to/codebase>'
+
+  opts.on('-c', '--codebase PATH', 'root of the codebase to analize') { |v| options[:root] = v }
+
+  opts.on_tail('-h', '--help', 'Show this message') do
+    puts opts
+    exit
+  end
+
+  opts.on('-v', '--[no-]verbose', 'Run verbosely') { |v| options[:verbose] = v }
+end.parse!
+
+logger.level = Logger::DEBUG if options[:verbose]
+
+unless options[:root]
+  logger.error('Missing required -c argument, exiting')
+  exit
+end
+
+unless File.directory?(options[:root])
+  logger.error('-c argument is an invalid path, exiting')
+  exit
+end
+
+root = File.expand_path(options[:root])
+logger.info("Running dead_css in #{root}")
+
+logger.info('Scanning css files')
+css_files = UnusedCSS.files_by_extensions(root, UnusedCSS::CSS_EXTENSIONS)
+logger.info("Found #{css_files.size} css files")
+css_files.each { |css_file| logger.debug(css_file) }
+
+css_selectors = css_files.map { |css_file| UnusedCSS.css_selectors(css_file) }.flatten.uniq
+css_selectors = css_selectors.map { |css_selector| UnusedCSS.elementary_selectors(css_selector) }.flatten.uniq
+logger.info("Found #{css_selectors.size} css selectors")
+css_selectors.each { |css_selector| logger.debug(css_selector) }
+css_selectors = css_selectors.map { |s| UnusedCSS::Selector.new(s) }
+
+assets_files = UnusedCSS.files_by_extensions(root, UnusedCSS::ASSETS_EXTENSIONS)
+logger.info("Found #{assets_files.size} assets files")
+logger.info('Looking for selectors in assets files')
+assets_files.each { |asset_file| logger.debug(asset_file) }
+unmatched_selectors = UnusedCSS.unmatched_selectors(css_selectors, assets_files)
+
+logger.info("The following selectors are potentially dead:")
+unmatched_selectors.each { |selector| logger.info(selector.to_s) }

data/lib/dead_css.rb

@@ -0,0 +1,56 @@
+require 'css_parser'
+
+
+module UnusedCSS
+  include CssParser
+
+  CSS_EXTENSIONS = ['css', 'scss']
+  ASSETS_EXTENSIONS = ['html', 'js', 'coffee', 'haml']
+  SPLIT_REGEX = /(?:\s|>|~)+/
+  SELECTOR_REGEX = /((\.|#)\w+)/
+
+  class Selector
+    def initialize(sel)
+      @sel = sel
+    end
+
+    def prefix
+      @sel[0]
+    end
+
+    def value
+      @sel[1..-1]
+    end
+
+    def to_s
+      @sel
+    end
+  end
+
+  def self.files_by_extensions(root, extensions)
+    extensions.map { |ext| Dir.glob("#{root}/**/*.#{ext}") }.flatten
+  end
+
+  def self.css_selectors(path)
+    parser = CssParser::Parser.new
+    parser.load_file!(path)
+    selectors = []
+    parser.each_selector { |selector, declarations, specificity| selectors << selector }
+    selectors.map(&:split).flatten.uniq
+  end
+
+  def self.elementary_selectors(composed_selector)
+    composed_selector.split(/(?:\s|>|~)+/).map do |s|
+      SELECTOR_REGEX.match(s)
+    end.flatten.compact.map(&:to_s)
+  end
+
+  def self.unmatched_selectors(selectors, files)
+    unmatched_selectors = Array.new(selectors)
+    files.each do |file|
+      lines = File.readlines(file)
+      unmatched_selectors.delete_if { |selector| lines.grep(Regexp.new(selector.value)).size > 0 }
+    end
+    unmatched_selectors
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: dead_css
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Lucas Deschamps
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: css_parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+description: List potentially unused css selectors in a project
+email: lucasdchamps@gmail.com
+executables:
+- dead_css
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/dead_css
+- lib/dead_css.rb
+homepage: http://rubygems.org/gems/dead_css
+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.8
+signing_key: 
+specification_version: 4
+summary: Reports unused css
+test_files: []