ngzip 1.0.2 → 1.0.3

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 1.0.3 (2013-08-05)
+
+* Added the :base_dir option
+
 ### 1.0.2 (2013-07-15)
 
 * Fixed the escaping of path names

data/README.md

@@ -21,10 +21,48 @@ Or install it yourself as:
 
 In a controller
 
-    b = Nginx::Builder.new()
-    response.headers['X-Archive-Files'] = 'zip'
-    render :text => b.build("/data/test/Report.pdf", "/data/test/LargeArchive.tar")
+```ruby
+b = Nginx::Builder.new()
+response.headers['X-Archive-Files'] = 'zip'
+render :text => b.build(["/data/test/Report.pdf", "/data/test/LargeArchive.tar"])
+```
 
+This will generate a manifest similar to this
+
+    8f92322f 446 /data/test/Report.pdf Report.pdf
+    13788d9a 234 /data/test/LargeArchive.tar LargeArchive.tar
+
+### Directories in the archive
+
+The builder will automatically remove common directory prefix for the pathes inside the archive. If you want to keep relative directories inside, specify the :base_dir option when calling the builder:
+
+```ruby
+options = {:base_dir => '/data'}
+render :text => b.build(["/data/test/Report.pdf", "/data/test/LargeArchive.tar"], options)
+```
+
+This will generate
+     
+    8f92322f 446 /data/test/Report.pdf test/Report.pdf
+    13788d9a 234 /data/test/LargeArchive.tar test/LargeArchive.tar
+
+
+
+### nginx configuration
+
+Compile nginx with the mod_zip module from https://github.com/evanmiller/mod_zip.
+
+Configure nginx to serve files with absolute paths from an internal location
+
+    # mod_zip location helper
+  	# Note: The leading ^~ is essential here, no more checks should be done after this match
+  	location ^~ /data/ {
+    	root /;
+    	internal;
+  	}
+
+Note that we only operate with local files in this examples. The module mod_zip uses subrequests to 
+fetch the actual file data and would support any location type (even proxied).
 
 ## License
 

data/lib/ngzip/builder.rb

@@ -17,12 +17,14 @@ module Ngzip
     # The following options are available:
     #  :crc         => Enable or disable CRC-32 checksums
     #  :crc_cache   => Allows for provided cached CRC-32 checksums in a hash where the key is the file path
+    #  :base_dir    => Use this as root for the relative pathes in the archive, keep all directories below
     def build(files, options = {})
       settings = {:crc => true}
       settings.merge! options
             
       list = file_list(files)
-      prefix = detect_common_prefix(list)
+      prefix = options[:base_dir] || detect_common_prefix(list)
+      prefix += '/' unless prefix.end_with?('/')
       list.map do |f|
         sprintf('%s %d %s %s',
                 compute_crc32(f, settings),
@@ -49,7 +51,7 @@ module Ngzip
     # Returns a common prefix
     def detect_common_prefix(list)
       if list.size == 1
-        return File.dirname(list.first) + '/'
+        return File.dirname(list.first)
       end
       prefix = ''
       min, max = list.sort.values_at(0, -1)

data/lib/ngzip/version.rb

@@ -1,3 +1,3 @@
 module Ngzip
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 end

data/test/lib/ngzip/builder_test.rb

@@ -87,7 +87,29 @@ describe Ngzip::Builder do
       expected = "#{invalid_but_cached} 446 #{lorem} lorem.txt"
       builder.build(lorem, options.merge(:crc_cache => {lorem => invalid_but_cached})).must_equal expected
     end
+    
+    it 'must remove common directories by default' do
+      pathes = builder.build([lorem, ipsum]).split("\n").map{|line| line.split.last}
+      expected = ["lorem.txt", "ipsum.txt"]
+      pathes.must_equal expected
+    end
+    
+    it 'must keep common directories if :base_dir is provided' do
+      options = {:base_dir => Pathname.new(lorem).parent.parent.to_s}
+      pathes = builder.build([lorem, ipsum], options).split("\n").map{|line| line.split.last}
+      expected = ["a/lorem.txt", "a/ipsum.txt"]
+      pathes.must_equal expected
+    end
+    
+    it 'must cope with a trailing / in the :base_dir' do
+      options = {:base_dir => Pathname.new(lorem).parent.parent.to_s + '/'}
+      pathes = builder.build([lorem, ipsum], options).split("\n").map{|line| line.split.last}
+      expected = ["a/lorem.txt", "a/ipsum.txt"]
+      pathes.must_equal expected
       
+    end
+    
+    
   end
   
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ngzip
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-14 00:00:00.000000000 Z
+date: 2013-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,7 +86,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3803006848080428378
+      hash: 4140413543763942870
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -95,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3803006848080428378
+      hash: 4140413543763942870
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25