zippo 0.2.0 → 0.2.1

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MDM2MjkzNjVlMWI3OTlmYmU5NTJjMTVhZmExMzU2ODRjYmMwZWNiMw==
-  data.tar.gz: !binary |-
-    Zjk3OWIwMTBjZWJiMmQyOTUwNzQ1YzgzOWExODc0NThiNjMwMDhmOA==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    NjI5ZDU5MTdiMWU0ZDc5NjBhNzMwMWY2YTRkNzYyZDRjZDMzNTFmOTcxMWI4
-    NDI3NGYzYWU5ZWQyOTEzYzY5N2U4YzFhNTA1ZWE2NTRlMTEzNTUzYzEyYmIx
-    ZGY4Njc5NjE1YWY5NWI4NjZjM2UxNGMxZTRiZGQ4MTFkZGM0OWU=
-  data.tar.gz: !binary |-
-    YmJkYjQ3YmQ2YWFjNjRhNGZmNWI5MTlhOGMzYjliMjg5MWQ4YzRhZTVhMGY3
-    OGIyZDJiMzM1NDNmMzY5MGVmNjFlZmFhMWM2MDY4ZjVmNDdiYzI4MmE1MDhk
-    N2I5Zjk1YzRlYTIwZWY2NDY5ZDMwYzMyNzEzZGI5NjMzZDFiZDE=
+SHA1:
+  metadata.gz: 40c9371e43e13d46ae694e7ed3bcb0168598a92c
+  data.tar.gz: 035f7bea5022170d7ddd7bcc16cabef3fb3b9ba2
+SHA512:
+  metadata.gz: 3532b3b02c7d4895790e3b4606e69586ae1bc142d184f2cecc9356e3777d56ca58a6008f090491a63633763a121de690e20063a6992ecb1228f09cbab239f19e
+  data.tar.gz: 78a7cef02643a7b12833a1ebf98d3871d5290b0dfb0313cdae73777faba860e8297f02a2f2c055435d875aa6328abca52e10153b1fd165c69b921e49275e31e0

data/.rubocop.yml

@@ -0,0 +1,35 @@
+Metrics/LineLength:
+  Max: 164
+
+Metrics/MethodLength:
+  Max: 31
+
+Metrics/AbcSize:
+  Max: 46
+
+Style/StringLiteralsInInterpolation:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/AndOr:
+  Enabled: false
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+Style/TrailingComma:
+  EnforcedStyleForMultiline: comma
+
+Style/MultilineOperationIndentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/README.md

@@ -1,7 +1,11 @@
 # Zippo
 
+[![Build Status](https://travis-ci.org/JonathonMA/zippo.svg?branch=master)](https://travis-ci.org/JonathonMA/zippo)
+
 Zippo is a fast zip library for ruby.
 
+A [benchmark](https://gist.github.com/JonathonMA/7943484) is available.
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/Rakefile

@@ -1,11 +1,17 @@
 #!/usr/bin/env rake
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 require 'yard'
-require './yard_extensions'
 
-task :default => :spec
+require './yard_extensions'
 
 RSpec::Core::RakeTask.new
+RuboCop::RakeTask.new
 
 YARD::Rake::YardocTask.new
+
+task default: [
+  :spec,
+  :rubocop,
+]

data/lib/zippo.rb

@@ -10,7 +10,7 @@ module Zippo
   class << self
     # Calls Zippo::ZipFile.open
     # @see ZipFile.open
-    def open filename, mode = 'r', &block
+    def open(filename, mode = 'r', &block)
       Zippo::ZipFile.open filename, mode, &block
     end
     public :open

data/lib/zippo/binary_structure/base.rb

@@ -32,18 +32,18 @@ module Zippo
   # @see Array#pack
   module BinaryStructure
     module Base
-      def binary_structure &block
+      def binary_structure(&block)
         @structure = Structure.create(self, &block)
-        self.const_set :Packer, Class.new(BinaryPacker)
+        const_set :Packer, Class.new(BinaryPacker)
         self::Packer.structure = @structure
-        self.const_set :Unpacker, Class.new(BinaryUnpacker)
+        const_set :Unpacker, Class.new(BinaryUnpacker)
         self::Unpacker.structure = @structure
 
         @structure.fields.each do |field|
           attr_reader field.name
           if @structure.dependent? field.name
-            define_method "#{field.name}=" do |value|
-              raise "can't mutate a dependent field"
+            define_method "#{field.name}=" do |_value|
+              fail "can't mutate a dependent field"
             end
           else
             if field.dependent
@@ -68,7 +68,8 @@ module Zippo
             hook.call(klass)
           end if @hooks
         end
-        def after_structure_definition &block
+
+        def after_structure_definition(&block)
           @hooks ||= []
           @hooks << block
         end
@@ -81,6 +82,7 @@ module Zippo
           end
           self
         end
+
         def size
           self.class.structure.fields.map do |field|
             if field.dependent
@@ -88,10 +90,10 @@ module Zippo
             else
               field.width
             end
-          end.inject(&:+)
+          end.reduce(&:+)
         end
 
-        def convert_to other
+        def convert_to(other)
           other.default.tap do |obj|
             self.class.common_fields_with(other).each do |field|
               obj.instance_variable_set "@#{field}", send(field)

data/lib/zippo/binary_structure/binary_packer.rb

@@ -9,8 +9,8 @@ module Zippo
         @io = io
       end
 
-      def pack obj
-        @io << self.class.structure.fields.map {|f| obj.send f.name}.pack(self.class.structure.fields.map(&:pack).join(""))
+      def pack(obj)
+        @io << self.class.structure.fields.map { |f| obj.send f.name }.pack(self.class.structure.fields.map(&:pack).join(""))
       end
     end
   end

data/lib/zippo/binary_structure/meta.rb

@@ -8,7 +8,7 @@ module Zippo::BinaryStructure
       # Defines a method on the specified class that sets a bunch of fields at once.
       def define_helper(klass, meth, fields)
         buf = []
-        buf << "def #{meth}(#{0.upto(fields.size-1).map{|x|"a#{x}"}.join(',')})"
+        buf << "def #{meth}(#{0.upto(fields.size - 1).map { |x|"a#{x}" }.join(',')})"
         fields.each_with_index do |field, i|
           buf << "@#{field} = a#{i}"
         end
@@ -17,7 +17,7 @@ module Zippo::BinaryStructure
       end
 
       def fields_as_args(fields)
-        fields.map {|f| "@#{f}"}.join(", ")
+        fields.map { |f| "@#{f}" }.join(", ")
       end
 
       def call_helper(receiver, meth, fields)
@@ -28,8 +28,8 @@ module Zippo::BinaryStructure
         buf = []
         buf << "def defaults"
         klass.structure.fields.each do |field|
-          buf << %{@#{field.name} = #{field.options[:default].inspect}} if field.options[:default]
-          buf << %{@#{field.name} = #{field.options[:signature].inspect}} if field.options[:signature]
+          buf << %(@#{field.name} = #{field.options[:default].inspect}) if field.options[:default]
+          buf << %(@#{field.name} = #{field.options[:signature].inspect}) if field.options[:signature]
         end
         buf << "self"
         buf << "end"
@@ -39,8 +39,8 @@ module Zippo::BinaryStructure
       # XXX - should write a spec for the "multiple helpers"
       # implementation, none of the current binary structures would make
       # use of it, as they all have a bunch of fixed fields,
-      # then the variable fields at the end. a test should 
-      #def self.define_unpack_method
+      # then the variable fields at the end. a test should
+      # def self.define_unpack_method
       def define_unpack_method_for(klass)
         buf = "def unpack\n"
         buf << "obj = self.class.structure.owner_class.new\n"
@@ -53,7 +53,7 @@ module Zippo::BinaryStructure
           if field.options[:size]
             # unpack fixed group
             unless field_buf.empty?
-              s = field_buf.map(&:width).inject(&:+)
+              s = field_buf.map(&:width).reduce(&:+)
               buf << %{arr = @io.read(#{s}).unpack("#{field_buf.map(&:pack).join('')}")\n}
               helper_name = "binary_structure_unpack_helper_#{helper_num += 1}"
               define_helper(klass.structure.owner_class, helper_name, field_buf.map(&:name))
@@ -104,9 +104,7 @@ module Zippo::BinaryStructure
         """
       end
 
-      def define_pack_method_for klass
-        buf = []
-
+      def define_pack_method_for(klass)
         fields = klass.structure.fields.map(&:name)
         packing_string = klass.structure.fields.map(&:pack).join('')
 
@@ -137,7 +135,7 @@ module Zippo::BinaryStructure
   end
 
   module InstanceMethods
-    def convert_to other
+    def convert_to(other)
       method = :"convert_to_#{other.object_id}"
       ::Zippo::BinaryStructure::CodeGen.define_converter_for(self.class, method, other) unless respond_to? method
       send method

data/lib/zippo/binary_structure/structure.rb

@@ -8,13 +8,15 @@ module Zippo
       def initialize(owner_class, &block)
         @fields = []
         @owner_class = owner_class
-        instance_eval &block
+        instance_eval(&block)
       end
-      def field name, pack, options = {}
+
+      def field(name, pack, options = {})
         @fields << StructureMember.new(name, pack, options)
       end
-      def dependent? field_name
-        fields.detect do |field|
+
+      def dependent?(field_name)
+        fields.find do |field|
           field.options[:size] == field_name
         end
       end

data/lib/zippo/binary_structure/structure_member.rb

@@ -17,7 +17,7 @@ module Zippo
         case pack
         when 'L' then 4
         when 'S' then 2
-        when /^a(\d+)$/ then $1.to_i
+        when /^a(\d+)$/ then Regexp.last_match[1].to_i
         when 'a*' then nil
         end
       end

data/lib/zippo/cd_file_header.rb

@@ -8,29 +8,29 @@ module Zippo
     binary_structure do
       # @!macro [attach] bs.field
       #   @!attribute [rw] $1
-      field :signature, 'L', :signature => SIGNATURE
-      field :version_made_by, 'S', :default => 0
-      field :version_extractable_by, 'S', :default => 20
-      field :bit_flags, 'S', :default => 0
+      field :signature, 'L', signature: SIGNATURE
+      field :version_made_by, 'S', default: 0
+      field :version_extractable_by, 'S', default: 20
+      field :bit_flags, 'S', default: 0
       field :compression_method, 'S'
-      field :last_modified_time, 'S', :default => 0
-      field :last_modified_date, 'S', :default => 0
+      field :last_modified_time, 'S', default: 0
+      field :last_modified_date, 'S', default: 0
       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 :extra_field_length, 'S', default: 0
       # set when file comment is set
-      field :file_comment_length, 'S', :default => 0
-      field :disk_number, 'S', :default => 0
-      field :internal_file_attributes, 'S', :default => 0
-      field :external_file_attributes, 'L', :default => 0
+      field :file_comment_length, 'S', default: 0
+      field :disk_number, 'S', default: 0
+      field :internal_file_attributes, 'S', default: 0
+      field :external_file_attributes, 'L', default: 0
       field :local_file_header_offset, 'L'
-      field :name, 'a*', :size => :file_name_length
-      field :extra_field, 'a*', :size => :extra_field_length, :default => ''
-      field :comment, 'a*', :default => '', :size => :file_comment_length, :default => ''
+      field :name, 'a*', size: :file_name_length
+      field :extra_field, 'a*', size: :extra_field_length, default: ''
+      field :comment, 'a*', size: :file_comment_length, default: ''
     end
   end
 end

data/lib/zippo/central_directory_entries_unpacker.rb

@@ -11,13 +11,14 @@ module Zippo
       @offset = offset
       @end = @offset + @size
     end
+
     def unpack
       [].tap do |entries|
         @io.seek @offset
-        while @io.pos < @end && entry = CdFileHeader::Unpacker.new(@io).unpack
+        while @io.pos < @end && (entry = CdFileHeader::Unpacker.new(@io).unpack)
           entries << entry
         end
       end
     end
- end
+  end
 end

data/lib/zippo/central_directory_reader.rb

@@ -25,19 +25,20 @@ module Zippo
 
       scan_from = @io.size - EndCdRecord::MAX_COMMENT_LENGTH
       scan_from = 0 if scan_from < 0
-      scan_from + (read_from(scan_from).rindex(EndCdRecord::PACKED_SIGNATURE) or raise "End of Central Directory Record not found")
+      scan_from + (read_from(scan_from).rindex(EndCdRecord::PACKED_SIGNATURE) or fail "End of Central Directory Record not found")
     end
 
     private
+
     # reads size from the specified offset
     # if offset is negative, will offset from EOF
-    def read size, offset
+    def read(size, offset)
       @io.seek offset, (offset < 0 ? IO::SEEK_END : IO::SEEK_SET)
       @io.read size
     end
 
     # reads from the specified offset until EOF
-    def read_from offset
+    def read_from(offset)
       read nil, offset
     end
   end

data/lib/zippo/end_cd_record.rb

@@ -5,17 +5,17 @@ module Zippo
   class EndCdRecord
     SIGNATURE = 0x06054b50
     PACKED_SIGNATURE = [SIGNATURE].pack('L')
-    MAX_COMMENT_LENGTH = 1<<16
+    MAX_COMMENT_LENGTH = 1 << 16
     binary_structure do
-      field :signature, 'L', :signature => SIGNATURE
-      field :disk, 'S', :default => 0
-      field :cd_disk, 'S', :default => 0
+      field :signature, 'L', signature: SIGNATURE
+      field :disk, 'S', default: 0
+      field :cd_disk, 'S', default: 0
       field :records, 'S'
       field :total_records, 'S'
       field :cd_size, 'L'
       field :cd_offset, 'L'
-      field :comment_length, 'S', :default => 0
-      field :comment, 'a*', :default => "", :size => :comment_length
+      field :comment_length, 'S', default: 0
+      field :comment, 'a*', default: "", size: :comment_length
     end
   end
 end

data/lib/zippo/filter/base.rb

@@ -7,10 +7,11 @@ module Zippo
       BLOCK_SIZE = 131072
       module ClassMethods
         def filters
-          @filters_hash ||= Hash[@filters.map{|u| [u::METHOD, u]}]
+          @filters_hash ||= Hash[@filters.map { |u| [u::METHOD, u] }]
         end
+
         def for(method)
-          filters[method] or raise "unknown compression method #{method}"
+          filters[method] or fail "unknown compression method #{method}"
         end
 
         def inherited(klass)

data/lib/zippo/filter/compressor.rb

@@ -21,22 +21,22 @@ module Zippo::Filter
       @io = io
     end
 
-    def read count = nil, buf = nil
+    def read(count = nil, buf = nil)
       @io.read count, buf
     end
 
-    def compress_to io
+    def compress_to(io)
       data_size = 0
       compressed_size = 0
       crc32 = 0
       buf = ""
-      while (read BLOCK_SIZE, buf)
+      while read BLOCK_SIZE, buf
         data_size += buf.bytesize
         compressed_size += io.write filter(buf)
         crc32 = Zlib.crc32(buf, crc32)
       end
       compressed_size += io.write tail_filter
-      return compressed_size, data_size, crc32
+      [compressed_size, data_size, crc32]
     end
   end
 end

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

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

data/lib/zippo/filter/null_filters.rb

@@ -3,6 +3,7 @@ module Zippo
     # Mixin for a no-op filter.
     module NullFilters
       protected
+
       def filter(buf)
         buf
       end