class UCF::Container

The mime-type of this UCF document. By default this is “application/epub+zip”.

Create a new UCF document on disk with the specified mimetype.

# File lib/ucf/container.rb, line 97
def Container.create(filename, mimetype = DEFAULT_MIMETYPE, &block)
  ::Zip::ZipOutputStream.open(filename) do |stream|
    stream.put_next_entry(MIMETYPE_FILE, nil, nil, ::Zip::ZipEntry::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

Iterate over the entries in the UCF document. The entry objects returned by this method are Zip::ZipEntry objects. Please see the rubyzip documentation for details.

# File lib/ucf/container.rb, line 124
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 an existing UCF document from disk. It will be checked for conformance to the UCF specification upon first access.

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

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

  c
end

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

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

  true
end

Verify that the specified UCF document conforms to the UCF 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/ucf/container.rb, line 181
def Container.verify!(filename)
  new(filename).verify!
end

Convenience method for adding the contents of a file to the UCF document. 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/ucf/container.rb, line 195
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

Returns the UCF document comment, if it has one.

# File lib/ucf/container.rb, line 388
    

Set the UCF document comment to the new value.

# File lib/ucf/container.rb, line 395
    

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

# File lib/ucf/container.rb, line 210
def commit
  return false unless commit_required?

  if on_disk?
    @zipfile.commit
  end
end

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

# File lib/ucf/container.rb, line 403
    

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

See the rubyzip documentation for details.

# File lib/ucf/container.rb, line 228
def dir
  @fs_dir
end

Iterate over the entries in the UCF document. The entry objects returned by this method are Zip::ZipEntry objects. Please see the rubyzip documentation for details.

# File lib/ucf/container.rb, line 413
    

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

# File lib/ucf/container.rb, line 422
    

Extracts the specified entry of the UCF document to dest_path.

See the rubyzip documentation for details of the on_exists_proc parameter.

# File lib/ucf/container.rb, line 432
    

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

See the rubyzip documentation for details.

# File lib/ucf/container.rb, line 240
def file
  @fs_file
end

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

# File lib/ucf/container.rb, line 440
    

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

# File lib/ucf/container.rb, line 448
    

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/ucf/container.rb, line 458
    

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/ucf/container.rb, line 254
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

Searches for entries within the UCF document that match the given glob.

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

# File lib/ucf/container.rb, line 469
    

Is this UCF document memory resident as opposed to stored on disk?

# File lib/ucf/container.rb, line 266
def in_memory?
  !@on_disk
end

Creates a directory in the UCF document. If asked to create a directory with a reserved name 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/ucf/container.rb, line 279
def mkdir(name, permission = 0755)
  if reserved_entry?(name) || managed_file?(name)
    raise ReservedNameClashError.new(name)
  end

  @zipfile.mkdir(name, permission)
end

Returns the filename of this UCF document.

# File lib/ucf/container.rb, line 476
    

Is this UCF document stored on disk as opposed to memory resident?

# File lib/ucf/container.rb, line 291
def on_disk?
  @on_disk
end

Returns a string containing the contents of the specified entry.

# File lib/ucf/container.rb, line 483
    

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

# File lib/ucf/container.rb, line 301
def remove(entry)
  return if reserved_entry?(entry)
  @zipfile.remove(entry)
end

Renames the specified entry in the UCF document. 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/ucf/container.rb, line 316
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

Replaces the specified entry of the UCF document 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/ucf/container.rb, line 330
def replace(entry, src_path)
  return if reserved_entry?(entry)
  @zipfile.replace(entry, src_path)
end

Returns the number of entries in the UCF document.

# File lib/ucf/container.rb, line 490
  

Return a textual summary of this UCF document.

# File lib/ucf/container.rb, line 339
def to_s
  @zipfile.to_s + " - #{@mimetype}"
end

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

# File lib/ucf/container.rb, line 348
def verify!
  verify_managed_entries!
end