class ZipContainer::Container

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.

Attributes

mimetype[R]

The mime-type of this ZipContainer file.

Public Class Methods

create(filename, mimetype = "application/epub+zip") → document click to toggle source
create(filename, mimetype = "application/epub+zip") {|document| ...}

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

# File lib/zip-container/container.rb, line 94
def Container.create(filename, mimetype, &block)
  ::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 → Enumerator click to toggle source
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.

# File lib/zip-container/container.rb, line 121
def Container.each_entry(filename, &block)
  c = new(filename)

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

  c.each
end
open(filename) → document click to toggle source
open(filename) {|document| ...}

Open an existing ZipContainer file from disk. It will be checked for conformance upon first access.

# File lib/zip-container/container.rb, line 141
def Container.open(filename, &block)
  c = new(filename)

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

  c
end
verify(filename) → boolean click to toggle source

Verify that the specified ZipContainer file conforms to the specification. This method returns false if there are any problems at all with the file (including if it cannot be found).

# File lib/zip-container/container.rb, line 161
def Container.verify(filename)
  begin
    new(filename).verify!
  rescue
    return false
  end

  true
end
verify!(filename) click to toggle source

Verify that the specified ZipContainer file conforms to the specification. This method raises exceptions when errors are found or if there is something fundamental wrong with the file itself (e.g. it cannot be found).

# File lib/zip-container/container.rb, line 178
def Container.verify!(filename)
  new(filename).verify!
end

Public Instance Methods

add(entry, src_path, &continue_on_exists_proc) click to toggle source

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.

# File lib/zip-container/container.rb, line 192
def add(entry, src_path, &continue_on_exists_proc)
  if reserved_entry?(entry) || managed_directory?(entry)
    raise ReservedNameClashError.new(entry.to_s)
  end

  @zipfile.add(entry, src_path, &continue_on_exists_proc)
end
close()
Alias for: commit
comment → String click to toggle source

Returns the ZipContainer file comment, if it has one.

# File lib/zip-container/container.rb, line 386
    
comment = comment click to toggle source

Set the ZipContainer file comment to the new value.

# File lib/zip-container/container.rb, line 393
    
commit → boolean click to toggle source
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.

# File lib/zip-container/container.rb, line 207
def commit
  return false unless commit_required?

  if on_disk?
    @zipfile.commit
  end
end
Also aliased as: close
commit_required? → boolean click to toggle source

Returns true if any changes have been made to this ZipContainer file since the last commit, false otherwise.

# File lib/zip-container/container.rb, line 401
    
dir → Zip::ZipFsDir click to toggle source

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.

# File lib/zip-container/container.rb, line 225
def dir
  @fs_dir
end
each → Enumerator click to toggle source
each {|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.

# File lib/zip-container/container.rb, line 411
    
entries → Enumerable click to toggle source

Returns an Enumerable containing all the entries in the ZipContainer file The entry objects returned by this method are Zip::Entry objects. Please see the rubyzip documentation for details.

# File lib/zip-container/container.rb, line 420
    
extract(entry, dest_path, &on_exists_proc) click to toggle source

Extracts the specified entry of the ZipContainer file to dest_path.

See the rubyzip documentation for details of the on_exists_proc parameter.

# File lib/zip-container/container.rb, line 430
    
file → Zip::ZipFsFile click to toggle source

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.

# File lib/zip-container/container.rb, line 237
def file
  @fs_file
end
find_entry(entry) → Zip::Entry click to toggle source

Searches for entries within the ZipContainer file with the specified name. Returns nil if no entry is found. See also get_entry.

# File lib/zip-container/container.rb, line 438
    
get_entry(entry) → Zip::Entry click to toggle source

Searches for an entry within the ZipContainer file in a similar manner to find_entry, but throws +Errno::ENOENT+ if no entry is found.

# File lib/zip-container/container.rb, line 446
    
get_input_stream(entry) → stream click to toggle source
get_input_stream(entry) {|stream| ...}

Returns an input 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.

# File lib/zip-container/container.rb, line 456
    
get_output_stream(entry, permission = nil) → stream click to toggle source
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.

# File lib/zip-container/container.rb, line 251
def get_output_stream(entry, permission = nil, &block)
  if reserved_entry?(entry) || managed_directory?(entry)
    raise ReservedNameClashError.new(entry.to_s)
  end

  @zipfile.get_output_stream(entry, permission, &block)
end
glob(*args) → Array of Zip::Entry click to toggle source
glob(*args) {|entry| ...}

Searches for entries within the ZipContainer file that match the given glob.

See the rubyzip documentation for details of the parameters that can be passed in.

# File lib/zip-container/container.rb, line 468
    
in_memory? → boolean click to toggle source

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

# File lib/zip-container/container.rb, line 263
def in_memory?
  !@on_disk
end
mkdir(name, permission = 0755) click to toggle source

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.

# File lib/zip-container/container.rb, line 277
def mkdir(name, permission = 0755)
  if reserved_entry?(name) || managed_file?(name)
    raise ReservedNameClashError.new(name)
  end

  @zipfile.mkdir(name, permission)
end
name → String click to toggle source

Returns the filename of this ZipContainer file.

# File lib/zip-container/container.rb, line 475
    
on_disk? → boolean click to toggle source

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

# File lib/zip-container/container.rb, line 289
def on_disk?
  @on_disk
end
read(entry) → String click to toggle source

Returns a string containing the contents of the specified entry.

# File lib/zip-container/container.rb, line 482
    
remove(entry) click to toggle source

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.

# File lib/zip-container/container.rb, line 299
def remove(entry)
  return if reserved_entry?(entry)
  @zipfile.remove(entry)
end
rename(entry, new_name, &continue_on_exists_proc) click to toggle source

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.

# File lib/zip-container/container.rb, line 314
def rename(entry, new_name, &continue_on_exists_proc)
  return if reserved_entry?(entry)
  raise ReservedNameClashError.new(new_name) if reserved_entry?(new_name)

  @zipfile.rename(entry, new_name, &continue_on_exists_proc)
end
replace(entry, src_path) click to toggle source

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.

# File lib/zip-container/container.rb, line 328
def replace(entry, src_path)
  return if reserved_entry?(entry)
  @zipfile.replace(entry, src_path)
end
size → int click to toggle source

Returns the number of entries in the ZipContainer file.

# File lib/zip-container/container.rb, line 489
  
to_s → String click to toggle source

Return a textual summary of this ZipContainer file.

# File lib/zip-container/container.rb, line 337
def to_s
  @zipfile.to_s + " - #{@mimetype}"
end
verify! click to toggle source

Verify the contents of this ZipContainer file. All managed files and directories are checked to make sure that they exist, if required.

# File lib/zip-container/container.rb, line 346
def verify!
  verify_managed_entries!
end