multi_zip 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b4d9becd80958a0eb07dab22a0207dfcb91ebe00
-  data.tar.gz: eb1092f782ab4fc2e6933eb5a36b84036bf9cfca
+  metadata.gz: 6ae79eb36822d59d1b6c74fbc01954469af7affc
+  data.tar.gz: e907a498f8b2f26bf0c5c09b79604e1ae3c55d5f
 SHA512:
-  metadata.gz: 9a6eca1072c53f5266e9e8afdee331b7df518df68ebceb5a10b9120fc9041e3710552fdcd557eba80ed51ec95692864b2724cf11f64afa0f5986fc1883412e7d
-  data.tar.gz: e90c64a98a10a98dcedda42f190d1551a507f83166d3ea5612f0996e6a47e8d7b9a8d087998caeee975d8b146c3984bdf3e2f848fe5d9723549bf5ca2e43c7f2
+  metadata.gz: fffb4dc3201100b24d680b0e7f1b34001f30ea653c286b378018c037ce99b66bc4628d57c7afed364a27f8318c2b0ac4b99fe2accd2d1b453ac10bfbe8d8b6ef
+  data.tar.gz: e02558c21895d05e01db7222d83dcf6be10067e074618b4bd7eebd1a90d24ec7927041bd6624c4e5507ad459ff519c48a2ee10a5e1052383c2ea3aa2ba400ab6

data/.gitignore

@@ -15,3 +15,5 @@ mkmf.log
 .ruby-*
 *.gem
 test_in_all_rubies.sh
+.byebug_history
+destination

data/.travis.yml

@@ -9,6 +9,7 @@ rvm:
   - 2.3.0
   - jruby-18mode
   - jruby-19mode
+  - jruby-9.0.5.0
   - rbx-2
 matrix:
   allow_failures:

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+### 0.1.6 - Dec 20, 2017
+
+Added '#member_info` method for retrieving file size and information.
+
+### 0.1.5 - May 4, 2016
+
+Add experimental support for using command-line utilities to zip and unzip.

data/Gemfile

@@ -3,7 +3,7 @@ source 'https://rubygems.org'
 gemspec
 
 # can't use pry on old rubies or on rubinius
-if RUBY_VERSION.to_f >= 2.0 && RUBY_ENGINE == 'ruby'
+if RUBY_VERSION.to_f >= 2.2 && RUBY_ENGINE == 'ruby'
   gem 'byebug', :require => false
   gem 'guard-rspec', :require => false
 end

data/README.md

@@ -7,7 +7,7 @@ interface regardless of which is being used. This allows for code that is more
 portable and helps to avoid namespace collisions (zipruby vs. rubyzip for example)
 and other implementation restrictions (MRI vs. Jruby, Unix vs. Windows, etc,).
 
-It currently supports `.zip` archives only. See TODO for info on others.
+It currently supports `.zip` archives only.
 
 MultiZip provides a very small and focused set of functions:
 
@@ -17,8 +17,6 @@ MultiZip provides a very small and focused set of functions:
  * Extract files from an archive to a local file.
  * List files contained in an archive.
  * Delete files from an archive.
- * Get information for a file in an archive. (Pending TODO)
- * Add a local file to an archive. (Pending TODO).
 
 It is meant for most common zip/unzip tasks. For anything more
 complicated than these basics, you should use a specific (un)zipping library
@@ -26,16 +24,16 @@ instead.
 
 Rubies supported (see [CI status](https://travis-ci.org/xunker/multi_zip) for more detail):
   * MRI 2.x.x, 1.9.3, 1.8.7 and REE.
-  * Jruby
+  * Jruby (1.8 and 1.9 mode)
   * Rubinius 2
 
 For information about which backend gems work in which ruby, see [Supported Backend Gems](#supported-backend-gems).
 
-This work is inspired by [multi_json](https://github.com/intridea/multi_json)
-and [multi_xml](https://github.com/sferik/multi_xml). Work began while I was
-visiting Japan in 2014 and is dedicated to the Rubyists of
-[Asukusa.rb](https://asakusarb.doorkeeper.jp/) and
-[John Mettraux](https://twitter.com/jmettraux).
+This gem was inspired by [multi_json](https://github.com/intridea/multi_json)
+and [multi_xml](https://github.com/sferik/multi_xml), and is dedicated to the
+Rubyists of [Asukusa.rb](https://asakusarb.doorkeeper.jp/) and
+[John Mettraux](https://twitter.com/jmettraux) of Hiroshima.
+おもてなしのあなたはありがとう！
 
 ## Installation
 
@@ -50,12 +48,14 @@ which ones can be used.
 
 `multi_zip` will try to use the available gem backends in the following order:
 
-  * rubyzip
-  * archive/zip
-  * zipruby
+  * [rubyzip](https://rubygems.org/gems/rubyzip)
+  * [archive-zip](https://rubygems.org/gems/archive-zip)
+  * [zipruby](https://rubygems.org/gems/zipruby)
 
-If no usable backends are loaded a `MultiZip::NoSupportedBackendError` will be
-raised for any operation.
+If no usable gems are found, it will then look for a compatible `zip`/ `unzip`
+program in your path and will try to use that instead of a gem. If no
+compatible gems or program can be found, a `MultiZip::NoSupportedBackendError`
+exception will be raised.
 
 If you have multiple gems available and want to choose your backend, you can
 do that in the initializer:
@@ -112,6 +112,38 @@ zip.list_members
 # ]
 ```
 
+#### Check if a file exists in an archive
+
+Returns `true` if the file exists in the archive, otherwise `false`
+
+```ruby
+zip.member_exists?('/path/inside/archive/to/file.txt')
+# => true
+
+zip.member_exists?('/doesnt_exist')
+# => false
+```
+
+#### Get member information (file size, etc)
+
+Returns a hash if the file exists in the archive, otherwise will raise exception.
+
+```ruby
+zip.member_info('/path/inside/archive/to/file.txt')
+# => { :path => '/path/inside/archive/to/file.txt', :size => 14323, type: :file }
+```
+
+At a minimum, the returned hash will contain:
+  :path  the full path of the member file (should equal `member_path` arg)
+  :size  the UNCOMPRESSED file size, in bytes
+
+Optionally, it MAY contain these keys:
+  :type             Filesystem type of the member (:directory, :file, :symlink, etc)
+  :created_at       creation timestamp of the file as an instance of Time
+  :compressed_size  size of the COMPRESSED file in bytes
+  :original         The original member info object as returned from the backend
+                    gem. Ex: using rubyzip, it would be an instace of Zip::Entry.
+
 #### Read file from zip archive
 
 ```ruby
@@ -186,8 +218,7 @@ end
 
 Planned for the future:
 
-  * [archive](https://rubygems.org/gems/archive)
-  * [unix_utils](https://rubygems.org/gems/unix_utils)
+  * [archive gem](https://rubygems.org/gems/archive)
   * Other archive formats like gzip, bzip2, 7zip, tar, etc.
   * Jruby-specific gems
   * Others (please suggest them in a [new issue](https://github.com/xunker/multi_zip/issues/new))

data/TODO.md

@@ -5,12 +5,10 @@
   * #add_member: add file to archive from filesystem (new method).
   * Document exceptions raised, what they mean and how to use them.
   * Add inline docs for methods.
-  * support *nix zip(1L)/unzip(1L) without needing backend gem (with warning).
 
 #### Other things that need to be done, in no particular order:
 
   * Add support for more backends.
-  * Support for backend gems to process other formats (gzip, bzip2, 7zip, tar, etc).
   * Keep the backend archive open between method calls.
   * Add soak tests for memory usage once archived are kept open.
   * Ensure #close is executed when MultiZip instance goes out of scope.
@@ -39,8 +37,9 @@
 #### Things that I'd **like** to do, but won't.
 
 These are thinks that would be really nice to have but that are probably not
-realistic because they cannot be abstracted across all backend gems:
+realistic because they cannot be abstracted across all backend gems and systems:
 
+  * Support for backend gems to process other formats (gzip, bzip2, 7zip, tar, etc).
   * Ability to set location and compression format and level of archive.
   * Ability to set compression format and level of individual members (for Epub compatibility).
   * Ability to set archive location of individual members (for Epub compatibility).

data/lib/multi_zip.rb

@@ -3,7 +3,7 @@ class MultiZip
 
   attr_reader :filename
 
-  BACKEND_PREFERENCE = [ :rubyzip, :archive_zip, :zipruby ]
+  BACKEND_PREFERENCE = [ :rubyzip, :archive_zip, :zipruby, :cli ]
   BACKENDS = {
     :rubyzip => {
       :fingerprints => [
@@ -24,6 +24,12 @@ class MultiZip
         ['constant', lambda { defined?(Zip::Archive) }]
       ],
       :constant => lambda { MultiZip::Backend::Zipruby }
+    },
+    :cli => {
+      :fingerprints => [
+        [true, lambda { MultiZip::Backend::Cli.strategy_available? } ]
+      ],
+      :constant => lambda { MultiZip::Backend::Cli.strategy.extend_class.call }
     }
   }
 
@@ -33,7 +39,15 @@ class MultiZip
     self.backend = if b_end = options.delete(:backend)
       b_end
     else
-      default_backend
+      begin
+        default_backend
+      rescue NoSupportedBackendError => e
+        if !!options[:allow_no_backends] # TODO: Fix this test mode hack
+          nil
+        else
+          raise e
+        end
+      end
     end
 
     if block_given?
@@ -46,7 +60,7 @@ class MultiZip
   end
 
   def backend=(backend_name)
-    return if backend_name.nil?
+    return @backend if backend_name.nil?
     if BACKENDS.keys.include?(backend_name.to_sym)
       @backend = backend_name.to_sym
       require "multi_zip/backend/#{@backend}"
@@ -124,6 +138,23 @@ class MultiZip
     list_members(nil, options).include?(member_path)
   end
 
+  # Returns a hash of information about the member file. At a minimum, the hash
+  # MUST contain these keys:
+  #  :path  the full path of the member file (should equal `member_path` arg)
+  #  :size  the UNCOMPRESSED file size, in bytes
+  #
+  # Optionally, it MAY contain these keys:
+  #  :created_at  creation timestamp of the file as an instance of Time
+  #  :compressed_size size of the COMPRESSED file
+  #  :type        Filesystem type of the member (:directory, :file, :symlink, etc)
+  #  :original    The original member info object as returned from the backend
+  #               gem. Ex: using rubyzip, it would be an instace of Zip::Entry.
+  #
+  # This method MUST be overridden by a backend module.
+  def member_info(member_path, options={})
+    raise NotImplementedError
+  end
+
   # Write string contents to a zip member file
   def write_member(member_path, member_content, options={})
     raise NotImplementedError
@@ -191,5 +222,6 @@ private
   end
 end
 
+require "multi_zip/backend/cli"
 require "multi_zip/version"
 require "multi_zip/errors"

data/lib/multi_zip/backend/archive_zip.rb

@@ -29,7 +29,7 @@ module MultiZip::Backend::ArchiveZip
     tempfile = Tempfile.new('multizip_member')
     tempfile.write(member_contents)
     tempfile.close
-    
+
     zip = Archive::Zip.new(@filename, :w)
     new_entry = Archive::Zip::Entry.from_file(tempfile.path, :zip_path => member_path)
     zip.add_entry(new_entry)
@@ -47,7 +47,7 @@ module MultiZip::Backend::ArchiveZip
     end
   end
 
-  def extract_member(member_path, destination_path, options = {}) 
+  def extract_member(member_path, destination_path, options = {})
     archive_operation do |zip|
       member = zip.find{|m| m.zip_path == member_path}
       if member && member.file?
@@ -73,18 +73,18 @@ module MultiZip::Backend::ArchiveZip
     member_paths.each do |member_path|
       exists!(member_path)
     end
-    
+
     # archive-zip doesn't have the #remove_entry method any more, so we do
     # this in a really slow way: we dump the entire dir to the filesystem,
     # delete `member_path` and zip the whole thing up again.
-    
+
     Dir.mktmpdir do |tmp_dir|
       Archive::Zip.extract(@filename, tmp_dir)
 
       member_paths.each do |member_path|
         FileUtils.rm("#{tmp_dir}/#{member_path}")
       end
-      
+
       # create a tempfile and immediately delete it, we just want the name.
       tempfile = Tempfile.new(['multizip_temp', '.zip'])
       tempfile_path = tempfile.path
@@ -98,6 +98,23 @@ module MultiZip::Backend::ArchiveZip
     true
   end
 
+  def member_info(member_path, options = {})
+    archive_operation do |zip|
+      member = zip.find{|m| m.zip_path == member_path}
+      if member
+        return {
+          path: member.zip_path,
+          size: member.expected_data_descriptor.uncompressed_size.to_i,
+          type: member.ftype,
+          original: member
+        }
+      else
+        zip.close
+        member_not_found!(member_path)
+      end
+    end
+  end
+
 private
 
   def archive_operation(mode = :r) # mode is either :r or :w
@@ -108,4 +125,4 @@ private
   rescue Archive::Zip::UnzipError => e
     raise MultiZip::InvalidArchiveError.new(@filename, e)
   end
-end
+end

data/lib/multi_zip/backend/cli.rb

@@ -0,0 +1,68 @@
+# If no suitable gems are found, this is the last-gasp fallback. We use
+# whatever command-line zipping/unzipping tools we can find and that we
+# know how to use.
+#
+# This will likely be a huge work in progress since it involves a lot of
+# detection. We'll need to detect the host OS and version, the tools available
+# in the path (or specified by the user, optionally) and the command-line
+# arguments to be used for those tools.
+#
+# OS          Unzip                           Zip
+#------------------------------------------------------------------------------
+# OS X 10.10  Info-ZIP UnZip 5.52             Info-ZIP Zip 3.0
+# RHEL-Based  Info-ZIP UnZip 5.xx to 6.xx     Info-ZIP Zip 2.x to 3.x
+# Ubuntu      Info-ZIP UnZip 6.xx             Info-ZIP Zip 3.0
+# Raspbian    Info-ZIP UnZip 6.00             Info-ZIP Zip 3.0
+# Windows
+#             GNU UnZip (from INFO-Zip UnZip) GNU Zip (from INFO-Zip Zip)
+#             7-Zip Command Line Version      7-Zip Command Line Version
+#             PKWare pkunzip                  PKWare pkzip
+#             WinZip CLI                      WinZip CLI
+#             WinRAR CLI                      WinRAR CLI
+#
+# First, check for the programs that would be installed by default.
+# If none can be found, raise an error and tell the user how they can resolve
+# the problem: Either tell them to install a different backend gem (preferred)
+# or tell them how to install a supported CLI program (depending on OS).
+#
+# When using this shell method, always emit a warning that it is very
+# inefficient and should not never no-way no-how no-where be used in
+# production environments.
+
+module MultiZip::Backend::Cli
+  STRATEGY_MODULES = [
+    [ :info_zip, lambda { InfoZip }]
+  ]
+
+  def self.extended(mod)
+    if strategy_available?
+      require "multi_zip/backend/cli/#{strategy.require_name}"
+      extend strategy.extend_class.call
+      warn([
+        "MultiZip is using the \"#{strategy.human_name}\" command-line program.",
+        'This feature is considered PRE-ALPHA, unstable and inefficient and',
+        'should not be used in production environments.'
+      ].join("\n"))
+    else
+      raise MultiZip::NoSupportedBackendError, "MultiZip::Backend::Cli could find no suitable zipping/unzipping programs in path."
+    end
+  end
+
+  def self.strategy_available?
+    !!strategy
+  end
+
+  def self.strategy
+    @strategy ||= detect_strategy
+  end
+
+  def self.detect_strategy
+    STRATEGY_MODULES.detect{|strategy_module_file, strategy_module_constant|
+      require "multi_zip/backend/cli/#{strategy_module_file}"
+      strategy_module = strategy_module_constant.call
+      if strategy_module.available?
+        return strategy_module
+      end
+    }
+  end
+end

data/lib/multi_zip/backend/cli/info_zip.rb

@@ -0,0 +1,292 @@
+module MultiZip::Backend::Cli
+  module InfoZip
+    require 'stringio'
+    require 'open3'
+
+    BUFFER_SIZE = 8192
+
+    # TODO: better way to find full path to programs?
+    WHICH_PROGRAM = 'which'
+
+    ZIP_AND_UNZIP_ARE_SAME_PROGRAM = false
+
+    ZIP_PROGRAM = 'zip'
+    ZIP_PROGRAM_SIGNATURE = /This is Zip [2-3].\d+\s.+, by Info-ZIP/
+    ZIP_PROGRAM_SIGNATURE_SWITCH = '-v'
+    ZIP_PROGRAM_REMOVE_MEMBER_SWITCH = '-d'
+
+    UNZIP_PROGRAM ='unzip'
+    UNZIP_PROGRAM_SIGNATURE = /UnZip [5-6]\.\d+ of .+, by Info-ZIP/
+    UNZIP_PROGRAM_SIGNATURE_SWITCH = '-v'
+    UNZIP_PROGRAM_LIST_MEMBERS_SWITCHES = ['-Z', '-1']
+    UNZIP_PROGRAM_READ_MEMBER_SWITCH = '-p'
+    UNZIP_PROGRAM_MEMBER_INFO_SWITCHES = ['-Z']
+
+    # TODO: does this change between versions?
+    # TODO: does this change with system language?
+    UNZIP_PROGRAM_EMPTY_ZIPFILE_MESSAGE = 'Empty zipfile.'
+    UNZIP_PROGRAM_MEMBER_NOT_FOUND_MESSAGE = 'caution: filename not matched:'
+    UNZIP_PROGRAM_INVALID_FILE_MESSAGE = 'End-of-central-directory signature not found'
+
+    def self.require_name
+      'info_zip'
+    end
+
+    def self.extend_class
+      lambda { MultiZip::Backend::Cli::InfoZip::InstanceMethods }
+    end
+
+    def self.human_name
+      'Info-ZIP - zip(1L)/unzip(1L)'
+    end
+
+    def self.available?
+      @available ||= programs_found?
+    end
+
+    def self.programs_found?
+      if ZIP_AND_UNZIP_ARE_SAME_PROGRAM
+        zip_program_found?
+      else
+        zip_program_found? && unzip_program_found?
+      end
+    end
+
+    def self.zip_program_found?
+      zip_program_path = `#{WHICH_PROGRAM} #{ZIP_PROGRAM}`.strip
+      return false unless zip_program_path =~ /#{ZIP_PROGRAM}/
+      return false unless File.exists?(zip_program_path)
+
+      spawn([ZIP_PROGRAM, ZIP_PROGRAM_SIGNATURE_SWITCH]).first =~ ZIP_PROGRAM_SIGNATURE
+    end
+
+    def self.unzip_program_found?
+      unzip_program_path = `#{WHICH_PROGRAM} #{UNZIP_PROGRAM}`.strip
+      return false unless unzip_program_path =~ /#{UNZIP_PROGRAM}/
+      return false unless File.exists?(unzip_program_path)
+
+      spawn([UNZIP_PROGRAM, UNZIP_PROGRAM_SIGNATURE_SWITCH]).first =~ UNZIP_PROGRAM_SIGNATURE
+    end
+
+    # Blatant copy from https://github.com/seamusabshere/unix_utils/blob/master/lib/unix_utils.rb
+    def self.spawn(argv, options = {}) # :nodoc:
+      input = if (read_from = options[:read_from])
+        if RUBY_DESCRIPTION =~ /jruby 1.7.0/
+          raise "MultiZip: Can't use `#{argv.first}` since JRuby 1.7.0 has a broken IO implementation!"
+        end
+        File.open(read_from, 'r')
+      end
+      output = if (write_to = options[:write_to])
+        output_redirected = true
+        File.open(write_to, 'wb')
+      else
+        output_redirected = false
+        StringIO.new
+      end
+      error = StringIO.new
+      if (chdir = options[:chdir])
+        Dir.chdir(chdir) do
+          _spawn argv, input, output, error
+        end
+      else
+        _spawn argv, input, output, error
+      end
+      error.rewind
+      whole_error = error.read
+      unless whole_error.empty?
+        $stderr.puts "MultiZip: `#{argv.join(' ')}` STDERR:"
+        $stderr.puts whole_error
+      end
+      unless output_redirected
+        output.rewind
+        [output.read, whole_error].map{|o| o.empty? ? nil : o}
+      end
+    ensure
+      [input, output, error].each { |io| io.close if io and not io.closed? }
+    end
+
+    # Blatant copy from https://github.com/seamusabshere/unix_utils/blob/master/lib/unix_utils.rb
+    def self._spawn(argv, input, output, error)
+      # lifted from posix-spawn
+      # https://github.com/rtomayko/posix-spawn/blob/master/lib/posix/spawn/child.rb
+      Open3.popen3(*argv) do |stdin, stdout, stderr|
+        readers = [stdout, stderr]
+        if RUBY_DESCRIPTION =~ /jruby 1.7.0/
+          readers.delete stderr
+        end
+        writers = if input
+          [stdin]
+        else
+          stdin.close
+          []
+        end
+        while readers.any? or writers.any?
+          ready = IO.select(readers, writers, readers + writers)
+          # write to stdin stream
+          ready[1].each do |fd|
+            begin
+              boom = nil
+              size = fd.write input.read(BUFFER_SIZE)
+            rescue Errno::EPIPE => boom
+            rescue Errno::EAGAIN, Errno::EINTR
+            end
+            if boom || size < BUFFER_SIZE
+              stdin.close
+              input.close
+              writers.delete stdin
+            end
+          end
+          # read from stdout and stderr streams
+          ready[0].each do |fd|
+            buf = (fd == stdout) ? output : error
+            if fd.eof?
+              readers.delete fd
+              fd.close
+            else
+              begin
+                # buf << fd.gets(BUFFER_SIZE) # maybe?
+                buf << fd.readpartial(BUFFER_SIZE)
+              rescue Errno::EAGAIN, Errno::EINTR
+              end
+            end
+          end
+        end
+        # thanks @tmm1 and @rtomayko for showing how it's done!
+      end
+    end
+
+    module InstanceMethods
+      def list_members(prefix = nil, options={})
+        archive_exists!
+        response = MultiZip::Backend::Cli::InfoZip.spawn([
+          UNZIP_PROGRAM, UNZIP_PROGRAM_LIST_MEMBERS_SWITCHES, @filename
+        ].flatten)
+
+        return [] if response.first.to_s =~ /^#{UNZIP_PROGRAM_EMPTY_ZIPFILE_MESSAGE}/
+
+        if response.first
+          member_list = response.first.split("\n").sort
+          member_list = member_list.select{|m| m =~ /^#{prefix}/} if prefix
+          return member_list
+        else # error, response.last should contain error message
+          raise_info_zip_error!(response.last)
+        end
+      end
+
+      def read_member(member_path, options={})
+        archive_exists!
+        member_not_found!(member_path) if member_path =~ /\/$/
+        response = MultiZip::Backend::Cli::InfoZip.spawn([
+          UNZIP_PROGRAM, UNZIP_PROGRAM_READ_MEMBER_SWITCH, @filename, member_path
+        ].flatten)
+
+        return response.first if response.first
+
+        raise_info_zip_error!(response.last, :member_path => member_path)
+      end
+
+      def write_member(member_path, member_content, options={})
+        Dir.mktmpdir do |tempdir|
+          member_file = File.new("#{tempdir}/#{member_path}", 'wb')
+          member_file.print member_content
+          member_file.close
+
+          cwd = Dir.pwd
+          Dir.chdir(tempdir)
+
+          response = MultiZip::Backend::Cli::InfoZip.spawn([
+            ZIP_PROGRAM, @filename, member_path
+          ])
+
+          Dir.chdir(cwd)
+        end
+        true
+      end
+
+      def remove_member(member_path, options={})
+        archive_exists!
+        raise MultiZip::MemberNotFoundError.new(member_path) unless member_exists?(member_path)
+
+        response = MultiZip::Backend::Cli::InfoZip.spawn([
+          ZIP_PROGRAM, ZIP_PROGRAM_REMOVE_MEMBER_SWITCH, @filename, member_path
+        ].flatten)
+
+        return response.first if response.first
+
+        raise_info_zip_error!(response.last, :member_path => member_path)
+      end
+
+      def member_info(member_path, options={})
+        archive_exists!
+
+        response = MultiZip::Backend::Cli::InfoZip.spawn([
+          UNZIP_PROGRAM, UNZIP_PROGRAM_MEMBER_INFO_SWITCHES, @filename, member_path
+        ].flatten).compact
+
+        if response.join =~ /#{UNZIP_PROGRAM_INVALID_FILE_MESSAGE}/
+          raise_info_zip_error!(response.join)
+        end
+
+        # example line:
+        # -rwx------  2.1 unx      558 bX defN 15-Jun-22 17:53 ROBO3DR1PLUSV1/BlinkM.cpp
+
+        line = response.detect{|r| r.strip.match(/#{member_path}$/)}
+
+        raise MultiZip::MemberNotFoundError.new(member_path) if line.nil? || line =~ /#{UNZIP_PROGRAM_MEMBER_NOT_FOUND_MESSAGE}/i
+
+        fields = line.split(/\s+/)
+
+        path = fields.last
+        unless path == member_path
+          raise MultiZip::Backend::Cli::InfoZip::ResponseError, "Unexpected file name format or position: #{line.inspect}"
+        end
+
+        size = fields[3]
+        unless size =~ /\d+/
+          raise MultiZip::Backend::Cli::InfoZip::ResponseError, "Unexpected file size format or position: #{line.inspect}"
+        end
+
+        type = case fields[0].slice(0,1)
+          when 'd'
+            :directory
+          when 'l'
+            :symlink
+          when '-'
+            :file
+          else
+            raise MultiZip::Backend::Cli::InfoZip::ResponseError, "Unexpected file type field format or position: #{line.inspect}"
+          end
+
+        {
+          path: fields.last,
+          size: size.to_i,
+          type: type,
+          original: line
+        }
+
+      end
+
+      def raise_info_zip_error!(message, options={})
+        infozip_error = MultiZip::Backend::Cli::InfoZip::ResponseError.new(message)
+        case message
+        when /#{UNZIP_PROGRAM_INVALID_FILE_MESSAGE}/
+          raise MultiZip::InvalidArchiveError.new(@filename, infozip_error)
+        when /cannot find or open/
+          raise MultiZip::ArchiveNotFoundError.new(@filename, infozip_error)
+        when /filename not matched/
+          raise MultiZip::MemberNotFoundError.new(options[:member_path])
+        else
+          raise MultiZip::UnknownError.new(@filename, infozip_error)
+        end
+      end
+    end
+
+
+    class ResponseError < MultiZip::InvalidArchiveError
+      attr_reader :message
+      def initialize(error_message)
+        @message = error_message
+      end
+    end
+  end
+end

data/lib/multi_zip/backend/rubyzip.rb

@@ -55,6 +55,21 @@ module MultiZip::Backend::Rubyzip
     end
   end
 
+  def member_info(member_path, options = {})
+    read_operation do |zip_file|
+      if zip_entry = zip_file.detect{|ze| ze.name == member_path}
+        {
+          path: zip_entry.name,
+          size: zip_entry.size.to_i,
+          type: zip_entry.ftype,
+          original: zip_entry
+        }
+      else
+        member_not_found!(member_path)
+      end
+    end
+  end
+
 private
 
   def read_operation(&blk)
@@ -70,4 +85,4 @@ private
       raise
     end
   end
-end
+end

data/lib/multi_zip/backend/zipruby.rb

@@ -58,6 +58,25 @@ module MultiZip::Backend::Zipruby
     true
   end
 
+  def member_info(member_path, options = {})
+    read_operation do |zip|
+      member_location = zip.locate_name(member_path)
+      if member_location == -1
+        zip.close
+        member_not_found!(member_path)
+      end
+
+      member_stats = zip.get_stat(member_location)
+
+      {
+        path: member_stats.name,
+        size: member_stats.size.to_i,
+        type: member_stats.directory? ? :directory : :file,
+        original: member_stats
+      }
+    end
+  end
+
 private
 
   # NOTE: Zip::Archive#locate_name return values
@@ -91,4 +110,4 @@ private
       raise
     end
   end
-end
+end

data/lib/multi_zip/errors.rb

@@ -36,6 +36,8 @@ class MultiZip
     end
   end
 
+  class UnknownError < ArchiveError; end
+
   class InvalidArchiveError < ArchiveError; end
   class ArchiveNotFoundError < ArchiveError
     def message

data/lib/multi_zip/version.rb

@@ -1,3 +1,3 @@
 class MultiZip
-  VERSION = "0.1.4"
+  VERSION = "0.1.6"
 end

data/spec/backend_shared_example.rb

@@ -200,6 +200,55 @@ shared_examples 'zip backend' do |backend_name|
       end
     end
 
+    describe '#member_info' do
+      context 'member found' do
+        archive_member_files.each do |member_file|
+          it "returns hash of member information" do
+            info = subject.member_info(member_file)
+            expect(info).to include(
+              {
+                path: member_file,
+                size: archive_member_size(member_file),
+                type: :file
+              }
+            )
+
+            expect(info[:original]).to_not be_nil
+          end
+        end
+      end
+
+      context 'member not found' do
+        it_behaves_like 'raises MemberNotFoundError', :member_info, 'doesnt_exist'
+      end
+
+      context 'member is a directory' do
+        it "returns hash of member information" do
+          expect(
+            subject.member_info(archive_member_directories.first)
+          ).to include(
+            {
+              path: archive_member_directories.first,
+              size: archive_member_size(archive_member_directories.first).to_i,
+              type: :directory
+            }
+          )
+        end
+      end
+
+      it_behaves_like 'archive not found, raises ArchiveNotFoundError', :member_info, archive_member_files.first
+
+      it_behaves_like 'archive is not a file, raises ArchiveNotFoundError', :member_info, archive_member_files.first
+
+      context 'archive cannot be accessed due to permissions' do
+        it 'raises ArchiveNotAccessibleError'
+      end
+
+      context 'invalid or unreadable archive' do
+        it_behaves_like 'raises InvalidArchiveError', :member_info, archive_member_files.first
+      end
+    end
+
     describe '#write_member' do
       after { FileUtils.rm(filename) if File.exists?(filename) }
 
@@ -318,35 +367,51 @@ shared_examples 'zip backend' do |backend_name|
       context 'archive exists' do
         before do
           FileUtils.cp(filename, temp_filename)
-          expect(
-            MultiZip.new(temp_filename).member_exists?(member_file_name)
-          ).to be_truthy
         end
 
-        let!(:result) do
-          subject.remove_member(member_file_name)
-        end
-
-        context 'member removed successfully' do
-          it 'returns true' do
-            expect(result).to be_truthy
-          end
-          it 'removes the member from the file' do
+        context 'member found in archive' do
+          let!(:result) do
             expect(
               MultiZip.new(temp_filename).member_exists?(member_file_name)
-            ).to be_falsey
+            ).to be_truthy
+
+            subject.remove_member(member_file_name)
           end
-          it 'does not remove any other members' do
-            zip = MultiZip.new(temp_filename)
-            (archive_member_files - [member_file_name]).each do |mfn|
-              expect(zip.member_exists?(mfn)).to be_truthy
+
+          context 'member removed successfully' do
+            it 'returns true' do
+              expect(result).to be_truthy
+            end
+            it 'removes the member from the file' do
+              expect(
+                MultiZip.new(temp_filename).member_exists?(member_file_name)
+              ).to be_falsey
+            end
+            it 'does not remove any other members' do
+              zip = MultiZip.new(temp_filename)
+              (archive_member_files - [member_file_name]).each do |mfn|
+                expect(zip.member_exists?(mfn)).to be_truthy
+              end
             end
           end
+
+          context 'member not successfully removed' do
+            it 'raises MemberNotRemovedError'
+            it 'does not remove member from the archive'
+          end
         end
 
-        context 'member not successfully added' do
-          it 'raises MemberNotRemovedError'
-          it 'does not remove member from the archive'
+        context 'member not found in archive' do
+          before do
+            expect(
+              MultiZip.new(temp_filename).member_exists?('doesnt_exist')
+            ).to be_falsey
+          end
+          it 'raises MemberNotFoundError' do
+            expect(
+              lambda { subject.remove_member('doesnt_exist') }
+            ).to raise_error(MultiZip::MemberNotFoundError)
+          end
         end
       end
 
@@ -463,4 +528,3 @@ shared_examples 'archive is not a file, raises ArchiveNotFoundError' do |*args|
     it_behaves_like 'raises ArchiveNotFoundError', *args
   end
 end
-

data/spec/lib/multi_zip/backend/archive_zip_spec.rb

@@ -2,5 +2,7 @@ require 'spec_helper'
 require 'backend_shared_example'
 
 RSpec.describe MultiZip do
-  it_behaves_like 'zip backend', 'archive_zip'
+  if test_with_archive_zip?
+    it_behaves_like 'zip backend', 'archive_zip'
+  end
 end

data/spec/lib/multi_zip/backend/cli_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+require 'backend_shared_example'
+
+RSpec.describe MultiZip do
+  if test_with_cli?
+    it_behaves_like 'zip backend', 'cli'
+  end
+end

data/spec/lib/multi_zip/backend/rubyzip_spec.rb

@@ -5,4 +5,4 @@ RSpec.describe MultiZip do
   if test_with_rubyzip?
     it_behaves_like 'zip backend', 'rubyzip'
   end
-end
+end

data/spec/lib/multi_zip_spec.rb

@@ -2,7 +2,8 @@ require 'spec_helper'
 
 RSpec.describe MultiZip do
   let(:filename) { archive_fixture_filename }
-  let(:subject) { MultiZip.new(filename) }
+  let(:subject) { MultiZip.new(filename, instance_options) }
+  let(:instance_options) { {} }
 
   describe '.new' do
     it 'accepts a block'
@@ -24,10 +25,11 @@ RSpec.describe MultiZip do
     end
 
     context 'unknown backend' do
+      let(:instance_options) { { :allow_no_backends => true } }
       it 'raises exception' do
         expect(
           lambda { subject.backend = 'unsupported' }
-        ).to raise_exception(MultiZip::NoSupportedBackendError)
+        ).to raise_exception(MultiZip::InvalidBackendError)
       end
     end
   end
@@ -50,4 +52,4 @@ RSpec.describe MultiZip do
       end
     end
   end
-end
+end

data/spec/spec_helper.rb

@@ -1,7 +1,7 @@
 require 'multi_zip'
 
 # can't use pry on old rubies or on rubinius
-if RUBY_VERSION.to_f >= 2.0 && RUBY_ENGINE == 'ruby'
+if RUBY_VERSION.to_f >= 2.2 && RUBY_ENGINE == 'ruby'
   require 'byebug'
 end
 
@@ -76,28 +76,61 @@ def archive_member_directories
 end
 
 def test_with_rubyzip?
-  # rubyzip requires ruby >= 1.9.2
-  if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("1.9.2")
-    gem 'rubyzip'
-    return true
+  test = if ENV['ONLY']
+    ENV['ONLY'] == 'rubyzip'
+  else
+    true
+  end
+
+  if test
+    # rubyzip requires ruby >= 1.9.2
+    if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("1.9.2")
+      gem 'rubyzip'
+      return true
+    end
+    return false
   end
-  false
 rescue Gem::LoadError
   false
 end
 
 def test_with_zipruby?
-  gem 'zipruby'
-  true
+  test = if ENV['ONLY']
+    ENV['ONLY'] == 'zipruby'
+  else
+    true
+  end
+
+  if test
+    gem 'zipruby'
+    return true
+  end
 rescue Gem::LoadError
   false
 end
 
+def test_with_archive_zip?
+  if ENV['ONLY']
+    ENV['ONLY'] =~ /archive/
+  else
+    true
+  end
+end
+
+def test_with_cli?
+  if ENV['ONLY']
+    ENV['ONLY'] = 'cli'
+  else
+    MultiZip::Backend::Cli.strategy_available?
+  end
+end
+
 def backends_to_test
   @backends_to_test ||= [
     (test_with_zipruby? ? :zipruby : nil),
     (test_with_rubyzip? ? :rubyzip : nil),
-    :archive_zip
+    (test_with_archive_zip? ? :archive_zip : nil),
+    (test_with_cli? ? :cli : nil),
   ].compact
 end
 
@@ -108,8 +141,13 @@ if excluded_backends.length > 0
   warn "*** Backends that will not be tested: #{excluded_backends.map(&:to_s).join(', ')} ***"
 end
 
-BACKEND_CONSTANTS = {}
-BACKEND_CLASSES = {}
+puts "*** MultiZip::Backend::Cli.strategy_available?: #{MultiZip::Backend::Cli.strategy_available?.inspect}"
+if MultiZip::Backend::Cli.strategy_available?
+  puts "*** MultiZip::Backend::Cli.strategy: #{MultiZip::Backend::Cli.strategy.inspect}"
+end
+
+BACKEND_CONSTANTS = Hash.new([])
+BACKEND_CLASSES = Hash.new([])
 
 def set_backend_class(lib, klass)
   BACKEND_CONSTANTS[lib.to_sym] = klass.constants

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: multi_zip
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - Matthew Nielsen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-06 00:00:00.000000000 Z
+date: 2017-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -65,6 +65,7 @@ files:
 - ".rspec"
 - ".travis.yml"
 - BACKEND_CONSTANTS.md
+- CHANGELOG.md
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -73,6 +74,8 @@ files:
 - TODO.md
 - lib/multi_zip.rb
 - lib/multi_zip/backend/archive_zip.rb
+- lib/multi_zip/backend/cli.rb
+- lib/multi_zip/backend/cli/info_zip.rb
 - lib/multi_zip/backend/rubyzip.rb
 - lib/multi_zip/backend/zipruby.rb
 - lib/multi_zip/errors.rb
@@ -84,6 +87,7 @@ files:
 - spec/fixtures/test.zip
 - spec/fixtures/test/.gitkeep
 - spec/lib/multi_zip/backend/archive_zip_spec.rb
+- spec/lib/multi_zip/backend/cli_spec.rb
 - spec/lib/multi_zip/backend/rubyzip_spec.rb
 - spec/lib/multi_zip/backend/zipruby_spec.rb
 - spec/lib/multi_zip_spec.rb
@@ -108,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Abstracts zipping and unzipping using whatever gems are installed, automatically.
@@ -119,6 +123,7 @@ test_files:
 - spec/fixtures/test.zip
 - spec/fixtures/test/.gitkeep
 - spec/lib/multi_zip/backend/archive_zip_spec.rb
+- spec/lib/multi_zip/backend/cli_spec.rb
 - spec/lib/multi_zip/backend/rubyzip_spec.rb
 - spec/lib/multi_zip/backend/zipruby_spec.rb
 - spec/lib/multi_zip_spec.rb