Gem::Package::DigestIO

Class

IO wrapper that creates digests of contents written to the IO it wraps.

Attributes

digests

Read

Collected digests for wrapped writes.

{
  'SHA1'   => #<OpenSSL::Digest: [...]>,
  'SHA512' => #<OpenSSL::Digest: [...]>,
}

Class Methods

new(io, digests)

lib/rubygems/package/digest_io.rb View on GitHub

          
            # File tmp/rubies/ruby-3.1.3/lib/rubygems/package/digest_io.rb, line 45
def initialize(io, digests)
  @io = io
  @digests = digests
end

Creates a new DigestIO instance. Using ::wrap is recommended, see the ::wrap documentation for documentation of io and digests.

wrap(io, digests) { |digest_io| ... }

lib/rubygems/package/digest_io.rb View on GitHub

          
            # File tmp/rubies/ruby-3.1.3/lib/rubygems/package/digest_io.rb, line 33
def self.wrap(io, digests)
  digest_io = new io, digests

  yield digest_io

  return digests
end

Wraps io and updates digest for each of the digest algorithms in the digests Hash. Returns the digests hash. Example:

io = StringIO.new
digests = {
  'SHA1'   => OpenSSL::Digest.new('SHA1'),
  'SHA512' => OpenSSL::Digest.new('SHA512'),
}

Gem::Package::DigestIO.wrap io, digests do |digest_io|
  digest_io.write "hello"
end

digests['SHA1'].hexdigest   #=> "aaf4c61d[...]"
digests['SHA512'].hexdigest #=> "9b71d224[...]"

Instance Methods

write(data)

lib/rubygems/package/digest_io.rb View on GitHub

          
            # File tmp/rubies/ruby-3.1.3/lib/rubygems/package/digest_io.rb, line 53
def write(data)
  result = @io.write data

  @digests.each do |_, digest|
    digest << data
  end

  result
end

Writes data to the underlying IO and updates the digests