jzip 1.0.10 → 1.0.11

data/CHANGELOG

@@ -1,5 +1,12 @@
 = Jzip CHANGELOG
 
+== Version 1.0.11 (November 2, 2010)
+
+* Introduced Jzip::Engine.options[:log_level] which provides control over the Jzip logging (available options are :error, :info, :debug and :console)
+* Explicitly requiring Jzip::Engine::Support::Minifier and Jzip::Plugin
+* Using Rails environment flags
+* Change RAILS to Rails.
+
 == Version 1.0.10 (September 3, 2010)
 
 * Updated source file requiring

data/README.textile

@@ -9,26 +9,38 @@ Jzip was created due to the need of simply merging and minifying Javascript file
 
 h2. Installation
 
-h3. Using Jzip as gem
+h3. Using Jzip as gem in Rails 3
 
-Install the Jzip gem:
+Add Jzip in @Gemfile@ as a gem dependency:
 
 <pre>
-  sudo gem install jzip
+  gem "jzip"
 </pre>
 
-Add Jzip in environment.rb as a gem dependency:
+Run the following in your console to install with Bundler:
+
+<pre>
+  bundle install
+</pre>
+
+h3. Using Jzip as gem in Rails 2
+
+Add Jzip in @environment.rb@ as a gem dependency:
 
 <pre>
   config.gem "jzip"
 </pre>
 
-h3. Using Jzip as plugin
+Run the following in your console:
+
+<pre>
+  sudo rake gems:install
+</pre>
 
-Install the Jzip plugin:
+h3. Using Jzip as plugin in Rails 3
 
 <pre>
-  ./script/plugin install git://github.com/archan937/jzip.git 
+  rails plugin install git://github.com/archan937/jzip.git
 </pre>
 
 *Note*: the following will be created at installation of the plugin:
@@ -36,6 +48,12 @@ Install the Jzip plugin:
 * @assets/jzip@ - which is the default template location
 * @assets/jzip/defaults.jz@ - a Jzip template which requires the default Javascript files (Prototype, Scriptaculous and application.js)
 
+h3. Using Jzip as plugin in Rails 2
+
+<pre>
+  script/plugin install git://github.com/archan937/jzip.git
+</pre>
+
 h2. Usage
 
 h3. Including generated Javascript files
@@ -73,7 +91,7 @@ Please see "http://github.com/archan937/jzip/tree/master/test/javascripts/assets
 
 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: 
+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) >
@@ -111,12 +129,14 @@ Finally, Jzip has some options that you can configure in the @environment.rb@ fi
 
 * @: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)
+* @:log_level@     - Which is used for logging, you can pass through the regular Rails log levels (@:error@, @:info@ and @:debug@) and even @:console@ which puts the output in your console (default: nil)
 
 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
+  Jzip::Engine.options[:log_level]     = :console
 </pre>
 
 h3. In the Rails console
@@ -143,6 +163,10 @@ SASS<br>
 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. Contributors
+
+Mark Mulder - "@bitterzoet":http://twitter.com/bitterzoet - "http://ikbenbitterzoet.com":http://ikbenbitterzoet.com
+
 h2. ToDo's
 
 None.

data/VERSION

@@ -1 +1 @@
-1.0.10
+1.0.11

data/jzip.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{jzip}
-  s.version = "1.0.10"
+  s.version = "1.0.11"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Paul Engel"]
-  s.date = %q{2010-09-03}
+  s.date = %q{2010-11-02}
   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 with AssetPackager (for minification) and SASS (for merging with templates) as inspiration, I came up with Jzip.}
   s.email = %q{paul.engel@holder.nl}

data/lib/jzip.rb

@@ -7,6 +7,8 @@ require "jzip/core"
 require "jzip/actionpack"
 
 require "jzip/engine/support/notifier"
+require "jzip/engine/support/minifier"
 require "jzip/engine"
 require "jzip/engine/template"
 require "jzip/engine/requirement"
+require "jzip/plugin"

data/lib/jzip/actionpack/action_controller/base.rb

@@ -1,8 +1,8 @@
 
 unless defined?(Jzip::CONTROLLER_HOOKED)
-  
+
   module ActionController
-  
+
     class Base
       alias_method :original_process, :process
       def process(*args)
@@ -10,9 +10,9 @@ unless defined?(Jzip::CONTROLLER_HOOKED)
         original_process(*args)
       end
     end
-  
+
   end
-  
+
   Jzip::CONTROLLER_HOOKED = true
-  
+
 end

data/lib/jzip/assets.rb

@@ -2,27 +2,27 @@
 module Jzip
   module Assets
     extend self
-    
+
     def install_defaults
       puts "Installing defaults..."
 
       create_default_template_location
       File.open(File.join(default_template_location, "defaults.jz"), "w") do |f|
-        f.write("\n//= require /defaults\n") 
+        f.write("\n//= require /defaults\n")
       end
 
       puts "Done"
     end
-    
+
   private
-  
+
     def create_default_template_location
       FileUtils.mkdir_p default_template_location
     end
-    
+
     def default_template_location
       File.join Jzip::Engine.root_dir, "assets", "jzip"
     end
-    
+
   end
 end

data/lib/jzip/core/string/analyzation.rb

@@ -3,19 +3,19 @@ module Jzip
   module Core
     module String
       module Analyzation
-        
+
         def jzip_require_statement?
           !!self.strip.match(Jzip::Engine::REG_EXPS[:require_statement])
         end
-        
+
         def required_jzip_source(exclude_exclamation_mark = true)
           self.strip.gsub(Regexp.new([Jzip::Engine::REG_EXPS[:require_statement].source, ("\!?" if exclude_exclamation_mark)].compact.join), "").strip if self.jzip_require_statement?
         end
-        
+
         def overrule_jzip_minification?
           !!required_jzip_source(false).match(/^!/) if self.jzip_require_statement?
         end
-        
+
       end
     end
   end

data/lib/jzip/engine.rb

@@ -2,58 +2,60 @@
 module Jzip
   module Engine
     include Support::Notifier
-    
+
     extend self
-    
+
     PREDEFINED_SETS = {"defaults" => %w(prototype effects dragdrop controls application)}
     REG_EXPS        = {:require_statement => /^\/\/\=\s*require\s*/, :partial => /^_/, :default_javascripts => /^\//}
-    
+
     @options = {
-      :minify        => RAILS_ENV == "production",
-      :always_update => RAILS_ENV != "production"
+      :minify        =>  Rails.env.production?,
+      :always_update => !Rails.env.production?,
+      :log_level     =>  nil
     }
+
     attr_reader :root_dir, :options
-    
+
     def root_dir=(value)
       @template_locations.clear
       @initial_compile = true
       @root_dir        = value
     end
-    
+
     def options=(value)
       @options.merge! value
     end
-    
+
     def add_template_location(location)
       @template_locations << location
     end
-    
+
     def compile_javascript_files
       return unless @options[:always_update] or @initial_compile
-      
+
       init if @initial_compile
       parse_templates
       @initial_compile = false
     end
-    
+
     def init
       @template_locations.unshift File.join(root_dir, "assets", "jzip")
       FileUtils.mkdir_p tmp_dir
     end
-    
+
     def root_dir
-      @root_dir || RAILS_ROOT
+      @root_dir || Rails.root
     end
-    
+
     def tmp_dir
       File.join(root_dir, "tmp", "jzip")
     end
-    
+
   private
-    
+
     @template_locations = []
     @initial_compile    = true
-    
+
     def template_refs
       Hash[
         *@template_locations.collect do |location|
@@ -64,19 +66,19 @@ module Jzip
         end.flatten
       ]
     end
-    
+
     def parse_templates
       notify "Compiling templates..."
-      
+
       Template.clear_instances
       template_refs.each do |source, target|
         Dir.glob(File.join(source, "**", "[^_]*.jz")).each do |template|
           Template.build(template, source, target).parse
         end
       end
-      
+
       notify "Done"
     end
-    
-  end  
+
+  end
 end

data/lib/jzip/engine/requirement.rb

@@ -1,46 +1,46 @@
 
 module Jzip
   module Engine
-        
+
     Requirement = Struct.new(:file, :source, :target, :overrule_minification) do
-    
+
       include Support::Notifier
-      
+
       def newer?(mtime)
         notify "Newer     '#{target_file}'" if result = mtime < File.mtime(target_file)
         result
       end
-      
+
       def parse
         @code ||= begin
                     source_file = plain_javascript? ? self.file : (template.parse; template.target_file)
                     File.read(minify? ? Support::Minifier.parse(source_file) : source_file)
                   end
       end
-      
+
       def code
         parse
       end
-      
+
     private
-      
+
       def plain_javascript?
         File.extname(self.file) == ".js"
       end
-      
+
       def minify?
         Jzip::Engine::options[:minify] && !@overrule_minification
       end
-      
+
       def template
         @template ||= Template.build(self.file, self.source, self.target) unless plain_javascript?
       end
-      
+
       def target_file
         plain_javascript? ? self.file : template.target_file
       end
-      
+
     end
-    
+
   end
 end

data/lib/jzip/engine/support/minifier.rb

@@ -4,27 +4,27 @@ module Jzip
     module Support
       module Minifier
         include Notifier
-      
+
         extend self
-      
+
         def parse(source_file)
           target_file = derive_target(source_file)
-        
+
           unless File.exists?(target_file)
             notify "Minifying '#{source_file}'"
             FileUtils.mkdir_p File.dirname(target_file)
             `ruby #{File.join(File.dirname(__FILE__), "jsmin.rb")} <#{source_file} >#{target_file}`
           end
-        
+
           target_file
         end
-        
+
       private
-      
+
         def derive_target(source_file)
           source_file.gsub source_file.match(REG_EXPS[:partial]) ? Engine.tmp_dir : Engine.root_dir, File.join(Engine.tmp_dir, "_minified_")
         end
-    
+
       end
     end
   end

data/lib/jzip/engine/support/notifier.rb

@@ -3,18 +3,23 @@ module Jzip
   module Engine
     module Support
       module Notifier
-    
+
         def notify(message)
           string = wrap(message)
-          RAILS_ENV == "test" ? puts(string) : RAILS_DEFAULT_LOGGER.info(string)
+          case Jzip::Engine.options[:log_level]
+          when :console
+            puts string
+          when :error, :info, :debug
+            Rails.logger.send Jzip::Engine.options[:log_level], string
+          end
         end
-        
+
       private
-        
+
         def wrap(message)
           "== JZIP: #{message}"
         end
-    
+
       end
     end
   end

data/lib/jzip/engine/template.rb

@@ -1,22 +1,22 @@
 
 module Jzip
   module Engine
-    
+
     Template = Struct.new(:template, :source, :target) do
-    
+
       include Support::Notifier
-      
+
       @@instances = {}
       attr_reader :target_file
-      
+
       def self.clear_instances
         @@instances.clear
       end
-      
+
       def self.build(*args)
         @@instances[args.first] ||= self.new(*args)
       end
-      
+
       def initialize(*args)
         super
 
@@ -26,46 +26,46 @@ module Jzip
           @target_dir.gsub! Engine.root_dir, Engine.tmp_dir
         end
         @target_file = File.join @target_dir, @file_name
-        
+
         scan_template
       end
-      
+
       def parse
         unless requires_parsing?
           notify "Skipping  '#{self.template}'"
         else
           notify "Parsing   '#{self.template}'"
-          
+
           @code = @segments.collect do |segment|
                     segment.is_a?(Requirement) ?
-                      segment.code : 
+                      segment.code :
                       segment.join("")
                   end.
                   join("\n\n").
                   gsub(/^\s*$\n{2,}/, "\n").
                   strip.insert(0, "\n").insert(-1, "\n")
-      
+
           write_file
         end
         @code ||= File.read(@target_file)
       end
-      
+
       def code
         parse
       end
-      
+
       def outdated?
         return true if missing?
         notify "Outdated  '#{self.template}'" if result = File.mtime(@target_file) < File.mtime(self.template)
         result
       end
-      
+
       def partial?
         !!@file_name.match(REG_EXPS[:partial])
       end
-      
+
     private
-      
+
       def scan_template
         @requirements = []
         @segments     = File.readlines(self.template).inject([]) do |segments, line|
@@ -81,11 +81,11 @@ module Jzip
                           segments
                         end
       end
-      
+
       def derive_required_source(required_source)
         basename = File.basename required_source
         dirname  = File.dirname  required_source
-        
+
         source_dirname = required_source.match(REG_EXPS[:default_javascripts]) ?
                            File.join(Engine.root_dir, "public", "javascripts") :
                            File.dirname(self.template)
@@ -96,46 +96,46 @@ module Jzip
                              [required_source]
                            end
                          end
-                         
+
         sources.collect do |x|
           source = File.join(source_dirname, x)
           dir    = File.dirname  source
           base   = File.basename source
-          
+
           [File.join(dir, "_#{base}.jz"),
            File.join(dir,  "#{base}.jz"),
            File.join(dir,  "#{base}.js")].detect{|f| File.exists?(f)}
         end.compact
       end
-      
+
       def write_file
         notify "Writing   '#{@target_file}'"
-        
+
         FileUtils.mkdir_p @target_dir
         File.open(@target_file, "w") do |f|
           f.write @code
         end
       end
-      
+
       def requires_parsing?
         return true if outdated?
 
         modification_time = File.mtime(@target_file)
-        
+
         @requirements.each{|x| x.parse}
         @requirements.any?{|x| x.newer? modification_time}
       end
-      
+
       def missing?
         notify "Missing   '#{@target_file}'" if result = !target_file?
         result
       end
-      
+
       def target_file?
         File.exists? @target_file
       end
-         
+
     end
-    
+
   end
 end