rubocop 1.60.2 → 1.62.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5baa438e333ac7dbae0d7481f0a512e950f9ef11014f09d78f360d3bc64d528
-  data.tar.gz: bfba21f2555729c81554baad4910a35088fef9ba39538402e54841fdff1c8d8f
+  metadata.gz: 71f9543fd4a2366245df52234cec7a2492a2e4df631fec99e466de8b82cde5d7
+  data.tar.gz: 99bf7b324f099186e5918469d3fd5d954e91317cb572e96f48a253c4d4ace709
 SHA512:
-  metadata.gz: 247eadb99d0c3d9f46067a707a0511433567fea2326ded958381c55cabe9a24ef6c2328e6d4ab901454a6af60cba185d5f87364fc9c1399684bbf3a657ef383b
-  data.tar.gz: 675be6aba0374927f8bf17df0d1dc51d4fc7a05431981d164ae62715fd9008b8ae6208b50f4b509afadb4622a0b19e0bf5d4c650aa203407ece15e9d88ebe031
+  metadata.gz: a0128453654e2f6c5b5000c70931edb3dcccc2d1eb54c08b4e1af6ea393f7192ad0aeaaf9c07a136138fee6be7702caa22cdd3e0f3a46a25a6508102ac0759a1
+  data.tar.gz: 989aade51c2112e02b3d4e130b99d1096116fca3a8cc0d47e8c25de8eea419afb242969f9a48c7a8d04ab1b9a8563dc138b65e9b364d89758ebcdd3444147893

data/README.md

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

data/assets/output.css.erb

@@ -0,0 +1,159 @@
+* {
+  -webkit-box-sizing: border-box;
+  -moz-box-sizing: border-box;
+  box-sizing: border-box;
+}
+
+body, html {
+  font-size: 62.5%;
+}
+body {
+  background-color: #ecedf0;
+  font-family: "Helvetica Neue",Helvetica,Arial,sans-serif;
+  margin: 0;
+}
+code {
+  font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace;
+  font-size: 85%;
+}
+#header {
+  background: #f9f9f9;
+  color: #333;
+  border-bottom: 3px solid #ccc;
+  height: 50px;
+  padding: 0;
+}
+#header .logo {
+  float: left;
+  margin: 5px 12px 7px 20px;
+  width: 38px;
+  height: 38px;
+}
+#header .title {
+  display: inline-block;
+  float: left;
+  height: 50px;
+  font-size: 2.4rem;
+  letter-spacing: normal;
+  line-height: 50px;
+  margin: 0;
+}
+
+.information, #offenses {
+  width: 100%;
+  padding: 20px;
+  color: #333;
+}
+#offenses {
+  padding: 0 20px;
+}
+
+.information .infobox {
+  border-left: 3px solid;
+  border-radius: 4px;
+  background-color: #fff;
+  -webkit-box-shadow: 0 1px 1px rgba(0, 0, 0, 0.05);
+  box-shadow: 0 1px 1px rgba(0, 0, 0, 0.05);
+  padding: 15px;
+  border-color: #0088cc;
+  font-size: 1.4rem;
+}
+.information .infobox .info-title {
+  font-size: 1.8rem;
+  line-height: 2.2rem;
+  margin: 0 0 0.5em;
+}
+.information .offenses-list li {
+  line-height: 1.8rem
+}
+.information .offenses-list {
+  padding-left: 20px;
+  margin-bottom: 0;
+}
+
+#offenses .offense-box {
+  border-radius: 4px;
+  margin-bottom: 20px;
+  background-color: #fff;
+  -webkit-box-shadow: 0 1px 1px rgba(0, 0, 0, 0.05);
+  box-shadow: 0 1px 1px rgba(0, 0, 0, 0.05);
+}
+.fixed .box-title {
+  position: fixed;
+  top: 0;
+  z-index: 10;
+  width: 100%;
+}
+.box-title-placeholder {
+  display: none;
+}
+.fixed .box-title-placeholder {
+  display: block;
+}
+#offenses .offense-box .box-title h3, #offenses .offense-box .box-title-placeholder h3 {
+  color: #33353f;
+  background-color: #f6f6f6;
+  font-size: 2rem;
+  line-height: 2rem;
+  display: block;
+  padding: 15px;
+  border-radius: 5px;
+  margin: 0;
+}
+#offenses .offense-box .offense-reports  {
+  padding: 0 15px;
+}
+#offenses .offense-box .offense-reports .report {
+  border-bottom: 1px dotted #ddd;
+  padding: 15px 0px;
+  position: relative;
+  font-size: 1.3rem;
+}
+#offenses .offense-box .offense-reports .report:last-child {
+  border-bottom: none;
+}
+#offenses .offense-box .offense-reports .report pre code {
+  display: block;
+  background: #000;
+  color: #fff;
+  padding: 10px 15px;
+  border-radius: 5px;
+  line-height: 1.6rem;
+}
+#offenses .offense-box .offense-reports .report .location {
+  font-weight: bold;
+}
+#offenses .offense-box .offense-reports .report .message code {
+  padding: 0.3em;
+  background-color: rgba(0,0,0,0.07);
+  border-radius: 3px;
+}
+.severity {
+  text-transform: capitalize;
+  font-weight: bold;
+}
+.highlight {
+  padding: 2px;
+  border-radius: 2px;
+  font-weight: bold;
+}
+<%- SEVERITY_COLORS.each do |severity, color| %>
+.severity.<%= severity %> {
+  color: <%= color %>;
+}
+.highlight.<%= severity %> {
+  background-color: <%= color.fade_out(0.4) %>;
+  border: 1px solid <%= color.fade_out(0.6) %>;
+}
+<%- end %>
+footer {
+  margin-bottom: 20px;
+  margin-right: 20px;
+  font-size: 1.3rem;
+  color: #777;
+  text-align: right;
+}
+.extra-code {
+  color: #ED9C28
+}
+

data/assets/output.html.erb

@@ -3,168 +3,9 @@
   <head>
     <meta charset='UTF-8' />
     <title>RuboCop Inspection Report</title>
-    <%# TODO: Clean up the messy markup and style definitions. %>
     <style>
-    * {
-    -webkit-box-sizing: border-box;
-    -moz-box-sizing: border-box;
-    box-sizing: border-box;
-    }
-
-    body, html {
-    font-size: 62.5%;
-    }
-    body {
-    background-color: #ecedf0;
-    font-family: "Helvetica Neue",Helvetica,Arial,sans-serif;
-    margin: 0;
-    }
-    code {
-    font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace;
-    font-size: 85%;
-    }
-    #header {
-    background: #f9f9f9;
-    color: #333;
-    border-bottom: 3px solid #ccc;
-    height: 50px;
-    padding: 0;
-    }
-    #header .logo {
-    float: left;
-    margin: 5px 12px 7px 20px;
-    width: 38px;
-    height: 38px;
-    }
-    #header .title {
-    display: inline-block;
-    float: left;
-    height: 50px;
-    font-size: 2.4rem;
-    letter-spacing: normal;
-    line-height: 50px;
-    margin: 0;
-    }
-
-    .information, #offenses {
-    width: 100%;
-    padding: 20px;
-    color: #333;
-    }
-    #offenses {
-    padding: 0 20px;
-    }
-
-    .information .infobox {
-    border-left: 3px solid;
-    border-radius: 4px;
-    background-color: #fff;
-    -webkit-box-shadow: 0 1px 1px rgba(0, 0, 0, 0.05);
-    box-shadow: 0 1px 1px rgba(0, 0, 0, 0.05);
-    padding: 15px;
-    border-color: #0088cc;
-    font-size: 1.4rem;
-    }
-    .information .infobox .info-title {
-    font-size: 1.8rem;
-    line-height: 2.2rem;
-    margin: 0 0 0.5em;
-    }
-    .information .offenses-list li {
-    line-height: 1.8rem
-    }
-    .information .offenses-list {
-    padding-left: 20px;
-    margin-bottom: 0;
-    }
-
-    #offenses .offense-box {
-    border-radius: 4px;
-    margin-bottom: 20px;
-    background-color: #fff;
-    -webkit-box-shadow: 0 1px 1px rgba(0, 0, 0, 0.05);
-    box-shadow: 0 1px 1px rgba(0, 0, 0, 0.05);
-    }
-    .fixed .box-title {
-    position: fixed;
-    top: 0;
-    z-index: 10;
-    width: 100%;
-    }
-    .box-title-placeholder {
-    display: none;
-    }
-    .fixed .box-title-placeholder {
-    display: block;
-    }
-    #offenses .offense-box .box-title h3, #offenses .offense-box .box-title-placeholder h3 {
-    color: #33353f;
-    background-color: #f6f6f6;
-    font-size: 2rem;
-    line-height: 2rem;
-    display: block;
-    padding: 15px;
-    border-radius: 5px;
-    margin: 0;
-    }
-    #offenses .offense-box .offense-reports  {
-    padding: 0 15px;
-    }
-    #offenses .offense-box .offense-reports .report {
-    border-bottom: 1px dotted #ddd;
-    padding: 15px 0px;
-    position: relative;
-    font-size: 1.3rem;
-    }
-    #offenses .offense-box .offense-reports .report:last-child {
-    border-bottom: none;
-    }
-    #offenses .offense-box .offense-reports .report pre code {
-    display: block;
-    background: #000;
-    color: #fff;
-    padding: 10px 15px;
-    border-radius: 5px;
-    line-height: 1.6rem;
-    }
-    #offenses .offense-box .offense-reports .report .location {
-    font-weight: bold;
-    }
-    #offenses .offense-box .offense-reports .report .message code {
-    padding: 0.3em;
-    background-color: rgba(0,0,0,0.07);
-    border-radius: 3px;
-    }
-    .severity {
-    text-transform: capitalize;
-    font-weight: bold;
-    }
-    .highlight {
-    padding: 2px;
-    border-radius: 2px;
-    font-weight: bold;
-    }
-    <%- SEVERITY_COLORS.each do |severity, color| %>
-    .severity.<%= severity %> {
-    color: <%= color %>;
-    }
-    .highlight.<%= severity %> {
-    background-color: <%= color.fade_out(0.4) %>;
-    border: 1px solid <%= color.fade_out(0.6) %>;
-    }
-    <%- end %>
-    footer {
-    margin-bottom: 20px;
-    margin-right: 20px;
-    font-size: 1.3rem;
-    color: #777;
-    text-align: right;
-    }
-    .extra-code {
-      color: #ED9C28
-    }
+<%= render_css %>
     </style>
-
     <script>
     (function() {
       // floating headers. requires classList support.

data/config/default.yml

@@ -144,6 +144,12 @@ AllCops:
   # Ruby version is still unresolved, RuboCop will use the oldest officially
   # supported Ruby version (currently Ruby 2.7).
   TargetRubyVersion: ~
+  # You can specify the parser engine. There are two options available:
+  # - `parser_whitequark` ... https://github.com/whitequark/parser
+  # - `parser_prism` ... https://github.com/ruby/prism (`Prism::Translation::Parser`)
+  # By default, `parser` is used. For the `TargetRubyVersion` value, `parser` can be specified for versions `2.0` and above.
+  # `parser_prism` can be specified for versions `3.3` and above. `parser_prism` is faster but still considered experimental.
+  ParserEngine: parser_whitequark
   # 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
@@ -556,7 +562,9 @@ Layout/ElseAlignment:
 Layout/EmptyComment:
   Description: 'Checks empty comment.'
   Enabled: true
+  AutoCorrect: contextual
   VersionAdded: '0.53'
+  VersionChanged: '1.61'
   AllowBorderComment: true
   AllowMarginComment: true
 
@@ -1825,16 +1833,18 @@ Lint/EmptyClass:
 Lint/EmptyConditionalBody:
   Description: 'Checks for the presence of `if`, `elsif` and `unless` branches without a body.'
   Enabled: true
+  AutoCorrect: contextual
   SafeAutoCorrect: false
   AllowComments: true
   VersionAdded: '0.89'
-  VersionChanged: '1.34'
+  VersionChanged: '1.61'
 
 Lint/EmptyEnsure:
   Description: 'Checks for empty ensure block.'
   Enabled: true
+  AutoCorrect: contextual
   VersionAdded: '0.10'
-  VersionChanged: '0.48'
+  VersionChanged: '1.61'
 
 Lint/EmptyExpression:
   Description: 'Checks for empty expressions.'
@@ -1856,8 +1866,9 @@ Lint/EmptyInPattern:
 Lint/EmptyInterpolation:
   Description: 'Checks for empty string interpolation.'
   Enabled: true
+  AutoCorrect: contextual
   VersionAdded: '0.20'
-  VersionChanged: '0.45'
+  VersionChanged: '1.61'
 
 Lint/EmptyWhen:
   Description: 'Checks for `when` branches with empty bodies.'
@@ -2395,7 +2406,9 @@ Lint/TopLevelReturnWithArgument:
 Lint/TrailingCommaInAttributeDeclaration:
   Description: 'Checks for trailing commas in attribute declarations.'
   Enabled: true
+  AutoCorrect: contextual
   VersionAdded: '0.90'
+  VersionChanged: '1.61'
 
 Lint/TripleQuotes:
   Description: 'Checks for useless triple quote constructs.'
@@ -2455,8 +2468,9 @@ Lint/UnusedBlockArgument:
   Description: 'Checks for unused block arguments.'
   StyleGuide: '#underscore-unused-vars'
   Enabled: true
+  AutoCorrect: contextual
   VersionAdded: '0.21'
-  VersionChanged: '0.22'
+  VersionChanged: '1.61'
   IgnoreEmptyBlocks: true
   AllowUnusedKeywordArguments: false
 
@@ -2464,8 +2478,9 @@ Lint/UnusedMethodArgument:
   Description: 'Checks for unused method arguments.'
   StyleGuide: '#underscore-unused-vars'
   Enabled: true
+  AutoCorrect: contextual
   VersionAdded: '0.21'
-  VersionChanged: '0.81'
+  VersionChanged: '1.61'
   AllowUnusedKeywordArguments: false
   IgnoreEmptyMethods: true
   IgnoreNotImplementedMethods: true
@@ -2489,8 +2504,9 @@ Lint/UriRegexp:
 Lint/UselessAccessModifier:
   Description: 'Checks for useless access modifiers.'
   Enabled: true
+  AutoCorrect: contextual
   VersionAdded: '0.20'
-  VersionChanged: '0.83'
+  VersionChanged: '1.61'
   ContextCreatingMethods: []
   MethodCreatingMethods: []
 
@@ -2498,8 +2514,9 @@ Lint/UselessAssignment:
   Description: 'Checks for useless assignment to a local variable.'
   StyleGuide: '#underscore-unused-vars'
   Enabled: true
+  AutoCorrect: contextual
   VersionAdded: '0.11'
-  VersionChanged: '1.51'
+  VersionChanged: '1.61'
   SafeAutoCorrect: false
 
 Lint/UselessElseWithoutRescue:
@@ -2511,8 +2528,9 @@ Lint/UselessElseWithoutRescue:
 Lint/UselessMethodDefinition:
   Description: 'Checks for useless method definitions.'
   Enabled: true
+  AutoCorrect: contextual
   VersionAdded: '0.90'
-  VersionChanged: '0.91'
+  VersionChanged: '1.61'
   Safe: false
 
 Lint/UselessRescue:
@@ -2535,13 +2553,17 @@ Lint/UselessSetterCall:
 Lint/UselessTimes:
   Description: 'Checks for useless `Integer#times` calls.'
   Enabled: true
-  VersionAdded: '0.91'
   Safe: false
+  AutoCorrect: contextual
+  VersionAdded: '0.91'
+  VersionChanged: '1.61'
 
 Lint/Void:
   Description: 'Possible use of operator/literal/variable in void context.'
   Enabled: true
+  AutoCorrect: contextual
   VersionAdded: '0.9'
+  VersionChanged: '1.61'
   CheckForMethodsWithNoSideEffects: false
 
 #################### Metrics ###############################
@@ -3701,8 +3723,9 @@ Style/EmptyCaseCondition:
 Style/EmptyElse:
   Description: 'Avoid empty else-clauses.'
   Enabled: true
+  AutoCorrect: contextual
   VersionAdded: '0.28'
-  VersionChanged: '0.32'
+  VersionChanged: '1.61'
   EnforcedStyle: both
   # empty - warn only on empty `else`
   # nil - warn on `else` with nil in it
@@ -3716,7 +3739,9 @@ Style/EmptyElse:
 Style/EmptyHeredoc:
   Description: 'Checks for using empty heredoc to reduce redundancy.'
   Enabled: pending
+  AutoCorrect: contextual
   VersionAdded: '1.32'
+  VersionChanged: '1.61'
 
 Style/EmptyLambdaParameter:
   Description: 'Omit parens for empty lambda parameters.'
@@ -3734,7 +3759,9 @@ Style/EmptyMethod:
   Description: 'Checks the formatting of empty method definitions.'
   StyleGuide: '#no-single-line-methods'
   Enabled: true
+  AutoCorrect: contextual
   VersionAdded: '0.46'
+  VersionChanged: '1.61'
   EnforcedStyle: compact
   SupportedStyles:
     - compact
@@ -4835,8 +4862,9 @@ Style/RaiseArgs:
   Description: 'Checks the arguments passed to raise/fail.'
   StyleGuide: '#exception-class-messages'
   Enabled: true
+  Safe: false
   VersionAdded: '0.14'
-  VersionChanged: '1.2'
+  VersionChanged: '1.61'
   EnforcedStyle: exploded
   SupportedStyles:
     - compact # raise Exception.new(msg)
@@ -4977,10 +5005,11 @@ Style/RedundantHeredocDelimiterQuotes:
 Style/RedundantInitialize:
   Description: 'Checks for redundant `initialize` methods.'
   Enabled: pending
+  AutoCorrect: contextual
   Safe: false
   AllowComments: true
   VersionAdded: '1.27'
-  VersionChanged: '1.28'
+  VersionChanged: '1.61'
 
 Style/RedundantInterpolation:
   Description: 'Checks for strings that are just an interpolated expression.'

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

@@ -7,11 +7,11 @@ module RuboCop
     module Command
       # Start Language Server Protocol of RuboCop.
       # @api private
-      class Lsp < Base
+      class LSP < Base
         self.command_name = :lsp
 
         def run
-          RuboCop::Lsp::Server.new(@config_store).start
+          RuboCop::LSP::Server.new(@config_store).start
         end
       end
     end

data/lib/rubocop/cli.rb

@@ -12,7 +12,7 @@ module RuboCop
     STATUS_INTERRUPTED = Signal.list['INT'] + 128
     DEFAULT_PARALLEL_OPTIONS = %i[
       color config debug display_style_guide display_time display_only_fail_level_offenses
-      display_only_failed except extra_details fail_level fix_layout format
+      display_only_failed editor_mode except extra_details fail_level fix_layout format
       ignore_disable_comments lint only only_guide_cops require safe
       autocorrect safe_autocorrect autocorrect_all
     ].freeze
@@ -151,6 +151,7 @@ module RuboCop
 
     def act_on_options
       set_options_to_config_loader
+      handle_editor_mode
 
       @config_store.options_config = @options[:config] if @options[:config]
       @config_store.force_default_config! if @options[:force_default_config]
@@ -174,6 +175,10 @@ module RuboCop
       ConfigLoader.ignore_unrecognized_cops = @options[:ignore_unrecognized_cops]
     end
 
+    def handle_editor_mode
+      RuboCop::LSP.enable if @options[:editor_mode]
+    end
+
     # rubocop:disable Metrics/CyclomaticComplexity
     def handle_exiting_options
       return unless Options::EXITING_OPTIONS.any? { |o| @options.key? o }

data/lib/rubocop/config.rb

@@ -244,6 +244,10 @@ module RuboCop
         end
     end
 
+    def parser_engine
+      @parser_engine ||= for_all_cops.fetch('ParserEngine', :parser_whitequark).to_sym
+    end
+
     def target_rails_version
       @target_rails_version ||=
         if for_all_cops['TargetRailsVersion']

data/lib/rubocop/config_finder.rb

@@ -17,8 +17,8 @@ module RuboCop
       attr_writer :project_root
 
       def find_config_path(target_dir)
-        find_project_dotfile(target_dir) || find_user_dotfile || find_user_xdg_config ||
-          DEFAULT_FILE
+        find_project_dotfile(target_dir) || find_project_root_dot_config ||
+          find_user_dotfile || find_user_xdg_config || DEFAULT_FILE
       end
 
       # Returns the path RuboCop inferred as the root of the project. No file
@@ -41,6 +41,16 @@ module RuboCop
         find_file_upwards(DOTFILE, target_dir, project_root)
       end
 
+      def find_project_root_dot_config
+        return unless project_root
+
+        dotfile = File.join(project_root, '.config', DOTFILE)
+        return dotfile if File.exist?(dotfile)
+
+        xdg_config = File.join(project_root, '.config', 'rubocop', XDG_CONFIG)
+        xdg_config if File.exist?(xdg_config)
+      end
+
       def find_user_dotfile
         return unless ENV.key?('HOME')
 

data/lib/rubocop/config_validator.rb

@@ -18,6 +18,7 @@ module RuboCop
     # @api private
     CONFIG_CHECK_KEYS = %w[Enabled Safe SafeAutoCorrect AutoCorrect].to_set.freeze
     CONFIG_CHECK_DEPARTMENTS = %w[pending override_department].freeze
+    CONFIG_CHECK_AUTOCORRECTS = %w[always contextual disabled].freeze
     private_constant :CONFIG_CHECK_KEYS, :CONFIG_CHECK_DEPARTMENTS
 
     def_delegators :@config, :smart_loaded_path, :for_all_cops
@@ -248,23 +249,31 @@ module RuboCop
       end
     end
 
+    # rubocop:disable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
     def check_cop_config_value(hash, parent = nil)
       hash.each do |key, value|
         check_cop_config_value(value, key) if value.is_a?(Hash)
 
         next unless CONFIG_CHECK_KEYS.include?(key) && value.is_a?(String)
 
-        next if key == 'Enabled' && CONFIG_CHECK_DEPARTMENTS.include?(value)
+        if key == 'Enabled' && !CONFIG_CHECK_DEPARTMENTS.include?(value)
+          supposed_values = 'a boolean'
+        elsif key == 'AutoCorrect' && !CONFIG_CHECK_AUTOCORRECTS.include?(value)
+          supposed_values = '`always`, `contextual`, `disabled`, or a boolean'
+        else
+          next
+        end
 
-        raise ValidationError, msg_not_boolean(parent, key, value)
+        raise ValidationError, param_error_message(parent, key, value, supposed_values)
       end
     end
+    # rubocop:enable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
 
     # FIXME: Handling colors in exception messages like this is ugly.
-    def msg_not_boolean(parent, key, value)
+    def param_error_message(parent, key, value, supposed_values)
       "#{Rainbow('').reset}" \
-        "Property #{Rainbow(key).yellow} of cop #{Rainbow(parent).yellow} " \
-        "is supposed to be a boolean and #{Rainbow(value).yellow} is not."
+        "Property #{Rainbow(key).yellow} of #{Rainbow(parent).yellow} cop " \
+        "is supposed to be #{supposed_values} and #{Rainbow(value).yellow} is not."
     end
   end
 end

data/lib/rubocop/cop/autocorrect_logic.rb

@@ -32,7 +32,12 @@ module RuboCop
         # allow turning off autocorrect on a cop by cop basis
         return true unless cop_config
 
-        return false if cop_config['AutoCorrect'] == false
+        # `false` is the same as `disabled` for backward compatibility.
+        return false if ['disabled', false].include?(cop_config['AutoCorrect'])
+
+        # When LSP is enabled, it is considered as editing source code,
+        # and autocorrection with `AutoCorrect: contextual` will not be performed.
+        return false if contextual_autocorrect? && LSP.enabled?
 
         # :safe_autocorrect is a derived option based on several command-line
         # arguments - see RuboCop::Options#add_autocorrection_options