asset_packager 0.1.0

data/CHANGELOG

@@ -0,0 +1,122 @@
+------------------------------------------------------------------------
+r52 | sbecker | 2007-11-04 01:38:21 -0400 (Sun, 04 Nov 2007) | 3 lines
+
+* Allow configuration of which environments the helpers should merge scripts with the Synthesis::AssetPackage.merge_environments variable.
+* Refactored tests so they can all run together, and not depend on what the RAILS_ENV constant is.
+* Only add file extension if it was explicitly passed in, fixes other helpers in rails.
+------------------------------------------------------------------------
+r51 | sbecker | 2007-10-26 16:24:48 -0400 (Fri, 26 Oct 2007) | 1 line
+
+* Updated jsmin.rb to latest version from 2007-07-20
+------------------------------------------------------------------------
+r50 | sbecker | 2007-10-23 23:16:07 -0400 (Tue, 23 Oct 2007) | 1 line
+
+Updated CHANGELOG
+
+------------------------------------------------------------------------
+r49 | sbecker | 2007-10-23 23:13:27 -0400 (Tue, 23 Oct 2007) | 1 line
+
+* Finally committed the subdirectory patch. (Thanks James Coglan!)
+------------------------------------------------------------------------
+r48 | sbecker | 2007-10-15 15:10:43 -0400 (Mon, 15 Oct 2007) | 1 line
+
+* Speed up rake tasks and remove rails environment dependencies
+------------------------------------------------------------------------
+r43 | sbecker | 2007-07-02 15:30:29 -0400 (Mon, 02 Jul 2007) | 1 line
+
+* Updated the docs regarding testing.
+------------------------------------------------------------------------
+r42 | sbecker | 2007-07-02 15:27:00 -0400 (Mon, 02 Jul 2007) | 1 line
+
+* For production helper test, build packages once - on first setup.
+------------------------------------------------------------------------
+r41 | sbecker | 2007-07-02 15:14:13 -0400 (Mon, 02 Jul 2007) | 1 line
+
+* Put build_all in test setup and delete_all in test teardown so all tests will pass the on first run of test suite.
+------------------------------------------------------------------------
+r40 | sbecker | 2007-07-02 14:55:28 -0400 (Mon, 02 Jul 2007) | 1 line
+
+* Fix quotes, add contact info
+------------------------------------------------------------------------
+r39 | sbecker | 2007-07-02 14:53:52 -0400 (Mon, 02 Jul 2007) | 1 line
+
+* Add note on how to run the tests for asset packager.
+------------------------------------------------------------------------
+r38 | sbecker | 2007-01-25 15:36:42 -0500 (Thu, 25 Jan 2007) | 1 line
+
+added CHANGELOG w/ subversion log entries
+------------------------------------------------------------------------
+r37 | sbecker | 2007-01-25 15:34:39 -0500 (Thu, 25 Jan 2007) | 1 line
+
+updated jsmin with new version from 2007-01-23
+------------------------------------------------------------------------
+r35 | sbecker | 2007-01-15 19:22:16 -0500 (Mon, 15 Jan 2007) | 1 line
+
+require synthesis/asset_package in rake tasks, as Rails 1.2 seems to necessitate
+------------------------------------------------------------------------
+r34 | sbecker | 2007-01-05 12:22:09 -0500 (Fri, 05 Jan 2007) | 1 line
+
+do a require before including in action view, because when running migrations, the plugin lib files don't automatically get required, causing the include to error out
+------------------------------------------------------------------------
+r33 | sbecker | 2006-12-23 02:03:41 -0500 (Sat, 23 Dec 2006) | 1 line
+
+updating readme with various tweaks
+------------------------------------------------------------------------
+r32 | sbecker | 2006-12-23 02:03:12 -0500 (Sat, 23 Dec 2006) | 1 line
+
+updating readme with various tweaks
+------------------------------------------------------------------------
+r31 | sbecker | 2006-12-23 01:52:25 -0500 (Sat, 23 Dec 2006) | 1 line
+
+updated readme to show how to use different media for stylesheets
+------------------------------------------------------------------------
+r28 | sbecker | 2006-11-27 21:02:14 -0500 (Mon, 27 Nov 2006) | 1 line
+
+updated compute_public_path, added check for images
+------------------------------------------------------------------------
+r27 | sbecker | 2006-11-10 18:28:29 -0500 (Fri, 10 Nov 2006) | 1 line
+
+tolerate extra periods in source asset names. fixed subversion revision checking to be file specific, instead of repository specific.
+------------------------------------------------------------------------
+r26 | sbecker | 2006-06-24 17:04:27 -0400 (Sat, 24 Jun 2006) | 1 line
+
+convert asset_packages_yml var to a class var
+------------------------------------------------------------------------
+r25 | sbecker | 2006-06-24 12:37:47 -0400 (Sat, 24 Jun 2006) | 1 line
+
+Added ability to include assets by package name. In development, include all uncompressed asset files. In production, include the single compressed asset.
+------------------------------------------------------------------------
+r24 | sbecker | 2006-06-19 21:57:23 -0400 (Mon, 19 Jun 2006) | 1 line
+
+Updates to README and about.yml
+------------------------------------------------------------------------
+r23 | sbecker | 2006-06-19 14:55:39 -0400 (Mon, 19 Jun 2006) | 2 lines
+
+Modifying about.yml and README
+
+------------------------------------------------------------------------
+r21 | sbecker | 2006-06-19 12:18:32 -0400 (Mon, 19 Jun 2006) | 2 lines
+
+added "formerly known as MergeJS"
+
+------------------------------------------------------------------------
+r20 | sbecker | 2006-06-19 12:14:46 -0400 (Mon, 19 Jun 2006) | 2 lines
+
+Updating docs
+
+------------------------------------------------------------------------
+r19 | sbecker | 2006-06-19 11:26:08 -0400 (Mon, 19 Jun 2006) | 2 lines
+
+removing compiled test assets from subversion
+
+------------------------------------------------------------------------
+r18 | sbecker | 2006-06-19 11:19:59 -0400 (Mon, 19 Jun 2006) | 2 lines
+
+Initial import.
+
+------------------------------------------------------------------------
+r17 | sbecker | 2006-06-19 11:18:56 -0400 (Mon, 19 Jun 2006) | 2 lines
+
+Creating directory.
+
+------------------------------------------------------------------------

data/README

@@ -0,0 +1,178 @@
+= AssetPackager
+
+JavaScript and CSS Asset Compression for Production Rails Apps
+
+== Description
+
+When it comes time to deploy your new web application, instead of 
+sending down a dozen JavaScript and CSS files full of formatting 
+and comments, this Rails plugin makes it simple to merge and 
+compress JavaScript and CSS down into one or more files, increasing 
+speed and saving bandwidth.
+
+When in development, it allows you to use your original versions 
+and retain formatting and comments for readability and debugging.
+
+This code is released under the MIT license (like Ruby). You're free 
+to rip it up, enhance it, etc. And if you make any enhancements, 
+I'd like to know so I can add them back in. Thanks!
+
+* Formerly known as MergeJS.
+
+== Credit
+
+This Rails Plugin was inspired by Cal Henderson's article 
+"Serving JavaScript Fast" on Vitamin:
+http://www.thinkvitamin.com/features/webapps/serving-javascript-fast
+
+It also uses the Ruby JavaScript Minifier created by 
+Douglas Crockford.
+http://www.crockford.com/javascript/jsmin.html
+
+== Key Features
+
+* Merges and compresses JavaScript and CSS when running in production.
+* Uses uncompressed originals when running in development.
+* Generates packages on demand in production
+
+== Components
+
+* Rake tasks for managing packages
+* Helper functions for including these JavaScript and CSS files in your views.
+* YAML configuration file for mapping JavaScript and CSS files to packages.
+* Rake Task for auto-generating the YAML file from your existing JavaScript files.
+
+== Updates
+
+November '08:
+* Rails 2.2 compatibility fixes
+* No more mucking with internal Rails functions, which means:
+  * Return to use of query-string timestamps. Greatly simplifies things.
+  * Multiple asset-hosts supported
+  * Filenames with "."'s in them, such as "jquery-x.x.x" are supported.
+* Now compatible with any revision control system since it no longer uses revision numbers.
+* Packages generated on demand in production mode. Running create_all rake task no longer necessary.
+
+== How to Use:
+
+1. Download and install the plugin:
+   ./script/plugin install git://github.com/sbecker/asset_packager.git
+
+2. Run the rake task "asset:packager:create_yml" to generate the /config/asset_packages.yml
+file the first time. You will need to reorder files under 'base' so dependencies are loaded 
+in correct order. Feel free to rename or create new file packages.
+
+IMPORTANT: JavaScript files can break once compressed if each statement doesn't end with a semi-colon.
+The minifier puts multiple statements on one line, so if the semi-colon is missing, the statement may no 
+longer makes sense and cause a syntax error.
+
+== Examples of config/asset_packages.yml
+
+Example from a fresh rails app after running the rake task. (Stylesheets is blank because a 
+default rails app has no stylesheets yet.):
+
+--- 
+javascripts: 
+- base: 
+  - prototype
+  - effects
+  - dragdrop
+  - controls
+  - application
+stylesheets: 
+- base: []
+
+Multiple packages:
+
+---
+javascripts:
+- base:
+  - prototype
+  - effects
+  - controls
+  - dragdrop
+  - application
+- secondary:
+  - foo
+  - bar
+stylesheets:
+- base:
+  - screen
+  - header
+- secondary:
+  - foo
+  - bar
+
+3. Run the rake task "asset:packager:build_all" to generate the compressed, merged versions
+for each package. Whenever you rearrange the yaml file, you'll need to run this task again. 
+
+Merging and compressing is expensive, so this is something we want to do once, not every time
+your app starts. Thats why its a rake task. You can run this task via Capistrano when deploying
+to avoid an initially slow request the first time a page is generated. 
+
+Note: The package will be generated on the fly if it doesn't yet exist, so you don't *need* 
+to run the rake task when deploying, its just recommended for speeding up initial requests.
+
+4. Use the helper functions whenever including these files in your application. See below for examples.
+
+5. Potential warning: css compressor function currently removes CSS comments. This might blow
+away some CSS hackery. To disable comment removal, comment out /lib/synthesis/asset_package.rb line 176.
+
+== JavaScript Examples
+
+Example call (based on above /config/asset_packages.yml):
+  <%= javascript_include_merged :base %>
+
+In development, this generates: 
+  <script type="text/javascript" src="/javascripts/prototype.js?1228027240"></script>
+  <script type="text/javascript" src="/javascripts/effects.js?1228027240"></script>
+  <script type="text/javascript" src="/javascripts/controls.js?1228027240"></script>
+  <script type="text/javascript" src="/javascripts/dragdrop.js?1228027240"></script>
+  <script type="text/javascript" src="/javascripts/application.js?1228027240"></script>
+
+In production, this generates: 
+  <script type="text/javascript" src="/javascripts/base_packaged.js?123456789"></script>
+
+== Stylesheet Examples
+
+Example call:
+  <%= stylesheet_link_merged :base %>
+
+In development, this generates:
+  <link href="/stylesheets/screen.css?1228027240" media="screen" rel="Stylesheet" type="text/css" />
+  <link href="/stylesheets/header.css?1228027240" media="screen" rel="Stylesheet" type="text/css" />
+
+In production this generates:
+  <link href="/stylesheets/base_packaged.css?1228027240" media="screen" rel="Stylesheet" type="text/css" />
+
+== Different CSS Media
+
+All options for stylesheet_link_tag still work, so if you want to specify a different media type:
+  <%= stylesheet_link_merged :secondary, 'media' => 'print' %>
+
+== Rake tasks
+
+rake asset:packager:build_all        # Merge and compress assets
+rake asset:packager:create_yml       # Generate asset_packages.yml from existing assets
+rake asset:packager:delete_all       # Delete all asset builds
+
+== Running the tests
+
+This plugin has a full suite of tests. But since they
+depend on rails, it has to be run in the context of a
+rails app, in the vendor/plugins directory. Observe:
+
+> rails newtestapp
+> cd newtestapp
+> ./script/plugin install ./script/plugin install git://github.com/sbecker/asset_packager.git
+> rake test:plugins PLUGIN=asset_packager # all tests pass
+
+== License
+Copyright (c) 2006-2008 Scott Becker - http://synthesis.sbecker.net
+Contact via Github for change requests, etc.
+
+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/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "asset_packager"
+    gem.summary = %Q{Packager for rails js and css}
+    gem.description = %Q{Minify for rails js and css}
+    gem.email = "dieinzige@gmail.com"
+    gem.homepage = "http://github.com/Dieinzige/asset_packager"
+    gem.authors = ["Dieinzige"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "asset_packager #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/about.yml

@@ -0,0 +1,8 @@
+author: Scott Becker
+name: AssetPackager
+summary: JavaScript and CSS Asset Compression for Production Rails Apps
+homepage: http://synthesis.sbecker.net/pages/asset_packager
+plugin: http://sbecker.net/shared/plugins/asset_packager
+license: MIT
+version: 0.2
+rails_version: 1.1.2+

data/init.rb

@@ -0,0 +1,2 @@
+require 'synthesis/asset_package_helper'
+ActionView::Base.send :include, Synthesis::AssetPackageHelper

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/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