libarchive-ruby-swig 0.5.1 → 0.5.2

data/ext/libarchive-ruby-swig/extconf.rb

@@ -21,7 +21,7 @@ if find_executable('g++')
 end
 
 if swig = find_executable('swig')
-  `#{swig} -c++ -ruby -features autodoc libarchive.i`
+  `#{swig} -c++ -ruby -features autodoc=0 libarchive.i`
   $distcleanfiles << 'libarchive_wrap.cxx'
 else
   $stderr.write "You need SWIG to compile this extension.\n"

data/lib/libarchive_doc.rb

@@ -0,0 +1,465 @@
+#
+# This file is part of "libarchive-ruby-swig", a simple SWIG wrapper around
+# libarchive.
+#
+# Copyright 2011, Tobias Koch <tobias.koch@gmail.com>
+# 
+# libarchive-ruby-swig is licensed under a simplified BSD License. A copy of the
+# license text can be found in the file LICENSE.txt distributed with the source.
+#
+
+#
+module Archive
+
+  ##
+  #
+  # Thrown on problems with opening or processing an archive.
+  #
+  class Error < StandardError
+  end
+
+  ##
+  #
+  # This class is not meant to be used directly. It exists for the sole purpose
+  # of initializing the <code>Archive::ENTRY_*</code> constants in a
+  # platform-independent way.
+  #
+  class Stat
+
+    private
+
+    def self.new()
+    end
+  end
+
+  class Entry
+
+    ##
+    #
+    # Is Entry a regular file?
+    #
+    def is_file
+    end
+
+    ##
+    #
+    # Is Entry a directory?
+    #
+    def is_directory
+    end
+
+    ##
+    #
+    # Is Entry a symbolic link?
+    #
+    def is_symbolic_link
+    end
+
+    ##
+    #
+    # Is Entry a block device?
+    #
+    def is_block_special
+    end
+
+    ##
+    #
+    # Is Entry a char device?
+    #
+    def is_character_special
+    end
+
+    ##
+    #
+    # Is Entry a fifo?
+    #
+    def is_fifo
+    end
+
+    ##
+    #
+    # Is Entry a socket?
+    #
+    def is_socket
+    end
+
+    ##
+    #
+    # Use one of the <code>Archive::ENTRY_*</code> to specify the filetype of
+    # the Entry.
+    #
+    def filetype=(filetype)
+    end
+
+    ##
+    #
+    # Device major number of device on which this Entry resided. This field
+    # will not be available in most cases and is, in any case,
+    # platform-specific.
+    #
+    def devmajor
+      return numeric_result
+    end
+
+    ##
+    #
+    # Sets the device major number of the device on which this Entry resides. This
+    # field will not be availabla in most cases and is, in any case,
+    # platform-specific.
+    #
+    def devmajor=(devmajor)
+    end
+
+    ##
+    #
+    # Device minor number of device on which this Entry resided. This field
+    # will not be available in most cases and is, in any case,
+    # platform-specific.
+    #
+    def devminor
+      return numeric_result
+    end
+
+    ##
+    #
+    # Sets the device minor number of the device on which this Entry resides. This
+    # field will not be availabla in most cases and is, in any case,
+    # platform-specific.
+    #
+    def devminor=(devminor)
+    end
+
+    ##
+    #
+    # Returns the atime of the saved Entry as a timestamp since epoch.
+    #
+    def atime
+    end
+
+    ##
+    #
+    # Sets the atime of the saved Entry from a timestamp.
+    #
+    def atime(atime)
+    end
+
+    ##
+    #
+    # Resets the Entry.
+    #
+    def clear
+    end
+
+    ##
+    #
+    # Returns an exact clone of Entry.
+    #
+    Entry *clone();
+
+    ##
+    #
+    # Device id of the device on which entry resided. This is usually unused
+    # and, in any case, platform-specific.
+    #
+    def dev
+    end
+
+    ##
+    #
+    # Sets the device id of the device on which entry resided. This is usually
+    # unused and, in any case, platform-specific.
+    #
+    def dev=(dev)
+    end
+
+    ##
+    #
+    # Group id of the Entry.
+    #
+    def gid
+    end
+
+    ##
+    #
+    # Sets the group id of the Entry.
+    #
+    def gid=(gid)
+    end
+
+    ##
+    #
+    # Group name of the Entry.
+    #
+    def gname
+    end
+
+    ##
+    #
+    # Sets the group name of the Entry.
+    #
+    def gname=(gname)
+    end
+
+    ##
+    #
+    # Path of file this entry was hardlinked to.
+    #
+    def hardlink
+    end
+
+    ##
+    #
+    # Sets the path to the file this entry is hard-linked to.
+    #
+    def hardlink=
+    end
+
+    ##
+    #
+    # Inode of Entry.
+    #
+    def ino
+    end
+
+    ##
+    #
+    # Sets the inode of Entry.
+    #
+    def ino=(ino)
+    end
+
+    ##
+    #
+    # Permission bits and filetype of entry
+    #
+    def mode
+    end
+
+    ##
+    #
+    # Sets the permission bits (and/or filetype) of Entry.
+    #
+    def mode=(mode)
+    end
+
+    ##
+    #
+    # Returns the mtime of the saved Entry as a timestamp since epoch.
+    #
+    def mtime
+    end
+
+    ##
+    #
+    # Sets the mtime of the saved Entry from a timestamp.
+    #
+    def mtime=(mtime)
+    end
+
+    ##
+    #
+    # Number of hard links to this Entry.
+    #
+    def nlink
+    end
+
+    ##
+    #
+    # Sets the number of hard links to this Entry.
+    #
+    def nlink=(num_links)
+    end
+
+    ##
+    #
+    # Returns the pathname of this Entry.
+    #
+    def pathname
+    end
+
+    ##
+    #
+    # Sets the pathname of this Entry.
+    #
+    def pathname=(pathname)
+    end
+
+    ##
+    #
+    # The dev major number of the device this Entry represents.
+    #
+    def rdevmajor
+    end
+
+    ##
+    #
+    # Sets the dev major number of the device this Entry represents.
+    #
+    def rdevmajor=(devmajor)
+    end
+
+    ##
+    #
+    # The dev minor number of the device this Entry represents.
+    #
+    def rdevminor
+    end
+
+    ##
+    #
+    # Sets the dev minor number of the device this Entry represents.
+    #
+    def rdevminor=(devminor)
+    end
+
+    ##
+    #
+    # Size of the Entry. In case Entry is a symlink, returns the size of
+    # symlink's target name.
+    #
+    def size
+    end
+
+    ##
+    #
+    # Sets the size of the Entry. In case Entry is a symlink, this should
+    # be the length of the string set with <code>symlink=</code>.
+    #
+    def size=()
+    end
+
+    ##
+    #
+    # Returns the rarget of a symlink Entry.
+    #
+    def symlink
+    end
+
+    ##
+    #
+    # Sets the target of a symlink Entry.
+    #
+    def symlink=(symlink)
+    end
+
+    ##
+    #
+    # The user id of this Entry.
+    #
+    def uid
+    end
+
+    ##
+    #
+    # Sets the user id of this Entry.
+    #
+    def uid=(uid)
+    end
+
+    ##
+    #
+    # The owner name of this entry.
+    #
+    def uname
+    end
+
+    ##
+    #
+    # Sets the owner name of this Entry.
+    #
+    def uname=(uname)
+    end
+
+    private
+
+    def self.new()
+    end
+  end
+
+  class Reader
+
+    ##
+    #
+    # Use <code>Archive::read_open_filename</code> instead.
+    #
+    def self.read_open_filename(filename, cmd = nil)
+    end
+
+    ##
+    #
+    # Use <code>Archive::read_open_memory</code> instead.
+    #
+    def self.read_open_memory(string, cmd = nil)
+    end
+
+    ##
+    #
+    # Releases all resources associated with the Reader object.
+    #
+    def close()
+    end
+
+    ##
+    #
+    # Returns the next Entry meta data object in the Archive.
+    #
+    def next_header()
+    end
+
+    private
+
+    def read_data_helper(len)
+    end
+
+    def self.new()
+    end
+
+  end
+
+  class Writer
+
+    ##
+    #
+    # Use Archive::write_open_filename instead.
+    #
+    #
+    def self.write_open_filename(filename, compression, format)
+    end
+
+    ##
+    #
+    # Releases all resources associated with the Writer object.
+    #
+    def close()
+    end
+
+    ##
+    #
+    # Creates a new Entry. An Entry holds the meta data for an item stored in
+    # an Archive, such as filetype, mode, owner, etc. It is typically populated
+    # by a call to <code>copy_stat</code>. It is written before the actual data.
+    #
+    def new_entry()
+    end
+
+    ##
+    #
+    # Write Entry meta data to Archive.
+    #
+    def write_header(entry)
+    end
+
+    private
+
+    def self.new()
+    end
+
+    def new_entry_helper()
+    end
+
+    def write_data_helper()
+    end
+
+  end
+
+end

data/lib/libarchive_rs.rb

@@ -20,9 +20,6 @@ module Archive
   ENTRY_BLOCK_SPECIAL = Stat.type_block_special
   ENTRY_CHARACTER_SPECIAL = Stat.type_character_special
 
-  class Error < StandardError
-  end
-
   class Entry
     alias :file? :is_file
     alias :directory? :is_directory
@@ -52,6 +49,11 @@ module Archive
     alias :uid= :set_uid
     alias :uname= :set_uname
 
+    ##
+    #
+    # Populates an Entry by doing a stat on given path and copying all
+    # attributes.
+    #
     def copy_stat(path)
       copy_stat_helper(path)
       self.set_symlink(File.readlink(path)) if self.symbolic_link?
@@ -61,7 +63,13 @@ module Archive
   end
 
   class Reader
- 
+
+    ##
+    #
+    # Reads size bytes from the Archive. If a block is given, chunks of size
+    # bytes are repeatedly passed to the block until the complete data stored
+    # for the Entry has been read.
+    #
     def read_data(size)
       if block_given?
         while result = self.read_data_helper(size)
@@ -77,6 +85,12 @@ module Archive
 
   class Writer
 
+    ##
+    #
+    # Returns a new Entry instance. An Entry holds the meta data for an item
+    # stored in an Archive, such as filetype, mode, owner, etc. It is written
+    # before the actual data.
+    #
     def new_entry()
       entry = self.new_entry_helper
       if block_given?
@@ -86,6 +100,11 @@ module Archive
       end
     end
 
+    ##
+    #
+    # Write data to Archive. If a block is given, data returned from the block
+    # is stored until the block returns nil.
+    #
     def write_data(data = nil)
       if block_given?
         while result = yield
@@ -99,6 +118,14 @@ module Archive
     private_class_method :new
   end
 
+  ##
+  #
+  # Open filename for reading. Libarchive automatically determines archive
+  # format and compression scheme. Optionally, you can specify an auxiliary
+  # command to be used for decompression.
+  #
+  # Returns a Reader instance.
+  #
   def self.read_open_filename(filename, cmd = nil)
     unless cmd.nil?
       cmd = locate_cmd(cmd)
@@ -114,6 +141,14 @@ module Archive
     end
   end
 
+  ##
+  #
+  # Read archive from string. Libarchive automatically determines archive
+  # format and compression scheme. Optionally, you can specify an auxiliary
+  # command to be used for decompression.
+  #
+  # Returns a Reader instance.
+  #
   def self.read_open_memory(string, cmd = nil)
     unless cmd.nil?
       cmd = locate_cmd(cmd)
@@ -129,6 +164,15 @@ module Archive
     end
   end
 
+  ##
+  #
+  # Open filename for writing. Specify the compression format by passing one
+  # of the <code>Archive::COMPRESSION_*</code> constants or optionally specify
+  # an auxiliary program to use for compression. Use one of the
+  # <code>Archive::FORMAT_*</code> constants to specify the archive format.
+  # 
+  # Returns a Writer instance.
+  #
   def self.write_open_filename(filename, compression, format)
     if compression.is_a? String
       compresion = locate_cmd(compression)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: libarchive-ruby-swig
 version: !ruby/object:Gem::Version 
-  hash: 9
-  prerelease: false
+  hash: 15
+  prerelease: 
   segments: 
   - 0
   - 5
-  - 1
-  version: 0.5.1
+  - 2
+  version: 0.5.2
 platform: ruby
 authors: 
 - Tobias Koch
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-07 00:00:00 +02:00
+date: 2011-02-12 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -29,6 +29,7 @@ extra_rdoc_files: []
 
 files: 
 - lib/libarchive_rs.rb
+- lib/libarchive_doc.rb
 - ext/libarchive-ruby-swig/stat.cpp
 - ext/libarchive-ruby-swig/stat.h
 - ext/libarchive-ruby-swig/entry.cpp
@@ -70,7 +71,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: Libarchive/Ruby/SWIG
-rubygems_version: 1.3.7
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: Ruby bindings to libarchive