epic 0.0.2 → 0.0.3

data/History.txt

@@ -1,4 +1,8 @@
-== 0.0.1 2010-01-25
+== 0.0.3 2010-01-25
+  * major enhancements
+    * added YUI compressor to compress JavaScript and CSS
+
+== 0.0.2 2010-01-25
   * bug fixes
     * fixed path
 

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/epic.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{epic}
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jeff Coleman"]
@@ -30,13 +30,17 @@ Gem::Specification.new do |s|
      "bin/epic",
      "epic.gemspec",
      "lib/epic.rb",
-     "lib/file.rb",
+     "lib/epic/base.rb",
+     "lib/epic/compressor.rb",
+     "lib/epic/validator.rb",
+     "spec/compressor_spec.rb",
      "spec/epic_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb",
      "spec/stubs.rb",
      "vendor/ext/js.jar",
-     "vendor/ext/jslint.js"
+     "vendor/ext/jslint.js",
+     "vendor/ext/yuicompressor-2.4.2.jar"
   ]
   s.homepage = %q{http://github.com/progressions/epic}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -44,7 +48,8 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.5}
   s.summary = %q{Epic validation of HTML, JavaScript and CSS}
   s.test_files = [
-    "spec/epic_spec.rb",
+    "spec/compressor_spec.rb",
+     "spec/epic_spec.rb",
      "spec/spec_helper.rb",
      "spec/stubs.rb"
   ]

data/lib/epic.rb

@@ -2,160 +2,11 @@ dir = File.dirname(__FILE__)
 $LOAD_PATH.unshift dir unless $LOAD_PATH.include?(dir)
 
 require 'rubygems'
-require 'file'
+require 'f'
 require 'g'
 require 'active_support'
 require 'w3c_validators'
 
-module Epic
-  module Validator
-    class Configuration
-      attr_accessor :base_path, :tmp_path, :doctype, :jslint_settings
-    end
-    
-    class Base
-      class << self
-        def configuration
-          @@configuration ||= Epic::Validator::Configuration.new
-        end
-      
-        def configure
-          yield configuration
-        end
-      end
-
-      def configuration
-        self.class.configuration
-      end
-
-      # Parses out the <tt>base_path</tt> setting from a path to display it in a
-      # less verbose way.
-      #
-      def display_path(path)
-        path = File.expand_path(path)
-        path.gsub(base_path.to_s, "")
-      end
-      
-      def base_path      
-        configuration.base_path || ""
-      end
-      
-      def tmp_path
-        configuration.tmp_path || ""
-      end
-    end
-    
-    class HTML < Base
-      def validator
-        @validator ||= W3CValidators::MarkupValidator.new
-      end
-      
-      def validate(path)
-        $stdout.print "   #{path}  validating . . . "
-        
-        doctype = configuration.doctype || "HTML 4.01 Transitional"
-        validator.set_doctype!(doctype)
-
-        results = validator.validate_file(path)
-        
-        valid = results.errors.length <= 0
-        
-        if valid
-          $stdout.puts "OK"
-        else
-          $stdout.puts "validation errors"
-          results.errors.each do |err|
-            $stdout.puts
-            $stdout.puts err.to_s
-          end
-        end
-        
-        valid
-      end
-    end
-    
-    class JavaScript < Base
-      def use_jslint_settings?
-        !jslint_settings.blank?
-      end
-      
-      def jslint_settings
-        configuration.jslint_settings
-      end
-      
-      def jslint_settings_count
-        jslint_settings.to_s.split("\n").size
-      end
-      
-      def pre_process(content)
-        content
-      end
-    
-      def validate(path)
-        display = display_path(path)
-        $stdout.print "   #{display}  validating . . . "
-        output = ""
-      
-        File.open(path) do |f|
-          output = f.read
-        end
-        
-        output = pre_process(output)
-        
-        FileUtils.mkdir_p(tmp_path)
-        
-        js_fragment_path = File.expand_path("#{tmp_path}/#{File.basename(path)}_fragment")
-        fragment_display_path = display_path(js_fragment_path)
-    
-        if File.exists?(js_fragment_path)
-          puts "That already exists?"
-        else
-          File.open(js_fragment_path,'w') do |f|
-            f.puts jslint_settings if use_jslint_settings?
-            f.puts output
-          end
-
-          jslint_path = File.expand_path("#{File.dirname(__FILE__)}/../vendor/ext/jslint.js")
-          raise "#{jslint_path} does not exist" unless File.exists?(jslint_path)
-          rhino_path = File.expand_path("#{File.dirname(__FILE__)}/../vendor/ext/js.jar")
-          raise "#{rhino_path} does not exist" unless File.exists?(rhino_path)
-          
-          results = F.execute("java -jar #{rhino_path} #{jslint_path} #{js_fragment_path}", :return => true)
-
-          if results =~ /jslint: No problems found/
-            $stdout.puts "OK"
-          else
-            $stdout.puts "errors found!"
-            results.split("\n").each do |result|
-              if result =~ /line (\d+) character (\d+): (.*)/
-                line_number = $1.to_i
-                error = "Error at #{fragment_display_path} line #{line_number-jslint_settings_count} character #{$2}: #{$3}"
-                error += F.get_line_from_file(js_fragment_path, line_number)
-          
-                $stdout.puts error
-              end
-            end
-            message = "JavaScript Errors embedded in #{display}"
-            g(message)
-            raise message
-          end
-        end
-      end
-    end
-    
-    class JSON < JavaScript
-      def pre_process(output)
-        output
-      end
-      
-      def jslint_settings
-      end
-    end
-    
-    class Stylesheet < Base
-      def validate(filename)
-        true
-      end
-    end
-  end
-end
+require 'epic/base'
+require 'epic/validator'
+require 'epic/compressor'

data/lib/epic/base.rb

@@ -0,0 +1,49 @@
+module Epic #:nodoc
+  class Configuration
+    attr_accessor :base_path, :tmp_path, :doctype, :jslint_settings
+  end
+  
+  class Base
+    class << self
+      def configuration
+        @@configuration ||= Epic::Configuration.new
+      end
+    
+      def configure
+        yield configuration
+      end
+
+      # Parses out the <tt>base_path</tt> setting from a path to display it in a
+      # less verbose way.
+      #
+      def display_path(path)
+        path = File.expand_path(path)
+        path.gsub(base_path.to_s, "")
+      end
+      
+      def base_path
+        configuration.base_path
+      end
+    end
+
+    def configuration
+      self.class.configuration
+    end
+
+    # Parses out the <tt>base_path</tt> setting from a path to display it in a
+    # less verbose way.
+    #
+    def display_path(path)
+      path = File.expand_path(path)
+      path.gsub(base_path.to_s, "")
+    end
+    
+    def base_path      
+      configuration.base_path || ""
+    end
+    
+    def tmp_path
+      configuration.tmp_path || ""
+    end
+  end
+end

data/lib/epic/compressor.rb

@@ -0,0 +1,126 @@
+module Epic #:nodoc:
+  module Compressor #:nodoc:
+    # Compresses a file using the specified compressor/minifier (currently YUI Compressor 2.4.2).
+    #
+    # === Usage
+    #
+    #   Epic::Compressor::Base.compress("filename.js", "type" => "js")
+    #
+    #   Epic::Compressor::Base.compress("filename.css", "type" => "css")
+    #
+    # Outputs the compressed file to <tt>_path_.min.</tt>
+    #
+    # === Options
+    # 
+    #   "type"::              "js" or "css". Identifies the file type.
+    #
+    #   "obfuscate"::         true or false. Change internal variable names within the code.
+    #                         
+    #   "verbose"::           true or false. Output warnings about code quality.
+    #
+    #   "preserve_semi"::     true or false. Preserve unnecessary semicolons.
+    #
+    # TODO: Make it support multiple compressors.
+    #
+    # TODO: Convert it to an object, so you instantiate the Compressor class and then call it
+    # on a file or a string.
+    #
+    # TODO: Get some stringify_keys! action going so you can send in symbols or strings.
+    #
+    class Base < Epic::Base
+      def self.compress(path, options={})
+        options.stringify_keys!
+        compressed_display_path = display_path(path)
+        compressed_path = "#{path}.min"
+      
+        options["type"] ||= "js"
+        options["type"] = options["type"].to_s
+        
+        # if the compressed_file exists, don't create it again
+        #
+        unless File.exists?(compressed_path)
+          $stdout.print "   #{compressed_display_path}  compressing . . . "
+          compressed = ''
+        
+          # set options and defaults
+          #
+          if options.delete("obfuscate")
+            options["nomunge"] = ""
+          end
+          if options.delete("verbose")
+            options["verbose"] = ""
+          end
+          options["charset"] = "utf-8"
+        
+          if options["type"].to_s == "js" && !options["preserve_semi"]
+            options["preserve-semi"] = ""
+          end
+        
+          # join the options together for appending to the command line
+          #
+          options_string = options.map {|k,v| "--#{k} #{v}"}.join(" ")
+      
+          # call the compressor
+          #
+          compressor_path = File.expand_path("#{File.dirname(__FILE__)}/../../vendor/ext/yuicompressor-2.4.2.jar")
+          raise "#{compressor_path} does not exist" unless File.exists?(compressor_path)
+          
+          command = "java -jar #{compressor_path} #{options_string} #{path} -o #{compressed_path} 2>&1"
+          result = F.execute(command, :return => true)
+        
+          result.split("\n").each do |line|
+            if line =~ /\[ERROR\] (\d+):(\d+):(.*)/
+              line_number = $1.to_i
+              error = "Error at #{compressed_display_path} line #{line_number} character #{$2}: #{$3}"
+              error += F.get_line_from_file(path, line_number)
+        
+              $stdout.puts error
+              g(error)
+            end
+          end
+          
+          if result =~ /ERROR/
+            raise "JavaScript errors in #{compressed_display_path}"
+          else
+            $stdout.puts "OK"
+          end
+        end
+
+        # The compressed file should exist now. If it does, use it. If not, raise an error.
+        #
+        if File.exists?(compressed_path)
+          compressed = File.read(compressed_path)
+        else
+          raise "File does not exist: #{compressed_display_path}"
+        end
+      
+        compressed      
+      end
+    end
+    
+    # Compresses a CSS file using the specified compressor/minifier (currently YUI Compressor 2.4.2).
+    #
+    # === Usage
+    #
+    #   Epic::Compressor::Stylesheet.compress("filename.css")
+    #
+    class Stylesheet < Base
+      def self.compress(path)
+        super(path, "type" => "css")
+      end
+    end
+    
+    # Compresses a JavaScript file using the specified compressor/minifier (currently YUI Compressor 2.4.2).
+    #
+    # === Usage
+    #
+    #   Epic::Compressor::JavaScript.compress("filename.js")
+    #
+    class JavaScript < Base
+      # TODO: Add options hash   
+      def self.compress(filename)
+        super(filename, "type" => "js")
+      end
+    end
+  end
+end

data/lib/epic/validator.rb

@@ -0,0 +1,118 @@
+require 'epic/base'
+
+module Epic
+  module Validator
+    class HTML < Epic::Base
+      def validator
+        @validator ||= W3CValidators::MarkupValidator.new
+      end
+      
+      def validate(path)
+        $stdout.print "   #{path}  validating . . . "
+        
+        doctype = configuration.doctype || "HTML 4.01 Transitional"
+        validator.set_doctype!(doctype)
+
+        results = validator.validate_file(path)
+        
+        valid = results.errors.length <= 0
+        
+        if valid
+          $stdout.puts "OK"
+        else
+          $stdout.puts "validation errors"
+          results.errors.each do |err|
+            $stdout.puts
+            $stdout.puts err.to_s
+          end
+        end
+        
+        valid
+      end
+    end
+    
+    class JavaScript < Base
+      def use_jslint_settings?
+        !jslint_settings.blank?
+      end
+      
+      def jslint_settings
+        configuration.jslint_settings
+      end
+      
+      def jslint_settings_count
+        jslint_settings.to_s.split("\n").size
+      end
+      
+      def pre_process(content)
+        content
+      end
+    
+      def validate(path)
+        display = display_path(path)
+        $stdout.print "   #{display}  validating . . . "
+        output = ""
+      
+        File.open(path) do |f|
+          output = f.read
+        end
+        
+        output = pre_process(output)
+        
+        FileUtils.mkdir_p(tmp_path)
+        
+        js_fragment_path = File.expand_path("#{tmp_path}/#{File.basename(path)}_fragment")
+        fragment_display_path = display_path(js_fragment_path)
+    
+        if File.exists?(js_fragment_path)
+          puts "That already exists?"
+        else
+          File.open(js_fragment_path,'w') do |f|
+            f.puts jslint_settings if use_jslint_settings?
+            f.puts output
+          end
+
+          jslint_path = File.expand_path("#{File.dirname(__FILE__)}/../../vendor/ext/jslint.js")
+          raise "#{jslint_path} does not exist" unless File.exists?(jslint_path)
+          rhino_path = File.expand_path("#{File.dirname(__FILE__)}/../../vendor/ext/js.jar")
+          raise "#{rhino_path} does not exist" unless File.exists?(rhino_path)
+          
+          results = F.execute("java -jar #{rhino_path} #{jslint_path} #{js_fragment_path}", :return => true)
+
+          if results =~ /jslint: No problems found/
+            $stdout.puts "OK"
+          else
+            $stdout.puts "errors found!"
+            results.split("\n").each do |result|
+              if result =~ /line (\d+) character (\d+): (.*)/
+                line_number = $1.to_i
+                error = "Error at #{fragment_display_path} line #{line_number-jslint_settings_count} character #{$2}: #{$3}"
+                error += F.get_line_from_file(js_fragment_path, line_number)
+          
+                $stdout.puts error
+              end
+            end
+            message = "JavaScript Errors embedded in #{display}"
+            g(message)
+            raise message
+          end
+        end
+      end
+    end
+    
+    class JSON < JavaScript
+      def pre_process(output)
+        output
+      end
+      
+      def jslint_settings
+      end
+    end
+    
+    class Stylesheet < Base
+      def validate(filename)
+        true
+      end
+    end
+  end
+end

data/spec/compressor_spec.rb

@@ -0,0 +1,127 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Compressor" do
+  before(:each) do
+    stub_io
+    File.stub!(:exists?).with(/yuicompressor/).and_return(true)
+  end
+  
+  describe "Base" do
+    it "should use the compressed file if it already exists" do
+      File.stub!(:exists?).with(/file.js/).and_return(true)
+      @file = "compressed file"
+      File.stub(:read).and_return(@file)
+      Epic::Compressor::Base.compress("file.js", "type" => "js").should == @file
+    end
+    
+    describe "generate a compressed file if one doesn't exist" do
+      before(:each) do
+        File.stub!(:exists?).with(/file.js/).and_return(false, true)
+        File.stub!(:exists?).with(/file.css/).and_return(false, true)
+      end
+      
+      it "should log what it's doing" do
+        $stdout.should_receive(:print).with(/file.js  compressing . . ./)
+        Epic::Compressor::Base.compress("file.js", "type" => "js")
+      end
+      
+      it "should run the compressor" do
+        F.should_receive(:execute).with(/yuicompressor/, :return => true).and_return("")
+        Epic::Compressor::Base.compress("file.js", "type" => "js")
+      end
+      
+      describe "options" do
+        it "should set nomunge" do
+          F.should_receive(:execute).with(/nomunge/, :return => true).and_return("")
+          Epic::Compressor::Base.compress("file.js", "type" => "js", "obfuscate" => true)
+        end
+      
+        it "should not set nomunge" do
+          F.stub!(:execute).with(/yuicompressor/, :return => true).and_return("")
+          F.should_not_receive(:execute).with(/nomunge/, :return => true).and_return("")
+          Epic::Compressor::Base.compress("file.js", "type" => "js", "obfuscate" => false)
+        end
+      
+        it "should set verbose" do
+          F.should_receive(:execute).with(/verbose/, :return => true).and_return("")
+          Epic::Compressor::Base.compress("file.js", "type" => "js", "verbose" => true)
+        end
+      
+        it "should not set verbose" do
+          F.stub!(:execute).with(/yuicompressor/, :return => true).and_return("")
+          F.should_not_receive(:execute).with(/verbose/, :return => true).and_return("")
+          Epic::Compressor::Base.compress("file.js", "type" => "js", "verbose" => false)
+        end
+      
+        it "should set preserve-semi on javascript" do
+          F.should_receive(:execute).with(/preserve-semi/, :return => true).and_return("")
+          Epic::Compressor::Base.compress("file.js", "type" => "js")
+        end
+      
+        it "should not set preserve-semi on css" do
+          File.stub!(:exists?).with(/file.css/).and_return(true)
+          F.stub!(:execute).with(/yuicompressor/, :return => true).and_return("")
+          F.should_not_receive(:execute).with(/preserve-semi/, :return => true).and_return("")
+          Epic::Compressor::Base.compress("file.css", "type" => "css")
+        end
+      end
+      
+      describe "on errors" do
+        before(:each) do
+          F.stub!(:execute).with(/yuicompressor/, :return => true).and_return("[ERROR] 12:13: Too much fruzzlegump")
+        end
+        
+        it "should raise an exception" do
+          lambda {
+            Epic::Compressor::Base.compress("file.js", "type" => "js")
+          }.should raise_error(/JavaScript errors/)
+        end
+        
+        it "should growl" do
+          @g.should_receive(:notify)
+          lambda {
+            Epic::Compressor::Base.compress("file.js", "type" => "js")
+          }.should raise_error(/JavaScript errors/)
+        end
+        
+        it "should show the source code" do
+          F.should_receive(:get_line_from_file).with("file.js", 12).and_return("")
+          lambda {
+            Epic::Compressor::Base.compress("file.js", "type" => "js")
+          }.should raise_error(/JavaScript errors/)
+        end
+      end
+      
+      it "should report OK" do
+        $stdout.should_receive(:puts).with("OK")
+        Epic::Compressor::Base.compress("file.js", "type" => "js")
+      end
+      
+      it "should raise an error if the compressed file doesn't exist" do
+        # File.stub!(:exists?).with(/file.js/).and_return(true)
+        # File.stub!(:exists?).with(/file.js.min/).and_return(false)
+        # lambda {
+          Epic::Compressor::Base.compress("file.js", "type" => "js")
+        # }.should raise_error(/File does not exist/)
+      end
+    end
+  end
+  
+  describe "JavaScript" do
+    it "should call Base with type js" do
+      File.stub(:exists?).with(/file.js/).and_return(true)
+      @file = "compressed file"
+      File.stub(:read).and_return(@file)
+      Epic::Compressor::JavaScript.compress("file.js").should == @file
+    end
+  end
+  
+  describe "Stylesheet" do
+    it "should call Base with type css" do
+      File.stub(:exists?).with(/file.css/).and_return(true)
+      @file = "compressed file"
+      File.stub(:read).and_return(@file)
+      Epic::Compressor::Stylesheet.compress("file.css").should == @file
+    end
+  end
+end

data/spec/epic_spec.rb

@@ -81,7 +81,7 @@ describe "Validator" do
       end
       
       it "should set jslint settings" do
-        Epic::Validator::JavaScript.configure do |config|
+        Epic::Base.configure do |config|
           config.jslint_settings = @jslint_settings
         end
         Epic::Validator::JavaScript.new.jslint_settings.should == @jslint_settings

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: epic
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Jeff Coleman
@@ -63,13 +63,17 @@ files:
 - bin/epic
 - epic.gemspec
 - lib/epic.rb
-- lib/file.rb
+- lib/epic/base.rb
+- lib/epic/compressor.rb
+- lib/epic/validator.rb
+- spec/compressor_spec.rb
 - spec/epic_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 - spec/stubs.rb
 - vendor/ext/js.jar
 - vendor/ext/jslint.js
+- vendor/ext/yuicompressor-2.4.2.jar
 has_rdoc: true
 homepage: http://github.com/progressions/epic
 licenses: []
@@ -99,6 +103,7 @@ signing_key:
 specification_version: 3
 summary: Epic validation of HTML, JavaScript and CSS
 test_files: 
+- spec/compressor_spec.rb
 - spec/epic_spec.rb
 - spec/spec_helper.rb
 - spec/stubs.rb

data/lib/file.rb

@@ -1,63 +0,0 @@
-# Provides a wrapper around common calls that interact with the file system.
-#
-module F
-
-  module_function
-
-  # Concatenates together the contents of all the files in the <tt>source_path</tt> 
-  # into the <tt>destination_path</tt>.
-  #
-  def concat_files(source_path, destination_path)
-    File.open(destination_path, "a") do |output|
-      Dir[source_path].each do |path|
-        output.puts File.read(path)
-      end
-    end
-  end
-
-  # Saves the <tt>output</tt> string to the <tt>destination_path</tt> given.
-  #
-  # Returns <tt>true</tt> if the destination file was newly created, <tt>false</tt> if
-  # it already existed.
-  #
-  def save_to_file(output, destination_path)
-    if File.exists?(destination_path)      
-      false
-    else
-      File.open(destination_path, "w") do |w|
-        w.write(output)
-      end
-      true
-    end
-  end
-
-  # Given a <tt>path</tt> and <tt>line_number</tt>, returns the line and two lines previous
-  #
-  # Used for displaying validation errors.
-  #
-  def get_line_from_file(path, line_number)
-    line_number = line_number.to_i
-    output = "\n"
-    lines = File.readlines(path)
-
-    3.times do |i|
-      line = lines[line_number-(3-i)]
-      output += line if line
-    end
-
-    output += "\n"
-    output
-  end
-
-  # Execute a system command. If the parameter <tt>:return</tt> is true, execute the command
-  # with the backtick (`) command and return the results.  Otherwise, just execute the command
-  # and let the output go to the screen.
-  #
-  def execute(command, params={})
-    if params[:return]
-      `#{command}`
-    else
-      Kernel.system command
-    end
-  end
-end