rubocop 0.49.1 → 0.52.0

data/lib/rubocop/cop/variable_force/scope.rb

@@ -37,11 +37,7 @@ module RuboCop
         end
 
         def name
-          # TODO: Add an else clause
-          case @node.type
-          when :def  then @node.children[0]
-          when :defs then @node.children[1]
-          end
+          @node.method_name
         end
 
         def body_node

data/lib/rubocop/cop/variable_force/variable.rb

@@ -47,7 +47,7 @@ module RuboCop
             next if consumed_branches.include?(assignment.branch)
 
             unless assignment.run_exclusively_with?(reference)
-              assignment.reference!
+              assignment.reference!(node)
             end
 
             break if !assignment.branch || assignment.branch == reference.branch

data/lib/rubocop/formatter/disabled_config_formatter.rb

@@ -50,13 +50,11 @@ module RuboCop
         output.puts HEADING % command
 
         # Syntax isn't a real cop and it can't be disabled.
-        @cops_with_offenses.delete('Syntax')
+        @cops_with_offenses.delete('Lint/Syntax')
 
         output_offenses
 
         puts "Created #{output.path}."
-        puts "Run `rubocop --config #{output.path}`, or add `inherit_from: " \
-             "#{output.path}` in a .rubocop.yml file."
       end
 
       private
@@ -107,7 +105,8 @@ module RuboCop
       end
 
       def output_cop_param_comments(params, default_cfg)
-        output.puts "# Configuration parameters: #{params.join(', ')}."
+        config_params = params.reject { |p| p.start_with?('Supported') }
+        output.puts "# Configuration parameters: #{config_params.join(', ')}."
 
         params.each do |param|
           value = default_cfg[param]

data/lib/rubocop/formatter/formatter_set.rb

@@ -19,7 +19,9 @@ module RuboCop
         'files'    => FileListFormatter,
         'offenses' => OffenseCountFormatter,
         'disabled' => DisabledLinesFormatter,
-        'worst'    => WorstOffendersFormatter
+        'worst'    => WorstOffendersFormatter,
+        'tap'      => TapFormatter,
+        'quiet'    => QuietFormatter
       }.freeze
 
       FORMATTER_APIS = %i[started finished].freeze

data/lib/rubocop/formatter/html_formatter.rb

@@ -4,7 +4,7 @@ require 'cgi'
 require 'erb'
 require 'ostruct'
 require 'base64'
-require 'rubocop/formatter/text_util'
+require_relative 'text_util'
 
 module RuboCop
   module Formatter

data/lib/rubocop/formatter/json_formatter.rb

@@ -64,9 +64,15 @@ module RuboCop
       # TODO: Consider better solution for Offense#real_column.
       def hash_for_location(offense)
         {
-          line:   offense.line,
-          column: offense.real_column,
-          length: offense.location.length
+          start_line:        offense.line,
+          start_column:      offense.real_column,
+          last_line:   offense.last_line,
+          last_column: offense.last_column,
+          length:      offense.location.length,
+          # `line` and `column` exist for compatibility.
+          # Use `start_line` and `start_column` instead.
+          line:        offense.line,
+          column:      offense.real_column
         }
       end
     end

data/lib/rubocop/formatter/offense_count_formatter.rb

@@ -27,6 +27,7 @@ module RuboCop
         report_summary(@offense_counts)
       end
 
+      # rubocop:disable Metrics/AbcSize
       def report_summary(offense_counts)
         per_cop_counts = ordered_offense_counts(offense_counts)
         total_count = total_offense_count(offense_counts)
@@ -42,6 +43,7 @@ module RuboCop
 
         output.puts
       end
+      # rubocop:enable Metrics/AbcSize
 
       def ordered_offense_counts(offense_counts)
         Hash[offense_counts.sort_by { |k, v| [-v, k] }]

data/lib/rubocop/formatter/quiet_formatter.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Formatter
+    # 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)
+        super unless offense_count.zero?
+      end
+    end
+  end
+end

data/lib/rubocop/formatter/simple_text_formatter.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'rubocop/formatter/colorizable'
-require 'rubocop/formatter/text_util'
+require_relative 'colorizable'
+require_relative 'text_util'
 
 module RuboCop
   module Formatter
@@ -70,7 +70,7 @@ module RuboCop
       end
 
       def annotate_message(msg)
-        msg.gsub(/`(.*?)`/, yellow('\1'))
+        msg.gsub(/`(.*?)`/m, yellow('\1'))
       end
 
       def message(offense)

data/lib/rubocop/formatter/tap_formatter.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Formatter
+    # This formatter formats report data using the Test Anything Protocol.
+    # TAP allows for to communicate tests results in a language agnostics way.
+    class TapFormatter < ClangStyleFormatter
+      def started(target_files)
+        super
+        @progress_count = 1
+        output.puts "1..#{target_files.size}"
+      end
+
+      def file_finished(file, offenses)
+        if offenses.empty?
+          output.puts "ok #{@progress_count} - #{smart_path(file)}"
+        else
+          output.puts "not ok #{@progress_count} - #{smart_path(file)}"
+
+          count_stats(offenses)
+          report_file(file, offenses)
+        end
+
+        @progress_count += 1
+      end
+
+      private
+
+      def report_line(location)
+        source_line = location.source_line
+
+        if location.first_line == location.last_line
+          output.puts("# #{source_line}")
+        else
+          output.puts("# #{source_line} #{yellow(ELLIPSES)}")
+        end
+      end
+
+      def report_highlighted_area(highlighted_area)
+        output.puts("# #{' ' * highlighted_area.begin_pos}" \
+                    "#{'^' * highlighted_area.size}")
+      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))
+
+        # rubocop:disable Lint/HandleExceptions
+        begin
+          return unless valid_line?(offense)
+
+          report_line(offense.location)
+          report_highlighted_area(offense.highlighted_area)
+        rescue IndexError
+          # range is not on a valid line; perhaps the source file is empty
+        end
+        # rubocop:enable Lint/HandleExceptions
+      end
+
+      def annotate_message(msg)
+        msg.gsub(/`(.*?)`/, '\1')
+      end
+
+      def message(offense)
+        message = offense.corrected? ? '[Corrected] ' : ''
+        "#{message}#{annotate_message(offense.message)}"
+      end
+    end
+  end
+end

data/lib/rubocop/formatter/worst_offenders_formatter.rb

@@ -32,6 +32,7 @@ module RuboCop
         report_summary(@offense_counts)
       end
 
+      # rubocop:disable Metrics/AbcSize
       def report_summary(offense_counts)
         per_file_counts = ordered_offense_counts(offense_counts)
         total_count = total_offense_count(offense_counts)
@@ -47,6 +48,7 @@ module RuboCop
 
         output.puts
       end
+      # rubocop:enable Metrics/AbcSize
 
       def ordered_offense_counts(offense_counts)
         Hash[offense_counts.sort_by { |k, v| [-v, k] }]

data/lib/rubocop/node_pattern.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-# rubocop:disable Metrics/ClassLength
-# rubocop:disable Metrics/CyclomaticComplexity
-
+# rubocop:disable Metrics/ClassLength, Metrics/CyclomaticComplexity
 module RuboCop
   # This class performs a pattern-matching operation on an AST node.
   #
@@ -98,19 +96,26 @@ module RuboCop
     # @private
     # Builds Ruby code which implements a pattern
     class Compiler
-      RSYM    = %r{:(?:[\w+@*/?!<>=~|%^-]+|\[\]=?)}
-      ID_CHAR = /[a-zA-Z_-]/
-      META    = /\(|\)|\{|\}|\[|\]|\$\.\.\.|\$|!|\^|\.\.\./
-      NUMBER  = /-?\d+(?:\.\d+)?/
-      TOKEN   =
-        /\G(?:[\s,]+|#{META}|%\d*|#{NUMBER}|\#?#{ID_CHAR}+[\!\?]?\(?|#{RSYM}|.)/
-
-      NODE      = /\A#{ID_CHAR}+\Z/
-      PREDICATE = /\A#{ID_CHAR}+\?\(?\Z/
-      WILDCARD  = /\A_#{ID_CHAR}*\Z/
-      FUNCALL   = /\A\##{ID_CHAR}+[\!\?]?\(?\Z/
-      LITERAL   = /\A(?:#{RSYM}|#{NUMBER}|nil)\Z/
-      PARAM     = /\A%\d*\Z/
+      SYMBOL       = %r{:(?:[\w+@*/?!<>=~|%^-]+|\[\]=?)}
+      IDENTIFIER   = /[a-zA-Z_-]/
+      META         = /\(|\)|\{|\}|\[|\]|\$\.\.\.|\$|!|\^|\.\.\./
+      NUMBER       = /-?\d+(?:\.\d+)?/
+      STRING       = /".+?"/
+      METHOD_NAME  = /\#?#{IDENTIFIER}+[\!\?]?\(?/
+      PARAM_NUMBER = /%\d*/
+
+      SEPARATORS = /[\s]+/
+      TOKENS     = Regexp.union(META, PARAM_NUMBER, NUMBER,
+                                METHOD_NAME, SYMBOL, STRING)
+
+      TOKEN = /\G(?:#{SEPARATORS}|#{TOKENS}|.)/
+
+      NODE      = /\A#{IDENTIFIER}+\Z/
+      PREDICATE = /\A#{IDENTIFIER}+\?\(?\Z/
+      WILDCARD  = /\A_#{IDENTIFIER}*\Z/
+      FUNCALL   = /\A\##{METHOD_NAME}/
+      LITERAL   = /\A(?:#{SYMBOL}|#{NUMBER}|#{STRING})\Z/
+      PARAM     = /\A#{PARAM_NUMBER}\Z/
       CLOSING   = /\A(?:\)|\}|\])\Z/
 
       attr_reader :match_code
@@ -128,9 +133,11 @@ module RuboCop
       end
 
       def run(node_var)
-        tokens = @string.scan(TOKEN)
-        tokens.reject! { |token| token =~ /\A[\s,]+\Z/ } # drop whitespace
+        tokens =
+          @string.scan(TOKEN).reject { |token| token =~ /\A#{SEPARATORS}\Z/ }
+
         @match_code = compile_expr(tokens, node_var, false)
+
         fail_due_to('unbalanced pattern') unless tokens.empty?
       end
 
@@ -158,7 +165,7 @@ module RuboCop
         when PARAM     then compile_param(cur_node, token[1..-1], seq_head)
         when CLOSING   then fail_due_to("#{token} in invalid position")
         when nil       then fail_due_to('pattern ended prematurely')
-        else fail_due_to("invalid token #{token.inspect}")
+        else                fail_due_to("invalid token #{token.inspect}")
         end
       end
       # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
@@ -336,7 +343,8 @@ module RuboCop
         else
           n = @unify[name] = next_temp_value
           # double assign to temp#{n} to avoid "assigned but unused variable"
-          "(temp#{n} = temp#{n} = #{cur_node}#{'.type' if seq_head}; true)"
+          "(temp#{n} = #{cur_node}#{'.type' if seq_head}; " \
+          "temp#{n} = temp#{n}; true)"
         end
       end
 
@@ -433,11 +441,17 @@ module RuboCop
         params.empty? ? '' : ",#{params}"
       end
 
+      def emit_guard_clause
+        <<-RUBY
+          return unless node.is_a?(RuboCop::AST::Node)
+        RUBY
+      end
+
       def emit_method_code
-        <<-CODE
-          return nil unless #{@match_code}
+        <<-RUBY
+          return unless #{@match_code}
           block_given? ? yield(#{emit_capture_list}) : (return #{emit_retval})
-        CODE
+        RUBY
       end
 
       def fail_due_to(message)
@@ -447,7 +461,7 @@ module RuboCop
       def with_temp_node(cur_node)
         with_temp_variable do |temp_var|
           # double assign to temp#{n} to avoid "assigned but unused variable"
-          yield "#{temp_var} = #{temp_var} = #{cur_node}", temp_var
+          yield "#{temp_var} = #{cur_node}; #{temp_var} = #{temp_var}", temp_var
         end
       end
 
@@ -459,6 +473,7 @@ module RuboCop
         @temps += 1
       end
     end
+    private_constant :Compiler
 
     # Helpers for defining methods based on a pattern string
     module Macros
@@ -470,9 +485,10 @@ module RuboCop
       # If the node matches, and no block is provided, the new method will
       # return the captures, or `true` if there were none.
       def def_node_matcher(method_name, pattern_str)
-        compiler = RuboCop::NodePattern::Compiler.new(pattern_str, 'node')
-        src = "def #{method_name}(node" \
+        compiler = Compiler.new(pattern_str, 'node')
+        src = "def #{method_name}(node = self" \
               "#{compiler.emit_trailing_params});" \
+              "#{compiler.emit_guard_clause}" \
               "#{compiler.emit_method_code};end"
 
         location = caller_locations(1, 1).first
@@ -486,7 +502,7 @@ module RuboCop
       # as soon as it finds a descendant which matches. Otherwise, it will
       # yield all descendants which match.
       def def_node_search(method_name, pattern_str)
-        compiler = RuboCop::NodePattern::Compiler.new(pattern_str, 'node')
+        compiler = Compiler.new(pattern_str, 'node')
         called_from = caller(1..1).first.split(':')
 
         if method_name.to_s.end_with?('?')
@@ -519,7 +535,7 @@ module RuboCop
 
       def node_search_body(method_name, trailing_params, prelude, match_code,
                            on_match)
-        <<-END
+        <<-RUBY
           def #{method_name}(node0#{trailing_params})
             #{prelude}
             node0.each_node do |node|
@@ -529,7 +545,7 @@ module RuboCop
             end
             nil
           end
-        END
+        RUBY
       end
     end
 
@@ -541,3 +557,4 @@ module RuboCop
     end
   end
 end
+# rubocop:enable Metrics/ClassLength, Metrics/CyclomaticComplexity

data/lib/rubocop/options.rb

@@ -17,9 +17,6 @@ module RuboCop
     def parse(command_line_args)
       args = args_from_file.concat(args_from_env).concat(command_line_args)
       define_options(args).parse!(args)
-      # The --no-color CLI option sets `color: false` so we don't want the
-      # `no_color` key, which is created automatically.
-      @options.delete(:no_color)
 
       @validator.validate_compatibility
 
@@ -100,6 +97,7 @@ module RuboCop
       end
 
       option(opts, '--force-exclusion')
+      option(opts, '--ignore-parent-exclusion')
 
       option(opts, '--force-default-config')
 
@@ -142,7 +140,7 @@ module RuboCop
       option(opts, '-F', '--fail-fast')
       option(opts, '-C', '--cache FLAG')
       option(opts, '-d', '--debug')
-      option(opts, '-D', '--display-cop-names')
+      option(opts, '-D', '--[no-]display-cop-names')
       option(opts, '-E', '--extra-details')
       option(opts, '-S', '--display-style-guide')
       option(opts, '-R', '--rails')
@@ -152,7 +150,7 @@ module RuboCop
       end
       option(opts, '-a', '--auto-correct')
 
-      option(opts, '--[no-]color') { |c| @options[:color] = c }
+      option(opts, '--[no-]color')
 
       option(opts, '-v', '--version')
       option(opts, '-V', '--verbose-version')
@@ -178,7 +176,8 @@ module RuboCop
     # e.g. [..., '--auto-correct', ...] to :auto_correct.
     def long_opt_symbol(args)
       long_opt = args.find { |arg| arg.start_with?('--') }
-      long_opt[2..-1].sub(/ .*/, '').tr('-', '_').gsub(/[\[\]]/, '').to_sym
+      long_opt[2..-1].sub('[no-]', '').sub(/ .*/, '')
+                     .tr('-', '_').gsub(/[\[\]]/, '').to_sym
     end
   end
 
@@ -303,6 +302,9 @@ module RuboCop
       force_exclusion:      ['Force excluding files specified in the',
                              'configuration `Exclude` even if they are',
                              'explicitly passed as arguments.'],
+      ignore_parent_exclusion:
+                            ['Prevent from inheriting AllCops/Exclude from',
+                             'parent folders.'],
       force_default_config: ['Use default configuration even if configuration',
                              'files are present in the directory tree.'],
       format:               ['Choose an output formatter. This option',
@@ -319,6 +321,8 @@ module RuboCop
                              '  [fi]les',
                              '  [o]ffenses',
                              '  [w]orst',
+                             '  [t]ap',
+                             '  [q]uiet',
                              '  custom formatter class name'],
       out:                  ['Write output to a file instead of STDOUT.',
                              'This option applies to the previously',
@@ -336,14 +340,15 @@ module RuboCop
                              '(FLAG=false), default determined by',
                              'configuration parameter AllCops: UseCache.'],
       debug:                 'Display debug info.',
-      display_cop_names:     'Display cop names in offense messages.',
+      display_cop_names:     ['Display cop names in offense messages.',
+                              'Default is true.'],
       display_style_guide:   'Display style guide URLs in offense messages.',
       extra_details:         'Display extra details in offense messages.',
       rails:                 'Run extra Rails cops.',
       lint:                  'Run only lint cops.',
       list_target_files:     'List all files RuboCop will inspect.',
       auto_correct:          'Auto-correct offenses.',
-      no_color:              'Force color output on or off.',
+      color:                 'Force color output on or off.',
       version:               'Display version.',
       verbose_version:       'Display verbose version.',
       parallel:             ['Use available CPUs to execute inspection in',