mini_tarball 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 186593f6df9a85bfd1247d7ac48d2e2516d21d3dc7cd92e97774667ecc0768be
+  data.tar.gz: 7b4c0465dddd0c67822fca7f7d44c5e134dea5dae4e839f307975d42aacf5728
+SHA512:
+  metadata.gz: 76239123207c12d071fa25ac28a7ee9e1d1796e3a68f15a5d124eeaf695590900130dff61cfe3e8af8c92f6b48ffa41e9be6e311ab0e93c42da5b0fb7efa1da8
+  data.tar.gz: e8bfcc562c8569b8f9168757406dfe162f31417a5bf7fb3b658b99a76de6896fa9b8dd3b5d73f8e1c33b434499dadc332a9c5dd6659185359a0d278d41b872c5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Discourse
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/lib/mini_tarball.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'mini_tarball/header'
+require 'mini_tarball/header_formatter'
+require 'mini_tarball/header_writer'
+require 'mini_tarball/write_only_stream'
+require 'mini_tarball/writer'
+require 'mini_tarball/version'

data/lib/mini_tarball/header.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module MiniTarball
+  class Header
+    # Size of each block in the tar file in bytes
+    BLOCK_SIZE = 512 # bytes
+
+    TYPE_REGULAR = "0"
+    TYPE_LONG_LINK = "L"
+
+    # rubocop:disable Layout/HashAlignment
+    FIELDS = {
+      name:     { length: 100, type: :chars },
+      mode:     { length:   8, type: :number },
+      uid:      { length:   8, type: :number },
+      gid:      { length:   8, type: :number },
+      size:     { length:  12, type: :number },
+      mtime:    { length:  12, type: :number },
+      checksum: { length:   8, type: :checksum },
+      typeflag: { length:   1, type: :chars },
+      linkname: { length: 100, type: :chars },
+      magic:    { length:   6, type: :chars },
+      version:  { length:   2, type: :chars },
+      uname:    { length:  32, type: :chars },
+      gname:    { length:  32, type: :chars },
+      devmajor: { length:   8, type: :number },
+      devminor: { length:   8, type: :number },
+      prefix:   { length: 155, type: :chars }
+    }
+    # rubocop:enable Layout/HashAlignment
+
+    def initialize(name:, mode: 0, uid: nil, gid: nil, size: 0, mtime: 0, typeflag: TYPE_REGULAR, linkname: "", uname: nil, gname: nil)
+      @values = {
+        name: name,
+        mode: mode,
+        uid: uid,
+        gid: gid,
+        size: size,
+        mtime: mtime.to_i,
+        checksum: nil,
+        typeflag: typeflag,
+        linkname: linkname,
+        magic: "ustar ",
+        version: " ",
+        uname: uname,
+        gname: gname,
+        devmajor: nil,
+        devminor: nil,
+        prefix: ""
+      }
+    end
+
+    def value_of(key)
+      @values[key]
+    end
+  end
+end

data/lib/mini_tarball/header_formatter.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module MiniTarball
+  ValueTooLargeError = Class.new(StandardError)
+
+  class HeaderFormatter
+    # @param value [Integer]
+    # @param length [Integer]
+    def self.format_number(value, length)
+      return nil if value.nil?
+      raise NotImplementedError.new("Negative numbers are not supported") if value.negative?
+
+      octal_length = length - 1
+      max_octal_value = ("0" + "7" * octal_length).to_i(8)
+
+      if (value <= max_octal_value)
+        to_octal(value, octal_length)
+      else
+        to_base256(value, length)
+      end
+    end
+
+    def self.to_octal(value, length)
+      "%0#{length}o" % value
+    end
+
+    def self.to_base256(value, length)
+      encoded = Array.new(length, 0)
+      encoded[0] = 0x80
+      index = length - 1
+
+      while value > 0
+        raise ValueTooLargeError.new("Value is too large: #{value}") if index == 0
+        encoded[index] = value % 256
+        value /= 256
+        index -= 1
+      end
+
+      encoded.pack("C#{length}")
+    end
+  end
+end

data/lib/mini_tarball/header_writer.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module MiniTarball
+  class HeaderWriter
+    def initialize(io)
+      @io = io
+    end
+
+    def write(header)
+      write_long_name_header(header) if has_long_name?(header)
+      @io.write(to_binary(header))
+    end
+
+    private
+
+    def to_binary(header)
+      values_by_field = {}
+
+      Header::FIELDS.each do |name, field|
+        value = values_by_field[name] = header.value_of(name)
+
+        case field[:type]
+        when :number
+          values_by_field[name] = HeaderFormatter.format_number(value, field[:length])
+        when :checksum
+          values_by_field[name] = " " * field[:length]
+        end
+      end
+
+      update_checksum(values_by_field)
+      add_padding(encode(values_by_field.values))
+    end
+
+    def update_checksum(values_by_field)
+      checksum = encode(values_by_field.values).unpack("C*").sum
+      values_by_field[:checksum] = format_checksum(checksum)
+    end
+
+    def format_checksum(checksum)
+      length = Header::FIELDS[:checksum][:length] - 1
+      HeaderFormatter.format_number(checksum, length) << "\0 "
+    end
+
+    def encode(values)
+      @pack_format ||= Header::FIELDS.values
+        .map { |field| "a#{field[:length]}" }
+        .join("")
+
+      values.pack(@pack_format)
+    end
+
+    def add_padding(binary)
+      padding_length = (Header::BLOCK_SIZE - binary.length) % Header::BLOCK_SIZE
+      binary << "\0" * padding_length
+    end
+
+    def has_long_name?(header)
+      header.value_of(:name).bytesize > Header::FIELDS[:name][:length]
+    end
+
+    def write_long_name_header(header)
+      name = header.value_of(:name)
+      private_header = long_link_header(name, Header::TYPE_LONG_LINK)
+      data = [header.value_of(:name)].pack("Z*")
+
+      @io.write(to_binary(private_header))
+      @io.write(add_padding(data))
+    end
+
+    def long_link_header(name, type)
+      Header.new(
+        name: "././@LongLink",
+        mode: 0644,
+        uid: 0,
+        gid: 0,
+        size: name.bytesize + 1,
+        typeflag: type,
+        uname: "root",
+        gname: "root"
+      )
+    end
+  end
+end

data/lib/mini_tarball/version.rb

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

data/lib/mini_tarball/write_only_stream.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module MiniTarball
+  class WriteOnlyStream
+    def initialize(io)
+      @io = io
+    end
+
+    def write(data)
+      @io.write (data)
+    end
+  end
+end

data/lib/mini_tarball/writer.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module MiniTarball
+  class Writer
+    END_OF_TAR_BLOCK_SIZE = 1024
+
+    # @param [String] filename
+    # @yieldparam [Writer]
+    def self.create(filename)
+      File.open(filename, "wb") do |file|
+        use(file) { |writer| yield(writer) }
+      end
+    end
+
+    # @param [IO] io
+    # @yieldparam [Writer]
+    def self.use(io)
+      writer = new(io)
+
+      begin
+        yield(writer)
+      ensure
+        writer.close
+      end
+
+      nil
+    end
+
+    def initialize(io)
+      check_io!(io)
+
+      @io = io
+      @write_only_io = WriteOnlyStream.new(@io)
+      @header_writer = HeaderWriter.new(@write_only_io)
+      @closed = false
+    end
+
+    def add_file(name:, mode: 0644, uname: "nobody", gname: "nogroup", uid: nil, gid: nil, mtime: nil)
+      check_closed!
+
+      header_start_position = @io.pos
+      @header_writer.write(Header.new(name: name))
+
+      file_start_position = @io.pos
+      yield @write_only_io
+      file_size = @io.pos - file_start_position
+      write_padding
+
+      @io.seek(header_start_position)
+      @header_writer.write(Header.new(
+        name: name,
+        size: file_size,
+        mode: mode,
+        uid: uid,
+        gid: gid,
+        uname: uname,
+        gname: gname,
+        mtime: mtime || Time.now.utc
+      ))
+
+      @io.seek(0, IO::SEEK_END)
+    end
+
+    def closed?
+      @closed
+    end
+
+    def close
+      check_closed!
+
+      @io.write("\0" * END_OF_TAR_BLOCK_SIZE)
+      @io.close
+      @closed = true
+    end
+
+    private
+
+    def check_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
+    end
+
+    def check_closed!
+      raise IOError.new("#{self.class} is closed") if closed?
+    end
+
+    def write_padding
+      padding_length = (Header::BLOCK_SIZE - @io.pos) % Header::BLOCK_SIZE
+      @io.write("\0" * padding_length)
+    end
+  end
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: mini_tarball
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Discourse
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-02-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-discourse
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: super_diff
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- lib/mini_tarball.rb
+- lib/mini_tarball/header.rb
+- lib/mini_tarball/header_formatter.rb
+- lib/mini_tarball/header_writer.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:
+- MIT
+metadata:
+  homepage_uri: https://github.com/discourse/mini_tarball
+  source_code_uri: https://github.com/discourse/mini_tarball
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A minimal implementation of the GNU Tar format.
+test_files: []