rubocop 0.89.1 → 0.90.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3201b273ee3a04b13a9f41d768d230a5be311881c7fd0b39f24aa0d99a8a16ad
-  data.tar.gz: 794ba4bfcadcee6a8a9aae92f88c167dc1f75122e69f4bee08baa8f22976c1bf
+  metadata.gz: 39db2826fa916853dc6641e30da24937e009a06b843daf1a7cdb2eca458dfaad
+  data.tar.gz: 9a4ffd95ff0401aeee427555d1baf51517e06580becfa9243dac9c75305998aa
 SHA512:
-  metadata.gz: c2ea28c0fbfaa2f37ef651b91f38e3084fda1d8c829ebc1aaa839c793f0b759deb692bc70482d863797ab33799af9e083ab7f274f4faa905b956b4b53fbab96b
-  data.tar.gz: 2ac4b6b2e1852c4ca1df725c6de4f6d34442633cb7dea00f27499ebae6e24ad006110dd0b473c781961d6e44819039a5e5748ac0de6ec0a1b2cbceb950c3fcf2
+  metadata.gz: 7e502aeecd9ceaeec36624190f4e9b72d075eed552f2e6204e2e842db1a77758f5fd11336f01f400af45bb36b27f13885a27847b17b84595aeef90df6b0db63b
+  data.tar.gz: e7ecf12bfc331ef99870f03e034a5154765ceb93c159fdde0fdf8802609c81fa3459250eb3bf6aa7ee140d5c80958783614f5da81585ba75ad9e252afdb8fc50

data/README.md

@@ -49,7 +49,7 @@ haven't reached version 1.0 yet). To prevent an unwanted RuboCop update you
 might want to use a conservative version lock in your `Gemfile`:
 
 ```rb
-gem 'rubocop', '~> 0.89.1', require: false
+gem 'rubocop', '~> 0.90.0', require: false
 ```
 
 ## Quickstart

data/config/default.yml

@@ -399,7 +399,6 @@ Layout/DefEndAlignment:
   SupportedStylesAlignWith:
     - start_of_line
     - def
-  AutoCorrect: false
   Severity: warning
 
 Layout/DotPosition:
@@ -436,6 +435,14 @@ Layout/EmptyLineAfterMagicComment:
   Enabled: true
   VersionAdded: '0.49'
 
+Layout/EmptyLineAfterMultilineCondition:
+  Description: 'Enforces empty line after multiline condition.'
+  # This is disabled, because this style is not very common in practice.
+  Enabled: false
+  VersionAdded: '0.90'
+  Reference:
+    - https://github.com/airbnb/ruby#multiline-if-newline
+
 Layout/EmptyLineBetweenDefs:
   Description: 'Use empty lines between defs.'
   StyleGuide: '#empty-lines-between-methods'
@@ -555,7 +562,6 @@ Layout/EndAlignment:
     - keyword
     - variable
     - start_of_line
-  AutoCorrect: false
   Severity: warning
 
 Layout/EndOfLine:
@@ -1427,6 +1433,11 @@ Lint/DuplicateMethods:
   Enabled: true
   VersionAdded: '0.29'
 
+Lint/DuplicateRequire:
+  Description: 'Check for duplicate `require`s and `require_relative`s.'
+  Enabled: pending
+  VersionAdded: '0.90'
+
 Lint/DuplicateRescueException:
   Description: 'Checks that there are no repeated exceptions used in `rescue` expressions.'
   Enabled: pending
@@ -1453,13 +1464,18 @@ Lint/EmptyEnsure:
   Enabled: true
   VersionAdded: '0.10'
   VersionChanged: '0.48'
-  AutoCorrect: false
 
 Lint/EmptyExpression:
   Description: 'Checks for empty expressions.'
   Enabled: true
   VersionAdded: '0.45'
 
+Lint/EmptyFile:
+  Description: 'Enforces that Ruby source files are not empty.'
+  Enabled: pending
+  AllowComments: true
+  VersionAdded: '0.90'
+
 Lint/EmptyInterpolation:
   Description: 'Checks for empty string interpolation.'
   Enabled: true
@@ -1856,6 +1872,11 @@ Lint/TopLevelReturnWithArgument:
   Enabled: 'pending'
   VersionAdded: '0.89'
 
+Lint/TrailingCommaInAttributeDeclaration:
+  Description: 'This cop checks for trailing commas in attribute declarations.'
+  Enabled: pending
+  VersionAdded: '0.90'
+
 Lint/UnderscorePrefixedVariableName:
   Description: 'Do not use prefix `_` for a variable that is used.'
   Enabled: true
@@ -1931,6 +1952,13 @@ Lint/UselessElseWithoutRescue:
   Enabled: true
   VersionAdded: '0.17'
 
+Lint/UselessMethodDefinition:
+  Description: 'Checks for useless method definitions.'
+  Enabled: pending
+  VersionAdded: '0.90'
+  Safe: false
+  AllowComments: true
+
 Lint/UselessSetterCall:
   Description: 'Checks for useless setter call to a local variable.'
   Enabled: true
@@ -2591,6 +2619,7 @@ Style/CaseLikeIf:
   Description: 'This cop identifies places where `if-elsif` constructions can be replaced with `case-when`.'
   StyleGuide: '#case-vs-if-else'
   Enabled: 'pending'
+  Safe: false
   VersionAdded: '0.88'
 
 Style/CharacterLiteral:
@@ -2608,7 +2637,6 @@ Style/ClassAndModuleChildren:
   # have the knowledge to perform either operation safely and thus requires
   # manual oversight.
   SafeAutoCorrect: false
-  AutoCorrect: false
   Enabled: true
   VersionAdded: '0.19'
   #
@@ -2647,6 +2675,16 @@ Style/ClassMethods:
   VersionAdded: '0.9'
   VersionChanged: '0.20'
 
+Style/ClassMethodsDefinitions:
+  Description: 'Enforces using `def self.method_name` or `class << self` to define class methods.'
+  StyleGuide: '#def-self-class-methods'
+  Enabled: false
+  VersionAdded: '0.89'
+  EnforcedStyle:  def_self
+  SupportedStyles:
+    - def_self
+    - self_class
+
 Style/ClassVars:
   Description: 'Avoid the use of class variables.'
   StyleGuide: '#no-class-vars'
@@ -2687,6 +2725,14 @@ Style/ColonMethodDefinition:
   Enabled: true
   VersionAdded: '0.52'
 
+Style/CombinableLoops:
+  Description: >-
+                  Checks for places where multiple consecutive loops over the same data
+                  can be combined into a single loop.
+  Enabled: pending
+  Safe: false
+  VersionAdded: '0.90'
+
 Style/CommandLiteral:
   Description: 'Use `` or %x around command literals.'
   StyleGuide: '#percent-x'
@@ -3021,7 +3067,7 @@ Style/FrozenStringLiteralComment:
     # `never` will enforce that the frozen string literal comment does not
     # exist in a file.
     - never
-  Safe: false
+  SafeAutoCorrect: false
 
 Style/GlobalStdStream:
   Description: 'Enforces the use of `$stdout/$stderr/$stdin` instead of `STDOUT/STDERR/STDIN`.'
@@ -3101,15 +3147,17 @@ Style/HashSyntax:
   PreferHashRocketsForNonAlnumEndingSymbols: false
 
 Style/HashTransformKeys:
-  Description: 'Prefer `transform_keys` over `each_with_object` and `map`.'
+  Description: 'Prefer `transform_keys` over `each_with_object`, `map`, or `to_h`.'
   Enabled: 'pending'
   VersionAdded: '0.80'
+  VersionChanged: '0.90'
   Safe: false
 
 Style/HashTransformValues:
-  Description: 'Prefer `transform_values` over `each_with_object` and `map`.'
+  Description: 'Prefer `transform_values` over `each_with_object`, `map`, or `to_h`.'
   Enabled: 'pending'
   VersionAdded: '0.80'
+  VersionChanged: '0.90'
   Safe: false
 
 Style/IdenticalConditionalBranches:
@@ -3206,6 +3254,12 @@ Style/IpAddresses:
     - "::"
     # :: is a valid IPv6 address, but could potentially be legitimately in code
 
+Style/KeywordParametersOrder:
+  Description: 'Enforces that optional keyword parameters are placed at the end of the parameters list.'
+  StyleGuide: '#keyword-parameters-order'
+  Enabled: pending
+  VersionAdded: '0.90'
+
 Style/Lambda:
   Description: 'Use the new lambda literal syntax for single-line blocks.'
   StyleGuide: '#lambda-multi-line'
@@ -3579,7 +3633,6 @@ Style/NumericPredicate:
   # object. Switching these methods has to be done with knowledge of the types
   # of the variables which rubocop doesn't have.
   SafeAutoCorrect: false
-  AutoCorrect: false
   Enabled: true
   VersionAdded: '0.42'
   VersionChanged: '0.59'
@@ -3595,12 +3648,13 @@ Style/NumericPredicate:
 
 Style/OneLineConditional:
   Description: >-
-                 Favor the ternary operator(?:) over
-                 if/then/else/end constructs.
+                 Favor the ternary operator (?:) or multi-line constructs over
+                 single-line if/then/else/end constructs.
   StyleGuide: '#ternary-operator'
   Enabled: true
+  AlwaysCorrectToMultiline: false
   VersionAdded: '0.9'
-  VersionChanged: '0.38'
+  VersionChanged: '0.90'
 
 Style/OptionHash:
   Description: "Don't use option hashes when you can use keyword arguments."
@@ -3831,6 +3885,12 @@ Style/RedundantSelf:
   VersionAdded: '0.10'
   VersionChanged: '0.13'
 
+Style/RedundantSelfAssignment:
+  Description: 'Checks for places where redundant assignments are made for in place modification methods.'
+  Enabled: pending
+  Safe: false
+  VersionAdded: '0.90'
+
 Style/RedundantSort:
   Description: >-
                   Use `min` instead of `sort.first`,
@@ -3983,6 +4043,14 @@ Style/SlicingWithRange:
   VersionAdded: '0.83'
   Safe: false
 
+Style/SoleNestedConditional:
+  Description: >-
+                  Finds sole nested conditional nodes
+                  which can be merged into outer conditional node.
+  Enabled: pending
+  VersionAdded: '0.89'
+  AllowModifier: false
+
 Style/SpecialGlobalVars:
   Description: 'Avoid Perl-style global variables.'
   StyleGuide: '#no-cryptic-perlisms'

data/lib/rubocop.rb

@@ -9,6 +9,7 @@ require 'regexp_parser'
 require 'unicode/display_width/no_string_ext'
 require 'rubocop-ast'
 require_relative 'rubocop/ast_aliases'
+require_relative 'rubocop/ext/regexp_node'
 
 require_relative 'rubocop/version'
 
@@ -34,6 +35,7 @@ require_relative 'rubocop/cop/registry'
 require_relative 'rubocop/cop/base'
 require_relative 'rubocop/cop/cop'
 require_relative 'rubocop/cop/commissioner'
+require_relative 'rubocop/cop/documentation'
 require_relative 'rubocop/cop/corrector'
 require_relative 'rubocop/cop/force'
 require_relative 'rubocop/cop/severity'
@@ -116,6 +118,7 @@ require_relative 'rubocop/cop/mixin/trailing_comma'
 require_relative 'rubocop/cop/mixin/uncommunicative_name'
 require_relative 'rubocop/cop/mixin/unused_argument'
 require_relative 'rubocop/cop/mixin/visibility_help'
+require_relative 'rubocop/cop/mixin/comments_help' # relies on visibility_help
 
 require_relative 'rubocop/cop/utils/format_string'
 
@@ -165,6 +168,7 @@ require_relative 'rubocop/cop/layout/else_alignment'
 require_relative 'rubocop/cop/layout/empty_comment'
 require_relative 'rubocop/cop/layout/empty_line_after_guard_clause'
 require_relative 'rubocop/cop/layout/empty_line_after_magic_comment'
+require_relative 'rubocop/cop/layout/empty_line_after_multiline_condition'
 require_relative 'rubocop/cop/layout/empty_line_between_defs'
 require_relative 'rubocop/cop/layout/empty_lines_around_access_modifier'
 require_relative 'rubocop/cop/layout/empty_lines_around_arguments'
@@ -255,12 +259,14 @@ require_relative 'rubocop/cop/lint/duplicate_case_condition'
 require_relative 'rubocop/cop/lint/duplicate_elsif_condition'
 require_relative 'rubocop/cop/lint/duplicate_hash_key'
 require_relative 'rubocop/cop/lint/duplicate_methods'
+require_relative 'rubocop/cop/lint/duplicate_require'
 require_relative 'rubocop/cop/lint/duplicate_rescue_exception'
 require_relative 'rubocop/cop/lint/each_with_object_argument'
 require_relative 'rubocop/cop/lint/else_layout'
 require_relative 'rubocop/cop/lint/empty_conditional_body'
 require_relative 'rubocop/cop/lint/empty_ensure'
 require_relative 'rubocop/cop/lint/empty_expression'
+require_relative 'rubocop/cop/lint/empty_file'
 require_relative 'rubocop/cop/lint/empty_interpolation'
 require_relative 'rubocop/cop/lint/empty_when'
 require_relative 'rubocop/cop/lint/ensure_return'
@@ -320,6 +326,7 @@ require_relative 'rubocop/cop/lint/suppressed_exception'
 require_relative 'rubocop/cop/lint/syntax'
 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/unified_integer'
 require_relative 'rubocop/cop/lint/unreachable_code'
@@ -331,6 +338,7 @@ require_relative 'rubocop/cop/lint/uri_regexp'
 require_relative 'rubocop/cop/lint/useless_access_modifier'
 require_relative 'rubocop/cop/lint/useless_assignment'
 require_relative 'rubocop/cop/lint/useless_else_without_rescue'
+require_relative 'rubocop/cop/lint/useless_method_definition'
 require_relative 'rubocop/cop/lint/useless_setter_call'
 require_relative 'rubocop/cop/lint/void'
 
@@ -385,10 +393,12 @@ require_relative 'rubocop/cop/style/character_literal'
 require_relative 'rubocop/cop/style/class_and_module_children'
 require_relative 'rubocop/cop/style/class_check'
 require_relative 'rubocop/cop/style/class_methods'
+require_relative 'rubocop/cop/style/class_methods_definitions'
 require_relative 'rubocop/cop/style/class_vars'
 require_relative 'rubocop/cop/style/collection_methods'
 require_relative 'rubocop/cop/style/colon_method_call'
 require_relative 'rubocop/cop/style/colon_method_definition'
+require_relative 'rubocop/cop/style/combinable_loops'
 require_relative 'rubocop/cop/style/command_literal'
 require_relative 'rubocop/cop/style/comment_annotation'
 require_relative 'rubocop/cop/style/commented_keyword'
@@ -442,6 +452,7 @@ require_relative 'rubocop/cop/style/infinite_loop'
 require_relative 'rubocop/cop/style/inverse_methods'
 require_relative 'rubocop/cop/style/inline_comment'
 require_relative 'rubocop/cop/style/ip_addresses'
+require_relative 'rubocop/cop/style/keyword_parameters_order'
 require_relative 'rubocop/cop/style/lambda'
 require_relative 'rubocop/cop/style/lambda_call'
 require_relative 'rubocop/cop/style/line_end_concatenation'
@@ -450,6 +461,8 @@ require_relative 'rubocop/cop/style/method_call_with_args_parentheses'
 require_relative 'rubocop/cop/style/redundant_assignment'
 require_relative 'rubocop/cop/style/redundant_fetch_block'
 require_relative 'rubocop/cop/style/redundant_file_extension_in_require'
+require_relative 'rubocop/cop/style/redundant_self_assignment'
+require_relative 'rubocop/cop/style/sole_nested_conditional'
 require_relative 'rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses'
 require_relative 'rubocop/cop/style/method_call_with_args_parentheses/require_parentheses'
 require_relative 'rubocop/cop/style/method_called_on_do_end_block'

data/lib/rubocop/cached_data.rb

@@ -4,6 +4,7 @@ require 'json'
 
 module RuboCop
   # Converts RuboCop objects to and from the serialization format JSON.
+  # @api private
   class CachedData
     def initialize(filename)
       @filename = filename

data/lib/rubocop/cli/command.rb

@@ -3,6 +3,7 @@
 module RuboCop
   class CLI
     # Home of subcommands in the CLI.
+    # @api private
     module Command
       class << self
         # Find the command with a given name and run it in an environment.

data/lib/rubocop/cli/command/auto_genenerate_config.rb

@@ -4,6 +4,7 @@ module RuboCop
   class CLI
     module Command
       # Generate a configuration file acting as a TODO list.
+      # @api private
       class AutoGenerateConfig < Base
         self.command_name = :auto_gen_config
 

data/lib/rubocop/cli/command/base.rb

@@ -4,6 +4,7 @@ module RuboCop
   class CLI
     module Command
       # A subcommand in the CLI.
+      # @api private
       class Base
         attr_reader :env
 

data/lib/rubocop/cli/command/execute_runner.rb

@@ -4,6 +4,7 @@ module RuboCop
   class CLI
     module Command
       # Run all the selected cops and report the result.
+      # @api private
       class ExecuteRunner < Base
         include Formatter::TextUtil
 

data/lib/rubocop/cli/command/init_dotfile.rb

@@ -4,6 +4,7 @@ module RuboCop
   class CLI
     module Command
       # Generate a .rubocop.yml file in the current directory.
+      # @api private
       class InitDotfile < Base
         DOTFILE = ConfigLoader::DOTFILE
 

data/lib/rubocop/cli/command/show_cops.rb

@@ -5,6 +5,7 @@ module RuboCop
     module Command
       # Shows the given cops, or all cops by default, and their configurations
       # for the current directory.
+      # @api private
       class ShowCops < Base
         self.command_name = :show_cops
 

data/lib/rubocop/cli/command/version.rb

@@ -4,6 +4,7 @@ module RuboCop
   class CLI
     module Command
       # Display version.
+      # @api private
       class Version < Base
         self.command_name = :version
 

data/lib/rubocop/cli/environment.rb

@@ -3,6 +3,7 @@
 module RuboCop
   class CLI
     # Execution environment for a CLI command.
+    # @api private
     class Environment
       attr_reader :options, :config_store, :paths
 

data/lib/rubocop/comment_config.rb

@@ -4,12 +4,17 @@ module RuboCop
   # This class parses the special `rubocop:disable` comments in a source
   # and provides a way to check if each cop is enabled at arbitrary line.
   class CommentConfig
+    # @api private
     REDUNDANT_DISABLE = 'Lint/RedundantCopDisableDirective'
 
+    # @api private
     COP_NAME_PATTERN = '([A-Z]\w+/)?(?:[A-Z]\w+)'
+    # @api private
     COP_NAMES_PATTERN = "(?:#{COP_NAME_PATTERN} , )*#{COP_NAME_PATTERN}"
+    # @api private
     COPS_PATTERN = "(all|#{COP_NAMES_PATTERN})"
 
+    # @api private
     COMMENT_DIRECTIVE_REGEXP = Regexp.new(
       "# rubocop : ((?:disable|enable|todo))\\b #{COPS_PATTERN}"
         .gsub(' ', '\s*')

data/lib/rubocop/config_loader.rb

@@ -140,22 +140,33 @@ module RuboCop
         @project_root ||= find_project_root
       end
 
+      PENDING_BANNER = <<~BANNER
+        The following cops were added to RuboCop, but are not configured. Please set Enabled to either `true` or `false` in your `.rubocop.yml` file.
+
+        Please also note that can also opt-in to new cops by default by adding this to your config:
+          AllCops:
+            NewCops: enable
+      BANNER
+
       def warn_on_pending_cops(pending_cops)
         return if pending_cops.empty?
 
-        warn Rainbow('The following cops were added to RuboCop, but are not ' \
-                     'configured. Please set Enabled to either `true` or ' \
-                     '`false` in your `.rubocop.yml` file:').yellow
+        warn Rainbow(PENDING_BANNER).yellow
 
         pending_cops.each do |cop|
-          version = cop.metadata['VersionAdded'] || 'N/A'
-
-          warn Rainbow(" - #{cop.name} (#{version})").yellow
+          warn_pending_cop cop
         end
 
         warn Rainbow('For more information: https://docs.rubocop.org/rubocop/versioning.html').yellow
       end
 
+      def warn_pending_cop(cop)
+        version = cop.metadata['VersionAdded'] || 'N/A'
+
+        warn Rainbow("#{cop.name}: # (new in #{version})").yellow
+        warn Rainbow('  Enabled: true').yellow
+      end
+
       # Merges the given configuration with the default one.
       def merge_with_default(config, config_file, unset_nil: true)
         resolver.merge_with_default(config, config_file, unset_nil: unset_nil)