rubocop 0.15.0 → 0.16.0

data/lib/rubocop.rb

@@ -22,6 +22,9 @@ require 'rubocop/cop/variable_inspector/reference'
 require 'rubocop/cop/variable_inspector/scope'
 require 'rubocop/cop/variable_inspector/variable_table'
 
+require 'rubocop/cop/check_assignment'
+require 'rubocop/cop/check_methods'
+
 require 'rubocop/cop/lint/assignment_in_condition'
 require 'rubocop/cop/lint/block_alignment'
 require 'rubocop/cop/lint/debugger'
@@ -44,15 +47,20 @@ require 'rubocop/cop/lint/useless_setter_call'
 require 'rubocop/cop/lint/void'
 
 require 'rubocop/cop/style/autocorrect_alignment'
+require 'rubocop/cop/style/configurable_enforced_style'
+require 'rubocop/cop/style/configurable_max'
 require 'rubocop/cop/style/configurable_naming'
 require 'rubocop/cop/style/cyclomatic_complexity'
 require 'rubocop/cop/style/string_help'
+
 require 'rubocop/cop/style/access_modifier_indentation'
+require 'rubocop/cop/style/accessor_method_name'
 require 'rubocop/cop/style/alias'
 require 'rubocop/cop/style/align_array'
 require 'rubocop/cop/style/align_hash'
 require 'rubocop/cop/style/align_parameters'
 require 'rubocop/cop/style/and_or'
+require 'rubocop/cop/style/array_syntax'
 require 'rubocop/cop/style/ascii_comments'
 require 'rubocop/cop/style/ascii_identifiers'
 require 'rubocop/cop/style/attr'
@@ -64,6 +72,7 @@ require 'rubocop/cop/style/case_equality'
 require 'rubocop/cop/style/case_indentation'
 require 'rubocop/cop/style/character_literal'
 require 'rubocop/cop/style/class_and_module_camel_case'
+require 'rubocop/cop/style/code_length'
 require 'rubocop/cop/style/class_length'
 require 'rubocop/cop/style/class_methods'
 require 'rubocop/cop/style/class_vars'
@@ -84,10 +93,12 @@ require 'rubocop/cop/style/end_block'
 require 'rubocop/cop/style/end_of_line'
 require 'rubocop/cop/style/even_odd'
 require 'rubocop/cop/style/favor_join'
+require 'rubocop/cop/style/if_node'
 require 'rubocop/cop/style/favor_modifier'
 require 'rubocop/cop/style/favor_sprintf'
 require 'rubocop/cop/style/favor_unless_over_negated_if'
 require 'rubocop/cop/style/final_newline'
+require 'rubocop/cop/style/flip_flop'
 require 'rubocop/cop/style/for'
 require 'rubocop/cop/style/global_vars'
 require 'rubocop/cop/style/hash_methods'
@@ -99,6 +110,7 @@ require 'rubocop/cop/style/lambda'
 require 'rubocop/cop/style/lambda_call'
 require 'rubocop/cop/style/leading_comment_space'
 require 'rubocop/cop/style/line_length'
+require 'rubocop/cop/style/method_def_parentheses'
 require 'rubocop/cop/style/method_call_parentheses'
 require 'rubocop/cop/style/method_called_on_do_end_block'
 require 'rubocop/cop/style/method_length'
@@ -114,9 +126,9 @@ require 'rubocop/cop/style/op_method'
 require 'rubocop/cop/style/parameter_lists'
 require 'rubocop/cop/style/parentheses_around_condition'
 require 'rubocop/cop/style/perl_backrefs'
+require 'rubocop/cop/style/predicate_name'
 require 'rubocop/cop/style/proc'
 require 'rubocop/cop/style/raise_args'
-require 'rubocop/cop/style/reduce_arguments'
 require 'rubocop/cop/style/redundant_begin'
 require 'rubocop/cop/style/redundant_exception'
 require 'rubocop/cop/style/redundant_return'
@@ -125,6 +137,7 @@ require 'rubocop/cop/style/regexp_literal'
 require 'rubocop/cop/style/rescue_modifier'
 require 'rubocop/cop/style/semicolon'
 require 'rubocop/cop/style/signal_exception'
+require 'rubocop/cop/style/single_line_block_params'
 require 'rubocop/cop/style/single_line_methods'
 require 'rubocop/cop/style/space_after_comma_etc'
 require 'rubocop/cop/style/space_after_control_keyword'
@@ -142,7 +155,6 @@ require 'rubocop/cop/style/space_inside_hash_literal_braces'
 require 'rubocop/cop/style/space_inside_brackets'
 require 'rubocop/cop/style/space_inside_parens'
 require 'rubocop/cop/style/symbol_array'
-require 'rubocop/cop/style/symbol_name'
 require 'rubocop/cop/style/tab'
 require 'rubocop/cop/style/ternary_operator'
 require 'rubocop/cop/style/trailing_blank_lines'
@@ -156,6 +168,7 @@ require 'rubocop/cop/style/while_until_do'
 require 'rubocop/cop/style/word_array'
 require 'rubocop/cop/style/braces_around_hash_parameters'
 
+require 'rubocop/cop/rails/default_scope'
 require 'rubocop/cop/rails/has_and_belongs_to_many'
 require 'rubocop/cop/rails/output'
 require 'rubocop/cop/rails/read_attribute'
@@ -179,6 +192,7 @@ require 'rubocop/target_finder'
 require 'rubocop/token'
 require 'rubocop/processed_source'
 require 'rubocop/source_parser'
+require 'rubocop/file_inspector'
 require 'rubocop/cli'
 require 'rubocop/options'
 require 'rubocop/version'

data/lib/rubocop/cli.rb

@@ -7,12 +7,11 @@ module Rubocop
     # If set true while running,
     # RuboCop will abort processing and exit gracefully.
     attr_accessor :wants_to_quit
-    attr_reader :options
+    attr_reader :options, :config_store
 
     alias_method :wants_to_quit?, :wants_to_quit
 
     def initialize
-      @errors = []
       @options = {}
       @config_store = ConfigStore.new
     end
@@ -25,13 +24,14 @@ module Rubocop
       trap_interrupt
 
       @options, remaining_args = Options.new.parse(args)
-      target_files = target_finder.find(remaining_args)
-
       act_on_options(remaining_args)
+      target_files = target_finder.find(remaining_args)
 
-      any_failed = process_files(target_files)
-
-      display_error_summary(@errors)
+      inspector = FileInspector.new(@options)
+      any_failed = inspector.process_files(target_files, @config_store) do
+        wants_to_quit?
+      end
+      inspector.display_error_summary
 
       !any_failed && !wants_to_quit ? 0 : 1
     rescue => e
@@ -48,51 +48,17 @@ module Rubocop
       end
     end
 
-    def display_error_summary(errors)
-      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 process_files(target_files)
-      target_files.each(&:freeze).freeze
-      inspected_files = []
-      any_failed = false
-
-      formatter_set.started(target_files)
-
-      target_files.each do |file|
-        break if wants_to_quit?
-
-        puts "Scanning #{file}" if @options[:debug]
-        formatter_set.file_started(file, {})
-
-        offences = inspect_file(file)
-
-        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 act_on_options(args)
       if @options[:show_cops]
         print_available_cops
         exit(0)
       end
 
-      @config_store.set_options_config(@options[:config]) if @options[:config]
+      ConfigLoader.debug = @options[:debug]
+
+      @config_store.options_config = @options[:config] if @options[:config]
 
       Sickill::Rainbow.enabled = false if @options[:no_color]
 
@@ -100,8 +66,6 @@ module Rubocop
       puts Rubocop::Version.version(true) if @options[:verbose_version]
       exit(0) if @options[:version] || @options[:verbose_version]
 
-      ConfigLoader.debug = @options[:debug]
-
       if @options[:auto_gen_config]
         target_finder.find(args).each do |file|
           config = @config_store.for(file)
@@ -113,33 +77,6 @@ module Rubocop
       end
     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 inspect_file(file)
-      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 print_available_cops
       cops = Cop::Cop.all
       puts "Available cops (#{cops.length}) + config for #{Dir.pwd.to_s}: "
@@ -166,23 +103,5 @@ module Rubocop
     def target_finder
       @target_finder ||= TargetFinder.new(@config_store, @options[:debug])
     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
-        exit(1)
-      end
-    end
   end
 end

data/lib/rubocop/config.rb

@@ -12,6 +12,8 @@ module Rubocop
   class Config < DelegateClass(Hash)
     class ValidationError < StandardError; end
 
+    COMMON_PARAMS = %w(Exclude Include Severity)
+
     attr_reader :loaded_path
     attr_accessor :contains_auto_generated_config
 
@@ -54,7 +56,8 @@ module Rubocop
 
       valid_cop_names.each do |name|
         @hash[name].each_key do |param|
-          unless default_config[name].key?(param)
+          unless COMMON_PARAMS.include?(param) ||
+                 default_config[name].key?(param)
             fail ValidationError,
                  "unrecognized parameter #{name}:#{param} found " +
                  "in #{loaded_path || self}"

data/lib/rubocop/config_loader.rb

@@ -17,23 +17,16 @@ module Rubocop
 
     class << self
       attr_accessor :debug
+      attr_writer :root_level # The upwards search is stopped at this level.
       alias_method :debug?, :debug
 
       def load_file(path)
         path = File.absolute_path(path)
-        hash = YAML.load_file(path)
+        hash = YAML.load_file(path) || {}
         puts "configuration from #{path}" if debug?
         contains_auto_generated_config = false
 
-        base_configs(path, hash['inherit_from']).reverse_each do |base_config|
-          if File.basename(base_config.loaded_path) == DOTFILE
-            make_excludes_absolute(base_config)
-          end
-          base_config.each do |key, value|
-            if value.is_a?(Hash)
-              hash[key] = hash.key?(key) ? merge(value, hash[key]) : value
-            end
-          end
+        resolve_inheritance(path, hash) do |base_config|
           if base_config.loaded_path.include?(AUTO_GENERATED_FILE)
             contains_auto_generated_config = true
           end
@@ -135,6 +128,20 @@ module Rubocop
 
       private
 
+      def resolve_inheritance(path, hash)
+        base_configs(path, hash['inherit_from']).reverse_each do |base_config|
+          if File.basename(base_config.loaded_path) == DOTFILE
+            make_excludes_absolute(base_config)
+          end
+          base_config.each do |key, value|
+            if value.is_a?(Hash)
+              hash[key] = hash.key?(key) ? merge(value, hash[key]) : value
+            end
+          end
+          yield base_config
+        end
+      end
+
       def config_files_in_path(target)
         possible_config_files = dirs_to_search(target).map do |dir|
           File.join(dir, DOTFILE)
@@ -146,6 +153,7 @@ module Rubocop
         dirs_to_search = []
         target_dir_pathname = Pathname.new(File.expand_path(target_dir))
         target_dir_pathname.ascend do |dir_pathname|
+          break if dir_pathname.to_s == @root_level
           dirs_to_search << dir_pathname.to_s
         end
         dirs_to_search << Dir.home

data/lib/rubocop/config_store.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
 module Rubocop
-  # Handles chaching of configurations and association of inspected
+  # Handles caching of configurations and association of inspected
   # ruby files to configurations.
   class ConfigStore
     def initialize
@@ -19,8 +19,9 @@ module Rubocop
       @object_cache = {}
     end
 
-    def set_options_config(options_config)
+    def options_config=(options_config)
       loaded_config = ConfigLoader.load_file(options_config)
+      ConfigLoader.make_excludes_absolute(loaded_config)
       @options_config = ConfigLoader.merge_with_default(loaded_config,
                                                         options_config)
     end

data/lib/rubocop/cop/check_assignment.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+
+module Rubocop
+  module Cop
+    # Common functionality for checking assignment nodes.
+    module CheckAssignment
+      def on_lvasgn(node)
+        _lhs, rhs = *node
+        check_assignment(node, rhs)
+      end
+
+      def on_ivasgn(node)
+        _lhs, rhs = *node
+        check_assignment(node, rhs)
+      end
+
+      def on_gvasgn(node)
+        _lhs, rhs = *node
+        check_assignment(node, rhs)
+      end
+
+      def on_or_asgn(node)
+        _lhs, rhs = *node
+        check_assignment(node, rhs)
+      end
+
+      def on_and_asgn(node)
+        _lhs, rhs = *node
+        check_assignment(node, rhs)
+      end
+
+      def on_casgn(node)
+        _scope, _lhs, rhs = *node
+        check_assignment(node, rhs)
+      end
+
+      def on_op_asgn(node)
+        _lhs, _op, rhs = *node
+        check_assignment(node, rhs)
+      end
+    end
+  end
+end

data/lib/rubocop/cop/check_methods.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+module Rubocop
+  module Cop
+    # Common functionality for checking instance methods and singeton methods.
+    module CheckMethods
+      def on_def(node)
+        method_name, args, body = *node
+        check(node, method_name, args, body)
+      end
+
+      def on_defs(node)
+        _scope, method_name, args, body = *node
+        check(node, method_name, args, body)
+      end
+    end
+  end
+end

data/lib/rubocop/cop/commissioner.rb

@@ -55,8 +55,14 @@ module Rubocop
         invoke_cops_callback(processed_source)
         process(processed_source.ast) if processed_source.ast
         @cops.reduce([]) do |offences, cop|
-          offences.concat(cop.offences)
-          offences
+          filename = processed_source.buffer.name
+          # ignore files that are of no interest to the cop in question
+          if cop.relevant_file?(filename)
+            offences.concat(cop.offences)
+            offences
+          else
+            []
+          end
         end
       end
 
@@ -72,12 +78,18 @@ module Rubocop
       end
 
       # There are cops that require their own custom processing.
-      # If they define the #investigate method all input parameters passed
+      # If they define the #investigate method, all input parameters passed
       # to the commissioner will be passed to the cop too in order to do
       # its own processing.
       def invoke_cops_callback(processed_source)
         @cops.each do |cop|
           next unless cop.respond_to?(:investigate)
+
+          filename = processed_source.buffer.name
+
+          # ignore files that are of no interest to the cop in question
+          next unless cop.relevant_file?(filename)
+
           with_cop_error_handling(cop) do
             cop.investigate(processed_source)
           end

data/lib/rubocop/cop/cop.rb

@@ -32,7 +32,7 @@ module Rubocop
     # A commissioner object is responsible for traversing the AST and invoking
     # the specific callbacks on each cop.
     # If a cop needs to do its own processing of the AST or depends on
-    # something else it should define the `#investigate` method and do
+    # something else, it should define the `#investigate` method and do
     # the processing there.
     #
     # @example
@@ -44,6 +44,7 @@ module Rubocop
     #   end
     class Cop
       extend AST::Sexp
+      include Util
 
       # http://phrogz.net/programmingruby/language.html#table_18.4
       # Backtick is added last just to help editors parse this code.
@@ -118,11 +119,13 @@ module Rubocop
         respond_to?(:autocorrect, true)
       end
 
-      def add_offence(severity, node, loc, message = nil)
+      def add_offence(node, loc, message = nil, severity = nil)
         location = loc.is_a?(Symbol) ? node.loc.send(loc) : loc
 
         return if disabled_line?(location.line)
 
+        severity = custom_severity || severity || default_severity
+
         message = message ? message : message(node)
         message = debug? ? "#{name}: #{message}" : message
 
@@ -133,14 +136,16 @@ module Rubocop
                       false
                     end
         @offences << Offence.new(severity, location, message, name, corrected)
+        yield if block_given?
       end
 
-      def convention(node, location, message = nil)
-        add_offence(:convention, node, location, message)
+      def config_to_allow_offences
+        Formatter::DisabledConfigFormatter.config_to_allow_offences[cop_name]
       end
 
-      def warning(node, location, message = nil)
-        add_offence(:warning, node, location, message)
+      def config_to_allow_offences=(hash)
+        Formatter::DisabledConfigFormatter.config_to_allow_offences[cop_name] =
+          hash
       end
 
       def cop_name
@@ -153,6 +158,34 @@ module Rubocop
         @ignored_nodes << node
       end
 
+      def include_paths
+        cop_config && cop_config['Include']
+      end
+
+      def include_file?(file)
+        return true unless include_paths
+
+        include_paths.any? do |regex|
+          processed_source.buffer.name =~ /#{regex}/
+        end
+      end
+
+      def exclude_paths
+        cop_config && cop_config['Exclude']
+      end
+
+      def exclude_file?(file)
+        return false unless exclude_paths
+
+        exclude_paths.any? do |regex|
+          processed_source.buffer.name =~ /#{regex}/
+        end
+      end
+
+      def relevant_file?(file)
+        include_file?(file) && !exclude_file?(file)
+      end
+
       private
 
       def disabled_line?(line_number)
@@ -178,47 +211,22 @@ module Rubocop
         @ignored_nodes.any? { |n| n.eql?(node) } # Same object found in array?
       end
 
-      def on_node(syms, sexp, excludes = [])
-        yield sexp if Array(syms).include?(sexp.type)
-
-        return if Array(excludes).include?(sexp.type)
+      def default_severity
+        self.class.lint? ? :warning : :convention
+      end
 
-        sexp.children.each do |elem|
-          if elem.is_a?(Parser::AST::Node)
-            on_node(syms, elem, excludes) { |s| yield s }
+      def custom_severity
+        severity = cop_config && cop_config['Severity']
+        if severity
+          if Offence::SEVERITIES.include?(severity.to_sym)
+            severity.to_sym
+          else
+            warn "Warning: Invalid severity '#{severity}'. " +
+                 "Valid severities are #{Offence::SEVERITIES.join(', ')}."
+                 .color(:red)
           end
         end
       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 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]/
-        Parser::Source::Range.new(@processed_source.buffer, begin_pos, end_pos)
-      end
     end
   end
 end