rubyzip 1.0.0 → 2.4.1

data/samples/example_recursive.rb

@@ -1,4 +1,4 @@
-require 'zip/zip'
+require 'zip'
 
 # This is a simple example which uses rubyzip to
 # recursively generate a zip file from the contents of
@@ -6,44 +6,49 @@ require 'zip/zip'
 # included in the archive, rather just its contents.
 #
 # Usage:
-#   directoryToZip = "/tmp/input"
-#   outputFile = "/tmp/out.zip"   
-#   zf = ZipFileGenerator.new(directoryToZip, outputFile)
+#   directory_to_zip = "/tmp/input"
+#   output_file = "/tmp/out.zip"
+#   zf = ZipFileGenerator.new(directory_to_zip, output_file)
 #   zf.write()
 class ZipFileGenerator
-
   # Initialize with the directory to zip and the location of the output archive.
-  def initialize(inputDir, outputFile)
-    @inputDir = inputDir
-    @outputFile = outputFile
+  def initialize(input_dir, output_file)
+    @input_dir = input_dir
+    @output_file = output_file
   end
 
   # Zip the input directory.
-  def write()
-    entries = Dir.entries(@inputDir); entries.delete("."); entries.delete("..") 
-    io = Zip::File.open(@outputFile, Zip::File::CREATE);
+  def write
+    entries = Dir.entries(@input_dir) - %w[. ..]
 
-    writeEntries(entries, "", io)
-    io.close();
+    ::Zip::File.open(@output_file, ::Zip::File::CREATE) do |zipfile|
+      write_entries entries, '', zipfile
+    end
   end
 
-  # A helper method to make the recursion work.
   private
-  def writeEntries(entries, path, io)
-    
-    entries.each { |e|
-      zipFilePath = path == "" ? e : File.join(path, e)
-      diskFilePath = File.join(@inputDir, zipFilePath)
-      puts "Deflating " + diskFilePath
-      if  File.directory?(diskFilePath)
-        io.mkdir(zipFilePath)
-        subdir =Dir.entries(diskFilePath); subdir.delete("."); subdir.delete("..") 
-        writeEntries(subdir, zipFilePath, io)
+
+  # A helper method to make the recursion work.
+  def write_entries(entries, path, zipfile)
+    entries.each do |e|
+      zipfile_path = path == '' ? e : File.join(path, e)
+      disk_file_path = File.join(@input_dir, zipfile_path)
+
+      if File.directory? disk_file_path
+        recursively_deflate_directory(disk_file_path, zipfile, zipfile_path)
       else
-        io.get_output_stream(zipFilePath) { |f| f.puts(File.open(diskFilePath, "rb").read())}
+        put_into_archive(disk_file_path, zipfile, zipfile_path)
       end
-    }
+    end
+  end
+
+  def recursively_deflate_directory(disk_file_path, zipfile, zipfile_path)
+    zipfile.mkdir zipfile_path
+    subdir = Dir.entries(disk_file_path) - %w[. ..]
+    write_entries subdir, zipfile_path, zipfile
   end
-    
-end
 
+  def put_into_archive(disk_file_path, zipfile, zipfile_path)
+    zipfile.add(zipfile_path, disk_file_path)
+  end
+end

data/samples/gtk_ruby_zip.rb

@@ -0,0 +1,84 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << '../lib'
+
+$VERBOSE = true
+
+require 'gtk'
+require 'zip'
+
+class MainApp < Gtk::Window
+  def initialize
+    super()
+    set_usize(400, 256)
+    set_title('rubyzip')
+    signal_connect(Gtk::Window::SIGNAL_DESTROY) { Gtk.main_quit }
+
+    box = Gtk::VBox.new(false, 0)
+    add(box)
+
+    @zipfile = nil
+    @button_panel = ButtonPanel.new
+    @button_panel.open_button.signal_connect(Gtk::Button::SIGNAL_CLICKED) do
+      show_file_selector
+    end
+    @button_panel.extract_button.signal_connect(Gtk::Button::SIGNAL_CLICKED) do
+      puts 'Not implemented!'
+    end
+    box.pack_start(@button_panel, false, false, 0)
+
+    sw = Gtk::ScrolledWindow.new
+    sw.set_policy(Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC)
+    box.pack_start(sw, true, true, 0)
+
+    @clist = Gtk::CList.new(%w[Name Size Compression])
+    @clist.set_selection_mode(Gtk::SELECTION_BROWSE)
+    @clist.set_column_width(0, 120)
+    @clist.set_column_width(1, 120)
+    @clist.signal_connect(Gtk::CList::SIGNAL_SELECT_ROW) do |_w, row, _column, _event|
+      @selected_row = row
+    end
+    sw.add(@clist)
+  end
+
+  class ButtonPanel < Gtk::HButtonBox
+    attr_reader :open_button, :extract_button
+    def initialize
+      super
+      set_layout(Gtk::BUTTONBOX_START)
+      set_spacing(0)
+      @open_button = Gtk::Button.new('Open archive')
+      @extract_button = Gtk::Button.new('Extract entry')
+      pack_start(@open_button)
+      pack_start(@extract_button)
+    end
+  end
+
+  def show_file_selector
+    @file_selector = Gtk::FileSelection.new('Open zip file')
+    @file_selector.show
+    @file_selector.ok_button.signal_connect(Gtk::Button::SIGNAL_CLICKED) do
+      open_zip(@file_selector.filename)
+      @file_selector.destroy
+    end
+    @file_selector.cancel_button.signal_connect(Gtk::Button::SIGNAL_CLICKED) do
+      @file_selector.destroy
+    end
+  end
+
+  def open_zip(filename)
+    @zipfile = Zip::File.open(filename)
+    @clist.clear
+    @zipfile.each do |entry|
+      @clist.append([entry.name,
+                     entry.size.to_s,
+                     (100.0 * entry.compressedSize / entry.size).to_s + '%'])
+    end
+  end
+end
+
+main_app = MainApp.new
+
+main_app.show_all
+
+Gtk.main

data/samples/qtzip.rb

@@ -1,22 +1,18 @@
 #!/usr/bin/env ruby
 
-$VERBOSE=true
+$VERBOSE = true
 
-$: << "../lib"
+$LOAD_PATH << '../lib'
 
 require 'Qt'
 system('rbuic -o zipdialogui.rb zipdialogui.ui')
 require 'zipdialogui.rb'
-require 'zip/zip'
-
-
+require 'zip'
 
 a = Qt::Application.new(ARGV)
 
 class ZipDialog < ZipDialogUI
-
-
-  def initialize()
+  def initialize
     super()
     connect(child('add_button'), SIGNAL('clicked()'),
             self, SLOT('add_files()'))
@@ -24,24 +20,22 @@ class ZipDialog < ZipDialogUI
             self, SLOT('extract_files()'))
   end
 
-  def zipfile(&proc)
-    Zip::File.open(@zip_filename, &proc)
+  def zipfile(&a_proc)
+    Zip::File.open(@zip_filename, &a_proc)
   end
 
-  def each(&proc)
-    Zip::File.foreach(@zip_filename, &proc)
+  def each(&a_proc)
+    Zip::File.foreach(@zip_filename, &a_proc)
   end
-  
-  def refresh()
-    lv = child("entry_list_view")
+
+  def refresh
+    lv = child('entry_list_view')
     lv.clear
-    each { 
-      |e|
+    each do |e|
       lv.insert_item(Qt::ListViewItem.new(lv, e.name, e.size.to_s))
-    }
+    end
   end
 
-    
   def load(zipfile)
     @zip_filename = zipfile
     refresh
@@ -49,13 +43,11 @@ class ZipDialog < ZipDialogUI
 
   def add_files
     l = Qt::FileDialog.getOpenFileNames(nil, nil, self)
-    zipfile { 
-      |zf| 
-      l.each { 
-        |path|
+    zipfile do |zf|
+      l.each do |path|
         zf.add(File.basename(path), path)
-      }
-    }
+      end
+    end
     refresh
   end
 
@@ -63,7 +55,7 @@ class ZipDialog < ZipDialogUI
     selected_items = []
     unselected_items = []
     lv_item = entry_list_view.first_child
-    while (lv_item)
+    while lv_item
       if entry_list_view.is_selected(lv_item)
         selected_items << lv_item.text(0)
       else
@@ -73,23 +65,22 @@ class ZipDialog < ZipDialogUI
     end
     puts "selected_items.size = #{selected_items.size}"
     puts "unselected_items.size = #{unselected_items.size}"
-    items = selected_items.size > 0 ? selected_items : unselected_items
+    items = !selected_items.empty? ? selected_items : unselected_items
     puts "items.size = #{items.size}"
 
     d = Qt::FileDialog.get_existing_directory(nil, self)
-    if (!d)
-      puts "No directory chosen"
+    if !d
+      puts 'No directory chosen'
     else
       zipfile { |zf| items.each { |e| zf.extract(e, File.join(d, e)) } }
     end
-    
   end
 
   slots 'add_files()', 'extract_files()'
 end
 
-if !ARGV[0]
-  puts "usage: #{$0} zipname"
+unless ARGV[0]
+  puts "usage: #{$PROGRAM_NAME} zipname"
   exit
 end
 
@@ -97,5 +88,5 @@ zd = ZipDialog.new
 zd.load(ARGV[0])
 
 a.mainWidget = zd
-zd.show()
-a.exec()
+zd.show
+a.exec

data/samples/write_simple.rb

@@ -1,13 +1,10 @@
-#!/usr/bin/env ruby
-
-$: << "../lib"
-
-require 'zip/zip'
-
-include Zip
-
-OutputStream.open('simple.zip') {
-  |zos|
-  ze = zos.put_next_entry 'entry.txt'
-  zos.puts "Hello world"
-}
+#!/usr/bin/env ruby
+
+$LOAD_PATH << '../lib'
+
+require 'zip'
+
+::Zip::OutputStream.open('simple.zip') do |zos|
+  zos.put_next_entry 'entry.txt'
+  zos.puts 'Hello world'
+end

data/samples/zipfind.rb

@@ -2,72 +2,65 @@
 
 $VERBOSE = true
 
-$: << "../lib"
+$LOAD_PATH << '../lib'
 
-require 'zip/zip'
+require 'zip'
 require 'find'
 
 module Zip
   module ZipFind
-    def self.find(path, zipFilePattern = /\.zip$/i)
-      Find.find(path) {
-	|fileName|
-	yield(fileName)
-	if zipFilePattern.match(fileName)  && File.file?(fileName)
-	  begin
-	    Zip::File.foreach(fileName)  {
-	      |zipEntry|
-	      yield(fileName + File::SEPARATOR + zipEntry.to_s)
-	    }
-	  rescue Errno::EACCES => ex
-	    puts ex
-	  end
-	end
-      }
-    end
+    def self.find(path, zip_file_pattern = /\.zip$/i)
+      Find.find(path) do |filename|
+        yield(filename)
+        next unless zip_file_pattern.match(filename) && File.file?(filename)
 
-    def self.find_file(path, fileNamePattern, zipFilePattern = /\.zip$/i)
-      self.find(path, zipFilePattern) {
-	|fileName|
-	yield(fileName) if fileNamePattern.match(fileName)
-      }
+        begin
+          Zip::File.foreach(filename) do |entry|
+            yield(filename + File::SEPARATOR + entry.to_s)
+          end
+        rescue Errno::EACCES => e
+          puts e
+        end
+      end
     end
 
+    def self.find_file(path, filename_pattern, zip_file_pattern = /\.zip$/i)
+      find(path, zip_file_pattern) do |filename|
+        yield(filename) if filename_pattern.match(filename)
+      end
+    end
   end
 end
 
-if __FILE__ == $0
+if $PROGRAM_NAME == __FILE__
   module ZipFindConsoleRunner
-    
-    PATH_ARG_INDEX = 0;
-    FILENAME_PATTERN_ARG_INDEX = 1;
-    ZIPFILE_PATTERN_ARG_INDEX = 2;
-    
+    PATH_ARG_INDEX = 0
+    FILENAME_PATTERN_ARG_INDEX = 1
+    ZIPFILE_PATTERN_ARG_INDEX = 2
+
     def self.run(args)
       check_args(args)
-      Zip::ZipFind.find_file(args[PATH_ARG_INDEX], 
-			    args[FILENAME_PATTERN_ARG_INDEX],
-			    args[ZIPFILE_PATTERN_ARG_INDEX]) {
-	|fileName|
-	report_entry_found fileName
-      }
+      Zip::ZipFind.find_file(args[PATH_ARG_INDEX],
+                             args[FILENAME_PATTERN_ARG_INDEX],
+                             args[ZIPFILE_PATTERN_ARG_INDEX]) do |filename|
+        report_entry_found filename
+      end
     end
-    
+
     def self.check_args(args)
-      if (args.size != 3)
-	usage
-	exit
-      end
+      return if args.size == 3
+
+      usage
+      exit
     end
 
     def self.usage
-      puts "Usage: #{$0} PATH ZIPFILENAME_PATTERN FILNAME_PATTERN"
+      puts "Usage: #{$PROGRAM_NAME} PATH ZIPFILENAME_PATTERN FILNAME_PATTERN"
     end
-    
-    def self.report_entry_found(fileName)
-      puts fileName
+
+    def self.report_entry_found(filename)
+      puts filename
     end
-    
   end
 
   ZipFindConsoleRunner.run(ARGV)

metadata

@@ -1,50 +1,120 @@
 --- !ruby/object:Gem::Specification
 name: rubyzip
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.4.1
 platform: ruby
 authors:
+- Robert Haines
+- John Lees-Miller
 - Alexander Simonov
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-08-29 00:00:00.000000000 Z
-dependencies: []
-description: 
+date: 2025-01-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
+- !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.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.79'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.79'
+description:
 email:
+- hainesr@gmail.com
+- jdleesmiller@gmail.com
 - alex@simonov.me
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- samples/example.rb
-- samples/example_filesystem.rb
-- samples/example_recursive.rb
-- samples/gtkRubyzip.rb
-- samples/qtzip.rb
-- samples/write_simple.rb
-- samples/zipfind.rb
+- README.md
+- Rakefile
+- TODO
+- lib/zip.rb
 - lib/zip/central_directory.rb
 - lib/zip/compressor.rb
 - lib/zip/constants.rb
+- lib/zip/crypto/decrypted_io.rb
+- lib/zip/crypto/encryption.rb
+- lib/zip/crypto/null_encryption.rb
+- lib/zip/crypto/traditional_encryption.rb
 - lib/zip/decompressor.rb
 - lib/zip/deflater.rb
 - lib/zip/dos_time.rb
 - lib/zip/entry.rb
 - lib/zip/entry_set.rb
 - lib/zip/errors.rb
+- lib/zip/extra_field.rb
 - lib/zip/extra_field/generic.rb
+- lib/zip/extra_field/ntfs.rb
+- lib/zip/extra_field/old_unix.rb
 - lib/zip/extra_field/universal_time.rb
 - lib/zip/extra_field/unix.rb
 - lib/zip/extra_field/zip64.rb
-- lib/zip/extra_field.rb
+- lib/zip/extra_field/zip64_placeholder.rb
 - lib/zip/file.rb
 - lib/zip/filesystem.rb
 - lib/zip/inflater.rb
 - lib/zip/input_stream.rb
+- lib/zip/ioextras.rb
 - lib/zip/ioextras/abstract_input_stream.rb
 - lib/zip/ioextras/abstract_output_stream.rb
-- lib/zip/ioextras.rb
 - lib/zip/null_compressor.rb
 - lib/zip/null_decompressor.rb
 - lib/zip/null_input_stream.rb
@@ -54,32 +124,63 @@ files:
 - lib/zip/streamable_directory.rb
 - lib/zip/streamable_stream.rb
 - lib/zip/version.rb
-- lib/zip.rb
-- README.md
-- NEWS
-- TODO
-- Rakefile
+- samples/example.rb
+- samples/example_filesystem.rb
+- samples/example_recursive.rb
+- samples/gtk_ruby_zip.rb
+- samples/qtzip.rb
+- samples/write_simple.rb
+- samples/zipfind.rb
 homepage: http://github.com/rubyzip/rubyzip
-licenses: []
-metadata: {}
-post_install_message: 
+licenses:
+- BSD 2-Clause
+metadata:
+  bug_tracker_uri: https://github.com/rubyzip/rubyzip/issues
+  changelog_uri: https://github.com/rubyzip/rubyzip/blob/v2.4.1/Changelog.md
+  documentation_uri: https://www.rubydoc.info/gems/rubyzip/2.4.1
+  source_code_uri: https://github.com/rubyzip/rubyzip/tree/v2.4.1
+  wiki_uri: https://github.com/rubyzip/rubyzip/wiki
+  rubygems_mfa_required: 'true'
+post_install_message: |
+  RubyZip 3.0 is coming!
+  **********************
+
+  The public API of some Rubyzip classes has been modernized to use named
+  parameters for optional arguments. Please check your usage of the
+  following classes:
+    * `Zip::File`
+    * `Zip::Entry`
+    * `Zip::InputStream`
+    * `Zip::OutputStream`
+    * `Zip::DOSTime`
+
+  Run your test suite with the `RUBYZIP_V3_API_WARN` environment
+  variable set to see warnings about usage of the old API. This will
+  help you to identify any changes that you need to make to your code.
+  See https://github.com/rubyzip/rubyzip/wiki/Updating-to-version-3.x for
+  more information.
+
+  Please ensure that your Gemfiles and .gemspecs are suitably restrictive
+  to avoid an unexpected breakage when 3.0 is released (e.g. ~> 2.3.0).
+  See https://github.com/rubyzip/rubyzip for details. The Changelog also
+  lists other enhancements and bugfixes that have been implemented since
+  version 2.3.0.
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.0.3
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: rubyzip is a ruby module for reading and writing zip files
 test_files: []