rubocop 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9139e9c7213e73e6f44db7e88265254dc4b4e11ab0fa38b0fa88268070ff0a6a
-  data.tar.gz: 5590d626e845237529e7e21dbc162b2704fdbe5f37a39f0e29d3e164b550a03e
+  metadata.gz: 5013f1930869ad961d7fe1cf2cd8bad7a36a15bc37f6cf42e1663fbdb61f2cc2
+  data.tar.gz: 1ac4e658406f0f6e22a068f28fab225a8e9f53c59a79f89f0e52157cdc076efc
 SHA512:
-  metadata.gz: 04ce9f16ffe193e6a048a2fe2b5c0015a148becdfc25bcd67efdd5cf207727eed3ab3440bbf5f8f2473868d9f697fb88b2c2f810bfe217fb23153d010318bde8
-  data.tar.gz: bd33137303ca551db1a8e67ad96bb14b376207caf88ba0c82efb3202c2373b94f22bd9e19f3a8b9cfd475bc6955078c13a87b8236e6703e8ad48c2b14a2cb271
+  metadata.gz: 555adab63cf768a150f37d2ca84e08f2322e84182528949e09bd5eda4c79348e4c41dc17d23737785ea044a78f54f99d99d512047446d7437efdeaf306147f32
+  data.tar.gz: 3fe186c044fd8733f4edef4055c036106d739e485dbfdcdbffe7882961175695edb79aafe27c1b11a8bbe9791f0754f26e7bd7534571dd09955bd5caf6aa6afe

data/README.md

@@ -11,11 +11,6 @@
 [![Maintainability](https://api.codeclimate.com/v1/badges/d2d67f728e88ea84ac69/maintainability)](https://codeclimate.com/github/rubocop-hq/rubocop/maintainability)
 [![SemVer](https://api.dependabot.com/badges/compatibility_score?dependency-name=rubocop&package-manager=bundler&version-scheme=semver)](https://dependabot.com/compatibility-score.html?dependency-name=rubocop&package-manager=bundler&version-scheme=semver)
 
-[![Patreon](https://img.shields.io/badge/patreon-donate-orange.svg)](https://www.patreon.com/bbatsov)
-[![OpenCollective](https://opencollective.com/rubocop/backers/badge.svg)](#open-collective-backers)
-[![OpenCollective](https://opencollective.com/rubocop/sponsors/badge.svg)](#open-collective-sponsors)
-[![Tidelift](https://tidelift.com/badges/package/rubygems/rubocop)](https://tidelift.com/subscription/pkg/rubygems-rubocop?utm_source=rubygems-rubocop&utm_medium=referral&utm_campaign=readme)
-
 > Role models are important. <br/>
 > -- Officer Alex J. Murphy / RoboCop
 
@@ -27,6 +22,12 @@ RuboCop can also automatically fix many of them for you.
 RuboCop is extremely flexible and most aspects of its behavior can be tweaked via various
 [configuration options](https://github.com/rubocop-hq/rubocop/blob/master/config/default.yml).
 
+----------
+[![Patreon](https://img.shields.io/badge/patreon-donate-orange.svg)](https://www.patreon.com/bbatsov)
+[![OpenCollective](https://opencollective.com/rubocop/backers/badge.svg)](#open-collective-backers)
+[![OpenCollective](https://opencollective.com/rubocop/sponsors/badge.svg)](#open-collective-sponsors)
+[![Tidelift](https://tidelift.com/badges/package/rubygems/rubocop)](https://tidelift.com/subscription/pkg/rubygems-rubocop?utm_source=rubygems-rubocop&utm_medium=referral&utm_campaign=readme)
+
 **Please consider [financially supporting its ongoing development](#funding).**
 
 ## Installation
@@ -50,7 +51,7 @@ To prevent an unwanted RuboCop update you might want to use a conservative versi
 in your `Gemfile`:
 
 ```rb
-gem 'rubocop', '~> 1.2', require: false
+gem 'rubocop', '~> 1.3', require: false
 ```
 
 See [versioning](https://docs.rubocop.org/rubocop/1.0/versioning.html) for further details.
@@ -150,14 +151,19 @@ wide array of funding channels to account for your preferences
 currently [Open Collective](https://opencollective.com/rubocop) is our
 preferred funding platform).
 
-If you're working in a company that's making significant use of RuboCop we'd appreciate it if you suggest to your company
-to become a RuboCop sponsor.
+**If you're working in a company that's making significant use of RuboCop we'd appreciate it if you suggest to your company
+to become a RuboCop sponsor.**
 
 You can support the development of RuboCop via
 [GitHub Sponsors](https://github.com/sponsors/bbatsov),
 [Patreon](https://www.patreon.com/bbatsov),
-[PayPal](https://paypal.me/bbatsov)
-and [Open Collective](https://opencollective.com/rubocop).
+[PayPal](https://paypal.me/bbatsov),
+[Open Collective](https://opencollective.com/rubocop)
+and [Tidelift](https://tidelift.com/subscription/pkg/rubygems-rubocop?utm_source=rubygems-rubocop&utm_medium=referral&utm_campaign=readme)
+.
+
+**Note:** If doing a sponsorship in the form of donation is problematic for your company from an accounting standpoint, we'd recommend
+the use of Tidelift, where you can get a support-like subscription instead.
 
 ### Open Collective Backers
 

data/config/default.yml

@@ -891,7 +891,7 @@ Layout/LineLength:
   StyleGuide: '#max-line-length'
   Enabled: true
   VersionAdded: '0.25'
-  VersionChanged: '0.84'
+  VersionChanged: '1.3'
   AutoCorrect: false
   Max: 120
   # To make it possible to copy or click on URIs in the code, we allow lines
@@ -1400,6 +1400,8 @@ Lint/ConstantDefinitionInBlock:
   StyleGuide: '#no-constant-definition-in-block'
   Enabled: true
   VersionAdded: '0.91'
+  VersionChanged: '1.3'
+  AllowedMethods: []
 
 Lint/ConstantResolution:
   Description: 'Check that constants are fully qualified with `::`.'
@@ -1415,6 +1417,22 @@ Lint/Debugger:
   Enabled: true
   VersionAdded: '0.14'
   VersionChanged: '0.49'
+  DebuggerReceivers:
+    - binding
+    - Kernel
+    - Pry
+  DebuggerMethods:
+    - debugger
+    - byebug
+    - remote_byebug
+    - pry
+    - remote_pry
+    - pry_remote
+    - console
+    - rescue
+    - save_and_open_page
+    - save_and_open_screenshot
+    - irb
 
 Lint/DeprecatedClassMethods:
   Description: 'Check for deprecated class method calls.'
@@ -1433,6 +1451,11 @@ Lint/DisjunctiveAssignmentInConstructor:
   VersionAdded: '0.62'
   VersionChanged: '0.88'
 
+Lint/DuplicateBranch:
+  Description: Checks that there are no repeated bodies within `if/unless`, `case-when` and `rescue` constructs.
+  Enabled: pending
+  VersionAdded: '1.3'
+
 Lint/DuplicateCaseCondition:
   Description: 'Do not repeat values in case conditionals.'
   Enabled: true
@@ -1484,7 +1507,15 @@ Lint/EmptyBlock:
   Description: 'This cop checks for blocks without a body.'
   Enabled: pending
   VersionAdded: '1.1'
+  VersionChanged: '1.3'
   AllowComments: true
+  AllowEmptyLambdas: true
+
+Lint/EmptyClass:
+  Description: 'Checks for classes and metaclasses without a body.'
+  Enabled: pending
+  VersionAdded: '1.3'
+  AllowComments: false
 
 Lint/EmptyConditionalBody:
   Description: 'This cop checks for the presence of `if`, `elsif` and `unless` branches without a body.'
@@ -1628,7 +1659,8 @@ Lint/Loop:
   StyleGuide: '#loop-with-break'
   Enabled: true
   VersionAdded: '0.9'
-  VersionChanged: '0.89'
+  VersionChanged: '1.3'
+  Safe: false
 
 Lint/MissingCopEnableDirective:
   Description: 'Checks for a `# rubocop:enable` after `# rubocop:disable`.'
@@ -2416,7 +2448,7 @@ Naming/VariableNumber:
   StyleGuide: '#snake-case-symbols-methods-vars-with-numbers'
   Enabled: true
   VersionAdded: '0.50'
-  VersionChanged: '1.2'
+  VersionChanged: '1.3'
   EnforcedStyle: normalcase
   SupportedStyles:
     - snake_case
@@ -2424,6 +2456,7 @@ Naming/VariableNumber:
     - non_integer
   CheckMethodNames: true
   CheckSymbols: true
+  AllowedIdentifiers: []
 
 #################### Security ##############################
 
@@ -2805,7 +2838,9 @@ Style/ClassVars:
 Style/CollectionCompact:
   Description: 'Use `{Array,Hash}#{compact,compact!}` instead of custom logic to reject nils.'
   Enabled: pending
+  Safe: false
   VersionAdded: '1.2'
+  VersionChanged: '1.3'
 
 # Align with the style guide.
 Style/CollectionMethods:
@@ -2870,17 +2905,18 @@ Style/CommandLiteral:
 Style/CommentAnnotation:
   Description: >-
                  Checks formatting of special comments
-                 (TODO, FIXME, OPTIMIZE, HACK, REVIEW).
+                 (TODO, FIXME, OPTIMIZE, HACK, REVIEW, NOTE).
   StyleGuide: '#annotate-keywords'
   Enabled: true
   VersionAdded: '0.10'
-  VersionChanged: '0.31'
+  VersionChanged: '1.3'
   Keywords:
     - TODO
     - FIXME
     - OPTIMIZE
     - HACK
     - REVIEW
+    - NOTE
 
 Style/CommentedKeyword:
   Description: 'Do not place comments on the same line as certain keywords.'
@@ -2976,6 +3012,7 @@ Style/DocumentDynamicEvalDefinition:
   StyleGuide: '#eval-comment-docs'
   Enabled: pending
   VersionAdded: '1.1'
+  VersionChanged: '1.3'
 
 Style/Documentation:
   Description: 'Document classes and non-namespace modules.'
@@ -3303,6 +3340,7 @@ Style/IfInsideElse:
   Enabled: true
   AllowIfModifier: false
   VersionAdded: '0.36'
+  VersionChanged: '1.3'
 
 Style/IfUnlessModifier:
   Description: >-
@@ -3335,12 +3373,14 @@ Style/ImplicitRuntimeError:
   VersionAdded: '0.41'
 
 Style/InfiniteLoop:
-  Description: 'Use Kernel#loop for infinite loops.'
+  Description: >-
+                 Use Kernel#loop for infinite loops.
+                 This cop is unsafe in the body may raise a `StopIteration` exception.
+  Safe: false
   StyleGuide: '#infinite-loop'
   Enabled: true
   VersionAdded: '0.26'
   VersionChanged: '0.61'
-  SafeAutoCorrect: true
 
 Style/InlineComment:
   Description: 'Avoid trailing inline comments.'
@@ -3723,6 +3763,11 @@ Style/NilComparison:
     - predicate
     - comparison
 
+Style/NilLambda:
+  Description: 'Prefer `-> {}` to `-> { nil }`.'
+  Enabled: pending
+  VersionAdded: '1.3'
+
 Style/NonNilCheck:
   Description: 'Checks for redundant nil checks.'
   StyleGuide: '#no-non-nil-checks'
@@ -4222,6 +4267,13 @@ Style/StabbyLambdaParentheses:
     - require_parentheses
     - require_no_parentheses
 
+Style/StaticClass:
+  Description: 'Prefer modules to classes with only class methods.'
+  StyleGuide: '#modules-vs-classes'
+  Enabled: false
+  Safe: false
+  VersionAdded: '1.3'
+
 Style/StderrPuts:
   Description: 'Use `warn` instead of `$stderr.puts`.'
   StyleGuide: '#warn'

data/lib/rubocop.rb

@@ -259,6 +259,7 @@ require_relative 'rubocop/cop/lint/debugger'
 require_relative 'rubocop/cop/lint/deprecated_class_methods'
 require_relative 'rubocop/cop/lint/deprecated_open_ssl_constant'
 require_relative 'rubocop/cop/lint/disjunctive_assignment_in_constructor'
+require_relative 'rubocop/cop/lint/duplicate_branch'
 require_relative 'rubocop/cop/lint/duplicate_case_condition'
 require_relative 'rubocop/cop/lint/duplicate_elsif_condition'
 require_relative 'rubocop/cop/lint/duplicate_hash_key'
@@ -269,6 +270,7 @@ 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_block'
+require_relative 'rubocop/cop/lint/empty_class'
 require_relative 'rubocop/cop/lint/empty_conditional_body'
 require_relative 'rubocop/cop/lint/empty_ensure'
 require_relative 'rubocop/cop/lint/empty_expression'
@@ -480,6 +482,7 @@ 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/static_class'
 require_relative 'rubocop/cop/style/method_called_on_do_end_block'
 require_relative 'rubocop/cop/style/method_def_parentheses'
 require_relative 'rubocop/cop/style/min_max'
@@ -506,6 +509,7 @@ require_relative 'rubocop/cop/style/nested_parenthesized_calls'
 require_relative 'rubocop/cop/style/nested_ternary_operator'
 require_relative 'rubocop/cop/style/next'
 require_relative 'rubocop/cop/style/nil_comparison'
+require_relative 'rubocop/cop/style/nil_lambda'
 require_relative 'rubocop/cop/style/non_nil_check'
 require_relative 'rubocop/cop/style/not'
 require_relative 'rubocop/cop/style/numeric_literals'

data/lib/rubocop/config_loader.rb

@@ -255,17 +255,18 @@ module RuboCop
               "Configuration file not found: #{absolute_path}"
       end
 
-      def yaml_safe_load(yaml_code, filename)
-        if defined?(SafeYAML) && SafeYAML.respond_to?(:load)
-          SafeYAML.load(yaml_code, filename, whitelisted_tags: %w[!ruby/regexp])
-        # Ruby 2.6+
-        elsif Gem::Version.new(Psych::VERSION) >= Gem::Version.new('3.1.0')
+      raise 'SafeYAML is unmaintained, no longer needed and should be removed' if defined?(SafeYAML)
+
+      if Gem::Version.new(Psych::VERSION) >= Gem::Version.new('3.1.0')
+        def yaml_safe_load(yaml_code, filename)
           YAML.safe_load(yaml_code,
                          permitted_classes: [Regexp, Symbol],
                          permitted_symbols: [],
                          aliases: true,
                          filename: filename)
-        else
+        end
+      else # Ruby < 2.6
+        def yaml_safe_load(yaml_code, filename)
           YAML.safe_load(yaml_code, [Regexp, Symbol], [], true, filename)
         end
       end

data/lib/rubocop/cop/bundler/duplicated_gem.rb

@@ -35,13 +35,13 @@ module RuboCop
       #     gem 'rubocop', '~> 0.90.0'
       #   end
       #
-      class DuplicatedGem < Cop
+      class DuplicatedGem < Base
         include RangeHelp
 
         MSG = 'Gem `%<gem_name>s` requirements already given on line '\
           '%<line_of_first_occurrence>d of the Gemfile.'
 
-        def investigate(processed_source)
+        def on_new_investigation
           return if processed_source.blank?
 
           duplicated_gem_nodes.each do |nodes|
@@ -89,7 +89,7 @@ module RuboCop
             gem_name: gem_name,
             line_of_first_occurrence: line_of_first_occurrence
           )
-          add_offense(node, location: offense_location, message: message)
+          add_offense(offense_location, message: message)
         end
       end
     end

data/lib/rubocop/cop/bundler/gem_comment.rb

@@ -58,7 +58,7 @@ module RuboCop
       #   # Version 2.1 introduces breaking change baz
       #   gem 'bar', '< 2.1'
       #
-      class GemComment < Cop
+      class GemComment < Base
         include DefNode
 
         MSG = 'Missing gem description comment.'

data/lib/rubocop/cop/commissioner.rb

@@ -138,7 +138,7 @@ module RuboCop
         end
       end
 
-      # Note: mutates `callbacks` in place
+      # NOTE: mutates `callbacks` in place
       def restricted_map(callbacks)
         map = {}
         callbacks&.select! do |cop|

data/lib/rubocop/cop/gemspec/duplicated_assignment.rb

@@ -34,7 +34,7 @@ module RuboCop
       #     spec.add_runtime_dependency('parallel', '~> 1.10')
       #     spec.add_runtime_dependency('parser', '>= 2.3.3.1', '< 3.0')
       #   end
-      class DuplicatedAssignment < Cop
+      class DuplicatedAssignment < Base
         include RangeHelp
 
         MSG = '`%<assignment>s` method calls already given on line '\
@@ -54,7 +54,7 @@ module RuboCop
             (lvar #match_block_variable_name?) #assignment_method? ...)
         PATTERN
 
-        def investigate(processed_source)
+        def on_new_investigation
           return if processed_source.blank?
 
           duplicated_assignment_method_nodes.each do |nodes|
@@ -96,7 +96,7 @@ module RuboCop
             assignment: assignment,
             line_of_first_occurrence: line_of_first_occurrence
           )
-          add_offense(node, location: offense_location, message: message)
+          add_offense(offense_location, message: message)
         end
       end
     end

data/lib/rubocop/cop/gemspec/required_ruby_version.rb

@@ -45,7 +45,7 @@ module RuboCop
       #   Gem::Specification.new do |spec|
       #     spec.required_ruby_version = '~> 2.5'
       #   end
-      class RequiredRubyVersion < Cop
+      class RequiredRubyVersion < Base
         include RangeHelp
 
         NOT_EQUAL_MSG = '`required_ruby_version` (%<required_ruby_version>s, ' \
@@ -64,7 +64,7 @@ module RuboCop
         PATTERN
 
         # rubocop:disable Metrics/AbcSize
-        def investigate(processed_source)
+        def on_new_investigation
           version_def = required_ruby_version(processed_source.ast).first
 
           if version_def
@@ -72,13 +72,12 @@ module RuboCop
             return if !ruby_version || ruby_version == target_ruby_version.to_s
 
             add_offense(
-              processed_source.ast,
-              location: version_def.loc.expression,
+              version_def.loc.expression,
               message: not_equal_message(ruby_version, target_ruby_version)
             )
           else
             range = source_range(processed_source.buffer, 1, 0)
-            add_offense(nil, location: range, message: MISSING_MSG)
+            add_offense(range, message: MISSING_MSG)
           end
         end
         # rubocop:enable Metrics/AbcSize

data/lib/rubocop/cop/gemspec/ruby_version_globals_usage.rb

@@ -25,7 +25,7 @@ module RuboCop
       #     spec.add_runtime_dependency 'gem_a'
       #   end
       #
-      class RubyVersionGlobalsUsage < Cop
+      class RubyVersionGlobalsUsage < Base
         MSG = 'Do not use `RUBY_VERSION` in gemspec file.'
 
         def_node_matcher :ruby_version?, '(const {cbase nil?} :RUBY_VERSION)'

data/lib/rubocop/cop/generator.rb

@@ -8,7 +8,7 @@ module RuboCop
     # and spec file when given a valid qualified cop name.
     # @api private
     class Generator
-      # Note: RDoc 5.1.0 or lower has the following issue.
+      # NOTE: RDoc 5.1.0 or lower has the following issue.
       # https://github.com/rubocop-hq/rubocop/issues/7043
       #
       # The following `String#gsub` can be replaced with

data/lib/rubocop/cop/layout/block_alignment.rb

@@ -210,10 +210,9 @@ module RuboCop
         end
 
         def alt_start_msg(start_loc, source_line_column)
-          if style != :either
-            ''
-          elsif start_loc.line == source_line_column[:line] &&
-                start_loc.column == source_line_column[:column]
+          if style != :either ||
+             (start_loc.line == source_line_column[:line] &&
+                 start_loc.column == source_line_column[:column])
             ''
           else
             " or #{format_source_line_column(source_line_column)}"

data/lib/rubocop/cop/layout/line_length.rb

@@ -88,6 +88,10 @@ module RuboCop
           end
         end
 
+        def correctable?
+          super && !breakable_range.nil?
+        end
+
         def autocorrect(range)
           return if range.nil?
 
@@ -98,6 +102,8 @@ module RuboCop
 
         private
 
+        attr_accessor :breakable_range
+
         def check_for_breakable_node(node)
           breakable_node = extract_breakable_node(node, max)
           return if breakable_node.nil?
@@ -195,7 +201,8 @@ module RuboCop
         def register_offense(loc, line, line_index)
           message = format(MSG, length: line_length(line), max: max)
 
-          breakable_range = breakable_range_by_line_index[line_index]
+          self.breakable_range = breakable_range_by_line_index[line_index]
+
           add_offense(breakable_range, location: loc, message: message) do
             self.max = line_length(line)
           end