rubocop 0.15.0 → 0.16.0

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

@@ -15,7 +15,7 @@ module Rubocop
           return unless loc.respond_to?(:keyword) && loc.respond_to?(:else)
 
           if loc.keyword.is?('unless') && loc.else
-            convention(node, :expression)
+            add_offence(node, :expression)
           end
         end
       end

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

@@ -12,7 +12,7 @@ module Rubocop
             var = (v.type == :nth_ref ? '$' : '') + v.to_a[0].to_s
 
             if node.loc.expression.source.include?("##{var}")
-              convention(v, :expression, sprintf(MSG, var, var))
+              add_offence(v, :expression, sprintf(MSG, var, var))
             end
           end
         end

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

@@ -8,7 +8,9 @@ module Rubocop
         MSG = 'Never use "when x;". Use "when x then" instead.'
 
         def on_when(node)
-          convention(node, :begin) if node.loc.begin && node.loc.begin.is?(';')
+          if node.loc.begin && node.loc.begin.is?(';')
+            add_offence(node, :begin)
+          end
         end
 
         def autocorrect(node)

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

@@ -18,8 +18,8 @@ module Rubocop
 
           if length > 1
             if node.loc.begin && node.loc.begin.is?('do')
-              convention(node, :begin,
-                         error_message(node.type))
+              add_offence(node, :begin,
+                          error_message(node.type))
             end
           end
         end

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

@@ -6,21 +6,15 @@ module Rubocop
       # This cop checks for array literals made up of word-like
       # strings, that are not using the %w() syntax.
       class WordArray < Cop
+        include ArraySyntax
+
         MSG = 'Use %w or %W for array of words.'
 
         def on_array(node)
-          return unless node.loc.begin && node.loc.begin.is?('[')
-
           array_elems = node.children
-
-          # no need to check empty arrays
-          return unless array_elems && array_elems.size > 1
-
-          string_array = array_elems.all? { |e| e.type == :str }
-
-          if string_array && !complex_content?(array_elems) &&
+          if array_of?(:str, node) && !complex_content?(array_elems) &&
             array_elems.size > min_size && !comments_in_array?(node)
-            convention(node, :expression)
+            add_offence(node, :expression)
           end
         end
 

data/lib/rubocop/cop/util.rb

@@ -4,6 +4,10 @@ module Rubocop
   module Cop
     # This module contains a collection of useful utility methods.
     module Util
+      extend AST::Sexp
+
+      PROC_NEW_NODE = s(:send, s(:const, nil, :Proc), :new)
+
       module_function
 
       def strip_quotes(str)
@@ -23,18 +27,6 @@ module Rubocop
         block_node.loc.end.line - block_node.loc.begin.line
       end
 
-      def source_length(source, count_comments = nil)
-        lines = source.lines.to_a[1...-1]
-
-        return 0 unless lines
-
-        lines.reject!(&:blank?)
-
-        lines.reject! { |line| comment_line?(line) } unless count_comments
-
-        lines.size
-      end
-
       def comment_line?(line_source)
         line_source =~ /^\s*#/
       end
@@ -69,6 +61,87 @@ module Rubocop
 
         const_names.reverse.join('::')
       end
+
+      def command?(name, node)
+        return unless node.type == :send
+
+        receiver, method_name, _args = *node
+
+        # commands have no explicit receiver
+        !receiver && method_name == name
+      end
+
+      def lambda?(node)
+        fail 'Not a block node' unless node.type == :block
+
+        send_node, _block_args, _block_body = *node
+
+        command?(:lambda, send_node)
+      end
+
+      def proc?(node)
+        fail 'Not a block node' unless node.type == :block
+
+        send_node, _block_args, _block_body = *node
+
+        command?(:proc, send_node) || send_node == PROC_NEW_NODE
+      end
+
+      def lambda_or_proc?(node)
+        lambda?(node) || proc?(node)
+      end
+
+      def on_node(syms, sexp, excludes = [])
+        yield sexp if Array(syms).include?(sexp.type)
+
+        return if Array(excludes).include?(sexp.type)
+
+        sexp.children.each do |elem|
+          if elem.is_a?(Parser::AST::Node)
+            on_node(syms, elem, excludes) { |s| yield s }
+          end
+        end
+      end
+
+      def source_range(source_buffer, preceding_lines, begin_column,
+                       column_count)
+        newline_length = 1
+        begin_pos = preceding_lines.reduce(0) do |a, e|
+          a + e.length + newline_length
+        end + begin_column
+        Parser::Source::Range.new(source_buffer, begin_pos,
+                                  begin_pos + column_count)
+      end
+
+      def range_with_surrounding_space(range, side = :both)
+        src = @processed_source.buffer.source
+        go_left = side == :left || side == :both
+        go_right = side == :right || side == :both
+        begin_pos = range.begin_pos
+        begin_pos -= 1 while go_left && src[begin_pos - 1] =~ /[ \t]/
+        end_pos = range.end_pos
+        end_pos += 1 while go_right && src[end_pos] =~ /[ \t]/
+        end_pos += 1 if go_right && src[end_pos] == "\n"
+        Parser::Source::Range.new(@processed_source.buffer, begin_pos, end_pos)
+      end
+
+      # Returns for example a bare `if` node if the given node is an `if` whith
+      # calls chained to the end of it.
+      def first_part_of_call_chain(node)
+        while node
+          case node.type
+          when :send
+            receiver, _method_name, _args = *node
+            node = receiver
+          when :block
+            method, _args, _body = *node
+            node = method
+          else
+            break
+          end
+        end
+        node
+      end
     end
   end
 end

data/lib/rubocop/cop/variable_inspector.rb

@@ -4,7 +4,7 @@ module Rubocop
   module Cop
     # This module provides a way to track local variables and scopes of Ruby.
     # This is intended to be used as mix-in, and the user class may override
-    # some of hook methods.
+    # some of the hook methods.
     module VariableInspector
       VARIABLE_ASSIGNMENT_TYPE = :lvasgn
       REGEXP_NAMED_CAPTURE_TYPE = :match_with_lvasgn
@@ -50,7 +50,7 @@ module Rubocop
       def inspect_variables(root_node)
         return unless root_node
 
-        # Wrap with begin node if it's standalone 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
@@ -84,6 +84,7 @@ module Rubocop
         throw :skip_children
       end
 
+      # rubocop:disable MethodLength, CyclomaticComplexity
       def dispatch_node(node)
         case node.type
         when *DECLARATION_TYPES
@@ -108,6 +109,7 @@ module Rubocop
           process_scope(node)
         end
       end
+      # rubocop:enable MethodLength, CyclomaticComplexity
 
       def process_variable_declaration(node)
         # restarg would have no name:

data/lib/rubocop/file_inspector.rb

@@ -0,0 +1,98 @@
+# encoding: utf-8
+
+module Rubocop
+  # This class handles the processing of files, which includes dealing with
+  # formatters and letting cops inspect the files.
+  class FileInspector
+    def initialize(options)
+      @options = options
+      @errors = []
+    end
+
+    # Takes a block which it calls once per inspected file.  The block shall
+    # return true if the caller wants to break the loop early.
+    def process_files(target_files, config_store)
+      target_files.each(&:freeze).freeze
+      inspected_files = []
+      any_failed = false
+
+      formatter_set.started(target_files)
+
+      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)
+
+        any_failed = true unless offences.empty?
+        inspected_files << file
+        formatter_set.file_finished(file, offences.freeze)
+      end
+
+      formatter_set.finished(inspected_files.freeze)
+      formatter_set.close_output_files
+      any_failed
+    end
+
+    def display_error_summary
+      return if @errors.empty?
+      plural = @errors.count > 1 ? 's' : ''
+      warn "\n#{@errors.count} error#{plural} occurred:".color(:red)
+      @errors.each { |error| warn error }
+      warn 'Errors are usually caused by RuboCop bugs.'
+      warn 'Please, report your problems to RuboCop\'s issue tracker.'
+      warn 'Mention the following information in the issue report:'
+      warn Rubocop::Version.version(true)
+    end
+
+    private
+
+    def inspect_file(file, config_store)
+      config = config_store.for(file)
+      team = Cop::Team.new(mobilized_cop_classes(config), config, @options)
+      offences = team.inspect_file(file)
+      @errors.concat(team.errors)
+      offences
+    end
+
+    def mobilized_cop_classes(config)
+      @mobilized_cop_classes ||= {}
+      @mobilized_cop_classes[config.object_id] ||= begin
+        cop_classes = Cop::Cop.all
+
+        if @options[:only]
+          cop_classes.select! { |c| c.cop_name == @options[:only] }
+        else
+          # filter out Rails cops unless requested
+          cop_classes.reject!(&:rails?) unless run_rails_cops?(config)
+
+          # filter out style cops when --lint is passed
+          cop_classes.select!(&:lint?) if @options[:lint]
+        end
+
+        cop_classes
+      end
+    end
+
+    def run_rails_cops?(config)
+      @options[:rails] || config['AllCops']['RunRailsCops']
+    end
+
+    def formatter_set
+      @formatter_set ||= begin
+        set = Formatter::FormatterSet.new
+        pairs = @options[:formatters] || [[Options::DEFAULT_FORMATTER]]
+        pairs.each do |formatter_key, output_path|
+          set.add_formatter(formatter_key, output_path)
+        end
+        set
+      rescue => error
+        warn error.message
+        $stderr.puts error.backtrace
+        exit(1)
+      end
+    end
+  end
+end

data/lib/rubocop/formatter/base_formatter.rb

@@ -9,8 +9,8 @@ module Rubocop
     # ## Creating Custom Formatter
     #
     # You can create a custom formatter by subclassing
-    # `Rubocop::Formatter::BaseFormatter` and override some methods,
-    # or implement all the methods by duck typing.
+    # `Rubocop::Formatter::BaseFormatter` and overriding some methods,
+    # or by implementing all the methods by duck typing.
     #
     # ## Using Custom Formatter in Command Line
     #

data/lib/rubocop/formatter/disabled_config_formatter.rb

@@ -3,7 +3,7 @@
 module Rubocop
   module Formatter
     # This formatter displays a YAML configuration file where all cops that
-    # detected any offences are disabled.
+    # detected any offences are configured to not detect the offence.
     class DisabledConfigFormatter < BaseFormatter
       HEADING =
         ['# This configuration was generated by `rubocop --auto-gen-config`.',
@@ -11,6 +11,12 @@ module Rubocop
          '# one by one as the offences are removed from the code base.']
         .join("\n")
 
+      @config_to_allow_offences = {}
+
+      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 }
@@ -21,7 +27,9 @@ module Rubocop
         @cops_with_offences.keys.sort.each do |cop_name|
           output.puts
           output.puts "#{cop_name}:"
-          output.puts '  Enabled: false'
+          cfg = self.class.config_to_allow_offences[cop_name]
+          cfg ||= { 'Enabled' => false }
+          cfg.each { |key, value| output.puts "  #{key}: #{value}" }
         end
         puts "Created #{output.path}."
         puts "Run rubocop with --config #{output.path}, or"

data/lib/rubocop/rake_task.rb

@@ -3,6 +3,8 @@
 require 'rake'
 require 'rake/tasklib'
 
+require 'rubocop/options'
+
 module Rubocop
   # Provides a custom rake task.
   #
@@ -13,6 +15,7 @@ module Rubocop
     attr_accessor :verbose
     attr_accessor :fail_on_error
     attr_accessor :patterns
+    attr_accessor :formatters
 
     def initialize(*args, &task_block)
       setup_ivars(args)
@@ -36,7 +39,7 @@ module Rubocop
 
       cli = CLI.new
       puts 'Running RuboCop...' if verbose
-      result = cli.run(patterns)
+      result = cli.run([formatters.map { |f| ['-f', f] }, patterns])
       abort('RuboCop failed!') if fail_on_error unless result == 0
     end
 
@@ -47,6 +50,7 @@ module Rubocop
       @verbose = true
       @fail_on_error = true
       @patterns = []
+      @formatters = [Rubocop::Options::DEFAULT_FORMATTER]
     end
   end
 end

data/lib/rubocop/target_finder.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
 module Rubocop
-  # This class finds target files to inspect by scanning directory tree
+  # This class finds target files to inspect by scanning the directory tree
   # and picking ruby files.
   class TargetFinder
     def initialize(config_store, debug = false)
@@ -9,8 +9,8 @@ module Rubocop
       @debug = debug
     end
 
-    # Generate a list of target files by expanding globing patterns
-    # (if any). If args is empty recursively finds all Ruby source
+    # Generate a list of target files by expanding globbing patterns
+    # (if any). If args is empty, recursively find all Ruby source
     # files under the current directory
     # @return [Array] array of file paths
     def find(args)

data/lib/rubocop/version.rb

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

data/rubocop-todo.yml

@@ -0,0 +1,12 @@
+# This configuration was generated by `rubocop --auto-gen-config`.
+# The point is for the user to remove these configuration records
+# one by one as the offences are removed from the code base.
+
+ClassLength:
+  Max: 140
+
+CyclomaticComplexity:
+  Max: 10
+
+MethodLength:
+  Max: 20

data/rubocop.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |s|
   s.summary = 'Automatic Ruby code style checking tool.'
 
   s.add_runtime_dependency('rainbow', '>= 1.1.4')
-  s.add_runtime_dependency('parser', '~> 2.0')
+  s.add_runtime_dependency('parser', '~> 2.1')
   s.add_runtime_dependency('powerpack', '~> 0.0.6')
   s.add_development_dependency('rake', '~> 10.1')
   s.add_development_dependency('rspec', '~> 2.14')