mini_tarball 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb6115ef818ae567ea4efad8646977a26cbb62f5164e656bd8d403dd1775ff38
-  data.tar.gz: 5364a6eece1aa623c4bb900eaf50de383017dcd4b9285f5f7b3b52423638d9b2
+  metadata.gz: e4f402eb6b43dd9a6a5b62d59d60d4ab949e9ea9c4e03be89354ab71624f5c74
+  data.tar.gz: 96e28996b32be3a777e7e8a1517e746536851e8a5e5cd330854a2e75b763be70
 SHA512:
-  metadata.gz: d8978adda8f400f47d37d037fc439d6d803538910aaa97a78cee3ec111b34616c0b3acd298a6a5b406a02a8e0d698e25743a5a4ff32a2e1b827835892621d186
-  data.tar.gz: 543abee46d1e1bd3df2abdd0b0164f2e72363d65ec63a7ac8c120302c94a0fc247315fcb7c4541774ab08ef00178e4de1df355cb2699e0056f0d984e53f532bc
+  metadata.gz: 0b941f8cb82d7a0a73782cd59e4e6185c4e28bd4c3e41f5eaaff1056e8503747df7012ba5cbe6a515d2138183bed3502f977b62f5cf6ab1909d9d7efdc3cd956
+  data.tar.gz: 108091d73b67d1cff944b04fc9c0123490b2234fcf1d53a53858bfa341204ab1bb7048b71cc4e596cb979c4ef92d62f0ebce6d914267f0012fe5e387477e7d40

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.2.0"
+  VERSION = "0.3.0"
 end

data/lib/mini_tarball/writer.rb

@@ -35,6 +35,7 @@ module MiniTarball
       @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)
@@ -86,6 +87,43 @@ module MiniTarball
       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?
       @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.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Discourse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-09 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.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: A minimal implementation of the GNU Tar format.