RubyGems - css_dead_class - Versions diffs - 1.0.1 - Mend

css_dead_class 1.0.1

Files changed (10) hide show

checksums.yaml ADDED Viewed

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5e81d84c300a27ca3cb3d49d71b0377a91e5b4cc
+  data.tar.gz: 79208456a35ee7c20c67c94a3c648f5a061d222f
+SHA512:
+  metadata.gz: ee22edcef063aefffed1a4a96e3ba9da6288f0b35d45572b98a56ccad2298d53edec948f81b5edff447f7efe190e5c86b211c314af558b02cc48a59947a51c91
+  data.tar.gz: 1354350b3bfaff4ea2f483100e2f94a68b1b27afd3286fcfa9afc2bef4a97127efb327943b1b67970a3583a250dd0ad57157707d07831a5380d99df4ed39c835

data/.gitignore ADDED Viewed

@@ -0,0 +1,7 @@
+*.gem
+# Ignore bundler lock file
+/Gemfile.lock
+# Ignore pkg folder
+/pkg

data/Gemfile ADDED Viewed

@@ -0,0 +1,18 @@
+# If you do not have OpenSSL installed, update
+# the following line to use "http://" instead
+source 'https://rubygems.org'
+# Specify your gem's dependencies in bem_html.gemspec
+gemspec
+group :development do
+  gem 'rake'
+  gem 'rdoc'
+  gem 'yard'
+end
+group :test do
+  gem 'cucumber'
+  gem 'aruba'
+  gem 'rspec'
+end

data/Rakefile ADDED Viewed

@@ -0,0 +1,14 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:cucumber, 'Run features that should pass') do |t|
+  t.cucumber_opts = '--color --tags ~@wip --strict'
+end
+require 'rake/clean'
+task test: ['cucumber']
+task default: :test

data/Readme.md ADDED Viewed

@@ -0,0 +1,82 @@
+# CSSDeadClass
+Remove undefined CSS class attributes from your HTML.
+## Purpose
+This Gem will, given a set of HTML files and a set of CSS files, remove any mentions in the class attributes of HTML objects classes that are not defined in the CSS files.
+## Sample Usage
+Given the following files
+`index.html`
+~~~html
+<html>
+<body>
+	<h1 class="happy sad">Heading</h1>
+	<p class="red blue">Hello</p>
+</body>
+</html>
+~~~
+`app.css`
+~~~css
+.red {
+	color: red;
+}
+.happy {
+	color: black;
+}
+~~~
+Running CSSDeadClass on those two files will change `index.html` to the following, remove calls to `.sad` and `.blue`, as they do not exist:
+~~~ html
+<html>
+<body>
+	<h1 class="happy">Heading</h1>
+	<p class="red">Hello</p>
+</body>
+</html>
+~~~
+## Installation
+Install using `gem css_dead_class`.
+## Configuration
+CSSDeadClass takes three options:
+### `:css_files`
+An array of file paths to CSS files to scan.
+### `:html_files`
+An array of file paths to HTML files to scan.
+### `:classes_to_keep`
+An array of CSS classes to keep, regardless of presence in the HTML files. Can either be of the form `.classname` or `classname`.
+## Usage
+Sample usage in a ruby program:
+~~~ ruby
+require 'css_dead_classes'
+css_deadfiles = CSSDeadClass.new({
+	html_files: Dir.glob("**/*.html"),
+	css_files: Dir.glob("**/*.css"),
+	classes_to_keep: [
+		".no-js",
+		"blue"
+	]
+})
+css_deadfiles.parse
+~~~

data/css_dead_class-1.0.0.gem ADDED Viewed

Binary file

data/css_dead_class.gemspec ADDED Viewed

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+Gem::Specification.new do |s|
+  s.name        = "css_dead_class"
+  s.version     = "1.0.1"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Andrew Pilsch"]
+  s.email       = ["apilsch@tamu.edu"]
+  s.homepage    = "https://github.com/oncomouse/css_dead_class"
+  s.summary     = %q{Gem that, given a collection of HTML documents and CSS files, will remove any class attributes in the HTML set to CSS selectors that do not exist in the CSS files.}
+  # s.description = %q{A longer description of your extension}
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  # The version of middleman-core your extension depends on
+  s.add_runtime_dependency("nokogiri", ["~> 1.6"])
+  s.add_runtime_dependency("css_parser", ["~> 1.4"])
+  s.license = "ISC"
+  # Additional dependencies
+  # s.add_runtime_dependency("gem-name", "gem-version")
+end

data/features/support/env.rb ADDED Viewed

@@ -0,0 +1,4 @@
+PROJECT_ROOT_PATH = File.dirname(File.dirname(File.dirname(__FILE__)))
+require 'middleman-core'
+require 'middleman-core/step_definitions'
+require File.join(PROJECT_ROOT_PATH, 'lib', 'bem_html')

data/lib/css_dead_class.rb ADDED Viewed

@@ -0,0 +1,74 @@
+require 'hashie'
+require 'css_parser'
+require 'nokogiri'
+class Config < Hash
+	include Hashie::Extensions::MethodAccessWithOverride
+end
+class CSSDeadClass
+	def self.config
+		@_config ||= Config.new
+	end
+	def self.option(key, default=nil, description=nil, options={})
+		self.config[key] = Config.new(default: default, description: description, options: {})
+	end
+	option :css_files, [], "CSS Files to Scan"
+	option :html_files, [], "HTML Files to Scan"
+	option :classes_to_keep, [], "Classes to Keep Regardless of Presence in CSS Files"
+	def initialize(opts={})
+		@options = self.class.config.dup
+		@options.finalize!
+		opts.each do |k, v|
+			@options[k] = v
+		end
+	end
+	def parse
+		cssSelectors = []
+		cssFiles = @options.css_files
+		htmlFiles = @options.html_files
+		classesToKeep = @options.classes_to_keep
+		if cssFiles.length > 0
+			parser = CssParser::Parser.new
+			cssFiles.each do |cssFile|
+				parser.load_file!(cssFile)
+			end
+			parser.each_selector(:screen).each do |rule|
+				rule = rule[:rules]
+				rule.selectors.each do |segment|
+					segment.split(/(?: |\+|>)/).each do |r|
+						next if r.include? ":"
+						if(r[0] == ".")
+							cssSelectors.push(r)
+						elsif(r.include? ".")
+							s = r.split(".")
+							s.shift
+							s.each { |v| cssSelectors.push('.' + v)}
+						end
+					end
+				end
+			end
+			cssSelectors.uniq!
+		end
+		if cssSelectors.length > 0
+			htmlFiles.each do |htmlFile|
+				htmlDoc = Nokogiri::HTML(IO.read(htmlFile))
+				htmlDoc.css('*').each do |node|
+					next if node.attributes.nil? or node.attributes['class'].nil?
+					node['class'] = node.attributes['class'].value.split(/ /).select{ |cn|
+						cssSelectors.include?('.' + cn) || classesToKeep.include?(cn) || classesToKeep.include?('.' + cn)
+					}.join(" ")
+					if(node.attributes['class'].value == "")
+						node.attributes['class'].remove
+					end
+				end
+				File.open(htmlFile, "w") do |fp|
+					fp.puts htmlDoc.to_s
+				end
+			end
+		end
+	end
+end

metadata ADDED Viewed

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: css_dead_class
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Andrew Pilsch
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2016-07-02 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.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description:
+email:
+- apilsch@tamu.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Rakefile
+- Readme.md
+- css_dead_class-1.0.0.gem
+- css_dead_class.gemspec
+- features/support/env.rb
+- lib/css_dead_class.rb
+homepage: https://github.com/oncomouse/css_dead_class
+licenses:
+- ISC
+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.5.1
+signing_key:
+specification_version: 4
+summary: Gem that, given a collection of HTML documents and CSS files, will remove
+  any class attributes in the HTML set to CSS selectors that do not exist in the CSS
+  files.
+test_files:
+- features/support/env.rb