superleggera 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 85dcff1791e37bcafe968360f90c4a064a55b9ee84a6d13848ab43e4a6ae207f
+  data.tar.gz: d01efa7e2cf3839a4073e6fbae2c935b271e2b3a9a0cdad50a7c4359ce2ea857
+SHA512:
+  metadata.gz: 8605c5bd446d59bab7f613075af5ac80fc7ae70ca575f2d8d2fde4041c872a3978890e8043450b89bbd4ee999bd662ac830dbb13ca2be134d6ab2ef04803251b
+  data.tar.gz: 6601a01aeb2ad964481cab1bb08112dfc548b3ab6850ad92b73e9b4523f73502e32b84651219855f1af0897610eb1d14e634e53b03fcbee13ee7a6cec5718d51

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Chris Oliver
+
+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,74 @@
+# Superleggera
+Monitor your CSS in development to create a whitelist for PurgeCSS
+in Rails with Webpacker.
+
+This can be used to purge unused CSS classes from Bootstrap,
+TailwindCSS, or any other CSS framework you include in Webpacker.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'superleggera'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install superleggera
+```
+
+Make sure your app has Bootstrap, TailwindCSS, or another CSS framework
+loaded via Webpacker and not the asset pipeline.
+
+Then update your `config/webpack/development.js` file:
+
+```
+process.env.NODE_ENV = process.env.NODE_ENV || 'development'
+
+const environment = require('./environment')
+
+
+// Configure PurgeCSS
+const PurgecssPlugin = require('purgecss-webpack-plugin')
+const fs = require("fs")
+const glob = require('glob-all')
+const path = require('path')
+
+var whitelist_path = "config/whitelist.json"
+var whitelist = []
+
+if (fs.existsSync(whitelist_path)) {
+  whitelist = JSON.parse(fs.readFileSync(whitelist_path))
+}
+
+environment.plugins.append('PurgecssPlugin', new PurgecssPlugin({
+  paths: glob.sync([
+    path.join(__dirname, '../../app/views/**/*.html.erb'),
+  ]),
+  whitelist: whitelist
+}))
+
+
+
+
+module.exports = environment.toWebpackConfig()
+```
+
+## TODO
+* When a Rails view is updated, we should also trigger webpack to rebuild the
+CSS and autoreload if the webpack-dev-server is running. This is ideally
+done via Webpacker monitoring of app/views, but we could also triggers
+this when a request comes through the middleware.
+* Process Vue, React, and Stimulus files to find more classes to
+  whitelist
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Superleggera'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/config/whitelist.json

@@ -0,0 +1 @@
+{["test"]

data/lib/superleggera.rb

@@ -0,0 +1,52 @@
+require "superleggera/engine"
+
+module Superleggera
+  class Error < StandardError; end
+
+  class Middleware
+    def initialize app
+      @app = app
+    end
+
+    def call env
+      @status, @headers, @response = @app.call(env)
+
+      merge_whitelist
+
+      [@status, @headers, @response]
+    end
+
+    def merge_whitelist
+      classes = load_whitelist
+      classes += parse_classes(@response)
+      classes.uniq!
+      classes.sort!
+      write_whitelist(classes)
+    end
+
+    def parse_classes(document)
+      matches = document.scan(/class=["'](.+)["']/)
+      matches.flatten.flat_map(&:split)
+    end
+
+    def write_whitelist(classes)
+      File.open(whitelist_path, "w") do |f|
+        f.write(classes.to_json)
+      end
+    end
+
+    def load_whitelist
+      if File.exist?(whitelist_path)
+        JSON.load File.open(whitelist_path)
+      else
+        []
+      end
+    rescue JSON::ParserError
+      raise Error, "Unable to parse #{whitelist_path}. The contents should be a valid JSON array of class names."
+    end
+
+    def whitelist_path
+      File.join(Engine.root, "config/whitelist.json")
+    end
+  end
+end

data/lib/superleggera/engine.rb

@@ -0,0 +1,7 @@
+module Superleggera
+  class Engine < ::Rails::Engine
+    initializer "superleggera.insert_middleware" do |app|
+      app.config.middleware.use Superleggera::Middleware
+    end
+  end
+end

data/lib/superleggera/version.rb

@@ -0,0 +1,3 @@
+module Superleggera
+  VERSION = '0.0.1'
+end

data/lib/tasks/superleggera_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :superleggera do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: superleggera
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Chris Oliver
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Monitor your CSS in development to create a whitelist for PurgeCSS in
+  Rails with Webpacker
+email:
+- excid3@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- config/whitelist.json
+- lib/superleggera.rb
+- lib/superleggera/engine.rb
+- lib/superleggera/version.rb
+- lib/tasks/superleggera_tasks.rake
+homepage: https://github.com/excid3/superleggera
+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.7.6
+signing_key: 
+specification_version: 4
+summary: PurgeCSS for Rails & Webpacker
+test_files: []