tar 0.1.0

data/lib/tar/header.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "tar/backports"
+require "tar/error"
+require "tar/schema"
+require "tar/ustar"
+
+module Tar
+  class Header
+    using Backports
+
+    SCHEMA = Schema.new {
+      string :name, 100
+      octal_number :mode, 8
+      octal_number :uid, 8
+      octal_number :gid, 8
+      octal_number :size, 12
+      timestamp :mtime, 12
+      octal_number :checksum, 8
+      string :typeflag, 1
+      string :link_name, 100
+      string :magic, 6
+      string :version, 2
+      string :uname, 32
+      string :gname, 32
+      octal_number :dev_major, 8
+      octal_number :dev_minor, 8
+      string :prefix, 155
+    }
+
+    def initialize(values, checksum: nil)
+      @values = values
+      check_checksum!(checksum) if checksum
+    end
+
+    SCHEMA.field_names.each do |name|
+      define_method name do
+        @values.fetch(name)
+      end
+    end
+
+    def path
+      return name if prefix.nil?
+      "#{prefix}/#{name}"
+    end
+
+    def self.parse(record)
+      expected_checksum = SCHEMA.clear(record, :checksum).chars.sum(&:ord)
+      new(SCHEMA.parse(record), checksum: expected_checksum)
+    end
+
+    private
+
+    def check_checksum!(expected_checksum)
+      raise ChecksumMismatch, "checksum mismatch at #{path.inspect}: expected #{expected_checksum}, got #{checksum}" unless checksum == expected_checksum
+    end
+  end
+end

data/lib/tar/header_reader.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "tar/backports"
+require "tar/error"
+require "tar/header"
+require "tar/ustar"
+
+module Tar
+  class HeaderReader
+    using Backports
+
+    def initialize(io)
+      @io = io
+    end
+
+    def read
+      record = read_record
+
+      if empty?(record)
+        return nil if empty?(read_record)
+        raise InvalidArchive, "empty header"
+      end
+
+      Header.parse(record)
+    end
+
+    private
+
+    def read_record
+      USTAR.read_record(@io)
+    end
+
+    def empty?(record)
+      /\A\0+\z/m.match?(record)
+    end
+  end
+end

data/lib/tar/polyfills.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "zlib"
+
+module Tar
+  module Polyfills
+    refine Zlib::GzipReader do
+      def read(length = nil, buffer = nil)
+        raise ArgumentError, "#{self.class} does not support read to buffer" unless buffer.nil?
+        super(length)
+      end
+    end
+  end
+end

data/lib/tar/reader.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "tar/file_reader"
+require "tar/header"
+require "tar/header_reader"
+
+module Tar
+  class Reader
+    include Enumerable
+
+    def initialize(io, **encoding_options)
+      @io = io
+      @encoding_options = encoding_options
+      @header_reader = HeaderReader.new(@io)
+    end
+
+    def each
+      return to_enum unless block_given?
+
+      loop do
+        header = @header_reader.read
+        break if header.nil?
+
+        file_reader = FileReader.new(header, @io, **@encoding_options)
+        yield file_reader
+        file_reader.skip_to_next_record
+      end
+    end
+  end
+end

data/lib/tar/schema.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module Tar
+  class Schema
+    def initialize(&block)
+      @fields = {}
+      @offset = 0
+      instance_eval(&block)
+      @fields.freeze
+
+      @unpack_format = @fields.values.map(&:unpack_format).join.freeze
+    end
+
+    def field_names
+      @fields.keys
+    end
+
+    def clear(record, field_name)
+      field = @fields.fetch(field_name)
+
+      record.dup.tap { |new_record|
+        new_record[field.offset, field.size] = " " * field.size
+      }
+    end
+
+    def parse(record)
+      @fields.zip(record.unpack(@unpack_format))
+             .map { |(name, type), value| [name, type.parse(value)] }
+             .to_h
+    end
+
+    def string(name, size)
+      add_field name, String, size
+    end
+
+    def octal_number(name, size)
+      add_field name, OctalNumber, size
+    end
+
+    def timestamp(name, size)
+      add_field name, Timestamp, size
+    end
+
+    private
+
+    def add_field(name, type, size)
+      @fields[name] = type.new(size, @offset)
+      @offset += size
+    end
+
+    class FieldType
+      attr_reader :size, :offset, :unpack_format
+
+      def initialize(size, offset, unpack_format:)
+        @size = size
+        @offset = offset
+        @unpack_format = unpack_format
+      end
+    end
+
+    class String < FieldType
+      def initialize(size, offset)
+        super(size, offset, unpack_format: "Z#{size}")
+      end
+
+      def parse(value)
+        value unless value.empty?
+      end
+    end
+
+    class OctalNumber < FieldType
+      def initialize(size, offset)
+        super(size, offset, unpack_format: "A#{size}")
+      end
+
+      def parse(value)
+        value.oct
+      end
+    end
+
+    class Timestamp < OctalNumber
+      def parse(value)
+        Time.at(super)
+      end
+    end
+  end
+end

data/lib/tar/ustar.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "tar/error"
+
+module Tar
+  module USTAR
+    module_function
+
+    RECORD_SIZE = 512
+
+    def read_record(io)
+      record = io.read(RECORD_SIZE) || ""
+
+      raise UnexpectedEOF, "unexpected end-of-file: attempted to read #{RECORD_SIZE} bytes from #{io}, got #{record.size}" unless record.size == RECORD_SIZE
+
+      record
+    end
+
+    def records(file_size)
+      (file_size - 1) / RECORD_SIZE + 1
+    end
+
+    def records_size(file_size)
+      RECORD_SIZE * records(file_size)
+    end
+  end
+end

data/lib/tar/version.rb

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

data/tar.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "tar/version"
+
+Gem::Specification.new do |spec|
+  spec.name    = "tar"
+  spec.version = Tar::VERSION
+  spec.authors = ["Andrew Haines"]
+  spec.email   = ["andrew@haines.org.nz"]
+
+  spec.summary  = "Read and write TAR files"
+  spec.homepage = "https://github.com/haines/tar"
+  spec.license  = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^#{spec.bindir}/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "codeclimate-test-reporter", "~> 1.0.8"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "rake", "~> 12.0"
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: tar
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Haines
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.8
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+description: 
+email:
+- andrew@haines.org.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/char_size.rb
+- lib/tar.rb
+- lib/tar/backports.rb
+- lib/tar/error.rb
+- lib/tar/file_reader.rb
+- lib/tar/file_reader/line.rb
+- lib/tar/header.rb
+- lib/tar/header_reader.rb
+- lib/tar/polyfills.rb
+- lib/tar/reader.rb
+- lib/tar/schema.rb
+- lib/tar/ustar.rb
+- lib/tar/version.rb
+- tar.gemspec
+homepage: https://github.com/haines/tar
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Read and write TAR files
+test_files: []