mini_tarball 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 186593f6df9a85bfd1247d7ac48d2e2516d21d3dc7cd92e97774667ecc0768be
-  data.tar.gz: 7b4c0465dddd0c67822fca7f7d44c5e134dea5dae4e839f307975d42aacf5728
+  metadata.gz: e4f402eb6b43dd9a6a5b62d59d60d4ab949e9ea9c4e03be89354ab71624f5c74
+  data.tar.gz: 96e28996b32be3a777e7e8a1517e746536851e8a5e5cd330854a2e75b763be70
 SHA512:
-  metadata.gz: 76239123207c12d071fa25ac28a7ee9e1d1796e3a68f15a5d124eeaf695590900130dff61cfe3e8af8c92f6b48ffa41e9be6e311ab0e93c42da5b0fb7efa1da8
-  data.tar.gz: e8bfcc562c8569b8f9168757406dfe162f31417a5bf7fb3b658b99a76de6896fa9b8dd3b5d73f8e1c33b434499dadc332a9c5dd6659185359a0d278d41b872c5
+  metadata.gz: 0b941f8cb82d7a0a73782cd59e4e6185c4e28bd4c3e41f5eaaff1056e8503747df7012ba5cbe6a515d2138183bed3502f977b62f5cf6ab1909d9d7efdc3cd956
+  data.tar.gz: 108091d73b67d1cff944b04fc9c0123490b2234fcf1d53a53858bfa341204ab1bb7048b71cc4e596cb979c4ef92d62f0ebce6d914267f0012fe5e387477e7d40

data/lib/mini_tarball/header.rb

@@ -11,7 +11,7 @@ module MiniTarball
     # rubocop:disable Layout/HashAlignment
     FIELDS = {
       name:     { length: 100, type: :chars },
-      mode:     { length:   8, type: :number },
+      mode:     { length:   8, type: :mode },
       uid:      { length:   8, type: :number },
       gid:      { length:   8, type: :number },
       size:     { length:  12, type: :number },

data/lib/mini_tarball/header_formatter.rb

@@ -4,6 +4,8 @@ module MiniTarball
   ValueTooLargeError = Class.new(StandardError)
 
   class HeaderFormatter
+    PERMISSION_BITMASK = 0007777
+
     # @param value [Integer]
     # @param length [Integer]
     def self.format_number(value, length)
@@ -38,5 +40,12 @@ module MiniTarball
 
       encoded.pack("C#{length}")
     end
+
+    # Removes file type bitfields and returns file permissions as formatted number
+    # @param value [Integer]
+    # @param length [Integer]
+    def self.format_permissions(value, length)
+      format_number(value & PERMISSION_BITMASK, length)
+    end
   end
 end

data/lib/mini_tarball/header_writer.rb

@@ -22,6 +22,8 @@ module MiniTarball
         case field[:type]
         when :number
           values_by_field[name] = HeaderFormatter.format_number(value, field[:length])
+        when :mode
+          values_by_field[name] = HeaderFormatter.format_permissions(value, field[:length])
         when :checksum
           values_by_field[name] = " " * field[:length]
         end

data/lib/mini_tarball/streams/limited_size_stream.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module MiniTarball
+  class WriteOutOfRangeError < StandardError; end
+
+  class LimitedSizeStream
+    attr_reader :start_position, :end_position
+
+    def initialize(io, start_position:, max_file_size:)
+      @io = io
+      @start_position = start_position
+      @end_position = start_position + max_file_size
+    end
+
+    def write(data)
+      if @io.pos < start_position || @io.pos + data.bytesize > end_position
+        raise WriteOutOfRangeError.new("Writing outside of limits not allowed")
+      end
+
+      @io.write(data)
+    end
+  end
+end

data/lib/mini_tarball/streams/placeholder_stream.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module MiniTarball
+  class PlaceholderStream < LimitedSizeStream
+    def initialize(io, start_position:, file_size:)
+      super(io, start_position: start_position, max_file_size: file_size)
+    end
+
+    def write(data)
+      super(data)
+      @io.write("\0" * (end_position - @io.pos)) if @io.pos <= end_position
+    end
+  end
+end

data/lib/mini_tarball/{write_only_stream.rb → streams/write_only_stream.rb}

@@ -7,7 +7,7 @@ module MiniTarball
     end
 
     def write(data)
-      @io.write (data)
+      @io.write(data)
     end
   end
 end

data/lib/mini_tarball/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MiniTarball
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

data/lib/mini_tarball/writer.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'etc'
+
 module MiniTarball
   class Writer
     END_OF_TAR_BLOCK_SIZE = 1024
@@ -27,16 +29,39 @@ module MiniTarball
     end
 
     def initialize(io)
-      check_io!(io)
+      ensure_valid_io!(io)
 
       @io = io
       @write_only_io = WriteOnlyStream.new(@io)
       @header_writer = HeaderWriter.new(@write_only_io)
       @closed = false
+      @placeholders = []
+    end
+
+    def add_file(name:, source_file_path:, mode: nil, uname: nil, gname: nil, uid: nil, gid: nil, mtime: nil)
+      ensure_not_closed!
+
+      file = File.open(source_file_path, "rb")
+      stat = File.stat(source_file_path)
+
+      @header_writer.write(Header.new(
+        name: name,
+        size: stat.size,
+        mode: mode || stat.mode,
+        uid: uid || stat.uid,
+        gid: gid || stat.gid,
+        uname: uname || Etc.getpwuid(stat.uid).name,
+        gname: gname || Etc.getgrgid(stat.gid).name,
+        mtime: mtime || stat.mtime
+      ))
+
+      IO.copy_stream(file, @write_only_io)
+      write_padding
+      nil
     end
 
-    def add_file(name:, mode: 0644, uname: "nobody", gname: "nogroup", uid: nil, gid: nil, mtime: nil)
-      check_closed!
+    def add_file_from_stream(name:, mode: 0644, uname: "nobody", gname: "nogroup", uid: nil, gid: nil, mtime: nil)
+      ensure_not_closed!
 
       header_start_position = @io.pos
       @header_writer.write(Header.new(name: name))
@@ -59,6 +84,44 @@ module MiniTarball
       ))
 
       @io.seek(0, IO::SEEK_END)
+      nil
+    end
+
+    def add_file_placeholder(name:, file_size:)
+      ensure_not_closed!
+
+      placeholder = {}
+      placeholder[:header_start_position] = @io.pos
+      @header_writer.write(Header.new(name: name, size: file_size))
+
+      placeholder[:file_start_position] = @io.pos
+      @io.write("\0" * file_size)
+      placeholder[:file_size] = file_size
+
+      write_padding
+
+      @placeholders << placeholder
+      @placeholders.size - 1
+    end
+
+    def with_placeholder(index)
+      placeholder = @placeholders[index]
+      raise ArgumentError.new("Placeholder not found") if placeholder.nil?
+
+      @io.seek(placeholder[:header_start_position])
+      old_write_only_io = @write_only_io
+      @write_only_io = PlaceholderStream.new(
+        @io,
+        start_position: placeholder[:file_start_position],
+        file_size: placeholder[:file_size]
+      )
+
+      yield self
+
+      @write_only_io = old_write_only_io
+      @io.seek(0, IO::SEEK_END)
+
+      nil
     end
 
     def closed?
@@ -66,7 +129,7 @@ module MiniTarball
     end
 
     def close
-      check_closed!
+      ensure_not_closed!
 
       @io.write("\0" * END_OF_TAR_BLOCK_SIZE)
       @io.close
@@ -75,15 +138,12 @@ module MiniTarball
 
     private
 
-    def check_io!(io)
+    def ensure_valid_io!(io)
       raise "No IO object given" unless io.respond_to?(:pos) &&
-        io.respond_to?(:seek) && io.respond_to?(:write) && io.respond_to?(:close)
-
-      io.seek(0, IO::SEEK_END)
-      raise "Stream must be empty" unless io.pos == 0
+        io.respond_to?(:write) && io.respond_to?(:close)
     end
 
-    def check_closed!
+    def ensure_not_closed!
       raise IOError.new("#{self.class} is closed") if closed?
     end
 

data/lib/mini_tarball.rb

@@ -3,6 +3,8 @@
 require 'mini_tarball/header'
 require 'mini_tarball/header_formatter'
 require 'mini_tarball/header_writer'
-require 'mini_tarball/write_only_stream'
+require 'mini_tarball/streams/limited_size_stream'
+require 'mini_tarball/streams/placeholder_stream'
+require 'mini_tarball/streams/write_only_stream'
 require 'mini_tarball/writer'
 require 'mini_tarball/version'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mini_tarball
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Discourse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-22 00:00:00.000000000 Z
+date: 2022-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -105,8 +105,10 @@ files:
 - lib/mini_tarball/header.rb
 - lib/mini_tarball/header_formatter.rb
 - lib/mini_tarball/header_writer.rb
+- lib/mini_tarball/streams/limited_size_stream.rb
+- lib/mini_tarball/streams/placeholder_stream.rb
+- lib/mini_tarball/streams/write_only_stream.rb
 - lib/mini_tarball/version.rb
-- lib/mini_tarball/write_only_stream.rb
 - lib/mini_tarball/writer.rb
 homepage: https://github.com/discourse/mini_tarball
 licenses:
@@ -122,14 +124,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: A minimal implementation of the GNU Tar format.