zipline 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 954c769aaf6aa7780a8770fcc9991a1beea5b326f1920b6bfdcc921dcef1a34d
-  data.tar.gz: 7e40d818c5b4e7da8c8167f42e9318d0d7cfee2384657a84fa3ee294184f9819
+  metadata.gz: 87ea082c8b6e5b78101eed8383d5851510765a948f5fa836607b14170db32c37
+  data.tar.gz: b7508ab7190eba8dd233d923bc41e3adab5d968f3eee743445a2d7b2f427c26e
 SHA512:
-  metadata.gz: 5a39143123fc75b44b94d88ca0e8d31a41e2b63f9368ff70692c502c21171baf406e4eb8bb7a9f9ef0885d2883d8c5e5d40995499068a2a0a9a9906c9135bc68
-  data.tar.gz: 84c7b320023d7195f619638b87acaa14121852a643a727a9ba5c1d848ed3d4bc045832347586ca3b454dfb753ad189f2bfe96d5e97bd6140065a1fa0ef4675b8
+  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/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 = "2.0.0"
+  VERSION = "2.1.0"
 end

data/lib/zipline/zip_handler.rb

@@ -14,7 +14,7 @@ module Zipline
       # 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 file #{name.inspect}"
-      @logger.error(error_message) if @logger
+      @logger&.error(error_message)
       raise
     end
 
@@ -51,7 +51,7 @@ module Zipline
       elsif is_url?(file)
         {url: file}
       else
-        raise(ArgumentError, 'Bad File/Stream')
+        raise(ArgumentError, "Bad File/Stream")
       end
     end
 
@@ -71,7 +71,7 @@ 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
@@ -91,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,7 +1,7 @@
-require 'content_disposition'
-require 'zip_kit'
-require 'zipline/version'
-require 'zipline/zip_handler'
+require "content_disposition"
+require "zip_kit"
+require "zipline/version"
+require "zipline/zip_handler"
 
 # class MyController < ApplicationController
 #   include Zipline
@@ -17,7 +17,7 @@ module Zipline
     super
   end
 
-  def zipline(files, zipname = 'zipline.zip', **kwargs_for_zip_kit_stream)
+  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 = {}|

data/spec/lib/zipline/zip_handler_spec.rb

@@ -1,17 +1,21 @@
-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
@@ -20,38 +24,44 @@ end
 
 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(:handler){ Zipline::ZipHandler.new(_streamer = double(), _logger = nil)}
+  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(handler.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')
+          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
@@ -61,20 +71,20 @@ describe Zipline::ZipHandler 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(handler.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')
+            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
@@ -84,20 +94,20 @@ describe Zipline::ZipHandler 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')
+          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(handler.normalize(file)).to include(url: 'fakeurl')
+          expect(handler.normalize(file)).to include(url: "fakeurl")
         end
       end
     end
@@ -154,7 +164,7 @@ describe Zipline::ZipHandler 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::ZipHandler 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(handler.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(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{handler.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,5 +1,5 @@
-require 'spec_helper'
-require 'action_controller'
+require "spec_helper"
+require "action_controller"
 
 describe Zipline do
   before do
@@ -14,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
@@ -28,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 ZipKit::OutputEnumerator' do
+  it "passes keyword parameters to ZipKit::OutputEnumerator" do
     fake_rack_env = {
       "HTTP_VERSION" => "HTTP/1.0",
       "REQUEST_METHOD" => "GET",
@@ -40,16 +40,20 @@ describe Zipline do
       "PATH_INFO" => "/download",
       "QUERY_STRING" => "",
       "SERVER_NAME" => "host.example",
-      "rack.input" => StringIO.new,
+      "rack.input" => StringIO.new
     }
     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",
@@ -57,17 +61,17 @@ describe Zipline do
       "PATH_INFO" => "/download",
       "QUERY_STRING" => "",
       "SERVER_NAME" => "host.example",
-      "rack.input" => StringIO.new,
+      "rack.input" => StringIO.new
     }
-    fake_logger = double()
+    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 {
-      status, headers, body = FakeController.action(:download_zip_with_error_during_streaming).call(fake_rack_env)
-      body.each { }
+      _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_kit', ['~> 6', '>= 6.2.0', '< 7']
+  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: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Ram Dobson
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-18 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
@@ -154,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
@@ -176,6 +189,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/ci.yml"
+- ".standard.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -192,7 +206,6 @@ homepage: http://github.com/fringd/zipline
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -207,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_handler_spec.rb
-- spec/lib/zipline/zipline_spec.rb
-- spec/spec_helper.rb
+test_files: []