rubocop 0.89.1 → 0.90.0

data/lib/rubocop/formatter/html_formatter.rb

@@ -90,9 +90,11 @@ module RuboCop
         end
 
         # Make Kernel#binding public.
+        # rubocop:disable Lint/UselessMethodDefinition
         def binding
           super
         end
+        # rubocop:enable Lint/UselessMethodDefinition
 
         def decorated_message(offense)
           offense.message.gsub(/`(.+?)`/) do

data/lib/rubocop/formatter/progress_formatter.rb

@@ -45,7 +45,8 @@ module RuboCop
 
         report_summary(inspected_files.size,
                        @total_offense_count,
-                       @total_correction_count)
+                       @total_correction_count,
+                       @total_correctable_count)
       end
 
       def report_file_as_mark(offenses)

data/lib/rubocop/formatter/quiet_formatter.rb

@@ -5,7 +5,7 @@ module RuboCop
     # If no offenses are found, no output is displayed.
     # Otherwise, SimpleTextFormatter's output is displayed.
     class QuietFormatter < SimpleTextFormatter
-      def report_summary(file_count, offense_count, correction_count)
+      def report_summary(file_count, offense_count, correction_count, correctable_count)
         super unless offense_count.zero?
       end
     end

data/lib/rubocop/formatter/simple_text_formatter.rb

@@ -23,6 +23,7 @@ module RuboCop
       def started(_target_files)
         @total_offense_count = 0
         @total_correction_count = 0
+        @total_correctable_count = 0
       end
 
       def file_finished(file, offenses)
@@ -35,7 +36,8 @@ module RuboCop
       def finished(inspected_files)
         report_summary(inspected_files.count,
                        @total_offense_count,
-                       @total_correction_count)
+                       @total_correction_count,
+                       @total_correctable_count)
       end
 
       def report_file(file, offenses)
@@ -52,11 +54,13 @@ module RuboCop
         end
       end
 
-      def report_summary(file_count, offense_count, correction_count)
+      def report_summary(file_count, offense_count, correction_count, correctable_count)
         report = Report.new(file_count,
                             offense_count,
                             correction_count,
-                            rainbow)
+                            correctable_count,
+                            rainbow,
+                            safe_auto_correct: @options[:safe_auto_correct])
 
         output.puts
         output.puts report.summary
@@ -66,7 +70,9 @@ module RuboCop
 
       def count_stats(offenses)
         @total_offense_count += offenses.count
-        @total_correction_count += offenses.count(&:corrected?)
+        corrected = offenses.count(&:corrected?)
+        @total_correction_count += corrected
+        @total_correctable_count += offenses.count(&:correctable?) - corrected
       end
 
       def colored_severity_code(offense)
@@ -96,16 +102,30 @@ module RuboCop
         include Colorizable
         include TextUtil
 
-        def initialize(file_count, offense_count, correction_count, rainbow)
+        # rubocop:disable Metrics/ParameterLists
+        def initialize(
+          file_count, offense_count, correction_count, correctable_count, rainbow,
+          safe_auto_correct: false
+        )
           @file_count = file_count
           @offense_count = offense_count
           @correction_count = correction_count
+          @correctable_count = correctable_count
           @rainbow = rainbow
+          @safe_auto_correct = safe_auto_correct
         end
+        # rubocop:enable Metrics/ParameterLists
 
         def summary
           if @correction_count.positive?
-            "#{files} inspected, #{offenses} detected, #{corrections} corrected"
+            if @correctable_count.positive?
+              "#{files} inspected, #{offenses} detected, #{corrections} corrected,"\
+                " #{correctable}"
+            else
+              "#{files} inspected, #{offenses} detected, #{corrections} corrected"
+            end
+          elsif @correctable_count.positive?
+            "#{files} inspected, #{offenses} detected, #{correctable}"
           else
             "#{files} inspected, #{offenses} detected"
           end
@@ -132,6 +152,16 @@ module RuboCop
 
           colorize(text, color)
         end
+
+        def correctable
+          if @safe_auto_correct
+            text = pluralize(@correctable_count, 'more offense')
+            "#{colorize(text, :yellow)} can be corrected with `rubocop -A`"
+          else
+            text = pluralize(@correctable_count, 'offense')
+            "#{colorize(text, :yellow)} auto-correctable"
+          end
+        end
       end
     end
   end

data/lib/rubocop/name_similarity.rb

@@ -2,6 +2,7 @@
 
 module RuboCop
   # Common functionality for finding names that are similar to a given name.
+  # @api private
   module NameSimilarity
     module_function
 

data/lib/rubocop/options.rb

@@ -8,6 +8,7 @@ module RuboCop
   class OptionArgumentError < StandardError; end
 
   # This class handles command line options.
+  # @api private
   class Options
     E_STDIN_NO_PATH = '-s/--stdin requires exactly one path, relative to the ' \
       'root of the project. RuboCop will use this path to determine which ' \
@@ -232,6 +233,7 @@ module RuboCop
   end
 
   # Validates option arguments and the options' compatibility with each other.
+  # @api private
   class OptionsValidator
     class << self
       # Cop name validation must be done later than option parsing, so it's not
@@ -393,6 +395,7 @@ module RuboCop
   end
 
   # This module contains help texts for command line options.
+  # @api private
   module OptionsHelp
     MAX_EXCL = RuboCop::Options::DEFAULT_MAXIMUM_EXCLUSION_ITEMS.to_s
     FORMATTER_OPTION_LIST = RuboCop::Formatter::FormatterSet::BUILTIN_FORMATTERS_FOR_KEYS.keys

data/lib/rubocop/remote_config.rb

@@ -5,6 +5,7 @@ require 'time'
 
 module RuboCop
   # Common methods and behaviors for dealing with remote config files.
+  # @api private
   class RemoteConfig
     attr_reader :uri
 

data/lib/rubocop/result_cache.rb

@@ -6,6 +6,7 @@ require 'etc'
 
 module RuboCop
   # Provides functionality for caching rubocop runs.
+  # @api private
   class ResultCache
     NON_CHANGING = %i[color format formatters out debug fail_level auto_correct
                       cache fail_fast stdin parallel].freeze

data/lib/rubocop/rspec/cop_helper.rb

@@ -17,7 +17,10 @@ module CopHelper
     RuboCop::Formatter::DisabledConfigFormatter.config_to_allow_offenses = {}
     RuboCop::Formatter::DisabledConfigFormatter.detected_styles = {}
     processed_source = parse_source(source, file)
-    raise 'Error parsing example code' unless processed_source.valid_syntax?
+    unless processed_source.valid_syntax?
+      raise 'Error parsing example code: ' \
+        "#{processed_source.diagnostics.map(&:render).join("\n")}"
+    end
 
     _investigate(cop, processed_source)
   end

data/lib/rubocop/rspec/expect_offense.rb

@@ -128,7 +128,10 @@ module RuboCop
         @processed_source = parse_source(expected_annotations.plain_source,
                                          file)
 
-        raise 'Error parsing example code' unless @processed_source.valid_syntax?
+        unless @processed_source.valid_syntax?
+          raise 'Error parsing example code: ' \
+            "#{@processed_source.diagnostics.map(&:render).join("\n")}"
+        end
 
         offenses = _investigate(cop, @processed_source)
         actual_annotations =
@@ -136,6 +139,8 @@ module RuboCop
 
         expect(actual_annotations).to eq(expected_annotations), ''
         expect(offenses.map(&:severity).uniq).to eq([severity]) if severity
+
+        offenses
       end
 
       def expect_correction(correction, loop: true)
@@ -236,10 +241,10 @@ module RuboCop
         def match_annotations?(other)
           annotations.zip(other.annotations) do |(_actual_line, actual_annotation),
                                                  (_expected_line, expected_annotation)|
-            if expected_annotation&.end_with?(ABBREV)
-              if actual_annotation.start_with?(expected_annotation[0...-ABBREV.length])
-                expected_annotation.replace(actual_annotation)
-              end
+            if expected_annotation&.end_with?(ABBREV) &&
+               actual_annotation.start_with?(expected_annotation[0...-ABBREV.length])
+
+              expected_annotation.replace(actual_annotation)
             end
           end
 

data/lib/rubocop/rspec/shared_contexts.rb

@@ -40,6 +40,18 @@ RSpec.shared_context 'isolated environment', :isolated_environment do
   end
 end
 
+RSpec.shared_context 'maintain registry', :restore_registry do
+  around(:each) do |example|
+    RuboCop::Cop::Registry.with_temporary_global { example.run }
+  end
+
+  def stub_cop_class(name, inherit: RuboCop::Cop::Base, &block)
+    klass = Class.new(inherit, &block)
+    stub_const(name, klass)
+    klass
+  end
+end
+
 # This context assumes nothing and defines `cop`, among others.
 RSpec.shared_context 'config', :config do # rubocop:disable Metrics/BlockLength
   ### Meant to be overridden at will

data/lib/rubocop/runner.rb

@@ -17,6 +17,7 @@ module RuboCop
       end
     end
 
+    # @api private
     MAX_ITERATIONS = 200
 
     attr_reader :errors, :warnings

data/lib/rubocop/string_interpreter.rb

@@ -17,6 +17,9 @@ module RuboCop
                             u\{[^}]*\}        |   # extended unicode escape
                             .                     # any other escaped char
                           )/x.freeze
+
+    private_constant :STRING_ESCAPES, :STRING_ESCAPE_REGEX
+
     class << self
       def interpret(string)
         # We currently don't handle \cx, \C-x, and \M-x

data/lib/rubocop/target_finder.rb

@@ -3,6 +3,7 @@
 module RuboCop
   # This class finds target files to inspect by scanning the directory tree
   # and picking ruby files.
+  # @api private
   class TargetFinder
     def initialize(config_store, options = {})
       @config_store = config_store

data/lib/rubocop/target_ruby.rb

@@ -2,6 +2,7 @@
 
 module RuboCop
   # The kind of Ruby that code inspected by RuboCop is written in.
+  # @api private
   class TargetRuby
     KNOWN_RUBIES = [2.4, 2.5, 2.6, 2.7, 2.8].freeze
     DEFAULT_VERSION = KNOWN_RUBIES.first
@@ -12,6 +13,7 @@ module RuboCop
     private_constant :KNOWN_RUBIES, :OBSOLETE_RUBIES
 
     # A place where information about a target ruby version is found.
+    # @api private
     class Source
       attr_reader :version, :name
 
@@ -26,6 +28,7 @@ module RuboCop
     end
 
     # The target ruby version may be configured in RuboCop's config.
+    # @api private
     class RuboCopConfig < Source
       def name
         "`TargetRubyVersion` parameter (in #{@config.smart_loaded_path})"
@@ -39,6 +42,7 @@ module RuboCop
     end
 
     # The target ruby version may be found in a .ruby-version file.
+    # @api private
     class RubyVersionFile < Source
       FILENAME = '.ruby-version'
 
@@ -68,6 +72,7 @@ module RuboCop
     end
 
     # The lock file of Bundler may identify the target ruby version.
+    # @api private
     class BundlerLockFile < Source
       def name
         "`#{bundler_lock_file_path}`"
@@ -108,6 +113,7 @@ module RuboCop
     end
 
     # If all else fails, a default version will be picked.
+    # @api private
     class Default < Source
       def name
         'default'

data/lib/rubocop/version.rb

@@ -3,12 +3,13 @@
 module RuboCop
   # This module holds the RuboCop version information.
   module Version
-    STRING = '0.89.1'
+    STRING = '0.90.0'
 
     MSG = '%<version>s (using Parser %<parser_version>s, '\
           'rubocop-ast %<rubocop_ast_version>s, ' \
           'running on %<ruby_engine>s %<ruby_version>s %<ruby_platform>s)'
 
+    # @api private
     def self.version(debug: false)
       if debug
         format(MSG, version: STRING, parser_version: Parser::VERSION,

data/lib/rubocop/yaml_duplication_checker.rb

@@ -2,6 +2,7 @@
 
 module RuboCop
   # Find duplicated keys from YAML.
+  # @api private
   module YAMLDuplicationChecker
     def self.check(yaml_string, filename, &on_duplicated)
       # Ruby 2.6+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop
 version: !ruby/object:Gem::Version
-  version: 0.89.1
+  version: 0.90.0
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-10 00:00:00.000000000 Z
+date: 2020-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parallel
@@ -226,6 +226,7 @@ files:
 - lib/rubocop/cop/correctors/space_corrector.rb
 - lib/rubocop/cop/correctors/string_literal_corrector.rb
 - lib/rubocop/cop/correctors/unused_arg_corrector.rb
+- lib/rubocop/cop/documentation.rb
 - lib/rubocop/cop/force.rb
 - lib/rubocop/cop/gemspec/duplicated_assignment.rb
 - lib/rubocop/cop/gemspec/ordered_dependencies.rb
@@ -261,6 +262,7 @@ files:
 - lib/rubocop/cop/layout/empty_comment.rb
 - lib/rubocop/cop/layout/empty_line_after_guard_clause.rb
 - lib/rubocop/cop/layout/empty_line_after_magic_comment.rb
+- lib/rubocop/cop/layout/empty_line_after_multiline_condition.rb
 - lib/rubocop/cop/layout/empty_line_between_defs.rb
 - lib/rubocop/cop/layout/empty_lines.rb
 - lib/rubocop/cop/layout/empty_lines_around_access_modifier.rb
@@ -352,12 +354,14 @@ files:
 - lib/rubocop/cop/lint/duplicate_elsif_condition.rb
 - lib/rubocop/cop/lint/duplicate_hash_key.rb
 - lib/rubocop/cop/lint/duplicate_methods.rb
+- lib/rubocop/cop/lint/duplicate_require.rb
 - lib/rubocop/cop/lint/duplicate_rescue_exception.rb
 - lib/rubocop/cop/lint/each_with_object_argument.rb
 - lib/rubocop/cop/lint/else_layout.rb
 - lib/rubocop/cop/lint/empty_conditional_body.rb
 - lib/rubocop/cop/lint/empty_ensure.rb
 - lib/rubocop/cop/lint/empty_expression.rb
+- lib/rubocop/cop/lint/empty_file.rb
 - lib/rubocop/cop/lint/empty_interpolation.rb
 - lib/rubocop/cop/lint/empty_when.rb
 - lib/rubocop/cop/lint/ensure_return.rb
@@ -417,6 +421,7 @@ files:
 - lib/rubocop/cop/lint/syntax.rb
 - lib/rubocop/cop/lint/to_json.rb
 - lib/rubocop/cop/lint/top_level_return_with_argument.rb
+- lib/rubocop/cop/lint/trailing_comma_in_attribute_declaration.rb
 - lib/rubocop/cop/lint/underscore_prefixed_variable_name.rb
 - lib/rubocop/cop/lint/unified_integer.rb
 - lib/rubocop/cop/lint/unreachable_code.rb
@@ -428,6 +433,7 @@ files:
 - lib/rubocop/cop/lint/useless_access_modifier.rb
 - lib/rubocop/cop/lint/useless_assignment.rb
 - lib/rubocop/cop/lint/useless_else_without_rescue.rb
+- lib/rubocop/cop/lint/useless_method_definition.rb
 - lib/rubocop/cop/lint/useless_setter_call.rb
 - lib/rubocop/cop/lint/void.rb
 - lib/rubocop/cop/message_annotator.rb
@@ -454,6 +460,7 @@ files:
 - lib/rubocop/cop/mixin/check_assignment.rb
 - lib/rubocop/cop/mixin/check_line_breakable.rb
 - lib/rubocop/cop/mixin/code_length.rb
+- lib/rubocop/cop/mixin/comments_help.rb
 - lib/rubocop/cop/mixin/configurable_enforced_style.rb
 - lib/rubocop/cop/mixin/configurable_formatting.rb
 - lib/rubocop/cop/mixin/configurable_max.rb
@@ -554,10 +561,12 @@ files:
 - lib/rubocop/cop/style/class_and_module_children.rb
 - lib/rubocop/cop/style/class_check.rb
 - lib/rubocop/cop/style/class_methods.rb
+- lib/rubocop/cop/style/class_methods_definitions.rb
 - lib/rubocop/cop/style/class_vars.rb
 - lib/rubocop/cop/style/collection_methods.rb
 - lib/rubocop/cop/style/colon_method_call.rb
 - lib/rubocop/cop/style/colon_method_definition.rb
+- lib/rubocop/cop/style/combinable_loops.rb
 - lib/rubocop/cop/style/command_literal.rb
 - lib/rubocop/cop/style/comment_annotation.rb
 - lib/rubocop/cop/style/commented_keyword.rb
@@ -611,6 +620,7 @@ files:
 - lib/rubocop/cop/style/inline_comment.rb
 - lib/rubocop/cop/style/inverse_methods.rb
 - lib/rubocop/cop/style/ip_addresses.rb
+- lib/rubocop/cop/style/keyword_parameters_order.rb
 - lib/rubocop/cop/style/lambda.rb
 - lib/rubocop/cop/style/lambda_call.rb
 - lib/rubocop/cop/style/line_end_concatenation.rb
@@ -678,6 +688,7 @@ files:
 - lib/rubocop/cop/style/redundant_regexp_escape.rb
 - lib/rubocop/cop/style/redundant_return.rb
 - lib/rubocop/cop/style/redundant_self.rb
+- lib/rubocop/cop/style/redundant_self_assignment.rb
 - lib/rubocop/cop/style/redundant_sort.rb
 - lib/rubocop/cop/style/redundant_sort_by.rb
 - lib/rubocop/cop/style/regexp_literal.rb
@@ -694,6 +705,7 @@ files:
 - lib/rubocop/cop/style/single_line_block_params.rb
 - lib/rubocop/cop/style/single_line_methods.rb
 - lib/rubocop/cop/style/slicing_with_range.rb
+- lib/rubocop/cop/style/sole_nested_conditional.rb
 - lib/rubocop/cop/style/special_global_vars.rb
 - lib/rubocop/cop/style/stabby_lambda_parentheses.rb
 - lib/rubocop/cop/style/stderr_puts.rb
@@ -743,6 +755,7 @@ files:
 - lib/rubocop/core_ext/string.rb
 - lib/rubocop/error.rb
 - lib/rubocop/ext/processed_source.rb
+- lib/rubocop/ext/regexp_node.rb
 - lib/rubocop/file_finder.rb
 - lib/rubocop/formatter/auto_gen_config_formatter.rb
 - lib/rubocop/formatter/base_formatter.rb