htmlcompressor 0.1.2 → 0.2.0

data/.travis.yml

@@ -1,5 +1,6 @@
 language: ruby
 rvm:
+  - 2.2.1
   - 2.1.1
   - 2.0.0
   - 1.9.3

data/CHANGELOG

@@ -1,3 +1,7 @@
+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

data/README.md

@@ -22,62 +22,81 @@ 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_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:
 
 ```ruby
-  config.middleware.use HtmlCompressor::Rack, options
+config.middleware.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 +106,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

data/lib/htmlcompressor/compressor.rb

@@ -128,15 +128,28 @@ module HtmlCompressor
       :preserve_line_breaks => false,
       :remove_surrounding_spaces => nil,
 
-      :preserve_patterns => nil,
-      :javascript_compressor => nil,
-      :css_compressor => nil
+      :preserve_patterns => nil
     }
 
     def initialize(options = {})
 
       @options = DEFAULT_OPTIONS.merge(options)
 
+      if @options[:compress_js_templates]
+        @options[:remove_quotes] = false
+
+        js_template_types = [ 'text/x-jquery-tmpl' ]
+
+        unless @options[:compress_js_templates].is_a? TrueClass
+          js_template_types << @options[:compress_js_templates]
+          js_template_types.flatten!
+        end
+
+        @options[:js_template_types] = js_template_types
+      else
+        @options[:js_template_types] = []
+      end
+
       detect_external_compressors
     end
 
@@ -314,7 +327,7 @@ module HtmlCompressor
             scriptBlocks << group_2
             index += 1
             group_1 + message_format(TEMP_SCRIPT_BLOCK, index) + group_3
-          elsif type == 'text/x-jquery-tmpl'
+          elsif @options[:js_template_types].include?(type)
             # jquery template, ignore so it gets compressed with the rest of html
             match
           else

data/lib/htmlcompressor/rack.rb

@@ -17,7 +17,7 @@ module HtmlCompressor
       :remove_form_attributes => false,
       :remove_input_attributes => true,
       :remove_javascript_protocol => true,
-      :remove_http_protocol => true,
+      :remove_http_protocol => false,
       :remove_https_protocol => false,
       :preserve_line_breaks => false,
       :simple_boolean_attributes => true

data/lib/htmlcompressor/version.rb

@@ -1,3 +1,3 @@
 module HtmlCompressor
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/test/compressor_closure_test.rb

@@ -11,7 +11,8 @@ module HtmlCompressor
       compressor = Compressor.new(
         :compress_javascript => true,
         :javascript_compressor => :closure,
-        :remove_intertag_spaces => true
+        :remove_intertag_spaces => true,
+        :compress_js_templates => true
       )
 
       assert_equal result, compressor.compress(source)

data/test/compressor_test.rb

@@ -82,7 +82,7 @@ module HtmlCompressor
       source = read_resource("testCompress.html")
       result = read_resource("testCompressResult.html")
 
-      compressor = Compressor.new
+      compressor = Compressor.new(:compress_js_templates => true)
 
       assert_equal result, compressor.compress(source)
     end
@@ -207,6 +207,13 @@ module HtmlCompressor
       assert_equal result, compressor.compress(source)
     end
 
+    def test_compress_custom_html_templates
+      source = read_resource("testCompressCustomHtmlTemplates.html")
+      result = read_resource("testCompressCustomHtmlTemplatesResult.html")
+      compressor = Compressor.new(:compress_js_templates => ['text/html'], :remove_quotes => true)
+      assert_equal result, compressor.compress(source)
+    end
+
   end
 
 end

data/test/compressor_yui_test.rb

@@ -11,7 +11,8 @@ module HtmlCompressor
       compressor = Compressor.new(
         :compress_javascript => true,
         :javascript_compressor => :yui,
-        :remove_intertag_spaces => true
+        :remove_intertag_spaces => true,
+        :compress_js_templates => true
       )
 
       assert_equal result, compressor.compress(source)

data/test/resources/html/testCompressCustomHtmlTemplates.html

@@ -0,0 +1 @@
+<script type="text/html">     <a attribute="value">     <!-- comment -->   <b>   </script>

data/test/resources/html/testCompressCustomHtmlTemplatesResult.html

@@ -0,0 +1 @@
+<script type="text/html"> <a attribute="value"> <b> </script>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: htmlcompressor
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-04 00:00:00.000000000 Z
+date: 2015-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yui-compressor
@@ -156,6 +156,8 @@ files:
 - test/resources/html/testCompress.html
 - test/resources/html/testCompressCss.html
 - test/resources/html/testCompressCssResult.html
+- test/resources/html/testCompressCustomHtmlTemplates.html
+- test/resources/html/testCompressCustomHtmlTemplatesResult.html
 - test/resources/html/testCompressJavaScript.html
 - test/resources/html/testCompressJavaScriptClosureResult.html
 - test/resources/html/testCompressJavaScriptYuiResult.html
@@ -233,7 +235,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3074038532829615995
+      hash: 472079073096694576
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -242,7 +244,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3074038532829615995
+      hash: 472079073096694576
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -311,6 +313,8 @@ test_files:
 - test/resources/html/testCompress.html
 - test/resources/html/testCompressCss.html
 - test/resources/html/testCompressCssResult.html
+- test/resources/html/testCompressCustomHtmlTemplates.html
+- test/resources/html/testCompressCustomHtmlTemplatesResult.html
 - test/resources/html/testCompressJavaScript.html
 - test/resources/html/testCompressJavaScriptClosureResult.html
 - test/resources/html/testCompressJavaScriptYuiResult.html