zipline 1.2.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 60e9847b29f301c7d2a2b7ff9614454f0e3a1193
-  data.tar.gz: b9b391b9478f96f0fa067918e4368a5415332123
+SHA256:
+  metadata.gz: 2a6443ee4c55b4c4d623364d8042bb47f8bdea691f23fb2d5261784826e69ec6
+  data.tar.gz: 0d82621fb810a72c1c4ebb8bb8f0bd7b1cebd3d237a8809068d16f2b3ee8eb63
 SHA512:
-  metadata.gz: e25c8bba3c7b7d6c093637c1323d0a4bb6660e94457e4445cc3e6798f7125e8c5c0b99a334de0430ef4ced180e00a4001c29b6ab9c92525dd0a6eca689b0dbe7
-  data.tar.gz: db9b45bfb987cf97f025c4c2cbeb818a821bd7968524df56ac44d6eaebea4b8420b634815b6a6cde8ff32976e67b20183f8dfa404a0ffa05b91aef824c645a79
+  metadata.gz: 3c5d8ba560e1d17db8207c1e99a5fefa31c59254cc3e55cb876c92a9685ebe9f9351b42c8ee815580bd9dc9e8a18c2c4fd0f5959caacda1450e7a830e3e35060
+  data.tar.gz: b075c04c1f16663dd3e71d650cdd1866cb588f2c88eb25319f79872845fb31fc99055bed1be5a6bc59a7412e21d99a1cee1bb8da40aa8d12376b8c45903c27d9

data/.travis.yml

@@ -1,8 +1,8 @@
 language: ruby
 cache: bundler
 rvm:
-  - 2.3
   - 2.4
   - 2.5
   - 2.6
   - 2.7
+  - 3.0

data/Gemfile

@@ -5,12 +5,10 @@ gemspec
 
 group :development, :test do
   gem 'rspec', '~> 3'
-  gem 'fog'
   gem 'fog-aws'
   gem 'activesupport'
-  gem 'aws-sdk'
+  gem 'aws-sdk-s3'
   gem 'carrierwave'
   gem 'paperclip'
   gem 'rake'
-  gem 'rake-rspec'
 end

data/Rakefile

@@ -1,4 +1,12 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
-require "rake/rspec"
-task :default => :spec
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/lib/zipline/version.rb

@@ -1,3 +1,3 @@
 module Zipline
-  VERSION = "1.2.1"
+  VERSION = "1.4.0"
 end

data/lib/zipline/zip_generator.rb

@@ -14,11 +14,27 @@ module Zipline
 
     def each(&block)
       fake_io_writer = ZipTricks::BlockWrite.new(&block)
-      ZipTricks::Streamer.open(fake_io_writer) do |streamer|
+      # ZipTricks outputs lots of strings in rapid succession, and with
+      # servers it can be beneficial to avoid doing too many tiny writes so that
+      # the number of syscalls is minimized. See https://github.com/WeTransfer/zip_tricks/issues/78
+      # There is a built-in facility for this in ZipTricks which can be used to implement
+      # some cheap buffering here (it exists both in version 4 and version 5). The buffer is really
+      # tiny and roughly equal to the medium Linux socket buffer size (16 KB). Although output
+      # will be not so immediate with this buffering the overall performance will be better,
+      # especially with multiple clients being serviced at the same time.
+      # Note that the WriteBuffer writes the same, retained String object - but the contents
+      # of that object changes between calls. This should work fine with servers where the
+      # contents of the string gets written to a socket immediately before the execution inside
+      # the WriteBuffer resumes), but if the strings get retained somewhere - like in an Array -
+      # this might pose a problem. Unlikely that it will be an issue here though.
+      write_buffer_size = 16 * 1024
+      write_buffer = ZipTricks::WriteBuffer.new(fake_io_writer, write_buffer_size)
+      ZipTricks::Streamer.open(write_buffer) do |streamer|
         @files.each do |file, name, options = {}|
-          handle_file(streamer, file, name, options)
+          handle_file(streamer, file, name.to_s, options)
         end
       end
+      write_buffer.flush! # for any remaining writes
     end
 
     def handle_file(streamer, file, name, options)
@@ -64,7 +80,7 @@ module Zipline
     end
 
     def write_file(streamer, file, name, options)
-      streamer.write_deflated_file(name, options) do |writer_for_file|
+      streamer.write_deflated_file(name, **options.slice(:modification_time)) do |writer_for_file|
         if file[:url]
           the_remote_uri = URI(file[:url])
 

data/lib/zipline.rb

@@ -1,6 +1,7 @@
 require "zipline/version"
 require 'zip_tricks'
 require "zipline/zip_generator"
+require 'uri'
 
 # class MyController < ApplicationController
 #   include Zipline
@@ -13,7 +14,7 @@ require "zipline/zip_generator"
 module Zipline
   def zipline(files, zipname = 'zipline.zip')
     zip_generator = ZipGenerator.new(files)
-    headers['Content-Disposition'] = "attachment; filename=\"#{zipname.gsub '"', '\"'}\""
+    headers['Content-Disposition'] = "attachment; filename=\"#{zipname.gsub '"', '\"'}\"; filename*=UTF-8''#{URI.encode_www_form_component(zipname)}"
     headers['Content-Type'] = Mime::Type.lookup_by_extension('zip').to_s
     response.sending_file = true
     response.cache_control[:public] ||= false

data/spec/lib/zipline/zip_generator_spec.rb

@@ -1,6 +1,23 @@
 require 'spec_helper'
 require 'tempfile'
 
+module ActiveStorage
+  class Attached
+    class One < Attached
+    end
+  end
+  class Attachment; end
+  class Blob; end
+  class Filename
+    def initialize(name)
+      @name = name
+    end
+    def to_s
+      @name
+    end
+  end
+end
+
 describe Zipline::ZipGenerator do
   before { Fog.mock! }
   let(:file_attributes){ {
@@ -85,15 +102,6 @@ describe Zipline::ZipGenerator do
       end
     end
     context "ActiveStorage" do
-      module ActiveStorage
-        class Attached
-          class One < Attached
-          end
-        end
-        class Attachment; end
-        class Blob; end
-      end
-
       context "Attached::One" do
         it "get blob" do
           attached = create_attached_one
@@ -147,8 +155,15 @@ describe Zipline::ZipGenerator do
       def create_blob
         blob = ActiveStorage::Blob.new
         allow(blob).to receive(:service_url).and_return('fakeurl')
+        filename = create_filename
+        allow(blob).to receive(:filename).and_return(filename)
         blob
       end
+
+      def create_filename
+        # Rails wraps Blob#filname in this class since Rails 5.2
+        ActiveStorage::Filename.new('test')
+      end
     end
     context "Fog" do
       it "extracts url" do
@@ -171,6 +186,25 @@ describe Zipline::ZipGenerator do
     end
   end
 
+  describe '.write_file' do
+    let(:file) { StringIO.new('passthrough') }
+
+    context 'when passing an ActiveStorage::Filename object as filename' do
+      let(:filename) { ActiveStorage::Filename.new('test') }
+
+      let(:generator) do
+        Zipline::ZipGenerator.new([[file, filename]])
+      end
+
+      it 'passes a string as filename to ZipTricks' do
+        allow(file).to receive(:url).and_return('fakeurl')
+        expect_any_instance_of(ZipTricks::Streamer).to receive(:write_deflated_file)
+          .with('test')
+        generator.each { |_| 'Test' }
+      end
+    end
+  end
+
   describe 'passing an options hash' do
     let(:file) { StringIO.new('passthrough') }
 
@@ -186,7 +220,7 @@ describe Zipline::ZipGenerator do
         generator.each { |_| 'Test' }
       end
 
-      it 'passes the options hash to ZipTricks' do
+      it 'passes the options hash to ZipTricks as kwargs' do
         allow(file).to receive(:url).and_return('fakeurl')
         expect_any_instance_of(ZipTricks::Streamer).to receive(:write_deflated_file)
           .with(anything, modification_time: mtime)
@@ -205,10 +239,30 @@ describe Zipline::ZipGenerator do
         generator.each { |_| 'Test' }
       end
 
-      it 'passes the options hash to ZipTricks' do
+      it 'passes the options hash to ZipTricks as kwargs' do
+        allow(file).to receive(:url).and_return('fakeurl')
+        expect_any_instance_of(ZipTricks::Streamer).to receive(:write_deflated_file)
+          .with(anything)
+        generator.each { |_| 'Test' }
+      end
+    end
+
+    context 'with extra invalid options' do
+      let(:mtime) { 1.day.ago }
+      let(:generator) do
+        Zipline::ZipGenerator.new([[file, 'test', modification_time: mtime, extra: 'invalid']])
+      end
+
+      it 'passes the whole options hash through handle_file' do
+        expect(generator).to receive(:handle_file)
+          .with(anything, anything, anything, { modification_time: mtime, extra: 'invalid' })
+        generator.each { |_| 'Test' }
+      end
+
+      it 'only passes the kwargs to ZipTricks that it expects (i.e., :modification_time)' do
         allow(file).to receive(:url).and_return('fakeurl')
         expect_any_instance_of(ZipTricks::Streamer).to receive(:write_deflated_file)
-          .with(anything, {})
+          .with(anything, modification_time: mtime)
         generator.each { |_| 'Test' }
       end
     end

data/spec/spec_helper.rb

@@ -2,9 +2,7 @@ require 'rspec'
 require 'active_support'
 require 'active_support/core_ext'
 require 'zipline'
-require 'aws-sdk'
 require 'paperclip'
-require 'fog'
 require 'fog-aws'
 require 'carrierwave'
 
@@ -21,8 +19,6 @@ CarrierWave.configure do |config|
 
 end
 
-
-
 RSpec.configure do |config|
   config.color = true
   config.order = :random

data/zipline.gemspec

@@ -16,6 +16,6 @@ Gem::Specification.new do |gem|
   gem.version       = Zipline::VERSION
   gem.licenses      = ['MIT']
 
+  gem.add_dependency 'actionpack', ['>= 3.2.1', '< 8.0']
   gem.add_dependency 'zip_tricks', ['>= 4.2.1', '< 6.0']
-  gem.add_dependency 'rails', ['>= 3.2.1', '< 6.1']
 end

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: zipline
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Ram Dobson
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-25 00:00:00.000000000 Z
+date: 2022-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: zip_tricks
+  name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.1
+        version: 3.2.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.1
+        version: 3.2.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '8.0'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: zip_tricks
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.1
+        version: 4.2.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.1
+        version: 4.2.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.0'
 description: a module for streaming dynamically generated zip files
 email:
 - ram.dobson@solsystemscompany.com
@@ -73,7 +73,7 @@ homepage: http://github.com/fringd/zipline
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -88,9 +88,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: stream zip files from rails
 test_files: