rubocop 1.4.1 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 559e608f152814f5300bb7abd0b4c3e094ae53149f9f99a4cef8c4b6dd0da2ab
-  data.tar.gz: fbee2cd4b7cf20eca1eeec13f67b43b32483a0c8b11c17829f705c9c529446f0
+  metadata.gz: ae0bcfc68121984fb71e933b1a00aa8d418d99dd4005cce76e986d6c387c0e50
+  data.tar.gz: '0465797f84ca499f634aac95e745a4192bb62d68f5d935b4a7e21b925893b131'
 SHA512:
-  metadata.gz: b9dd79f49f7bca665d5e9d05cc6e41a6ba5cdff9f4392b9ed5d8a25ec714966b661d8bfef677087cbd4b3ec29c55afb3dbe08e00ffbd7df34385f1ca60ec1312
-  data.tar.gz: e36d6e3f839d586fd2776767eb4eff2228c5378f90a56726497b5cc37b1b890f1da33d0c76b47cbfdb3e141debb5eeaee63f41914d03cbd2d2cd819361f5301e
+  metadata.gz: eb0e28d3926209e380aed52e134801e3e206cf9ca1bace01e133223ddfe37507a888a70b629cefb7711951eaffd089078daa0a7065cf0730ccfd79febe80f1ff
+  data.tar.gz: 17fcb97b537f9529a5bb484d85f5873f1745905712472586550f463cf689465f12aaa291efcf9371babc17b8ca7e5b2d5a99d7f6a46c800fdb3dba8dca58989e

data/README.md

@@ -51,7 +51,7 @@ To prevent an unwanted RuboCop update you might want to use a conservative versi
 in your `Gemfile`:
 
 ```rb
-gem 'rubocop', '~> 1.4', require: false
+gem 'rubocop', '~> 1.6', require: false
 ```
 
 See [versioning](https://docs.rubocop.org/rubocop/1.0/versioning.html) for further details.

data/config/default.yml

@@ -139,6 +139,16 @@ AllCops:
   # from the lock file.) If the Ruby version is still unresolved, RuboCop will
   # use the oldest officially supported Ruby version (currently Ruby 2.4).
   TargetRubyVersion: ~
+  # Determines if a notification for extension libraries should be shown when
+  # rubocop is run. Keys are the name of the extension, and values are an array
+  # of gems in the Gemfile that the extension is suggested for, if not already
+  # included.
+  SuggestExtensions:
+    rubocop-rails: [rails]
+    rubocop-rspec: [rspec, rspec-rails]
+    rubocop-minitest: [minitest]
+    rubocop-sequel: [sequel]
+    rubocop-rake: [rake]
 
 #################### Bundler ###############################
 
@@ -459,7 +469,7 @@ Layout/EmptyLineAfterMultilineCondition:
     - https://github.com/airbnb/ruby#multiline-if-newline
 
 Layout/EmptyLineBetweenDefs:
-  Description: 'Use empty lines between defs.'
+  Description: 'Use empty lines between class/module/method defs.'
   StyleGuide: '#empty-lines-between-methods'
   Enabled: true
   VersionAdded: '0.49'
@@ -1998,6 +2008,23 @@ Lint/UnderscorePrefixedVariableName:
   VersionAdded: '0.21'
   AllowKeywordBlockArguments: false
 
+Lint/UnexpectedBlockArity:
+  Description: 'Looks for blocks that have fewer arguments that the calling method expects.'
+  Enabled: pending
+  Safe: false
+  VersionAdded: '1.5'
+  Methods:
+    chunk_while: 2
+    each_with_index: 2
+    each_with_object: 2
+    inject: 2
+    max: 2
+    min: 2
+    minmax: 2
+    reduce: 2
+    slice_when: 2
+    sort: 2
+
 Lint/UnifiedInteger:
   Description: 'Use Integer instead of Fixnum or Bignum.'
   Enabled: true
@@ -2007,6 +2034,7 @@ Lint/UnmodifiedReduceAccumulator:
   Description: Checks for `reduce` or `inject` blocks that do not update the accumulator each iteration.
   Enabled: pending
   VersionAdded: '1.1'
+  VersionChanged: '1.5'
 
 Lint/UnreachableCode:
   Description: 'Unreachable code.'
@@ -2110,21 +2138,23 @@ Metrics/AbcSize:
     - https://en.wikipedia.org/wiki/ABC_Software_Metric
   Enabled: true
   VersionAdded: '0.27'
-  VersionChanged: '0.81'
+  VersionChanged: '1.5'
   # The ABC size is a calculated magnitude, so this number can be an Integer or
   # a Float.
   IgnoredMethods: []
+  CountRepeatedAttributes: true
   Max: 17
 
 Metrics/BlockLength:
   Description: 'Avoid long blocks with many lines.'
   Enabled: true
   VersionAdded: '0.44'
-  VersionChanged: '0.87'
+  VersionChanged: '1.5'
   CountComments: false  # count full line comments?
   Max: 25
   CountAsOne: []
-  ExcludedMethods:
+  ExcludedMethods: [] # deprecated, retained for backwards compatibility
+  IgnoredMethods:
     # By default, exclude the `#refine` method, as it tends to have larger
     # associated blocks.
     - refine
@@ -2165,11 +2195,12 @@ Metrics/MethodLength:
   StyleGuide: '#short-methods'
   Enabled: true
   VersionAdded: '0.25'
-  VersionChanged: '0.87'
+  VersionChanged: '1.5'
   CountComments: false  # count full line comments?
   Max: 10
   CountAsOne: []
-  ExcludedMethods: []
+  ExcludedMethods: [] # deprecated, retained for backwards compatibility
+  IgnoredMethods: []
 
 Metrics/ModuleLength:
   Description: 'Avoid modules longer than 100 lines of code.'
@@ -2185,8 +2216,10 @@ Metrics/ParameterLists:
   StyleGuide: '#too-many-params'
   Enabled: true
   VersionAdded: '0.25'
+  VersionChanged: '1.5'
   Max: 5
   CountKeywordArgs: true
+  MaxOptionalParameters: 3
 
 Metrics/PerceivedComplexity:
   Description: >-
@@ -2456,7 +2489,7 @@ Naming/VariableNumber:
   StyleGuide: '#snake-case-symbols-methods-vars-with-numbers'
   Enabled: true
   VersionAdded: '0.50'
-  VersionChanged: '1.3'
+  VersionChanged: '1.4'
   EnforcedStyle: normalcase
   SupportedStyles:
     - snake_case
@@ -2464,7 +2497,13 @@ Naming/VariableNumber:
     - non_integer
   CheckMethodNames: true
   CheckSymbols: true
-  AllowedIdentifiers: []
+  AllowedIdentifiers:
+    - capture3     # Open3.capture3
+    - iso8601      # Time#iso8601
+    - rfc1123_date # CGI.rfc1123_date
+    - rfc822       # Time#rfc822
+    - rfc2822      # Time#rfc2822
+    - rfc3339      # DateTime.rfc3339
 
 #################### Security ##############################
 
@@ -3170,9 +3209,10 @@ Style/ExponentialNotation:
 Style/FloatDivision:
   Description: 'For performing float division, coerce one side only.'
   StyleGuide: '#float-division'
-  Reference: 'https://github.com/rubocop-hq/ruby-style-guide/issues/628'
+  Reference: 'https://blog.rubystyle.guide/ruby/2019/06/21/float-division.html'
   Enabled: true
   VersionAdded: '0.72'
+  VersionChanged: '1.6'
   EnforcedStyle: single_coerce
   SupportedStyles:
     - left_coerce
@@ -3986,6 +4026,7 @@ Style/RedundantArgument:
   Enabled: pending
   Safe: false
   VersionAdded: '1.4'
+  VersionChanged: '1.6'
   Methods:
     # Array#join
     join: ''
@@ -4233,7 +4274,7 @@ Style/SingleLineBlockParams:
   Description: 'Enforces the names of some block params.'
   Enabled: false
   VersionAdded: '0.16'
-  VersionChanged: '0.47'
+  VersionChanged: '1.6'
   Methods:
     - reduce:
         - acc
@@ -4262,6 +4303,7 @@ Style/SoleNestedConditional:
                   which can be merged into outer conditional node.
   Enabled: true
   VersionAdded: '0.89'
+  VersionChanged: '1.5'
   AllowModifier: false
 
 Style/SpecialGlobalVars:
@@ -4305,6 +4347,7 @@ Style/StringConcatenation:
   Enabled: true
   Safe: false
   VersionAdded: '0.89'
+  VersionChanged: '1.6'
 
 Style/StringHashKeys:
   Description: 'Prefer symbols instead of strings as hash keys.'
@@ -4394,7 +4437,7 @@ Style/SymbolProc:
   Enabled: true
   Safe: false
   VersionAdded: '0.26'
-  VersionChanged: '0.64'
+  VersionChanged: '1.5'
   # A list of method names to be ignored by the check.
   # The names should be fairly unique, otherwise you'll end up ignoring lots of code.
   IgnoredMethods:

data/config/obsoletion.yml

@@ -0,0 +1,196 @@
+# Configuration of obsolete/deprecated cops used by `ConfigObsoletion`
+
+# Cops that were renamed
+renamed:
+  Layout/AlignArguments: Layout/ArgumentAlignment
+  Layout/AlignArray: Layout/ArrayAlignment
+  Layout/AlignHash: Layout/HashAlignment
+  Layout/AlignParameters: Layout/ParameterAlignment
+  Layout/IndentArray: Layout/FirstArrayElementIndentation
+  Layout/IndentAssignment: Layout/AssignmentIndentation
+  Layout/IndentFirstArgument: Layout/FirstArgumentIndentation
+  Layout/IndentFirstArrayElement: Layout/FirstArrayElementIndentation
+  Layout/IndentFirstHashElement: Layout/FirstHashElementIndentation
+  Layout/IndentFirstParameter: Layout/FirstParameterIndentation
+  Layout/IndentHash: Layout/FirstHashElementIndentation
+  Layout/IndentHeredoc: Layout/HeredocIndentation
+  Layout/LeadingBlankLines: Layout/LeadingEmptyLines
+  Layout/Tab: Layout/IndentationStyle
+  Layout/TrailingBlankLines: Layout/TrailingEmptyLines
+  Lint/BlockAlignment: Layout/BlockAlignment
+  Lint/DefEndAlignment: Layout/DefEndAlignment
+  Lint/DuplicatedKey: Lint/DuplicateHashKey
+  Lint/EndAlignment: Layout/EndAlignment
+  Lint/EndInMethod: Style/EndBlock
+  Lint/Eval: Security/Eval
+  Lint/HandleExceptions: Lint/SuppressedException
+  Lint/MultipleCompare: Lint/MultipleComparison
+  Lint/StringConversionInInterpolation: Lint/RedundantStringCoercion
+  Lint/UnneededCopDisableDirective: Lint/RedundantCopDisableDirective
+  Lint/UnneededCopEnableDirective: Lint/RedundantCopEnableDirective
+  Lint/UnneededRequireStatement: Lint/RedundantRequireStatement
+  Lint/UnneededSplatExpansion: Lint/RedundantSplatExpansion
+  Metrics/LineLength: Layout/LineLength
+  Naming/UncommunicativeBlockParamName: Naming/BlockParameterName
+  Naming/UncommunicativeMethodParamName: Naming/MethodParameterName
+  Style/AccessorMethodName: Naming/AccessorMethodName
+  Style/AsciiIdentifiers: Naming/AsciiIdentifiers
+  Style/ClassAndModuleCamelCase: Naming/ClassAndModuleCamelCase
+  Style/ConstantName: Naming/ConstantName
+  Style/DeprecatedHashMethods: Style/PreferredHashMethods
+  Style/FileName: Naming/FileName
+  Style/FlipFlop: Lint/FlipFlop
+  Style/MethodCallParentheses: Style/MethodCallWithoutArgsParentheses
+  Style/MethodName: Naming/MethodName
+  Style/OpMethod: Naming/BinaryOperatorParameterName
+  Style/PredicateName: Naming/PredicateName
+  Style/SingleSpaceBeforeFirstArg: Layout/SpaceBeforeFirstArg
+  Style/UnneededCapitalW: Style/RedundantCapitalW
+  Style/UnneededCondition: Style/RedundantCondition
+  Style/UnneededInterpolation: Style/RedundantInterpolation
+  Style/UnneededPercentQ: Style/RedundantPercentQ
+  Style/UnneededSort: Style/RedundantSort
+  Style/VariableName: Naming/VariableName
+  Style/VariableNumber: Naming/VariableNumber
+
+# Cops that were removed
+removed:
+  Layout/SpaceAfterControlKeyword:
+    alternatives: Layout/SpaceAroundKeyword
+  Layout/SpaceBeforeModifierKeyword:
+    alternatives: Layout/SpaceAroundKeyword
+  Lint/InvalidCharacterLiteral:
+    reason: it was never being actually triggered
+  Lint/RescueWithoutErrorClass:
+    alternatives: Style/RescueStandardError
+  Lint/SpaceBeforeFirstArg:
+    reason: >
+      it was a duplicate of `Layout/SpaceBeforeFirstArg`. Please use
+      `Layout/SpaceBeforeFirstArg` instead
+  Lint/UselessComparison:
+    reason: >
+      it has been superseded by
+      `Lint/BinaryOperatorWithIdenticalOperands`. Please use
+      `Lint/BinaryOperatorWithIdenticalOperands` instead
+  Style/BracesAroundHashParameters: true
+  Style/MethodMissingSuper:
+    reason: >
+      it has been superseded by `Lint/MissingSuper`. Please use
+      `Lint/MissingSuper` instead
+  Style/SpaceAfterControlKeyword:
+    alternatives: Layout/SpaceAroundKeyword
+  Style/SpaceBeforeModifierKeyword:
+    alternatives: Layout/SpaceAroundKeyword
+  Style/TrailingComma:
+    alternatives:
+      - Style/TrailingCommaInArguments
+      - Style/TrailingCommaInArrayLiteral
+      - Style/TrailingCommaInHashLiteral
+  Style/TrailingCommaInLiteral:
+    alternatives:
+      - Style/TrailingCommaInArrayLiteral
+      - Style/TrailingCommaInHashLiteral
+
+# Cops split into multiple other cops
+split:
+  Style/MethodMissing:
+    alternatives:
+      - Style/MethodMissingSuper
+      - Style/MissingRespondToMissing
+
+# Cops that were extracted into a different gem
+extracted:
+  Performance/*: rubocop-performance
+  Rails/*: rubocop-rails
+
+# Cop parameters that have been changed
+# Can be treated as a warning instead of a failure with `severity: warning`
+changed_parameters:
+  - cops:
+      - Layout/SpaceAroundOperators
+      - Style/SpaceAroundOperators
+    parameters: MultiSpaceAllowedForOperators
+    reason: >
+      If your intention was to allow extra spaces for alignment, please
+      use `AllowForAlignment: true` instead.
+  - cops: Style/Encoding
+    parameters:
+      - EnforcedStyle
+      - SupportedStyles
+      - AutoCorrectEncodingComment
+    reason: '`Style/Encoding` no longer supports styles. The "never" behavior is always assumed.'
+  - cops: Style/IfUnlessModifier
+    parameters: MaxLineLength
+    reason: >
+      `Style/IfUnlessModifier: MaxLineLength` has been removed.
+      Use `Layout/LineLength: Max` instead
+  - cops: Style/WhileUntilModifier
+    parameters: MaxLineLength
+    reason: >
+      `Style/WhileUntilModifier: MaxLineLength` has been removed.
+      Use `Layout/LineLength: Max` instead
+  - cops: AllCops
+    parameters: RunRailsCops
+    reason: |-
+      Use the following configuration instead:
+      Rails:
+        Enabled: true
+  - cops: Layout/CaseIndentation
+    parameters: IndentWhenRelativeTo
+    alternative: EnforcedStyle
+  - cops:
+      - Lint/BlockAlignment
+      - Layout/BlockAlignment
+      - Lint/EndAlignment
+      - Layout/EndAlignment
+      - Lint/DefEndAlignment
+      - Layout/DefEndAlignment
+    parameters: AlignWith
+    alternative: EnforcedStyleAlignWith
+  - cops: Rails/UniqBeforePluck
+    parameters: EnforcedMode
+    alternative: EnforcedStyle
+  - cops: Style/MethodCallWithArgsParentheses
+    parameters: IgnoredMethodPatterns
+    alternative: IgnoredPatterns
+  - cops:
+      - Performance/Count
+      - Performance/Detect
+    parameters: SafeMode
+    reason: "`SafeMode` has been removed. Use `SafeAutoCorrect` instead."
+  - cops: Bundler/GemComment
+    parameters: Whitelist
+    alternative: IgnoredGems
+  - cops:
+      - Lint/SafeNavigationChain
+      - Lint/SafeNavigationConsistency
+      - Style/NestedParenthesizedCalls
+      - Style/SafeNavigation
+      - Style/TrivialAccessors
+    parameters: Whitelist
+    alternative: AllowedMethods
+  - cops: Style/IpAddresses
+    parameters: Whitelist
+    alternative: AllowedAddresses
+  - cops: Naming/HeredocDelimiterNaming
+    parameters: Blacklist
+    alternative: ForbiddenDelimiters
+  - cops: Naming/PredicateName
+    parameters: NamePrefixBlacklist
+    alternative: ForbiddenPrefixes
+  - cops: Naming/PredicateName
+    parameters: NameWhitelist
+    alternative: AllowedMethods
+  - cops:
+      - Metrics/BlockLength
+      - Metrics/MethodLength
+    parameters: ExcludedMethods
+    alternative: IgnoredMethods
+    severity: warning
+
+# Enforced styles that have been removed or replaced
+changed_enforced_styles:
+  - cops: Layout/IndentationConsistency
+    parameters: EnforcedStyle
+    value: rails
+    alternative: indented_internal_methods

data/lib/rubocop.rb

@@ -18,6 +18,7 @@ require_relative 'rubocop/ext/regexp_node'
 require_relative 'rubocop/ext/regexp_parser'
 
 require_relative 'rubocop/core_ext/string'
+require_relative 'rubocop/core_ext/hash'
 require_relative 'rubocop/ext/processed_source'
 
 require_relative 'rubocop/path_util'
@@ -88,6 +89,7 @@ require_relative 'rubocop/cop/mixin/interpolation'
 require_relative 'rubocop/cop/mixin/line_length_help'
 require_relative 'rubocop/cop/mixin/match_range'
 require_relative 'rubocop/cop/metrics/utils/repeated_csend_discount'
+require_relative 'rubocop/cop/metrics/utils/repeated_attribute_discount'
 require_relative 'rubocop/cop/mixin/method_complexity'
 require_relative 'rubocop/cop/mixin/method_preference'
 require_relative 'rubocop/cop/mixin/min_body_length'
@@ -341,6 +343,7 @@ require_relative 'rubocop/cop/lint/to_json'
 require_relative 'rubocop/cop/lint/top_level_return_with_argument'
 require_relative 'rubocop/cop/lint/trailing_comma_in_attribute_declaration'
 require_relative 'rubocop/cop/lint/underscore_prefixed_variable_name'
+require_relative 'rubocop/cop/lint/unexpected_block_arity'
 require_relative 'rubocop/cop/lint/unified_integer'
 require_relative 'rubocop/cop/lint/unmodified_reduce_accumulator'
 require_relative 'rubocop/cop/lint/unreachable_code'
@@ -629,9 +632,19 @@ require_relative 'rubocop/cached_data'
 require_relative 'rubocop/config'
 require_relative 'rubocop/config_loader_resolver'
 require_relative 'rubocop/config_loader'
+require_relative 'rubocop/config_obsoletion/rule'
+require_relative 'rubocop/config_obsoletion/cop_rule'
+require_relative 'rubocop/config_obsoletion/parameter_rule'
+require_relative 'rubocop/config_obsoletion/changed_enforced_styles'
+require_relative 'rubocop/config_obsoletion/changed_parameter'
+require_relative 'rubocop/config_obsoletion/extracted_cop'
+require_relative 'rubocop/config_obsoletion/removed_cop'
+require_relative 'rubocop/config_obsoletion/renamed_cop'
+require_relative 'rubocop/config_obsoletion/split_cop'
 require_relative 'rubocop/config_obsoletion'
 require_relative 'rubocop/config_store'
 require_relative 'rubocop/config_validator'
+require_relative 'rubocop/lockfile'
 require_relative 'rubocop/target_finder'
 require_relative 'rubocop/directive_comment'
 require_relative 'rubocop/comment_config'
@@ -646,6 +659,7 @@ require_relative 'rubocop/cli/command/auto_genenerate_config'
 require_relative 'rubocop/cli/command/execute_runner'
 require_relative 'rubocop/cli/command/init_dotfile'
 require_relative 'rubocop/cli/command/show_cops'
+require_relative 'rubocop/cli/command/suggest_extensions'
 require_relative 'rubocop/cli/command/version'
 require_relative 'rubocop/config_regeneration'
 require_relative 'rubocop/options'