Module: Unpacker

Defined in:
lib/unpacker.rb

Defined Under Namespace

Classes: UnpackedFailedError, UnrecognizedArchiveError

Constant Summary collapse

SUPPORTED_FILEEXTS = 
%w[tar rar zip gz bz tgz bgz tar]
VERSION =

:stopdoc:

'1.0.1'
LIBPATH = 
::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
PATH = 
::File.dirname(LIBPATH) + ::File::SEPARATOR

Class Method Summary collapse

Class Method Details

.archive?(file_name) ⇒ Boolean

Returns:

  • (Boolean) 


19
20
21
 
# File 'lib/unpacker.rb', line 19

def self.archive?(file_name)
  SUPPORTED_FILEEXTS.include? File.extname(file_name).sub('.', '')
end

.libpath(*args) ⇒ Object

Returns the library path for the module. If any arguments are given, they will be joined to the end of the libray path using File.join.



44
45
46
 
# File 'lib/unpacker.rb', line 44

def self.libpath( *args )
  args.empty? ? LIBPATH : ::File.join(LIBPATH, args.flatten)
end

.path(*args) ⇒ Object

Returns the lpath for the module. If any arguments are given, they will be joined to the end of the path using File.join.



52
53
54
 
# File 'lib/unpacker.rb', line 52

def self.path( *args )
  args.empty? ? PATH : ::File.join(PATH, args.flatten)
end

.require_all_libs_relative_to(fname, dir = nil) ⇒ Object

Utility method used to require all files ending in .rb that lie in the directory below this file that has the same name as the filename passed in. Optionally, a specific directory name can be passed in such that the filename does not have to be equivalent to the directory.



61
62
63
64
65
66
67
 
# File 'lib/unpacker.rb', line 61

def self.require_all_libs_relative_to( fname, dir = nil )
  dir ||= ::File.basename(fname, '.*')
  search_me = ::File.expand_path(
      ::File.join(::File.dirname(fname), dir, '**', '*.rb'))

  Dir.glob(search_me).sort.each {|rb| require rb}
end

.unpack(file, tmpdir = "/tmp", &block) ⇒ Object 



11
12
13
14
15
16
17
 
# File 'lib/unpacker.rb', line 11

def self.unpack(file, tmpdir = "/tmp", &block) 
  Dir.mktmpdir 'unpacker' do |dir|
    cmd = command_by_file_ext(file)% [file, dir]
    system("#{cmd} 1>/dev/null") or raise UnrecognizedArchiveError($?)
    block.call(Dir.new(dir))
  end
end

.valid?(file_path, file_name = file_path) ⇒ Boolean

Returns:

  • (Boolean) 


23
24
25
26
 
# File 'lib/unpacker.rb', line 23

def self.valid?(file_path, file_name = file_path)
  cmd = test_cmd_by_file_ext(file_name)% file_path
  system("#{cmd} 1>/dev/null 2>/dev/null")
end

.version ⇒ Object

Returns the version string for the library.



36
37
38
 
# File 'lib/unpacker.rb', line 36

def self.version
  VERSION
end