rubocop 0.16.0 → 0.17.0

data/lib/rubocop/cop/style/unless_else.rb

@@ -5,8 +5,8 @@ module Rubocop
     module Style
       # This cop looks for *unless* expressions with *else* clauses.
       class UnlessElse < Cop
-        MSG = 'Never use unless with else. Rewrite these with the ' +
-          'positive case first.'
+        MSG = 'Never use unless with else. Rewrite these with the ' \
+              'positive case first.'
 
         def on_if(node)
           loc = node.loc

data/lib/rubocop/cop/style/while_until_modifier.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+
+module Rubocop
+  module Cop
+    module Style
+      # Checks for while and until statements that would fit on one line
+      # if written as a modifier while/until.
+      class WhileUntilModifier < Cop
+        include StatementModifier
+
+        def investigate(processed_source)
+          return unless processed_source.ast
+          on_node([:while, :until], processed_source.ast) do |node|
+            # discard modifier while/until
+            next unless node.loc.end
+
+            if check(node, processed_source.comments)
+              add_offence(node, :keyword,
+                          message(node.loc.keyword.source))
+            end
+          end
+        end
+
+        private
+
+        def message(keyword)
+          "Favor modifier #{keyword} usage when you have a single-line body."
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/style/word_array.rb

@@ -7,6 +7,10 @@ module Rubocop
       # strings, that are not using the %w() syntax.
       class WordArray < Cop
         include ArraySyntax
+        # The parameter is called MinSize (meaning the minimum array size for
+        # which an offence can be registered), but essentially it's a Max
+        # parameter (the maximum number of something that's allowed).
+        include ConfigurableMax
 
         MSG = 'Use %w or %W for array of words.'
 
@@ -14,12 +18,16 @@ module Rubocop
           array_elems = node.children
           if array_of?(:str, node) && !complex_content?(array_elems) &&
             array_elems.size > min_size && !comments_in_array?(node)
-            add_offence(node, :expression)
+            add_offence(node, :expression) { self.max = array_elems.size }
           end
         end
 
         private
 
+        def parameter_name
+          'MinSize'
+        end
+
         def comments_in_array?(node)
           comments = processed_source.comments
 

data/lib/rubocop/cop/util.rb

@@ -7,9 +7,23 @@ module Rubocop
       extend AST::Sexp
 
       PROC_NEW_NODE = s(:send, s(:const, nil, :Proc), :new)
+      EQUALS_ASGN_NODES = [:lvasgn, :ivasgn, :cvasgn, :gvasgn, :casgn, :masgn]
+      SHORTHAND_ASGN_NODES = [:op_asgn, :or_asgn, :and_asgn]
+      ASGN_NODES = EQUALS_ASGN_NODES + SHORTHAND_ASGN_NODES
+
+      # http://phrogz.net/programmingruby/language.html#table_18.4
+      # Backtick is added last just to help editors parse this code.
+      OPERATOR_METHODS = %w(
+          | ^ & <=> == === =~ > >= < <= << >>
+          + - * / % ** ~ +@ -@ [] []= ! != !~
+        ).map(&:to_sym) + [:'`']
 
       module_function
 
+      def operator?(symbol)
+        OPERATOR_METHODS.include?(symbol)
+      end
+
       def strip_quotes(str)
         if str[0] == '"' || str[0] == "'"
           str[0] = ''

data/lib/rubocop/cop/variable_inspector.rb

@@ -40,7 +40,7 @@ module Rubocop
       ZERO_ARITY_SUPER_TYPE = :zsuper
 
       TWISTED_SCOPE_TYPES = [:block, :class, :sclass, :defs].freeze
-      SCOPE_TYPES = (TWISTED_SCOPE_TYPES + [:module, :def]).freeze
+      SCOPE_TYPES = (TWISTED_SCOPE_TYPES + [:top_level, :module, :def]).freeze
 
       def variable_table
         @variable_table ||= VariableTable.new(self)
@@ -50,14 +50,19 @@ module Rubocop
       def inspect_variables(root_node)
         return unless root_node
 
-        # Wrap with begin node if it's a standalone node.
-        unless root_node.type == :begin
-          root_node = Parser::AST::Node.new(:begin, [root_node])
-        end
+        # Wrap the root node with :top_level scope node.
+        top_level_node = wrap_with_top_level_node(root_node)
+
+        inspect_variables_in_scope(top_level_node)
+      end
 
-        inspect_variables_in_scope(root_node)
+      def wrap_with_top_level_node(node)
+        # This is a custom node type, not defined in Parser.
+        Parser::AST::Node.new(:top_level, [node])
       end
 
+      module_function :wrap_with_top_level_node
+
       # This is called for each scope recursively.
       def inspect_variables_in_scope(scope_node)
         variable_table.push_scope(scope_node)

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

@@ -26,9 +26,10 @@ module Rubocop
 
         def body_node
           child_index = case @node.type
-                        when :module, :sclass, :begin then 1
-                        when :def, :class, :block     then 2
-                        when :defs                    then 3
+                        when :top_level           then 0
+                        when :module, :sclass     then 1
+                        when :def, :class, :block then 2
+                        when :defs                then 3
                         end
 
           @node.children[child_index]

data/lib/rubocop/file_inspector.rb

@@ -20,15 +20,10 @@ module Rubocop
 
       target_files.each do |file|
         break if yield
-
-        puts "Scanning #{file}" if @options[:debug]
-        formatter_set.file_started(file, {})
-
-        offences = inspect_file(file, config_store)
+        offences = process_file(file, config_store)
 
         any_failed = true unless offences.empty?
         inspected_files << file
-        formatter_set.file_finished(file, offences.freeze)
       end
 
       formatter_set.finished(inspected_files.freeze)
@@ -49,6 +44,27 @@ module Rubocop
 
     private
 
+    def process_file(file, config_store)
+      puts "Scanning #{file}" if @options[:debug]
+      offences = []
+      formatter_set.file_started(file, {})
+
+      # When running with --auto-correct, we need to inspect the file (which
+      # includes writing a corrected version of it) until no more corrections
+      # are made. This is because automatic corrections can introduce new
+      # offences. In the normal case the loop is only executed once.
+      loop do
+        new_offences = inspect_file(file, config_store)
+        unique_new = new_offences.reject { |n| offences.include?(n) }
+
+        offences += unique_new
+        break unless unique_new.any?(&:corrected?)
+      end
+
+      formatter_set.file_finished(file, offences.freeze)
+      offences
+    end
+
     def inspect_file(file, config_store)
       config = config_store.for(file)
       team = Cop::Team.new(mobilized_cop_classes(config), config, @options)

data/lib/rubocop/formatter/clang_style_formatter.rb

@@ -9,7 +9,7 @@ module Rubocop
       def report_file(file, offences)
         offences.each do |o|
           output.printf("%s:%d:%d: %s: %s\n",
-                        smart_path(file).color(:cyan), o.line, o.real_column,
+                        cyan(smart_path(file)), o.line, o.real_column,
                         colored_severity_code(o), message(o))
 
           source_line = o.location.source_line

data/lib/rubocop/formatter/colorizable.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+
+module Rubocop
+  module Formatter
+    # This mix-in module provides string coloring methods for terminals.
+    # It automatically disables coloring if coloring is disabled in the process
+    # globally or the formatter's output is not a terminal.
+    module Colorizable
+      def rainbow
+        @rainbow ||= begin
+          rainbow = Rainbow.new
+          rainbow.enabled = false unless output.tty?
+          rainbow
+        end
+      end
+
+      def colorize(string, *args)
+        rainbow.wrap(string).color(*args)
+      end
+
+      [
+        :black,
+        :red,
+        :green,
+        :yellow,
+        :blue,
+        :magenta,
+        :cyan,
+        :white
+      ].each do |color|
+        define_method(color) do |string|
+          colorize(string, color)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/formatter/disabled_config_formatter.rb

@@ -6,35 +6,56 @@ module Rubocop
     # detected any offences are configured to not detect the offence.
     class DisabledConfigFormatter < BaseFormatter
       HEADING =
-        ['# This configuration was generated by `rubocop --auto-gen-config`.',
+        ['# This configuration was generated by `rubocop --auto-gen-config`',
+         "# on #{Time.now} using RuboCop version #{Version.version}.",
          '# The point is for the user to remove these configuration records',
-         '# one by one as the offences are removed from the code base.']
+         '# one by one as the offences are removed from the code base.',
+         '# Note that changes in the inspected code, or installation of new',
+         '# versions of RuboCop, may require this file to be generated again.']
         .join("\n")
 
       @config_to_allow_offences = {}
 
+      COPS = Cop::Cop.all.group_by { |c| c.cop_name }
+
       class << self
         attr_accessor :config_to_allow_offences
       end
 
       def file_finished(file, offences)
-        @cops_with_offences ||= {}
-        offences.each { |o| @cops_with_offences[o.cop_name] = true }
+        @cops_with_offences ||= Hash.new(0)
+        offences.each { |o| @cops_with_offences[o.cop_name] += 1 }
       end
 
       def finished(inspected_files)
         output.puts HEADING
-        @cops_with_offences.keys.sort.each do |cop_name|
+        @cops_with_offences.sort.each do |cop_name, offence_count|
           output.puts
-          output.puts "#{cop_name}:"
           cfg = self.class.config_to_allow_offences[cop_name]
           cfg ||= { 'Enabled' => false }
+          output_cop_comments(output, cfg, cop_name, offence_count)
+          output.puts "#{cop_name}:"
           cfg.each { |key, value| output.puts "  #{key}: #{value}" }
         end
         puts "Created #{output.path}."
         puts "Run rubocop with --config #{output.path}, or"
         puts "add inherit_from: #{output.path} in a .rubocop.yml file."
       end
+
+      def output_cop_comments(output, cfg, cop_name, offence_count)
+        output.puts "# Offence count: #{offence_count}"
+        if COPS[cop_name] && COPS[cop_name].first.new.support_autocorrect?
+          output.puts '# Cop supports --auto-correct.'
+        end
+
+        default_cfg = Rubocop::ConfigLoader.default_configuration[cop_name]
+        if default_cfg
+          params = default_cfg.keys - %w(Description Enabled) - cfg.keys
+          unless params.empty?
+            output.puts "# Configuration parameters: #{params.join(', ')}."
+          end
+        end
+      end
     end
   end
 end

data/lib/rubocop/formatter/progress_formatter.rb

@@ -42,7 +42,7 @@ module Rubocop
 
       def report_file_as_mark(file, offences)
         mark = if offences.empty?
-                 '.'.color(:green)
+                 green('.')
                else
                  highest_offence = offences.max do |a, b|
                    a.severity_level <=> b.severity_level

data/lib/rubocop/formatter/simple_text_formatter.rb

@@ -1,11 +1,15 @@
 # encoding: utf-8
 
+require 'rubocop/formatter/colorizable'
+
 module Rubocop
   module Formatter
     # A basic formatter that displays only files with offences.
     # Offences are displayed at compact form - just the
     # location of the problem and the associated message.
     class SimpleTextFormatter < BaseFormatter
+      include Colorizable
+
       COLOR_FOR_SEVERITY = {
         refactor:   :yellow,
         convention: :yellow,
@@ -32,7 +36,7 @@ module Rubocop
       end
 
       def report_file(file, offences)
-        output.puts "== #{smart_path(file)} ==".color(:yellow)
+        output.puts yellow("== #{smart_path(file)} ==")
 
         offences.each do |o|
           output.printf("%s:%3d:%3d: %s\n",
@@ -47,14 +51,14 @@ module Rubocop
 
         offences_text = pluralize(offence_count, 'offence', no_for_zero: true)
         offences_text << ' detected'
-        summary << offences_text.color(offence_count.zero? ? :green : :red)
+        summary << colorize(offences_text, offence_count.zero? ? :green : :red)
 
         if correction_count > 0
           summary << ', '
           correction_text = pluralize(correction_count, 'offence')
           correction_text << ' corrected'
           color = correction_count == offence_count ? :green : :cyan
-          summary << correction_text.color(color)
+          summary << colorize(correction_text, color)
         end
 
         output.puts
@@ -78,11 +82,11 @@ module Rubocop
 
       def colored_severity_code(offence)
         color = COLOR_FOR_SEVERITY[offence.severity]
-        offence.severity_code.color(color)
+        colorize(offence.severity_code, color)
       end
 
       def message(offence)
-        message = offence.corrected? ? '[Corrected] '.color(:green) : ''
+        message = offence.corrected? ? green('[Corrected] ') : ''
         message << offence.message
       end
 

data/lib/rubocop/options.rb

@@ -30,6 +30,7 @@ module Rubocop
           require f
         end
 
+        add_flags_with_optional_args(opts)
         add_boolean_flags(opts)
       end.parse!(args)
 
@@ -74,15 +75,29 @@ module Rubocop
       end
     end
 
+    def add_flags_with_optional_args(opts)
+      option(opts, '--show-cops [cop1,cop2,...]',
+             'Shows the given cops, or all cops by',
+             'default, and their configurations for the',
+             'current directory.') do |list|
+        @options[:show_cops] = list.nil? ? [] : list.split(',')
+      end
+    end
+
     def add_boolean_flags(opts)
-      option(opts, '--show-cops',
-             'Shows cops and their config for the',
-             'current directory.')
       option(opts, '-d', '--debug', 'Display debug info.')
+      option(opts,
+             '-D', '--display-cop-names',
+             'Display cop names in offence messages.')
       option(opts, '-R', '--rails', 'Run extra Rails cops.')
       option(opts, '-l', '--lint', 'Run only lint cops.')
       option(opts, '-a', '--auto-correct', 'Auto-correct offences.')
-      option(opts, '-n', '--no-color', 'Disable color output.')
+
+      @options[:color] = true
+      opts.on('-n', '--no-color', 'Disable color output.') do
+        @options[:color] = false
+      end
+
       option(opts, '-v', '--version', 'Display version.')
       option(opts, '-V', '--verbose-version', 'Display verbose version.')
     end

data/lib/rubocop/target_finder.rb

@@ -41,6 +41,10 @@ module Rubocop
     #   ruby source files
     # @return [Array] Array of filenames
     def target_files_in_dir(base_dir = Dir.pwd)
+      # Support Windows: Backslashes from command-line -> forward slashes
+      if File::ALT_SEPARATOR
+        base_dir.gsub!(File::ALT_SEPARATOR, File::SEPARATOR)
+      end
       files = Dir["#{base_dir}/**/*"].select { |path| FileTest.file?(path) }
       base_dir_config = @config_store.for("#{base_dir}/foobar.rb")
 

data/lib/rubocop/version.rb

@@ -3,7 +3,7 @@
 module Rubocop
   # This module holds the RuboCop version information.
   module Version
-    STRING = '0.16.0'
+    STRING = '0.17.0'
 
     MSG = '%s (using Parser %s, running on %s %s %s)'
 

data/rubocop-todo.yml

@@ -1,12 +1,20 @@
-# This configuration was generated by `rubocop --auto-gen-config`.
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2014-01-15 12:15:45 +0100 using RuboCop version 0.16.0.
 # The point is for the user to remove these configuration records
 # one by one as the offences are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
 
+# Offence count: 6
+# Configuration parameters: CountComments.
 ClassLength:
-  Max: 140
+  Max: 124
 
+# Offence count: 14
 CyclomaticComplexity:
   Max: 10
 
+# Offence count: 97
+# Configuration parameters: CountComments.
 MethodLength:
   Max: 20