Add rubyzip 3.2 type signature (#1022)

* init `rubyzip` version `3.2`

* add boilerplate types for `Zip::File` and `Zip::Entry`

from the `rambling-trie` gem:
https://github.com/gonzedge/rambling-trie/tree/bc3cb892096887bdd2e50594143047a77cfa5b6e/sig/lib/zip

* first pass at generating all .rbs files

* first pass at test_example, based off of 2.3

* add `zlib` dependency

* remove `DelegateClass(Entry)`, use `< Entry` to get around it

unfortunately, `DelegateClass[Entry]` does not work yet per upstream rbs

there are Github issues requesting that feature since Nov 2021,
last one mentioning it is ruby/rbs#2061

* add `singleton` to deps

* use `extend` for `FileSplit`, not `include`

and fix tests corresponding tests to use correct params!

* fix `(T | void)` to `T?`

* rubocop -A

Author: gonzedge

gems/rubyzip/.rubocop.yml

@@ -1,8 +1,19 @@
+# This configuration inherits from /.rubocop.yml.
+# You can configure RBS style of this gem.
+# This file is used on CI. It is configured to automatically
+# make rubocop suggestions on pull requests for this gem.
+# If you do not like the style enforcement, you should remove this file.
 inherit_from: ../../.rubocop.yml
 
+##
+# If you want to customize the style, please consult with the gem reviewers.
+# You can see the list of cops at https://github.com/ksss/rubocop-on-rbs/blob/main/docs/modules/ROOT/pages/cops.adoc
+
 RBS/Layout:
   Enabled: true
+
 RBS/Lint:
   Enabled: true
+
 RBS/Style:
   Enabled: true

gems/rubyzip/3.2/_test/metadata.yaml

@@ -0,0 +1,4 @@
+# If the test needs gem's RBS files, declare them here.
+#
+# additional_gems:
+#   - GEM_NAME

gems/rubyzip/3.2/_test/test.rb

@@ -0,0 +1,4 @@
+# Write Ruby code to test the RBS.
+# It is type checked by `steep check` command.
+
+require "rubyzip"

gems/rubyzip/3.2/_test/test_example.rb

@@ -0,0 +1,67 @@
+# Taken from https://github.com/rubyzip/rubyzip/blob/v3.2.0/samples/example.rb
+
+require 'zip'
+
+####### Using ZipInputStream alone: #######
+
+Zip::InputStream.open('example.zip') do |zis|
+  entry = zis.get_next_entry
+  print "First line of '#{entry&.name} (#{entry&.size} bytes):  "
+  puts "'#{zis.gets&.chomp}'"
+  entry = zis.get_next_entry
+  print "First line of '#{entry&.name} (#{entry&.size} bytes):  "
+  puts "'#{zis.gets&.chomp}'"
+end
+
+####### Using ZipFile to read the directory of a zip file: #######
+
+zf = Zip::File.new('example.zip')
+zf.each_with_index do |entry, index|
+  puts "entry #{index} is #{entry.name}, size = #{entry.size}, compressed size = #{entry.compressed_size}"
+  # use zf.get_input_stream(entry) to get a ZipInputStream for the entry
+  # entry can be the ZipEntry object or any object which has a to_s method that
+  # returns the name of the entry.
+end
+
+####### Using ZipOutputStream to write a zip file: #######
+
+Zip::OutputStream.open('exampleout.zip') do |zos|
+  zos.put_next_entry('the first little entry')
+  zos.puts 'Hello hello hello hello hello hello hello hello hello'
+
+  zos.put_next_entry('the second little entry')
+  zos.puts 'Hello again'
+
+  # Use rubyzip or your zip client of choice to verify
+  # the contents of exampleout.zip
+end
+
+####### Using ZipFile to change a zip file: #######
+
+Zip::File.open('exampleout.zip') do |zip_file|
+  zip_file.add('thisFile.rb', 'example.rb')
+  zip_file.rename('thisFile.rb', 'ILikeThisName.rb')
+  zip_file.add('Again', 'example.rb')
+end
+
+# Lets check
+Zip::File.open('exampleout.zip') do |zip_file|
+  puts "Changed zip file contains: #{zip_file.entries.join(', ')}"
+  zip_file.remove('Again')
+  puts "Without 'Again': #{zip_file.entries.join(', ')}"
+end
+
+####### Using ZipFile to split a zip file: #######
+
+# Creating large zip file for splitting
+Zip::OutputStream.open('large_zip_file.zip') do |zos|
+  puts 'Creating zip file...'
+  10.times do |i|
+    zos.put_next_entry("large_entry_#{i}.txt")
+    zos.puts 'Hello' * 104_857_600
+  end
+end
+
+# Splitting created large zip file
+part_zips_count = Zip::File.split('large_zip_file.zip', segment_size: 2_097_152, delete_original: false, partial_zip_file_name: 'part_zip_file')
+puts "Zip file splitted in #{part_zips_count} parts"

gems/rubyzip/3.2/manifest.yaml

@@ -0,0 +1,8 @@
+# manifest.yaml describes dependencies which do not appear in the gemspec.
+# If this gem includes such dependencies, comment-out the following lines and
+# declare the dependencies.
+# If all dependencies appear in the gemspec, you should remove this file.
+#
+ dependencies:
+   - name: singleton
+   - name: zlib

gems/rubyzip/3.2/rubyzip.rbs

@@ -0,0 +1,38 @@
+module Zip
+  DEFAULT_RESTORE_OPTIONS: { restore_ownership: bool, restore_permissions: bool, restore_times: bool }
+  ZLIB_FLUSHING_STRATEGY: Integer
+
+  def self.unicode_names: () -> bool
+  def self.unicode_names=: (bool) -> bool
+
+  def self.on_exists_proc: () -> bool
+  def self.on_exists_proc=: (bool) -> bool
+
+  def self.continue_on_exists_proc: () -> bool
+  def self.continue_on_exists_proc=: (bool) -> bool
+
+  def self.sort_entries: () -> bool
+  def self.sort_entries=: (bool) -> bool
+
+  def self.default_compression: () -> Integer
+  def self.default_compression=: (Integer) -> Integer
+
+  def self.write_zip64_support: () -> bool
+  def self.write_zip64_support=: (bool) -> bool
+
+  def self.warn_invalid_date: () -> bool
+  def self.warn_invalid_date=: (bool) -> bool
+
+  def self.case_insensitive_match: () -> bool
+  def self.case_insensitive_match=: (bool) -> bool
+
+  def self.force_entry_names_encoding: () -> String?
+  def self.force_entry_names_encoding=: (String?) -> String?
+
+  def self.validate_entry_sizes: () -> bool
+  def self.validate_entry_sizes=: (bool) -> bool
+
+  def self.setup: () { (Zip) -> void } -> void
+
+  def self.reset!: () -> void
+end

gems/rubyzip/3.2/zip/central_directory.rbs

@@ -0,0 +1,42 @@
+module Zip
+  class CentralDirectory
+    include Dirtyable
+
+    END_OF_CD_SIG: Integer
+    ZIP64_END_OF_CD_SIG: Integer
+    ZIP64_EOCD_LOCATOR_SIG: Integer
+    STATIC_EOCD_SIZE: Integer
+    ZIP64_STATIC_EOCD_SIZE: Integer
+    ZIP64_EOCD_LOC_SIZE: Integer
+    MAX_FILE_COMMENT_SIZE: Integer
+    MAX_END_OF_CD_SIZE: Integer
+
+    attr_accessor comment: String
+
+    def initialize: (?EntrySet entries, ?String comment) -> void
+
+    def <<: (Entry entry) -> void
+
+    def delete: (Entry | String entry) -> Entry?
+
+    def each: () { (Entry) -> void } -> void
+
+    def entries: () -> Array[Entry]
+
+    def find_entry: (String | Entry entry_name) -> Entry?
+
+    def glob: (String pattern, ?Integer flags) ?{ (Entry) -> void } -> Array[Entry]
+
+    def include?: (Entry | String entry) -> bool
+
+    def size: () -> Integer
+
+    def read_from_stream: (IO io) -> void
+
+    def write_to_stream: (IO io, ?suppress_extra_fields: bool) -> void
+
+    def count_entries: (IO io) -> Integer
+
+    def ==: (untyped other) -> bool
+  end
+end

gems/rubyzip/3.2/zip/compressor.rbs

@@ -0,0 +1,5 @@
+module Zip
+  class Compressor
+    def finish: () -> void
+  end
+end

gems/rubyzip/3.2/zip/constants.rbs

@@ -0,0 +1,47 @@
+module Zip
+  WINDOWS: bool
+
+  CENTRAL_DIRECTORY_ENTRY_SIGNATURE: Integer
+  CDIR_ENTRY_STATIC_HEADER_LENGTH: Integer
+  LOCAL_ENTRY_SIGNATURE: Integer
+  LOCAL_ENTRY_STATIC_HEADER_LENGTH: Integer
+  LOCAL_ENTRY_TRAILING_DESCRIPTOR_SIZE: Integer
+  SPLIT_FILE_SIGNATURE: Integer
+
+  VERSION_MADE_BY: Integer
+  VERSION_NEEDED_TO_EXTRACT: Integer
+  VERSION_NEEDED_TO_EXTRACT_ZIP64: Integer
+
+  FILE_TYPE_FILE: Integer
+  FILE_TYPE_DIR: Integer
+  FILE_TYPE_SYMLINK: Integer
+
+  FSTYPE_FAT: Integer
+  FSTYPE_AMIGA: Integer
+  FSTYPE_VMS: Integer
+  FSTYPE_UNIX: Integer
+  FSTYPE_VM_CMS: Integer
+  FSTYPE_ATARI: Integer
+  FSTYPE_HPFS: Integer
+  FSTYPE_MAC: Integer
+  FSTYPE_Z_SYSTEM: Integer
+  FSTYPE_CPM: Integer
+  FSTYPE_TOPS20: Integer
+  FSTYPE_NTFS: Integer
+  FSTYPE_QDOS: Integer
+  FSTYPE_ACORN: Integer
+  FSTYPE_VFAT: Integer
+  FSTYPE_MVS: Integer
+  FSTYPE_BEOS: Integer
+  FSTYPE_TANDEM: Integer
+  FSTYPE_THEOS: Integer
+  FSTYPE_MAC_OSX: Integer
+  FSTYPE_ATHEOS: Integer
+
+  FSTYPES: Hash[Integer, String]
+
+  COMPRESSION_METHOD_STORE: Integer
+  COMPRESSION_METHOD_DEFLATE: Integer
+
+  COMPRESSION_METHODS: Hash[Integer, String]
+end

gems/rubyzip/3.2/zip/crypto/aes_encryption.rbs

@@ -0,0 +1,30 @@
+module Zip
+  module AESEncryption
+    VERIFIER_LENGTH: Integer
+    BLOCK_SIZE: Integer
+    AUTHENTICATION_CODE_LENGTH: Integer
+    VERSION_AE_1: Integer
+    VERSION_AE_2: Integer
+    VERSIONS: Array[Integer]
+    STRENGTHS: Array[Integer]
+    BITS: Hash[Integer, Integer]
+    KEY_LENGTHS: Hash[Integer, Integer]
+    SALT_LENGTHS: Hash[Integer, Integer]
+
+    def initialize: (String password, Integer strength) -> void
+
+    def header_bytesize: () -> Integer
+
+    def gp_flags: () -> Integer
+  end
+
+  class AESDecrypter < Decrypter
+    include AESEncryption
+
+    def decrypt: (String encrypted_data) -> String
+
+    def reset!: (String header) -> void
+
+    def check_integrity!: (IO io) -> void
+  end
+end