packr 1.0.1 → 1.0.2

data/README

@@ -45,6 +45,28 @@ Be careful with that - it will overwrite the contents of the file with
 the packed version. Be a good kid and use version control in case something
 goes wrong and you lose all your source code!
 
+If you want PackR's variable-shrinking routine to preserve certain variable names,
+you can tell it to do so by instantiating it and telling it which names you want to
+preserve:
+
+  my_packr = Packr.new
+  my_packr.protect_vars(:some, :variable, :names)
+  
+  my_packr.pack('var func = function(foo, bar, some) { return some(foo + bar); }', :shrink_vars => true)
+  #=> "var func=function(a,b,some){return some(a+b)}"
+
+If you want to protect the same variables for all scripts your program compresses,
+tell the +Packr+ class to protect them:
+
+  Packr.protect_vars(:some, :variable, :names)
+  
+  Packr.pack('var func = function(foo, bar, some) { return some(foo + bar); }', :shrink_vars => true)
+  #=> "var func=function(a,b,some){return some(a+b)}"
+
+By default, PackR always protects the variable <tt>$super</tt> so you can compress
+Prototype code that uses class inheritance. The constant +PROTECTED_NAMES+ in the
++Packr+ source code controls which variables are protected by default.
+
 === Automated packing
 
 When installed as a Rails plugin, PackR also comes with a +rake+ task to let you

data/lib/packr.rb

@@ -8,7 +8,14 @@ require File.dirname(__FILE__) + '/packr/words'
 
 class Packr
   
+  PROTECTED_NAMES = %w($super)
+  
   class << self
+    def protect_vars(*args)
+      @packr ||= self.new
+      @packr.protect_vars(*args)
+    end
+    
     def minify(script)
       @packr ||= self.new
       @packr.minify(script)
@@ -83,6 +90,12 @@ class Packr
     @data = RegexpGroup.new(@data)
     @whitespace = @data.union(WHITESPACE)
     @clean = @data.union(CLEAN)
+    @protected_names = PROTECTED_NAMES
+  end
+  
+  def protect_vars(*args)
+    args = args.map { |arg| arg.to_s.strip }.select { |arg| arg =~ /^[a-z\_\$][a-z0-9\_\$]*$/i }
+    @protected_names = (@protected_names + args).uniq
   end
   
   def minify(script)
@@ -183,7 +196,7 @@ private
         count = 0
         ids.each do |id|
           id = id.strip
-          if id and id.length > 1 # > 1 char
+          if id and id.length > 1 and !@protected_names.include?(id) # > 1 char
             id = id.rescape
             # find the next free short name (check everything in the current scope)
             short_id = encode52.call(count)

data/test/packr_test.rb

@@ -54,4 +54,15 @@ class PackrTest < Test::Unit::TestCase
     actual_words = actual.scan(/'[\w\|]+'/)[-2].gsub(/^'(.*?)'$/, '\1').split("|").sort
     assert expected_words.eql?(actual_words)
   end
+  
+  def test_protected_names
+    expected = 'var func=function(a,b,$super,c){return $super(a+c)}'
+    actual = Packr.pack('var func = function(foo, bar, $super, baz) { return $super( foo + baz ); }', :shrink_vars => true)
+    assert_equal expected, actual
+    packr = Packr.new
+    packr.protect_vars *(%w(other) + [:method, :names] + ['some random stuff', 24])
+    expected = 'var func=function(a,other,$super,b,names){return $super()(other.apply(names,a))}'
+    actual = packr.pack('var func = function(foo, other, $super, bar, names) { return $super()(other.apply(names, foo)); }', :shrink_vars => true)
+    assert_equal expected, actual
+  end
 end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: packr
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
-date: 2007-12-09 00:00:00 +00:00
+  version: 1.0.2
+date: 2007-12-13 00:00:00 +00:00
 summary: A Ruby port of Dean Edwards' JavaScript compressor
 require_paths: 
 - lib