Class: ZipContainer::File

Inherits:
Container show all
Extended by:
Forwardable
Defined in:
lib/zip-container/file.rb

Overview

This class represents a ZipContainer file in PK Zip format. See the OCF and UCF specifications for more details.

This class provides most of the facilities of the Zip::File class in the rubyzip gem. Please also consult the rubyzip documentation alongside these pages.

There are code examples available with the source code of this library.

Constant Summary

Constants inherited from Container

Container::MIMETYPE_FILE

Instance Attribute Summary

Attributes inherited from Container

#mimetype

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Container

open, verify, #verify, verify!, #verify!, verify?, #verify?

Methods included from ManagedEntries

#hidden_directory?, #hidden_entry?, #hidden_file?, #managed_directories, #managed_directory?, #managed_directory_names, #managed_entries, #managed_entry?, #managed_entry_names, #managed_file?, #managed_file_names, #managed_files, #verify_managed_entries, #verify_managed_entries!

Methods included from Util

#entry_name

Methods included from ReservedNames

#reserved_entry?, #reserved_names

Constructor Details

#initialize(location) ⇒ File

:stopdoc:



57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/zip-container/file.rb', line 57

def initialize(location)
  super(location)

  @on_disk = true

  # Here we fake up the connection to the rubyzip filesystem classes so
  # that they also respect the reserved names that we define.
  mapped_zip = ::Zip::FileSystem::ZipFileNameMapper.new(self)
  @fs_dir  = ::Zip::FileSystem::ZipFsDir.new(mapped_zip)
  @fs_file = ::Zip::FileSystem::ZipFsFile.new(mapped_zip)
  @fs_dir.file = @fs_file
  @fs_file.dir = @fs_dir
end

Class Method Details

.create(filename, mimetype) ⇒ Object

:call-seq:

File.create(filename, mimetype) -> container
File.create(filename, mimetype) {|container| ...}

Create a new ZipContainer file on disk with the specified mimetype.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/zip-container/file.rb', line 77

def self.create(filename, mimetype)
  ::Zip::OutputStream.open(filename) do |stream|
    stream.put_next_entry(MIMETYPE_FILE, nil, nil, ::Zip::Entry::STORED)
    stream.write mimetype
  end

  # Now open the newly created container.
  c = new(filename)

  if block_given?
    begin
      yield c
    ensure
      c.close
    end
  end

  c
end

.each_entry(filename, &block) ⇒ Object

:call-seq:

File.each_entry -> Enumerator
File.each_entry {|entry| ...}

Iterate over the entries in the ZipContainer file. The entry objects returned by this method are Zip::Entry objects. Please see the rubyzip documentation for details.



104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/zip-container/file.rb', line 104

def self.each_entry(filename, &block)
  c = new(filename)

  if block_given?
    begin
      c.each(&block)
    ensure
      c.close
    end
  end

  c.each
end

Instance Method Details

#add(entry, src_path, &continue_on_exists_proc) ⇒ Object

:call-seq:

add(entry, src_path, &continue_on_exists_proc)

Convenience method for adding the contents of a file to the ZipContainer file. If asked to add a file with a reserved name, such as the special mimetype header file, this method will raise a ReservedNameClashError.

See the rubyzip documentation for details of the continue_on_exists_proc parameter.



128
129
130
131
132
133
134
 
# File 'lib/zip-container/file.rb', line 128

def add(entry, src_path, &continue_on_exists_proc)
  if reserved_entry?(entry) || managed_directory?(entry)
    raise ReservedNameClashError, entry.to_s
  end

  @container.add(entry, src_path, &continue_on_exists_proc)
end

#commit ⇒ Object Also known as: close

:call-seq:

commit -> boolean
close -> boolean

Commits changes that have been made since the previous commit to the ZipContainer file. Returns true if anything was actually done, false otherwise.



143
144
145
146
147
 
# File 'lib/zip-container/file.rb', line 143

def commit
  return false unless commit_required?

  @container.commit if on_disk?
end

#dir ⇒ Object

:call-seq:

dir -> Zip::ZipFsDir

Returns an object which can be used like ruby’s built in Dir (class) object, except that it works on the ZipContainer file on which this method is invoked.

See the rubyzip documentation for details.



159
160
161
 
# File 'lib/zip-container/file.rb', line 159

def dir
  @fs_dir
end

#file ⇒ Object

:call-seq:

file -> Zip::ZipFsFile

Returns an object which can be used like ruby’s built in File (class) object, except that it works on the ZipContainer file on which this method is invoked.

See the rubyzip documentation for details.



171
172
173
 
# File 'lib/zip-container/file.rb', line 171

def file
  @fs_file
end

#find_entry(entry_name, options = {}) ⇒ Object

:call-seq:

find_entry(entry_name, options = {}) -> Zip::Entry or nil

Searches for the entry with the specified name. Returns nil if no entry is found or if the specified entry is hidden for normal use. You can specify :include_hidden => true to include hidden entries in the search.



182
183
184
185
186
187
188
189
190
 
# File 'lib/zip-container/file.rb', line 182

def find_entry(entry_name, options = {})
  options = { include_hidden: false }.merge(options)

  unless options[:include_hidden]
    return if hidden_entry?(entry_name)
  end

  @container.find_entry(entry_name)
end

#get_entry(entry, options = {}) ⇒ Object

:call-seq:

get_entry(entry, options = {}) -> Zip::Entry or nil

Searches for an entry like find_entry, but throws Errno::ENOENT if no entry is found or if the specified entry is hidden for normal use. You can specify :include_hidden => true to include hidden entries in the search.



199
200
201
202
203
204
205
206
207
 
# File 'lib/zip-container/file.rb', line 199

def get_entry(entry, options = {})
  options = { include_hidden: false }.merge(options)

  unless options[:include_hidden]
    raise Errno::ENOENT, entry if hidden_entry?(entry)
  end

  @container.get_entry(entry)
end

#get_output_stream(entry, permission = nil, &block) ⇒ Object

:call-seq:

get_output_stream(entry, permission = nil) -> stream
get_output_stream(entry, permission = nil) {|stream| ...}

Returns an output stream to the specified entry. If a block is passed the stream object is passed to the block and the stream is automatically closed afterwards just as with ruby’s built-in File.open method.

See the rubyzip documentation for details of the permission_int parameter.



219
220
221
222
223
224
225
 
# File 'lib/zip-container/file.rb', line 219

def get_output_stream(entry, permission = nil, &block)
  if reserved_entry?(entry) || managed_directory?(entry)
    raise ReservedNameClashError, entry.to_s
  end

  @container.get_output_stream(entry, permission, &block)
end

#glob(pattern, *params) ⇒ Object

:call-seq:

glob(pattern) -> Array
glob(pattern) { |entry| ... }
glob(pattern, *parameters) -> Array
glob(pattern, *parameters) { |entry| ... }

Searches for entries given a glob. Hidden files are ignored by default.

The parameters that can be supplied are:

  • flags - A bitwise OR of the FNM_xxx parameters defined in File::Constants. The default value is ::File::FNM_PATHNAME | ::File::FNM_DOTMATCH

  • options - :include_hidden => true will include hidden entries in the search.



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/zip-container/file.rb', line 241

def glob(pattern, *params)
  flags = ::File::FNM_PATHNAME | ::File::FNM_DOTMATCH
  options = { include_hidden: false }

  params.each do |param|
    case param
    when Hash
      options = options.merge(param)
    else
      flags = param
    end
  end

  entries.map do |entry|
    next if !options[:include_hidden] && hidden_entry?(entry)
    next unless ::File.fnmatch(pattern, entry.name.chomp('/'), flags)

    yield(entry) if block_given?
    entry
  end.compact
end

#in_memory? ⇒ Boolean

:call-seq:

in_memory? -> boolean

Is this ZipContainer file memory resident as opposed to stored on disk?

Returns:

  • (Boolean) 


267
268
269
 
# File 'lib/zip-container/file.rb', line 267

def in_memory?
  !@on_disk
end

#mkdir(name, permission = 0o0755) ⇒ Object

:call-seq:

mkdir(name, permission = 0755)

Creates a directory in the ZipContainer file. If asked to create a directory with a name reserved for use by a file this method will raise a ReservedNameClashError.

The new directory will be created with the supplied unix-style permissions. The default (0755) is owner read, write and list; group read and list; and world read and list.



281
282
283
284
285
286
287
 
# File 'lib/zip-container/file.rb', line 281

def mkdir(name, permission = 0o0755)
  if reserved_entry?(name) || managed_file?(name)
    raise ReservedNameClashError, name
  end

  @container.mkdir(name, permission)
end

#on_disk? ⇒ Boolean

:call-seq:

on_disk? -> boolean

Is this ZipContainer file stored on disk as opposed to memory resident?

Returns:

  • (Boolean) 


293
294
295
 
# File 'lib/zip-container/file.rb', line 293

def on_disk?
  @on_disk
end

#remove(entry) ⇒ Object

:call-seq:

remove(entry)

Removes the specified entry from the ZipContainer file. If asked to remove any reserved files such as the special mimetype header file this method will do nothing.



303
304
305
306
307
 
# File 'lib/zip-container/file.rb', line 303

def remove(entry)
  return if reserved_entry?(entry)

  @container.remove(entry)
end

#rename(entry, new_name, &continue_on_exists_proc) ⇒ Object

:call-seq:

rename(entry, new_name, &continue_on_exists_proc)

Renames the specified entry in the ZipContainer file. If asked to rename any reserved files such as the special mimetype header file this method will do nothing. If asked to rename a file to one of the reserved names a ReservedNameClashError is raised.

See the rubyzip documentation for details of the continue_on_exists_proc parameter.

Raises:



319
320
321
322
323
324
 
# File 'lib/zip-container/file.rb', line 319

def rename(entry, new_name, &continue_on_exists_proc)
  return if reserved_entry?(entry)
  raise ReservedNameClashError, new_name if reserved_entry?(new_name)

  @container.rename(entry, new_name, &continue_on_exists_proc)
end

#replace(entry, src_path) ⇒ Object

:call-seq:

replace(entry, src_path)

Replaces the specified entry of the ZipContainer file with the contents of src_path (from the file system). If asked to replace any reserved files such as the special mimetype header file this method will do nothing.



333
334
335
336
337
 
# File 'lib/zip-container/file.rb', line 333

def replace(entry, src_path)
  return if reserved_entry?(entry)

  @container.replace(entry, src_path)
end

#to_s ⇒ Object

:call-seq:

to_s -> String

Return a textual summary of this ZipContainer file.



343
344
345
 
# File 'lib/zip-container/file.rb', line 343

def to_s
  @container.to_s + " - #{@mimetype}"
end