yui-compressor 0.9.0

data/Rakefile

@@ -0,0 +1,21 @@
+require "rubygems"
+require "rake/gempackagetask"
+require "rake/rdoctask"
+require "rake/testtask"
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs << "lib test"
+  t.test_files = FileList["test/*_test.rb"]
+  t.verbose = true
+end
+
+Rake::RDocTask.new do |t|
+  t.rdoc_files.include("README.rdoc", "lib/**/*.rb")
+end
+
+Rake::GemPackageTask.new(eval(IO.read(File.join(File.dirname(__FILE__), "yui-compressor.gemspec")))) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar = true
+end

data/lib/yui/compressor.rb

@@ -0,0 +1,199 @@
+require "open3"
+require "stringio"
+
+module YUI #:nodoc:
+  class Compressor
+    class Error < StandardError; end
+    class OptionError   < Error; end
+    class RuntimeError  < Error; end
+    
+    attr_reader :options, :command
+    
+    def self.default_options #:nodoc:
+      { :charset => "utf-8", :line_break => nil }
+    end
+
+    def self.compressor_type #:nodoc:
+      raise Error, "create a CssCompressor or JavaScriptCompressor instead"
+    end
+
+    def initialize(options = {}) #:nodoc:
+      @options = self.class.default_options.merge(options)
+      @command = [path_to_java, "-jar", path_to_jar_file, *(command_option_for_type + command_options)]
+    end
+    
+    # Compress a stream or string of code with YUI Compressor. (A stream is
+    # any object that responds to +read+ and +close+ like an IO.) If a block
+    # is given, you can read the compressed code from the block's argument.
+    # Otherwise, +compress+ returns a string of compressed code.
+    #
+    # ==== Example: Compress CSS
+    #   compressor = YUI::CssCompressor.new
+    #   compressor.compress(<<-END_CSS)
+    #     div.error {
+    #       color: red;
+    #     }
+    #     div.warning {
+    #       display: none;
+    #     }
+    #   END_CSS
+    #   # => "div.error{color:red;}div.warning{display:none;}"
+    #
+    # ==== Example: Compress JavaScript
+    #   compressor = YUI::JavaScriptCompressor.new
+    #   compressor.compress('(function () { var foo = {}; foo["bar"] = "baz"; })()')
+    #   # => "(function(){var foo={};foo.bar=\"baz\"})();"
+    #
+    # ==== Example: Compress and gzip a file on disk
+    #   File.open("my.js", "r") do |source|
+    #     Zlib::GzipWriter.open("my.js.gz", "w") do |gzip|
+    #       compressor.compress(source) do |compressed|
+    #         while buffer = compressed.read(4096)
+    #           gzip.write(buffer)
+    #         end
+    #       end
+    #     end
+    #   end
+    #
+    def compress(stream_or_string)
+      streamify(stream_or_string) do |stream|
+        Open3.popen3(*command) do |stdin, stdout, stderr|
+          begin
+            transfer(stream, stdin)
+            
+            if block_given?
+              yield stdout
+            else
+              stdout.read
+            end
+            
+          rescue Exception => e
+            raise RuntimeError, "compression failed"
+          end
+        end
+      end
+    end
+    
+    private
+      def command_options
+        options.inject([]) do |command_options, (name, argument)|
+          method = "command_option_for_#{name}"
+          if private_methods.include?(method)
+            command_options.concat(send(method, argument))
+          else
+            raise OptionError, "undefined option #{name.inspect}"
+          end
+        end
+      end
+
+      def path_to_java
+        options.delete(:java) || "java"
+      end
+
+      def path_to_jar_file
+        options.delete(:jar_file) || File.join(File.dirname(__FILE__), *%w".. .. vendor yuicompressor-2.4.2.jar")
+      end
+
+      def streamify(stream_or_string)
+        if stream_or_string.respond_to?(:read)
+          yield stream_or_string
+        else
+          yield StringIO.new(stream_or_string.to_s)
+        end
+      end
+      
+      def transfer(from_stream, to_stream)
+        while buffer = from_stream.read(4096)
+          to_stream.write(buffer)
+        end
+        to_stream.close
+      end
+      
+      def command_option_for_type
+        ["--type", self.class.compressor_type.to_s]
+      end
+
+      def command_option_for_charset(charset)
+        ["--charset", charset.to_s]
+      end
+      
+      def command_option_for_line_break(line_break)
+        line_break ? ["--line-break", line_break.to_s] : []
+      end
+  end
+  
+  class CssCompressor < Compressor
+    def self.compressor_type #:nodoc:
+      "css"
+    end
+    
+    # Creates a new YUI::CssCompressor for minifying CSS code.
+    #
+    # Options are:
+    #
+    # <tt>:charset</tt>::    Specifies the character encoding to use. Defaults to 
+    #                        <tt>"utf-8"</tt>.
+    # <tt>:line_break</tt>:: By default, CSS will be compressed onto a single
+    #                        line. Use this option to specify the maximum 
+    #                        number of characters in each line before a newline
+    #                        is added. If <tt>:line_break</tt> is 0, a newline
+    #                        is added after each CSS rule.
+    #
+    def initialize(options = {})
+      super
+    end
+  end
+  
+  class JavaScriptCompressor < Compressor
+    def self.compressor_type #:nodoc:
+      "js"
+    end
+    
+    def self.default_options #:nodoc:
+      super.merge(
+        :munge    => false,
+        :optimize => true,
+        :preserve_semicolons => false
+      )
+    end
+    
+    # Creates a new YUI::JavaScriptCompressor for minifying JavaScript code.
+    #
+    # Options are:
+    #
+    # <tt>:charset</tt>::    Specifies the character encoding to use. Defaults to 
+    #                        <tt>"utf-8"</tt>.
+    # <tt>:line_break</tt>:: By default, JavaScript will be compressed onto a 
+    #                        single line. Use this option to specify the
+    #                        maximum number of characters in each line before a
+    #                        newline is added. If <tt>:line_break</tt> is 0, a 
+    #                        newline is added after each JavaScript statement.
+    # <tt>:munge</tt>::      Specifies whether YUI Compressor should shorten local
+    #                        variable names when possible. Defaults to +false+.
+    # <tt>:optimize</tt>::   Specifies whether YUI Compressor should optimize
+    #                        JavaScript object property access and object literal
+    #                        declarations to use as few characters as possible.
+    #                        Defaults to +true+.
+    # <tt>:preserve_semicolons</tt>:: Defaults to +false+. If +true+, YUI 
+    #                                 Compressor will ensure semicolons exist 
+    #                                 after each statement to appease tools like 
+    #                                 JSLint.
+    #
+    def initialize(options = {})
+      super
+    end
+
+    private
+      def command_option_for_munge(munge)
+        munge ? [] : ["--nomunge"]
+      end
+    
+      def command_option_for_optimize(optimize)
+        optimize ? [] : ["--disable-optimizations"]
+      end
+    
+      def command_option_for_preserve_semicolons(preserve_semicolons)
+        preserve_semicolons ? ["--preserve-semi"] : []
+      end
+  end
+end

data/test/compressor_test.rb

@@ -0,0 +1,94 @@
+require "test/unit"
+require "yui/compressor"
+
+module YUI
+  class CompressorTest < Test::Unit::TestCase
+    FIXTURE_CSS = <<-END_CSS
+      div.warning {
+        display: none;
+      }
+      
+      div.error {
+        background: red;
+        color: white;
+      }
+    END_CSS
+
+    FIXTURE_JS = <<-END_JS
+      // here's a comment
+      var Foo = { "a": 1 };
+      Foo["bar"] = (function(baz) {
+        /* here's a
+           multiline comment */
+        if (false) {
+          doSomething();
+        } else {
+          for (var index = 0; index < baz.length; index++) {
+            doSomething(baz[index]);
+          }
+        }
+      })("hello");
+    END_JS
+    
+    def test_compressor_should_raise_when_instantiated
+      assert_raises YUI::Compressor::Error do
+        YUI::Compressor.new
+      end
+    end
+    
+    def test_css_should_be_compressed
+      @compressor = YUI::CssCompressor.new
+      assert_equal "div.warning{display:none;}div.error{background:red;color:white;}", @compressor.compress(FIXTURE_CSS)
+    end
+    
+    def test_js_should_be_compressed
+      @compressor = YUI::JavaScriptCompressor.new
+      assert_equal "var Foo={a:1};Foo.bar=(function(baz){if(false){doSomething()}else{for(var index=0;index<baz.length;index++){doSomething(baz[index])}}})(\"hello\");", @compressor.compress(FIXTURE_JS)
+    end
+        
+    def test_compress_should_raise_when_an_unknown_option_is_specified
+      assert_raises YUI::Compressor::OptionError do
+        @compressor = YUI::CssCompressor.new(:foo => "bar")
+        @compressor.compress(FIXTURE_JS)
+      end
+    end
+
+    def test_compress_should_accept_an_io_argument
+      @compressor = YUI::CssCompressor.new
+      assert_equal "div.warning{display:none;}div.error{background:red;color:white;}", @compressor.compress(StringIO.new(FIXTURE_CSS))
+    end
+    
+    def test_compress_should_accept_a_block_and_yield_an_io
+      @compressor = YUI::CssCompressor.new
+      @compressor.compress(FIXTURE_CSS) do |stream|
+        assert_kind_of IO, stream
+        assert_equal "div.warning{display:none;}div.error{background:red;color:white;}", stream.read
+      end
+    end
+    
+    def test_line_break_option_should_insert_line_breaks_in_css
+      @compressor = YUI::CssCompressor.new(:line_break => 0)
+      assert_equal "div.warning{display:none;}\ndiv.error{background:red;color:white;}", @compressor.compress(FIXTURE_CSS)
+    end
+    
+    def test_line_break_option_should_insert_line_breaks_in_js
+      @compressor = YUI::JavaScriptCompressor.new(:line_break => 0)
+      assert_equal "var Foo={a:1};\nFoo.bar=(function(baz){if(false){doSomething()\n}else{for(var index=0;\nindex<baz.length;\nindex++){doSomething(baz[index])\n}}})(\"hello\");", @compressor.compress(FIXTURE_JS)
+    end
+    
+    def test_munge_option_should_munge_local_variable_names
+      @compressor = YUI::JavaScriptCompressor.new(:munge => true)
+      assert_equal "var Foo={a:1};Foo.bar=(function(b){if(false){doSomething()}else{for(var a=0;a<b.length;a++){doSomething(b[a])}}})(\"hello\");", @compressor.compress(FIXTURE_JS)
+    end
+    
+    def test_optimize_option_should_not_modify_property_accesses_or_object_literal_keys_when_false
+      @compressor = YUI::JavaScriptCompressor.new(:optimize => false)
+      assert_equal "var Foo={\"a\":1};Foo[\"bar\"]=(function(baz){if(false){doSomething()}else{for(var index=0;index<baz.length;index++){doSomething(baz[index])}}})(\"hello\");", @compressor.compress(FIXTURE_JS)
+    end
+
+    def test_preserve_semicolons_option_should_preserve_semicolons
+      @compressor = YUI::JavaScriptCompressor.new(:preserve_semicolons => true)
+      assert_equal "var Foo={a:1};Foo.bar=(function(baz){if(false){doSomething();}else{for(var index=0;index<baz.length;index++){doSomething(baz[index]);}}})(\"hello\");", @compressor.compress(FIXTURE_JS)
+    end
+  end
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification 
+name: yui-compressor
+version: !ruby/object:Gem::Version 
+  version: 0.9.0
+platform: ruby
+authors: 
+- Sam Stephenson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-20 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: A Ruby interface to YUI Compressor for minifying JavaScript and CSS assets.
+email: sstephenson@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- lib/yui/compressor.rb
+- test/compressor_test.rb
+- vendor/yuicompressor-2.4.2.jar
+has_rdoc: true
+homepage: http://github.com/sstephenson/ruby-yui-compressor/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: yui
+rubygems_version: 1.3.3
+signing_key: 
+specification_version: 3
+summary: JavaScript and CSS minification library
+test_files: []
+