zipline 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b56c703c9733a9c781d4d81eb83826a8de4a647238a83d9ade835fa034c8a84c
-  data.tar.gz: 0f1cd2b80086cb0a3fcd572aa18d03f03228820870f93b8ec9da7cb6591c165c
+  metadata.gz: 8735b5a6429dcffa8672a1a970cc37145eadfd5e5ff13e2cb5b3f08166895d14
+  data.tar.gz: a4555919f140b0661cb12fd0e6f92900e419319ebf7ec7c376ce19034dffd9a9
 SHA512:
-  metadata.gz: 0b97a0e674b144d21eeacf5ed955dcf1e62639479f63e73c988d405d3ed707c8d45e64f33bf3bb98eeebc4fabeacf991f2e60c5c23367152a677e2a9e616e43c
-  data.tar.gz: e54fb0c40ad64959b1c1965a45312aafa5fe0fa6547d626f54795dab8027c0208a4550589fb933266620c0e00d98eb1685daede1b3395539da81f2bf24887a85
+  metadata.gz: 758292743ee475bc2a276bd00d953fa4f0b1cb1c4ccd2ceae7b2c7dbeced0e1a901a609d183a68c6eeaa898693045f3d5f4ee23bfece0c35b379fb7ce170cdc2
+  data.tar.gz: 7383e439111008fa964a2d762f6855351d3a0372df973d453e0b205aee57f53d9fc8aea54e4f7efed6719b3b8318768f8d125e314ad277f2855bac29fa63c5e2

data/.github/workflows/ci.yml

@@ -11,7 +11,6 @@ jobs:
       fail-fast: false
       matrix:
         ruby-version:
-          - head
           - '3.1'
           - '3.0'
           - '2.7'

data/Gemfile

@@ -7,6 +7,7 @@ group :development, :test do
   gem 'rspec', '~> 3'
   gem 'fog-aws'
   gem 'activesupport'
+  gem 'actionpack'
   gem 'aws-sdk-s3'
   gem 'carrierwave'
   gem 'paperclip'

data/README.md

@@ -41,7 +41,10 @@ class MyController < ApplicationController
     # responds to :url, :path or :file.
     # :modification_time is an optional third argument you can use.
     files = users.map{ |user| [user.avatar, "#{user.username}.png", modification_time: 1.day.ago] }
-    zipline(files, 'avatars.zip')
+
+    # 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.
+    zipline(files, 'avatars.zip', auto_rename_duplicate_filenames: true) 
   end
 end
 ```

data/lib/zipline/version.rb

@@ -1,3 +1,3 @@
 module Zipline
-  VERSION = "1.4.1"
+  VERSION = "1.5.0"
 end

data/lib/zipline/zip_generator.rb

@@ -3,8 +3,9 @@
 module Zipline
   class ZipGenerator
     # takes an array of pairs [[uploader, filename], ... ]
-    def initialize(files)
+    def initialize(files,  **kwargs_for_new)
       @files = files
+      @kwargs_for_new = kwargs_for_new
     end
 
     #this is supposed to be streamed!
@@ -29,7 +30,7 @@ module Zipline
       # 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|
+      ZipTricks::Streamer.open(write_buffer, **@kwargs_for_new) do |streamer|
         @files.each do |file, name, options = {}|
           handle_file(streamer, file, name.to_s, options)
         end

data/lib/zipline.rb

@@ -12,8 +12,8 @@ require "zipline/zip_generator"
 #   end
 # end
 module Zipline
-  def zipline(files, zipname = 'zipline.zip')
-    zip_generator = ZipGenerator.new(files)
+  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

data/spec/lib/zipline/zip_generator_spec.rb

@@ -216,7 +216,7 @@ describe Zipline::ZipGenerator do
 
       it 'passes the options hash through handle_file' do
         expect(generator).to receive(:handle_file)
-          .with(anything, anything, anything, modification_time: mtime)
+          .with(anything, anything, anything, { modification_time: mtime })
         generator.each { |_| 'Test' }
       end
 
@@ -267,4 +267,9 @@ describe Zipline::ZipGenerator do
       end
     end
   end
+  it 'passes along constructor options to ZipTricks streamer' do
+    expect(ZipTricks::Streamer).to receive(:open).with(anything, { :some => 'options' })
+    generator = Zipline::ZipGenerator.new([file, 'somefile'], :some => 'options')
+    generator.each { |_| 'Test' }
+  end
 end

data/spec/lib/zipline/zipline_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+require 'ostruct'
+
+describe Zipline do
+  before { Fog.mock! }
+
+  let (:undertest) {
+    class TestZipline
+
+      attr_accessor :headers
+      attr_accessor :response
+      attr_accessor :response_body
+      def initialize 
+        @headers = {}
+        @response = OpenStruct.new(:cache_control => {}, :headers => {} )
+      end
+      include Zipline
+    end 
+    return TestZipline.new()
+  }
+
+
+  it 'passes arguments along' do
+    expect(Zipline::ZipGenerator).to receive(:new)
+          .with(['some', 'fake', 'files'], { some: 'options' })
+    undertest.zipline(['some', 'fake', 'files'], 'myfiles.zip', some: 'options')
+    expect(undertest.headers['Content-Disposition']).to eq("attachment; filename=\"myfiles.zip\"; filename*=UTF-8''myfiles.zip")
+  end
+end

data/spec/spec_helper.rb

@@ -1,6 +1,8 @@
 require 'rspec'
 require 'active_support'
 require 'active_support/core_ext'
+require 'action_dispatch'
+
 require 'zipline'
 require 'paperclip'
 require 'fog-aws'

data/zipline.gemspec

@@ -23,5 +23,5 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'zip_tricks', ['>= 4.2.1', '< 6.0']
 
   # https://github.com/rspec/rspec-mocks/issues/1457
-  gem.add_development_dependency 'rspec-mocks', ['~> 3.10', '!= 3.10.3']
+  gem.add_development_dependency 'rspec-mocks', '3.10.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zipline
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.0
 platform: ruby
 authors:
 - Ram Dobson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-08 00:00:00.000000000 Z
+date: 2022-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -68,22 +68,16 @@ dependencies:
   name: rspec-mocks
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.10'
-    - - "!="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 3.10.3
+        version: 3.10.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.10'
-    - - "!="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 3.10.3
+        version: 3.10.2
 description: a module for streaming dynamically generated zip files
 email:
 - ram.dobson@solsystemscompany.com
@@ -101,6 +95,7 @@ files:
 - lib/zipline/zip_generator.rb
 - spec/fakefile.txt
 - spec/lib/zipline/zip_generator_spec.rb
+- spec/lib/zipline/zipline_spec.rb
 - spec/spec_helper.rb
 - zipline.gemspec
 homepage: http://github.com/fringd/zipline
@@ -122,11 +117,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.11
 signing_key:
 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