ngzip 1.0.4 → 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 456fae1b62d713966116eba3fc4a54ed579722faee0eb6c70f10559ed9777417
+  data.tar.gz: 77b9dc4077689d672b732025c41e913e6b6326c4659a7eeaa36c190a6d7d2089
+SHA512:
+  metadata.gz: '09275f7ae55b7c94af391eb829f6810016093a57ae550cad93f82f9f5e7c2ca99eea7e9781bc9f895ca97a22ffa39e845fac6449b196768bd502b3f36a88069b'
+  data.tar.gz: 6f0fcb9a9daf07ac7de34d468591bdb1920644eb8c2691b4b63a100ce59f0cf5005c7569f51d99bd47d9d6f0c256f2326e27a40d944e63b36e95cdb24ef8a2db

data/.github/workflows/rspec.yaml

@@ -0,0 +1,16 @@
+env:
+  RUBY_VERSION: 2.6.6
+name: Rspec tests
+on: [push,pull_request]
+jobs:
+  rspec-tests:
+    name: RSpec
+    runs-on: ubuntu-18.04
+    steps:
+      - uses: actions/checkout@v1
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ env.RUBY_VERSION }}
+          bundler-cache: true
+      - name: Run tests
+        run: bundler exec rake

data/CHANGELOG.md

@@ -1,3 +1,27 @@
+### 1.2.0 (2021-07-08)
+
+* Fixed an issue with brackets in file names (thanks to @mecampbellsoup)
+* Code cleanup
+* Fixed dependencies
+* Activated github CI actions
+
+### 1.1.0 (2020-11-25)
+
+* Exclude file name from detect common prefix (thanks to @mecampbellsoup)
+* Code cleanup
+
+### 1.0.7 (2017-10-20)
+
+* Fixed an issue with '?' encoding
+
+### 1.0.6 (2013-12-12)
+
+* Fixed a regression from 1.0.5 where directories were included due to the changed pattern
+
+### 1.0.5 (2013-12-12)
+
+* Fixed issue #2 (files without extensions being ignored)
+
 ### 1.0.4 (2013-09-20)
 
 * Fixed issue #1 ("+" character in filename)
@@ -17,4 +41,3 @@
 ### 1.0.0 (2013-07-14)
 
 * Initial public release
-

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/LICENSE.txt

@@ -1,4 +1,5 @@
 Copyright (c) 2013 ncode gmbh
+Copyright (c) 2017 CargoServer AG
 
 MIT License
 

data/README.md

@@ -22,7 +22,7 @@ Or install it yourself as:
 In a controller
 
 ```ruby
-b = Nginx::Builder.new()
+b = Ngzip::Builder.new()
 response.headers['X-Archive-Files'] = 'zip'
 render :text => b.build(["/data/test/Report.pdf", "/data/test/LargeArchive.tar"])
 ```
@@ -67,6 +67,7 @@ fetch the actual file data and would support any location type (even proxied).
 ## License
 
 Copyright (c) 2013, ncode gmbh. All Rights Reserved.
+Copyright (c) 2017, CargoServer AG. All Rights Reserved.
+Copyright (c) 2021, Swiss Cyber Gate AG. All Rights Reserved.
 
 This project is licenced under the [MIT License](LICENSE.txt).
-

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,113 +1,119 @@
+# frozen_string_literal: true
+
 require 'zlib'
 require 'uri'
+require 'erb'
+require 'refinements'
+
+using Refinements
 
 module Ngzip
-  
+  # The manifest builder based on the file list
   class Builder
-    
     BUFFER_SIZE = 8 * 1024
-    
+
     # Public: Build the files manifest for mod_zip, see http://wiki.nginx.org/NginxNgxZip for the specs.
-    # 
+    #
     # files - An Array of absolute file path elements
     # options - The options, see below
-    # 
+    #
     # 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
 
     # 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 
+
+    # Public: Encode the string
     #
     # Returns the encoded string using URL escape formatting
     def self.encode(string)
-      URI.encode(string).sub('+', "%2B")
+      ERB::Util.url_encode(string)
     end
-    
+
     private
-    
+
     # Internal: Compute a common prefix from a list of path elements
-    # 
+    #
     # list - The list of file path elements
-    # 
+    #
     # 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
-    # 
+    #
     def file_list(files)
       Array(files).map do |e|
         if File.directory?(e)
-          Dir.glob("#{e}/**/*.*")
+          # `expand_path` removes any trailing slash from the path string
+          # `String#escape_glob` handles bracket literals otherwise interpreted as glob control characters
+          sanitized_path = File.expand_path(e.escape_glob)
+          Dir.glob("#{sanitized_path}/**/*").reject { |f| File.directory?(f) }
         else
           e
         end
       end.flatten
     end
-    
-    
-    # Internal: Compute the CRC-32 checksum for a file unless the settings 
-    # disable the computation (:crc => false) and this method returns "-"
-    # 
+
+    # Internal: Compute the CRC-32 checksum for a file unless the settings
+    # disable the computation (crc: false) and this method returns "-"
+    #
     # file - The full path to the file
     # settings - The settings hash
-    # 
+    #
     # Returns a hex string
     def compute_crc32(file, settings)
       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
-          crc32 = Zlib.crc32(buffer, crc32) 
+      File.open(file, 'rb') do |f|
+        while (buffer = f.read(BUFFER_SIZE))
+          crc32 = Zlib.crc32(buffer, crc32)
         end
       end
       crc32.to_s(16)
     end
-    
   end
-  
-end
+end

data/lib/ngzip/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ngzip
-  VERSION = "1.0.4"
+  VERSION = '1.2.0'
 end

data/lib/refinements.rb

@@ -0,0 +1,9 @@
+module Refinements
+  refine String do
+    # Ref: https://stackoverflow.com/questions/14127343/why-dir-glob-in-ruby-doesnt-see-files-in-folders-named-with-square-brackets
+    # Ref: https://bugs.ruby-lang.org/issues/8258
+    def escape_glob
+      self.gsub(/[\\\{\}\[\]\*\?]/) { |x| "\\" + x }
+    end
+  end
+end

data/ngzip.gemspec

@@ -1,24 +1,28 @@
-# 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@ncode.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.required_ruby_version = '>= 2.3'
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'bundler', '>= 2.2.10'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rubocop'
 end

data/test/data/a/d/my_file.txt

@@ -0,0 +1 @@
+Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

data/test/data/a/filename-without-a-dot

@@ -0,0 +1 @@
+Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

data/test/data/c/[brackets]/(parenthesis).txt

@@ -0,0 +1,3 @@
+Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+
+Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

data/test/data/c/questions?/test.txt

@@ -0,0 +1 @@
+Tyrell Corp.

data/test/lib/ngzip/builder_test.rb

@@ -1,122 +1,168 @@
-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
-  end  
-
+    expect(Ngzip.respond_to?(:build)).must_equal true
+  end
 end
 
 describe Ngzip::Builder do
-  
-  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(: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__)}
-  
+  def encode_file_path(path)
+    ERB::Util.url_encode path
+  end
+
+  let(:builder) { Ngzip::Builder.new }
+  let(:sit) { File.expand_path('../../data/sit.txt', __dir__) }
+  let(:lorem) { File.expand_path('../../data/a/lorem.txt', __dir__) }
+  let(:ipsum) { File.expand_path('../../data/a/ipsum.txt', __dir__) }
+  let(:my_file) { File.expand_path('../../data/a/d/my_file.txt', __dir__) }
+  let(:without_dot) { File.expand_path('../../data/a/filename-without-a-dot', __dir__) }
+  let(:whitespaced) { File.expand_path('../../data/a/A filename with whitespace.txt', __dir__) }
+  let(:a) { File.expand_path('../../data/a', __dir__) }
+  let(:cargo) { File.expand_path('../../data/b/Cargo.png', __dir__) }
+  let(:plused) { File.expand_path('../../data/c/A filename with space and + in it.txt', __dir__) }
+  let(:questions) { File.expand_path('../../data/c/questions?', __dir__) }
+  let(:brackets) { File.expand_path('../../data/c/[brackets]', __dir__) }
+
   it 'must be defined' do
-    Ngzip::Builder.wont_be_nil
-  end 
-  
+    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      
-    end          
+      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 #{ipsum} ipsum.txt"
-      expected << "\n8f92322f 446 #{lorem} lorem.txt"
-      builder.build(a,options).must_equal expected
+      expected = <<~MANIFEST.chomp
+        8f92322f 446 #{encode_file_path(whitespaced)} A filename with whitespace.txt
+        8f92322f 446 #{encode_file_path(without_dot)} filename-without-a-dot
+        8f92322f 446 #{encode_file_path(ipsum)} ipsum.txt
+        8f92322f 446 #{encode_file_path(lorem)} lorem.txt
+        8f92322f 446 #{encode_file_path(my_file)} d/my_file.txt
+      MANIFEST
+      expect(builder.build(a, options).lines.sort.map(&:chomp)).must_equal expected.lines.sort.map(&:chomp)
     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 #{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 = <<~MANIFEST.chomp
+        8f92322f 446 #{encode_file_path(whitespaced)} a/A filename with whitespace.txt
+        8f92322f 446 #{encode_file_path(without_dot)} a/filename-without-a-dot
+        8f92322f 446 #{encode_file_path(ipsum)} a/ipsum.txt
+        8f92322f 446 #{encode_file_path(lorem)} a/lorem.txt
+        8f92322f 446 #{encode_file_path(my_file)} a/d/my_file.txt
+        f7c0867d 1342 #{encode_file_path(sit)} sit.txt
+      MANIFEST
+      expect(builder.build([a, sit], options).lines.sort.map(&:chomp)).must_equal expected.lines.sort.map(&:chomp)
     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
+      describe 'the path includes brackets' do
+        it 'handles special characters in file names' do
+          result = builder.build(brackets)
+          encoded_host_path = ERB::Util.url_encode(File.join(File.expand_path('../data', File.dirname(__dir__)), '/'))
+          manifest = <<~MANIFEST.chomp
+            dee5e05b 894 #{encoded_host_path}c%2F%5Bbrackets%5D%2F%28parenthesis%29.txt (parenthesis).txt
+          MANIFEST
+          expect(result).must_equal manifest
+        end
+      end
+
+      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.lines.sort.map(&:chomp)).must_equal manifest.lines.sort.map(&:chomp)
+      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?/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,58 +1,68 @@
 --- !ruby/object:Gem::Specification
 name: ngzip
 version: !ruby/object:Gem::Version
-  version: 1.0.4
-  prerelease: 
+  version: 1.2.0
 platform: ruby
 authors:
 - dup2
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-09-20 00:00:00.000000000 Z
+date: 2021-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 2.2.10
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 2.2.10
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: ! "Provides a nginx mod_zip compatible file manifest for streaming support.\n
-  \                         See http://wiki.nginx.org/NginxNgxZip for the nginx module."
+- !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.
 email:
-- zarkov@ncode.ch
+- zarkov@cargoserver.ch
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rvmrc
+- ".github/workflows/rspec.yaml"
+- ".gitignore"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -61,13 +71,18 @@ files:
 - lib/ngzip.rb
 - lib/ngzip/builder.rb
 - lib/ngzip/version.rb
+- lib/refinements.rb
 - ngzip.gemspec
 - test/data/a/A filename with whitespace.txt
+- test/data/a/d/my_file.txt
+- test/data/a/filename-without-a-dot
 - test/data/a/ipsum.txt
 - test/data/a/lorem.txt
 - test/data/b/Cargo.png
 - test/data/b/dolor.txt
 - test/data/c/A filename with space and + in it.txt
+- test/data/c/[brackets]/(parenthesis).txt
+- test/data/c/questions?/test.txt
 - test/data/sit.txt
 - test/lib/ngzip/builder_test.rb
 - test/lib/ngzip/version_test.rb
@@ -75,41 +90,37 @@ files:
 homepage: https://github.com/cargoserver/ngzip
 licenses:
 - MIT
-post_install_message: 
+metadata: {}
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
-      segments:
-      - 0
-      hash: 870021569406491909
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 870021569406491909
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.25
-signing_key: 
-specification_version: 3
+rubygems_version: 3.0.8
+signing_key:
+specification_version: 4
 summary: Provides a nginx mod_zip compatible file manifest for streaming support
 test_files:
 - test/data/a/A filename with whitespace.txt
+- test/data/a/d/my_file.txt
+- test/data/a/filename-without-a-dot
 - test/data/a/ipsum.txt
 - test/data/a/lorem.txt
 - test/data/b/Cargo.png
 - test/data/b/dolor.txt
 - test/data/c/A filename with space and + in it.txt
+- test/data/c/[brackets]/(parenthesis).txt
+- test/data/c/questions?/test.txt
 - test/data/sit.txt
 - test/lib/ngzip/builder_test.rb
 - test/lib/ngzip/version_test.rb

data/.rvmrc

@@ -1,48 +0,0 @@
-#!/usr/bin/env bash
-
-# This is an RVM Project .rvmrc file, used to automatically load the ruby
-# development environment upon cd'ing into the directory
-
-# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
-# Only full ruby name is supported here, for short names use:
-#     echo "rvm use 1.9.3" > .rvmrc
-environment_id="ruby-1.9.3-p392@ngzip"
-
-# Uncomment the following lines if you want to verify rvm version per project
-# rvmrc_rvm_version="1.18.14 (version)" # 1.10.1 seams as a safe start
-# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
-#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
-#   return 1
-# }
-
-# First we attempt to load the desired environment directly from the environment
-# file. This is very fast and efficient compared to running through the entire
-# CLI and selector. If you want feedback on which environment was used then
-# insert the word 'use' after --create as this triggers verbose mode.
-if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
-  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
-then
-  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
-  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
-    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
-else
-  # If the environment file has not yet been created, use the RVM CLI to select.
-  rvm --create  "$environment_id" || {
-    echo "Failed to create RVM environment '${environment_id}'."
-    return 1
-  }
-fi
-
-# If you use bundler, this might be useful to you:
-# if [[ -s Gemfile ]] && {
-#   ! builtin command -v bundle >/dev/null ||
-#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
-# }
-# then
-#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
-#   gem install bundler
-# fi
-# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
-# then
-#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
-# fi