ruby_archive 0.1.2

data/lib/ruby_archive/handlers/zip_handler.rb

@@ -0,0 +1,42 @@
+if defined?(Zip::ZipFile)
+  $stderr.puts "RubyArchive requires its own version of rubyzip. A copy of rubyzip has already been loaded. This may lead to unpredictable problems."
+else
+  $LOAD_PATH.unshift(File.expand_path('../rubyzip',__FILE__))
+  require File.expand_path('../rubyzip/zip/zipfilesystem',__FILE__)
+end
+
+module RubyArchive::Handlers
+  class ZipHandler < RubyArchive::Handler
+    ZIP_MAGIC = "\x50\x4B\x03\x04"
+
+    # Checks the magic of the given file to check if it's a zip file
+    def self.handles? location
+      # use normalized location because Zip::ZipFile.open does not expand '~'
+      normalized_location = RubyArchive::Handler::normalize_path(location)
+      return false unless File.file?(normalized_location)
+      return false unless File.read(normalized_location, ZIP_MAGIC.length) == ZIP_MAGIC
+      return true
+    end
+
+    def initialize location
+      # use normalized location because Zip::ZipFile.open does not expand '~'
+      normalized_location = RubyArchive::Handler::normalize_path(location)
+      @zipfs = Zip::ZipFile.open(normalized_location)
+      @name = normalized_location
+    end
+
+    def close
+      @zipfs.close
+    end
+
+    def file
+      @zipfs.file
+    end
+
+    def dir
+      @zipfs.dir
+    end
+  end
+end
+
+RubyArchive.add_handler_class(RubyArchive::Handlers::ZipHandler)

data/lib/ruby_archive/patch.rb

@@ -0,0 +1,3 @@
+require File.expand_path('../patch/dir',__FILE__)
+require File.expand_path('../patch/file',__FILE__)
+require File.expand_path('../patch/kernel',__FILE__)

data/lib/ruby_archive/patch/dir.rb

@@ -0,0 +1,185 @@
+class Dir
+  class << self
+    @@ruby_archive_dir_class_bind = binding
+
+    # Automates creating class methods that operate on either normal files
+    # or files within archives, given a symbol with the name of the method
+    # and the index of the argument containing the file name.
+    #
+    # It performs tasks in the following order:
+    # * alias the original method to ruby_archive_original_{method name},
+    #   marks the alias as protected.
+    # * overrides the class method so that it tries, in order:
+    #    1. returns the result of the original class method if the given file exists
+    #    2. returns the result of the original class method if an archive is not specified
+    #    3. returns the result of the archive handler method if an archive is specified
+    #
+    # The current method of doing this is kind of ugly and involves 'eval',
+    # but it works(tm).  This method is definitely a candidate for improvement.
+    #
+    # This code is heavily duplicated from +File.forward_method_single+ - I would like
+    # to make the same code work in two different places but couldn't quickly find
+    # a way.
+    def forward_method_single method, min_arguments=1, path_arg_index=0, on_load_error=nil
+      alias_name = "ruby_archive_original_#{method}".intern
+      eval_line = __LINE__; eval %{
+        unless Dir.respond_to?(:#{alias_name})
+          alias_method(:#{alias_name}, :#{method})
+        end
+        protected(:#{alias_name})
+
+        define_method(:#{method}) do |*args|
+          if (#{min_arguments} > 0 && args.size == 0)
+            raise ArgumentError, "wrong number of arguments (0 for #{min_arguments})"
+          end
+
+          # grab args before and after the filepath
+          args_before_path = nil
+          if #{path_arg_index} == 0
+            args_before_path = []
+          else
+            args_before_path = args[0..(#{path_arg_index - 1})]
+          end
+          path = args[#{path_arg_index}]
+          args_after_path = args[(#{path_arg_index + 1})..(args.size-1)]
+        
+          # get file location info and forward it to the appropriate method
+          location_info = File.in_archive?(path)
+          if location_info == false
+            return Dir.send(:#{alias_name},*args)
+          else
+            begin
+              dir_handler = RubyArchive.get(location_info[0]).dir
+              raise NotImplementedError unless dir_handler.respond_to?(:#{method})
+              args_to_send = args_before_path + [location_info[1]] + args_after_path
+              return dir_handler.send(:#{method},*args_to_send)
+            rescue LoadError
+              raise if #{on_load_error.inspect}.nil?
+              return #{on_load_error.inspect}
+            rescue NotImplementedError
+              raise NotImplementedError, "#{method} not implemented in handler for specified archive"
+            end
+          end
+        end
+      }, @@ruby_archive_dir_class_bind, __FILE__, eval_line
+    end
+    #protected(:forward_method_single)  # -- protecting this method makes rubinius choke
+
+    # See +forward_method_single+.  Does nearly the same thing, but assumes
+    # the argument list ends with a list of files to operate on rather than
+    # a single file to operate on.
+    #
+    # This code is basically +File.forward_method_multi+ adapted for Dir.glob and the like
+    def forward_method_array method, min_arguments=1, array_index=0
+      alias_name = "ruby_archive_original_#{method}".intern
+      eval_line = __LINE__; eval %{
+        unless Dir.respond_to?(:#{alias_name})
+          alias_method(:#{alias_name}, :#{method})
+        end
+        protected(:#{alias_name})
+
+        define_method(:#{method}) do |*args|
+          if (#{min_arguments} > 0 && args.size == 0)
+            raise ArgumentError, "wrong number of arguments (0 for #{min_arguments})"
+          end
+
+          # grab args before the list of filepaths, and the list of filepaths
+          args_before_array = nil
+          if #{array_index} == 0
+            args_before_array = []
+          else
+            args_before_array = args[0..#{array_index - 1}]
+          end
+          args_after_array = args[#{array_index + 1}..(args.size - 1)]
+
+          path_list = args[#{array_index}]
+
+          path_list = [path_list] unless path_list.is_a?(Array)
+
+          results = []
+          path_list.each do |path|
+            location_info = File.in_archive?(path)
+            if location_info == false
+              args_to_send = args_before_array + [path] + args_after_array
+              results += Dir.send(:#{alias_name},*args_to_send)
+              next
+            else
+              begin
+                dir_handler = RubyArchive.get(location_info[0]).dir
+                raise NotImplementedError unless dir_handler.respond_to?(:#{method})
+                args_to_send = args_before_array + [location_info[1]] + args_after_array
+                get_array = dir_handler.send(:#{method},*args_to_send)
+                results += get_array.map { |file| "\#{location_info[0]}!\#{file}" }
+                next
+              rescue NotImplementedError
+                raise NotImplementedError, "#{method} not implemented in handler for specified archive"
+              end
+            end
+          end
+          return results
+        end
+      }, @@ruby_archive_dir_class_bind, __FILE__, eval_line
+    end
+    #protected(:forward_method_multi)  # -- protecting this method makes rubinius choke
+
+    # Marks a function as unsupported by archives.  path_args should be an array
+    # of argument indices containing filepaths to check.
+    #
+    # This code is heavily duplicated from +File.forward_method_unsupported+ - I would like
+    # to make the same code work in two different places but couldn't quickly find
+    # a way.
+    def forward_method_unsupported method, min_arguments=1, path_args=[0], return_instead=:raise
+      alias_name = "ruby_archive_original_#{method}".intern
+      eval_line = __LINE__; eval %{
+        unless Dir.respond_to?(:#{alias_name})
+          alias_method(:#{alias_name}, :#{method})
+        end
+        protected(:#{alias_name})
+
+        define_method(:#{method}) do |*args|
+          if (#{min_arguments} > 0 && args.size == 0)
+            raise ArgumentError, "wrong number of arguments (0 for #{min_arguments})"
+          end
+
+          # grab args before the list of filepaths, and the list of filepaths
+          #{path_args.inspect}.each do |i|
+            if File.in_archive?(args[i]) != false
+              unless #{return_instead.inspect} == :raise
+                warn "Dir.#{method} is not supported for files within archives"
+                puts "#{return_instead.inspect}"
+                return #{return_instead.inspect}
+              end
+              raise NotImplementedError, "Dir.#{method} is not supported for files within archives (yet)"
+            end
+          end
+          
+          Dir.send(:#{alias_name},*args)
+        end
+      }, @@ruby_archive_dir_class_bind, __FILE__, eval_line
+    end
+    #protected(:forward_method_unsupported)  # -- protecting this method makes rubinius choke
+
+    Dir.forward_method_unsupported(:chdir)
+
+    Dir.forward_method_unsupported(:chroot)
+
+    Dir.forward_method_single(:delete)
+    alias rmdir delete
+    alias unlink delete
+
+    Dir.forward_method_single(:entries)
+
+    Dir.forward_method_unsupported(:foreach) # should be a target to support soon
+
+    # getwd/pwd does not need to be forwarded
+
+    Dir.forward_method_array(:glob,2,0) # should be a target to support soon
+    def [](*glob); return Dir.glob(glob,0); end
+
+    Dir.forward_method_single(:mkdir)
+
+    Dir.forward_method_single(:open)
+
+    # tmpdir does not need to be forwarded
+  end
+end

data/lib/ruby_archive/patch/file.rb

@@ -0,0 +1,301 @@
+class File
+  class << self
+    @@ruby_archive_file_class_bind = binding
+
+    # Determines whether a specified location appears to be within an archive.
+    # It first checks if the given location exists on the filesystem, and if
+    # not check if there is an '!' mark in the filename.
+    #
+    # Returns an array of [archive_path, file_inside_archive] if location appears
+    # to be in an archive, +false+ otherwise.
+    def in_archive? path
+      return false if File.ruby_archive_original_exist?(path)
+      sp = path.split('!')
+      return sp if sp.size == 2
+      raise ArgumentError, "only one archive deep supported (for now)" if sp.size > 2
+      return false
+    end
+
+    # Automates creating class methods that operate on either normal files
+    # or files within archives, given a symbol with the name of the method
+    # and the index of the argument containing the file name.
+    #
+    # It performs tasks in the following order:
+    # * alias the original method to ruby_archive_original_{method name},
+    #   marks the alias as protected.
+    # * overrides the class method so that it tries, in order:
+    #    1. returns the result of the original class method if the given file exists
+    #    2. returns the result of the original class method if an archive is not specified
+    #    3. returns the result of the archive handler method if an archive is specified
+    #
+    # The current method of doing this is kind of ugly and involves 'eval',
+    # but it works(tm).  This method is definitely a candidate for improvement.
+    def forward_method_single method, min_arguments=1, path_arg_index=0, on_load_error=nil
+      alias_name = "ruby_archive_original_#{method}".intern
+      eval_line = __LINE__; eval %{
+        unless File.respond_to?(:#{alias_name})
+          alias_method(:#{alias_name}, :#{method})
+        end
+        protected(:#{alias_name})
+
+        define_method(:#{method}) do |*args|
+          if (#{min_arguments} > 0 && args.size == 0)
+            raise ArgumentError, "wrong number of arguments (0 for #{min_arguments})"
+          end
+
+          # grab args before and after the filepath
+          args_before_path = nil
+          if #{path_arg_index} == 0
+            args_before_path = []
+          else
+            args_before_path = args[0..(#{path_arg_index - 1})]
+          end
+          path = args[#{path_arg_index}]
+          args_after_path = args[(#{path_arg_index + 1})..(args.size-1)]
+        
+          # get file location info and forward it to the appropriate method
+          location_info = File.in_archive?(path)
+          if location_info == false
+            return File.send(:#{alias_name},*args)
+          else
+            begin
+              file_handler = RubyArchive.get(location_info[0]).file
+              raise NotImplementedError unless file_handler.respond_to?(:#{method})
+              args_to_send = args_before_path + [location_info[1]] + args_after_path
+              return file_handler.send(:#{method},*args_to_send)
+            rescue LoadError
+              raise if #{on_load_error.inspect}.nil?
+              return #{on_load_error.inspect}
+            rescue NotImplementedError
+              raise NotImplementedError, "#{method} not implemented in handler for specified archive"
+            end
+          end
+        end
+      }, @@ruby_archive_file_class_bind, __FILE__, eval_line
+    end
+    #protected(:forward_method_single)  # -- protecting this method makes rubinius choke
+
+    # See +forward_method_single+.  Does nearly the same thing, but assumes
+    # the argument list ends with a list of files to operate on rather than
+    # a single file to operate on.
+    def forward_method_multi method, min_arguments=1, first_path_arg_index=0
+      alias_name = "ruby_archive_original_#{method}".intern
+      eval_line = __LINE__; eval %{
+        unless File.respond_to?(:#{alias_name})
+          alias_method(:#{alias_name}, :#{method})
+        end
+        protected(:#{alias_name})
+
+        define_method(:#{method}) do |*args|
+          if (#{min_arguments} > 0 && args.size == 0)
+            raise ArgumentError, "wrong number of arguments (0 for #{min_arguments})"
+          end
+
+          # grab args before the list of filepaths, and the list of filepaths
+          args_before_path = nil
+          if #{first_path_arg_index} == 0
+            args_before_path = []
+          else
+            args_before_path = args[0..(#{first_path_arg_index - 1})]
+          end
+          path_list = args[#{first_path_arg_index}..(args.size - 1)]
+
+          path_list.each do |path|
+            location_info = File.in_archive?(path)
+            if location_info == false
+              args_to_send = args_before_path + [path]
+              File.send(:#{alias_name},*args_to_send)
+              next
+            else
+              begin
+                file_handler = RubyArchive.get(location_info[0]).file
+                raise NotImplementedError unless file_handler.respond_to?(:#{method})
+                args_to_send = args_before_path + [location_info[1]]
+                file_handler.send(:#{method},*args_to_send)
+                next
+              rescue NotImplementedError
+                raise NotImplementedError, "#{method} not implemented in handler for specified archive"
+              end
+            end         
+          end
+          return path_list.size
+        end
+      }, @@ruby_archive_file_class_bind, __FILE__, eval_line
+    end
+    #protected(:forward_method_multi)  # -- protecting this method makes rubinius choke
+
+    # Marks a function as unsupported by archives.  path_args should be an array
+    # of argument indices containing filepaths to check.
+    def forward_method_unsupported method, min_arguments=1, path_args=[0], return_instead=:raise
+      alias_name = "ruby_archive_original_#{method}".intern
+      eval_line = __LINE__; eval %{
+        unless File.respond_to?(:#{alias_name})
+          alias_method(:#{alias_name}, :#{method})
+        end
+        protected(:#{alias_name})
+
+        define_method(:#{method}) do |*args|
+          if (#{min_arguments} > 0 && args.size == 0)
+            raise ArgumentError, "wrong number of arguments (0 for #{min_arguments})"
+          end
+
+          # grab args before the list of filepaths, and the list of filepaths
+          #{path_args.inspect}.each do |i|
+            if File.in_archive?(args[i]) != false
+              unless #{return_instead.inspect} == :raise
+                warn "Dir.#{method} is not supported for files within archives"
+                return #{return_instead.inspect}
+              end
+              raise NotImplementedError, "File.#{method} is not supported for files within archives (yet)"
+            end
+          end
+          
+          File.send(:#{alias_name},*args)
+        end
+      }, @@ruby_archive_file_class_bind, __FILE__, eval_line
+    end
+    #protected(:forward_method_multi)  # -- protecting this method makes rubinius choke
+
+    unless File.respond_to?('ruby_archive_original_open')
+      # Alias for the original +File::open+
+      alias ruby_archive_original_open open
+      protected(:ruby_archive_original_open)
+    end
+
+    # Open a file, either from the filesystem or from within an archive.
+    # If the given path exists on the filesystem, it will be opened from
+    # there.  Otherwise the path will be split by delimiter +!+ and
+    # checked again.
+    #
+    # TODO: 'perm' is currently ignored by anything sent to an archive,
+    # due to incompatibility with rubyzip.
+    def open path,mode='r',perm=0666,&block # 0666 from io.c in MRI
+      if File.ruby_archive_original_exist?(path)
+        return File.ruby_archive_original_open(path,mode,perm,&block)
+      end
+      location_info = File.in_archive?(path)
+      if location_info == false
+        return File.ruby_archive_original_open(path,mode,perm,&block)
+      else
+        f = RubyArchive.get(location_info[0]).file.open(location_info[1],mode)
+        return f if block.nil?
+        begin
+          return yield(f)
+        ensure
+          f.close
+        end
+      end
+    end
+
+
+    # Replacement for stock +File::read+
+    def read name,length=nil,offset=nil
+      ret = nil
+      self.open(name) do |f|
+        f.seek(offset) unless offset.nil?
+        ret = f.read(length)
+      end
+      ret
+    end
+
+    File.forward_method_single(:atime)
+
+    # basename does not need to be forwarded
+
+    File.forward_method_single(:blockdev?)
+
+    # catname does not need to be forwarded
+
+    File.forward_method_single(:chardev?)
+
+    File.forward_method_multi(:chmod,1,1)
+
+    File.forward_method_multi(:chown,2,2)
+
+    File.forward_method_single(:ctime)
+
+    File.forward_method_multi(:delete,0,0)
+    alias unlink delete
+
+    File.forward_method_single(:directory?)
+
+    # dirname does not need to be forwarded
+
+    File.forward_method_single(:executable?)
+
+    File.forward_method_single(:executable_real?)
+
+    File.forward_method_single(:exist?,1,0,false)
+    alias exists? exist? #(obsolete alias)
+
+    # expand_path does not need to be forwarded
+
+    # extname does not need to be forwarded
+
+    File.forward_method_single(:file?)
+
+    # fnmatch does not need to be forwarded
+
+    File.forward_method_single(:ftype)
+
+    File.forward_method_single(:grpowned?)
+
+    File.forward_method_unsupported(:identical?,2,[0,1])
+
+    # join does not need to be forwarded
+
+    File.forward_method_multi(:lchmod,1,1)
+
+    File.forward_method_multi(:lchown,2,2)
+
+    File.forward_method_unsupported(:link,2,[0,1])
+
+    File.forward_method_single(:lstat)
+
+    File.forward_method_single(:mtime)
+
+    File.forward_method_single(:owned?)
+
+    File.forward_method_single(:pipe?)
+
+    File.forward_method_single(:readable?)
+
+    File.forward_method_single(:readable_real?)
+
+    File.forward_method_single(:readlink)
+
+    File.forward_method_unsupported(:rename,2,[0,1]) # should be a target to support soon
+
+    File.forward_method_single(:setgid?)
+
+    File.forward_method_single(:setuid?)
+
+    File.forward_method_single(:size)
+
+    File.forward_method_single(:size?)
+
+    File.forward_method_single(:socket?)
+
+    File.forward_method_single(:split)
+
+    File.forward_method_single(:stat)
+
+    File.forward_method_single(:sticky?)
+
+    File.forward_method_unsupported(:symlink,2,[0,1])
+
+    File.forward_method_single(:symlink?)
+
+    File.forward_method_single(:truncate)
+
+    # umask does not need to be forwarded
+
+    File.forward_method_multi(:utime,2,2)
+
+    File.forward_method_single(:writable?)
+
+    File.forward_method_single(:writable_real?)
+
+    File.forward_method_single(:zero?)
+  end
+end