ngzip 1.0.7 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e20636d23b8e7ba30af726b7a530f96f31eb636a
-  data.tar.gz: ed999e168b1c77b6942cb2cb6f118a5a936fe434
+SHA256:
+  metadata.gz: 84899280f348b240160b5c6984b7a4130a7a48f71b9c7d903051f99a36326f09
+  data.tar.gz: 1b1b057b9da9d80900035e732ed586b13c9e5a25659b4b9ac226862f7d6782b4
 SHA512:
-  metadata.gz: 70d66540ec58ff16e08321b26b998e303c765f3aaa057f58e9956cd5922c1e39869ce1c2d75b5a5db01952a91089661470fca66bc069fe0d540b15e60c9743fc
-  data.tar.gz: 769e82edd41c5029b2eef0be5dbc89fcdaaae0f5b2570902cbe3bc71b601d3145dde48b86bfebfe4839d785d4aece3a8b62fd74d7ae079cc1d5ba1d7bed882d6
+  metadata.gz: 6f5b599664e6b4f49de86596596ae5bdae4f9ab8601c260e58e075c6376d6a37c5aa25a441baa971cf590a1b11d218e675369e67140ca9076df197fc2c62aeaa
+  data.tar.gz: 815fb0735456a2020781276b456c47e8e76d567e2ef8b35bcd65856e38913c55e00c717cb1a0ced8da4f8e39d1d9febf9deec9645dcb9d2bf4de2790520ddee1

data/Gemfile

@@ -1,4 +1,12 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in ngzip.gemspec
+group :test do
+  gem 'minitest'
+  gem 'minitest-reporters'
+  gem 'pry'
+end
+
 gemspec

data/Rakefile

@@ -1,11 +1,13 @@
-require "bundler/gem_tasks"
+# frozen_string_literal: true
 
-require "rake/testtask"
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
 
 Rake::TestTask.new do |t|
   t.libs << 'lib'
   t.test_files = FileList['test/lib/ngzip/*_test.rb']
   t.verbose = true
 end
- 
-task :default => :test
+
+task default: :test

data/lib/ngzip.rb

@@ -1,8 +1,11 @@
-require "ngzip/version"
-require "ngzip/builder"
+# frozen_string_literal: true
 
+require 'ngzip/version'
+require 'ngzip/builder'
+
+# Ngzip module
 module Ngzip
   def self.build(files, options)
-    Ngzip::Builder.new().build(files, options)
+    Ngzip::Builder.new.build(files, options)
   end
 end

data/lib/ngzip/builder.rb

@@ -1,7 +1,11 @@
+# frozen_string_literal: true
+
 require 'zlib'
 require 'uri'
+require 'erb'
 
 module Ngzip
+  # The manifest builder based on the file list
   class Builder
     BUFFER_SIZE = 8 * 1024
 
@@ -13,22 +17,25 @@ module Ngzip
     # Returns a line for each file separated by \n
     #
     # 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
+    #  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 = { crc: true }
       settings.merge! options
 
       list = file_list(files)
       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),
-                File.size(f).to_i,
-                Builder.encode(f),
-                f.gsub(prefix, '')
+        format(
+          '%<crc>s %<size>d %<url>s %<name>s',
+          {
+            crc: compute_crc32(f, settings),
+            size: File.size(f).to_i,
+            url: Builder.encode(f),
+            name: f.gsub(prefix, '')
+          }
         )
       end.join("\n")
     end
@@ -36,15 +43,15 @@ module Ngzip
     # Public: Get the special header to signal the mod_zip
     #
     # Returns the header as a string "key: value"
-    def header()
-      "X-Archive-Files: zip"
+    def header
+      'X-Archive-Files: zip'
     end
 
     # Public: Encode the string
     #
     # Returns the encoded string using URL escape formatting
     def self.encode(string)
-      URI.encode(string).gsub('+', '%2B').gsub('?', '%3F')
+      ERB::Util.url_encode(string)
     end
 
     private
@@ -55,16 +62,17 @@ module Ngzip
     #
     # Returns a common prefix
     def detect_common_prefix(list)
-      if list.size == 1
-        return File.dirname(list.first)
-      end
-      prefix = ''
-      min, max = list.sort.values_at(0, -1)
+      return File.dirname(list.first) if list.size == 1
+
+      prefix = StringIO.new
+      excluding_file_names = list.map { |p| File.dirname p }
+      min, max = excluding_file_names.sort.values_at(0, -1)
       min.split(//).each_with_index do |c, i|
         break if c != max[i, 1]
+
         prefix << c
       end
-      prefix
+      prefix.string
     end
 
     # Internal: Compute the file list by expanding directories
@@ -72,7 +80,9 @@ module Ngzip
     def file_list(files)
       Array(files).map do |e|
         if File.directory?(e)
-          Dir.glob("#{e}/**/*").reject { |f| File.directory?(f) }
+          # `expand_path` removes any trailing slash from the path string
+          sanitized_path = File.expand_path(e)
+          Dir.glob("#{sanitized_path}/**/*").reject { |f| File.directory?(f) }
         else
           e
         end
@@ -80,7 +90,7 @@ module Ngzip
     end
 
     # Internal: Compute the CRC-32 checksum for a file unless the settings
-    # disable the computation (:crc => false) and this method returns "-"
+    # disable the computation (crc: false) and this method returns "-"
     #
     # file - The full path to the file
     # settings - The settings hash
@@ -90,14 +100,12 @@ module Ngzip
       return '-' unless settings[:crc]
 
       # honor the cache
-      if settings[:crc_cache] && settings[:crc_cache][file]
-        return settings[:crc_cache][file]
-      end
+      return settings[:crc_cache][file] if settings[:crc_cache] && settings[:crc_cache][file]
 
       # read using a buffer, we might operate on large files!
       crc32 = 0
-      File.open(file,'rb') do |f|
-        while buffer = f.read(BUFFER_SIZE) do
+      File.open(file, 'rb') do |f|
+        while (buffer = f.read(BUFFER_SIZE))
           crc32 = Zlib.crc32(buffer, crc32)
         end
       end

data/lib/ngzip/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ngzip
-  VERSION = '1.0.7'.freeze
+  VERSION = '1.1.0'
 end

data/ngzip.gemspec

@@ -1,24 +1,27 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'english'
 require 'ngzip/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "ngzip"
+  spec.name          = 'ngzip'
   spec.version       = Ngzip::VERSION
-  spec.authors       = ["dup2"]
-  spec.email         = ["zarkov@cargoserver.ch"]
-  spec.description   = %q{Provides a nginx mod_zip compatible file manifest for streaming support.
-                          See http://wiki.nginx.org/NginxNgxZip for the nginx module.}
-  spec.summary       = %q{Provides a nginx mod_zip compatible file manifest for streaming support}
-  spec.homepage      = "https://github.com/cargoserver/ngzip"
-  spec.license       = "MIT"
+  spec.authors       = ['dup2']
+  spec.email         = ['zarkov@cargoserver.ch']
+  spec.description   = %(Provides a nginx mod_zip compatible file manifest for streaming support.
+                          See http://wiki.nginx.org/NginxNgxZip for the nginx module.)
+  spec.summary       = 'Provides a nginx mod_zip compatible file manifest for streaming support'
+  spec.homepage      = 'https://github.com/cargoserver/ngzip'
+  spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rubocop'
 end

data/test/lib/ngzip/builder_test.rb

@@ -1,134 +1,154 @@
-require_relative "../../test_helper"
+# frozen_string_literal: true
+
+require_relative '../../test_helper'
 require 'uri'
 require 'pathname'
 
 describe Ngzip do
-
   it 'must support the static method :build' do
-    Ngzip.respond_to?(:build).must_equal true
+    expect(Ngzip.respond_to?(:build)).must_equal true
   end
-
 end
 
 describe Ngzip::Builder do
+  def encode_file_path(path)
+    ERB::Util.url_encode path
+  end
 
-  let(:builder) {Ngzip::Builder.new()}
-  let(:lorem) {File.expand_path('../../../data/a/lorem.txt', __FILE__)}
-  let(:ipsum) {File.expand_path('../../../data/a/ipsum.txt', __FILE__)}
-  let(:without_dot) {File.expand_path('../../../data/a/filename-without-a-dot', __FILE__)}
-  let(:my_file) {File.expand_path('../../../data/a/d/my_file.txt', __FILE__)}
-  let(:whitespaced) {File.expand_path('../../../data/a/A filename with whitespace.txt', __FILE__)}
-  let(:plused) {File.expand_path('../../../data/c/A filename with space and + in it.txt', __FILE__)}
-  let(:cargo) {File.expand_path('../../../data/b/Cargo.png', __FILE__)}
-  let(:sit) {File.expand_path('../../../data/sit.txt', __FILE__)}
-  let(:a) {File.expand_path('../../../data/a', __FILE__)}
-  let(:questions) { File.expand_path('../../../data/c/questions?', __FILE__) }
+  let(:builder) { Ngzip::Builder.new }
+  let(:lorem) { File.expand_path('../../data/a/lorem.txt', __dir__) }
+  let(:ipsum) { File.expand_path('../../data/a/ipsum.txt', __dir__) }
+  let(:without_dot) { File.expand_path('../../data/a/filename-without-a-dot', __dir__) }
+  let(:my_file) { File.expand_path('../../data/a/d/my_file.txt', __dir__) }
+  let(:whitespaced) { File.expand_path('../../data/a/A filename with whitespace.txt', __dir__) }
+  let(:plused) { File.expand_path('../../data/c/A filename with space and + in it.txt', __dir__) }
+  let(:cargo) { File.expand_path('../../data/b/Cargo.png', __dir__) }
+  let(:sit) { File.expand_path('../../data/sit.txt', __dir__) }
+  let(:a) { File.expand_path('../../data/a', __dir__) }
+  let(:questions) { File.expand_path('../../data/c/questions?', __dir__) }
 
   it 'must be defined' do
-    Ngzip::Builder.wont_be_nil
+    expect(Ngzip::Builder).wont_be_nil
   end
 
   it 'must be a class we can call :new on' do
-    Ngzip::Builder.new().wont_be_nil
+    expect(Ngzip::Builder.new).wont_be_nil
   end
 
   it 'must respond to :build' do
-    builder.respond_to?(:build).must_equal true
+    expect(builder.respond_to?(:build)).must_equal true
   end
 
-  describe "with CRC-32 checksums disabled" do
-    let(:options) { {:crc => false}}
+  describe 'with CRC-32 checksums disabled' do
+    let(:options) { { crc: false } }
 
     it 'must return a correct list for one file' do
-      expected = "- 446 #{lorem} lorem.txt"
-      builder.build(lorem, options).must_equal expected
+      expected = "- 446 #{encode_file_path(lorem)} lorem.txt"
+      expect(builder.build(lorem, options)).must_equal expected
     end
   end
 
-  describe "with CRC-32 checksums enabled" do
-    let(:options) { {:crc => true}}
+  describe 'with CRC-32 checksums enabled' do
+    let(:options) { { crc: true } }
 
     it 'must return a correct list for one file with a checksum' do
-      expected = "8f92322f 446 #{lorem} lorem.txt"
-      builder.build(lorem, options).must_equal expected
+      expected = "8f92322f 446 #{encode_file_path(lorem)} lorem.txt"
+      expect(builder.build(lorem, options)).must_equal expected
     end
 
     it 'must return a correct list for one binary file with a checksum' do
-      expected = "b2f4655b 11550 #{cargo} Cargo.png"
-      builder.build(cargo, options).must_equal expected
+      expected = "b2f4655b 11550 #{encode_file_path(cargo)} Cargo.png"
+      expect(builder.build(cargo, options)).must_equal expected
     end
 
     it 'must escape the path name' do
-      expected = "8f92322f 446 #{URI.escape(whitespaced)} A filename with whitespace.txt"
-      builder.build(whitespaced, options).must_equal expected
+      expected = "8f92322f 446 #{encode_file_path(whitespaced)} A filename with whitespace.txt"
+      expect(builder.build(whitespaced, options)).must_equal expected
     end
 
     it 'must return a correct list for all files in a directory' do
-      expected = "8f92322f 446 #{URI.escape(whitespaced)} A filename with whitespace.txt"
-      expected << "\n8f92322f 446 #{my_file} d/my_file.txt"
-      expected << "\n8f92322f 446 #{without_dot} filename-without-a-dot"
-      expected << "\n8f92322f 446 #{ipsum} ipsum.txt"
-      expected << "\n8f92322f 446 #{lorem} lorem.txt"
-      builder.build(a,options).must_equal expected
+      expected = StringIO.new
+      expected << "8f92322f 446 #{encode_file_path(whitespaced)} A filename with whitespace.txt"
+      expected << "\n8f92322f 446 #{encode_file_path(without_dot)} filename-without-a-dot"
+      expected << "\n8f92322f 446 #{encode_file_path(ipsum)} ipsum.txt"
+      expected << "\n8f92322f 446 #{encode_file_path(lorem)} lorem.txt"
+      expected << "\n8f92322f 446 #{encode_file_path(my_file)} d/my_file.txt"
+      expect(builder.build(a, options)).must_equal expected.string
     end
 
     it 'must allow to mix files and directories' do
-      expected = "8f92322f 446 #{URI.escape(whitespaced)} a/A filename with whitespace.txt"
-      expected << "\n8f92322f 446 #{my_file} a/d/my_file.txt"
-      expected << "\n8f92322f 446 #{without_dot} a/filename-without-a-dot"
-      expected << "\n8f92322f 446 #{ipsum} a/ipsum.txt"
-      expected << "\n8f92322f 446 #{lorem} a/lorem.txt"
-      expected << "\nf7c0867d 1342 #{sit} sit.txt"
-      builder.build([a,sit], options).must_equal expected
+      expected = StringIO.new
+      expected << "8f92322f 446 #{encode_file_path(whitespaced)} a/A filename with whitespace.txt"
+      expected << "\n8f92322f 446 #{encode_file_path(without_dot)} a/filename-without-a-dot"
+      expected << "\n8f92322f 446 #{encode_file_path(ipsum)} a/ipsum.txt"
+      expected << "\n8f92322f 446 #{encode_file_path(lorem)} a/lorem.txt"
+      expected << "\n8f92322f 446 #{encode_file_path(my_file)} a/d/my_file.txt"
+      expected << "\nf7c0867d 1342 #{encode_file_path(sit)} sit.txt"
+      expect(builder.build([a, sit], options)).must_equal expected.string
     end
 
     it 'must preserve directory names' do
       expected = [
-        "8f92322f 446 #{lorem} a/lorem.txt",
-        "8f92322f 446 #{ipsum} a/ipsum.txt",
-        "b2f4655b 11550 #{cargo} b/Cargo.png"
-        ].join("\n")
-      builder.build([lorem,ipsum,cargo], options).must_equal expected
+        "8f92322f 446 #{encode_file_path(lorem)} a/lorem.txt",
+        "8f92322f 446 #{encode_file_path(ipsum)} a/ipsum.txt",
+        "b2f4655b 11550 #{encode_file_path(cargo)} b/Cargo.png"
+      ].join("\n")
+      expect(builder.build([lorem, ipsum, cargo], options)).must_equal expected
     end
 
     it 'must honor the CRC cache' do
-      invalid_but_cached = "781aaabcc124"
-      expected = "#{invalid_but_cached} 446 #{lorem} lorem.txt"
-      builder.build(lorem, options.merge(:crc_cache => {lorem => invalid_but_cached})).must_equal expected
+      invalid_but_cached = '781aaabcc124'
+      expected = "#{invalid_but_cached} 446 #{encode_file_path(lorem)} lorem.txt"
+      expect(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
+      pathes = builder.build([lorem, ipsum]).split("\n").map { |line| line.split.last }
+      expected = ['lorem.txt', 'ipsum.txt']
+      expect(pathes).must_equal expected
+    end
+
+    describe 'when building the manifest from a directory path parameter' do
+      it 'removes trailing slash from builder file path' do
+        dir_path = File.join(File.dirname(lorem), '/')
+        result = builder.build(dir_path)
+        encoded_host_path = ERB::Util.url_encode(File.join(File.expand_path('../data', File.dirname(__dir__)), '/'))
+        manifest = <<~MANIFEST.chomp
+          8f92322f 446 #{encoded_host_path}a%2FA%20filename%20with%20whitespace.txt A filename with whitespace.txt
+          8f92322f 446 #{encoded_host_path}a%2Ffilename-without-a-dot filename-without-a-dot
+          8f92322f 446 #{encoded_host_path}a%2Fipsum.txt ipsum.txt
+          8f92322f 446 #{encoded_host_path}a%2Florem.txt lorem.txt
+          8f92322f 446 #{encoded_host_path}a%2Fd%2Fmy_file.txt d/my_file.txt
+        MANIFEST
+        expect(result).must_equal manifest
+      end
     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
+      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']
+      expect(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
+      options = { base_dir: "#{Pathname.new(lorem).parent.parent}/" }
+      pathes = builder.build([lorem, ipsum], options).split("\n").map { |line| line.split.last }
+      expected = ['a/lorem.txt', 'a/ipsum.txt']
+      expect(pathes).must_equal expected
     end
 
     it 'must correctly encode filenames with a "+"' do
       options = {}
-      name = File.join(Pathname.new(plused).parent.to_s, 'A%20filename%20with%20space%20and%20%2B%20in%20it.txt')
-      expected = "8f92322f 446 #{name} A filename with space and + in it.txt"
-      builder.build([plused], options).must_equal expected
+      name = File.join(Pathname.new(plused).parent.to_s, 'A filename with space and + in it.txt')
+      expected = "8f92322f 446 #{encode_file_path(name)} A filename with space and + in it.txt"
+      expect(builder.build([plused], options)).must_equal expected
     end
 
     it 'must correctly encode the "?" character' do
-      name = File.join(Pathname.new(questions).parent.to_s, 'questions%3F/test.txt')
-      expected = "f03102f5 13 #{name} test.txt"
-
-      builder.build([File.join(questions, 'test.txt')]).must_equal expected
+      name = File.join(Pathname.new(questions).parent.to_s, 'questions?/test.txt')
+      expected = "f03102f5 13 #{encode_file_path(name)} test.txt"
+      expect(builder.build([File.join(questions, 'test.txt')])).must_equal expected
     end
   end
 end

data/test/lib/ngzip/version_test.rb

@@ -1,9 +1,9 @@
-require_relative "../../test_helper"
+# frozen_string_literal: true
 
-describe Ngzip do
+require_relative '../../test_helper'
 
-  it "must define a version" do
-    Ngzip::VERSION.wont_be_nil
+describe Ngzip do
+  it 'must define a version' do
+    expect(Ngzip::VERSION).wont_be_nil
   end
-
-end
+end

data/test/test_helper.rb

@@ -1,4 +1,8 @@
+# frozen_string_literal: true
+
 require 'minitest/autorun'
 require 'minitest/pride'
-require File.expand_path('../../lib/ngzip.rb', __FILE__)
-
+require 'minitest/reporters'
+require 'pry'
+Minitest::Reporters.use!
+require File.expand_path('../lib/ngzip.rb', __dir__)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ngzip
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.1.0
 platform: ruby
 authors:
 - dup2
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-10-20 00:00:00.000000000 Z
+date: 2020-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |-
   Provides a nginx mod_zip compatible file manifest for streaming support.
                             See http://wiki.nginx.org/NginxNgxZip for the nginx module.
@@ -74,7 +88,7 @@ homepage: https://github.com/cargoserver/ngzip
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -89,9 +103,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-signing_key: 
+rubygems_version: 3.0.8
+signing_key:
 specification_version: 4
 summary: Provides a nginx mod_zip compatible file manifest for streaming support
 test_files: