javascript template option

.travis.yml

@@ -1,7 +1,11 @@
 language: ruby
 rvm:
-  - 2.1.1
-  - 2.0.0
+  - 2.5
+  - 2.4
+  - 2.3
+  - 2.2
+  - 2.1
+  - 2.0
   - 1.9.3
   - jruby-18mode # JRuby in 1.8 mode
   - jruby-19mode # JRuby in 1.9 mode

CHANGELOG

@@ -1,3 +1,11 @@
+0.3.1 - 23/09/2016
+  Add option flag to disable "remove spaces inside tags"
+0.3.0 - 09/09/2015
+  Fix CDATA errors
+0.2.0 - 32/03/2015
+  Remove warnings in ruby 2.2
+  Support for custom html templates
+  Disable remove_http_protocol by default in the middleware
 0.1.2 - 04/09/2014
   Preserve custom attributes similar to simple attributes, such as ng-disabled (fixes #12)
 0.1.1 - 08/05/2014

README.md

@@ -6,7 +6,8 @@
 Htmlcompressor provides tools to minify html code.
 It includes
 - HtmlCompressor::Compressor class which is a raw port of [google's htmlcompressor](http://code.google.com/p/htmlcompressor/)
-- HtmlCompressor::Rack a rack middleware to compress html pages on the fly
+- HtmlCompressor::Rack a rack middleware to compress html pages on the fly.
+Beware that the compressor has proved to be too slow in many circunstances to be used for on the fly or real time execution. I encourage you to use it only for build-time optimisations or decrease the number of optimisations that are run at execution time.
 
 Please note that Htmlcompressor is still in alpha version and need some additional love.
 
@@ -22,62 +23,92 @@ Using the compressor class is straightforward:
 The compressor ships with basic and safe default options that may be overwritten passing the options hash to the constructor:
 
 ```ruby
-  options = {
-    :enabled => true,
-    :remove_multi_spaces => true,
-    :remove_comments => true,
-    :remove_intertag_spaces => false,
-    :remove_quotes => false,
-    :compress_css => false,
-    :compress_javascript => false,
-    :simple_doctype => false,
-    :remove_script_attributes => false,
-    :remove_style_attributes => false,
-    :remove_link_attributes => false,
-    :remove_form_attributes => false,
-    :remove_input_attributes => false,
-    :remove_javascript_protocol => false,
-    :remove_http_protocol => false,
-    :remove_https_protocol => false,
-    :preserve_line_breaks => false,
-    :simple_boolean_attributes => false
-  }
+options = {
+  :enabled => true,
+  :remove_spaces_inside_tags => true,
+  :remove_multi_spaces => true,
+  :remove_comments => true,
+  :remove_intertag_spaces => false,
+  :remove_quotes => false,
+  :compress_css => false,
+  :compress_javascript => false,
+  :simple_doctype => false,
+  :remove_script_attributes => false,
+  :remove_style_attributes => false,
+  :remove_link_attributes => false,
+  :remove_form_attributes => false,
+  :remove_input_attributes => false,
+  :remove_javascript_protocol => false,
+  :remove_http_protocol => false,
+  :remove_https_protocol => false,
+  :preserve_line_breaks => false,
+  :simple_boolean_attributes => false,
+  :compress_js_templates => false
+}
 ```
 
-Using rack middleware is as easy as:
+Htmlcompressor also ships a rack middleware that can be used with rails, sinatra or rack.
+
+**However keep in mind that compression is slow (especially when also compressing javascript or css) and can negatively impact the performance of your website. Take your measurements and adopt a different strategy if necessary**
+
+Using rack middleware (in rails) is as easy as:
+
+```ruby
+config.middleware.use HtmlCompressor::Rack, options
+```
+
+And in sinatra:
 
 ```ruby
-  config.middleware.use HtmlCompressor::Rack, options
+use HtmlCompressor::Rack, options
 ```
 
 The middleware uses a little more aggressive options by default:
 
 ```ruby
-  options = {
-    :enabled => true,
-    :remove_multi_spaces => true,
-    :remove_comments => true,
-    :remove_intertag_spaces => false,
-    :remove_quotes => true,
-    :compress_css => false,
-    :compress_javascript => false,
-    :simple_doctype => false,
-    :remove_script_attributes => true,
-    :remove_style_attributes => true,
-    :remove_link_attributes => true,
-    :remove_form_attributes => false,
-    :remove_input_attributes => true,
-    :remove_javascript_protocol => true,
-    :remove_http_protocol => true,
-    :remove_https_protocol => false,
-    :preserve_line_breaks => false,
-    :simple_boolean_attributes => true
-  }
+options = {
+  :enabled => true,
+  :remove_multi_spaces => true,
+  :remove_comments => true,
+  :remove_intertag_spaces => false,
+  :remove_quotes => true,
+  :compress_css => false,
+  :compress_javascript => false,
+  :simple_doctype => false,
+  :remove_script_attributes => true,
+  :remove_style_attributes => true,
+  :remove_link_attributes => true,
+  :remove_form_attributes => false,
+  :remove_input_attributes => true,
+  :remove_javascript_protocol => true,
+  :remove_http_protocol => false,
+  :remove_https_protocol => false,
+  :preserve_line_breaks => false,
+  :simple_boolean_attributes => true
+}
 ```
 
 Rails 2.3 users may need to add
 ```ruby
-  require 'htmlcompressor'
+require 'htmlcompressor'
+```
+
+## Javascript template compression
+
+You can compress javascript templates that are present in the html.
+Setting the `:compress_js_templates` options to `true` will by default compress the content of script tags marked with `type="text/x-jquery-tmpl"`.
+For compressing other types of templates, you can pass a string (or an array of strings) containing the type: `:compress_js_templates => ['text/html']`.
+Please note that activating template compression will disable the removal of quotes from attributes values, as this could lead to unexpected errors with compiled templates.
+
+
+## Custom preservation rules
+
+If you need to define custom preservation rules, you can list regular expressions in the `preserve_patterns` option. For example, to preserve PHP blocks you might want to define:
+
+```ruby
+options = {
+  :preserve_patterns => [/<\?php.*?\?>/im]
+}
 ```
 
 ## CSS and JavaScript Compression
@@ -87,48 +118,46 @@ In order to minify in page javascript and css, you need to supply a compressor i
 A compressor can be `:yui` or `:closure` or any object that responds to `:compress`. E.g.: `compressed = compressor.compress(source)`
 
 ```ruby
+class MyCompressor
 
-  class MyCompressor
-
-    def compress(source)
-      return 'minified'
-    end
-
+  def compress(source)
+    return 'minified'
   end
 
-  options = {
-    :compress_css => true,
-    :css_compressor => MyCompressor.new,
-    :compress_javascript => true,
-    :javascript_compressor => MyCompressor.new
-  }
+end
 
+options = {
+  :compress_css => true,
+  :css_compressor => MyCompressor.new,
+  :compress_javascript => true,
+  :javascript_compressor => MyCompressor.new
+}
 ```
 
 Please note that in order to use yui or closure compilers you need to manually add them to the Gemfile
 
 ```ruby
-  gem 'yui-compressor'
+gem 'yui-compressor'
 
-  ...
+...
 
-  options = {
-    :compress_javscript => true,
-    :javascript_compressor => :yui,
-    :compress_css => true
-    :css_compressor => :yui
-  }
+options = {
+  :compress_javascript => true,
+  :javascript_compressor => :yui,
+  :compress_css => true,
+  :css_compressor => :yui
+}
 ```
 
 ```ruby
-  gem 'closure-compiler'
+gem 'closure-compiler'
 
-  ...
+...
 
-  options = {
-    :compress_javascript => true,
-    :javascript_compressor => :closure
-  }
+options = {
+  :compress_javascript => true,
+  :javascript_compressor => :closure
+}
 ```
 
 ## Statistics

htmlcompressor.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency 'yui-compressor', '~> 0.9'
   gem.add_development_dependency 'closure-compiler', '~> 1.1'
-  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rake', '~> 10.3.2'
   gem.add_development_dependency 'minitest', '~> 5.0'
 
   gem.files         = `git ls-files`.split($\)