minitar 0.8 → 0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1440e1c57cdd811497e6717a6f81791816bfb2ec5dce0981d9208c41bcd6f09d
-  data.tar.gz: e36cf70bd9acc32d73c95a48c1e67f494853f47603032cac05a84bd366417655
+  metadata.gz: 81012ea81faa48803820b1eb4c26fd7a305bd1a2065a748b6dee20ee42e0034a
+  data.tar.gz: '00875c99346e1b1d77c75c08d22111903ea5bc65b0d82caee885a6984209c5af'
 SHA512:
-  metadata.gz: b615673d6e6626606e6e858d453af056870f4b8c88dade5641595b35733491e6dfe2ec32e90d28f7585308a4229f2ace63b47224c0b2877b44c5b028ee3c1031
-  data.tar.gz: ea2adda3fdcf9314c325cfa69f7ae5bbf6bc02732c8b131acef7406c45c4c53906a5612940fdc6d026d2fcda809b3a095abbe90bcf96a19f4082a653dcf8cbc3
+  metadata.gz: b47a400a37432b732b662a3c374b2bb1a36b36ea3c92b58db872cb1efc8be0036d708716305f19840ab5f1d0b76a2b4331273e6c6339bc42a003b74c450e79c4
+  data.tar.gz: 32b4f62fac25b7bc4ff0ba3d2f28e5a3d761eb62c7e4f2b9330a3be95cee31eda82f6a6c6c0883a8ea4c26d3735c17aec922ab29b3b18372cf7e86b9fe425370

data/Contributing.md

@@ -69,21 +69,22 @@ Here's the most direct way to get your work merged into the project:
 
 Thanks to everyone who has contributed to minitar:
 
+*   Akinori MUSHA (knu)
 *   Antoine Toulme
 *   Curtis Sampson
 *   Daniel J. Berger
+*   Jorie Tappa
+*   Kazuyoshi Kato
 *   Kazuyoshi Kato
+*   Kevin McDermott
 *   Matthew Kent
 *   Michal Suchanek
 *   Mike Furr
 *   Pete Fritchman
 *   Zach Dennis
-*   ooooooo\_q
-*   Kazuyoshi Kato
 *   dearblue
-*   Kevin McDermott
 *   inkstak
-*   Akinori MUSHA (knu)
+*   ooooooo\_q
 
 [Minitest]: https://github.com/seattlerb/minitest
 [quality commit messages]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html

data/History.md

@@ -1,3 +1,9 @@
+## 0.9 / 2019-09-04
+
+*   jtappa added the ability to skip fsync with a new option to Minitar.unpack
+    and Minitar::Input#extract_entry. Provide `:fsync => false` as the last
+    parameter to enable. Merged from a modified version of PR [#37][].
+
 ## 0.8 / 2019-01-05
 
 *   inkstak resolved an issue introduced in the fix for [#31][] by allowing
@@ -161,3 +167,4 @@
 [#33]: https://github.com/halostatue/minitar/issues/33
 [#35]: https://github.com/halostatue/minitar/issues/35
 [#36]: https://github.com/halostatue/minitar/issues/36
+[#37]: https://github.com/halostatue/minitar/issues/37

data/README.rdoc

@@ -14,24 +14,9 @@ coveralls :: {<img src="https://coveralls.io/repos/halostatue/minitar/badge.svg"
 The minitar library is a pure-Ruby library that provides the ability to deal
 with POSIX tar(1) archive files.
 
-This is release 0.7, providing fixes for several issues and clarifying the
-Minitar security stance. There are two minor breaking changes in this version
-so that exceptions will be thrown if a negative size is provided in a tar
-stream header or if the tar stream header is otherwise invalid.
-
-This release continues the migration and modernization of the code:
-
-*   the licence has been changed to match the modern Ruby licensing scheme
-    (Ruby and Simplified BSD instead of Ruby and GNU GPL);
-*   the +minitar+ command-line program has been separated into the
-    +minitar-cli+ gem; and
-*   the +archive-tar-minitar+ gem now points to the +minitar+ and +minitar-cli+
-    gems and discourages its installation.
-
-Some of these changes may break existing programs that depend on the internal
-structure of the minitar library, but every effort has been made to ensure
-compatibility; inasmuch as is possible, this compatibility will be maintained
-through the release of minitar 1.0 (which will have strong breaking changes).
+This is release 0.9, adding a minor feature to Minitar.unpack and
+Minitar::Input#extract_entry that when <tt>:fsync => false</tt> is provided,
+fsync will be skipped.
 
 minitar (previously called Archive::Tar::Minitar) is based heavily on code
 originally written by Mauricio Julio Fernández Pradier for the rpa-base

data/lib/archive/tar/minitar.rb

@@ -73,7 +73,7 @@ end
 #       tar.close
 #     end
 module Archive::Tar::Minitar
-  VERSION = '0.8'.freeze # :nodoc:
+  VERSION = '0.9'.freeze # :nodoc:
 
   # The base class for any minitar error.
   Error = Class.new(::StandardError)
@@ -245,7 +245,7 @@ module Archive::Tar::Minitar
     # A convenience method to unpack files from +src+ into the directory
     # specified by +dest+. Only those files named explicitly in +files+
     # will be extracted.
-    def unpack(src, dest, files = [], &block)
+    def unpack(src, dest, files = [], options = {}, &block)
       Input.open(src) do |inp|
         if File.exist?(dest) and !dir?(dest)
           raise %q(Can't unpack to a non-directory.)
@@ -255,7 +255,7 @@ module Archive::Tar::Minitar
 
         inp.each do |entry|
           if files.empty? or files.include?(entry.full_name)
-            inp.extract_entry(dest, entry, &block)
+            inp.extract_entry(dest, entry, options, &block)
           end
         end
       end

data/lib/archive/tar/minitar/input.rb

@@ -19,14 +19,17 @@ module Archive::Tar::Minitar
     #    Archive::Tar::Minitar::Input.open(io) { |input| block } -> obj
     def self.open(input)
       stream = new(input)
-      return stream unless block_given?
-
-      # This exception context must remain, otherwise the stream closes on open
-      # even if a block is not given.
-      begin
-        yield stream
-      ensure
-        stream.close
+
+      if block_given?
+        # This exception context must remain, otherwise the stream closes on
+        # open even if a block is not given.
+        begin
+          yield stream
+        ensure
+          stream.close
+        end
+      else
+        stream
       end
     end
 
@@ -114,7 +117,7 @@ module Archive::Tar::Minitar
     #                     cycle.
     # <tt>:entry</tt>::   The entry being extracted; this is a
     #                     Reader::EntryStream, with all methods thereof.
-    def extract_entry(destdir, entry) # :yields action, name, stats:
+    def extract_entry(destdir, entry, options = {}, &block) # :yields action, name, stats:
       stats = {
         :current  => 0,
         :currinc  => 0,
@@ -137,59 +140,9 @@ module Archive::Tar::Minitar
       end
 
       if entry.directory?
-        dest = File.join(destdir, full_name)
-
-        yield :dir, full_name, stats if block_given?
-
-        if Archive::Tar::Minitar.dir?(dest)
-          begin
-            FileUtils.chmod(entry.mode, dest)
-          rescue
-            nil
-          end
-        else
-          File.unlink(dest.chomp('/')) if File.symlink?(dest.chomp('/'))
-
-          FileUtils.mkdir_p(dest, :mode => entry.mode)
-          FileUtils.chmod(entry.mode, dest)
-        end
-
-        fsync_dir(dest)
-        fsync_dir(File.join(dest, '..'))
-        return
+        extract_directory(destdir, full_name, entry, stats, options, &block)
       else # it's a file
-        destdir = File.join(destdir, File.dirname(full_name))
-        FileUtils.mkdir_p(destdir, :mode => 0o755)
-
-        destfile = File.join(destdir, File.basename(full_name))
-
-        File.unlink(destfile) if File.symlink?(destfile)
-
-        # Errno::ENOENT
-        # rubocop:disable Style/RescueModifier
-        FileUtils.chmod(0o600, destfile) rescue nil
-        # rubocop:enable Style/RescueModifier
-
-        yield :file_start, full_name, stats if block_given?
-
-        File.open(destfile, 'wb', entry.mode) do |os|
-          loop do
-            data = entry.read(4096)
-            break unless data
-
-            stats[:currinc] = os.write(data)
-            stats[:current] += stats[:currinc]
-
-            yield :file_progress, full_name, stats if block_given?
-          end
-          os.fsync
-        end
-
-        FileUtils.chmod(entry.mode, destfile)
-        fsync_dir(File.dirname(destfile))
-        fsync_dir(File.join(File.dirname(destfile), '..'))
-
-        yield :file_done, full_name, stats if block_given?
+        extract_file(destdir, full_name, entry, stats, options, &block)
       end
     end
 
@@ -218,5 +171,73 @@ module Archive::Tar::Minitar
     ensure
       dir.close if dir rescue nil # rubocop:disable Style/RescueModifier
     end
+
+    def extract_directory(destdir, full_name, entry, stats, options)
+      dest = File.join(destdir, full_name)
+
+      yield :dir, full_name, stats if block_given?
+
+      if Archive::Tar::Minitar.dir?(dest)
+        begin
+          FileUtils.chmod(entry.mode, dest)
+        rescue
+          nil
+        end
+      else
+        File.unlink(dest.chomp('/')) if File.symlink?(dest.chomp('/'))
+
+        FileUtils.mkdir_p(dest, :mode => entry.mode)
+        FileUtils.chmod(entry.mode, dest)
+      end
+
+      if options.fetch(:fsync, true)
+        fsync_dir(dest)
+        fsync_dir(File.join(dest, '..'))
+      end
+    end
+
+    def extract_file(destdir, full_name, entry, stats, options)
+      destdir = File.join(destdir, File.dirname(full_name))
+      FileUtils.mkdir_p(destdir, :mode => 0o755)
+
+      destfile = File.join(destdir, File.basename(full_name))
+
+      File.unlink(destfile) if File.symlink?(destfile)
+
+      # Errno::ENOENT
+      # rubocop:disable Style/RescueModifier
+      FileUtils.chmod(0o600, destfile) rescue nil
+      # rubocop:enable Style/RescueModifier
+
+      yield :file_start, full_name, stats if block_given?
+
+      File.open(destfile, 'wb', entry.mode) do |os|
+        loop do
+          data = entry.read(4096)
+          break unless data
+
+          stats[:currinc] = os.write(data)
+          stats[:current] += stats[:currinc]
+
+          yield :file_progress, full_name, stats if block_given?
+        end
+
+        if options.fetch(:fsync, true)
+          yield :file_fsync, full_name, stats if block_given?
+          os.fsync
+        end
+      end
+
+      FileUtils.chmod(entry.mode, destfile)
+
+      if options.fetch(:fsync, true)
+        yield :dir_fsync, full_name, stats if block_given?
+
+        fsync_dir(File.dirname(destfile))
+        fsync_dir(File.join(File.dirname(destfile), '..'))
+      end
+
+      yield :file_done, full_name, stats if block_given?
+    end
   end
 end

data/test/test_tar_input.rb

@@ -216,4 +216,12 @@ UTAKRsEoGAWjYBSMglFACgAAuUHUvwAoAAA=
     reader = Zlib::GzipReader.new(StringIO.new(OCTAL_WRAPPED_BY_SPACE_TGZ))
     Minitar.unpack(reader, 'data__', [])
   end
+
+  def test_fsync_false
+    outer = 0
+    Minitar.unpack(Zlib::GzipReader.new(StringIO.new(TEST_TGZ)), 'data__', [], :fsync => false) do |_label, _path, _stats|
+      outer += 1
+    end
+    assert_equal(6, outer)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minitar
 version: !ruby/object:Gem::Version
-  version: '0.8'
+  version: '0.9'
 platform: ruby
 authors:
 - Austin Ziegler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-05 00:00:00.000000000 Z
+date: 2019-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -154,36 +154,21 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.17'
+        version: '3.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.17'
+        version: '3.18'
 description: |-
   The minitar library is a pure-Ruby library that provides the ability to deal
   with POSIX tar(1) archive files.
 
-  This is release 0.7, providing fixes for several issues and clarifying the
-  Minitar security stance. There are two minor breaking changes in this version
-  so that exceptions will be thrown if a negative size is provided in a tar
-  stream header or if the tar stream header is otherwise invalid.
-
-  This release continues the migration and modernization of the code:
-
-  *   the licence has been changed to match the modern Ruby licensing scheme
-      (Ruby and Simplified BSD instead of Ruby and GNU GPL);
-  *   the +minitar+ command-line program has been separated into the
-      +minitar-cli+ gem; and
-  *   the +archive-tar-minitar+ gem now points to the +minitar+ and +minitar-cli+
-      gems and discourages its installation.
-
-  Some of these changes may break existing programs that depend on the internal
-  structure of the minitar library, but every effort has been made to ensure
-  compatibility; inasmuch as is possible, this compatibility will be maintained
-  through the release of minitar 1.0 (which will have strong breaking changes).
+  This is release 0.9, adding a minor feature to Minitar.unpack and
+  Minitar::Input#extract_entry that when <tt>:fsync => false</tt> is provided,
+  fsync will be skipped.
 
   minitar (previously called Archive::Tar::Minitar) is based heavily on code
   originally written by Mauricio Julio Fernández Pradier for the rpa-base
@@ -250,8 +235,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: The minitar library is a pure-Ruby library that provides the ability to deal