class ZipContainer::File

The mime-type of this ZipContainer file.

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

# File lib/zip-container/file.rb, line 93
def self.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

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/file.rb, line 120
def self.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 ZipContainer file from disk. It will be checked for conformance upon first access.

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

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

  c
end

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/file.rb, line 160
def self.verify(filename)
  begin
    new(filename).verify!
  rescue
    return false
  end

  true
end

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/file.rb, line 177
def self.verify!(filename)
  new(filename).verify!
end

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/file.rb, line 191
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 ZipContainer file comment, if it has one.

# File lib/zip-container/file.rb, line 454
    

Set the ZipContainer file comment to the new value.

# File lib/zip-container/file.rb, line 461
    

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/file.rb, line 206
def commit
  return false unless commit_required?

  if on_disk?
    @zipfile.commit
  end
end

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

# File lib/zip-container/file.rb, line 469
    

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/file.rb, line 224
def dir
  @fs_dir
end

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/file.rb, line 479
    

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/file.rb, line 488
    

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/file.rb, line 498
    

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/file.rb, line 236
def file
  @fs_file
end

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.

# File lib/zip-container/file.rb, line 247
def find_entry(entry_name, options = {})
  options = {:include_hidden => false}.merge(options)

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

  @zipfile.find_entry(entry_name)
end

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.

# File lib/zip-container/file.rb, line 264
def get_entry(entry, options = {})
  options = {:include_hidden => false}.merge(options)

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

  @zipfile.get_entry(entry)
end

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/file.rb, line 524
    

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/file.rb, line 284
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 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.

# File lib/zip-container/file.rb, line 306
def glob(pattern, *params, &block)
  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

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

# File lib/zip-container/file.rb, line 331
def in_memory?
  !@on_disk
end

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/file.rb, line 345
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 ZipContainer file.

# File lib/zip-container/file.rb, line 543
    

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

# File lib/zip-container/file.rb, line 357
def on_disk?
  @on_disk
end

Returns a string containing the contents of the specified entry.

# File lib/zip-container/file.rb, line 550
    

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/file.rb, line 367
def remove(entry)
  return if reserved_entry?(entry)
  @zipfile.remove(entry)
end

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/file.rb, line 382
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 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/file.rb, line 396
def replace(entry, src_path)
  return if reserved_entry?(entry)
  @zipfile.replace(entry, src_path)
end

Returns the number of entries in the ZipContainer file.

# File lib/zip-container/file.rb, line 557
  

Return a textual summary of this ZipContainer file.

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

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/file.rb, line 414
def verify!
  verify_managed_entries!
end