fix rubocop Style/StringLiterals cop

rubyzip · simonoff · Jun 8, 2015 · Mar 20, 2015 · Mar 20, 2015 · Mar 20, 2015
commit b93ef1266f3e974a81b06c558bf94c2c70e16d05
diff --git a/.rubocop_rubyzip.yml b/.rubocop_rubyzip.yml
@@ -340,12 +340,6 @@ Style/SpaceInsideParens:
 Style/SpecialGlobalVars:
   Enabled: false
 
-# Offense count: 1005
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/StringLiterals:
-  Enabled: false
-
 # Offense count: 22
 # Cop supports --auto-correct.
 # Configuration parameters: IgnoredMethods.

diff --git a/lib/zip/central_directory.rb b/lib/zip/central_directory.rb
@@ -96,7 +96,7 @@ def read_64_e_o_c_d(buf) #:nodoc:
       @size_in_bytes                                = Entry.read_zip_64_long(buf)
       @cdir_offset                                  = Entry.read_zip_64_long(buf)
       @zip_64_extensible                            = buf.slice!(0, buf.bytesize)
-      raise Error, "Zip consistency problem while reading eocd structure" unless buf.size == 0
+      raise Error, 'Zip consistency problem while reading eocd structure' unless buf.size == 0
     end
 
     def read_e_o_c_d(buf) #:nodoc:
@@ -113,14 +113,14 @@ def read_e_o_c_d(buf) #:nodoc:
                                                       else
                                                         buf.read(comment_length)
                                                       end
-      raise Error, "Zip consistency problem while reading eocd structure" unless buf.size == 0
+      raise Error, 'Zip consistency problem while reading eocd structure' unless buf.size == 0
     end
 
     def read_central_directory_entries(io) #:nodoc:
       begin
         io.seek(@cdir_offset, IO::SEEK_SET)
       rescue Errno::EINVAL
-        raise Error, "Zip consistency problem while reading central directory entry"
+        raise Error, 'Zip consistency problem while reading central directory entry'
       end
       @entry_set = EntrySet.new
       @size.times do
@@ -140,7 +140,7 @@ def read_from_stream(io) #:nodoc:
 
     def get_e_o_c_d(buf) #:nodoc:
       sig_index = buf.rindex([END_OF_CDS].pack('V'))
-      raise Error, "Zip end of central directory signature not found" unless sig_index
+      raise Error, 'Zip end of central directory signature not found' unless sig_index
       buf = buf.slice!((sig_index + 4)..(buf.bytesize))
 
       def buf.read(count)
@@ -165,9 +165,9 @@ def start_buf(io)
 
     def get_64_e_o_c_d(buf) #:nodoc:
       zip_64_start = buf.rindex([ZIP64_END_OF_CDS].pack('V'))
-      raise Error, "Zip64 end of central directory signature not found" unless zip_64_start
+      raise Error, 'Zip64 end of central directory signature not found' unless zip_64_start
       zip_64_locator = buf.rindex([ZIP64_EOCD_LOCATOR].pack('V'))
-      raise Error, "Zip64 end of central directory signature locator not found" unless zip_64_locator
+      raise Error, 'Zip64 end of central directory signature locator not found' unless zip_64_locator
       buf = buf.slice!((zip_64_start + 4)..zip_64_locator)
 
       def buf.read(count)

diff --git a/lib/zip/crypto/traditional_encryption.rb b/lib/zip/crypto/traditional_encryption.rb
@@ -46,15 +46,15 @@ def header(mtime)
         end
         header << (mtime.to_binary_dos_time & 0xff)
         header << (mtime.to_binary_dos_time >> 8)
-      end.map{|x| encode x}.pack("C*")
+      end.map{|x| encode x}.pack('C*')
     end
 
     def encrypt(data)
-      data.unpack("C*").map{|x| encode x}.pack("C*")
+      data.unpack('C*').map{|x| encode x}.pack('C*')
     end
 
     def data_descriptor(crc32, compressed_size, uncomprssed_size)
-      [0x08074b50, crc32, compressed_size, uncomprssed_size].pack("VVVV")
+      [0x08074b50, crc32, compressed_size, uncomprssed_size].pack('VVVV')
     end
 
     def reset!
@@ -74,7 +74,7 @@ class TraditionalDecrypter < Decrypter
     include TraditionalEncryption
 
     def decrypt(data)
-      data.unpack("C*").map{|x| decode x}.pack("C*")
+      data.unpack('C*').map{|x| decode x}.pack('C*')
     end
 
     def reset!(header)

diff --git a/lib/zip/entry.rb b/lib/zip/entry.rb
@@ -223,7 +223,7 @@ def read_local_entry(io) #:nodoc:all
       static_sized_fields_buf = io.read(::Zip::LOCAL_ENTRY_STATIC_HEADER_LENGTH) || ''
 
       unless static_sized_fields_buf.bytesize == ::Zip::LOCAL_ENTRY_STATIC_HEADER_LENGTH
-        raise Error, "Premature end of file. Not enough data for zip entry local header"
+        raise Error, 'Premature end of file. Not enough data for zip entry local header'
       end
 
       unpack_local_entry(static_sized_fields_buf)
@@ -239,7 +239,7 @@ def read_local_entry(io) #:nodoc:all
       @name.gsub!('\\', '/')
 
       if extra && extra.bytesize != @extra_length
-        raise ::Zip::Error, "Truncated local zip entry header"
+        raise ::Zip::Error, 'Truncated local zip entry header'
       else
         if ::Zip::ExtraField === @extra
           @extra.merge(extra)
@@ -345,7 +345,7 @@ def check_c_dir_entry_signature
 
     def check_c_dir_entry_comment_size
       unless @comment && @comment.bytesize == @comment_length
-        raise ::Zip::Error, "Truncated cdir zip entry header"
+        raise ::Zip::Error, 'Truncated cdir zip entry header'
       end
     end
 
@@ -557,7 +557,7 @@ def get_raw_input_stream(&block)
       if @zipfile.is_a?(::IO) || @zipfile.is_a?(::StringIO)
         yield @zipfile
       else
-        ::File.open(@zipfile, "rb", &block)
+        ::File.open(@zipfile, 'rb', &block)
       end
     end
 
@@ -570,15 +570,15 @@ def clean_up
     def set_time(binary_dos_date, binary_dos_time)
       @time = ::Zip::DOSTime.parse_binary_dos_format(binary_dos_date, binary_dos_time)
     rescue ArgumentError
-      puts "Invalid date/time in zip entry" if ::Zip.warn_invalid_date
+      puts 'Invalid date/time in zip entry' if ::Zip.warn_invalid_date
     end
 
     def create_file(dest_path, _continue_on_exists_proc = proc { Zip.continue_on_exists_proc })
       if ::File.exist?(dest_path) && !yield(self, dest_path)
         raise ::Zip::DestinationFileExistsError,
               "Destination '#{dest_path}' already exists"
       end
-      ::File.open(dest_path, "wb") do |os|
+      ::File.open(dest_path, 'wb') do |os|
         get_input_stream do |is|
           set_extra_attributes_on_path(dest_path)
 
@@ -598,7 +598,7 @@ def create_directory(dest_path)
         else
           raise ::Zip::DestinationFileExistsError,
                 "Cannot create directory '#{dest_path}'. "+
-                  "A file already exists with that name"
+                  'A file already exists with that name'
         end
       end
       ::FileUtils.mkdir_p(dest_path)
@@ -623,12 +623,12 @@ def create_symlink(dest_path)
           else
             raise ::Zip::DestinationFileExistsError,
                   "Cannot create symlink '#{dest_path}'. "+
-                    "A symlink already exists with that name"
+                    'A symlink already exists with that name'
           end
         else
           raise ::Zip::DestinationFileExistsError,
                 "Cannot create symlink '#{dest_path}'. "+
-                  "A file already exists with that name"
+                  'A file already exists with that name'
         end
       end
 

diff --git a/lib/zip/extra_field/generic.rb b/lib/zip/extra_field/generic.rb
@@ -7,7 +7,7 @@ def self.register_map
     end
 
     def self.name
-      @name ||= self.to_s.split("::")[-1]
+      @name ||= self.to_s.split('::')[-1]
     end
 
     # return field [size, content] or false
@@ -16,10 +16,10 @@ def initial_parse(binstr)
         # If nil, start with empty.
         return false
       elsif binstr[0, 2] != self.class.const_get(:HEADER_ID)
-        $stderr.puts "Warning: weired extra feild header ID. skip parsing"
+        $stderr.puts 'Warning: weired extra feild header ID. skip parsing'
         return false
       end
-      [binstr[2, 2].unpack("v")[0], binstr[4..-1]]
+      [binstr[2, 2].unpack('v')[0], binstr[4..-1]]
     end
 
     def ==(other)
@@ -32,12 +32,12 @@ def ==(other)
 
     def to_local_bin
       s = pack_for_local
-      self.class.const_get(:HEADER_ID) + [s.bytesize].pack("v") << s
+      self.class.const_get(:HEADER_ID) + [s.bytesize].pack('v') << s
     end
 
     def to_c_dir_bin
       s = pack_for_c_dir
-      self.class.const_get(:HEADER_ID) + [s.bytesize].pack("v") << s
+      self.class.const_get(:HEADER_ID) + [s.bytesize].pack('v') << s
     end
   end
 end
diff --git a/lib/zip/extra_field/ntfs.rb b/lib/zip/extra_field/ntfs.rb
@@ -27,7 +27,7 @@ def merge(binstr)
 
       tag1 = tags[1]
       if tag1
-        ntfs_mtime, ntfs_atime, ntfs_ctime = tag1.unpack("Q<Q<Q<")
+        ntfs_mtime, ntfs_atime, ntfs_ctime = tag1.unpack('Q<Q<Q<')
         ntfs_mtime && @mtime ||= from_ntfs_time(ntfs_mtime)
         ntfs_atime && @atime ||= from_ntfs_time(ntfs_atime)
         ntfs_ctime && @ctime ||= from_ntfs_time(ntfs_ctime)
@@ -48,7 +48,7 @@ def pack_for_local
     # But 7-zip for Windows only stores at central dir
     def pack_for_c_dir
       # reserved 0 and tag 1
-      s = [0, 1].pack("Vv")
+      s = [0, 1].pack('Vv')
 
       tag1 = ''.force_encoding(Encoding::BINARY)
       if @mtime

diff --git a/lib/zip/extra_field/old_unix.rb b/lib/zip/extra_field/old_unix.rb
@@ -1,7 +1,7 @@
 module Zip
   # Olf Info-ZIP Extra for UNIX uid/gid and file timestampes
   class ExtraField::OldUnix < ExtraField::Generic
-    HEADER_ID = "UX"
+    HEADER_ID = 'UX'
     register_map
 
     def initialize(binstr = nil)
@@ -19,7 +19,7 @@ def merge(binstr)
       size, content = initial_parse(binstr)
       # size: 0 for central directory. 4 for local header
       return if (!size || size == 0)
-      atime, mtime, uid, gid = content.unpack("VVvv")
+      atime, mtime, uid, gid = content.unpack('VVvv')
       @uid ||= uid
       @gid ||= gid
       @atime ||= atime
@@ -34,11 +34,11 @@ def ==(other)
     end
 
     def pack_for_local
-      [@atime, @mtime, @uid, @gid].pack("VVvv")
+      [@atime, @mtime, @uid, @gid].pack('VVvv')
     end
 
     def pack_for_c_dir
-      [@atime, @mtime].pack("VV")
+      [@atime, @mtime].pack('VV')
     end
   end
 end
diff --git a/lib/zip/extra_field/universal_time.rb b/lib/zip/extra_field/universal_time.rb
@@ -1,7 +1,7 @@
 module Zip
   # Info-ZIP Additional timestamp field
   class ExtraField::UniversalTime < ExtraField::Generic
-    HEADER_ID = "UT"
+    HEADER_ID = 'UT'
     register_map
 
     def initialize(binstr = nil)
@@ -18,7 +18,7 @@ def merge(binstr)
       return if binstr.empty?
       size, content = initial_parse(binstr)
       size || return
-      @flag, mtime, atime, ctime = content.unpack("CVVV")
+      @flag, mtime, atime, ctime = content.unpack('CVVV')
       mtime && @mtime ||= ::Zip::DOSTime.at(mtime)
       atime && @atime ||= ::Zip::DOSTime.at(atime)
       ctime && @ctime ||= ::Zip::DOSTime.at(ctime)
@@ -31,16 +31,16 @@ def ==(other)
     end
 
     def pack_for_local
-      s = [@flag].pack("C")
-      @flag & 1 != 0 && s << [@mtime.to_i].pack("V")
-      @flag & 2 != 0 && s << [@atime.to_i].pack("V")
-      @flag & 4 != 0 && s << [@ctime.to_i].pack("V")
+      s = [@flag].pack('C')
+      @flag & 1 != 0 && s << [@mtime.to_i].pack('V')
+      @flag & 2 != 0 && s << [@atime.to_i].pack('V')
+      @flag & 4 != 0 && s << [@ctime.to_i].pack('V')
       s
     end
 
     def pack_for_c_dir
-      s = [@flag].pack("C")
-      @flag & 1 == 1 && s << [@mtime.to_i].pack("V")
+      s = [@flag].pack('C')
+      @flag & 1 == 1 && s << [@mtime.to_i].pack('V')
       s
     end
   end

diff --git a/lib/zip/extra_field/unix.rb b/lib/zip/extra_field/unix.rb
@@ -1,7 +1,7 @@
 module Zip
   # Info-ZIP Extra for UNIX uid/gid
   class ExtraField::IUnix < ExtraField::Generic
-    HEADER_ID = "Ux"
+    HEADER_ID = 'Ux'
     register_map
 
     def initialize(binstr = nil)
@@ -17,7 +17,7 @@ def merge(binstr)
       size, content = initial_parse(binstr)
       # size: 0 for central directory. 4 for local header
       return if (!size || size == 0)
-      uid, gid = content.unpack("vv")
+      uid, gid = content.unpack('vv')
       @uid     ||= uid
       @gid     ||= gid
     end
@@ -27,7 +27,7 @@ def ==(other)
     end
 
     def pack_for_local
-      [@uid, @gid].pack("vv")
+      [@uid, @gid].pack('vv')
     end
 
     def pack_for_c_dir

diff --git a/lib/zip/extra_field/zip64.rb b/lib/zip/extra_field/zip64.rb
@@ -51,16 +51,16 @@ def extract(size, format)
     def pack_for_local
       # local header entries must contain original size and compressed size; other fields do not apply
       return '' unless @original_size && @compressed_size
-      [@original_size, @compressed_size].pack("Q<Q<")
+      [@original_size, @compressed_size].pack('Q<Q<')
     end
 
     def pack_for_c_dir
       # central directory entries contain only fields that didn't fit in the main entry part
       packed = ''.force_encoding('BINARY')
-      packed << [@original_size].pack("Q<") if @original_size
-      packed << [@compressed_size].pack("Q<") if @compressed_size
-      packed << [@relative_header_offset].pack("Q<") if @relative_header_offset
-      packed << [@disk_start_number].pack("V") if @disk_start_number
+      packed << [@original_size].pack('Q<') if @original_size
+      packed << [@compressed_size].pack('Q<') if @compressed_size
+      packed << [@relative_header_offset].pack('Q<') if @relative_header_offset
+      packed << [@disk_start_number].pack('V') if @disk_start_number
       packed
     end
   end

diff --git a/lib/zip/file.rb b/lib/zip/file.rb
@@ -130,7 +130,7 @@ def open_buffer(io, options = {})
         begin
           zf.write_buffer(io)
         rescue IOError => e
-          raise unless e.message == "not opened for writing"
+          raise unless e.message == 'not opened for writing'
         end
       end
 
@@ -263,7 +263,7 @@ def read(entry)
     # Convenience method for adding the contents of a file to the archive
     def add(entry, src_path, &continue_on_exists_proc)
       continue_on_exists_proc ||= proc { ::Zip.continue_on_exists_proc }
-      check_entry_exists(entry, continue_on_exists_proc, "add")
+      check_entry_exists(entry, continue_on_exists_proc, 'add')
       new_entry = entry.kind_of?(::Zip::Entry) ? entry : ::Zip::Entry.new(@name, entry.to_s)
       new_entry.gather_fileinfo_from_srcpath(src_path)
       new_entry.dirty = true
@@ -382,7 +382,7 @@ def is_directory(newEntry, srcPath)
               "entry name '#{newEntry}' indicates directory entry, but "+
                 "'#{srcPath}' is not a directory"
       elsif !newEntry.is_directory && srcPathIsDirectory
-        newEntry.name += "/"
+        newEntry.name += '/'
       end
       newEntry.is_directory && srcPathIsDirectory
     end