zippo 0.2.0 → 0.2.1

data/lib/zippo/filter/uncompressor.rb

@@ -27,7 +27,7 @@ module Zippo::Filter
       @remaining = @compressed_size
     end
 
-    def read n, buf = nil
+    def read(n, buf = nil)
       if @remaining >= n
         @remaining -= n
       elsif (n = @remaining) > 0
@@ -43,11 +43,9 @@ module Zippo::Filter
     # Uncompresses the data to the specified IO
     #
     # @param [IO] io the object to uncompress to, must respond to #<<
-    def uncompress_to io
+    def uncompress_to(io)
       buf = ""
-      while (read BLOCK_SIZE, buf)
-        io << buf
-      end
+      io << buf while read BLOCK_SIZE, buf
       io << tail_filter
     end
 

data/lib/zippo/filter/uncompressor/deflate.rb

@@ -14,6 +14,7 @@ module Zippo::Filter
     end
 
     private
+
     def filter(buf)
       @zlib.inflate(buf)
     end

data/lib/zippo/io_zip_member.rb

@@ -17,7 +17,7 @@ module Zippo
       @source.rewind
     end
 
-    def write_to out, preferred_compression_method = Filter::DeflateCompressor::METHOD, recompress = nil
+    def write_to(out, preferred_compression_method = Filter::DeflateCompressor::METHOD, _recompress = nil)
       Filter::Compressor.for(preferred_compression_method).new(@source).compress_to(out)
     end
   end

data/lib/zippo/local_file_header.rb

@@ -8,21 +8,21 @@ module Zippo
     binary_structure do
       # @!macro [attach] bs.field
       #   @!attribute [rw] $1
-      field :signature, 'L', :signature => SIGNATURE
-      field :version_extractable_by, 'S', :default => 20
-      field :bit_flags, 'S', :default => 0
+      field :signature, 'L', signature: SIGNATURE
+      field :version_extractable_by, 'S', default: 20
+      field :bit_flags, 'S', default: 0
       field :compression_method, 'S'
-      field :last_modified_time, 'S', :default => 0 # XXX
-      field :last_modified_date, 'S', :default => 0 # XXX
+      field :last_modified_time, 'S', default: 0 # XXX
+      field :last_modified_date, 'S', default: 0 # XXX
       field :crc32, 'L'
       field :compressed_size, 'L'
       field :uncompressed_size, 'L'
       # set when name is set
       field :file_name_length, 'S'
       # set when extra_field is set
-      field :extra_field_length, 'S', :default => 0
-      field :name, 'a*', :size => :file_name_length
-      field :extra_field, 'a*', :default => '', :size => :extra_field_length
+      field :extra_field_length, 'S', default: 0
+      field :name, 'a*', size: :file_name_length
+      field :extra_field, 'a*', default: '', size: :extra_field_length
     end
   end
 end

data/lib/zippo/version.rb

@@ -1,3 +1,3 @@
 module Zippo
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/lib/zippo/zip_directory.rb

@@ -13,7 +13,7 @@ module Zippo
     def_delegators :entries_hash, :empty?
     def_delegators :entries, :each, :map
 
-    def initialize io = nil
+    def initialize(io = nil)
       @io = io
     end
 
@@ -48,23 +48,25 @@ module Zippo
     # - another ZipMember (allowing direct stream copy)
     def insert(name, source)
       set name,
-        case source
-        when ZipMember then source.with_name name
-        when String then IOZipMember.new name, File.open(source, 'r:BINARY')
-        else IOZipMember.new name, source
-        end
+          case source
+          when ZipMember then source.with_name name
+          when String then IOZipMember.new name, File.open(source, 'r:BINARY')
+          else IOZipMember.new name, source
+          end
     end
 
     # @return [Hash] the hash of ZipMembers, the hash key is the
     #   member's name
     def entries_hash
-      @entries_hash ||= if @io
-        CentralDirectoryReader.new(@io).cd_file_headers.each_with_object({}) do |header, hash|
-          hash[header.name] = ZipMember.new @io, header
+      @entries_hash ||=
+        if @io
+          CentralDirectoryReader.new(@io)
+            .cd_file_headers.each_with_object({}) do |header, hash|
+              hash[header.name] = ZipMember.new @io, header
+            end
+        else
+          {}
         end
-      else
-        {}
-      end
     end
 
     # @return [Array] the members of the ZipFile
@@ -73,6 +75,7 @@ module Zippo
     end
 
     private
+
     def set(name, member)
       entries_hash[name] = member
     end

data/lib/zippo/zip_file.rb

@@ -87,14 +87,16 @@ module Zippo
 
     # @return [ZipDirectory] the ZipDirectory
     def directory
-      @directory ||= if read?
-        ZipDirectory.new io
-      else
-        ZipDirectory.new
-      end
+      @directory ||=
+        if read?
+          ZipDirectory.new io
+        else
+          ZipDirectory.new
+        end
     end
 
     private
+
     def read?
       File.exist? @filename and @mode.include? 'r'
     end
@@ -104,7 +106,7 @@ module Zippo
     end
 
     def update?
-      read? and write?
+      read? && write?
     end
 
     def io

data/lib/zippo/zip_file_writer.rb

@@ -10,10 +10,10 @@ module Zippo
 
     # Writes the directory to the file.
     def write
-      File.open(@filename,'wb:ASCII-8BIT') do |io|
+      File.open(@filename, 'wb:ASCII-8BIT') do |io|
         packer = LocalFileHeader::Packer.new io
         headers = []
-        for member in @directory
+        @directory.each do |member|
           header = CdFileHeader.default
           header.compression_method = 8 # XXX configurable
           # XXX hack fix for maintaining method in zipped data copies
@@ -36,7 +36,7 @@ module Zippo
 
           # write the completed header, returning to the current position
           io.seek header.local_file_header_offset
-          #packer.pack LocalFileHeader.from header.convert_to LocalHileHeader
+          # packer.pack LocalFileHeader.from header.convert_to LocalHileHeader
           packer.pack header.convert_to LocalFileHeader
           io.seek header.compressed_size, IO::SEEK_CUR
           headers << header
@@ -45,7 +45,7 @@ module Zippo
         eocdr = EndCdRecord.default
         eocdr.cd_offset = io.pos
         packer = CdFileHeader::Packer.new io
-        for header in headers
+        headers.each do |header|
           packer.pack header
         end
         eocdr.cd_size = io.pos - eocdr.cd_offset

data/lib/zippo/zip_member.rb

@@ -7,7 +7,7 @@ require 'forwardable'
 module Zippo
   # A member of a Zip archive file.
   class ZipMember
-    def initialize io, header
+    def initialize(io, header)
       @io = io
       @header = header
     end
@@ -38,7 +38,7 @@ module Zippo
     #
     # @param [String] name the name to use
     # @return [ZipMember] the new ZipMember
-    def with_name name
+    def with_name(name)
       dup.tap do |obj|
         obj.instance_variable_set :@name, name
       end
@@ -53,7 +53,7 @@ module Zippo
     #
     # @return [Integer, Integer, Integer] the amount written, the
     #   original size of the data, the crc32 of the data
-    def write_to out, preferred_method = Filter::DeflateCompressor::METHOD, recompress = false
+    def write_to(out, preferred_method = Filter::DeflateCompressor::METHOD, recompress = false)
       seek_to_compressed_data
       if recompress
         Filter::Compressor.for(preferred_method).new(uncompressor).compress_to(out)
@@ -64,6 +64,7 @@ module Zippo
     end
 
     private
+
     def local_file_header
       @io.seek @header.local_file_header_offset
       LocalFileHeader::Unpacker.new(@io).unpack

data/spec/binary_structure_spec.rb

@@ -1,6 +1,6 @@
 require "spec_helper"
 
-# TODO - spec that unpackers can take strings
+# TODO: - spec that unpackers can take strings
 
 require 'zippo/binary_structure'
 
@@ -17,14 +17,14 @@ module Zippo
         klass.class_eval do
           binary_structure do
             field :foo, 'L'
-            field :yay, 'a4', :signature => "baz"
+            field :yay, 'a4', signature: "baz"
             field :bar, 'S'
-            field :quux, 'a*', :size => :foo
+            field :quux, 'a*', size: :foo
           end
         end
       end
       it "should store field information in the class" do
-        klass.structure.should have(4).fields
+        klass.structure.fields.size.should eq 4
         klass.structure.fields[0].name.should eq :foo
         klass.structure.fields[3].options[:size].should eq :foo
         klass.structure.fields[1].should be_signature
@@ -42,7 +42,7 @@ module Zippo
         obj.bar.should eq 10
       end
       it "should have an unpacker" do
-        array = [10,"baz", 42,"foobar baz"]
+        array = [10, "baz", 42, "foobar baz"]
         packed = array.pack 'La4Sa*'
         io = StringIO.new packed
         obj = klass::Unpacker.new(io).unpack
@@ -51,14 +51,14 @@ module Zippo
         obj.quux.should eq "foobar baz"
       end
       it "should unpack oversized strings correctly" do
-        array = [3,"baz", 42,"foobar baz"]
+        array = [3, "baz", 42, "foobar baz"]
         packed = array.pack 'La4Sa*'
         io = StringIO.new packed
         obj = klass::Unpacker.new(io).unpack
         obj.quux.should eq "foo"
       end
       it "should have a packer" do
-        array = [10,"baz", 42,"foobar baz"]
+        array = [10, "baz", 42, "foobar baz"]
         packed = array.pack 'La4Sa*'
         io = StringIO.new
         obj.bar = 42
@@ -79,7 +79,7 @@ module Zippo
           other_klass.class_eval do
             binary_structure do
               field :bar, 'S'
-              field :yay, 'a4', :signature => "quux"
+              field :yay, 'a4', signature: "quux"
             end
           end
         end
@@ -108,25 +108,23 @@ module Zippo
     # need to test a few fixed fields, followed by a
     # variable length field, then a few more fixed
     # fields
-=begin
-    it "should complain if the order is bad" do
-      pending
-      klass = Class.new BinaryStructure
-      lambda { klass.class_eval do
-        field :foo, 'S'
-        field :bar, 'a*', :size => :baz
-        field :baz, 'S'
-      end }.should raise_error "size not found"
-    end
-    it "should remain silent if the order is ok" do
-      pending
-      klass = Class.new BinaryStructure
-      lambda { klass.class_eval do
-        field :foo, 'S'
-        field :baz, 'S'
-        field :bar, 'a*', :size => :baz
-      end }.should_not raise_error
-    end
-=end
+    #     it "should complain if the order is bad" do
+    #       pending
+    #       klass = Class.new BinaryStructure
+    #       lambda { klass.class_eval do
+    #         field :foo, 'S'
+    #         field :bar, 'a*', :size => :baz
+    #         field :baz, 'S'
+    #       end }.should raise_error "size not found"
+    #     end
+    #     it "should remain silent if the order is ok" do
+    #       pending
+    #       klass = Class.new BinaryStructure
+    #       lambda { klass.class_eval do
+    #         field :foo, 'S'
+    #         field :baz, 'S'
+    #         field :bar, 'a*', :size => :baz
+    #       end }.should_not raise_error
+    #     end
   end
 end

data/spec/central_directory_entries_unpacker_spec.rb

@@ -11,7 +11,7 @@ module Zippo
       let(:offset) { 112 }
       let(:size) { 79 }
 
-      specify { subject.should have(1).items }
+      specify { subject.size.should eq 1 }
       specify { subject.first.name.should eq "test.file" }
     end
 
@@ -20,10 +20,9 @@ module Zippo
       let(:offset) { 242 }
       let(:size) { 158 }
 
-      specify { subject.should have(2).items }
+      specify { subject.size.should eq 2 }
       specify { subject[0].name.should eq "test.file" }
       specify { subject[1].name.should eq "other.test" }
     end
-
   end
 end

data/spec/central_directory_parser_spec.rb

@@ -6,7 +6,7 @@ require "zippo/zip_file"
 module Zippo
   describe CentralDirectoryReader do
     let(:io) { File.open(file, "rb:ASCII-8BIT") }
-      let(:file) { test_file "test.zip" }
+    let(:file) { test_file "test.zip" }
     let(:parser) { CentralDirectoryReader.new(io) }
     after(:each) { io.close }
 
@@ -17,7 +17,7 @@ module Zippo
       end
 
       specify { parser.end_of_cd_record_position.should eq 0xbf }
-      specify { parser.should have(1).cd_file_headers }
+      specify { parser.cd_file_headers.size.should eq 1 }
     end
 
     context "when parsing a file with a comment" do
@@ -33,7 +33,7 @@ module Zippo
 
     context "when parsing a file that is not a zip" do
       let(:file) { test_file "not_a.zip" }
-      specify { -> {parser.end_of_cd_record_position}.should raise_error(/not found/) }
+      specify { -> { parser.end_of_cd_record_position }.should raise_error(/not found/) }
     end
 
     context "when parsing a zip file larger than the maximum comment size" do
@@ -42,7 +42,7 @@ module Zippo
           Zippo::ZipFile.open("large.zip", "w") do |v|
             v["test.file"] = "a" * 65535
           end
-          Zippo::ZipFile.open("large.zip") {|v| v["test.file"].read }.should eq "a" * 65535
+          Zippo::ZipFile.open("large.zip") { |v| v["test.file"].read }.should eq "a" * 65535
         end
       end
     end

data/spec/central_directory_unpacker_spec.rb

@@ -26,6 +26,5 @@ module Zippo
       specify { subject.total_records.should eq 1 }
       specify { subject.comment.should eq "this is a comment to make things tricky" }
     end
-
   end
 end

data/spec/deflate_compressor_spec.rb

@@ -5,10 +5,10 @@ require "zippo/filter/compressor/deflate"
 
 module Zippo::Filter
   describe DeflateCompressor do
-    let (:data) { "a" * 20 }
-    let (:zdata) { "KL\xC4\u0004\u0000" }
-    let (:io) { StringIO.new data }
-    let (:out) { StringIO.new "" }
+    let(:data) { "a" * 20 }
+    let(:zdata) { "KL\xC4\u0004\u0000" }
+    let(:io) { StringIO.new data }
+    let(:out) { StringIO.new "" }
     it "should write the data" do
       compressor = DeflateCompressor.new(io)
       csize, size, crc32 = compressor.compress_to out

data/spec/deflate_uncompressor_spec.rb

@@ -4,12 +4,11 @@ require "zippo/filter/uncompressor/deflate"
 
 module Zippo::Filter
   describe DeflateUncompressor do
-
-    let (:zstring) { Zlib::Deflate.new(Zlib::BEST_COMPRESSION, -Zlib::MAX_WBITS).deflate("a" * 20, Zlib::FINISH) }
-    let (:size) { zstring.size }
-    let (:string) { "aaa" + zstring + "bbb" }
-    let (:out) { StringIO.new }
-    let (:io) { StringIO.new string }
+    let(:zstring) { Zlib::Deflate.new(Zlib::BEST_COMPRESSION, -Zlib::MAX_WBITS).deflate("a" * 20, Zlib::FINISH) }
+    let(:size) { zstring.size }
+    let(:string) { "aaa" + zstring + "bbb" }
+    let(:out) { StringIO.new }
+    let(:io) { StringIO.new string }
     it "should deflate only the compressed string" do
       io.seek 3
       DeflateUncompressor.new(io, size).uncompress.should eq "a" * 20

data/spec/integration/compressors_spec.rb

@@ -7,7 +7,7 @@ require 'zippo/filter/compressors'
 
 module Zippo::Filter
   describe Uncompressor do
-    let (:zstring) { Zlib::Deflate.new(Zlib::BEST_COMPRESSION, -Zlib::MAX_WBITS).deflate("a" * 20, Zlib::FINISH) }
+    let(:zstring) { Zlib::Deflate.new(Zlib::BEST_COMPRESSION, -Zlib::MAX_WBITS).deflate("a" * 20, Zlib::FINISH) }
     it "should allow uncompressors to work with compressors" do
       stream = StringIO.new zstring
       deflater = DeflateUncompressor.new(stream, zstring.size)

data/spec/integration/zippo_spec.rb

@@ -24,7 +24,8 @@ module Zippo
 
       it "should work like File.open" do
         io = File.open(file)
-        File.should_receive(:open).with(file, 'r:ASCII-8BIT').and_return(io)
+        expect(File).to receive(:open)
+          .with(file, 'r:ASCII-8BIT').and_return(io)
         s = Zippo.open(file) { |v| v['test.file'].read }
         s.should eq member_data
         io.should be_closed
@@ -33,9 +34,9 @@ module Zippo
       it "should create zip files" do
         in_working_directory do
           File.write "xyzzy.txt", "plugh"
-          Zippo.open("new.zip", "w") {|v| v['xyzzy.txt'] = "plugh" }
+          Zippo.open("new.zip", "w") { |v| v['xyzzy.txt'] = "plugh" }
           Pathname.new("new.zip").should exist
-          Zippo.open("new.zip") {|v| v['xyzzy.txt'].read }.should eq "plugh"
+          Zippo.open("new.zip") { |v| v['xyzzy.txt'].read }.should eq "plugh"
         end
       end