jzip 1.0.7

data/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+pkg/*
+test/rails_root/public/javascripts/*
+test/rails_root/tmp/*

data/CHANGELOG

@@ -0,0 +1,74 @@
+= Jzip CHANGELOG
+
+== Version 1.0.6 (June 27, 2010)
+
+* Corrected the plugin installation
+
+== Version 1.0.5 (June 27, 2010)
+
+* Corrected the plugin initialization
+* Changed the minification temp directory to "_minified_"
+
+== Version 1.0.4 (June 11, 2010)
+
+* Corrected setting the root_dir of Jzip::Engine
+* Using File.read and File.readlines from now on
+
+== Version 1.0.3 (June 10, 2010)
+
+* Corrected Template.derive_required_source(required_source)
+* Corrected Requirement.newer?
+* Tweaked the template output (regarding new lines)
+* Also notifying in the test environment
+* Added extra notifications
+
+== Version 1.0.2 (June 8, 2010)
+
+* Being able to alter the root dir (default is RAILS_ROOT)
+* Running Jzip::Engine.init on initial compile
+
+== Version 1.0.1 (June 5, 2010)
+
+* Altered the ActionController::Base hook a bit
+
+== Version 1.0.0 (May 31, 2010)
+
+* Refactored the entire code base (cleaned up the module and file structure and separated functionality)
+* Improved Javascript file compiling
+* Introduced Jzip partials
+* Deprecated Jzip::Plugin (use Jzip::Engine instead)
+
+== Version 0.2.1 (May 5, 2010)
+
+* Altered the plugin initialization
+* Refactored the code a bit (moved code to separate files and using Sass' method to trigger compiling)
+* Added more logging info
+
+== Version 0.2.0 (September 19, 2009)
+
+* Refactored the requirements method:
+  - enabled using a preleading '/' in the required_source parameter to specify 'RAILS_ROOT/public/javascripts'
+  - using a more transparent approach of parsing 'defaults' to Prototype and Scriptaculous sources
+  - being able to add predefined sources (such as 'defaults') with great ease
+  - only adding a predefined source when the file exists
+* Added a preleading '/' to the at installment generated Jzip template
+* Not specifying the template location(s) in the Jzip::Plugin.options anymore (this let's you add template locations without having to know the whereabouts of other locations):
+  - the locations are stored in a private variable
+  - adding a template location has to be done by calling Jzip::Plugin.add_template_location
+
+== Version 0.1.3 (September 1, 2009)
+
+* Always parsing Jzip templates when on initial compile and options[:minify] is set to true
+
+== Version 0.1.2 (August 31, 2009)
+
+* Fixed bug in 'require_code' method (generating empty .js files)
+
+== Version 0.1.1 (August 30, 2009)
+
+* Only parsing Jzip templates when the target file doesn't exist or either the template or its required sources has been updated
+* Provided the possibility of overruling the Jzip minification by adding an exclamation mark before the required source or defaults (e.g. //= require !foo)
+
+== Version 0.1.0 (August 30, 2009)
+
+* Initial release

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Paul Engel
+
+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.textile

@@ -0,0 +1,159 @@
+
+h1. Jzip
+
+A Rails gem (and also plugin) for Javascript merging and compression within Rails Apps
+
+h2. Introduction
+
+Jzip was created due to the need of simply merging and minifying Javascript files to reduce HTTP requests and file size of my assets. Using sprites for images and SASS for stylesheets only left javascripts not be optimized. AssetPackager almost suited the solution, but I wanted more flexibility in configuration. So I got inspired by AssetPackager and SASS to come up with the Jzip. At first Jzip was a plugin only, but after refactoring the entire code base Jzip is available as a gem hosted on gemcutter.
+
+h2. Installation
+
+h3. Using Jzip as gem
+
+Add gemcutter as a gem source, if you haven't already done it:
+
+<pre>
+  sudo gem sources -a http://gemcutter.org/
+</pre>
+
+Install the Jzip gem:
+
+<pre>
+  sudo gem install jzip
+</pre>
+
+Add Jzip in environment.rb as a gem dependency:
+
+<pre>
+  config.gem "jzip"
+</pre>
+
+Optionally, you can run @rake jzip:assets:install@ which creates the following:
+
+* @assets/jzip@ - which is the default template location
+* @assets/jzip/defaults.jz@ - a Jzip template which requires the default Javascript files (Prototype, Scriptaculous sources and application.js)
+
+h3. Using Jzip as plugin
+
+Install the Jzip plugin:
+
+<pre>
+  ./script/plugin install git://github.com/archan937/jzip.git 
+</pre>
+
+*Note*: a Jzip template (@assets/jzip/defaults.jz@) for the Prototype and Scriptaculous sources along with application.js will be created
+
+h2. Usage
+
+h3. Including generated Javascript files
+
+Just use the @javascript_include_tag@ helper method (e.g. for the @defaults.jz@ template):
+
+<pre>
+  <%= javascript_include_tag "defaults" %>
+</pre>
+
+h3. Creating Jzip templates / partials
+
+A @.jz@ file (Jzip template or partial) is nothing more than a common .js file in which you can require other files for merging. You can do this by simply adding the following:
+
+<pre>
+  //= require < path_to_file or path_to_template or path_to_partial or predefined_set >
+</pre>
+
+Just like in Rails views and in SASS, Jzip has partials of which the output file will not be created in the target directory. The path to the Javascript file or Jzip template or partial has to be relative to the Jzip template / partial itself. Please note that specifying a preleading @/@ in the path will be interpreted by Jzip as @RAILS_ROOT/public/javascripts@ (which is very handy).
+
+Other than the path to a Javascript file, you can also refer to a predefined set of Javascripts sources. At the moment, only @defaults@ is available for the Prototype and Scriptaculous libs and application.js which are shipped with a Rails application. Any suggestions for other predefined sets are welcome.
+
+The following instructs Jzip to merge the Prototype and Scriptaculous libraries with three custom Javascript files into @public/javascripts/foo.js@:
+
+*Note*: template is located in @assets/jzip/foo.jz@
+
+<pre>
+  //= require shared/top_up
+  //= require /defaults
+  //= require builder/module
+  //= require builder/model_browser
+</pre>
+
+h3. Registering template locations
+
+You probably already have guessed that the default location for Jzip templates is @RAILS_ROOT/assets/jzip@. I can imagine that you would have choosen another location. So fortunately, the Jzip engine offers you to that piece of freedom. All you have to do is put the following in your @environment.rb@ file: 
+
+<pre>
+  Jzip::Engine.add_template_location < your_own_template_location(s) >
+</pre>
+
+This comes in very handy when building a Rails plugin that uses Jzip because you don't want to copy your all Jzip templates to @RAILS_ROOT/assets/jzip@. So let's say your plugin is called @betty@, all you have to do is put the following in it's @init.rb@ file:
+
+<pre>
+  Jzip::Engine.add_template_location RAILS_ROOT + "vendor/plugins/betty/assets/jzip"
+</pre>
+
+Now isn't that a piece cake? Not only can you pass a @string@ containing the template location, you can also pass an @array of strings@ (containing multiple locations) or a @hash@ (which also specifies the output directory):
+
+* @string@ - target directory will be @public/javascripts@
+
+<pre>
+  RAILS_ROOT + "/lib/jzip
+</pre>
+
+* @array@ - target directory will be @public/javascripts@
+
+<pre>
+  [RAILS_ROOT + "/some/path/jzip", RAILS_ROOT + "/vendor/plugins/foo/assets/jzip"]
+</pre>
+
+* @hash@ - target directory will be @public/javascripts/betty@
+
+<pre>
+  {RAILS_ROOT + "/vendor/plugins/betty/assets/jzip" => RAILS_ROOT + "/public/javascripts/betty"}
+</pre>
+
+h3. Compile options
+
+Finally, Jzip has some options that you can configure in the @environment.rb@ file:
+
+* @:minify@        - Minify the merged Javascript file using the JSMin library (default: true when in production environment)
+* @:always_update@ - Merge (and minify when specified) the Jzip templates on every page request when outdated (default: true when not in production environment)
+
+You can specify a Jzip option by putting the following in your @environment.rb@ file:
+
+<pre>
+  Jzip::Engine.options[:minify]        = false
+  Jzip::Engine.options[:always_update] = true
+</pre>
+
+h2. Contact me
+
+For support, remarks and requests please mail me at "paul.engel@holder.nl":mailto:paul.engel@holder.nl.
+
+h2. Credit
+
+This Rails engine is inspired by:
+
+AssetPackager<br>
+"http://github.com/sbecker/asset_packager/tree/master":http://github.com/sbecker/asset_packager/tree/master
+
+SASS<br>
+"http://sass-lang.com":http://sass-lang.com
+
+Also, the Jzip engine makes use of the Ruby JavaScript Minifier created by Douglas Crockford<br>
+"http://www.crockford.com/javascript/jsmin.html":http://www.crockford.com/javascript/jsmin.html
+
+h2. ToDo's
+
+None.
+
+h2. License
+
+Copyright (c) 2010 Paul Engel, released under the MIT license
+
+"http://holder.nl":http://holder.nl - "http://codehero.es":http://codehero.es - "http://gettopup.com":http://gettopup.com - "http://twitter.com/archan937":http://twitter.com/archan937 - "paul.engel@holder.nl":mailto:paul.engel@holder.nl
+
+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,42 @@
+require "rake"
+require "rake/testtask"
+require "rake/rdoctask"
+
+begin
+  require "jeweler"
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name        = "jzip"
+    gemspec.summary     = "Javascript merging and compression for Rails Apps"
+    gemspec.description = "Jzip was created due to the need of simply merging and minifying Javascript files to reduce HTTP requests and file size of application assets. Using sprites for images and SASS for stylesheets only left javascripts not be optimized.
+                           AssetPackager almost suited the solution, but it hasn't got enough flexibility in configuration. So using AssetPackager and SASS for inspriration the Jzip gem was created."
+    gemspec.email       = "paul.engel@holder.nl"
+    gemspec.homepage    = "http://github.com/archan937/jzip"
+    gemspec.author      = "Paul Engel"
+
+    gemspec.add_dependency "formtastic"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+desc "Default: run unit tests."
+task :default => :test
+
+desc "Test the jzip plugin."
+Rake::TestTask.new(:test) do |t|
+  t.libs    << "lib"
+  t.libs    << "test"
+  t.pattern  = "test/**/*_test.rb"
+  t.verbose  = true
+end
+
+desc "Generate documentation for the jzip plugin."
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "Jzip"
+  rdoc.options << "--line-numbers" << "--inline-source"
+  rdoc.rdoc_files.include "README"
+  rdoc.rdoc_files.include "MIT-LICENSE"
+  rdoc.rdoc_files.include "lib/**/*.rb"
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.7

data/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), "rails", "init")

data/install.rb

@@ -0,0 +1,3 @@
+
+require File.expand_path(File.dirname(__FILE__) + "/../../../config/environment")
+Jzip::Assets.install_defaults

data/jzip.gemspec

@@ -0,0 +1,143 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{jzip}
+  s.version = "1.0.7"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Paul Engel"]
+  s.date = %q{2010-06-27}
+  s.description = %q{Jzip was created due to the need of simply merging and minifying Javascript files to reduce HTTP requests and file size of application assets. Using sprites for images and SASS for stylesheets only left javascripts not be optimized.
+                           AssetPackager almost suited the solution, but it hasn't got enough flexibility in configuration. So using AssetPackager and SASS for inspriration the Jzip gem was created.}
+  s.email = %q{paul.engel@holder.nl}
+  s.extra_rdoc_files = [
+    "README.textile"
+  ]
+  s.files = [
+    ".gitignore",
+     "CHANGELOG",
+     "MIT-LICENSE",
+     "README.textile",
+     "Rakefile",
+     "VERSION",
+     "init.rb",
+     "install.rb",
+     "jzip.gemspec",
+     "lib/jzip.rb",
+     "lib/jzip/actionpack.rb",
+     "lib/jzip/actionpack/action_controller/base.rb",
+     "lib/jzip/assets.rb",
+     "lib/jzip/core.rb",
+     "lib/jzip/core/string.rb",
+     "lib/jzip/core/string/analyzation.rb",
+     "lib/jzip/engine.rb",
+     "lib/jzip/engine/requirement.rb",
+     "lib/jzip/engine/support/jsmin.rb",
+     "lib/jzip/engine/support/minifier.rb",
+     "lib/jzip/engine/support/notifier.rb",
+     "lib/jzip/engine/template.rb",
+     "lib/jzip/plugin.rb",
+     "rails/init.rb",
+     "tasks/jzip.rake",
+     "test/actionpack/action_controller/base_test.rb",
+     "test/core/string/analyzation_test.rb",
+     "test/engine_test.rb",
+     "test/javascripts/after/compressed/public/javascripts/backend.js",
+     "test/javascripts/after/compressed/public/javascripts/defaults.js",
+     "test/javascripts/after/compressed/public/javascripts/frontend.js",
+     "test/javascripts/after/compressed/tmp/jzip/_minified_/assets/jzip/code_heroes/backend.js",
+     "test/javascripts/after/compressed/tmp/jzip/_minified_/assets/jzip/code_heroes/frontend.js",
+     "test/javascripts/after/compressed/tmp/jzip/_minified_/assets/jzip/shared/code_heroes.js",
+     "test/javascripts/after/compressed/tmp/jzip/_minified_/assets/jzip/shared/code_heroes/ajaxify.js",
+     "test/javascripts/after/compressed/tmp/jzip/_minified_/assets/jzip/shared/jquery/ajax_setup.js",
+     "test/javascripts/after/compressed/tmp/jzip/_minified_/assets/jzip/shared/jquery/class.js",
+     "test/javascripts/after/compressed/tmp/jzip/_minified_/assets/jzip/shared/jquery/components/core.js",
+     "test/javascripts/after/compressed/tmp/jzip/_minified_/assets/jzip/shared/jquery/extensions/core.js",
+     "test/javascripts/after/compressed/tmp/jzip/_minified_/assets/jzip/shared/jquery/extensions/deparam.js",
+     "test/javascripts/after/compressed/tmp/jzip/_minified_/assets/jzip/shared/jquery/seat_holder.js",
+     "test/javascripts/after/compressed/tmp/jzip/_minified_/assets/jzip/shared/native/extensions/array.js",
+     "test/javascripts/after/compressed/tmp/jzip/_minified_/assets/jzip/shared/native/extensions/string.js",
+     "test/javascripts/after/compressed/tmp/jzip/_minified_/assets/jzip/shared/native/log.js",
+     "test/javascripts/after/compressed/tmp/jzip/_minified_/public/javascripts/application.js",
+     "test/javascripts/after/compressed/tmp/jzip/_minified_/public/javascripts/controls.js",
+     "test/javascripts/after/compressed/tmp/jzip/_minified_/public/javascripts/dragdrop.js",
+     "test/javascripts/after/compressed/tmp/jzip/_minified_/public/javascripts/effects.js",
+     "test/javascripts/after/compressed/tmp/jzip/_minified_/public/javascripts/prototype.js",
+     "test/javascripts/after/compressed/tmp/jzip/_minified_/tmp/jzip/public/javascripts/shared/_shared.js",
+     "test/javascripts/after/compressed/tmp/jzip/_minified_/tmp/jzip/public/javascripts/shared/jquery/_core.js",
+     "test/javascripts/after/compressed/tmp/jzip/public/javascripts/shared/_shared.js",
+     "test/javascripts/after/compressed/tmp/jzip/public/javascripts/shared/jquery/_core.js",
+     "test/javascripts/after/uncompressed/public/javascripts/backend.js",
+     "test/javascripts/after/uncompressed/public/javascripts/defaults.js",
+     "test/javascripts/after/uncompressed/public/javascripts/frontend.js",
+     "test/javascripts/after/uncompressed/tmp/jzip/public/javascripts/shared/_shared.js",
+     "test/javascripts/after/uncompressed/tmp/jzip/public/javascripts/shared/jquery/_core.js",
+     "test/javascripts/assets/jzip/backend.jz",
+     "test/javascripts/assets/jzip/code_heroes/backend.js",
+     "test/javascripts/assets/jzip/code_heroes/frontend.js",
+     "test/javascripts/assets/jzip/defaults.jz",
+     "test/javascripts/assets/jzip/frontend.jz",
+     "test/javascripts/assets/jzip/shared/_shared.jz",
+     "test/javascripts/assets/jzip/shared/code_heroes.js",
+     "test/javascripts/assets/jzip/shared/code_heroes/ajaxify.js",
+     "test/javascripts/assets/jzip/shared/jquery/_all.jz",
+     "test/javascripts/assets/jzip/shared/jquery/_core.fxc-clip.jz",
+     "test/javascripts/assets/jzip/shared/jquery/_core.jz",
+     "test/javascripts/assets/jzip/shared/jquery/_core.uic-resizable.jz",
+     "test/javascripts/assets/jzip/shared/jquery/_fxc-clip.jz",
+     "test/javascripts/assets/jzip/shared/jquery/_fxc-clip.uic-resizable.jz",
+     "test/javascripts/assets/jzip/shared/jquery/_uic-resizable.jz",
+     "test/javascripts/assets/jzip/shared/jquery/ajax_setup.js",
+     "test/javascripts/assets/jzip/shared/jquery/class.js",
+     "test/javascripts/assets/jzip/shared/jquery/components/core.js",
+     "test/javascripts/assets/jzip/shared/jquery/components/fxc-clip.js",
+     "test/javascripts/assets/jzip/shared/jquery/components/uic-resizable.js",
+     "test/javascripts/assets/jzip/shared/jquery/extensions/core.js",
+     "test/javascripts/assets/jzip/shared/jquery/extensions/deparam.js",
+     "test/javascripts/assets/jzip/shared/jquery/seat_holder.js",
+     "test/javascripts/assets/jzip/shared/native/extensions/array.js",
+     "test/javascripts/assets/jzip/shared/native/extensions/string.js",
+     "test/javascripts/assets/jzip/shared/native/log.js",
+     "test/javascripts/before/application.js",
+     "test/javascripts/before/controls.js",
+     "test/javascripts/before/dragdrop.js",
+     "test/javascripts/before/effects.js",
+     "test/javascripts/before/prototype.js",
+     "test/rails_root/compressed/assets/jzip/foo.js",
+     "test/rails_root/compressed/public/javascripts/foo.js",
+     "test/rails_root/uncompressed/assets/jzip/foo.js",
+     "test/rails_root/uncompressed/public/javascripts/foo.js",
+     "test/setup.rb",
+     "test/test_helper.rb",
+     "uninstall.rb"
+  ]
+  s.homepage = %q{http://github.com/archan937/jzip}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Javascript merging and compression for Rails Apps}
+  s.test_files = [
+    "test/actionpack/action_controller/base_test.rb",
+     "test/core/string/analyzation_test.rb",
+     "test/engine_test.rb",
+     "test/setup.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<formtastic>, [">= 0"])
+    else
+      s.add_dependency(%q<formtastic>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<formtastic>, [">= 0"])
+  end
+end
+