ngzip 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84899280f348b240160b5c6984b7a4130a7a48f71b9c7d903051f99a36326f09
-  data.tar.gz: 1b1b057b9da9d80900035e732ed586b13c9e5a25659b4b9ac226862f7d6782b4
+  metadata.gz: 456fae1b62d713966116eba3fc4a54ed579722faee0eb6c70f10559ed9777417
+  data.tar.gz: 77b9dc4077689d672b732025c41e913e6b6326c4659a7eeaa36c190a6d7d2089
 SHA512:
-  metadata.gz: 6f5b599664e6b4f49de86596596ae5bdae4f9ab8601c260e58e075c6376d6a37c5aa25a441baa971cf590a1b11d218e675369e67140ca9076df197fc2c62aeaa
-  data.tar.gz: 815fb0735456a2020781276b456c47e8e76d567e2ef8b35bcd65856e38913c55e00c717cb1a0ced8da4f8e39d1d9febf9deec9645dcb9d2bf4de2790520ddee1
+  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,15 @@
+### 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

data/README.md

@@ -68,5 +68,6 @@ fetch the actual file data and would support any location type (even proxied).
 
 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/lib/ngzip/builder.rb

@@ -3,6 +3,9 @@
 require 'zlib'
 require 'uri'
 require 'erb'
+require 'refinements'
+
+using Refinements
 
 module Ngzip
   # The manifest builder based on the file list
@@ -81,7 +84,8 @@ module Ngzip
       Array(files).map do |e|
         if File.directory?(e)
           # `expand_path` removes any trailing slash from the path string
-          sanitized_path = File.expand_path(e)
+          # `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

data/lib/ngzip/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ngzip
-  VERSION = '1.1.0'
+  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

@@ -2,7 +2,7 @@
 
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'english'
+require 'English'
 require 'ngzip/version'
 
 Gem::Specification.new do |spec|
@@ -20,8 +20,9 @@ Gem::Specification.new do |spec|
   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.required_ruby_version = '>= 2.3'
 
-  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'bundler', '>= 2.2.10'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rubocop'
 end

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/lib/ngzip/builder_test.rb

@@ -16,16 +16,17 @@ describe Ngzip::Builder do
   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(: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(: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(: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(: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
     expect(Ngzip::Builder).wont_be_nil
@@ -67,24 +68,26 @@ describe Ngzip::Builder do
     end
 
     it 'must return a correct list for all files in a directory' do
-      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
+      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 = 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
+      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
@@ -109,6 +112,17 @@ describe Ngzip::Builder do
     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)
@@ -120,7 +134,7 @@ describe Ngzip::Builder do
           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
+        expect(result.lines.sort.map(&:chomp)).must_equal manifest.lines.sort.map(&:chomp)
       end
     end
 

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: ngzip
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - dup2
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-25 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
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 2.2.10
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 2.2.10
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -61,6 +61,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/rspec.yaml"
 - ".gitignore"
 - CHANGELOG.md
 - Gemfile
@@ -70,6 +71,7 @@ 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
@@ -79,6 +81,7 @@ files:
 - 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
@@ -96,7 +99,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -116,6 +119,7 @@ test_files:
 - 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