Class: Zip::StreamableStream

Inherits:
Entry
  • Object
show all
Defined in:
lib/zip/streamable_stream.rb

Overview

:nodoc:all

Constant Summary

Constants inherited from Entry

Entry::DEFLATED, Entry::EFS, Entry::STORED

Instance Attribute Summary

Attributes inherited from Entry

#comment, #compressed_size, #compression_method, #crc, #dirty, #external_file_attributes, #extra, #filepath, #follow_symlinks, #fstype, #ftype, #gp_flags, #header_signature, #internal_file_attributes, #local_header_offset, #name, #restore_ownership, #restore_permissions, #restore_times, #size, #unix_gid, #unix_perms, #unix_uid, #zipfile

Instance Method Summary collapse

Methods inherited from Entry

#<=>, #==, #calculate_local_header_size, #cdir_header_size, #check_c_dir_entry_comment_size, #check_c_dir_entry_signature, #check_c_dir_entry_static_header_length, #check_name, #comment_size, #encrypted?, #extra_size, #extract, #file_stat, #file_type_is?, #gather_fileinfo_from_srcpath, #get_extra_attributes_from_path, #get_raw_input_stream, #incomplete?, #local_entry_offset, #name_is_directory?, #name_safe?, #name_size, #next_header_offset, #pack_c_dir_entry, #pack_local_entry, #parent_as_string, read_c_dir_entry, #read_c_dir_entry, #read_c_dir_extra_field, read_local_entry, #read_local_entry, read_zip_64_long, read_zip_long, read_zip_short, #set_default_vars_values, #set_extra_attributes_on_path, #set_ftype_from_c_dir_entry, #set_unix_attributes_on_path, #time, #time=, #to_s, #unpack_c_dir_entry, #unpack_local_entry, #verify_local_header_size!, #write_c_dir_entry, #write_local_entry

Constructor Details

#initialize(entry) ⇒ StreamableStream

Returns a new instance of StreamableStream.



3
4
5
6
7
 
# File 'lib/zip/streamable_stream.rb', line 3

def initialize(entry)
  super(entry)
  @temp_file = Tempfile.new(::File.basename(name))
  @temp_file.binmode
end

Instance Method Details

#clean_up ⇒ Object 



44
45
46
 
# File 'lib/zip/streamable_stream.rb', line 44

def clean_up
  @temp_file.unlink
end

#get_input_stream ⇒ Object 



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/zip/streamable_stream.rb', line 21

def get_input_stream
  unless @temp_file.closed?
    raise StandardError, "cannot open entry for reading while its open for writing - #{name}"
  end

  @temp_file.open # reopens tempfile from top
  @temp_file.binmode
  if block_given?
    begin
      yield(@temp_file)
    ensure
      @temp_file.close
    end
  else
    @temp_file
  end
end

#get_output_stream ⇒ Object 



9
10
11
12
13
14
15
16
17
18
19
 
# File 'lib/zip/streamable_stream.rb', line 9

def get_output_stream
  if block_given?
    begin
      yield(@temp_file)
    ensure
      @temp_file.close
    end
  else
    @temp_file
  end
end

#write_to_zip_output_stream(output_stream) ⇒ Object 



39
40
41
42
 
# File 'lib/zip/streamable_stream.rb', line 39

def write_to_zip_output_stream(output_stream)
  output_stream.put_next_entry(self)
  get_input_stream { |is| ::Zip::IOExtras.copy_stream(output_stream, is) }
end