rubocop 0.72.0 → 0.76.0

data/lib/rubocop/formatter/tap_formatter.rb

@@ -42,9 +42,14 @@ module RuboCop
       end
 
       def report_offense(file, offense)
-        output.printf("# %s:%d:%d: %s: %s\n",
-                      cyan(smart_path(file)), offense.line, offense.real_column,
-                      colored_severity_code(offense), message(offense))
+        output.printf(
+          "# %<path>s:%<line>d:%<column>d: %<severity>s: %<message>s\n",
+          path: cyan(smart_path(file)),
+          line: offense.line,
+          column: offense.real_column,
+          severity: colored_severity_code(offense),
+          message: message(offense)
+        )
 
         # rubocop:disable Lint/HandleExceptions
         begin
@@ -63,7 +68,15 @@ module RuboCop
       end
 
       def message(offense)
-        message = offense.corrected? ? '[Corrected] ' : ''
+        message =
+          if offense.corrected_with_todo?
+            '[Todo] '
+          elsif offense.corrected?
+            '[Corrected] '
+          else
+            ''
+          end
+
         "#{message}#{annotate_message(offense.message)}"
       end
     end

data/lib/rubocop/magic_comment.rb

@@ -42,6 +42,10 @@ module RuboCop
       frozen_string_literal == true
     end
 
+    def valid_literal_value?
+      [true, false].include?(frozen_string_literal)
+    end
+
     # Was a magic comment for the frozen string literal found?
     #
     # @return [Boolean]

data/lib/rubocop/node_pattern.rb

@@ -429,12 +429,13 @@ module RuboCop
         [0..Float::INFINITY, 'true']
       end
 
+      # rubocop:disable Metrics/AbcSize
       # rubocop:disable Metrics/MethodLength
       def compile_any_order(capture_all = nil)
         rest = capture_rest = nil
         patterns = []
         with_temp_variables do |child, matched|
-          tokens_until('>', 'any child').each do
+          tokens_until('>', 'any child') do
             fail_due_to 'ellipsis must be at the end of <>' if rest
             token = tokens.shift
             case token
@@ -448,6 +449,7 @@ module RuboCop
         end
       end
       # rubocop:enable Metrics/MethodLength
+      # rubocop:enable Metrics/AbcSize
 
       def insure_same_captures(enum, what)
         return to_enum __method__, enum, what unless block_given?
@@ -612,7 +614,7 @@ module RuboCop
       end
 
       def emit_method_code
-        <<-RUBY
+        <<~RUBY
           return unless #{@match_code}
           block_given? ? #{emit_yield_capture} : (return #{emit_retval})
         RUBY
@@ -746,7 +748,7 @@ module RuboCop
 
       def node_search_body(method_name, trailing_params, prelude, match_code,
                            on_match)
-        <<-RUBY
+        <<~RUBY
           def #{method_name}(node0#{trailing_params})
             #{prelude}
             node0.each_node do |node|

data/lib/rubocop/options.rb

@@ -109,6 +109,8 @@ module RuboCop
         @validator.validate_exclude_limit_option
       end
 
+      option(opts, '--disable-uncorrectable')
+
       option(opts, '--no-offense-counts') do
         @options[:no_offense_counts] = true
       end
@@ -253,10 +255,17 @@ module RuboCop
       @options = options
     end
 
+    def validate_cop_options
+      %i[only except].each do |opt|
+        OptionsValidator.validate_cop_list(@options[opt])
+      end
+    end
+
+    # rubocop:disable Metrics/AbcSize
     def validate_compatibility # rubocop:disable Metrics/MethodLength
-      if only_includes_unneeded_disable?
-        raise OptionArgumentError, 'Lint/UnneededCopDisableDirective can not ' \
-                                   'be used with --only.'
+      if only_includes_redundant_disable?
+        raise OptionArgumentError, 'Lint/RedundantCopDisableDirective can ' \
+                                   'not be used with --only.'
       end
       if except_syntax?
         raise OptionArgumentError, 'Syntax checking can not be turned off.'
@@ -270,6 +279,7 @@ module RuboCop
           '--display-only-fail-level-offenses'
       end
       validate_auto_gen_config
+      validate_auto_correct
       validate_parallel
 
       return if incompatible_options.size <= 1
@@ -277,6 +287,7 @@ module RuboCop
       raise OptionArgumentError, 'Incompatible cli options: ' \
                                  "#{incompatible_options.inspect}"
     end
+    # rubocop:enable Metrics/AbcSize
 
     def validate_auto_gen_config
       return if @options.key?(:auto_gen_config)
@@ -292,6 +303,15 @@ module RuboCop
       end
     end
 
+    def validate_auto_correct
+      return if @options.key?(:auto_correct)
+      return unless @options.key?(:disable_uncorrectable)
+
+      raise OptionArgumentError,
+            format('--%<flag>s can only be used together with --auto-correct.',
+                   flag: '--disable-uncorrectable')
+    end
+
     def validate_parallel
       return unless @options.key?(:parallel)
 
@@ -318,10 +338,10 @@ module RuboCop
       end
     end
 
-    def only_includes_unneeded_disable?
+    def only_includes_redundant_disable?
       @options.key?(:only) &&
-        (@options[:only] & %w[Lint/UnneededCopDisableDirective
-                              UnneededCopDisableDirective]).any?
+        (@options[:only] & %w[Lint/RedundantCopDisableDirective
+                              RedundantCopDisableDirective]).any?
     end
 
     def display_only_fail_level_offenses_with_autocorrect?
@@ -353,8 +373,9 @@ module RuboCop
   # This module contains help texts for command line options.
   module OptionsHelp
     MAX_EXCL = RuboCop::Options::DEFAULT_MAXIMUM_EXCLUSION_ITEMS.to_s
-
     # rubocop:disable Metrics/LineLength
+    FORMATTER_OPTION_LIST = RuboCop::Formatter::FormatterSet::BUILTIN_FORMATTERS_FOR_KEYS.keys
+
     TEXT = {
       only:                             'Run only the given cop(s).',
       only_guide_cops:                  ['Run only cops for rules that link to a',
@@ -378,6 +399,9 @@ module RuboCop
       exclude_limit:                    ['Used together with --auto-gen-config to',
                                          'set the limit for how many Exclude',
                                          "properties to generate. Default is #{MAX_EXCL}."],
+      disable_uncorrectable:            ['Used with --auto-correct to annotate any',
+                                         'offenses that do not support autocorrect',
+                                         'with `rubocop:todo` comments.'],
       force_exclusion:                  ['Force excluding files specified in the',
                                          'configuration `Exclude` even if they are',
                                          'explicitly passed as arguments.'],
@@ -390,20 +414,8 @@ module RuboCop
       format:                           ['Choose an output formatter. This option',
                                          'can be specified multiple times to enable',
                                          'multiple formatters at the same time.',
-                                         '  [p]rogress (default)',
-                                         '  [s]imple',
-                                         '  [c]lang',
-                                         '  [d]isabled cops via inline comments',
-                                         '  [fu]ubar',
-                                         '  [e]macs',
-                                         '  [j]son',
-                                         '  [h]tml',
-                                         '  [fi]les',
-                                         '  [o]ffenses',
-                                         '  [w]orst',
-                                         '  [t]ap',
-                                         '  [q]uiet',
-                                         '  [a]utogenconf',
+                                         '[p]rogress is used by default',
+                                         *FORMATTER_OPTION_LIST.map { |item| "  #{item}" },
                                          '  custom formatter class name'],
       out:                              ['Write output to a file instead of STDOUT.',
                                          'This option applies to the previously',

data/lib/rubocop/path_util.rb

@@ -51,7 +51,7 @@ module RuboCop
 
     # Returns true for an absolute Unix or Windows path.
     def absolute?(path)
-      path =~ %r{\A([A-Z]:)?/}
+      path =~ %r{\A([A-Z]:)?/}i
     end
 
     def self.pwd

data/lib/rubocop/processed_source.rb

@@ -123,6 +123,10 @@ module RuboCop
       lines[token.line - 2]
     end
 
+    def current_line(token)
+      lines[token.line - 1]
+    end
+
     def following_line(token)
       lines[token.line]
     end

data/lib/rubocop/result_cache.rb

@@ -100,7 +100,7 @@ module RuboCop
 
       begin
         FileUtils.mkdir_p(dir)
-      rescue Errno::EACCES => e
+      rescue Errno::EACCES, Errno::EROFS => e
         warn "Couldn't create cache directory. Continuing without cache."\
              "\n  #{e.message}"
         return

data/lib/rubocop/rspec/expect_offense.rb

@@ -132,7 +132,10 @@ module RuboCop
       def expect_no_offenses(source, file = nil)
         inspect_source(source, file)
 
-        expect(cop.offenses).to be_empty
+        expected_annotations = AnnotatedSource.parse(source)
+        actual_annotations =
+          expected_annotations.with_offense_annotations(cop.offenses)
+        expect(actual_annotations.to_s).to eq(source)
       end
 
       # Parsed representation of code annotated with the `^^^ Message` style

data/lib/rubocop/rspec/shared_contexts.rb

@@ -61,6 +61,18 @@ RSpec.shared_context 'config', :config do
   end
 end
 
+RSpec.shared_context 'mock console output' do
+  before do
+    $stdout = StringIO.new
+    $stderr = StringIO.new
+  end
+
+  after do
+    $stdout = STDOUT
+    $stderr = STDERR
+  end
+end
+
 RSpec.shared_context 'ruby 2.3', :ruby23 do
   let(:ruby_version) { 2.3 }
 end

data/lib/rubocop/runner.rb

@@ -104,25 +104,20 @@ module RuboCop
     end
 
     def process_file(file)
-      puts "Scanning #{file}" if @options[:debug]
       file_started(file)
-
       offenses = file_offenses(file)
-      if @options[:display_only_fail_level_offenses]
-        offenses = offenses.select { |o| considered_failure?(o) }
-      end
-      formatter_set.file_finished(file, offenses)
-      offenses
     rescue InfiniteCorrectionLoop => e
-      formatter_set.file_finished(file, e.offenses.compact.sort.freeze)
+      offenses = e.offenses.compact.sort.freeze
       raise
+    ensure
+      file_finished(file, offenses || [])
     end
 
     def file_offenses(file)
       file_offense_cache(file) do
         source = get_processed_source(file)
         source, offenses = do_inspection_loop(file, source)
-        add_unneeded_disables(file, offenses.compact.sort, source)
+        add_redundant_disables(file, offenses.compact.sort, source)
       end
     end
 
@@ -146,48 +141,66 @@ module RuboCop
       offenses
     end
 
-    def add_unneeded_disables(file, offenses, source)
-      if check_for_unneeded_disables?(source)
-        config = @config_store.for(file)
-        if config.for_cop(Cop::Lint::UnneededCopDisableDirective)
-                 .fetch('Enabled')
-          cop = Cop::Lint::UnneededCopDisableDirective.new(config, @options)
-          if cop.relevant_file?(file)
-            cop.check(offenses, source.disabled_line_ranges, source.comments)
-            offenses += cop.offenses
-            autocorrect_unneeded_disables(source, cop)
-          end
+    def add_redundant_disables(file, offenses, source)
+      if check_for_redundant_disables?(source)
+        redundant_cop_disable_directive(file) do |cop|
+          cop.check(offenses, source.disabled_line_ranges, source.comments)
+          offenses += cop.offenses
+          offenses += autocorrect_redundant_disables(file, source, cop,
+                                                     offenses)
         end
-        offenses
       end
 
       offenses.sort.reject(&:disabled?).freeze
     end
 
-    def check_for_unneeded_disables?(source)
+    def check_for_redundant_disables?(source)
       !source.disabled_line_ranges.empty? && !filtered_run?
     end
 
+    def redundant_cop_disable_directive(file)
+      config = @config_store.for(file)
+      if config.for_cop(Cop::Lint::RedundantCopDisableDirective)
+               .fetch('Enabled')
+        cop = Cop::Lint::RedundantCopDisableDirective.new(config, @options)
+        yield cop if cop.relevant_file?(file)
+      end
+    end
+
     def filtered_run?
       @options[:except] || @options[:only]
     end
 
-    def autocorrect_unneeded_disables(source, cop)
+    def autocorrect_redundant_disables(file, source, cop, offenses)
       cop.processed_source = source
 
-      Cop::Team.new(
-        RuboCop::Cop::Registry.new,
-        nil,
-        @options
-      ).autocorrect(source.buffer, [cop])
+      team = Cop::Team.new(RuboCop::Cop::Registry.new, nil, @options)
+      team.autocorrect(source.buffer, [cop])
+
+      return [] unless team.updated_source_file?
+
+      # Do one extra inspection loop if any redundant disables were
+      # removed. This is done in order to find rubocop:enable directives that
+      # have now become useless.
+      _source, new_offenses = do_inspection_loop(file,
+                                                 get_processed_source(file))
+      new_offenses - offenses
     end
 
     def file_started(file)
+      puts "Scanning #{file}" if @options[:debug]
       formatter_set.file_started(file,
                                  cli_options: @options,
                                  config_store: @config_store)
     end
 
+    def file_finished(file, offenses)
+      if @options[:display_only_fail_level_offenses]
+        offenses = offenses.select { |o| considered_failure?(o) }
+      end
+      formatter_set.file_finished(file, offenses)
+    end
+
     def cached_run?
       @cached_run ||=
         (@options[:cache] == 'true' ||
@@ -285,9 +298,7 @@ module RuboCop
       @mobilized_cop_classes[config.object_id] ||= begin
         cop_classes = Cop::Cop.all
 
-        %i[only except].each do |opt|
-          OptionsValidator.validate_cop_list(@options[opt])
-        end
+        OptionsValidator.new(@options).validate_cop_options
 
         if @options[:only]
           cop_classes.select! { |c| c.match?(@options[:only]) }

data/lib/rubocop/target_finder.rb

@@ -65,10 +65,7 @@ module RuboCop
         to_inspect?(file, hidden_files, base_dir_config)
       end
 
-      # Most recently modified file first.
-      target_files.sort_by! { |path| -Integer(File.mtime(path)) } if fail_fast?
-
-      target_files
+      target_files.sort_by!(&order)
     end
 
     def to_inspect?(file, hidden_files, base_dir_config)
@@ -184,5 +181,16 @@ module RuboCop
         config.file_to_exclude?(file)
       end
     end
+
+    private
+
+    def order
+      if fail_fast?
+        # Most recently modified file first.
+        ->(path) { -Integer(File.mtime(path)) }
+      else
+        :itself
+      end
+    end
   end
 end

data/lib/rubocop/version.rb

@@ -3,7 +3,7 @@
 module RuboCop
   # This module holds the RuboCop version information.
   module Version
-    STRING = '0.72.0'
+    STRING = '0.76.0'
 
     MSG = '%<version>s (using Parser %<parser_version>s, running on ' \
           '%<ruby_engine>s %<ruby_version>s %<ruby_platform>s)'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop
 version: !ruby/object:Gem::Version
-  version: 0.72.0
+  version: 0.76.0
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-25 00:00:00.000000000 Z
+date: 2019-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jaro_winkler
@@ -185,6 +185,7 @@ files:
 - lib/rubocop/ast/node/regexp_node.rb
 - lib/rubocop/ast/node/resbody_node.rb
 - lib/rubocop/ast/node/retry_node.rb
+- lib/rubocop/ast/node/return_node.rb
 - lib/rubocop/ast/node/self_class_node.rb
 - lib/rubocop/ast/node/send_node.rb
 - lib/rubocop/ast/node/str_node.rb
@@ -202,7 +203,9 @@ files:
 - lib/rubocop/config.rb
 - lib/rubocop/config_loader.rb
 - lib/rubocop/config_loader_resolver.rb
+- lib/rubocop/config_obsoletion.rb
 - lib/rubocop/config_store.rb
+- lib/rubocop/config_validator.rb
 - lib/rubocop/cop/autocorrect_logic.rb
 - lib/rubocop/cop/badge.rb
 - lib/rubocop/cop/bundler/duplicated_gem.rb
@@ -376,6 +379,10 @@ files:
 - lib/rubocop/cop/lint/percent_string_array.rb
 - lib/rubocop/cop/lint/percent_symbol_array.rb
 - lib/rubocop/cop/lint/rand_one.rb
+- lib/rubocop/cop/lint/redundant_cop_disable_directive.rb
+- lib/rubocop/cop/lint/redundant_cop_enable_directive.rb
+- lib/rubocop/cop/lint/redundant_require_statement.rb
+- lib/rubocop/cop/lint/redundant_splat_expansion.rb
 - lib/rubocop/cop/lint/redundant_with_index.rb
 - lib/rubocop/cop/lint/redundant_with_object.rb
 - lib/rubocop/cop/lint/regexp_as_condition.rb
@@ -387,6 +394,7 @@ files:
 - lib/rubocop/cop/lint/safe_navigation_consistency.rb
 - lib/rubocop/cop/lint/safe_navigation_with_empty.rb
 - lib/rubocop/cop/lint/script_permission.rb
+- lib/rubocop/cop/lint/send_with_mixin_argument.rb
 - lib/rubocop/cop/lint/shadowed_argument.rb
 - lib/rubocop/cop/lint/shadowed_exception.rb
 - lib/rubocop/cop/lint/shadowing_outer_local_variable.rb
@@ -395,10 +403,6 @@ files:
 - lib/rubocop/cop/lint/to_json.rb
 - lib/rubocop/cop/lint/underscore_prefixed_variable_name.rb
 - lib/rubocop/cop/lint/unified_integer.rb
-- lib/rubocop/cop/lint/unneeded_cop_disable_directive.rb
-- lib/rubocop/cop/lint/unneeded_cop_enable_directive.rb
-- lib/rubocop/cop/lint/unneeded_require_statement.rb
-- lib/rubocop/cop/lint/unneeded_splat_expansion.rb
 - lib/rubocop/cop/lint/unreachable_code.rb
 - lib/rubocop/cop/lint/unused_block_argument.rb
 - lib/rubocop/cop/lint/unused_method_argument.rb
@@ -422,6 +426,7 @@ files:
 - lib/rubocop/cop/metrics/parameter_lists.rb
 - lib/rubocop/cop/metrics/perceived_complexity.rb
 - lib/rubocop/cop/metrics/utils/abc_size_calculator.rb
+- lib/rubocop/cop/migration/department_name.rb
 - lib/rubocop/cop/mixin/alignment.rb
 - lib/rubocop/cop/mixin/annotation_comment.rb
 - lib/rubocop/cop/mixin/array_min_size.rb
@@ -446,10 +451,10 @@ files:
 - lib/rubocop/cop/mixin/frozen_string_literal.rb
 - lib/rubocop/cop/mixin/hash_alignment.rb
 - lib/rubocop/cop/mixin/heredoc.rb
-- lib/rubocop/cop/mixin/ignored_method_patterns.rb
 - lib/rubocop/cop/mixin/ignored_methods.rb
 - lib/rubocop/cop/mixin/ignored_pattern.rb
 - lib/rubocop/cop/mixin/integer_node.rb
+- lib/rubocop/cop/mixin/interpolation.rb
 - lib/rubocop/cop/mixin/match_range.rb
 - lib/rubocop/cop/mixin/method_complexity.rb
 - lib/rubocop/cop/mixin/method_preference.rb
@@ -540,6 +545,7 @@ files:
 - lib/rubocop/cop/style/dir.rb
 - lib/rubocop/cop/style/documentation.rb
 - lib/rubocop/cop/style/documentation_method.rb
+- lib/rubocop/cop/style/double_cop_disable_directive.rb
 - lib/rubocop/cop/style/double_negation.rb
 - lib/rubocop/cop/style/each_for_simple_loop.rb
 - lib/rubocop/cop/style/each_with_object.rb
@@ -592,6 +598,7 @@ files:
 - lib/rubocop/cop/style/multiline_memoization.rb
 - lib/rubocop/cop/style/multiline_method_signature.rb
 - lib/rubocop/cop/style/multiline_ternary_operator.rb
+- lib/rubocop/cop/style/multiline_when_then.rb
 - lib/rubocop/cop/style/multiple_comparison.rb
 - lib/rubocop/cop/style/mutable_constant.rb
 - lib/rubocop/cop/style/negated_if.rb
@@ -621,12 +628,17 @@ files:
 - lib/rubocop/cop/style/raise_args.rb
 - lib/rubocop/cop/style/random_with_offset.rb
 - lib/rubocop/cop/style/redundant_begin.rb
+- lib/rubocop/cop/style/redundant_capital_w.rb
+- lib/rubocop/cop/style/redundant_condition.rb
 - lib/rubocop/cop/style/redundant_conditional.rb
 - lib/rubocop/cop/style/redundant_exception.rb
 - lib/rubocop/cop/style/redundant_freeze.rb
+- lib/rubocop/cop/style/redundant_interpolation.rb
 - lib/rubocop/cop/style/redundant_parentheses.rb
+- lib/rubocop/cop/style/redundant_percent_q.rb
 - lib/rubocop/cop/style/redundant_return.rb
 - lib/rubocop/cop/style/redundant_self.rb
+- lib/rubocop/cop/style/redundant_sort.rb
 - lib/rubocop/cop/style/redundant_sort_by.rb
 - lib/rubocop/cop/style/regexp_literal.rb
 - lib/rubocop/cop/style/rescue_modifier.rb
@@ -663,11 +675,6 @@ files:
 - lib/rubocop/cop/style/trailing_underscore_variable.rb
 - lib/rubocop/cop/style/trivial_accessors.rb
 - lib/rubocop/cop/style/unless_else.rb
-- lib/rubocop/cop/style/unneeded_capital_w.rb
-- lib/rubocop/cop/style/unneeded_condition.rb
-- lib/rubocop/cop/style/unneeded_interpolation.rb
-- lib/rubocop/cop/style/unneeded_percent_q.rb
-- lib/rubocop/cop/style/unneeded_sort.rb
 - lib/rubocop/cop/style/unpack_first.rb
 - lib/rubocop/cop/style/variable_interpolation.rb
 - lib/rubocop/cop/style/when_then.rb
@@ -678,6 +685,7 @@ files:
 - lib/rubocop/cop/style/zero_length_predicate.rb
 - lib/rubocop/cop/team.rb
 - lib/rubocop/cop/util.rb
+- lib/rubocop/cop/utils/format_string.rb
 - lib/rubocop/cop/variable_force.rb
 - lib/rubocop/cop/variable_force/assignment.rb
 - lib/rubocop/cop/variable_force/branch.rb
@@ -702,6 +710,7 @@ files:
 - lib/rubocop/formatter/html_formatter.rb
 - lib/rubocop/formatter/json_formatter.rb
 - lib/rubocop/formatter/offense_count_formatter.rb
+- lib/rubocop/formatter/pacman_formatter.rb
 - lib/rubocop/formatter/progress_formatter.rb
 - lib/rubocop/formatter/quiet_formatter.rb
 - lib/rubocop/formatter/simple_text_formatter.rb