imw 0.2.18 → 0.3.0

data/lib/imw/archives.rb

@@ -1,120 +0,0 @@
-module IMW
-
-  # Contains modules which define the behavior of archive files.
-  module Archives
-
-    # Handlers for archives.
-    HANDLERS = [
-                ["Archives::Tarbz2",     Proc.new { |r| r.is_local? && r.path =~ /\.tar\.bz2$/i  } ],
-                ["Archives::Tarbz2",     Proc.new { |r| r.is_local? && r.path =~ /\.tbz2$/i      } ],
-                ["Archives::Targz",      Proc.new { |r| r.is_local? && r.path =~ /\.tar\.gz$/i   } ],
-                ["Archives::Targz",      Proc.new { |r| r.is_local? && r.path =~ /\.tgz$/i       } ],
-                ["Archives::Tar",        Proc.new { |r| r.is_local? && r.path =~ /\.tar$/i       } ],
-                ["Archives::Rar",        Proc.new { |r| r.is_local? && r.path =~ /\.rar$/i       } ],
-                ["Archives::Zip",        Proc.new { |r| r.is_local? && r.path =~ /\.zip$/i       } ]
-               ]
-
-    autoload :Rar,    'imw/archives/rar'
-    autoload :Tar,    'imw/archives/tar'
-    autoload :Tarbz2, 'imw/archives/tarbz2'
-    autoload :Targz,  'imw/archives/targz'
-    autoload :Zip,    'imw/archives/zip'
-
-    # Defines methods for creating, appending to, extracting, and
-    # listing an archive file.  This module isn't used to directly
-    # extend an IMW::Resource -- instead, format specifc modules
-    # (e.g. - IMW::Resources::Archives::Tarbz2) include this module
-    # and define the specific settings (command-line flags, &c.)
-    # required to make things work.
-    module Base
-
-      attr_accessor :archive_settings
-
-      # Is this file an archive?
-      #
-      # @return [true, false]
-      def is_archive?
-        true
-      end
-
-      # Create an archive of the given +input_paths+.
-      #
-      # The input paths must be strings and will be shell-escaped
-      # before further processing.  This means you cannot use a shell
-      # glob!
-      #
-      # @param [String] input_paths the paths to add to this archive
-      # @return [IMW::Resource] the resutling archive
-      def create *input_paths
-        should_have_archive_setting!("Cannot create archive #{path}", :program, :create)
-        IMW.system archive_settings[:program], archive_settings[:create], path, *input_paths.flatten
-        self
-      end
-
-      # Append to this archive the given +input_paths+.
-      #
-      # The input paths must be strings and will be shell-escaped
-      # before further processing.  This means you cannot use a shell
-      # glob!
-      #
-      # @param [String] input_paths the paths to add to this archive
-      # @return [IMW::Resource] the resutling archive      
-      def append *input_paths
-        should_have_archive_setting!("Cannot append to archive #{path}", :program, :append)
-        IMW.system archive_settings[:program], archive_settings[:append], path, *input_paths.flatten
-        self
-      end
-
-      # Extract the files from this archive to the current directory.
-      #
-      # @return [IMW::Resource] this archive
-      def extract
-        should_exist!("Cannot extract archive.")        
-        should_have_archive_setting!("Cannot extract archive #{path}", :extract, [:unarchving_program, :program])
-        program = archive_settings[:unarchiving_program] || archive_settings[:program]
-        IMW.system program, archive_settings[:extract], path
-        self
-      end
-
-      # Return a (sorted) list of contents in this archive.
-      #
-      # @return [Array<String>] a list of paths in the archive.
-      def contents
-        should_exist!("Cannot list archive contents.")
-        should_have_archive_setting!("Cannot list archive #{path}", :list, [:unarchiving_program, :program])
-        program = archive_settings[:unarchiving_program] || archive_settings[:program]
-        # FIXME this needs to be more robust
-        flags = archive_settings[:list]
-        flags = flags.join(' ') if flags.is_a?(Array)
-        command = [program, flags, path.gsub(' ', '\ ')].join(' ')
-        output  = `#{command}`
-        archive_contents_string_to_array(output)
-      end
-
-      protected
-
-      def should_have_archive_setting! message=nil,*settings # :nodoc:
-        settings.each do |setting|
-          if setting.is_a?(Array)
-            raise IMW::Error.new([message, "Must define one of #{setting.join(', ')} in archive_settings"].compact.join(', ')) unless setting.any? { |optional_setting| archive_settings[optional_setting] }
-          else
-            raise IMW::Error.new([message, "Must define #{setting} in archive_setings"].compact.join(', '))                    unless archive_settings[setting]
-          end
-        end
-      end
-
-      # Parse and format the output from the archive program's "list"
-      # command into an array of filenames.
-      #
-      # An including class can override this method to match the
-      # output from the archiving program of that class.
-      #
-      # @param [String] string the raw output from the archive program's "list" command
-      # @return [Array] a list of paths in the archive
-      def archive_contents_string_to_array string
-        string.split("\n")
-      end
-    end
-  end
-end
-

data/lib/imw/archives/rar.rb

@@ -1,19 +0,0 @@
-module IMW
-  module Archives
-    module Rar
-      
-      include IMW::Archives::Base
-      
-      def archive_settings
-        @archive_settings ||= {
-          :program => :rar,
-          :create  => ['a', '-o+', '-inul'],
-          :append  => ['a', '-o+', '-inul'],
-          :list    => "vb",
-          :extract => ['x', '-o+', '-inul']
-        }
-      end
-    end
-  end
-end
-

data/lib/imw/archives/tar.rb

@@ -1,19 +0,0 @@
-module IMW
-  module Archives
-    module Tar
-
-      include IMW::Archives::Base
-      
-      def archive_settings
-        @archive_settings ||=  {
-          :create  => "-cf",
-          :append  => "-rf",
-          :list    => "-tf",
-          :extract => "-xf",
-          :program => :tar
-        }
-      end
-    end
-  end
-end
-

data/lib/imw/archives/tarbz2.rb

@@ -1,73 +0,0 @@
-module IMW
-  module Archives
-    module Tarbz2
-
-      #
-      # It's a compressed file
-      #
-
-      include IMW::CompressedFiles::Base
-
-      def compression_settings
-        @compression_settings ||= {
-          :program               => :bzip2,
-          :decompression_program => :bunzip2,
-          :decompress            => '',
-          :extension             => 'bz2'
-        }
-      end
-
-      #
-      # But it's also an archive
-      #
-      
-      include IMW::Archives::Base
-      
-      def archive_settings
-        @archive_settings ||= {
-          :program               => :tar,
-          :create                => '-cf',
-          :list                  => "-tjf",
-          :extract               => "-xjf"
-        }
-      end
-
-      # Overrides default behvaior of IMW::Files::Archive#create to
-      # compress files after creating them.
-      def create *input_paths
-        IMW.system(archive_settings[:program], archive_settings[:create], path_between_archive_and_compression, *input_paths.flatten)
-        IMW.open(path_between_archive_and_compression).compress!
-      end
-
-      def decompressed_basename
-        case extname
-        when '.tar.bz2' then basename[0..-5]               # .tar.bz2 => .tar
-        when '.tbz2'    then basename.gsub(/tbz2$/, 'tar') # .tbz2    => .tar
-        else                 basename[0..-(extname.size + 1)]
-        end
-      end
-      
-
-      protected
-      def path_between_archive_and_compression
-        File.join(dirname,name + '.tar')
-      end
-
-      public
-
-      #
-      # It's a compressed file AND an archive!
-      #
-      
-      def extname
-        case path
-        when /\.tar\.bz2$/ then '.tar.bz2'
-        when /\.tbz2$/     then '.tbz2'
-        else               File.extname(path)
-        end
-      end
-      
-    end
-  end
-end
-

data/lib/imw/archives/targz.rb

@@ -1,73 +0,0 @@
-module IMW
-  module Archives
-    module Targz
-
-      #
-      # It's a compressed file
-      #
-
-      include IMW::CompressedFiles::Base
-
-      def compression_settings
-        @compression_settings ||= {
-          :program               => :gzip,
-          :decompression_program => :gunzip,
-          :decompress            => '',
-          :extension             => 'gz'
-        }
-      end
-
-      #
-      # But it's also an archive
-      #
-      
-      include IMW::Archives::Base        
-      
-      def archive_settings
-        @archive_settings ||= {
-          :program               => :tar,        
-          :list                  => "-tzf",
-          :create                => '-cf',            
-          :extract               => "-xzf"
-        }
-      end
-
-      # Overrides default behvaior of IMW::Files::Archive#create to
-      # compress files after creating them.
-      def create *input_paths
-        IMW.system(archive_settings[:program], archive_settings[:create].split, path_between_archive_and_compression, *input_paths.flatten)
-        tar = IMW.open(path_between_archive_and_compression)
-        tar.compression_settings = compression_settings
-        tar.compress!
-      end
-
-      def decompressed_basename
-        case extname
-        when '.tar.gz' then basename[0..-4]              # .tar.gz => .tar
-        when '.tgz'    then basename.gsub(/tgz$/, 'tar') # .tgz    => .tar
-        else                basename[0..-(extname.size + 1)]
-        end
-      end
-      
-      protected
-      def path_between_archive_and_compression
-        File.join(dirname,name + '.tar')
-      end
-      public
-
-      #
-      # It's both an archive and a compressed file!
-      #
-
-      def extname
-        case path
-        when /\.tar\.gz$/ then '.tar.gz'
-        when /\.tgz$/     then '.tgz'
-        else              File.extname(path)
-        end
-      end
-
-    end
-  end
-end
-

data/lib/imw/archives/zip.rb

@@ -1,51 +0,0 @@
-module IMW
-  module Archives
-    module Zip
-
-      include IMW::Archives::Base
-
-      def archive_settings
-        @archive_settings ||= {
-          :program             => :zip,
-          :create              => "-qqr",
-          :append              => "-qqg",
-          :list                => "-l",
-          :extract             => "-qqo",
-          :unarchiving_program => :unzip
-        }
-      end
-
-      protected
-      
-      # The `unzip' program outputs data in a very annoying format:
-      #
-      #     Archive:  data.zip
-      #       Length     Date   Time    Name
-      #      --------    ----   ----    ----
-      #         18510  07-28-08 15:58   data/4d7Qrgz7.csv
-      #          3418  07-28-08 15:41   data/7S.csv
-      #         23353  07-28-08 15:41   data/g.csv
-      #           711  07-28-08 15:58   data/g.xml
-      #          1095  07-28-08 15:41   data/L.xml
-      #          2399  07-28-08 15:58   data/mTAu9H3.xml
-      #           152  07-28-08 15:58   data/vaHBS2t5R.dat
-      #      --------                   -------
-      #         49638                   7 files            
-      #
-      # which is parsed by this method.
-      def archive_contents_string_to_array string
-        rows = string.split("\n")
-        # ignore the first 3 lines of the output and also discared the
-        # last 2 (5 = 2 + 3)
-        file_rows = rows[3,(rows.length - 5)]
-        file_rows.map do |row|
-          if row
-            columns = row.lstrip.rstrip.split(' ')
-            # grab the filename in the fourth column
-            columns[3..-1].join(' ')
-          end
-        end.compact
-      end
-    end
-  end
-end

data/lib/imw/boot.rb

@@ -1,87 +0,0 @@
-module IMW
-
-  # IMW looks for configuration settings in the following places, in
-  # order of increasing precedence:
-  #
-  #   1. Settings defined directly in this file.
-  #
-  #   2. From the <tt>etc/imwrc</tt> file in the IMW root directory.
-  #
-  #   3. From the <tt>.imwrc</tt> file in the user's home directory (the
-  #      filename can be changed; see
-  #      <tt>IMW::Config::USER_CONFIG_FILE_BASENAME</tt>).
-  #
-  #   4. From the file defined by the environment variable +IMWRC+ (the
-  #      value can be changed; see
-  #      <tt>IMW::Config::USER_CONFIG_FILE_ENV_VARIABLE</tt>
-  #
-  # Settings not found in one configuration location will be searched
-  # for in locations of lesser precedence.
-  #
-  # *Note:* configuration files are plain Ruby code that will be directly
-  # evaluated.
-  #
-  # Relevant settings include
-  #
-  # * interfaces with external programs (+tar+, +wget+, &c.)
-  # * paths to directories where IMW reads/writes files
-  # * correspondences between file extensions and IMW file classes
-  #
-  # For more detailed information, see the default configuration file,
-  # <tt>etc/imwrc</tt>.
-  module Config
-
-    # Root of the IMW source base.
-    def self.imw_root
-      File.expand_path File.join(File.dirname(__FILE__), '../..')
-    end
-
-    #
-    # User configuration file
-    #
-    # By default, the file ~/.imwrc (.imwrc, in your home directory --
-    # note no .rb extension) is sourced at top level.  If the $IMWRC
-    # environment variable is set, that file will be sourced instead.
-    #
-    # Any code within this file will override settings in
-    # /etc/imwrc.rb which itself overrides IMW_ROOT/etc/imwrc.rb
-    #
-    USER_CONFIG_FILE = File.join(ENV['HOME'] || '', '.imwrc')
-    # Environment variable to override user configuration file location.
-    ENV_CONFIG_FILE = "IMWRC"
-    def self.user_config_file # :nodoc:
-      File.expand_path(ENV[ENV_CONFIG_FILE] || USER_CONFIG_FILE)
-    end
-
-    # Path to site-wide config file (overwrites IMW defaults but
-    # overridden by user defaults).
-    SITE_CONFIG_FILE = "/etc/imwrc.rb"
-    def self.site_config_file # :nodoc:
-      SITE_CONFIG_FILE
-    end
-
-    def self.default_config_file # :nodoc:
-      File.join(imw_root, "etc/imwrc.rb")
-    end
-    
-    # Source the config files
-    def self.load_config
-      if File.exist?(user_config_file)
-        load user_config_file
-      end
-
-      if File.exist?(site_config_file)
-        load site_config_file
-      end
-
-      load default_config_file
-      
-    end
-  end
-end
-
-#
-# Load the config files
-#
-IMW::Config.load_config
-