Class: Gem::Package::TarWriter (Ruby 2.7.3)
Description: Class : Gem::Package::TarWriter - Ruby 2.7.3

### Home Classes Methods

### In Files

- rubygems/package/tar_writer.rb

### Parent

Object

### Namespace

- CLASS Gem::Package::TarWriter::BoundedStream
- CLASS Gem::Package::TarWriter::FileOverflow
- CLASS Gem::Package::TarWriter::RestrictedStream

### Methods

- ::new
- ::new
- #add_file
- #add_file_digest
- #add_file_signed
- #add_file_simple
- #add_symlink
- #check_closed
- #close
- #closed?
- #flush
- #mkdir

### Class/Module Index

Quicksearch

- Gem::AvailableSet
- Gem::BasicSpecification
- Gem::BundlerVersionFinder
- Gem::Command
- Gem::CommandLineError
- Gem::CommandManager
- Gem::Commands
- Gem::Commands::BuildCommand
- Gem::Commands::CertCommand
- Gem::Commands::CheckCommand
- Gem::Commands::CleanupCommand
- Gem::Commands::ContentsCommand
- Gem::Commands::DependencyCommand
- Gem::Commands::EnvironmentCommand
- Gem::Commands::FetchCommand
- Gem::Commands::GenerateIndexCommand
- Gem::Commands::HelpCommand
- Gem::Commands::InfoCommand
- Gem::Commands::InstallCommand
- Gem::Commands::ListCommand
- Gem::Commands::LockCommand
- Gem::Commands::MirrorCommand
- Gem::Commands::OpenCommand
- Gem::Commands::OutdatedCommand
- Gem::Commands::OwnerCommand
- Gem::Commands::PristineCommand
- Gem::Commands::PushCommand
- Gem::Commands::QueryCommand
- Gem::Commands::RdocCommand
- Gem::Commands::SearchCommand
- Gem::Commands::ServerCommand
- Gem::Commands::SetupCommand
- Gem::Commands::SetupCommand::MakeDirs
- Gem::Commands::SigninCommand
- Gem::Commands::SignoutCommand
- Gem::Commands::SourcesCommand
- Gem::Commands::SpecificationCommand
- Gem::Commands::StaleCommand
- Gem::Commands::UninstallCommand
- Gem::Commands::UnpackCommand
- Gem::Commands::UpdateCommand
- Gem::Commands::WhichCommand
- Gem::Commands::YankCommand
- Gem::ConfigFile
- Gem::ConflictError
- Gem::ConsoleUI
- Gem::DefaultUserInteraction
- Gem::Dependency
- Gem::DependencyError
- Gem::DependencyInstaller
- Gem::DependencyList
- Gem::DependencyRemovalException
- Gem::DependencyResolutionError
- Gem::Deprecate
- Gem::Doctor
- Gem::DocumentError
- Gem::EndOfYAMLException
- Gem::ErrorReason
- Gem::Exception
- Gem::Ext
- Gem::Ext::BuildError
- Gem::Ext::Builder
- Gem::Ext::CmakeBuilder
- Gem::Ext::ConfigureBuilder
- Gem::Ext::ExtConfBuilder
- Gem::Ext::RakeBuilder
- Gem::FakeFetcher
- Gem::FilePermissionError
- Gem::FormatException
- Gem::GemNotFoundException
- Gem::GemNotInHomeException
- Gem::GemRunner
- Gem::GemcutterUtilities
- Gem::ImpossibleDependenciesError
- Gem::Indexer
- Gem::InstallError
- Gem::InstallUpdateOptions
- Gem::Installer
- Gem::Installer::FakePackage
- Gem::InstallerTestCase
- Gem::InvalidSpecificationException
- Gem::Licenses
- Gem::List
- Gem::LoadError
- Gem::LocalRemoteOptions
- Gem::MissingSpecError
- Gem::MissingSpecVersionError
- Gem::MockGemUi
- Gem::MockGemUi::InputEOFError
- Gem::MockGemUi::SystemExitException
- Gem::MockGemUi::TTY
- Gem::MockGemUi::TermError
- Gem::NameTuple
- Gem::NoAliasYAMLTree
- Gem::OperationNotSupportedError
- Gem::Package::DigestIO
- Gem::Package::Error
- Gem::Package::FormatError
- Gem::Package::NonSeekableIO
- Gem::Package::Old
- Gem::Package::PathError
- Gem::Package::TarHeader
- Gem::Package::TarInvalidError
- Gem::Package::TarReader
- Gem::Package::TarReader::Entry
- Gem::Package::TarReader::UnexpectedEOF
- Gem::Package::TarTestCase
- Gem::Package::TarWriter
- Gem::Package::TarWriter::BoundedStream
- Gem::Package::TarWriter::FileOverflow
- Gem::Package::TarWriter::RestrictedStream
- Gem::Package::TooLongFileName
- Gem::PackageTask
- Gem::PathSupport
- Gem::Platform
- Gem::PlatformMismatch
- Gem::RemoteError
- Gem::RemoteFetcher
- Gem::RemoteFetcher::FetchError
- Gem::RemoteFetcher::UnknownHostError
- Gem::RemoteInstallationCancelled
- Gem::RemoteInstallationSkipped
- Gem::RemoteSourceException
- Gem::RequestSet
- Gem::RequestSet::GemDependencyAPI
- Gem::RequestSet::Lockfile
- Gem::RequestSet::Lockfile::ParseError
- Gem::RequestSet::Lockfile::Parser
- Gem::RequestSet::Lockfile::Tokenizer
- Gem::Requirement
- Gem::Requirement::BadRequirementError
- Gem::Resolver
- Gem::Resolver::APISet
- Gem::Resolver::APISpecification
- Gem::Resolver::ActivationRequest
- Gem::Resolver::BestSet
- Gem::Resolver::ComposedSet
- Gem::Resolver::Conflict
- Gem::Resolver::CurrentSet
- Gem::Resolver::DependencyRequest
- Gem::Resolver::GitSet
- Gem::Resolver::GitSpecification
- Gem::Resolver::IndexSet
- Gem::Resolver::IndexSpecification
- Gem::Resolver::InstalledSpecification
- Gem::Resolver::InstallerSet
- Gem::Resolver::LocalSpecification
- Gem::Resolver::LockSet
- Gem::Resolver::LockSpecification
- Gem::Resolver::Molinillo
- Gem::Resolver::Molinillo::CircularDependencyError
- Gem::Resolver::Molinillo::Delegates
- Gem::Resolver::Molinillo::Delegates::ResolutionState
- Gem::Resolver::Molinillo::Delegates::SpecificationProvider
- Gem::Resolver::Molinillo::DependencyGraph
- Gem::Resolver::Molinillo::DependencyGraph::Action
- Gem::Resolver::Molinillo::DependencyGraph::AddEdgeNoCircular
- Gem::Resolver::Molinillo::DependencyGraph::DeleteEdge
- Gem::Resolver::Molinillo::DependencyGraph::DetachVertexNamed
- Gem::Resolver::Molinillo::DependencyGraph::Log
- Gem::Resolver::Molinillo::DependencyGraph::Tag
- Gem::Resolver::Molinillo::DependencyGraph::Vertex
- Gem::Resolver::Molinillo::DependencyState
- Gem::Resolver::Molinillo::NoSuchDependencyError
- Gem::Resolver::Molinillo::PossibilityState
- Gem::Resolver::Molinillo::ResolutionState
- Gem::Resolver::Molinillo::Resolver
- Gem::Resolver::Molinillo::Resolver::Resolution
- Gem::Resolver::Molinillo::ResolverError
- Gem::Resolver::Molinillo::SpecificationProvider
- Gem::Resolver::Molinillo::UI
- Gem::Resolver::Molinillo::VersionConflict
- Gem::Resolver::RequirementList
- Gem::Resolver::Set
- Gem::Resolver::SourceSet
- Gem::Resolver::SpecSpecification
- Gem::Resolver::Specification
- Gem::Resolver::Stats
- Gem::Resolver::VendorSet
- Gem::Resolver::VendorSpecification
- Gem::RubyVersionMismatch
- Gem::RuntimeRequirementNotMetError
- Gem::S3URISigner
- Gem::S3URISigner::ConfigurationError
- Gem::S3URISigner::InstanceProfileError
- Gem::SafeYAML
- Gem::Security
- Gem::Security::Exception
- Gem::Security::Policy
- Gem::Security::Signer
- Gem::Security::TrustDir
- Gem::SecurityOption
- Gem::Server
- Gem::SilentUI
- Gem::Source
- Gem::Source::Git
- Gem::Source::Installed
- Gem::Source::Local
- Gem::Source::Lock
- Gem::Source::SpecificFile
- Gem::Source::Vendor
- Gem::SourceFetchProblem
- Gem::SourceList
- Gem::SpecFetcher
- Gem::SpecificGemNotFoundException
- Gem::Specification
- Gem::SpecificationPolicy
- Gem::StreamUI
- Gem::StreamUI::SilentDownloadReporter
- Gem::StreamUI::SilentProgressReporter
- Gem::StreamUI::SimpleProgressReporter
- Gem::StreamUI::ThreadedDownloadReporter
- Gem::StreamUI::VerboseProgressReporter
- Gem::StubSpecification
- Gem::SystemExitException
- Gem::TestCase
- Gem::TestCase::SpecFetcherSetup
- Gem::TestCase::StaticSet
- Gem::Text
- Gem::UninstallError
- Gem::Uninstaller
- Gem::UnsatisfiableDependencyError
- Gem::UriFormatter
- Gem::UriParser
- Gem::UriParsing
- Gem::UserInteraction
- Gem::Util
- Gem::Validator
- Gem::VerificationError
- Gem::Version
- Gem::VersionOption
- Kernel
- Object
- TempIO
- YAML::Syck
- YAML::Syck

No matching classes.

# Gem::Package::TarWriter

Allows writing of tar files

### Public Class Methods

new(io) click to toggle source

Creates a new `TarWriter`, yielding it if a block is given

                   # File rubygems/package/tar_writer.rb, line 79
    def self.new(io)
      writer = super

      return writer unless block_given?

      begin
        yield writer
      ensure
        writer.close
      end

      nil
    end

new(io) click to toggle source

Creates a new `TarWriter` that will write to `io`

                   # File rubygems/package/tar_writer.rb, line 96
    def initialize(io)
      @io = io
      @closed = false
    end

### Public Instance Methods

add_file(name, mode) click to toggle source

Adds file `name` with permissions `mode`, and yields an IO for writing the file to

                   # File rubygems/package/tar_writer.rb, line 105
    def add_file(name, mode) # :yields: io
      check_closed

      name, prefix = split_name name

      init_pos = @io.pos
      @io.write Gem::Package::TarHeader::EMPTY_HEADER # placeholder for the header

      yield RestrictedStream.new(@io) if block_given?

      size = @io.pos - init_pos - 512

      remainder = (512 - (size % 512)) % 512
      @io.write "\0" * remainder

      final_pos = @io.pos
      @io.pos = init_pos

      header = Gem::Package::TarHeader.new :name => name, :mode => mode,
                                           :size => size, :prefix => prefix,
                                           :mtime => Gem.source_date_epoch

      @io.write header
      @io.pos = final_pos

      self
    end

add_file_digest(name, mode, digest_algorithms) click to toggle source

Adds `name` with permissions `mode` to the tar, yielding `io` for writing the file. The `digest_algorithm` is written to a read-only `name`.sum file following the given file contents containing the digest name and hexdigest separated by a tab.

The created digest object is returned.

                   # File rubygems/package/tar_writer.rb, line 141
    def add_file_digest(name, mode, digest_algorithms) # :yields: io
      digests = digest_algorithms.map do |digest_algorithm|
        digest = digest_algorithm.new
        digest_name =
          if digest.respond_to? :name
            digest.name
          else
            /::([^:]+)$/ =~ digest_algorithm.name
            $1
          end

        [digest_name, digest]
      end

      digests = Hash[*digests.flatten]

      add_file name, mode do |io|
        Gem::Package::DigestIO.wrap io, digests do |digest_io|
          yield digest_io
        end
      end

      digests
    end

add_file_signed(name, mode, signer) click to toggle source

Adds `name` with permissions `mode` to the tar, yielding `io` for writing the file. The `signer` is used to add a digest file using its digest_algorithm per `add_file_digest` and a cryptographic signature in `name`.sig. If the signer has no key only the checksum file is added.

Returns the digest.

                   # File rubygems/package/tar_writer.rb, line 174
    def add_file_signed(name, mode, signer)
      digest_algorithms = [
        signer.digest_algorithm,
        Digest::SHA512,
      ].compact.uniq

      digests = add_file_digest name, mode, digest_algorithms do |io|
        yield io
      end

      signature_digest = digests.values.compact.find do |digest|
        digest_name =
          if digest.respond_to? :name
            digest.name
          else
            digest.class.name[/::([^:]+)\z/, 1]
          end

        digest_name == signer.digest_name
      end

      raise "no #{signer.digest_name} in #{digests.values.compact}" unless signature_digest

      if signer.key
        signature = signer.sign signature_digest.digest

        add_file_simple "#{name}.sig", 0444, signature.length do |io|
          io.write signature
        end
      end

      digests
    end

add_file_simple(name, mode, size) click to toggle source

Add file `name` with permissions `mode` `size` bytes long. Yields an IO to write the file to.

                   # File rubygems/package/tar_writer.rb, line 212
    def add_file_simple(name, mode, size) # :yields: io
      check_closed

      name, prefix = split_name name

      header = Gem::Package::TarHeader.new(:name => name, :mode => mode,
                                           :size => size, :prefix => prefix,
                                           :mtime => Gem.source_date_epoch).to_s

      @io.write header
      os = BoundedStream.new @io, size

      yield os if block_given?

      min_padding = size - os.written
      @io.write("\0" * min_padding)

      remainder = (512 - (size % 512)) % 512
      @io.write("\0" * remainder)

      self
    end

add_symlink(name, target, mode) click to toggle source

Adds symlink `name` with permissions `mode`, linking to `target`.

                   # File rubygems/package/tar_writer.rb, line 238
    def add_symlink(name, target, mode)
      check_closed

      name, prefix = split_name name

      header = Gem::Package::TarHeader.new(:name => name, :mode => mode,
                                           :size => 0, :typeflag => "2",
                                           :linkname => target,
                                           :prefix => prefix,
                                           :mtime => Gem.source_date_epoch).to_s

      @io.write header

      self
    end

check_closed() click to toggle source

Raises IOError if the `TarWriter` is closed

                   # File rubygems/package/tar_writer.rb, line 257
    def check_closed
      raise IOError, "closed #{self.class}" if closed?
    end

close() click to toggle source

Closes the `TarWriter`

                   # File rubygems/package/tar_writer.rb, line 264
    def close
      check_closed

      @io.write "\0" * 1024
      flush

      @closed = true
    end

closed?() click to toggle source

Is the `TarWriter` closed?

                   # File rubygems/package/tar_writer.rb, line 276
    def closed?
      @closed
    end

flush() click to toggle source

Flushes the TarWriter's IO

                   # File rubygems/package/tar_writer.rb, line 283
    def flush
      check_closed

      @io.flush if @io.respond_to? :flush
    end

mkdir(name, mode) click to toggle source

Creates a new directory in the tar file `name` with `mode`

                   # File rubygems/package/tar_writer.rb, line 292
    def mkdir(name, mode)
      check_closed

      name, prefix = split_name(name)

      header = Gem::Package::TarHeader.new :name => name, :mode => mode,
                                           :typeflag => "5", :size => 0,
                                           :prefix => prefix,
                                           :mtime => Gem.source_date_epoch

      @io.write header

      self
    end