This class represents a UCF file in PK Zip format. See learn.adobe.com/wiki/display/PDFNAV/Universal+Container+Format for more details.
This class mostly provides all the facilities of the
Zip::ZipFile
class in the rubyzip gem. Please also consult the
rubyzip documentation: rubydoc.info/gems/rubyzip/0.9.9/frames
There are code examples available with the source code of this library.
The mime-type of this UCF file. By default this is “application/epub+zip”.
Create a new UCF file on disk with the specified mimetype.
# File lib/ucf/container.rb, line 80 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 Container.open(filename, &block) end
Verify that the specified UCF file conforms to
the UCF specification. This method returns
false
if there are any problems at all with the file
(including if it can’t be found) or true
if it conforms.
# File lib/ucf/container.rb, line 115 def Container.verify(filename) begin Container.verify!(filename) rescue return false end true end
Convenience method for adding the contents of a file to the UCF file.
See the rubyzip documentation for details of the
continue_on_exists_proc
parameter.
# File lib/ucf/container.rb, line 215
Closes the UCF file committing any changes that have been made.
# File lib/ucf/container.rb, line 222
Returns the UCF file comment, if it has one.
# File lib/ucf/container.rb, line 229
Commits changes that have been made since the previous commit to the UCF file.
# File lib/ucf/container.rb, line 237
Returns an object which can be used like ruby’s built in Dir
(class) object, except that it works on the UCF
file on which this method is invoked.
See the rubyzip documentation for details.
# File lib/ucf/container.rb, line 248
Extracts the specified entry to dest_path
.
See the rubyzip documentation for details of the
on_exists_proc
parameter.
# File lib/ucf/container.rb, line 258
Returns an object which can be used like ruby’s built in File
(class) object, except that it works on the UCF
file on which this method is invoked.
See the rubyzip documentation for details.
# File lib/ucf/container.rb, line 269
Searches for entries with the specified name. Returns nil
if
no entry is found. See also get_entry
.
# File lib/ucf/container.rb, line 277
Searches for an entry like find_entry
, but throws
+Errno::ENOENT+ if no entry is found.
# File lib/ucf/container.rb, line 285
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 295
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 308
Searches for entries given a glob.
See the rubyzip documentation for details of the parameters that can be passed in.
# File lib/ucf/container.rb, line 319
Creates a directory.
See the rubyzip documentation for details of the
permission_int
parameter.
# File lib/ucf/container.rb, line 329
Returns the filename of this UCF file.
# File lib/ucf/container.rb, line 336
Returns a string containing the contents of the specified entry.
# File lib/ucf/container.rb, line 343
Removes the specified entry. If asked to remove the special mimetype header file this method will do nothing.
# File lib/ucf/container.rb, line 141 def remove(entry) return if mimetype_entry?(entry) @zipfile.remove(entry) end
Renames the specified entry. If asked to rename the special mimetype header
file this method will do nothing. See the rubyzip documentation for details
of the continue_on_exists_proc
parameter.
# File lib/ucf/container.rb, line 152 def rename(entry, new_name, &continue_on_exists_proc) return if mimetype_entry?(entry) @zipfile.rename(entry, new_name, continue_on_exists_proc) end
Replaces the specified entry with the contents of src_path
(from the file system). If asked to replace the special mimetype header
file this method will do nothing.
# File lib/ucf/container.rb, line 163 def replace(entry, src_path) return if mimetype_entry?(entry) @zipfile.replace(entry, src_path) end
Return a String representation of this UCF file.
# File lib/ucf/container.rb, line 172 def to_s @zipfile.to_s + " - #{@mimetype}" end