rubyzip 2.2.0 → 2.3.0

data/lib/zip/inflater.rb

@@ -3,15 +3,16 @@ module Zip
     def initialize(*args)
       super
 
-      @buffer = ''.dup
+      @buffer = +''
       @zlib_inflater = ::Zlib::Inflate.new(-Zlib::MAX_WBITS)
     end
 
     def read(length = nil, outbuf = '')
-      return ((length.nil? || length.zero?) ? "" : nil) if eof
+      return (length.nil? || length.zero? ? '' : nil) if eof
 
       while length.nil? || (@buffer.bytesize < length)
         break if input_finished?
+
         @buffer << produce_input
       end
 
@@ -22,7 +23,7 @@ module Zip
       @buffer.empty? && input_finished?
     end
 
-    alias_method :eof?, :eof
+    alias eof? eof
 
     private
 
@@ -32,6 +33,7 @@ module Zip
         @zlib_inflater.inflate(input_stream.read(Decompressor::CHUNK_SIZE))
       rescue Zlib::BufError
         raise if retried >= 5 # how many times should we retry?
+
         retried += 1
         retry
       end

data/lib/zip/input_stream.rb

@@ -51,7 +51,7 @@ module Zip
     # @param offset [Integer] offset in the IO/StringIO
     def initialize(context, offset = 0, decrypter = nil)
       super()
-      @archive_io = get_io(context, offset)
+      @archive_io    = get_io(context, offset)
       @decompressor  = ::Zip::NullDecompressor
       @decrypter     = decrypter || ::Zip::NullDecrypter.new
       @current_entry = nil
@@ -73,6 +73,7 @@ module Zip
     # Rewinds the stream to the beginning of the current entry
     def rewind
       return if @current_entry.nil?
+
       @lineno = 0
       @pos    = 0
       @archive_io.seek(@current_entry.local_header_offset, IO::SEEK_SET)
@@ -91,6 +92,7 @@ module Zip
       def open(filename_or_io, offset = 0, decrypter = nil)
         zio = new(filename_or_io, offset, decrypter)
         return zio unless block_given?
+
         begin
           yield zio
         ensure
@@ -100,7 +102,7 @@ module Zip
 
       def open_buffer(filename_or_io, offset = 0)
         warn 'open_buffer is deprecated!!! Use open instead!'
-        open(filename_or_io, offset)
+        ::Zip::InputStream.open(filename_or_io, offset)
       end
     end
 
@@ -120,9 +122,10 @@ module Zip
 
     def open_entry
       @current_entry = ::Zip::Entry.read_local_entry(@archive_io)
-      if @current_entry && @current_entry.encrypted? && @decrypter.is_a?(NullEncrypter)
+      if @current_entry && @current_entry.encrypted? && @decrypter.kind_of?(NullEncrypter)
         raise Error, 'password required to decode zip file'
       end
+
       if @current_entry && @current_entry.incomplete? && @current_entry.crc == 0 \
         && @current_entry.compressed_size == 0 \
         && @current_entry.size == 0 && !@complete_entry

data/lib/zip/ioextras.rb

@@ -25,7 +25,7 @@ module Zip
         object == IO || super
       end
     end
-  end # IOExtras namespace module
+  end
 end
 
 require 'zip/ioextras/abstract_input_stream'

data/lib/zip/ioextras/abstract_input_stream.rb

@@ -35,6 +35,7 @@ module Zip
 
         if tbuf.nil? || tbuf.empty?
           return nil if number_of_bytes
+
           return ''
         end
 
@@ -48,13 +49,13 @@ module Zip
         buf
       end
 
-      def readlines(a_sep_string = $/)
+      def readlines(a_sep_string = $INPUT_RECORD_SEPARATOR)
         ret_val = []
         each_line(a_sep_string) { |line| ret_val << line }
         ret_val
       end
 
-      def gets(a_sep_string = $/, number_of_bytes = nil)
+      def gets(a_sep_string = $INPUT_RECORD_SEPARATOR, number_of_bytes = nil)
         @lineno = @lineno.next
 
         if number_of_bytes.respond_to?(:to_int)
@@ -62,20 +63,22 @@ module Zip
           a_sep_string = a_sep_string.to_str if a_sep_string
         elsif a_sep_string.respond_to?(:to_int)
           number_of_bytes = a_sep_string.to_int
-          a_sep_string    = $/
+          a_sep_string    = $INPUT_RECORD_SEPARATOR
         else
           number_of_bytes = nil
           a_sep_string = a_sep_string.to_str if a_sep_string
         end
 
         return read(number_of_bytes) if a_sep_string.nil?
-        a_sep_string = "#{$/}#{$/}" if a_sep_string.empty?
+
+        a_sep_string = "#{$INPUT_RECORD_SEPARATOR}#{$INPUT_RECORD_SEPARATOR}" if a_sep_string.empty?
 
         buffer_index = 0
         over_limit   = (number_of_bytes && @output_buffer.bytesize >= number_of_bytes)
         while (match_index = @output_buffer.index(a_sep_string, buffer_index)).nil? && !over_limit
           buffer_index = [buffer_index, @output_buffer.bytesize - a_sep_string.bytesize].max
           return @output_buffer.empty? ? nil : flush if input_finished?
+
           @output_buffer << produce_input
           over_limit = (number_of_bytes && @output_buffer.bytesize >= number_of_bytes)
         end
@@ -94,24 +97,26 @@ module Zip
         ret_val
       end
 
-      def readline(a_sep_string = $/)
+      def readline(a_sep_string = $INPUT_RECORD_SEPARATOR)
         ret_val = gets(a_sep_string)
         raise EOFError unless ret_val
+
         ret_val
       end
 
-      def each_line(a_sep_string = $/)
-        yield readline(a_sep_string) while true
+      def each_line(a_sep_string = $INPUT_RECORD_SEPARATOR)
+        loop { yield readline(a_sep_string) }
       rescue EOFError
+        # We just need to catch this; we don't need to handle it.
       end
 
-      alias_method :each, :each_line
+      alias each each_line
 
       def eof
         @output_buffer.empty? && input_finished?
       end
 
-      alias_method :eof?, :eof
+      alias eof? eof
     end
   end
 end

data/lib/zip/ioextras/abstract_output_stream.rb

@@ -11,7 +11,7 @@ module Zip
       end
 
       def print(*params)
-        self << params.join($,) << $\.to_s
+        self << params.join($OUTPUT_FIELD_SEPARATOR) << $OUTPUT_RECORD_SEPARATOR.to_s
       end
 
       def printf(a_format_string, *params)

data/lib/zip/output_stream.rb

@@ -49,6 +49,7 @@ module Zip
     class << self
       def open(file_name, encrypter = nil)
         return new(file_name) unless block_given?
+
         zos = new(file_name, false, encrypter)
         yield zos
       ensure
@@ -57,6 +58,7 @@ module Zip
 
       # Same as #open but writes to a filestream instead
       def write_buffer(io = ::StringIO.new(''), encrypter = nil)
+        io.binmode if io.respond_to?(:binmode)
         zos = new(io, true, encrypter)
         yield zos
         zos.close_buffer
@@ -66,6 +68,7 @@ module Zip
     # Closes the stream and writes the central directory to the zip file
     def close
       return if @closed
+
       finalize_current_entry
       update_local_headers
       write_central_directory
@@ -76,6 +79,7 @@ module Zip
     # Closes the stream and writes the central directory to the zip file
     def close_buffer
       return @output_stream if @closed
+
       finalize_current_entry
       update_local_headers
       write_central_directory
@@ -87,6 +91,7 @@ module Zip
     # +entry+ can be a ZipEntry object or a string.
     def put_next_entry(entry_name, comment = nil, extra = nil, compression_method = Entry::DEFLATED, level = Zip.default_compression)
       raise Error, 'zip stream is closed' if @closed
+
       new_entry = if entry_name.kind_of?(Entry)
                     entry_name
                   else
@@ -94,7 +99,7 @@ module Zip
                   end
       new_entry.comment = comment unless comment.nil?
       unless extra.nil?
-        new_entry.extra = extra.is_a?(ExtraField) ? extra : ExtraField.new(extra.to_s)
+        new_entry.extra = extra.kind_of?(ExtraField) ? extra : ExtraField.new(extra.to_s)
       end
       new_entry.compression_method = compression_method unless compression_method.nil?
       init_next_entry(new_entry, level)
@@ -104,7 +109,8 @@ module Zip
     def copy_raw_entry(entry)
       entry = entry.dup
       raise Error, 'zip stream is closed' if @closed
-      raise Error, 'entry is not a ZipEntry' unless entry.is_a?(Entry)
+      raise Error, 'entry is not a ZipEntry' unless entry.kind_of?(Entry)
+
       finalize_current_entry
       @entry_set << entry
       src_pos = entry.local_header_offset
@@ -123,8 +129,11 @@ module Zip
 
     def finalize_current_entry
       return unless @current_entry
+
       finish
-      @current_entry.compressed_size = @output_stream.tell - @current_entry.local_header_offset - @current_entry.calculate_local_header_size
+      @current_entry.compressed_size = @output_stream.tell - \
+                                       @current_entry.local_header_offset - \
+                                       @current_entry.calculate_local_header_size
       @current_entry.size = @compressor.size
       @current_entry.crc = @compressor.crc
       @output_stream << @encrypter.data_descriptor(@current_entry.crc, @current_entry.compressed_size, @current_entry.size)
@@ -144,9 +153,9 @@ module Zip
 
     def get_compressor(entry, level)
       case entry.compression_method
-      when Entry::DEFLATED then
+      when Entry::DEFLATED
         ::Zip::Deflater.new(@output_stream, level, @encrypter)
-      when Entry::STORED then
+      when Entry::STORED
         ::Zip::PassThruCompressor.new(@output_stream)
       else
         raise ::Zip::CompressionMethodError,

data/lib/zip/pass_thru_compressor.rb

@@ -1,8 +1,8 @@
 module Zip
   class PassThruCompressor < Compressor #:nodoc:all
-    def initialize(outputStream)
+    def initialize(output_stream)
       super()
-      @output_stream = outputStream
+      @output_stream = output_stream
       @crc = Zlib.crc32
       @size = 0
     end

data/lib/zip/pass_thru_decompressor.rb

@@ -6,7 +6,7 @@ module Zip
     end
 
     def read(length = nil, outbuf = '')
-      return ((length.nil? || length.zero?) ? "" : nil) if eof
+      return (length.nil? || length.zero? ? '' : nil) if eof
 
       if length.nil? || (@read_so_far + length) > decompressed_size
         length = decompressed_size - @read_so_far
@@ -20,7 +20,7 @@ module Zip
       @read_so_far >= decompressed_size
     end
 
-    alias_method :eof?, :eof
+    alias eof? eof
   end
 
   ::Zip::Decompressor.register(::Zip::COMPRESSION_METHOD_STORE, ::Zip::PassThruDecompressor)

data/lib/zip/streamable_directory.rb

@@ -1,11 +1,11 @@
 module Zip
   class StreamableDirectory < Entry
-    def initialize(zipfile, entry, srcPath = nil, permissionInt = nil)
+    def initialize(zipfile, entry, src_path = nil, permission = nil)
       super(zipfile, entry)
 
       @ftype = :directory
-      entry.get_extra_attributes_from_path(srcPath) if srcPath
-      @unix_perms = permissionInt if permissionInt
+      entry.get_extra_attributes_from_path(src_path) if src_path
+      @unix_perms = permission if permission
     end
   end
 end

data/lib/zip/streamable_stream.rb

@@ -1,5 +1,5 @@
 module Zip
-  class StreamableStream < DelegateClass(Entry) # nodoc:all
+  class StreamableStream < DelegateClass(Entry) # :nodoc:all
     def initialize(entry)
       super(entry)
       @temp_file = Tempfile.new(::File.basename(name))
@@ -22,6 +22,7 @@ module Zip
       unless @temp_file.closed?
         raise StandardError, "cannot open entry for reading while its open for writing - #{name}"
       end
+
       @temp_file.open # reopens tempfile from top
       @temp_file.binmode
       if block_given?
@@ -35,9 +36,9 @@ module Zip
       end
     end
 
-    def write_to_zip_output_stream(aZipOutputStream)
-      aZipOutputStream.put_next_entry(self)
-      get_input_stream { |is| ::Zip::IOExtras.copy_stream(aZipOutputStream, is) }
+    def write_to_zip_output_stream(output_stream)
+      output_stream.put_next_entry(self)
+      get_input_stream { |is| ::Zip::IOExtras.copy_stream(output_stream, is) }
     end
 
     def clean_up

data/lib/zip/version.rb

@@ -1,3 +1,3 @@
 module Zip
-  VERSION = '2.2.0'
+  VERSION = '2.3.0'
 end

data/samples/example.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-$: << '../lib'
+$LOAD_PATH << '../lib'
 system('zip example.zip example.rb gtk_ruby_zip.rb')
 
 require 'zip'
@@ -71,7 +71,7 @@ puts "Zip file splitted in #{part_zips_count} parts"
 
 # Track splitting an archive
 Zip::File.split('large_zip_file.zip', 1_048_576, true, 'part_zip_file') do |part_count, part_index, chunk_bytes, segment_bytes|
-  puts "#{part_index} of #{part_count} part splitting: #{(chunk_bytes.to_f / segment_bytes.to_f * 100).to_i}%"
+  puts "#{part_index} of #{part_count} part splitting: #{(chunk_bytes.to_f / segment_bytes * 100).to_i}%"
 end
 
 # For other examples, look at zip.rb and ziptest.rb

data/samples/example_filesystem.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-$: << '../lib'
+$LOAD_PATH << '../lib'
 
 require 'zip/filesystem'
 

data/samples/gtk_ruby_zip.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-$: << '../lib'
+$LOAD_PATH << '../lib'
 
 $VERBOSE = true
 
@@ -18,14 +18,14 @@ class MainApp < Gtk::Window
     add(box)
 
     @zipfile = nil
-    @buttonPanel = ButtonPanel.new
-    @buttonPanel.openButton.signal_connect(Gtk::Button::SIGNAL_CLICKED) do
+    @button_panel = ButtonPanel.new
+    @button_panel.open_button.signal_connect(Gtk::Button::SIGNAL_CLICKED) do
       show_file_selector
     end
-    @buttonPanel.extractButton.signal_connect(Gtk::Button::SIGNAL_CLICKED) do
+    @button_panel.extract_button.signal_connect(Gtk::Button::SIGNAL_CLICKED) do
       puts 'Not implemented!'
     end
-    box.pack_start(@buttonPanel, false, false, 0)
+    box.pack_start(@button_panel, false, false, 0)
 
     sw = Gtk::ScrolledWindow.new
     sw.set_policy(Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC)
@@ -42,27 +42,27 @@ class MainApp < Gtk::Window
   end
 
   class ButtonPanel < Gtk::HButtonBox
-    attr_reader :openButton, :extractButton
+    attr_reader :open_button, :extract_button
     def initialize
       super
       set_layout(Gtk::BUTTONBOX_START)
       set_spacing(0)
-      @openButton = Gtk::Button.new('Open archive')
-      @extractButton = Gtk::Button.new('Extract entry')
-      pack_start(@openButton)
-      pack_start(@extractButton)
+      @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
-    @fileSelector = Gtk::FileSelection.new('Open zip file')
-    @fileSelector.show
-    @fileSelector.ok_button.signal_connect(Gtk::Button::SIGNAL_CLICKED) do
-      open_zip(@fileSelector.filename)
-      @fileSelector.destroy
+    @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
-    @fileSelector.cancel_button.signal_connect(Gtk::Button::SIGNAL_CLICKED) do
-      @fileSelector.destroy
+    @file_selector.cancel_button.signal_connect(Gtk::Button::SIGNAL_CLICKED) do
+      @file_selector.destroy
     end
   end
 
@@ -77,8 +77,8 @@ class MainApp < Gtk::Window
   end
 end
 
-mainApp = MainApp.new
+main_app = MainApp.new
 
-mainApp.show_all
+main_app.show_all
 
 Gtk.main

data/samples/qtzip.rb

@@ -2,7 +2,7 @@
 
 $VERBOSE = true
 
-$: << '../lib'
+$LOAD_PATH << '../lib'
 
 require 'Qt'
 system('rbuic -o zipdialogui.rb zipdialogui.ui')
@@ -20,12 +20,12 @@ 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
@@ -80,7 +80,7 @@ class ZipDialog < ZipDialogUI
 end
 
 unless ARGV[0]
-  puts "usage: #{$0} zipname"
+  puts "usage: #{$PROGRAM_NAME} zipname"
   exit
 end