zipline 1.6.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca44760a8a5c6019544aa77857692b43d4cd9f429395173a54b779f276f214f2
-  data.tar.gz: c9aec0dc791f84a315658ae9405e88f1d5b7348822befa69e61c92e261ff3a69
+  metadata.gz: 87ea082c8b6e5b78101eed8383d5851510765a948f5fa836607b14170db32c37
+  data.tar.gz: b7508ab7190eba8dd233d923bc41e3adab5d968f3eee743445a2d7b2f427c26e
 SHA512:
-  metadata.gz: 2c46de9ba175df42d54c36a37dceddb77cf7816e058528750fe0b05c54313aba1992b8ba12d40b9f029a33c088c79a214d3e50e56cbd0b295c74062fe49c7781
-  data.tar.gz: 5022768afbe367ca08c586b33d16f8a044ad79c7cde80b79be4a3d1c9b18c16d2b0d9cdb9d82f75e3df338d101eda5dce80a099c1261e2e3d828ac637569d790
+  metadata.gz: 643f217f94d513a1f517bd421117f7ec51b8df45ac6afe23e1ddbb0f4964dedd46f2b895fe0551ce0e3142f911dc5f07c92254a877cd4960506ade02e955a322
+  data.tar.gz: b6a8960a8a8378b46a13b212f4e1713f6b29f08c60c65c48135b765a48e93892063faf2ba983f3a81bb81df9e7d92f875d0341b571d67afb65ed5c8977ec4023

data/.github/workflows/ci.yml

@@ -22,5 +22,5 @@ jobs:
       with:
         ruby-version: ${{ matrix.ruby-version }}
         bundler-cache: true # 'bundle install' and cache
-    - name: Run tests
+    - name: Run tests and standard
       run: bundle exec rake

data/.standard.yml

@@ -0,0 +1,4 @@
+ruby_version: 2.7
+ignore:
+  - 'spec/**/*':
+    - Lint/ConstantDefinitionInBlock

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in zipline.gemspec
 gemspec

data/README.md

@@ -7,7 +7,7 @@ A gem to stream dynamically generated zip files from a rails application. Unlike
 - Removes need for large disk space or memory allocation to generate zips, even huge zips. So it works on Heroku.
 - The user begins downloading immediately, which decreaceses latency, download time, and timeouts on Heroku.
 
-Zipline now depends on [zip tricks](https://github.com/WeTransfer/zip_tricks), and you might want to just use that directly if you have more advanced use cases.
+Zipline now depends on [zip_kit](https://github.com/julik/zip_kit), and you might want to just use that directly if you have more advanced use cases.
 
 ## Installation
 
@@ -43,7 +43,7 @@ class MyController < ApplicationController
     files = users.map{ |user| [user.avatar, "#{user.username}.png", modification_time: 1.day.ago] }
 
     # we can force duplicate file names to be renamed, or raise an error
-    # we can also pass in our own writer if required to conform with the Delegated [ZipTricks::Streamer object](https://github.com/WeTransfer/zip_tricks/blob/main/lib/zip_tricks/streamer.rb#L147) object.
+    # we can also pass in our own writer if required to conform with the delegated [ZipKit::Streamer object](https://github.com/julik/zip_kit/blob/main/lib/zip_kit/streamer.rb#L147) object.
     zipline(files, 'avatars.zip', auto_rename_duplicate_filenames: true) 
   end
 end
@@ -93,7 +93,7 @@ For directories, just give the files names like "directory/file".
 
 ```Ruby
 avatars = [
-  # remote_url                          zip_path             zip_tricks_options
+  # remote_url                          zip_path             write_file options for Streamer
   [ 'http://www.example.com/user1.png', 'avatars/user1.png', modification_time: Time.now.utc ]
   [ 'http://www.example.com/user2.png', 'avatars/user2.png', modification_time: 1.day.ago ]
   [ 'http://www.example.com/user3.png', 'avatars/user3.png' ]

data/Rakefile

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

data/lib/zipline/version.rb

@@ -1,3 +1,3 @@
 module Zipline
-  VERSION = "1.6.0"
+  VERSION = "2.1.0"
 end

data/lib/zipline/{zip_generator.rb → zip_handler.rb}

@@ -1,39 +1,23 @@
-# this class acts as a streaming body for rails
-# initialize it with an array of the files you want to zip
 module Zipline
-  class ZipGenerator
+  class ZipHandler
     # takes an array of pairs [[uploader, filename], ... ]
-    def initialize(files,  **kwargs_for_streamer)
-      # Use RackBody as it has buffering built-in in zip_tricks 5.x+
-      @body = ZipTricks::RackBody.new(**kwargs_for_streamer) do |streamer|
-        files.each do |file, name, options = {}|
-          handle_file(streamer, file, name.to_s, options)
-        end
-      end
+    def initialize(streamer, logger)
+      @streamer = streamer
+      @logger = logger
     end
 
-    def each(&block)
-      return to_enum(:each) unless block_given?
-      @body.each(&block)
+    def handle_file(file, name, options)
+      normalized_file = normalize(file)
+      write_file(normalized_file, name, options)
     rescue => e
       # Since most APM packages do not trace errors occurring within streaming
       # Rack bodies, it can be helpful to print the error to the Rails log at least
       error_message = "zipline: an exception (#{e.inspect}) was raised  when serving the ZIP body."
-      error_message += " The error occurred when handling #{@filename.inspect}" if @filename
-      logger.error(error_message)
+      error_message += " The error occurred when handling file #{name.inspect}"
+      @logger&.error(error_message)
       raise
     end
 
-    def handle_file(streamer, file, name, options)
-      file = normalize(file)
-
-      # Store the filename so that a sensible error message can be displayed in the log
-      # if writing this particular file fails
-      @filename = name
-      write_file(streamer, file, name, options)
-      @filename = nil
-    end
-
     # This extracts either a url or a local file from the provided file.
     # Currently support carrierwave and paperclip local and remote storage.
     # returns a hash of the form {url: aUrl} or {file: anIoObject}
@@ -67,12 +51,12 @@ module Zipline
       elsif is_url?(file)
         {url: file}
       else
-        raise(ArgumentError, 'Bad File/Stream')
+        raise(ArgumentError, "Bad File/Stream")
       end
     end
 
-    def write_file(streamer, file, name, options)
-      streamer.write_deflated_file(name, **options.slice(:modification_time)) do |writer_for_file|
+    def write_file(file, name, options)
+      @streamer.write_file(name, **options.slice(:modification_time)) do |writer_for_file|
         if file[:url]
           the_remote_uri = URI(file[:url])
 
@@ -87,25 +71,15 @@ module Zipline
         elsif file[:blob]
           file[:blob].download { |chunk| writer_for_file << chunk }
         else
-          raise(ArgumentError, 'Bad File/Stream')
+          raise(ArgumentError, "Bad File/Stream")
         end
       end
     end
 
-    def is_io?(io_ish)
-      io_ish.respond_to? :read
-    end
-
     private
 
-    def logger
-      # Rails is not defined in our tests, and might as well not be defined
-      # elsewhere - or the logger might not be configured correctly
-      if defined?(Rails.logger) && Rails.logger
-        Rails.logger
-      else
-        Logger.new($stderr)
-      end
+    def is_io?(io_ish)
+      io_ish.respond_to? :read
     end
 
     def is_active_storage_attachment?(file)
@@ -117,8 +91,12 @@ module Zipline
     end
 
     def is_url?(url)
-      url = URI.parse(url) rescue false
-      url.kind_of?(URI::HTTP) || url.kind_of?(URI::HTTPS)
+      url = begin
+        URI.parse(url)
+      rescue
+        false
+      end
+      url.is_a?(URI::HTTP) || url.is_a?(URI::HTTPS)
     end
   end
 end

data/lib/zipline.rb

@@ -1,9 +1,7 @@
-require 'content_disposition'
-require 'zipline/version'
-require 'zip_tricks'
-require 'zipline/zip_generator'
-require 'zipline/chunked_body'
-require 'zipline/tempfile_body'
+require "content_disposition"
+require "zip_kit"
+require "zipline/version"
+require "zipline/zip_handler"
 
 # class MyController < ApplicationController
 #   include Zipline
@@ -14,42 +12,17 @@ require 'zipline/tempfile_body'
 #   end
 # end
 module Zipline
-  def zipline(files, zipname = 'zipline.zip', **kwargs_for_new)
-    zip_generator = ZipGenerator.new(files, **kwargs_for_new)
-    headers['Content-Disposition'] = ContentDisposition.format(disposition: 'attachment', filename: zipname)
-    headers['Content-Type'] = Mime::Type.lookup_by_extension('zip').to_s
-    response.sending_file = true
-    response.cache_control[:public] ||= false
-
-    # Disables Rack::ETag if it is enabled (prevent buffering)
-    # see https://github.com/rack/rack/issues/1619#issuecomment-606315714
-    self.response.headers['Last-Modified'] = Time.now.httpdate
-
-    if request.get_header("HTTP_VERSION") == "HTTP/1.0"
-      # If HTTP/1.0 is used it is not possible to stream, and if that happens it usually will be
-      # unclear why buffering is happening. Some info in the log is the least one can do.
-      logger.warn { "The downstream HTTP proxy/LB insists on HTTP/1.0 protocol, ZIP response will be buffered." } if logger
-
-      # If we use Rack::ContentLength it would run through our ZIP block twice - once to calculate the content length
-      # of the response, and once - to serve. We can trade performance for disk space and buffer the response into a Tempfile
-      # since we are already buffering.
-      tempfile_body = TempfileBody.new(request.env, zip_generator)
-      headers["Content-Length"] = tempfile_body.size.to_s
-      headers["X-Zipline-Output"] = "buffered"
-      self.response_body = tempfile_body
-    else
-      # Disable buffering for both nginx and Google Load Balancer, see
-      # https://cloud.google.com/appengine/docs/flexible/how-requests-are-handled?tab=python#x-accel-buffering
-      response.headers["X-Accel-Buffering"] = "no"
-
-      # Make sure Rack::ContentLength does not try to compute a content length,
-      # and remove the one already set
-      headers.delete("Content-Length")
+  def self.included(into_controller)
+    into_controller.include(ZipKit::RailsStreaming)
+    super
+  end
 
-      # and send out in chunked encoding
-      headers["Transfer-Encoding"] = "chunked"
-      headers["X-Zipline-Output"] = "streamed"
-      self.response_body = Chunked.new(zip_generator)
+  def zipline(files, zipname = "zipline.zip", **kwargs_for_zip_kit_stream)
+    zip_kit_stream(filename: zipname, **kwargs_for_zip_kit_stream) do |zip_kit_streamer|
+      handler = Zipline::ZipHandler.new(zip_kit_streamer, logger)
+      files.each do |file, name, options = {}|
+        handler.handle_file(file, name.to_s, options)
+      end
     end
   end
 end

data/spec/lib/zipline/{zip_generator_spec.rb → zip_handler_spec.rb}

@@ -1,58 +1,68 @@
-require 'spec_helper'
-require 'tempfile'
+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
+describe Zipline::ZipHandler do
   before { Fog.mock! }
-  let(:file_attributes){ {
-    key: 'fog_file_tests',
-    body: 'some body',
-    public: true
-  }}
-  let(:directory_attributes){{
-    key: 'fog_directory'
-  }}
-  let(:storage_attributes){{
-    aws_access_key_id: 'fake_access_key_id',
-    aws_secret_access_key: 'fake_secret_access_key',
-    provider: 'AWS'
-  }}
-  let(:storage){ Fog::Storage.new(storage_attributes)}
-  let(:directory){ storage.directories.create(directory_attributes) }
-  let(:file){ directory.files.create(file_attributes) }
-
-  describe '.normalize' do
-    let(:generator){ Zipline::ZipGenerator.new([])}
+  let(:file_attributes) {
+    {
+      key: "fog_file_tests",
+      body: "some body",
+      public: true
+    }
+  }
+  let(:directory_attributes) {
+    {
+      key: "fog_directory"
+    }
+  }
+  let(:storage_attributes) {
+    {
+      aws_access_key_id: "fake_access_key_id",
+      aws_secret_access_key: "fake_secret_access_key",
+      provider: "AWS"
+    }
+  }
+  let(:storage) { Fog::Storage.new(storage_attributes) }
+  let(:directory) { storage.directories.create(directory_attributes) }
+  let(:file) { directory.files.create(file_attributes) }
+
+  describe ".normalize" do
+    let(:handler) { Zipline::ZipHandler.new(_streamer = double, _logger = nil) }
     context "CarrierWave" do
       context "Remote" do
-        let(:file){ CarrierWave::Storage::Fog::File.new(nil,nil,nil) }
+        let(:file) { CarrierWave::Storage::Fog::File.new(nil, nil, nil) }
         it "extracts the url" do
-          allow(file).to receive(:url).and_return('fakeurl')
+          allow(file).to receive(:url).and_return("fakeurl")
           expect(File).not_to receive(:open)
-          expect(generator.normalize(file)).to eq({url: 'fakeurl'})
+          expect(handler.normalize(file)).to eq({url: "fakeurl"})
         end
       end
       context "Local" do
-        let(:file){ CarrierWave::SanitizedFile.new(Tempfile.new('t')) }
+        let(:file) { CarrierWave::SanitizedFile.new(Tempfile.new("t")) }
         it "creates a File" do
-          allow(file).to receive(:path).and_return('spec/fakefile.txt')
-          normalized = generator.normalize(file)
+          allow(file).to receive(:path).and_return("spec/fakefile.txt")
+          normalized = handler.normalize(file)
           expect(normalized.keys).to include(:file)
           expect(normalized[:file]).to be_a File
         end
@@ -61,21 +71,21 @@ describe Zipline::ZipGenerator do
         let(:uploader) { Class.new(CarrierWave::Uploader::Base).new }
 
         context "Remote" do
-          let(:file){ CarrierWave::Storage::Fog::File.new(nil,nil,nil) }
+          let(:file) { CarrierWave::Storage::Fog::File.new(nil, nil, nil) }
           it "extracts the url" do
             allow(uploader).to receive(:file).and_return(file)
-            allow(file).to receive(:url).and_return('fakeurl')
+            allow(file).to receive(:url).and_return("fakeurl")
             expect(File).not_to receive(:open)
-            expect(generator.normalize(uploader)).to eq({url: 'fakeurl'})
+            expect(handler.normalize(uploader)).to eq({url: "fakeurl"})
           end
         end
 
         context "Local" do
-          let(:file){ CarrierWave::SanitizedFile.new(Tempfile.new('t')) }
+          let(:file) { CarrierWave::SanitizedFile.new(Tempfile.new("t")) }
           it "creates a File" do
             allow(uploader).to receive(:file).and_return(file)
-            allow(file).to receive(:path).and_return('spec/fakefile.txt')
-            normalized = generator.normalize(uploader)
+            allow(file).to receive(:path).and_return("spec/fakefile.txt")
+            normalized = handler.normalize(uploader)
             expect(normalized.keys).to include(:file)
             expect(normalized[:file]).to be_a File
           end
@@ -84,20 +94,20 @@ describe Zipline::ZipGenerator do
     end
     context "Paperclip" do
       context "Local" do
-        let(:file){ Paperclip::Attachment.new(:name, :instance) }
+        let(:file) { Paperclip::Attachment.new(:name, :instance) }
         it "creates a File" do
-          allow(file).to receive(:path).and_return('spec/fakefile.txt')
-          normalized = generator.normalize(file)
+          allow(file).to receive(:path).and_return("spec/fakefile.txt")
+          normalized = handler.normalize(file)
           expect(normalized.keys).to include(:file)
           expect(normalized[:file]).to be_a File
         end
       end
       context "Remote" do
-        let(:file){ Paperclip::Attachment.new(:name, :instance, storage: :s3) }
+        let(:file) { Paperclip::Attachment.new(:name, :instance, storage: :s3) }
         it "creates a URL" do
-          allow(file).to receive(:expiring_url).and_return('fakeurl')
+          allow(file).to receive(:expiring_url).and_return("fakeurl")
           expect(File).to_not receive(:open)
-          expect(generator.normalize(file)).to include(url: 'fakeurl')
+          expect(handler.normalize(file)).to include(url: "fakeurl")
         end
       end
     end
@@ -107,7 +117,7 @@ describe Zipline::ZipGenerator do
           attached = create_attached_one
           allow_any_instance_of(Object).to receive(:defined?).and_return(true)
 
-          normalized = generator.normalize(attached)
+          normalized = handler.normalize(attached)
 
           expect(normalized.keys).to include(:blob)
           expect(normalized[:blob]).to be_a(ActiveStorage::Blob)
@@ -119,7 +129,7 @@ describe Zipline::ZipGenerator do
           attachment = create_attachment
           allow_any_instance_of(Object).to receive(:defined?).and_return(true)
 
-          normalized = generator.normalize(attachment)
+          normalized = handler.normalize(attachment)
 
           expect(normalized.keys).to include(:blob)
           expect(normalized[:blob]).to be_a(ActiveStorage::Blob)
@@ -131,7 +141,7 @@ describe Zipline::ZipGenerator do
           blob = create_blob
           allow_any_instance_of(Object).to receive(:defined?).and_return(true)
 
-          normalized = generator.normalize(blob)
+          normalized = handler.normalize(blob)
 
           expect(normalized.keys).to include(:blob)
           expect(normalized[:blob]).to be_a(ActiveStorage::Blob)
@@ -154,7 +164,7 @@ describe Zipline::ZipGenerator do
 
       def create_blob
         blob = ActiveStorage::Blob.new
-        allow(blob).to receive(:service_url).and_return('fakeurl')
+        allow(blob).to receive(:service_url).and_return("fakeurl")
         filename = create_filename
         allow(blob).to receive(:filename).and_return(filename)
         blob
@@ -162,26 +172,26 @@ describe Zipline::ZipGenerator do
 
       def create_filename
         # Rails wraps Blob#filname in this class since Rails 5.2
-        ActiveStorage::Filename.new('test')
+        ActiveStorage::Filename.new("test")
       end
     end
     context "Fog" do
       it "extracts url" do
-        allow(file).to receive(:url).and_return('fakeurl')
+        allow(file).to receive(:url).and_return("fakeurl")
         expect(File).not_to receive(:open)
-        expect(generator.normalize(file)).to eq(url:  'fakeurl')
+        expect(handler.normalize(file)).to eq(url: "fakeurl")
       end
     end
     context "IOStream" do
-      let(:file){ StringIO.new('passthrough')}
+      let(:file) { StringIO.new("passthrough") }
       it "passes through" do
-        expect(generator.normalize(file)).to eq(file: file)
+        expect(handler.normalize(file)).to eq(file: file)
       end
     end
     context "invalid" do
-      let(:file){ Thread.new{} }
+      let(:file) { Thread.new {} }
       it "raises error" do
-        expect{generator.normalize(file)}.to raise_error(ArgumentError)
+        expect { handler.normalize(file) }.to raise_error(ArgumentError)
       end
     end
   end

data/spec/lib/zipline/zipline_spec.rb

@@ -1,8 +1,11 @@
-require 'spec_helper'
-require 'action_controller'
+require "spec_helper"
+require "action_controller"
 
 describe Zipline do
-  before { Fog.mock! }
+  before do
+    Fog.mock!
+    FakeController.logger = nil
+  end
 
   class FakeController < ActionController::Base
     include Zipline
@@ -11,7 +14,7 @@ describe Zipline do
         [StringIO.new("File content goes here"), "one.txt"],
         [StringIO.new("Some other content goes here"), "two.txt"]
       ]
-      zipline(files, 'myfiles.zip', auto_rename_duplicate_filenames: false)
+      zipline(files, "myfiles.zip", auto_rename_duplicate_filenames: false)
     end
 
     class FailingIO < StringIO
@@ -25,11 +28,11 @@ describe Zipline do
         [StringIO.new("File content goes here"), "one.txt"],
         [FailingIO.new("This will fail half-way"), "two.txt"]
       ]
-      zipline(files, 'myfiles.zip', auto_rename_duplicate_filenames: false)
+      zipline(files, "myfiles.zip", auto_rename_duplicate_filenames: false)
     end
   end
 
-  it 'passes keyword parameters to ZipTricks::Streamer' do
+  it "passes keyword parameters to ZipKit::OutputEnumerator" do
     fake_rack_env = {
       "HTTP_VERSION" => "HTTP/1.0",
       "REQUEST_METHOD" => "GET",
@@ -37,16 +40,20 @@ describe Zipline do
       "PATH_INFO" => "/download",
       "QUERY_STRING" => "",
       "SERVER_NAME" => "host.example",
-      "rack.input" => StringIO.new,
+      "rack.input" => StringIO.new
     }
-    expect(ZipTricks::Streamer).to receive(:new).with(anything, auto_rename_duplicate_filenames: false).and_call_original
+    expect(ZipKit::OutputEnumerator).to receive(:new).with(auto_rename_duplicate_filenames: false).and_call_original
 
     status, headers, body = FakeController.action(:download_zip).call(fake_rack_env)
 
-    expect(headers['Content-Disposition']).to eq("attachment; filename=\"myfiles.zip\"; filename*=UTF-8''myfiles.zip")
+    expect(status).to eq(200)
+    expect(headers["Content-Disposition"]).to eq("attachment; filename=\"myfiles.zip\"; filename*=UTF-8''myfiles.zip")
+    expect {
+      body.each {}
+    }.not_to raise_error
   end
 
-  it 'sends the exception raised in the streaming body to the Rails logger' do
+  it "sends the exception raised in the streaming body to the Rails logger" do
     fake_rack_env = {
       "HTTP_VERSION" => "HTTP/1.0",
       "REQUEST_METHOD" => "GET",
@@ -54,15 +61,17 @@ describe Zipline do
       "PATH_INFO" => "/download",
       "QUERY_STRING" => "",
       "SERVER_NAME" => "host.example",
-      "rack.input" => StringIO.new,
+      "rack.input" => StringIO.new
     }
-    expect(ZipTricks::Streamer).to receive(:new).with(anything, auto_rename_duplicate_filenames: false).and_call_original
-    fake_logger = double()
-    expect(Logger).to receive(:new).and_return(fake_logger)
-    expect(fake_logger).to receive(:error).with(instance_of(String))
+    fake_logger = double
+    allow(fake_logger).to receive(:warn)
+    expect(fake_logger).to receive(:error).with(a_string_matching(/when serving the ZIP/))
+
+    FakeController.logger = fake_logger
 
     expect {
-      FakeController.action(:download_zip_with_error_during_streaming).call(fake_rack_env)
+      _status, _headers, body = FakeController.action(:download_zip_with_error_during_streaming).call(fake_rack_env)
+      body.each {}
     }.to raise_error(/Something wonky/)
   end
 end

data/spec/spec_helper.rb

@@ -1,22 +1,22 @@
-require 'rspec'
-require 'active_support'
-require 'active_support/core_ext'
-require 'action_dispatch'
+require "rspec"
+require "active_support"
+require "active_support/core_ext"
+require "action_dispatch"
 
-require 'zipline'
-require 'paperclip'
-require 'fog-aws'
-require 'carrierwave'
+require "zipline"
+require "paperclip"
+require "fog-aws"
+require "carrierwave"
 
-Dir["#{File.expand_path('..', __FILE__)}/support/**/*.rb"].sort.each { |f| require f }
+Dir["#{File.expand_path("..", __FILE__)}/support/**/*.rb"].sort.each { |f| require f }
 
 CarrierWave.configure do |config|
-  config.fog_provider = 'fog/aws'
+  config.fog_provider = "fog/aws"
   config.fog_credentials = {
-    provider:              'AWS',
-    aws_access_key_id:     'dummy',
-    aws_secret_access_key: 'data',
-    region:                'us-west-2',
+    provider: "AWS",
+    aws_access_key_id: "dummy",
+    aws_secret_access_key: "data",
+    region: "us-west-2"
   }
 end
 

data/zipline.gemspec

@@ -1,34 +1,33 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/zipline/version', __FILE__)
+require File.expand_path("../lib/zipline/version", __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["Ram Dobson"]
-  gem.email         = ["ram.dobson@solsystemscompany.com"]
-  gem.description   = %q{a module for streaming dynamically generated zip files}
-  gem.summary       = %q{stream zip files from rails}
-  gem.homepage      = "http://github.com/fringd/zipline"
+  gem.authors = ["Ram Dobson"]
+  gem.email = ["ram.dobson@solsystemscompany.com"]
+  gem.description = "a module for streaming dynamically generated zip files"
+  gem.summary = "stream zip files from rails"
+  gem.homepage = "http://github.com/fringd/zipline"
 
-  gem.files         = `git ls-files`.split($\) - %w{.gitignore}
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.name          = "zipline"
+  gem.files = `git ls-files`.split($\) - %w[.gitignore]
+  gem.executables = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  gem.name = "zipline"
   gem.require_paths = ["lib"]
-  gem.version       = Zipline::VERSION
-  gem.licenses      = ['MIT']
+  gem.version = Zipline::VERSION
+  gem.licenses = ["MIT"]
 
   gem.required_ruby_version = ">= 2.7"
 
-  gem.add_dependency 'actionpack', ['>= 6.0', '< 8.0']
-  gem.add_dependency 'content_disposition', '~> 1.0'
-  gem.add_dependency 'zip_tricks', ['~> 4.8', '< 6'] # Minimum to 4.8.3 which is the last-released MIT version
+  gem.add_dependency "actionpack", [">= 6.0", "< 8.1"]
+  gem.add_dependency "content_disposition", "~> 1.0"
+  gem.add_dependency "zip_kit", ["~> 6", ">= 6.2.0", "< 7"]
 
-  gem.add_development_dependency 'rspec', '~> 3'
-  gem.add_development_dependency 'fog-aws'
-  gem.add_development_dependency 'aws-sdk-s3'
-  gem.add_development_dependency 'carrierwave'
-  gem.add_development_dependency 'paperclip'
-  gem.add_development_dependency 'rake'
+  gem.add_development_dependency "rspec", "~> 3"
+  gem.add_development_dependency "fog-aws"
+  gem.add_development_dependency "aws-sdk-s3"
+  gem.add_development_dependency "carrierwave"
+  gem.add_development_dependency "paperclip"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "standard", "1.28.5" # Very specific version of standard for 2.6 with _known_ settings
 
   # https://github.com/rspec/rspec-mocks/issues/1457
-  gem.add_development_dependency 'rspec-mocks', '~> 3.12'
+  gem.add_development_dependency "rspec-mocks", "~> 3.12"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: zipline
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Ram Dobson
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-12 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -19,7 +18,7 @@ dependencies:
         version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '8.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +28,7 @@ dependencies:
         version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '8.1'
 - !ruby/object:Gem::Dependency
   name: content_disposition
   requirement: !ruby/object:Gem::Requirement
@@ -45,25 +44,31 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: zip_tricks
+  name: zip_kit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.8'
+        version: '6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.8'
+        version: '6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -148,6 +153,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.28.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.28.5
 - !ruby/object:Gem::Dependency
   name: rspec-mocks
   requirement: !ruby/object:Gem::Requirement
@@ -170,17 +189,16 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/ci.yml"
+- ".standard.yml"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - lib/zipline.rb
-- lib/zipline/chunked_body.rb
-- lib/zipline/tempfile_body.rb
 - lib/zipline/version.rb
-- lib/zipline/zip_generator.rb
+- lib/zipline/zip_handler.rb
 - spec/fakefile.txt
-- spec/lib/zipline/zip_generator_spec.rb
+- spec/lib/zipline/zip_handler_spec.rb
 - spec/lib/zipline/zipline_spec.rb
 - spec/spec_helper.rb
 - zipline.gemspec
@@ -188,7 +206,6 @@ homepage: http://github.com/fringd/zipline
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -203,12 +220,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: stream zip files from rails
-test_files:
-- spec/fakefile.txt
-- spec/lib/zipline/zip_generator_spec.rb
-- spec/lib/zipline/zipline_spec.rb
-- spec/spec_helper.rb
+test_files: []

data/lib/zipline/chunked_body.rb

@@ -1,31 +0,0 @@
-module Zipline
-  # A body wrapper that emits chunked responses, creating valid
-  # "Transfer-Encoding: chunked" HTTP response body. This is copied from Rack::Chunked::Body,
-  # because Rack is not going to include that class after version 3.x
-  # Rails has a substitute class for this inside ActionController::Streaming,
-  # but that module is a private constant in the Rails codebase, and is thus
-  # considered "private" from the Rails standpoint. It is not that much code to
-  # carry, so we copy it into our code.
-  class Chunked
-    TERM = "\r\n"
-    TAIL = "0#{TERM}"
-
-    def initialize(body)
-      @body = body
-    end
-
-    # For each string yielded by the response body, yield
-    # the element in chunked encoding - and finish off with a terminator
-    def each
-      term = TERM
-      @body.each do |chunk|
-        size = chunk.bytesize
-        next if size == 0
-
-        yield [size.to_s(16), term, chunk.b, term].join
-      end
-      yield TAIL
-      yield term
-    end
-  end
-end

data/lib/zipline/tempfile_body.rb

@@ -1,52 +0,0 @@
-module Zipline
-  # Contains a file handle which can be closed once the response finishes sending.
-  # It supports `to_path` so that `Rack::Sendfile` can intercept it
-  class TempfileBody
-    TEMPFILE_NAME_PREFIX = "zipline-tf-body-"
-    attr_reader :tempfile
-
-    # @param body[#each] the enumerable that yields bytes, usually a `RackBody`.
-    #   The `body` will be read in full immediately and closed.
-    def initialize(env, body)
-      @tempfile = Tempfile.new(TEMPFILE_NAME_PREFIX)
-      # Rack::TempfileReaper calls close! on tempfiles which get buffered
-      # We wil assume that it works fine with Rack::Sendfile (i.e. the path
-      # to the file getting served gets used before we unlink the tempfile)
-      env['rack.tempfiles'] ||= []
-      env['rack.tempfiles'] << @tempfile
-
-      @tempfile.binmode
-
-      body.each { |bytes| @tempfile << bytes }
-      body.close if body.respond_to?(:close)
-
-      @tempfile.flush
-    end
-
-    # Returns the size of the contained `Tempfile` so that a correct
-    # Content-Length header can be set
-    #
-    # @return [Integer]
-    def size
-      @tempfile.size
-    end
-
-    # Returns the path to the `Tempfile`, so that Rack::Sendfile can send this response
-    # using the downstream webserver
-    #
-    # @return [String]
-    def to_path
-      @tempfile.to_path
-    end
-
-    # Stream the file's contents if `Rack::Sendfile` isn't present.
-    #
-    # @return [void]
-    def each
-      @tempfile.rewind
-      while chunk = @tempfile.read(16384)
-        yield chunk
-      end
-    end
-  end
-end