rubocop 1.12.0 → 1.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4f019dc65a23e4fdd32592747afcbee2cf60dff91484b26714f587b9f70a178
-  data.tar.gz: 85f0e9d193e2165646764047f5422cb7942c87a147c96ff8e4a05b186eaea3c5
+  metadata.gz: 87761564ea69f6968eb595204b979c7accaee729c8c27005d8f4d22fe7d7c588
+  data.tar.gz: f1b08e98a6bfed772381c159a5bc1c22e697b965acb48154c7fb4b2c58566077
 SHA512:
-  metadata.gz: 5064fb48121769e10df9fe4dd7295151f15c2a3ae5f67fbb2869302a7ad268dfd3ed20e7a3242bf59ef68c1c6cf4e92452fedab08971702d29dba06516250de8
-  data.tar.gz: 3b01830b9394f8336bdc415d90e2805f2817eb9fa9686a11392ef8009c4a58dd4b04e40c4a8005e90204774e85b38a6885c315581d55c56bf4a847c71c570447
+  metadata.gz: '0709e83e22cd4b7ffd86e2144ce9da499a8aa6ded608337c6e88f0418feb313c9d46d2c0a46245297a8e2ff5e072b45af7c7797d30f0a172fb0ab0e377c70264'
+  data.tar.gz: 19bf9b1b665b3421665f29196702aaedcedd7599b7ba22c547ac2b4871241ddcab1103c017aa8c447d2a4b882a09a835a3ac8e101f8db06f91cd8957fad077c0

data/README.md

@@ -10,6 +10,7 @@
 [![Test Coverage](https://api.codeclimate.com/v1/badges/d2d67f728e88ea84ac69/test_coverage)](https://codeclimate.com/github/rubocop/rubocop/test_coverage)
 [![Maintainability](https://api.codeclimate.com/v1/badges/d2d67f728e88ea84ac69/maintainability)](https://codeclimate.com/github/rubocop/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)
+[![Discord](https://img.shields.io/badge/chat-on%20discord-7289da.svg?sanitize=true)](https://discord.gg/wJjWvGRDmm)
 
 > Role models are important. <br/>
 > -- Officer Alex J. Murphy / RoboCop
@@ -28,6 +29,8 @@ RuboCop is extremely flexible and most aspects of its behavior can be tweaked vi
 [![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)
 
+Working on RuboCop is often fun, but it also requires a great deal of time and energy.
+
 **Please consider [financially supporting its ongoing development](#funding).**
 
 ## Installation
@@ -51,7 +54,7 @@ To prevent an unwanted RuboCop update you might want to use a conservative versi
 in your `Gemfile`:
 
 ```rb
-gem 'rubocop', '~> 1.12', require: false
+gem 'rubocop', '~> 1.16', require: false
 ```
 
 See [our versioning policy](https://docs.rubocop.org/rubocop/versioning.html) for further details.
@@ -73,7 +76,7 @@ You can read a lot more about RuboCop in its [official docs](https://docs.ruboco
 
 RuboCop officially supports the following Ruby implementations:
 
-* MRI 2.4+
+* MRI 2.5+
 * JRuby 9.2+
 
 See the [compatibility documentation](https://docs.rubocop.org/rubocop/compatibility.html) for further details.

data/config/default.yml

@@ -130,7 +130,7 @@ AllCops:
   # What MRI version of the Ruby interpreter is the inspected code intended to
   # run on? (If there is more than one, set this to the lowest version.)
   # If a value is specified for TargetRubyVersion then it is used. Acceptable
-  # values are specificed as a float (i.e. 2.5); the teeny version of Ruby
+  # values are specificed as a float (i.e. 3.0); the teeny version of Ruby
   # should not be included. If the project specifies a Ruby version in the
   # .tool-versions or .ruby-version files, Gemfile or gems.rb file, RuboCop will
   # try to determine the desired version of Ruby by inspecting the
@@ -138,7 +138,7 @@ AllCops:
   # or gems.locked file. (Although the Ruby version is specified in the Gemfile
   # or gems.rb file, RuboCop reads the final value from the lock file.) If the
   # Ruby version is still unresolved, RuboCop will use the oldest officially
-  # supported Ruby version (currently Ruby 2.4).
+  # supported Ruby version (currently Ruby 2.5).
   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
@@ -174,6 +174,20 @@ Bundler/GemComment:
   IgnoredGems: []
   OnlyFor: []
 
+Bundler/GemVersion:
+  Description: 'Requires or forbids specifying gem versions.'
+  Enabled: false
+  VersionAdded: '1.14'
+  EnforcedStyle: 'required'
+  SupportedStyles:
+    - 'required'
+    - 'forbidden'
+  Include:
+    - '**/*.gemfile'
+    - '**/Gemfile'
+    - '**/gems.rb'
+  AllowedGems: []
+
 Bundler/InsecureProtocolSource:
   Description: >-
                  The source `:gemcutter`, `:rubygems` and `:rubyforge` are deprecated
@@ -363,10 +377,11 @@ Layout/BlockEndNewline:
   VersionAdded: '0.49'
 
 Layout/CaseIndentation:
-  Description: 'Indentation of when in a case/when/[else/]end.'
+  Description: 'Indentation of when in a case/(when|in)/[else/]end.'
   StyleGuide: '#indent-when-to-case'
   Enabled: true
   VersionAdded: '0.49'
+  VersionChanged: '1.16'
   EnforcedStyle: case
   SupportedStyles:
     - case
@@ -757,7 +772,7 @@ Layout/HashAlignment:
   Enabled: true
   AllowMultipleStyles: true
   VersionAdded: '0.49'
-  VersionChanged: '0.77'
+  VersionChanged: '1.16'
   # Alignment of entries using hash rocket as separator. Valid values are:
   #
   # key - left alignment of keys
@@ -1101,11 +1116,24 @@ Layout/ParameterAlignment:
   # But it can be overridden by setting this parameter
   IndentationWidth: ~
 
+Layout/RedundantLineBreak:
+  Description: >-
+                 Do not break up an expression into multiple lines when it fits
+                 on a single line.
+  Enabled: false
+  InspectBlocks: false
+  VersionAdded: '1.13'
+
 Layout/RescueEnsureAlignment:
   Description: 'Align rescues and ensures correctly.'
   Enabled: true
   VersionAdded: '0.49'
 
+Layout/SingleLineBlockChain:
+  Description: 'Put method call on a separate line if chained to a single line block.'
+  Enabled: false
+  VersionAdded: '1.14'
+
 Layout/SpaceAfterColon:
   Description: 'Use spaces after colons.'
   StyleGuide: '#spaces-operators'
@@ -1380,6 +1408,8 @@ Lint/AmbiguousBlockAssociation:
   StyleGuide: '#syntax'
   Enabled: true
   VersionAdded: '0.48'
+  VersionChanged: '1.13'
+  IgnoredMethods: []
 
 Lint/AmbiguousOperator:
   Description: >-
@@ -1583,7 +1613,7 @@ Lint/EmptyBlock:
   Description: 'This cop checks for blocks without a body.'
   Enabled: pending
   VersionAdded: '1.1'
-  VersionChanged: '1.3'
+  VersionChanged: '1.15'
   AllowComments: true
   AllowEmptyLambdas: true
 
@@ -1616,6 +1646,11 @@ Lint/EmptyFile:
   AllowComments: true
   VersionAdded: '0.90'
 
+Lint/EmptyInPattern:
+  Description: 'Checks for the presence of `in` pattern branches without a body.'
+  Enabled: pending
+  VersionAdded: '1.16'
+
 Lint/EmptyInterpolation:
   Description: 'Checks for empty string interpolation.'
   Enabled: true
@@ -2063,6 +2098,7 @@ Lint/SymbolConversion:
   Description: 'Checks for unnecessary symbol conversions.'
   Enabled: pending
   VersionAdded: '1.9'
+  VersionChanged: '1.16'
   EnforcedStyle: strict
   SupportedStyles:
     - strict
@@ -3451,6 +3487,7 @@ Style/HashAsLastArrayItem:
 
 Style/HashConversion:
   Description: 'Avoid Hash[] in favor of ary.to_h or literal hashes.'
+  StyleGuide: '#avoid-hash-constructor'
   Enabled: pending
   VersionAdded: '1.10'
   VersionChanged: '1.11'
@@ -3460,8 +3497,10 @@ Style/HashEachMethods:
   Description: 'Use Hash#each_key and Hash#each_value.'
   StyleGuide: '#hash-each'
   Enabled: true
-  VersionAdded: '0.80'
   Safe: false
+  VersionAdded: '0.80'
+  VersionChanged: '1.16'
+  AllowedReceivers: []
 
 Style/HashExcept:
   Description: >-
@@ -3524,6 +3563,7 @@ Style/IdenticalConditionalBranches:
                  out of the conditional.
   Enabled: true
   VersionAdded: '0.36'
+  VersionChanged: '1.16'
 
 Style/IfInsideElse:
   Description: 'Finds if nodes inside else, which can be converted to elsif.'
@@ -3570,6 +3610,12 @@ Style/ImplicitRuntimeError:
   Enabled: false
   VersionAdded: '0.41'
 
+Style/InPatternThen:
+  Description: 'Checks for `in;` uses in `case` expressions.'
+  StyleGuide: '#no-in-pattern-semicolons'
+  Enabled: pending
+  VersionAdded: '1.16'
+
 Style/InfiniteLoop:
   Description: >-
                  Use Kernel#loop for infinite loops.
@@ -3798,6 +3844,12 @@ Style/MultilineIfThen:
   VersionAdded: '0.9'
   VersionChanged: '0.26'
 
+Style/MultilineInPatternThen:
+  Description: 'Do not use `then` for multi-line `in` statement.'
+  StyleGuide: '#no-then'
+  Enabled: pending
+  VersionAdded: '1.16'
+
 Style/MultilineMemoization:
   Description: 'Wrap multiline memoizations in a `begin` and `end` block.'
   Enabled: true
@@ -3969,6 +4021,7 @@ Style/NilLambda:
   Description: 'Prefer `-> {}` to `-> { nil }`.'
   Enabled: pending
   VersionAdded: '1.3'
+  VersionChanged: '1.15'
 
 Style/NonNilCheck:
   Description: 'Checks for redundant nil checks.'
@@ -4155,6 +4208,16 @@ Style/Proc:
   VersionAdded: '0.9'
   VersionChanged: '0.18'
 
+Style/QuotedSymbols:
+  Description: 'Use a consistent style for quoted symbols.'
+  Enabled: pending
+  VersionAdded: '1.16'
+  EnforcedStyle: same_as_string_literals
+  SupportedStyles:
+    - same_as_string_literals
+    - single_quotes
+    - double_quotes
+
 Style/RaiseArgs:
   Description: 'Checks the arguments passed to raise/fail.'
   StyleGuide: '#exception-class-messages'
@@ -4622,6 +4685,12 @@ Style/TernaryParentheses:
     - require_parentheses_when_complex
   AllowSafeAssignment: true
 
+Style/TopLevelMethodDefinition:
+  Description: 'This cop looks for top-level method definitions.'
+  StyleGuide: '#top-level-methods'
+  Enabled: false
+  VersionAdded: '1.15'
+
 Style/TrailingBodyOnClass:
   Description: 'Class body goes below class statement.'
   Enabled: true
@@ -4708,7 +4777,7 @@ Style/TrivialAccessors:
   StyleGuide: '#attr_family'
   Enabled: true
   VersionAdded: '0.9'
-  VersionChanged: '0.77'
+  VersionChanged: '1.15'
   # When set to `false` the cop will suggest the use of accessor methods
   # in situations like:
   #
@@ -4727,7 +4796,7 @@ Style/TrivialAccessors:
   # on_exception :restart
   #
   # Commonly used in DSLs
-  AllowDSLWriters: false
+  AllowDSLWriters: true
   IgnoreClassMethods: false
   AllowedMethods:
     - to_ary

data/exe/rubocop

@@ -9,9 +9,7 @@ require 'benchmark'
 cli = RuboCop::CLI.new
 result = 0
 
-time = Benchmark.realtime do
-  result = cli.run
-end
+time = Benchmark.realtime { result = cli.run }
 
 puts "Finished in #{time} seconds" if cli.options[:debug] || cli.options[:display_time]
 exit result

data/lib/rubocop.rb

@@ -18,7 +18,6 @@ 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'
@@ -83,6 +82,7 @@ require_relative 'rubocop/cop/mixin/end_keyword_alignment'
 require_relative 'rubocop/cop/mixin/enforce_superclass'
 require_relative 'rubocop/cop/mixin/first_element_line_break'
 require_relative 'rubocop/cop/mixin/frozen_string_literal'
+require_relative 'rubocop/cop/mixin/gem_declaration'
 require_relative 'rubocop/cop/mixin/hash_alignment_styles'
 require_relative 'rubocop/cop/mixin/hash_transform_method'
 require_relative 'rubocop/cop/mixin/ignored_pattern'
@@ -119,6 +119,7 @@ require_relative 'rubocop/cop/mixin/surrounding_space'
 require_relative 'rubocop/cop/mixin/statement_modifier'
 require_relative 'rubocop/cop/mixin/string_help'
 require_relative 'rubocop/cop/mixin/string_literals_help'
+require_relative 'rubocop/cop/mixin/symbol_help'
 require_relative 'rubocop/cop/mixin/target_ruby_version'
 require_relative 'rubocop/cop/mixin/trailing_body'
 require_relative 'rubocop/cop/mixin/trailing_comma'
@@ -149,6 +150,7 @@ require_relative 'rubocop/cop/correctors/unused_arg_corrector'
 
 require_relative 'rubocop/cop/bundler/duplicated_gem'
 require_relative 'rubocop/cop/bundler/gem_comment'
+require_relative 'rubocop/cop/bundler/gem_version'
 require_relative 'rubocop/cop/bundler/insecure_protocol_source'
 require_relative 'rubocop/cop/bundler/ordered_gems'
 
@@ -222,7 +224,9 @@ require_relative 'rubocop/cop/layout/multiline_method_call_indentation'
 require_relative 'rubocop/cop/layout/multiline_method_definition_brace_layout'
 require_relative 'rubocop/cop/layout/multiline_operation_indentation'
 require_relative 'rubocop/cop/layout/parameter_alignment'
+require_relative 'rubocop/cop/layout/redundant_line_break'
 require_relative 'rubocop/cop/layout/rescue_ensure_alignment'
+require_relative 'rubocop/cop/layout/single_line_block_chain'
 require_relative 'rubocop/cop/layout/space_after_colon'
 require_relative 'rubocop/cop/layout/space_after_comma'
 require_relative 'rubocop/cop/layout/space_after_method_name'
@@ -284,6 +288,7 @@ 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_in_pattern'
 require_relative 'rubocop/cop/lint/empty_interpolation'
 require_relative 'rubocop/cop/lint/empty_when'
 require_relative 'rubocop/cop/lint/ensure_return'
@@ -487,6 +492,7 @@ require_relative 'rubocop/cop/style/if_unless_modifier_of_if_unless'
 require_relative 'rubocop/cop/style/if_with_boolean_literal_branches'
 require_relative 'rubocop/cop/style/if_with_semicolon'
 require_relative 'rubocop/cop/style/implicit_runtime_error'
+require_relative 'rubocop/cop/style/in_pattern_then'
 require_relative 'rubocop/cop/style/infinite_loop'
 require_relative 'rubocop/cop/style/inverse_methods'
 require_relative 'rubocop/cop/style/inline_comment'
@@ -497,6 +503,7 @@ require_relative 'rubocop/cop/style/lambda_call'
 require_relative 'rubocop/cop/style/line_end_concatenation'
 require_relative 'rubocop/cop/style/method_call_without_args_parentheses'
 require_relative 'rubocop/cop/style/method_call_with_args_parentheses'
+require_relative 'rubocop/cop/style/multiline_in_pattern_then'
 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'
@@ -547,6 +554,7 @@ require_relative 'rubocop/cop/style/percent_q_literals'
 require_relative 'rubocop/cop/style/perl_backrefs'
 require_relative 'rubocop/cop/style/preferred_hash_methods'
 require_relative 'rubocop/cop/style/proc'
+require_relative 'rubocop/cop/style/quoted_symbols'
 require_relative 'rubocop/cop/style/raise_args'
 require_relative 'rubocop/cop/style/random_with_offset'
 require_relative 'rubocop/cop/style/redundant_argument'
@@ -595,6 +603,7 @@ require_relative 'rubocop/cop/style/symbol_array'
 require_relative 'rubocop/cop/style/symbol_literal'
 require_relative 'rubocop/cop/style/symbol_proc'
 require_relative 'rubocop/cop/style/ternary_parentheses'
+require_relative 'rubocop/cop/style/top_level_method_definition'
 require_relative 'rubocop/cop/style/trailing_body_on_class'
 require_relative 'rubocop/cop/style/trailing_body_on_method_definition'
 require_relative 'rubocop/cop/style/trailing_body_on_module'

data/lib/rubocop/cached_data.rb

@@ -51,9 +51,7 @@ module RuboCop
         location = Parser::Source::Range.new(source_buffer,
                                              o['location']['begin_pos'],
                                              o['location']['end_pos'])
-        Cop::Offense.new(o['severity'], location,
-                         o['message'],
-                         o['cop_name'], o['status'].to_sym)
+        Cop::Offense.new(o['severity'], location, o['message'], o['cop_name'], o['status'].to_sym)
       end
     end
   end

data/lib/rubocop/cli.rb

@@ -78,12 +78,10 @@ module RuboCop
     end
 
     def validate_options_vs_config
-      if @options[:parallel] &&
-         !@config_store.for_pwd.for_all_cops['UseCache']
-        raise OptionArgumentError, '-P/--parallel uses caching to speed up ' \
-                                   'execution, so combining with AllCops: ' \
-                                   'UseCache: false is not allowed.'
-      end
+      return unless @options[:parallel] && !@config_store.for_pwd.for_all_cops['UseCache']
+
+      raise OptionArgumentError, '-P/--parallel uses caching to speed up execution, so combining ' \
+                                 'with AllCops: UseCache: false is not allowed.'
     end
 
     def act_on_options

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

@@ -14,10 +14,8 @@ module RuboCop
         PHASE_1 = 'Phase 1 of 2: run Layout/LineLength cop'
         PHASE_2 = 'Phase 2 of 2: run all cops'
 
-        PHASE_1_OVERRIDDEN =
-          '(skipped because the default Layout/LineLength:Max is overridden)'
-        PHASE_1_DISABLED =
-          '(skipped because Layout/LineLength is disabled)'
+        PHASE_1_OVERRIDDEN = '(skipped because the default Layout/LineLength:Max is overridden)'
+        PHASE_1_DISABLED = '(skipped because Layout/LineLength is disabled)'
 
         def run
           add_formatter
@@ -31,9 +29,7 @@ module RuboCop
         def maybe_run_line_length_cop
           if !line_length_enabled?(@config_store.for_pwd)
             skip_line_length_cop(PHASE_1_DISABLED)
-          elsif !same_max_line_length?(
-            @config_store.for_pwd, ConfigLoader.default_configuration
-          )
+          elsif !same_max_line_length?(@config_store.for_pwd, ConfigLoader.default_configuration)
             skip_line_length_cop(PHASE_1_OVERRIDDEN)
           else
             run_line_length_cop
@@ -71,10 +67,7 @@ module RuboCop
           @options.delete(:only)
           @config_store = ConfigStore.new
           # Save the todo configuration of the LineLength cop.
-          IO.read(AUTO_GENERATED_FILE)
-            .lines
-            .drop_while { |line| line.start_with?('#') }
-            .join
+          File.read(AUTO_GENERATED_FILE).lines.drop_while { |line| line.start_with?('#') }.join
         end
 
         def run_all_cops(line_length_contents)
@@ -82,9 +75,7 @@ module RuboCop
           result = execute_runner
           # This run was made with the current maximum length allowed, so append
           # the saved setting for LineLength.
-          File.open(AUTO_GENERATED_FILE, 'a') do |f|
-            f.write(line_length_contents)
-          end
+          File.open(AUTO_GENERATED_FILE, 'a') { |f| f.write(line_length_contents) }
           result
         end
 
@@ -96,8 +87,7 @@ module RuboCop
         end
 
         def add_formatter
-          @options[:formatters] << [Formatter::DisabledConfigFormatter,
-                                    AUTO_GENERATED_FILE]
+          @options[:formatters] << [Formatter::DisabledConfigFormatter, AUTO_GENERATED_FILE]
         end
 
         def execute_runner
@@ -125,9 +115,9 @@ module RuboCop
         end
 
         def existing_configuration(config_file)
-          IO.read(config_file, encoding: Encoding::UTF_8)
-            .sub(/^inherit_from: *[^\n]+/, '')
-            .sub(/^inherit_from: *(\n *- *[^\n]+)+/, '')
+          File.read(config_file, encoding: Encoding::UTF_8)
+              .sub(/^inherit_from: *[^\n]+/, '')
+              .sub(/^inherit_from: *(\n *- *[^\n]+)+/, '')
         end
 
         def write_config_file(file_name, file_string, rubocop_yml_contents)