rubocop 1.8.1 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe7ec80b8cde2a075fee5a5658abf6dc74889091dae29e88482107983d2de270
-  data.tar.gz: 7852fe6a6d0ba9cae98439cba0dfbfda659a5a434f62eca318bcd5bc45dfd3c4
+  metadata.gz: ec2d9f7ba4857375232c4e42ea44accdb38b2873c83315f3029a546e315622e0
+  data.tar.gz: 01df5c9957cca7c79cf8cab073c1bae675d684761561835d6d93f554f3743905
 SHA512:
-  metadata.gz: 4239a27259a39584a544ed4bfc7c6025ece2198d463f8a2918a98e5560cec9a5a2ea5b978f0d253e61ea700446bb49f705627d8b8e41d4ead0fef35b23b14d98
-  data.tar.gz: 59746b47f6bbe92dec5f6d79395ad6cd1a175d3a186005412953f0a849192673084b426bd14f6e9ac83e11dfaa0b27fc15718857b29ca6d359e2c9d387bca9c2
+  metadata.gz: 55a5a8deae643b6d76dc5220c7136a7c5413ecb93ca85ec61dcd3aa9ff0adb3c1ab356ec81f72273771ab3125317fc105bfcaf0c7e1e1ae07f6295c7fa33c26e
+  data.tar.gz: 642d925df9f18c6c42b532eb0193965c6a85a93bd9339523757882eb6e9029052161a32bbc4421e454a210fe2ab5318ae64459dc4a9d792ee0cb5e4b259568ff

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.8', require: false
+gem 'rubocop', '~> 1.9', require: false
 ```
 
 See [versioning](https://docs.rubocop.org/rubocop/1.0/versioning.html) for further details.

data/config/default.yml

@@ -1806,6 +1806,17 @@ Lint/NumberConversion:
     - Time
     - DateTime
 
+Lint/NumberedParameterAssignment:
+  Description: 'Checks for uses of numbered parameter assignment.'
+  Enabled: pending
+  VersionAdded: '1.9'
+
+Lint/OrAssignmentToConstant:
+  Description: 'Checks unintended or-assignment to constant.'
+  Enabled: pending
+  Safe: false
+  VersionAdded: '1.9'
+
 Lint/OrderedMagicComments:
   Description: 'Checks the proper ordering of magic comments and whether a magic comment is not placed before a shebang.'
   Enabled: true
@@ -2032,12 +2043,16 @@ Lint/SuppressedException:
   VersionAdded: '0.9'
   VersionChanged: '0.81'
 
+Lint/SymbolConversion:
+  Description: 'Checks for unnecessary symbol conversions.'
+  Enabled: pending
+  VersionAdded: '1.9'
+
 Lint/Syntax:
-  Description: 'Checks syntax error.'
+  Description: 'Checks for syntax errors.'
   Enabled: true
   VersionAdded: '0.9'
 
-
 Lint/ToEnumArguments:
   Description: 'This cop ensures that `to_enum`/`enum_for`, called for the current method, has correct arguments.'
   Enabled: pending
@@ -2058,6 +2073,11 @@ Lint/TrailingCommaInAttributeDeclaration:
   Enabled: true
   VersionAdded: '0.90'
 
+Lint/TripleQuotes:
+  Description: 'Checks for useless triple quote constructs.'
+  Enabled: pending
+  VersionAdded: '1.9'
+
 Lint/UnderscorePrefixedVariableName:
   Description: 'Do not use prefix `_` for a variable that is used.'
   Enabled: true
@@ -2689,7 +2709,8 @@ Style/AsciiComments:
   Enabled: true
   VersionAdded: '0.9'
   VersionChanged: '0.52'
-  AllowedChars: []
+  AllowedChars:
+    - ©
 
 Style/Attr:
   Description: 'Checks for uses of Module#attr.'
@@ -3120,6 +3141,8 @@ Style/DisableCopsWithinSourceCodeDirective:
                  Forbids disabling/enabling cops within source code.
   Enabled: false
   VersionAdded: '0.82'
+  VersionChanged: '1.9'
+  AllowedCops: []
 
 Style/DocumentDynamicEvalDefinition:
   Description: >-
@@ -3291,7 +3314,8 @@ Style/FloatDivision:
   Reference: 'https://blog.rubystyle.guide/ruby/2019/06/21/float-division.html'
   Enabled: true
   VersionAdded: '0.72'
-  VersionChanged: '1.6'
+  VersionChanged: '1.9'
+  Safe: false
   EnforcedStyle: single_coerce
   SupportedStyles:
     - left_coerce
@@ -3339,6 +3363,7 @@ Style/FormatStringToken:
   MaxUnannotatedPlaceholdersAllowed: 1
   VersionAdded: '0.49'
   VersionChanged: '1.0'
+  IgnoredMethods: []
 
 Style/FrozenStringLiteralComment:
   Description: >-
@@ -3492,6 +3517,11 @@ Style/IfUnlessModifierOfIfUnless:
   VersionAdded: '0.39'
   VersionChanged: '0.87'
 
+Style/IfWithBooleanLiteralBranches:
+  Description: 'Checks for redundant `if` with boolean literal branches.'
+  Enabled: pending
+  VersionAdded: '1.9'
+
 Style/IfWithSemicolon:
   Description: 'Do not use if x; .... Use the ternary operator instead.'
   StyleGuide: '#no-semicolon-ifs'

data/lib/rubocop.rb

@@ -312,6 +312,8 @@ require_relative 'rubocop/cop/lint/no_return_in_begin_end_blocks'
 require_relative 'rubocop/cop/lint/non_deterministic_require_order'
 require_relative 'rubocop/cop/lint/non_local_exit_from_iterator'
 require_relative 'rubocop/cop/lint/number_conversion'
+require_relative 'rubocop/cop/lint/numbered_parameter_assignment'
+require_relative 'rubocop/cop/lint/or_assignment_to_constant'
 require_relative 'rubocop/cop/lint/ordered_magic_comments'
 require_relative 'rubocop/cop/lint/out_of_range_regexp_ref'
 require_relative 'rubocop/cop/lint/parentheses_as_grouped_expression'
@@ -344,11 +346,13 @@ require_relative 'rubocop/cop/lint/shadowed_exception'
 require_relative 'rubocop/cop/lint/shadowing_outer_local_variable'
 require_relative 'rubocop/cop/lint/struct_new_override'
 require_relative 'rubocop/cop/lint/suppressed_exception'
+require_relative 'rubocop/cop/lint/symbol_conversion'
 require_relative 'rubocop/cop/lint/syntax'
 require_relative 'rubocop/cop/lint/to_enum_arguments'
 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/triple_quotes'
 require_relative 'rubocop/cop/lint/underscore_prefixed_variable_name'
 require_relative 'rubocop/cop/lint/unexpected_block_arity'
 require_relative 'rubocop/cop/lint/unified_integer'
@@ -477,6 +481,7 @@ require_relative 'rubocop/cop/style/identical_conditional_branches'
 require_relative 'rubocop/cop/style/if_inside_else'
 require_relative 'rubocop/cop/style/if_unless_modifier'
 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/infinite_loop'

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

@@ -9,6 +9,7 @@ module RuboCop
         self.command_name = :auto_gen_config
 
         AUTO_GENERATED_FILE = '.rubocop_todo.yml'
+        YAML_OPTIONAL_DOC_START = /\A---(\s+#|\s*\z)/.freeze
 
         PHASE_1 = 'Phase 1 of 2: run Layout/LineLength cop'
         PHASE_2 = 'Phase 2 of 2: run all cops'
@@ -130,10 +131,10 @@ module RuboCop
         end
 
         def write_config_file(file_name, file_string, rubocop_yml_contents)
-          File.open(file_name, 'w') do |f|
-            f.write "inherit_from:#{file_string}\n"
-            f.write "\n#{rubocop_yml_contents}" if /\S/.match?(rubocop_yml_contents)
-          end
+          lines = /\S/.match?(rubocop_yml_contents) ? rubocop_yml_contents.split("\n", -1) : []
+          doc_start_index = lines.index { |line| YAML_OPTIONAL_DOC_START.match?(line) } || -1
+          lines.insert(doc_start_index + 1, "inherit_from:#{file_string}\n")
+          File.open(file_name, 'w') { |f| f.write lines.join("\n") }
         end
       end
     end

data/lib/rubocop/config.rb

@@ -33,8 +33,8 @@ module RuboCop
       @validator = ConfigValidator.new(self)
     end
 
-    def self.create(hash, path)
-      new(hash, path).check
+    def self.create(hash, path, check: true)
+      new(hash, path).tap { |config| config.check if check }
     end
 
     def loaded_features

data/lib/rubocop/config_loader.rb

@@ -25,17 +25,18 @@ module RuboCop
       attr_accessor :debug, :ignore_parent_exclusion,
                     :disable_pending_cops, :enable_pending_cops
       attr_writer :default_configuration, :project_root
+      attr_reader :loaded_features
 
       alias debug? debug
       alias ignore_parent_exclusion? ignore_parent_exclusion
 
       def clear_options
         @debug = nil
-        @loaded_features = []
+        @loaded_features = Set.new
         FileFinder.root_level = nil
       end
 
-      def load_file(file)
+      def load_file(file, check: true)
         path = file_path(file)
 
         hash = load_yaml_configuration(path)
@@ -52,7 +53,7 @@ module RuboCop
 
         hash.delete('inherit_from')
 
-        Config.create(hash, path)
+        Config.create(hash, path, check: check)
       end
 
       def load_yaml_configuration(absolute_path)
@@ -99,10 +100,10 @@ module RuboCop
           find_user_xdg_config || DEFAULT_FILE
       end
 
-      def configuration_from_file(config_file)
+      def configuration_from_file(config_file, check: true)
         return default_configuration if config_file == DEFAULT_FILE
 
-        config = load_file(config_file)
+        config = load_file(config_file, check: check)
         if ignore_parent_exclusion?
           print 'Ignoring AllCops/Exclude from parent folders' if debug?
         else
@@ -174,19 +175,11 @@ module RuboCop
         resolver.merge_with_default(config, config_file, unset_nil: unset_nil)
       end
 
-      def loaded_features
-        @loaded_features.flatten.compact.uniq
-      end
-
       # @api private
       # Used to add features that were required inside a config or from
       # the CLI using `--require`.
       def add_loaded_features(loaded_features)
-        if instance_variable_defined?(:@loaded_features)
-          instance_variable_get(:@loaded_features) << loaded_features
-        else
-          instance_variable_set(:@loaded_features, [loaded_features])
-        end
+        @loaded_features.merge(Array(loaded_features))
       end
 
       private

data/lib/rubocop/config_store.rb

@@ -4,6 +4,9 @@ module RuboCop
   # Handles caching of configurations and association of inspected
   # ruby files to configurations.
   class ConfigStore
+    attr_reader :validated
+    alias validated? validated
+
     def initialize
       # @options_config stores a config that is specified in the command line.
       # This takes precedence over configs located in any directories
@@ -17,6 +20,9 @@ module RuboCop
       # @object_cache maps configuration file paths to
       # configuration objects so we only need to load them once.
       @object_cache = {}
+
+      # By default the config is validated before it can be used.
+      @validated = true
     end
 
     def options_config=(options_config)
@@ -29,6 +35,11 @@ module RuboCop
       @options_config = ConfigLoader.default_configuration
     end
 
+    def unvalidated
+      @validated = false
+      self
+    end
+
     def for_file(file)
       for_dir(File.dirname(file))
     end
@@ -55,7 +66,7 @@ module RuboCop
       path = @path_cache[dir]
       @object_cache[path] ||= begin
         print "For #{dir}: " if ConfigLoader.debug?
-        ConfigLoader.configuration_from_file(path)
+        ConfigLoader.configuration_from_file(path, check: validated?)
       end
     end
   end

data/lib/rubocop/cop/base.rb

@@ -351,7 +351,7 @@ module RuboCop
       def use_corrector(range, corrector)
         if autocorrect?
           attempt_correction(range, corrector)
-        elsif corrector
+        elsif corrector && cop_config.fetch('AutoCorrect', true)
           :uncorrected
         else
           :unsupported

data/lib/rubocop/cop/generator.rb

@@ -81,9 +81,7 @@ module RuboCop
       SPEC_TEMPLATE = <<~SPEC
         # frozen_string_literal: true
 
-        RSpec.describe RuboCop::Cop::%<department>s::%<cop_name>s do
-          subject(:cop) { described_class.new(config) }
-
+        RSpec.describe RuboCop::Cop::%<department>s::%<cop_name>s, :config do
           let(:config) { RuboCop::Config.new }
 
           # TODO: Write test code

data/lib/rubocop/cop/internal_affairs.rb

@@ -1,10 +1,14 @@
 # frozen_string_literal: true
 
+require_relative 'internal_affairs/empty_line_between_expect_offense_and_correction'
+require_relative 'internal_affairs/example_description'
 require_relative 'internal_affairs/method_name_equal'
 require_relative 'internal_affairs/node_destructuring'
 require_relative 'internal_affairs/node_type_predicate'
 require_relative 'internal_affairs/offense_location_keyword'
-require_relative 'internal_affairs/redundant_message_argument'
+require_relative 'internal_affairs/redundant_described_class_as_subject'
+require_relative 'internal_affairs/redundant_let_rubocop_config_new'
 require_relative 'internal_affairs/redundant_location_argument'
+require_relative 'internal_affairs/redundant_message_argument'
 require_relative 'internal_affairs/style_detected_api_use'
 require_relative 'internal_affairs/useless_message_assertion'

data/lib/rubocop/cop/internal_affairs/empty_line_between_expect_offense_and_correction.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module InternalAffairs
+      # This cop checks whether `expect_offense` and correction expectation methods
+      # (i.e. `expect_correction` and `expect_no_corrections`) are separated by empty line.
+      #
+      # @example
+      #   # bad
+      #   it 'registers and corrects an offense' do
+      #     expect_offense(<<~RUBY)
+      #       bad_method
+      #       ^^^^^^^^^^ Use `good_method`.
+      #     RUBY
+      #     expect_correction(<<~RUBY)
+      #       good_method
+      #     RUBY
+      #   end
+      #
+      #   # good
+      #   it 'registers and corrects an offense' do
+      #     expect_offense(<<~RUBY)
+      #       bad_method
+      #       ^^^^^^^^^^ Use `good_method`.
+      #     RUBY
+      #
+      #     expect_correction(<<~RUBY)
+      #       good_method
+      #     RUBY
+      #   end
+      #
+      class EmptyLineBetweenExpectOffenseAndCorrection < Base
+        extend AutoCorrector
+
+        MSG = 'Add empty line between `expect_offense` and `%<expect_correction>s`.'
+        RESTRICT_ON_SEND = %i[expect_offense].freeze
+        CORRECTION_EXPECTATION_METHODS = %i[expect_correction expect_no_corrections].freeze
+
+        def on_send(node)
+          return unless (next_sibling = node.right_sibling) && next_sibling.send_type?
+
+          method_name = next_sibling.method_name
+          return unless CORRECTION_EXPECTATION_METHODS.include?(method_name)
+
+          range = offense_range(node)
+          return unless range.last_line + 1 == next_sibling.loc.line
+
+          add_offense(range, message: format(MSG, expect_correction: method_name)) do |corrector|
+            corrector.insert_after(range, "\n")
+          end
+        end
+
+        private
+
+        def offense_range(node)
+          first_argument = node.first_argument
+
+          if first_argument.respond_to?(:heredoc?) && first_argument.heredoc?
+            first_argument.loc.heredoc_end
+          else
+            node
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/internal_affairs/example_description.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module InternalAffairs
+      # Checks that RSpec examples that use `expects_offense`
+      # or `expects_no_offenses` do not have conflicting
+      # descriptions.
+      #
+      # @example
+      #   # bad
+      #   it 'does not register an offense' do
+      #     expect_offense('...')
+      #   end
+      #
+      #   it 'registers an offense' do
+      #     expect_no_offenses('...')
+      #   end
+      #
+      #   # good
+      #   it 'registers an offense' do
+      #     expect_offense('...')
+      #   end
+      #
+      #   it 'does not register an offense' do
+      #     expect_no_offenses('...')
+      #   end
+      class ExampleDescription < Base
+        class << self
+          attr_accessor :descriptions
+        end
+
+        MSG = 'Description does not match use of `%<method_name>s`.'
+
+        RESTRICT_ON_SEND = %i[
+          expect_offense
+          expect_no_offenses
+          expect_correction
+          expect_no_corrections
+        ].to_set.freeze
+
+        EXPECT_NO_OFFENSES_INCORRECT_DESCRIPTIONS = [
+          /^(adds|registers|reports|finds) (an? )?offense/,
+          /^flags\b/
+        ].freeze
+
+        EXPECT_OFFENSE_INCORRECT_DESCRIPTIONS = [
+          /^(does not|doesn't) (register|find|flag|report)/,
+          /^(does not|doesn't) add (a|an|any )?offense/
+        ].freeze
+
+        EXPECT_NO_CORRECTIONS_INCORRECT_DESCRIPTIONS = [
+          /^(auto[- ]?)?correct/
+        ].freeze
+
+        EXPECT_CORRECTION_INCORRECT_DESCRIPTIONS = [
+          /\b(does not|doesn't) (auto[- ]?)?correct/
+        ].freeze
+
+        def_node_matcher :offense_example?, <<~PATTERN
+          (block
+            (send _ {:it :specify} $_description)
+            _args
+            `(send nil? %RESTRICT_ON_SEND ...)
+          )
+        PATTERN
+
+        def on_send(node)
+          parent = node.each_ancestor(:block).first
+          return unless parent && (description = offense_example?(parent))
+
+          method_name = node.method_name
+          message = format(MSG, method_name: method_name)
+
+          regexp_group = self.class.const_get("#{method_name}_incorrect_descriptions".upcase)
+          check_description(description, regexp_group, message)
+        end
+
+        private
+
+        def check_description(description, regexps, message)
+          return unless regexps.any? { |regexp| regexp.match?(description.value) }
+
+          add_offense(description, message: message)
+        end
+      end
+    end
+  end
+end