multi_css 0.0.2 → 0.0.3

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/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "vendor/cssminify"]
+	path = vendor/cssminify
+	url = https://github.com/matthiassiegel/cssminify.git

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,9 @@
+source 'https://rubygems.org'
+
+gem 'css_press', :require => nil
+gem 'yuicssmin', :require => nil
+gem 'cssminify', :require => nil
+gem 'rainpress', :require => nil
+# gem 'yui-compressor', :require => nil, :platforms => [:ruby, :mingw, :mswin]
+
+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,43 @@
+# MultiCss [![Build Status](https://secure.travis-ci.org/stereobooster/multi_css.png?branch=master)](https://secure.travis-ci.org/#!/stereobooster/multi_css) [![Dependency Status](https://gemnasium.com/stereobooster/multi_css.png?travis)](https://gemnasium.com/stereobooster/multi_css) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/stereobooster/multi_css)
+
+There are lot of Ruby libraries to minify CSS.
+Instead of choosing a single implementation and forcing users of your library to be
+stuck with it, you can use MultiCss instead, which will simply choose the
+best available CSS minifier. Here's how to use it:
+
+```ruby
+require 'multi_css'
+
+MultiCss.min('a { color: red; }') #=> 'a{color:red}'
+```
+
+The `use` method, which sets the MultiCss adapter, takes either a symbol or a
+class (to allow for custom CSS minifier) that responds to `.min` at the class level.
+
+MultiCss 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:
+
+ - [css_press](https://github.com/stereobooster/css_press)
+ - [cssminify](https://github.com/matthiassiegel/cssminify)
+ - [yuicssmin](https://github.com/matthiassiegel/yuicssmin)
+ - [ruby-yui-compressor](https://github.com/sstephenson/ruby-yui-compressor). Doesn't test with travis-ci
+ - [rainpress](https://github.com/sprsquish/rainpress)
+
+If no other library is available, MultiCss falls back to vendored [cssminify](https://github.com/matthiassiegel/cssminify), a simple and reliable library.
+
+## 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,20 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+desc "Run all examples"
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+task :test => :spec
+
+namespace :doc do
+  require 'rdoc/task'
+  require File.expand_path('../lib/multi_css/version', __FILE__)
+  RDoc::Task.new do |rdoc|
+    rdoc.rdoc_dir = 'rdoc'
+    rdoc.title = "multi_css #{MultiCss::VERSION}"
+    rdoc.main = 'README.md'
+    rdoc.rdoc_files.include('README.md', 'LICENSE.md', 'lib/**/*.rb')
+  end
+end

data/lib/multi_css.rb

@@ -0,0 +1,119 @@
+require "multi_css/version"
+
+module MultiCss
+  class ParseError < StandardError
+    def initialize(message="", backtrace=[])
+      super(message)
+      self.set_backtrace(backtrace)
+    end
+  end
+
+  @adapter = nil
+  
+  REQUIREMENT_MAP = [
+    ["css_press", :css_press],
+    ["cssminify", :cssminify],
+    ["yuicssmin", :yuicssmin],
+    ["yui/compressor", :yui_compressor],
+    ["rainpress", :rainpress]
+  ]
+
+  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 :css_press if defined?(::CssPress)
+      return :cssminify if defined?(::CSSminify)      
+      return :yuicssmin if defined?(::Yuicssmin)
+      return :yui_compressor if defined?(::YUI::CssCompressor)
+      return :rainpress if defined?(::Rainpress)
+
+      REQUIREMENT_MAP.each do |(library, adapter)|
+        begin
+          require library
+          return adapter
+        rescue LoadError
+          next
+        end
+      end
+
+      Kernel.warn "[WARNING] MultiCss is using the default adapter."
+      :vendored
+    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>:css_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_css/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_css/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 CSS
+    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 ::MultiCss::ParseError.new(exception.message, exception.backtrace)
+        end
+      else
+        adapter.min(string, options)
+      end
+    end
+
+    # Minify partial CSS (as in style attribute)
+    def min_attr(string, options={})
+      min("a{#{string}}", options).gsub(/^a\{|\}$/, '')
+    end
+  end
+
+end

data/lib/multi_css/adapters/css_press.rb

@@ -0,0 +1,13 @@
+require 'css_press' unless defined?(::CssPress)
+
+module MultiCss
+  module Adapters
+    class CssPress
+      ParseError = ::Racc::ParseError
+
+      def self.min(text, options={}) #:nodoc:
+        ::CssPress.press(text, options)
+      end
+    end
+  end
+end

data/lib/multi_css/adapters/cssminify.rb

@@ -0,0 +1,12 @@
+require 'cssminify' unless defined?(::CSSminify)
+
+module MultiCss
+  module Adapters
+    class Cssminify
+      def self.min(text, options={}) #:nodoc:
+        length = options[:length] || 5000
+        ::CSSminify.compress(text, length)
+      end
+    end
+  end
+end

data/lib/multi_css/adapters/rainpress.rb

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

data/lib/multi_css/adapters/vendored.rb

@@ -0,0 +1,9 @@
+require File.expand_path('../../../../vendor/cssminify/lib/cssminify', __FILE__)
+require 'cssminify'
+
+module MultiCss
+  module Adapters
+    class Vendored < Cssminify
+    end
+  end
+end

data/lib/multi_css/adapters/yui_compressor.rb

@@ -0,0 +1,12 @@
+require 'yui/compressor' unless defined?(::YUI::CssCompressor)
+
+module MultiCss
+  module Adapters
+    class YuiCompressor
+      def self.min(text, options={}) #:nodoc:
+        compressor = ::YUI::CssCompressor.new options
+        compressor.compress text
+      end
+    end
+  end
+end

data/lib/multi_css/adapters/yuicssmin.rb

@@ -0,0 +1,14 @@
+require 'yuicssmin' unless defined?(::Yuicssmin)
+
+module MultiCss
+  module Adapters
+    class Yuicssmin
+      ParseError = ::ExecJS::RuntimeError
+
+      def self.min(text, options={}) #:nodoc:
+        length = options[:length] || 5000
+        ::Yuicssmin.compress(text, length)
+      end
+    end
+  end
+end

data/lib/multi_css/version.rb

@@ -0,0 +1,3 @@
+module MultiCss
+  VERSION = "0.0.3"
+end

data/multi_css.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_css/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "multi_css"
+  gem.version       = MultiCss::VERSION
+  gem.authors       = ["sterebooster"]
+  gem.email         = ["stereobooster@gmail.com"]
+  gem.description   = %q{A generic swappable back-end for CSS minification.}
+  gem.summary       = %q{A generic swappable back-end for CSS minification.}
+  gem.homepage      = "https://github.com/stereobooster/multi_css"
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.files        += `cd vendor/cssminify && git ls-files`.split($/).map{|f| 'vendor/cssminify/' + f}
+  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_development_dependency 'rake'
+  gem.add_development_dependency 'rdoc'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'simplecov'
+end

data/spec/adapter_shared_example.rb

@@ -0,0 +1,27 @@
+shared_examples_for "an adapter" do |adapter|
+
+  before do
+    begin
+      MultiCss.use adapter
+    rescue LoadError
+      pending "Adapter #{adapter} couldn't be loaded (not installed?)"
+    end
+  end
+
+  describe '.min' do
+    it 'minify' do
+      MultiCss.min("a { color: red;\n background: red ;  } ").should eq 'a{color:red;background:red}'
+      MultiCss.min_attr(" color: red;\n background: red ; ").should eq 'color:red;background:red'
+    end
+
+    if adapter == 'css_press'
+      it 'throws exception if parse error occurred' do
+        lambda { MultiCss.min('a{b:') }.should raise_error MultiCss::ParseError
+      end
+    else
+      it 'doesn\'t throw exception if parse error occurred' do
+        lambda { MultiCss.min('a{b:') }.should_not raise_error
+      end
+    end
+  end
+end

data/spec/helper.rb

@@ -0,0 +1,23 @@
+def jruby?
+  defined?(RUBY_ENGINE) && RUBY_ENGINE == 'jruby'
+end
+
+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_css'
+require 'rspec'
+
+class MockDecoder
+  def self.min(string, options={})
+    'a{color:red}'
+  end
+end

data/spec/multi_css_spec.rb

@@ -0,0 +1,72 @@
+require 'helper'
+require 'adapter_shared_example'
+require 'stringio'
+
+describe 'MultiCss' do
+  context 'adapters' do
+    before do
+      MultiCss.use nil
+    end
+    context 'when no other implementations are available' do
+
+      CONSTS = [:CssPress, :CSSminify, :Yuicssmin, :YUI, :Rainpress]
+
+      before do
+        @old_map = MultiCss::REQUIREMENT_MAP
+        @old_consts = {}
+        CONSTS.each do |c|
+          @old_consts[c] = Object.const_get c if Object.const_defined?(c)
+        end
+
+        MultiCss::REQUIREMENT_MAP.each_with_index do |(library, adapter), index|
+          MultiCss::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|
+          MultiCss::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
+        MultiCss.default_adapter.should eq :vendored
+      end
+
+      it 'prints a warning' do
+        Kernel.should_receive(:warn).with(/warning/i)
+        MultiCss.default_adapter
+      end
+    end
+
+    it 'defaults to the best available gem' do
+      require 'css_press'
+      MultiCss.adapter.name.should eq 'MultiCss::Adapters::CssPress'
+    end
+
+    it 'is settable via a symbol' do
+      MultiCss.use :cssminify
+      MultiCss.adapter.name.should eq 'MultiCss::Adapters::Cssminify'
+    end
+
+    it 'is settable via a class' do
+      MultiCss.use MockDecoder
+      MultiCss.adapter.name.should eq 'MockDecoder'
+    end
+  end
+
+  %w(css_press cssminify yuicssmin rainpress vendored).each do |adapter|
+    context adapter do
+      it_behaves_like "an adapter", adapter
+    end
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: multi_css
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -82,6 +82,25 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
+- .gitmodules
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/multi_css.rb
+- lib/multi_css/adapters/css_press.rb
+- lib/multi_css/adapters/cssminify.rb
+- lib/multi_css/adapters/rainpress.rb
+- lib/multi_css/adapters/vendored.rb
+- lib/multi_css/adapters/yui_compressor.rb
+- lib/multi_css/adapters/yuicssmin.rb
+- lib/multi_css/version.rb
+- multi_css.gemspec
+- spec/adapter_shared_example.rb
+- spec/helper.rb
+- spec/multi_css_spec.rb
 - vendor/cssminify/.gitignore
 - vendor/cssminify/.travis.yml
 - vendor/cssminify/CHANGES.md
@@ -204,7 +223,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 564547919
+      hash: -293339025
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -213,11 +232,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 564547919
+      hash: -293339025
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A generic swappable back-end for CSS minification.
-test_files: []
+test_files:
+- spec/adapter_shared_example.rb
+- spec/helper.rb
+- spec/multi_css_spec.rb