Module: ActiveStorage::SendZipHelper

Defined in:
lib/active_storage/send_zip_helper.rb

Overview

This module contains some methods usefull for ‘ActiveStorage::SendZip.send_zip` method.

Class Method Summary collapse

Class Method Details

.construct_with_hash(files, temp_folder) ⇒ String

Parses hash to build out directories where folders are key names

Parameters:

  • files (ActiveStorage::Attached::One|ActiveStorage::Attached::Many|Array|Hash) —

    file(s) to save

Returns:

  • (String) —

    folder path of saved files



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/active_storage/send_zip_helper.rb', line 37

def self.construct_with_hash(files, temp_folder)
  filepaths = []

  files.each do |subfolder, filesHash|
    filesHash = [filesHash] unless filesHash.is_a? Array

    filesHash.each do |f|
      # Build directory strucutre recursively for hashes
      if f.is_a? Hash
        # Build folder for hash entry
        folder = File.join(temp_folder, subfolder.to_s)
        Dir.mkdir(folder) unless Dir.exist?(folder)

        filepaths += construct_with_hash(f, folder)
      # Save attachement
      else
        filepaths << save_file_on_server(f, temp_folder, subfolder: subfolder.to_s)
      end
    end
  end

  filepaths
end

.create_temporary_zip_file(folderpath) ⇒ String

Create a temporary zip file & return the content as bytes

Parameters:

  • folderpath (String) —

    folder path

Returns:

  • (String) —

    as content of zip



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/active_storage/send_zip_helper.rb', line 101

def self.create_temporary_zip_file(folderpath)
  temp_file = Tempfile.new('user.zip')
  folderpath_glob = File.join folderpath, '**', '*'

  files = Dir.glob(folderpath_glob).reject { |e| File.directory? e }

  begin
    # Initialize the temp file as a zip file
    Zip::OutputStream.open(temp_file) { |zos| }

    # open the zip
    Zip::File.open(temp_file.path, Zip::File::CREATE) do |zip|
      files.each do |filepath|
        filepath_zip = filepath.sub(folderpath, '').sub(File::SEPARATOR, '')
        zip.add filepath_zip, filepath
      end
    end

    File.read(temp_file.path)
  ensure
    # close all ressources & remove temporary files
    # temp_file.close
    # temp_file.unlink
    # FileUtils.rm_rf(folderpath)
  end
end

.save_file_on_server(file, folder, subfolder: nil, resize_to_limit: nil) ⇒ String

Save the given file on the server

Parameters:

  • file (ActiveStorage::Attached) —

    files to save

  • folder (String) —

    where to store the file

  • resize_to_limit (Array) (defaults to: nil) —

    resize to limit filter in ImageProcessing format [width, height]

Returns:

  • (String) —

    the filepath of file created



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/active_storage/send_zip_helper.rb', line 67

def self.save_file_on_server(file, folder, subfolder: nil, resize_to_limit: nil)
  filename = file.filename.to_s

  folder = File.join(folder, subfolder) unless subfolder.nil?
  Dir.mkdir(folder) unless Dir.exist?(folder)

  # build filepath & create path if not exists
  filepath = File.join(folder, filename)

  # Ensure that filename not already exists
  if File.exist? filepath
    # create a new random filenames
    basename = File.basename filename
    extension = File.extname filename

    filename = "#{basename}_#{SecureRandom.uuid}#{extension}"
    filepath = File.join folder, filename
  end

  # resize images if needed
  unless resize_to_limit.nil?
    file = file.variant(resize_to_limit: resize_to_limit).processed
  end

  # write the file on disk
  File.open(filepath, 'wb') { |f| f.write(file.service.download(file.key)) }

  filepath
end

.save_files_on_server(files, resize_to_limit: nil) ⇒ String

Download active storage files on server in a temporary folder

Parameters:

  • files (ActiveStorage::Attached::One|ActiveStorage::Attached::Many|Array|Hash) —

    file(s) to save

  • resize_to_limit (Array) (defaults to: nil) —

    resize to limit filter in ImageProcessing format [width, height]

Returns:

  • (String) —

    folder path of saved files



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/active_storage/send_zip_helper.rb', line 17

def self.save_files_on_server(files, resize_to_limit: nil)
  require 'zip'
  # get a temporary folder and create it
  temp_folder = Dir.mktmpdir 'active_storage-send_zip'

  if files.is_a? Hash
    filepaths = construct_with_hash(files, temp_folder)
  elsif files.respond_to? :each
    files.each { |file| save_file_on_server(file, temp_folder, resize_to_limit: resize_to_limit) }
  else
    raise ArgumentError, '`files` must be an hash or an iterable object'
  end

  temp_folder
end