purgecss_rails 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0cc2d4d2e912a40049906bdd59ad44980b5339d6eb2e04a141ae9a657168ed38
-  data.tar.gz: 8922f762b735a68d340c4794667930900d0182279f59094316cef6690b810510
+  metadata.gz: 23f5fe49ebc2e41737b3e0ba335d3d6e8e80881a0c8254eea4df38dac5d8f1fa
+  data.tar.gz: 5683c0766ae5173cf154fa9681cf5e3a9ddb695cfec71596560003cf80a6acd9
 SHA512:
-  metadata.gz: 4b0066cc05354fb384a0375a4d683247957b49a9914ea4550536fbc75dbaf4f4b362a5f0de8861d71258d1485028170cda20db27e17c0a5a3a2c25652b8e5702
-  data.tar.gz: 740d9640affe431606042f67ea75d014968befda50fc9fc39b1e07639cbaea4d206a316b202765b898469c36feed2b3ebb932a338ed2782ff230d9be7d9a5c0c
+  metadata.gz: 2b8eb042be8e5718507e33a641210237d0651490c96ba8662b0dd938b5df8384493ccbe62671fddb2693fdabbd78549fe8facb83005455e5d0010665fa5e4368
+  data.tar.gz: b8e1e66a17ab4eed47b68d69ac48b4c903475a41a673f62d1da4242713f1495b346d844be855bd72d774972982b7095c7b42674bdaea9e006b0c9ce163c5bc59

data/README.md

@@ -1,9 +1,15 @@
 # PurgecssRails
-Short description and motivation.
-
-## Usage
+Reduce the bloat in your Rails CSS files using PurgeCSS. You can easily configure it to work with most rails apps.
 
 ## Installation
+
+First you would need a `purgecss` executable.
+you can easily add by:
+
+```bash
+yarn add purgecss
+```
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -20,44 +26,47 @@ Or install it yourself as:
 $ gem install purgecss_rails
 ```
 
+## Usage
+
 Define a file lib/tasks/purge_css.rake and put:
 
 ```ruby
-    require "purgecss_rails"
-    
-    desc "PurgeCSS"
-    namespace :purge_css do
-      task :clear do
-        `rm public/assets/*.css -rf`
-        `rm public/assets/*.css.gz -rf`
-      end
-    
-      task :run do
-        PurgecssRails.configure do |purge|
-          purge.search_css_files("public/assets/**/*.css")
-    
-          purge.match_html_files "public/assets/**/*.js",
-                                 "app/views/**/*.html.erb",
-                                 "app/helpers/**/*.rb"
-    
-          purge.optimize!
-        end.enable!.run_now!
-      end
-    end
-```
+require "purgecss_rails"
 
-If you need more precision in purging the css, ex engines:
+namespace :purge_css do
+  desc "Clear previous CSS files, this busts the CSS cache"
+  task :clear do
+    `rm public/assets/*.css -rf`
+    `rm public/assets/*.css.gz -rf`
+  end
 
-```ruby
-    PurgecssRails.configure do |purge|
-      purge.search_css_files("public/assets/my_engine/application.css")
+  desc "Optimize css files with PurgeCSS"
+  task :run do
+    PurgecssRails.configure(purge_css_path: "node_modules/purgecss/bin/purgecss") do |purge|
+      purge.search_css_files("public/assets/**/*.css")
 
-      purge.match_html_files "public/assets/my_engine/application.js",
-                             "engines/my_engine/views/**/*.html.erb",
+      purge.match_html_files "public/assets/**/*.js",
+                             "app/views/**/*.html.erb",
                              "app/helpers/**/*.rb"
 
       purge.optimize!
     end.enable!.run_now!
+  end
+end
+```
+
+If you need more precision in purging the css, ex engines:
+
+```ruby
+PurgecssRails.configure(purge_css_path: `purgecss`) do |purge|
+  purge.search_css_files("public/assets/my_engine/application.css")
+
+  purge.match_html_files "public/assets/my_engine/application.js",
+                         "engines/my_engine/views/**/*.html.erb",
+                         "app/helpers/**/*.rb"
+
+  purge.optimize!
+end.enable!.run_now!
 ```
 
 When you are using an external engine and you don't want to purge their css file, add a ingore
@@ -68,5 +77,15 @@ When you are using an external engine and you don't want to purge their css file
 
 you can also call `purge.refresh!` and reuse the the `purge` object
 
+## Deployment
+
+Heroku Procfile example
+
+`release: rake purge_css:clear assets:precompile purge_css:run`
+
+Other
+
+`rake purge_css:clear assets:precompile purge_css:run`
+
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/purgecss_rails/version.rb

@@ -1,3 +1,3 @@
 module PurgecssRails
-  VERSION = '0.5.0'
+  VERSION = '0.7.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: purgecss_rails
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - sebi
@@ -38,7 +38,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Reduce your css files considerably and improve your users experience
+description: Reduce the bloat in your Rails CSS files
 email:
 - gore.sebyx@yahoo.com
 executables: []
@@ -51,7 +51,7 @@ files:
 - lib/purgecss_rails.rb
 - lib/purgecss_rails/builder.rb
 - lib/purgecss_rails/version.rb
-homepage: https://www.google.com
+homepage: https://github.com/sebyx07/purgecss_rails
 licenses:
 - MIT
 metadata: {}
@@ -73,5 +73,5 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Use PurgeCSS with rails, designed for Asset Pipeline
+summary: PurgeCSS wrapper which can be used with Rails Asset Pipeline
 test_files: []