rubyzip 3.2: Add type sig for block-form/generic overrides and fix sig top-level config (#1023)

* add tests for missing block-form return types

* add generic overrides for `Zip::File.open` and `Zip::File.open_buffer`

* add block-form/generic method overrides for `Zip::FileSystem::(Dir|File|ZipFileNameMapper)`

* add block-form/generic method overrides for `Zip::(Input|Output)Stream`

* add block-form/generic method overrides for `Zip::Streamable` methods

* add non-block/generic method overrides for `Zip::Entry`

* More tests

* more tests

* Fix top level `::Zip` module config methods

* more tests

* Use new `next_entry` var for `get_next_entry` in tests so it does not cause type issues with the var `entry` resulting from `get_entry`

* rubocop -A

Author: gonzedge

gems/rubyzip/3.2/_test/test_example.rb

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

gems/rubyzip/3.2/rubyzip.rbs

@@ -78,7 +78,8 @@ module Zip
 
     def extract: (?String entry_path, ?destination_directory: String) ?{ (Entry, String) -> boolish } -> self
 
-    def get_input_stream: () ?{ (IO) -> void } -> IO
+    def get_input_stream: [TContent] () { (IO) -> TContent } -> TContent
+                        | () -> IO
 
     def write_to_zip_output_stream: (OutputStream zip_output_stream) -> void
 

gems/rubyzip/3.2/zip.rbs

@@ -17,25 +17,43 @@ module Zip
     def glob: (String pattern, ?Integer flags) ?{ (Entry) -> void } -> Array[Entry]
     def size: () -> Integer
 
-    def self.open: (
+    def self.open: [TContent] (
       String file_name,
       ?create: bool,
       ?restore_ownership: bool,
       ?restore_permissions: bool,
       ?restore_times: bool,
       ?compression_level: Integer,
       ?suppress_extra_fields: bool
-    ) ?{ (File) -> void } -> File?
+    ) { (File) -> TContent } -> TContent
+                 | (
+      String file_name,
+      ?create: bool,
+      ?restore_ownership: bool,
+      ?restore_permissions: bool,
+      ?restore_times: bool,
+      ?compression_level: Integer,
+      ?suppress_extra_fields: bool
+    ) -> File
 
-    def self.open_buffer: (
-      ?IO io,
+    def self.open_buffer: [TContent] (
+      ?IO | String io,
       ?create: bool,
       ?restore_ownership: bool,
       ?restore_permissions: bool,
       ?restore_times: bool,
       ?compression_level: Integer,
       ?suppress_extra_fields: bool
-    ) ?{ (File) -> void } -> File?
+    ) { (File) -> TContent } -> TContent
+                        | (
+      ?IO | String io,
+      ?create: bool,
+      ?restore_ownership: bool,
+      ?restore_permissions: bool,
+      ?restore_times: bool,
+      ?compression_level: Integer,
+      ?suppress_extra_fields: bool
+    ) -> File
 
     def self.foreach: (String zip_file_name) { (Entry) -> void } -> void
 
@@ -52,9 +70,22 @@ module Zip
       ?suppress_extra_fields: bool
     ) -> void
 
-    def get_input_stream: (String | Entry entry) ?{ (IO) -> void } -> IO
+    def get_input_stream: [TContent] (String | Entry entry) { (IO) -> TContent } -> TContent
+                        | (String | Entry entry) -> IO
 
-    def get_output_stream: (
+    def get_output_stream: [TContent] (
+      String | Entry entry,
+      ?permissions: Integer?,
+      ?comment: String?,
+      ?extra: ExtraField?,
+      ?compressed_size: Integer?,
+      ?crc: Integer?,
+      ?compression_method: Integer?,
+      ?compression_level: Integer?,
+      ?size: Integer?,
+      ?time: Time?
+    ) { (IO) -> TContent } -> TContent
+                         | (
       String | Entry entry,
       ?permissions: Integer?,
       ?comment: String?,
@@ -65,7 +96,7 @@ module Zip
       ?compression_level: Integer?,
       ?size: Integer?,
       ?time: Time?
-    ) ?{ (IO) -> void } -> IO
+    ) -> IO
 
     def read: (String | Entry entry) -> String
 

gems/rubyzip/3.2/zip/entry.rbs

@@ -7,12 +7,13 @@ module Zip
 
       def new: (String directory_name) -> DirectoryIterator
 
-      def open: (String directory_name) ?{ (DirectoryIterator) -> void } -> DirectoryIterator?
+      def open: (String directory_name) { (DirectoryIterator) -> void } -> nil
+              | (String directory_name) -> DirectoryIterator
 
       def pwd: () -> String
       alias getwd pwd
 
-      def chdir: (String directory_name) ?{ () -> void } -> void
+      def chdir: (String directory_name) -> void
 
       def entries: (String directory_name) -> Array[String]
 

gems/rubyzip/3.2/zip/file.rbs

@@ -25,7 +25,8 @@ module Zip
       def size?: (String filename) -> Integer?
       def zero?: (String filename) -> bool
 
-      def open: (String filename, ?String mode, ?Integer permissions) ?{ (IO) -> void } -> IO?
+      def open: [TContent] (String filename, ?String mode, ?Integer permissions) { (IO) -> TContent } -> TContent
+              | (String filename, ?String mode, ?Integer permissions) -> IO
 
       def read: (String filename) -> String
 

gems/rubyzip/3.2/zip/filesystem/dir.rbs

@@ -11,9 +11,11 @@ module Zip
 
       def get_entry: (String filename) -> Entry
 
-      def get_input_stream: (String filename) ?{ (IO) -> void } -> IO?
+      def get_input_stream: [TContent] (String filename) { (IO) -> TContent } -> TContent
+                          | (String filename) -> IO
 
-      def get_output_stream: (String filename, ?Integer? permissions) ?{ (IO) -> void } -> IO?
+      def get_output_stream: [TContent] (String filename, ?Integer? permissions) { (IO) -> TContent } -> TContent
+                           | (String filename, ?Integer? permissions) -> IO
 
       def glob: (String pattern, *untyped flags) ?{ (String) -> void } -> Array[String]
 

gems/rubyzip/3.2/zip/filesystem/file.rbs

@@ -4,7 +4,8 @@ module Zip
 
     CHUNK_SIZE: Integer
 
-    def self.open: (String | IO filename_or_io, ?offset: Integer, ?decrypter: Decrypter?) ?{ (InputStream) -> void } -> InputStream?
+    def self.open: [TContent] (String | IO filename_or_io, ?offset: Integer, ?decrypter: Decrypter?) { (InputStream) -> TContent } -> TContent
+                 | (String | IO filename_or_io, ?offset: Integer, ?decrypter: Decrypter?) -> InputStream
 
     def initialize: (String | IO context, ?offset: Integer, ?decrypter: Decrypter?) -> void
 

gems/rubyzip/3.2/zip/filesystem/zip_file_name_mapper.rbs

@@ -2,7 +2,8 @@ module Zip
   class OutputStream
     include IOExtras::AbstractOutputStream
 
-    def self.open: (String file_name, ?encrypter: Encrypter?, ?suppress_extra_fields: bool) ?{ (OutputStream) -> void } -> OutputStream?
+    def self.open: [TContent] (String file_name, ?encrypter: Encrypter?, ?suppress_extra_fields: bool) { (OutputStream) -> TContent } -> TContent
+                 | (String file_name, ?encrypter: Encrypter?, ?suppress_extra_fields: bool) -> OutputStream
 
     def self.write_buffer: (?IO io, ?encrypter: Encrypter?, ?suppress_extra_fields: bool) { (OutputStream) -> void } -> IO