multi_html 0.0.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - rbx-18mode
+  - rbx-19mode
+  - jruby-18mode
+  - jruby-19mode
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - ruby-head

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gem 'html_press', :require => nil
+gem 'html_minifier', ">= 0.0.4", :require => nil
+# gem 'html_compressor', :require => nil
+# gem 'html_min', :require => nil
+# gem 'htmlmin', :require => nil
+# gem 'htmlcompressor', :require => nil
+
+# gem 'html-pipeline', :require => nil
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 sterebooster
+
+MIT License
+
+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,52 @@
+# MultiHtml [![Build Status](https://secure.travis-ci.org/stereobooster/multi_html.png?branch=master)](https://secure.travis-ci.org/#!/stereobooster/multi_html) [![Dependency Status](https://gemnasium.com/stereobooster/multi_html.png?travis)](https://gemnasium.com/stereobooster/multi_html) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/stereobooster/multi_html)
+
+There are lot of Ruby libraries to minify HTML.
+Instead of choosing a single implementation and forcing users of your library to be
+stuck with it, you can use MultiHtml instead, which will simply choose the
+best available HTML minifier. Here's how to use it:
+
+```ruby
+require 'multi_html'
+
+MultiHtml.min('<div>  <p>test</p>  </div>') #=> '<div><p>test</p></div>'
+```
+
+The `use` method, which sets the MultiHtml adapter, takes either a symbol or a
+class (to allow for custom HTML minifier) that responds to `.min` at the class level.
+
+MultiHtml tries to have intelligent defaulting. That is, if you have any of the
+supported engines already loaded, it will utilize them before attempting to
+load any. 
+It will load libraries in following order:
+
+ - [html_minifier](https://github.com/stereobooster/html_minifier)
+ - TODO: [html_compressor](https://github.com/completelynovel/html_compressor)
+ - TODO: [html_min](http://rubygems.org/gems/html_min)
+ - TODO: [htmlmin](https://github.com/aishek/htmlmin)
+ - TODO: [htmlcompressor](https://github.com/paolochiodi/htmlcompressor)
+
+If no other library is available, MultiHtml falls back to [html_press](https://github.com/stereobooster/html_press).
+
+## HTML::Pipeline
+
+```ruby
+pipeline = HTML::Pipeline.new [
+  MultiHtml::Filter
+]
+pipeline.call('<div>  <p>test</p>  </div>') #=> '<div><p>test</p></div>'
+```
+
+## TODO
+
+ - benchmark against most popular css frameworks (speed, size)
+ - generate benchmark report (html or md)
+ - write test suite
+ - generate comparison table (html or md) with the help of test suite
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+desc "Run all examples"
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/multi_html.rb

@@ -0,0 +1,116 @@
+require "multi_html/version"
+require "multi_html/filter"
+
+module MultiHtml
+  class ParseError < StandardError
+    def initialize(message="", backtrace=[])
+      super(message)
+      self.set_backtrace(backtrace)
+    end
+  end
+
+  @adapter = nil
+  
+  REQUIREMENT_MAP = [
+    ["html_minifier", :html_minifier],
+    # ["html_compressor", :html_compressor],
+    # ["html_min", :html_min],
+    # ["htmlmin", :htmlmin],
+    # ["htmlcompressor", :htmlcompressor],
+    ["html_press", :html_press]
+  ]
+
+  class << self
+
+    # The default adapter based on what you currently
+    # have loaded and installed. First checks to see
+    # if any adapters are already loaded, then checks
+    # to see which are installed if none are loaded.
+    def default_adapter
+      return :html_minifier if defined?(::HtmlMinifier)
+      # return :html_compressor if defined?(::HtmlCompressor)
+      # return :html_min if defined?(::HTMLMin)
+      # return :htmlmin if defined?(::HTMLMin)
+      # return :htmlcompressor if defined?(::HtmlCompressor)
+      return :html_press if defined?(::HtmlPress)
+
+      REQUIREMENT_MAP.each do |(library, adapter)|
+        begin
+          require library
+          return adapter
+        rescue LoadError
+          next
+        end
+      end
+
+      :html_press
+    end
+    # :nodoc:
+    alias :default_engine :default_adapter
+
+    # Get the current adapter class.
+    def adapter
+      return @adapter if @adapter
+      self.use self.default_adapter
+      @adapter
+    end
+    # :nodoc:
+    alias :engine :adapter
+
+    # Set the adapter utilizing a symbol, string, or class.
+    # Supported by default are:
+    #
+    # * <tt>:html_press</tt>
+    # * <tt>:cssminify</tt>
+    # * <tt>:yuicssmin</tt>
+    # * <tt>:yui_compressor</tt>
+    # * <tt>:rainpress</tt>
+    def use(new_adapter)
+      @adapter = load_adapter(new_adapter)
+    end
+    alias :adapter= :use
+    # :nodoc:
+    alias :engine= :use
+
+    def load_adapter(new_adapter)
+      case new_adapter
+      when String, Symbol
+        require "multi_html/adapters/#{new_adapter}"
+        self::Adapters.const_get(:"#{new_adapter.to_s.split('_').map{|s| s.capitalize}.join('')}")
+      when NilClass, FalseClass
+        default_adapter = self.default_adapter
+        require "multi_html/adapters/#{default_adapter}"
+        self::Adapters.const_get(:"#{default_adapter.to_s.split('_').map{|s| s.capitalize}.join('')}")
+      when Class
+        new_adapter
+      else
+        raise "Did not recognize your adapter specification. Please specify either a symbol or a class."
+      end
+    end
+
+    def current_adapter(options)
+      if new_adapter = (options || {}).delete(:adapter)
+        load_adapter(new_adapter)
+      else
+        adapter
+      end
+    end
+
+    # Minify HTML
+    def min(string, options={})
+      string = string.read if string.respond_to?(:read)
+
+      adapter = current_adapter(options)
+      if defined?(adapter::ParseError)
+        begin
+          adapter.min(string, options)
+        rescue adapter::ParseError => exception
+          raise ::MultiHtml::ParseError.new(exception.message, exception.backtrace)
+        end
+      else
+        adapter.min(string, options)
+      end
+    end
+
+  end
+end

data/lib/multi_html/adapters/html_compressor.rb

@@ -0,0 +1,11 @@
+require 'html_compressor' unless defined?(::HtmlCompressor)
+
+module MultiHtml
+  module Adapters
+    class HtmlCompressor
+      def self.min(text, options={}) #:nodoc:
+        ::HtmlCompressor.new(options).compress(text)
+      end
+    end
+  end
+end

data/lib/multi_html/adapters/html_min.rb

@@ -0,0 +1,11 @@
+require 'html_min' unless defined?(::HTMLMin)
+
+module MultiHtml
+  module Adapters
+    class HtmlMin
+      def self.min(text, options={}) #:nodoc:
+        ::HTMLMin.new.minimize(text)
+      end
+    end
+  end
+end

data/lib/multi_html/adapters/html_minifier.rb

@@ -0,0 +1,11 @@
+require 'html_minifier' unless defined?(::HtmlMinifier)
+
+module MultiHtml
+  module Adapters
+    class HtmlMinifier
+      def self.min(text, options=nil) #:nodoc:
+        ::HtmlMinifier.minify(text, options)
+      end
+    end
+  end
+end

data/lib/multi_html/adapters/html_press.rb

@@ -0,0 +1,11 @@
+require 'html_press' unless defined?(::HtmlPress)
+
+module MultiHtml
+  module Adapters
+    class HtmlPress
+      def self.min(text, options={}) #:nodoc:
+        ::HtmlPress.press(text, options)
+      end
+    end
+  end
+end

data/lib/multi_html/adapters/htmlcompressor.rb

@@ -0,0 +1,11 @@
+require 'htmlcompressor' unless defined?(::HtmlCompressor)
+
+module MultiHtml
+  module Adapters
+    class Htmlcompressor
+      def self.min(text, options={}) #:nodoc:
+        ::HtmlCompressor.Compressor.new(options).compile(text)
+      end
+    end
+  end
+end

data/lib/multi_html/adapters/htmlmin.rb

@@ -0,0 +1,11 @@
+require 'htmlmin' unless defined?(::HTMLMin)
+
+module MultiHtml
+  module Adapters
+    class Htmlmin
+      def self.min(text, options={}) #:nodoc:
+        ::HTMLMin.minify(text, options)
+      end
+    end
+  end
+end

data/lib/multi_html/filter.rb

@@ -0,0 +1,12 @@
+begin
+  require 'html/pipeline'
+
+  module MultiHtml
+    class Filter < ::HTML::Pipeline::TextFilter 
+      def call
+        MultiHtml.min(@text, context[:multi_html])
+      end
+    end
+  end
+rescue LoadError
+end

data/lib/multi_html/version.rb

@@ -0,0 +1,3 @@
+module MultiHtml
+  VERSION = "0.0.2"
+end

data/multi_html.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'multi_html/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "multi_html"
+  gem.version       = MultiHtml::VERSION
+  gem.authors       = ["sterebooster"]
+  gem.email         = ["stereobooster@gmail.com"]
+  gem.description   = %q{A generic swappable back-end for HTML minifiers}
+  gem.summary       = %q{A generic swappable back-end for HTML minifiers}
+  gem.homepage      = "https://github.com/stereobooster/multi_html"
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'html_press'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'simplecov'
+end

data/spec/adapter_shared_example.rb

@@ -0,0 +1,19 @@
+shared_examples_for "an adapter" do |adapter|
+
+  before do
+    begin
+      MultiHtml.use adapter
+    rescue LoadError
+      pending "Adapter #{adapter} couldn't be loaded (not installed?)"
+    end
+  end
+
+  describe '.min' do
+    it 'minify' do
+      MultiHtml.min(" <p>some text</p>").should eq '<p>some text</p>'
+    end
+
+    it 'support options'
+    
+  end
+end

data/spec/helper.rb

@@ -0,0 +1,19 @@
+def macruby?
+  defined?(RUBY_ENGINE) && RUBY_ENGINE == 'macruby'
+end
+
+unless ENV['CI'] || macruby?
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter 'spec'
+  end
+end
+
+require 'multi_html'
+require 'rspec'
+
+class MockDecoder
+  def self.min(string, options={})
+    ''
+  end
+end

data/spec/multi_html_spec.rb

@@ -0,0 +1,79 @@
+require 'helper'
+require 'adapter_shared_example'
+require 'stringio'
+
+describe MultiHtml do
+  context 'adapters' do
+    before do
+      MultiHtml.use nil
+    end
+    context 'when no other implementations are available' do
+
+      # :HtmlCompressor, :HTMLMin
+      CONSTS = [:HtmlPress, :HtmlMinifier]
+
+      before do
+        @old_map = MultiHtml::REQUIREMENT_MAP
+        @old_consts = {}
+        CONSTS.each do |c|
+          @old_consts[c] = Object.const_get c if Object.const_defined?(c)
+        end
+
+        MultiHtml::REQUIREMENT_MAP.each_with_index do |(library, adapter), index|
+          MultiHtml::REQUIREMENT_MAP[index] = ["foo/#{library}", adapter]
+        end
+
+        CONSTS.each do |c|
+           Object.send :remove_const, c if @old_consts[c]
+        end
+      end
+
+      after do
+        @old_map.each_with_index do |(library, adapter), index|
+          MultiHtml::REQUIREMENT_MAP[index] = [library, adapter]
+        end
+
+        CONSTS.each do |c|
+           Object.const_set c, @old_consts[c] if @old_consts[c]
+        end
+      end
+
+      it 'defaults to vendored implemention if no other implementions are available' do
+        MultiHtml.default_adapter.should eq :html_press
+      end
+    end
+
+    it 'defaults to the best not vendored lib if any other lib available' do
+      require 'html_minifier'
+      MultiHtml.adapter.name.should eq 'MultiHtml::Adapters::HtmlMinifier'
+    end
+
+    it 'is settable via a symbol' do
+      MultiHtml.use :html_minifier
+      MultiHtml.adapter.name.should eq 'MultiHtml::Adapters::HtmlMinifier'
+    end
+
+    it 'is settable via a class' do
+      MultiHtml.use MockDecoder
+      MultiHtml.adapter.name.should eq 'MockDecoder'
+    end
+  end
+
+  # html_compressor html_min htmlmin htmlcompressor
+  %w(html_press html_minifier).each do |adapter|
+    context adapter do
+      it_behaves_like "an adapter", adapter
+    end
+  end
+end
+
+if defined?(MultiHtml::Filter)
+  describe MultiHtml::Filter do
+    it "filter works" do
+      pipeline = HTML::Pipeline.new [
+        MultiHtml::Filter
+      ]
+      pipeline.call(" <p>some text</p>").should eq '<p>some text</p>'
+    end
+  end
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: multi_html
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- sterebooster
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: html_press
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A generic swappable back-end for HTML minifiers
+email:
+- stereobooster@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/multi_html.rb
+- lib/multi_html/adapters/html_compressor.rb
+- lib/multi_html/adapters/html_min.rb
+- lib/multi_html/adapters/html_minifier.rb
+- lib/multi_html/adapters/html_press.rb
+- lib/multi_html/adapters/htmlcompressor.rb
+- lib/multi_html/adapters/htmlmin.rb
+- lib/multi_html/filter.rb
+- lib/multi_html/version.rb
+- multi_html.gemspec
+- spec/adapter_shared_example.rb
+- spec/helper.rb
+- spec/multi_html_spec.rb
+homepage: https://github.com/stereobooster/multi_html
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -404139121
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -404139121
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A generic swappable back-end for HTML minifiers
+test_files:
+- spec/adapter_shared_example.rb
+- spec/helper.rb
+- spec/multi_html_spec.rb