rubocop 0.31.0 → 0.35.0

data/lib/rubocop/formatter/disabled_config_formatter.rb

@@ -6,7 +6,8 @@ module RuboCop
     # detected any offenses are configured to not detect the offense.
     class DisabledConfigFormatter < BaseFormatter
       HEADING =
-        ['# This configuration was generated by `rubocop --auto-gen-config`',
+        ['# This configuration was generated by',
+         '# `%s`',
          "# on #{Time.now} using RuboCop version #{Version.version}.",
          '# The point is for the user to remove these configuration records',
          '# one by one as the offenses are removed from the code base.',
@@ -22,13 +23,30 @@ module RuboCop
         attr_accessor :config_to_allow_offenses
       end
 
-      def file_finished(_file, offenses)
+      def file_started(_file, file_info)
+        @exclude_limit_option =
+          file_info.fetch(:cli_options, {})[:exclude_limit]
+        @exclude_limit = (
+          @exclude_limit_option ||
+          RuboCop::Options::DEFAULT_MAXIMUM_EXCLUSION_ITEMS).to_i
+      end
+
+      def file_finished(file, offenses)
         @cops_with_offenses ||= Hash.new(0)
-        offenses.each { |o| @cops_with_offenses[o.cop_name] += 1 }
+        @files_with_offenses ||= {}
+        offenses.each do |o|
+          @cops_with_offenses[o.cop_name] += 1
+          @files_with_offenses[o.cop_name] ||= []
+          @files_with_offenses[o.cop_name] << file
+        end
       end
 
       def finished(_inspected_files)
-        output.puts HEADING
+        command = 'rubocop --auto-gen-config'
+        if @exclude_limit_option
+          command += format(' --exclude-limit %d', @exclude_limit_option.to_i)
+        end
+        output.puts HEADING % command
 
         # Syntax isn't a real cop and it can't be disabled.
         @cops_with_offenses.delete('Syntax')
@@ -36,10 +54,9 @@ module RuboCop
         @cops_with_offenses.sort.each do |cop_name, offense_count|
           output.puts
           cfg = self.class.config_to_allow_offenses[cop_name]
-          cfg ||= { 'Enabled' => false }
+          cfg ||= {}
           output_cop_comments(output, cfg, cop_name, offense_count)
-          output.puts "#{cop_name}:"
-          cfg.each { |key, value| output.puts "  #{key}: #{value}" }
+          output_cop_config(output, cfg, cop_name)
         end
         puts "Created #{output.path}."
         puts "Run `rubocop --config #{output.path}`, or"
@@ -55,12 +72,57 @@ module RuboCop
         default_cfg = RuboCop::ConfigLoader.default_configuration[cop_name]
         return unless default_cfg
 
-        params = default_cfg.keys - %w(Description StyleGuide Enabled) -
+        params = default_cfg.keys -
+                 %w(Description StyleGuide Reference Enabled) -
                  cfg.keys
         return if params.empty?
 
         output.puts "# Configuration parameters: #{params.join(', ')}."
       end
+
+      def output_cop_config(output, cfg, cop_name)
+        output.puts "#{cop_name}:"
+        cfg.each do |key, value|
+          value = value[0] if value.is_a?(Array)
+          output.puts "  #{key}: #{value}"
+        end
+        output_offending_files(output, cfg, cop_name)
+      end
+
+      def output_offending_files(output, cfg, cop_name)
+        return unless cfg.empty?
+
+        offending_files = @files_with_offenses[cop_name].uniq.sort
+        if offending_files.count > @exclude_limit
+          output.puts '  Enabled: false'
+        else
+          output_exclude_list(output, offending_files, cop_name)
+        end
+      end
+
+      def output_exclude_list(output, offending_files, cop_name)
+        require 'pathname'
+        parent = Pathname.new(Dir.pwd)
+
+        # Exclude properties in .rubocop_todo.yml override default ones, so in
+        # order to retain the default excludes we must copy them.
+        default_cfg = RuboCop::ConfigLoader.default_configuration[cop_name]
+        default_excludes = default_cfg ? default_cfg['Exclude'] || [] : []
+
+        output.puts '  Exclude:'
+        (default_excludes + offending_files).each do |file|
+          file_path = Pathname.new(file)
+          begin
+            relative = file_path.relative_path_from(parent)
+            output.puts "    - '#{relative}'"
+          rescue ArgumentError
+            output.puts "    - '#{file}'"
+          end
+        end
+      rescue LoadError
+        # Fallback to Enabled: false for Ruby < 1.9.3
+        output.puts '  Enabled: false'
+      end
     end
   end
 end

data/lib/rubocop/formatter/formatter_set.rb

@@ -21,7 +21,7 @@ module RuboCop
         'disabled' => DisabledLinesFormatter
       }
 
-      FORMATTER_APIS = [:started, :file_started, :file_finished, :finished]
+      FORMATTER_APIS = [:started, :finished]
 
       FORMATTER_APIS.each do |method_name|
         define_method(method_name) do |*args|
@@ -29,6 +29,32 @@ module RuboCop
         end
       end
 
+      def file_started(file, options)
+        @cop_disabled_line_ranges = options[:cop_disabled_line_ranges]
+        @comments = options[:comments]
+        @options = options[:cli_options]
+        @config_store = options[:config_store]
+        each { |f| f.file_started(file, options) }
+      end
+
+      def file_finished(file, offenses)
+        if @cop_disabled_line_ranges.any? &&
+           # Don't check unneeded disable if --only or --except option is
+           # given, because these options override configuration.
+           (@options[:except] || []).empty? && (@options[:only] || []).empty?
+          config = @config_store.for(file)
+          if config['Lint/UnneededDisable']['Enabled']
+            cop = Cop::Lint::UnneededDisable.new(config, @options)
+            cop.check(offenses, @cop_disabled_line_ranges, @comments)
+            offenses += cop.offenses
+          end
+        end
+
+        offenses = offenses.sort.reject(&:disabled?)
+        each { |f| f.file_finished(file, offenses) }
+        offenses
+      end
+
       def add_formatter(formatter_type, output_path = nil)
         formatter_class = case formatter_type
                           when Class

data/lib/rubocop/formatter/progress_formatter.rb

@@ -8,6 +8,14 @@ module RuboCop
     class ProgressFormatter < ClangStyleFormatter
       include TextUtil
 
+      DOT = '.'.freeze
+      GREEN_DOT = Rainbow(DOT).green.freeze
+
+      def initialize(output)
+        super
+        @dot = @output.tty? ? GREEN_DOT : DOT
+      end
+
       def started(target_files)
         super
         @offenses_for_files = {}
@@ -36,14 +44,14 @@ module RuboCop
           end
         end
 
-        report_summary(inspected_files.count,
+        report_summary(inspected_files.size,
                        @total_offense_count,
                        @total_correction_count)
       end
 
       def report_file_as_mark(offenses)
         mark = if offenses.empty?
-                 green('.')
+                 @dot
                else
                  highest_offense = offenses.max_by(&:severity)
                  colored_severity_code(highest_offense)

data/lib/rubocop/formatter/simple_text_formatter.rb

@@ -90,7 +90,7 @@ module RuboCop
       end
 
       def annotate_message(msg)
-        msg.gsub(/`(.*?)`/, Rainbow('\1').yellow)
+        msg.gsub(/`(.*?)`/, yellow('\1'))
       end
 
       def message(offense)

data/lib/rubocop/node_pattern.rb

@@ -0,0 +1,390 @@
+# encoding: utf-8
+
+# rubocop:disable Metrics/ClassLength
+# rubocop:disable Metrics/CyclomaticComplexity
+
+module RuboCop
+  # This class performs a pattern-matching operation on an AST node.
+  #
+  # Initialize a new `NodePattern` with `NodePattern.new(pattern_string)`, then
+  # pass an AST node to `NodePattern#match`. Alternatively, use one of the class
+  # macros in `NodePattern::Macros` to define your own pattern-matching method.
+  #
+  # If the match fails, `nil` will be returned. If the match succeeds, the
+  # return value depends on whether a block was provided to `#match`, and
+  # whether the pattern contained any "captures" (values which are extracted
+  # from a matching AST.)
+  #
+  # - With block: #match yields the captures (if any) and passes the return
+  #               value of the block through.
+  # - With no block, but one capture: the capture is returned.
+  # - With no block, but multiple captures: captures are returned as an array.
+  # - With no captures: #match returns `true`.
+  #
+  # ## Pattern string format examples
+  #
+  #    ':sym'              # matches a literal symbol
+  #    '1'                 # matches a literal integer
+  #    'nil'               # matches a literal nil
+  #    'send'              # matches (send ...)
+  #    '(send)'            # matches (send)
+  #    '(send ...)'        # matches (send ...)
+  #    '{send class}'      # matches (send ...) or (class ...)
+  #    '({send class})'    # matches (send) or (class)
+  #    '(send const)'      # matches (send (const ...))
+  #    '(send _ :new)'     # matches (send <anything> :new)
+  #    '(send $_ :new)'    # as above, but whatever matches the $_ is captured
+  #    '(send $_ $_)'      # you can use as many captures as you want
+  #    '(send !const ...)' # ! negates the next part of the pattern
+  #    '$(send const ...)' # arbitrary matching can be performed on a capture
+  #    '(send _recv _msg)' # wildcards can be named (for readability)
+  #    '(send ... :new)'   # you can specifically match against the last child
+  #                        # (this only works for the very last)
+  #    '(send $...)'       # capture all the children as an array
+  #    '(send $... int)'   # capture all children but the last as an array
+  #    '(send _x :+ _x)'   # unification is performed on named wildcards
+  #                        # (like Prolog variables...)
+  #    '(int odd?)'        # words which end with a ? are predicate methods,
+  #                        # are are called on the target to see if it matches
+  #                        # any Ruby method which the matched object supports
+  #                        # can be used
+  #    '(int [!1 !2])'     # [] contains multiple patterns, ALL of which must
+  #                        # match in that position
+  #                        # ({} is pattern union, [] is intersection)
+  #    '(send %1 _)'       # % stands for a parameter which must be supplied to
+  #                        # #match at matching time
+  #                        # it will be compared to the corresponding value in
+  #                        # the AST using #==
+  #                        # a bare '%' is the same as '%1'
+  #    '^^send'            # each ^ ascends one level in the AST
+  #                        # so this matches against the grandparent node
+  #
+  # You can nest arbitrarily deep:
+  #
+  #     # matches node parsed from 'Const = Class.new' or 'Const = Module.new':
+  #     '(casgn nil const (send (const nil {:Class :Module}) :new)))'
+  #     # matches a node parsed from an 'if', with a '==' comparison,
+  #     # and no 'else' branch:
+  #     '(if (send _ :== _) _ nil)'
+  #
+  # Note that patterns like 'send' are implemented by calling `#send_type?` on
+  # the node being matched, 'const' by `#const_type?`, 'int' by `#int_type?`,
+  # and so on. Therefore, if you add methods which are named like
+  # `#prefix_type?` to the AST node class, then 'prefix' will become usable as
+  # a pattern.
+  #
+  # Also node that if you need a "guard clause" to protect against possible nils
+  # in a certain place in the AST, you can do it like this: `[!nil <pattern>]`
+  #
+  class NodePattern
+    # @private
+    Invalid = Class.new(StandardError)
+
+    # @private
+    # Builds Ruby code which implements a pattern
+    class Compiler
+      RSYM      = %r{:(?:[\w+-@_*/?!<>~|%^]+|==|\[\]=?)}
+      ID_CHAR   = /[a-zA-Z_]/
+      META_CHAR = /\(|\)|\{|\}|\[|\]|\$\.\.\.|\$|!|\^|\.\.\./
+      TOKEN     = /\G(?:\s+|#{META_CHAR}|#{ID_CHAR}+\??|%\d*|\d+|#{RSYM}|.)/
+
+      NODE      = /\A#{ID_CHAR}+\Z/
+      PREDICATE = /\A#{ID_CHAR}+\?\Z/
+      LITERAL   = /\A(?:#{RSYM}|\d+|nil)\Z/
+      WILDCARD  = /\A_#{ID_CHAR}*\Z/
+      PARAM     = /\A%\d*\Z/
+      CLOSING   = /\A(?:\)|\}|\])\Z/
+
+      attr_reader :match_code
+
+      def initialize(str, node_var = 'node0')
+        @string   = str
+
+        @temps    = 0  # avoid name clashes between temp variables
+        @captures = 0  # number of captures seen
+        @unify    = {} # named wildcard -> temp variable number
+        @params   = 0  # highest % (param) number seen
+
+        run(node_var)
+      end
+
+      def run(node_var)
+        tokens = @string.scan(TOKEN)
+        tokens.reject! { |token| token =~ /\A\s+\Z/ }
+        @match_code = compile_expr(tokens, node_var, false)
+        fail_due_to('unbalanced pattern') unless tokens.empty?
+      end
+
+      def compile_expr(tokens, cur_node, seq_head)
+        token = tokens.shift
+        case token
+        when '('       then compile_seq(tokens, cur_node, seq_head)
+        when '{'       then compile_union(tokens, cur_node, seq_head)
+        when '['       then compile_intersect(tokens, cur_node, seq_head)
+        when '!'       then compile_negation(tokens, cur_node, seq_head)
+        when '$'       then compile_capture(tokens, cur_node, seq_head)
+        when '^'       then compile_ascend(tokens, cur_node, seq_head)
+        when WILDCARD  then compile_wildcard(cur_node, token[1..-1], seq_head)
+        when LITERAL   then compile_literal(cur_node, token, seq_head)
+        when PREDICATE then compile_predicate(cur_node, token, seq_head)
+        when NODE      then compile_nodetype(cur_node, token)
+        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}")
+        end
+      end
+
+      def compile_seq(tokens, cur_node, seq_head)
+        fail_due_to('empty parentheses') if tokens.first == ')'
+        fail_due_to('parentheses at sequence head') if seq_head
+
+        init = "temp#{@temps += 1} = #{cur_node}"
+        cur_node = "temp#{@temps}"
+        terms = compile_seq_terms(tokens, cur_node)
+
+        join_terms(init, terms, ' && ')
+      end
+
+      def compile_seq_terms(tokens, cur_node)
+        terms = []
+        index = nil
+        until tokens.first == ')'
+          if tokens.first == '...'
+            return compile_ellipsis(tokens, cur_node, terms, index || 0)
+          elsif tokens.first == '$...'
+            return compile_capt_ellip(tokens, cur_node, terms, index || 0)
+          elsif index.nil?
+            terms << compile_expr(tokens, cur_node, true)
+            index = 0
+          else
+            child_node = "#{cur_node}.children[#{index}]"
+            terms << compile_expr(tokens, child_node, false)
+            index += 1
+          end
+        end
+        terms << "(#{cur_node}.children.size == #{index})"
+        tokens.shift # drop concluding )
+        terms
+      end
+
+      def compile_ellipsis(tokens, cur_node, terms, index)
+        if (term = compile_seq_tail(tokens, "#{cur_node}.children.last"))
+          terms << "(#{cur_node}.children.size > #{index})"
+          terms << term
+        elsif index > 0
+          terms << "(#{cur_node}.children.size >= #{index})"
+        end
+        terms
+      end
+
+      def compile_capt_ellip(tokens, cur_node, terms, index)
+        capture = next_capture
+        if (term = compile_seq_tail(tokens, "#{cur_node}.children.last"))
+          terms << "(#{cur_node}.children.size > #{index})"
+          terms << term
+          terms << "(#{capture} = #{cur_node}.children[#{index}..-2])"
+        else
+          terms << "(#{cur_node}.children.size >= #{index})" if index > 0
+          terms << "(#{capture} = #{cur_node}.children[#{index}..-1])"
+        end
+        terms
+      end
+
+      def compile_seq_tail(tokens, cur_node)
+        tokens.shift
+        if tokens.first == ')'
+          tokens.shift
+          nil
+        else
+          expr = compile_expr(tokens, cur_node, false)
+          fail_due_to('missing )') unless tokens.shift == ')'
+          expr
+        end
+      end
+
+      def compile_union(tokens, cur_node, seq_head)
+        fail_due_to('empty union') if tokens.first == '}'
+
+        init = "temp#{@temps += 1} = #{cur_node}"
+        cur_node = "temp#{@temps}"
+
+        terms = []
+        captures_before = @captures
+        terms << compile_expr(tokens, cur_node, seq_head)
+        captures_after = @captures
+
+        until tokens.first == '}'
+          @captures = captures_before
+          terms << compile_expr(tokens, cur_node, seq_head)
+          if @captures != captures_after
+            fail_due_to('each branch of {} must have same # of captures')
+          end
+        end
+        tokens.shift
+
+        join_terms(init, terms, ' || ')
+      end
+
+      def compile_intersect(tokens, cur_node, seq_head)
+        fail_due_to('empty intersection') if tokens.first == ']'
+
+        init = "temp#{@temps += 1} = #{cur_node}"
+        cur_node = "temp#{@temps}"
+
+        terms = []
+        until tokens.first == ']'
+          terms << compile_expr(tokens, cur_node, seq_head)
+        end
+        tokens.shift
+
+        join_terms(init, terms, ' && ')
+      end
+
+      def compile_capture(tokens, cur_node, seq_head)
+        "(#{next_capture} = #{cur_node}#{'.type' if seq_head}; " <<
+          compile_expr(tokens, cur_node, seq_head) <<
+          ')'
+      end
+
+      def compile_negation(tokens, cur_node, seq_head)
+        '(!' << compile_expr(tokens, cur_node, seq_head) << ')'
+      end
+
+      def compile_ascend(tokens, cur_node, seq_head)
+        "(#{cur_node}.parent && " <<
+          compile_expr(tokens, "#{cur_node}.parent", seq_head) <<
+          ')'
+      end
+
+      def compile_wildcard(cur_node, name, seq_head)
+        if name.empty?
+          'true'
+        elsif @unify.key?(name)
+          # we have already seen a wildcard with this name before
+          # so the value it matched the first time will already be stored
+          # in a temp. check if this value matches the one stored in the temp
+          "(#{cur_node}#{'.type' if seq_head} == temp#{@unify[name]})"
+        else
+          n = @unify[name] = (@temps += 1)
+          "(temp#{n} = #{cur_node}#{'.type' if seq_head}; true)"
+        end
+      end
+
+      def compile_literal(cur_node, literal, seq_head)
+        "(#{cur_node}#{'.type' if seq_head} == #{literal})"
+      end
+
+      def compile_predicate(cur_node, predicate, seq_head)
+        "(#{cur_node}#{'.type' if seq_head}.#{predicate})"
+      end
+
+      def compile_nodetype(cur_node, type)
+        "(#{cur_node} && #{cur_node}.#{type}_type?)"
+      end
+
+      def compile_param(cur_node, number, seq_head)
+        number = number.empty? ? 1 : Integer(number)
+        @params = number if number > @params
+        "(#{cur_node}#{'.type' if seq_head} == param#{number})"
+      end
+
+      def next_capture
+        "capture#{@captures += 1}"
+      end
+
+      def join_terms(init, terms, operator)
+        '(' << init << ';' << terms.join(operator) << ')'
+      end
+
+      def emit_capture_list
+        (1..@captures).map { |n| "capture#{n}" }.join(',')
+      end
+
+      def emit_retval
+        if @captures.zero?
+          'true'
+        elsif @captures == 1
+          'capture1'
+        else
+          "[#{emit_capture_list}]"
+        end
+      end
+
+      def emit_param_list
+        (1..@params).map { |n| "param#{n}" }.join(',')
+      end
+
+      def emit_trailing_param_list
+        params = emit_param_list
+        params.empty? ? '' : ',' << params
+      end
+
+      def emit_method_code
+        <<-CODE
+          return nil unless #{@match_code}
+          block_given? ? yield(#{emit_capture_list}) : (return #{emit_retval})
+        CODE
+      end
+
+      def fail_due_to(message)
+        fail Invalid, "Couldn't compile due to #{message}. Pattern: #{@string}"
+      end
+    end
+
+    # Helpers for defining methods based on a pattern string
+    module Macros
+      # Define a method which applies a pattern to an AST node
+      #
+      # The new method will return nil if the node does not match
+      # If the node matches, and a block is provided, the new method will
+      # yield to the block (passing any captures as block arguments).
+      # 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.emit_trailing_param_list <<
+              ');' << compiler.emit_method_code << ';end'
+        class_eval(src)
+      end
+
+      # Define a method which recurses over the descendants of an AST node,
+      # checking whether any of them match the provided pattern
+      #
+      # If the method name ends with '?', the new method will return `true`
+      # 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')
+        if method_name.to_s.end_with?('?')
+          on_match = 'return true'
+          prelude = ''
+        else
+          yieldval = compiler.emit_capture_list
+          yieldval = 'node' if yieldval.empty?
+          on_match = "yield(#{yieldval})"
+          prelude = "return enum_for(:#{method_name},node0) unless block_given?"
+        end
+        src = <<-END
+          def #{method_name}(node0#{compiler.emit_trailing_param_list})
+            #{prelude}
+            node0.each_node do |node|
+              if #{compiler.match_code}
+                #{on_match}
+              end
+            end
+            nil
+          end
+        END
+        class_eval(src)
+      end
+    end
+
+    def initialize(str)
+      compiler = Compiler.new(str)
+      src = 'def match(node0' << compiler.emit_trailing_param_list << ');' <<
+            compiler.emit_method_code << 'end'
+      instance_eval(src)
+    end
+  end
+end