mack-asset_packager 0.8.0

data/README

@@ -0,0 +1,25 @@
+Asset Packager
+===========================================================
+
+Summary:
+Allow application to bundle up (and compress) asset files and include the compressed file in the view.
+This will make the application more efficient, because the browser won't need to make multiple 
+request for each single asset files.
+The packaging/compression will only be performed in production mode, or when configatron.mack.asset_packager.disable_bundle_merge is not set.
+
+Usage:
+First you will need to define asset group/bundle that you want to package up by doing the following:
+1. Create an assets.rb file in config/initializers folder
+2. In that file do the following:
+    assets_mgr.my_bundle_1 do |a|
+        a.add_js "foo.js"
+        a.add_js "jquery"
+        a.add_css "scaffold"
+    end
+   So the above code will create a new bundle called my_bundle_1, and in that group, you'll add 2 javascript files and 1 css file.
+3. Once you have that defined, next step would be in your layout file (or whereever you refer to the asset file):
+    <%= stylesheet 'my_bundle_1 %>
+    <%= javascript 'my_bundle_1 %>
+4. That's it.  When run in development mode, the javascript tag will be evaluated into 4 <script> tags, and the stylesheet scriptlet
+   will get evaluated into 1 <stylesheet> tag.  In production (assuming disable_bundle_merge configuration is not set), then 
+   each scriptlet tag will get evaluated into 1 tag (each will refer to the packaged and compressed asset file)

data/lib/mack-asset_packager.rb

@@ -0,0 +1,14 @@
+fl = File.join(File.dirname(__FILE__), "mack-asset_packager")
+
+[:package_collection, :link_helpers, :cssmin].each do |f|
+  file = File.join(fl, "#{f}.rb")
+  # puts "requiring #{file}"
+  require file
+end
+
+# default configuration
+if Mack.env == "production"
+  configatron.mack.assets.set_default(:enable_bundle_merge, true)
+else
+  configatron.mack.assets.set_default(:enable_bundle_merge, false)
+end

data/lib/mack-asset_packager/cssmin.rb

@@ -0,0 +1,49 @@
+class CSSMin
+  
+  attr_accessor :data
+  def initialize(content)
+    self.data = content
+  end
+  
+  def minimize
+    # find all elements in between { and }, and remove \n and \t
+    # self.data.scan(/\{([.|\s\S]*?)\}/).flatten.each do |elt|
+    #   str = elt.gsub("\n", "")
+    #   str = str.gsub("\t", "")
+    #   self.data.gsub!(elt, str)
+    # end
+    
+    self.data = self.data.squeeze(" ").squeeze("\t").squeeze("\n")
+    self.data.gsub!("\t", "")
+    
+    # remove comments in the form of /* ... */ 
+    self.data.gsub!(/\/\*[.|\s|\S]*?\*\//, "")
+    
+    # remove newline before and after {
+    self.data.gsub!("\n\{", " \{")
+    self.data.gsub!("\{\n", " \{")
+    
+    # remove newline after ,
+    self.data.gsub!(",\n", ", ")
+    
+    # remove spaces after/before ...
+    self.data.gsub!(": ", ":")
+    self.data.gsub!(" :", ":")
+    self.data.gsub!(", ", ",")
+    self.data.gsub!(" ,", ",")
+    self.data.gsub!("; ", ";")
+    self.data.gsub!(" ;", ";")
+    self.data.gsub!(";\}", "\}")
+    self.data.gsub!(" \}", "\}")
+    self.data.gsub!("\{ ", "\{")
+    self.data.gsub!(" \{", "\{")
+        
+    # remove all new line, but add one after }
+    self.data.gsub!("\n", "")
+    self.data.gsub!("\}", "\}\n")
+    
+    self.data = self.data.squeeze(" ").squeeze("\t").squeeze("\n").strip
+    
+    return self.data
+  end
+end

data/lib/mack-asset_packager/jsmin.rb

@@ -0,0 +1,205 @@
+#!/usr/bin/ruby
+# jsmin.rb 2007-07-20
+# Author: Uladzislau Latynski
+# This work is a translation from C to Ruby of jsmin.c published by
+# Douglas Crockford.  Permission is hereby granted to use the Ruby
+# version under the same conditions as the jsmin.c on which it is
+# based.
+#
+# /* jsmin.c
+#    2003-04-21
+#
+# Copyright (c) 2002 Douglas Crockford  (www.crockford.com)
+#
+# 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 shall be used for Good, not Evil.
+#
+# 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.
+
+EOF = -1
+$theA = ""
+$theB = ""
+
+# isAlphanum -- return true if the character is a letter, digit, underscore,
+# dollar sign, or non-ASCII character
+def isAlphanum(c)
+   return false if !c || c == EOF
+   return ((c >= 'a' && c <= 'z') || (c >= '0' && c <= '9') ||
+           (c >= 'A' && c <= 'Z') || c == '_' || c == '$' ||
+           c == '\\' || c[0] > 126)
+end
+
+# get -- return the next character from stdin. Watch out for lookahead. If
+# the character is a control character, translate it to a space or linefeed.
+def get()
+  c = $stdin.getc
+  return EOF if(!c)
+  c = c.chr
+  return c if (c >= " " || c == "\n" || c.unpack("c") == EOF)
+  return "\n" if (c == "\r")
+  return " "
+end
+
+# Get the next character without getting it.
+def peek()
+    lookaheadChar = $stdin.getc
+    $stdin.ungetc(lookaheadChar)
+    return lookaheadChar.chr
+end
+
+# mynext -- get the next character, excluding comments.
+# peek() is used to see if a '/' is followed by a '/' or '*'.
+def mynext()
+    c = get
+    if (c == "/")
+        if(peek == "/")
+            while(true)
+                c = get
+                if (c <= "\n")
+                return c
+                end
+            end
+        end
+        if(peek == "*")
+            get
+            while(true)
+                case get
+                when "*"
+                   if (peek == "/")
+                        get
+                        return " "
+                    end
+                when EOF
+                    raise "Unterminated comment"
+                end
+            end
+        end
+    end
+    return c
+end
+
+
+# action -- do something! What you do is determined by the argument: 1
+# Output A. Copy B to A. Get the next B. 2 Copy B to A. Get the next B.
+# (Delete A). 3 Get the next B. (Delete B). action treats a string as a
+# single character. Wow! action recognizes a regular expression if it is
+# preceded by ( or , or =.
+def action(a)
+    if(a==1)
+        $stdout.write $theA
+    end
+    if(a==1 || a==2)
+        $theA = $theB
+        if ($theA == "\'" || $theA == "\"")
+            while (true)
+                $stdout.write $theA
+                $theA = get
+                break if ($theA == $theB)
+                raise "Unterminated string literal" if ($theA <= "\n")
+                if ($theA == "\\")
+                    $stdout.write $theA
+                    $theA = get
+                end
+            end
+        end
+    end
+    if(a==1 || a==2 || a==3)
+        $theB = mynext
+        if ($theB == "/" && ($theA == "(" || $theA == "," || $theA == "=" ||
+                             $theA == ":" || $theA == "[" || $theA == "!" ||
+                             $theA == "&" || $theA == "|" || $theA == "?" ||
+                             $theA == "{" || $theA == "}" || $theA == ";" ||
+                             $theA == "\n"))
+            $stdout.write $theA
+            $stdout.write $theB
+            while (true)
+                $theA = get
+                if ($theA == "/")
+                    break
+                elsif ($theA == "\\")
+                    $stdout.write $theA
+                    $theA = get
+                elsif ($theA <= "\n")
+                    raise "Unterminated RegExp Literal"
+                end
+                $stdout.write $theA
+            end
+            $theB = mynext
+        end
+    end
+end
+
+# jsmin -- Copy the input to the output, deleting the characters which are
+# insignificant to JavaScript. Comments will be removed. Tabs will be
+# replaced with spaces. Carriage returns will be replaced with linefeeds.
+# Most spaces and linefeeds will be removed.
+def jsmin
+    $theA = "\n"
+    action(3)
+    while ($theA != EOF)
+        case $theA
+        when " "
+            if (isAlphanum($theB))
+                action(1)
+            else
+                action(2)
+            end
+        when "\n"
+            case ($theB)
+            when "{","[","(","+","-"
+                action(1)
+            when " "
+                action(3)
+            else
+                if (isAlphanum($theB))
+                    action(1)
+                else
+                    action(2)
+                end
+            end
+        else
+            case ($theB)
+            when " "
+                if (isAlphanum($theA))
+                    action(1)
+                else
+                    action(3)
+                end
+            when "\n"
+                case ($theA)
+                when "}","]",")","+","-","\"","\\", "'", '"'
+                    action(1)
+                else
+                    if (isAlphanum($theA))
+                        action(1)
+                    else
+                        action(3)
+                    end
+                end
+            else
+                action(1)
+            end
+        end
+    end
+end
+
+ARGV.each do |anArg|
+    $stdout.write "// #{anArg}\n"
+end
+
+jsmin

data/lib/mack-asset_packager/link_helpers.rb

@@ -0,0 +1,51 @@
+module Mack
+  module ViewHelpers
+    module LinkHelpers # :nodoc:
+      alias_method :old_javascripts, :javascript
+      alias_method :old_stylesheets, :stylesheet
+
+      def javascript(files, options = {})
+        process_file(files, 'javascripts', options)
+      end
+
+      def stylesheet(files, options = {})
+        process_file(files, 'stylesheets', options)
+      end
+
+      private
+      def process_file(files, asset_type, options)
+        files = [files].flatten
+        data_arr = []
+        contents(files, asset_type).each do |file|
+          data_arr << self.send("old_#{asset_type}", file, options)
+        end
+        return data_arr.join("\n")
+      end   
+      
+      def contents(files, asset_type)
+        return [files].flatten if !Mack::Assets::PackageCollection.instance.merge?
+        files = files.collect {|s| s.to_s}
+        processed_files = []
+        
+        # Ask the package_collection to compress the bundles.
+        # the package_collection will only perform the compression once
+        Mack::Assets::PackageCollection.instance.compress_bundles
+        
+        # find all bundled files listed in the file_list
+        groups = assets_mgr.groups_by_asset_type(asset_type)
+        groups.each do |group|
+          if files.include?(group.to_s)
+            processed_files << "#{group.to_s}.#{Mack::Assets::PackageCollection.instance.extension(asset_type)}"
+            files.delete(group.to_s)
+          end
+        end
+        
+        # now for all files that's not part of the bundle
+        # just add them to the list
+        processed_files += files
+        return processed_files
+      end
+
+    end
+  end
+end

data/lib/mack-asset_packager/package_collection.rb

@@ -0,0 +1,95 @@
+module Mack
+  module Assets
+    class PackageCollection # :nodoc:
+      include Singleton
+      
+      attr_accessor :bundle_processed
+      
+      def merge?
+        return configatron.mack.assets.enable_bundle_merge
+      end
+      
+      def initialized
+        self.bundle_processed = false
+      end
+      
+      def destroy_compressed_bundles
+        assets_mgr.groups_by_asset_type(:javascripts).each do |group|
+          path = Mack::Paths.javascripts(group + ".js")
+          if File.exists?(path)
+            FileUtils.rm(path)
+          end
+        end
+        assets_mgr.groups_by_asset_type(:stylesheets).each do |group|
+          path = Mack::Paths.stylesheets(group + ".css")
+          if File.exists?(path)
+            FileUtils.rm(path)
+          end
+        end
+      end
+      
+      def compress_bundles
+        if !self.bundle_processed and merge?
+          self.bundle_processed = true
+          assets_mgr.groups_by_asset_type(:javascripts).each do |group|
+            compress(group, :javascripts)
+          end
+          
+          assets_mgr.groups_by_asset_type(:stylesheets).each do |group|
+            compress(group, :stylesheets)
+          end
+        end
+      end
+      
+      def extension(asset_type)
+        return "js" if asset_type.to_s == "javascripts"
+        return "css" if asset_type.to_s == "stylesheets"
+        return ""
+      end
+      
+      private
+      def compress(group, asset_type)
+        base_dir  = Mack::Paths.public(asset_type)
+        file_name = "#{group}.#{extension(asset_type)}"
+        file_path = File.join(base_dir, file_name)
+        
+        # check if we need to delete the existing file.
+        delete_file(file_path, true)
+        
+        # if the file still exists, that means it's not time to expire the previously compressed doc
+        # just return the file_name
+        return file_name if File.exists?(file_path)
+        
+        # now read data from all the files defined in the bundle
+        raw = ""
+        assets_mgr.send(asset_type, group).each do |file|
+          path = File.join(base_dir, file)
+          raw += File.read(path)
+        end
+        
+        # save it to some tmp file, and compress it
+        jsmin_path = File.join(File.dirname(__FILE__), "jsmin.rb")
+        tmp_file = File.join(base_dir, "#{asset_type}_#{rand(10000)}")
+        File.open(tmp_file, "w") { |f| f.write(raw) }
+        if asset_type.to_s == "javascripts"
+          `ruby #{jsmin_path} < #{tmp_file} > #{file_path} \n`
+        elsif asset_type.to_s == "stylesheets"
+          min_data = CSSMin.new(raw).minimize
+          File.open(file_path, "w") { |f| f.write(min_data) }
+        end
+        # now that we're done, let's delete the tmp file
+        delete_file(tmp_file)
+        
+        return file_name
+      end
+      
+      def delete_file(name, check_time = false)
+        begin
+          FileUtils.rm(name) if !check_time or (check_time and File.ctime(name) < ASSET_LOAD_TIME)
+        rescue Exception => ex
+        end
+      end
+      
+    end
+  end
+end

data/lib/mack-asset_packager/tasks/asset_packager.rake

@@ -0,0 +1,13 @@
+namespace :assets do
+  namespace :packager do
+    desc "Rebuild asset bundles"
+    task :rebuild => :environment do
+      Mack::Assets::PackageCollection.instance.compress_bundles
+    end
+    
+    desc "Destroy asset bundles"
+    task :destroy => :environment do
+      Mack::Assets::PackageCollection.instance.destroy_compressed_bundles
+    end
+  end
+end

data/lib/mack-asset_packager_tasks.rb

@@ -0,0 +1,3 @@
+Dir.glob(File.join(File.dirname(__FILE__), "mack-asset_packager", "tasks", "*.rake")).each do |f|
+  load(f)
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification 
+name: mack-asset_packager
+version: !ruby/object:Gem::Version 
+  version: 0.8.0
+platform: ruby
+authors: 
+- Darsono Sutedja
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-10-06 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Asset Packager for Mack Framework
+email: darsono.sutedja@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/mack-asset_packager/cssmin.rb
+- lib/mack-asset_packager/jsmin.rb
+- lib/mack-asset_packager/link_helpers.rb
+- lib/mack-asset_packager/package_collection.rb
+- lib/mack-asset_packager/tasks/asset_packager.rake
+- lib/mack-asset_packager.rb
+- lib/mack-asset_packager_tasks.rb
+- README
+has_rdoc: true
+homepage: http://www.mackframework.com
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+- 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: magrathea
+rubygems_version: 1.3.0
+signing_key: 
+specification_version: 2
+summary: Asset Packager
+test_files: []
+