Class: Gitlab::Styles::Rubocop::Cop::Performance::Rubyzip

Inherits:

RuboCop::Cop::Cop

• Object
• RuboCop::Cop::Cop
• Gitlab::Styles::Rubocop::Cop::Performance::Rubyzip

Defined in:

lib/gitlab/styles/rubocop/cop/performance/rubyzip.rb

Overview

This cop flags inefficient uses of rubyzip’s Zip::File, since when instantiated it reads the file’s Central Directory into memory entirely. For zips with many files and directories, this can be very expensive even when the archive’s size in bytes is small.

See also:

• github.com/rubyzip/rubyzip/issues/506

• github.com/rubyzip/rubyzip#notes-on-zipinputstream

Constant Summary

MSG =

'Be careful when opening or iterating zip files via Zip::File. ' \
'Zip archives may contain many entries, and their file index is ' \
'read into memory upon construction, which can lead to ' \
'high memory use and poor performance. ' \
'Consider iterating archive entries via Zip::InputStream instead.'

Instance Method Summary

• #on_send(node) ⇒ Object

Instance Method Details

#on_send(node) ⇒ Object

# File 'lib/gitlab/styles/rubocop/cop/performance/rubyzip.rb', line 29

def on_send(node)
  return unless reads_central_directory?(node)

  add_offense(node)
end