rubyzip/.rubocop_todo.yml

# This configuration was generated by
# `rubocop --auto-gen-config`
# on 2021-05-23 16:31:53 UTC using RuboCop version 1.12.1.
# The point is for the user to remove these configuration records
# one by one as the offenses are removed from the code base.
# Note that changes in the inspected code, or installation of new
# versions of RuboCop, may require this file to be generated again.

# Offense count: 3
# Cop supports --auto-correct.
# Configuration parameters: AllowAliasSyntax, AllowedMethods.
# AllowedMethods: alias_method, public, protected, private
Layout/EmptyLinesAroundAttributeAccessor:
  Exclude:
    - 'lib/zip/extra_field/zip64.rb'
    - 'lib/zip/filesystem.rb'
    - 'samples/gtk_ruby_zip.rb'

# Offense count: 2
# Cop supports --auto-correct.
# Configuration parameters: IndentationWidth.
# SupportedStyles: special_inside_parentheses, consistent, align_brackets
Layout/FirstArrayElementIndentation:
  EnforcedStyle: consistent

# Offense count: 5
# Configuration parameters: AllowComments, AllowEmptyLambdas.
Lint/EmptyBlock:
  Exclude:
    - 'lib/zip/file.rb'
    - 'test/gentestfiles.rb'
    - 'test/settings_test.rb'

# Offense count: 3
# Configuration parameters: AllowComments.
Lint/EmptyClass:
  Exclude:
    - 'lib/zip/crypto/encryption.rb'
    - 'test/decompressor_test.rb'

# Offense count: 7
Lint/MissingSuper:
  Exclude:
    - 'lib/zip/extra_field.rb'
    - 'lib/zip/extra_field/ntfs.rb'
    - 'lib/zip/extra_field/old_unix.rb'
    - 'lib/zip/extra_field/universal_time.rb'
    - 'lib/zip/extra_field/unix.rb'
    - 'lib/zip/extra_field/zip64.rb'
    - 'lib/zip/extra_field/zip64_placeholder.rb'

# Offense count: 5
# Configuration parameters: CountComments, CountAsOne.
Metrics/ClassLength:
  Max: 601

# Offense count: 20
# Configuration parameters: IgnoredMethods.
Metrics/CyclomaticComplexity:
  Max: 14

# Offense count: 46
# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
Metrics/MethodLength:
  Max: 32

# Offense count: 5
# Configuration parameters: CountKeywordArgs.
Metrics/ParameterLists:
  Max: 11
  MaxOptionalParameters: 9

# Offense count: 14
# Configuration parameters: IgnoredMethods.
Metrics/PerceivedComplexity:
  Max: 15

# Offense count: 8
Naming/AccessorMethodName:
  Exclude:
    - 'lib/zip/entry.rb'
    - 'lib/zip/filesystem.rb'
    - 'lib/zip/input_stream.rb'
    - 'lib/zip/streamable_stream.rb'

# Offense count: 4
# Configuration parameters: EnforcedStyle, CheckMethodNames, CheckSymbols, AllowedIdentifiers.
# SupportedStyles: snake_case, normalcase, non_integer
# AllowedIdentifiers: capture3, iso8601, rfc1123_date, rfc822, rfc2822, rfc3339
Naming/VariableNumber:
  Exclude:
    - 'test/file_extract_test.rb'
    - 'test/file_permissions_test.rb'

# Offense count: 4
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle.
# SupportedStyles: separated, grouped
Style/AccessorGrouping:
  Exclude:
    - 'lib/zip/decompressor.rb'
    - 'lib/zip/entry.rb'

# Offense count: 7
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle.
# SupportedStyles: nested, compact
Style/ClassAndModuleChildren:
  Exclude:
    - 'lib/zip/extra_field/generic.rb'
    - 'lib/zip/extra_field/ntfs.rb'
    - 'lib/zip/extra_field/old_unix.rb'
    - 'lib/zip/extra_field/universal_time.rb'
    - 'lib/zip/extra_field/unix.rb'
    - 'lib/zip/extra_field/zip64.rb'
    - 'lib/zip/extra_field/zip64_placeholder.rb'

# Offense count: 2
# Cop supports --auto-correct.
# Configuration parameters: Keywords.
# Keywords: TODO, FIXME, OPTIMIZE, HACK, REVIEW, NOTE
Style/CommentAnnotation:
  Exclude:
    - 'test/file_test.rb'
    - 'test/zip64_full_test.rb'

# Offense count: 1
# Cop supports --auto-correct.
Style/Dir:
  Exclude:
    - 'test/file_test.rb'

# Offense count: 2
Style/DocumentDynamicEvalDefinition:
  Exclude:
    - 'test/test_helper.rb'

# Offense count: 24
# Configuration parameters: AllowedConstants.
Style/Documentation:
  Enabled: false

# Offense count: 2
# Configuration parameters: MaxUnannotatedPlaceholdersAllowed, IgnoredMethods.
# SupportedStyles: annotated, template, unannotated
Style/FormatStringToken:
  EnforcedStyle: unannotated

# Offense count: 1
# Cop supports --auto-correct.
# Configuration parameters: AllowSplatArgument.
Style/HashConversion:
  Exclude:
    - 'lib/zip/entry_set.rb'

# Offense count: 13
# Cop supports --auto-correct.
Style/IfUnlessModifier:
  Exclude:
    - 'lib/zip/entry.rb'
    - 'lib/zip/file.rb'
    - 'lib/zip/filesystem.rb'
    - 'lib/zip/pass_thru_decompressor.rb'
    - 'lib/zip/streamable_stream.rb'

# Offense count: 1
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, Autocorrect.
# SupportedStyles: module_function, extend_self, forbidden
Style/ModuleFunction:
  Exclude:
    - 'lib/zip.rb'

# Offense count: 56
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle.
# SupportedStyles: literals, strict
Style/MutableConstant:
  Enabled: false

# Offense count: 2
# Cop supports --auto-correct.
Style/NegatedIfElseCondition:
  Exclude:
    - 'samples/qtzip.rb'

# Offense count: 24
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, IgnoredMethods.
# SupportedStyles: predicate, comparison
Style/NumericPredicate:
  Exclude:
    - 'spec/**/*'
    - 'lib/zip/entry.rb'
    - 'lib/zip/extra_field/old_unix.rb'
    - 'lib/zip/extra_field/universal_time.rb'
    - 'lib/zip/extra_field/unix.rb'
    - 'lib/zip/file.rb'
    - 'lib/zip/filesystem.rb'
    - 'lib/zip/input_stream.rb'
    - 'lib/zip/ioextras.rb'
    - 'lib/zip/ioextras/abstract_input_stream.rb'
    - 'test/file_split_test.rb'
    - 'test/test_helper.rb'

# Offense count: 6
# Configuration parameters: AllowedMethods.
# AllowedMethods: respond_to_missing?
Style/OptionalBooleanParameter:
  Exclude:
    - 'lib/zip/entry.rb'
    - 'lib/zip/file.rb'
    - 'lib/zip/output_stream.rb'

# Offense count: 1
# Cop supports --auto-correct.
Style/RedundantBegin:
  Exclude:
    - 'lib/zip/dos_time.rb'

# Offense count: 1
# Cop supports --auto-correct.
Style/RedundantFileExtensionInRequire:
  Exclude:
    - 'samples/qtzip.rb'

# Offense count: 29
# Cop supports --auto-correct.
Style/RedundantRegexpEscape:
  Exclude:
    - 'Guardfile'
    - 'test/file_extract_test.rb'
    - 'test/path_traversal_test.rb'

# Offense count: 17
# Cop supports --auto-correct.
# Configuration parameters: ConvertCodeThatCanStartToReturnNil, AllowedMethods.
# AllowedMethods: present?, blank?, presence, try, try!
Style/SafeNavigation:
  Exclude:
    - 'lib/zip/entry.rb'
    - 'lib/zip/input_stream.rb'
    - 'lib/zip/output_stream.rb'
    - 'test/file_extract_test.rb'
    - 'test/filesystem/file_nonmutating_test.rb'
    - 'test/filesystem/file_stat_test.rb'
    - 'test/test_helper.rb'

# Offense count: 9
# Cop supports --auto-correct.
Style/StringConcatenation:
  Exclude:
    - 'lib/zip/filesystem.rb'
    - 'samples/gtk_ruby_zip.rb'
    - 'test/encryption_test.rb'
    - 'test/file_test.rb'
    - 'test/ioextras/abstract_input_stream_test.rb'
    - 'test/test_helper.rb'