class ZipContainer::Dir

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

This class provides most of the facilities of the standard ::Dir class. Please also consult the ruby Dir documentation alongside these pages.

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

Public Class Methods

create(pathname, mimetype) → container

create(pathname, mimetype) {|container| ...}

Source

# File lib/zip-container/dir.rb, line 64
def self.create(pathname, mimetype)
  ::Dir.mkdir(pathname) unless ::File.directory?(pathname)
  ::File.write(::File.join(pathname, MIMETYPE_FILE), mimetype)

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

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

  c
end

Create a new (or convert an existing) directory as a ZipContainer with the specified mimetype.

Public Instance Methods

close → nil

Source

# File lib/zip-container/dir.rb, line 156

Equal to ::Dir.close

each { |filename| ... } → dir

each → an_enumerator

Source

# File lib/zip-container/dir.rb, line 164

Equal to ::Dir.each

path → string or nil

Source

# File lib/zip-container/dir.rb, line 173

Equal to ::Dir.path

pos → integer

Source

# File lib/zip-container/dir.rb, line 181

Equal to ::Dir.pos

pos = integer → integer

Source

# File lib/zip-container/dir.rb, line 189

Equal to ::Dir.pos=

read

read(path) → file contents

Source

# File lib/zip-container/dir.rb, line 93
def read(name = nil)
  return @container.read if name.nil?

  ::File.read(full_path(name))
end

Provides compatibility between directory and zip containers. If called without any parameters it acts like ::Dir.read but if called with a path then it acts like Zip::File#read.

Please see the documentation of the relevant method for more details.

rewind → dir

Source

# File lib/zip-container/dir.rb, line 197

Equal to ::Dir.rewind

seek(integer) → dir

Source

# File lib/zip-container/dir.rb, line 205

Equal to ::Dir.seek

tell → integer

Source

# File lib/zip-container/dir.rb, line 213

Equal to ::Dir.tell