rubocop 0.16.0 → 0.17.0

data/lib/rubocop.rb

@@ -7,8 +7,11 @@ require 'parser/current'
 require 'ast/sexp'
 require 'powerpack'
 
+require 'rubocop/version'
+
 require 'rubocop/cop/util'
 require 'rubocop/cop/offence'
+require 'rubocop/cop/ignored_node'
 require 'rubocop/cop/cop'
 require 'rubocop/cop/commissioner'
 require 'rubocop/cop/corrector'
@@ -22,18 +25,39 @@ 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/mixin/array_syntax'
+require 'rubocop/cop/mixin/autocorrect_alignment'
+require 'rubocop/cop/mixin/check_assignment'
+require 'rubocop/cop/mixin/check_methods'
+require 'rubocop/cop/mixin/configurable_max'
+require 'rubocop/cop/mixin/code_length'
+require 'rubocop/cop/mixin/configurable_enforced_style'
+require 'rubocop/cop/mixin/configurable_naming'
+require 'rubocop/cop/mixin/if_node'
+require 'rubocop/cop/mixin/if_then_else'
+require 'rubocop/cop/mixin/negative_conditional'
+require 'rubocop/cop/mixin/parser_diagnostic'
+require 'rubocop/cop/mixin/safe_assignment'
+require 'rubocop/cop/mixin/surrounding_space'
+require 'rubocop/cop/mixin/space_inside'
+require 'rubocop/cop/mixin/space_after_punctuation'
+require 'rubocop/cop/mixin/statement_modifier'
+require 'rubocop/cop/mixin/string_help'
 
+require 'rubocop/cop/lint/ambiguous_operator'
+require 'rubocop/cop/lint/ambiguous_regexp_literal'
 require 'rubocop/cop/lint/assignment_in_condition'
 require 'rubocop/cop/lint/block_alignment'
+require 'rubocop/cop/lint/condition_position'
 require 'rubocop/cop/lint/debugger'
+require 'rubocop/cop/lint/else_layout'
 require 'rubocop/cop/lint/empty_ensure'
 require 'rubocop/cop/lint/end_alignment'
 require 'rubocop/cop/lint/end_in_method'
 require 'rubocop/cop/lint/ensure_return'
 require 'rubocop/cop/lint/eval'
 require 'rubocop/cop/lint/handle_exceptions'
+require 'rubocop/cop/lint/invalid_character_literal'
 require 'rubocop/cop/lint/literal_in_condition'
 require 'rubocop/cop/lint/loop'
 require 'rubocop/cop/lint/parentheses_as_grouped_expression'
@@ -43,16 +67,10 @@ require 'rubocop/cop/lint/syntax'
 require 'rubocop/cop/lint/unreachable_code'
 require 'rubocop/cop/lint/useless_assignment'
 require 'rubocop/cop/lint/useless_comparison'
+require 'rubocop/cop/lint/useless_else_without_rescue'
 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'
@@ -60,7 +78,6 @@ 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'
@@ -68,11 +85,11 @@ require 'rubocop/cop/style/begin_block'
 require 'rubocop/cop/style/block_comments'
 require 'rubocop/cop/style/block_nesting'
 require 'rubocop/cop/style/blocks'
+require 'rubocop/cop/style/braces_around_hash_parameters'
 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'
@@ -80,44 +97,47 @@ require 'rubocop/cop/style/collection_methods'
 require 'rubocop/cop/style/colon_method_call'
 require 'rubocop/cop/style/comment_annotation'
 require 'rubocop/cop/style/constant_name'
+require 'rubocop/cop/style/cyclomatic_complexity'
 require 'rubocop/cop/style/def_parentheses'
 require 'rubocop/cop/style/documentation'
 require 'rubocop/cop/style/dot_position'
 require 'rubocop/cop/style/empty_line_between_defs'
 require 'rubocop/cop/style/empty_lines'
-require 'rubocop/cop/style/empty_lines_around_body'
 require 'rubocop/cop/style/empty_lines_around_access_modifier'
+require 'rubocop/cop/style/empty_lines_around_body'
 require 'rubocop/cop/style/empty_literal'
 require 'rubocop/cop/style/encoding'
 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/favor_until_over_negated_while'
 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'
 require 'rubocop/cop/style/hash_syntax'
-require 'rubocop/cop/style/if_then_else'
+require 'rubocop/cop/style/if_unless_modifier'
 require 'rubocop/cop/style/if_with_semicolon'
+require 'rubocop/cop/style/indentation_consistency'
 require 'rubocop/cop/style/indentation_width'
 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_def_parentheses'
 require 'rubocop/cop/style/method_length'
 require 'rubocop/cop/style/method_name'
 require 'rubocop/cop/style/module_function'
 require 'rubocop/cop/style/multiline_block_chain'
 require 'rubocop/cop/style/multiline_if_then'
+require 'rubocop/cop/style/multiline_ternary_operator'
+require 'rubocop/cop/style/nested_ternary_operator'
 require 'rubocop/cop/style/nil_comparison'
 require 'rubocop/cop/style/not'
 require 'rubocop/cop/style/numeric_literals'
@@ -139,25 +159,25 @@ 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_colon'
+require 'rubocop/cop/style/space_after_comma'
 require 'rubocop/cop/style/space_after_control_keyword'
 require 'rubocop/cop/style/space_after_method_name'
 require 'rubocop/cop/style/space_after_not'
-require 'rubocop/cop/style/special_global_vars'
-require 'rubocop/cop/style/space_before_modifier_keyword'
-require 'rubocop/cop/style/string_literals'
-require 'rubocop/cop/style/surrounding_space'
+require 'rubocop/cop/style/space_after_semicolon'
 require 'rubocop/cop/style/space_around_block_braces'
 require 'rubocop/cop/style/space_around_equals_in_parameter_default'
 require 'rubocop/cop/style/space_around_operators'
-require 'rubocop/cop/style/space_inside'
-require 'rubocop/cop/style/space_inside_hash_literal_braces'
+require 'rubocop/cop/style/space_before_modifier_keyword'
 require 'rubocop/cop/style/space_inside_brackets'
+require 'rubocop/cop/style/space_inside_hash_literal_braces'
 require 'rubocop/cop/style/space_inside_parens'
+require 'rubocop/cop/style/special_global_vars'
+require 'rubocop/cop/style/string_literals'
 require 'rubocop/cop/style/symbol_array'
 require 'rubocop/cop/style/tab'
-require 'rubocop/cop/style/ternary_operator'
 require 'rubocop/cop/style/trailing_blank_lines'
+require 'rubocop/cop/style/trailing_comma'
 require 'rubocop/cop/style/trailing_whitespace'
 require 'rubocop/cop/style/trivial_accessors'
 require 'rubocop/cop/style/unless_else'
@@ -165,8 +185,8 @@ require 'rubocop/cop/style/variable_interpolation'
 require 'rubocop/cop/style/variable_name'
 require 'rubocop/cop/style/when_then'
 require 'rubocop/cop/style/while_until_do'
+require 'rubocop/cop/style/while_until_modifier'
 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'
@@ -195,4 +215,3 @@ require 'rubocop/source_parser'
 require 'rubocop/file_inspector'
 require 'rubocop/cli'
 require 'rubocop/options'
-require 'rubocop/version'

data/lib/rubocop/cli.rb

@@ -57,47 +57,46 @@ module Rubocop
       end
 
       ConfigLoader.debug = @options[:debug]
+      ConfigLoader.auto_gen_config = @options[:auto_gen_config]
 
       @config_store.options_config = @options[:config] if @options[:config]
 
-      Sickill::Rainbow.enabled = false if @options[:no_color]
+      Rainbow.enabled = false unless @options[:color]
 
       puts Rubocop::Version.version(false) if @options[:version]
       puts Rubocop::Version.version(true) if @options[:verbose_version]
       exit(0) if @options[:version] || @options[:verbose_version]
-
-      if @options[:auto_gen_config]
-        target_finder.find(args).each do |file|
-          config = @config_store.for(file)
-          if config.contains_auto_generated_config
-            fail "Remove #{ConfigLoader::AUTO_GENERATED_FILE} from the " +
-              'current configuration before generating it again.'
-          end
-        end
-      end
     end
 
     def print_available_cops
       cops = Cop::Cop.all
-      puts "Available cops (#{cops.length}) + config for #{Dir.pwd.to_s}: "
-      dirconf = @config_store.for(Dir.pwd.to_s)
-      cops.types.sort!.each do |type|
-        coptypes = cops.with_type(type).sort_by!(&:cop_name)
-        puts "Type '#{type.to_s.capitalize}' (#{coptypes.size}):"
-        coptypes.each do |cop|
-          puts " - #{cop.cop_name}"
-          cnf = dirconf.for_cop(cop).dup
-          print_conf_option('Description',
-                            cnf.delete('Description') { 'None' })
-          cnf.each { |k, v| print_conf_option(k, v) }
-          print_conf_option('SupportsAutoCorrection',
-                            cop.new.support_autocorrect?.to_s)
-        end
+      show_all = @options[:show_cops].empty?
+
+      if show_all
+        puts "# Available cops (#{cops.length}) + config for #{Dir.pwd.to_s}: "
       end
+
+      cops.types.sort!.each { |type| print_cops_of_type(cops, type, show_all) }
     end
 
-    def print_conf_option(option, value)
-      puts  "    - #{option}: #{value}"
+    def print_cops_of_type(cops, type, show_all)
+      cops_of_this_type = cops.with_type(type).sort_by!(&:cop_name)
+
+      if show_all
+        puts "# Type '#{type.to_s.capitalize}' (#{cops_of_this_type.size}):"
+      end
+
+      selected_cops = cops_of_this_type.select do |cop|
+        show_all || @options[:show_cops].include?(cop.cop_name)
+      end
+
+      selected_cops.each do |cop|
+        puts '# Supports --auto-correct' if cop.new.support_autocorrect?
+        puts "#{cop.cop_name}:"
+        cnf = @config_store.for(Dir.pwd.to_s).for_cop(cop)
+        puts cnf.to_yaml.lines.to_a[1..-1].map { |line| '  ' + line }
+        puts
+      end
     end
 
     def target_finder

data/lib/rubocop/config.rb

@@ -15,7 +15,6 @@ module Rubocop
     COMMON_PARAMS = %w(Exclude Include Severity)
 
     attr_reader :loaded_path
-    attr_accessor :contains_auto_generated_config
 
     def initialize(hash = {}, loaded_path = nil)
       @hash = hash

data/lib/rubocop/config_loader.rb

@@ -16,26 +16,22 @@ module Rubocop
     AUTO_GENERATED_FILE = 'rubocop-todo.yml'
 
     class << self
-      attr_accessor :debug
+      attr_accessor :debug, :auto_gen_config
       attr_writer :root_level # The upwards search is stopped at this level.
+
       alias_method :debug?, :debug
+      alias_method :auto_gen_config?, :auto_gen_config
 
       def load_file(path)
         path = File.absolute_path(path)
         hash = YAML.load_file(path) || {}
         puts "configuration from #{path}" if debug?
-        contains_auto_generated_config = false
 
-        resolve_inheritance(path, hash) do |base_config|
-          if base_config.loaded_path.include?(AUTO_GENERATED_FILE)
-            contains_auto_generated_config = true
-          end
-        end
+        resolve_inheritance(path, hash)
 
         hash.delete('inherit_from')
         config = Config.new(hash, path)
         config.warn_unless_valid
-        config.contains_auto_generated_config = contains_auto_generated_config
         config
       end
 
@@ -73,6 +69,10 @@ module Rubocop
       def base_configs(path, inherit_from)
         Array(inherit_from).map do |f|
           f = File.join(File.dirname(path), f) unless f.start_with?('/')
+          if auto_gen_config? && f.include?(AUTO_GENERATED_FILE)
+            fail "Remove #{AUTO_GENERATED_FILE} from the current " +
+              'configuration before generating it again.'
+          end
           print 'Inheriting ' if debug?
           load_file(f)
         end
@@ -89,6 +89,8 @@ module Rubocop
 
       def configuration_from_file(config_file)
         config = load_file(config_file)
+        return config if config_file == DEFAULT_FILE
+
         found_files = config_files_in_path(config_file)
         if found_files.any? && found_files.last != config_file
           print 'AllCops/Excludes ' if debug?
@@ -101,14 +103,13 @@ module Rubocop
       def add_excludes_from_higher_level(config, highest_config)
         if highest_config['AllCops'] && highest_config['AllCops']['Excludes']
           config['AllCops'] ||= {}
-          config['AllCops']['Excludes'] ||= []
+          excludes = config['AllCops']['Excludes'] ||= []
           highest_config['AllCops']['Excludes'].each do |path|
             unless path.is_a?(Regexp) || path.start_with?('/')
               path = File.join(File.dirname(highest_config.loaded_path), path)
             end
-            config['AllCops']['Excludes'] << path
+            excludes << path unless excludes.include?(path)
           end
-          config['AllCops']['Excludes'].uniq!
         end
       end
 
@@ -120,10 +121,7 @@ module Rubocop
       end
 
       def merge_with_default(config, config_file)
-        result = Config.new(merge(default_configuration, config), config_file)
-        result.contains_auto_generated_config =
-          config.contains_auto_generated_config
-        result
+        Config.new(merge(default_configuration, config), config_file)
       end
 
       private
@@ -133,12 +131,9 @@ module Rubocop
           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
+          base_config.each do |k, v|
+            hash[k] = hash.key?(k) ? merge(v, hash[k]) : v if v.is_a?(Hash)
           end
-          yield base_config
         end
       end
 
@@ -151,13 +146,11 @@ module Rubocop
 
       def dirs_to_search(target_dir)
         dirs_to_search = []
-        target_dir_pathname = Pathname.new(File.expand_path(target_dir))
-        target_dir_pathname.ascend do |dir_pathname|
+        Pathname.new(File.expand_path(target_dir)).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
-        dirs_to_search
       end
     end
   end

data/lib/rubocop/cop/commissioner.rb

@@ -54,15 +54,10 @@ module Rubocop
         prepare(processed_source)
         invoke_cops_callback(processed_source)
         process(processed_source.ast) if processed_source.ast
-        @cops.reduce([]) do |offences, cop|
+        @cops.each_with_object([]) do |cop, 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
+          offences.concat(cop.offences) if cop.relevant_file?(filename)
         end
       end
 

data/lib/rubocop/cop/cop.rb

@@ -45,13 +45,7 @@ module Rubocop
     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.
-      OPERATOR_METHODS = %w(
-          | ^ & <=> == === =~ > >= < <= << >>
-          + - * / % ** ~ +@ -@ [] []= ! != !~
-        ).map(&:to_sym) + [:'`']
+      include IgnoredNode
 
       attr_reader :config, :offences, :corrections
       attr_accessor :processed_source # TODO: Bad design.
@@ -78,10 +72,6 @@ module Rubocop
         name.to_s.split('::')[-2].downcase.to_sym
       end
 
-      def self.style?
-        cop_type == :style
-      end
-
       def self.lint?
         cop_type == :lint
       end
@@ -96,7 +86,6 @@ module Rubocop
 
         @offences = []
         @corrections = []
-        @ignored_nodes = []
       end
 
       def cop_config
@@ -111,6 +100,10 @@ module Rubocop
         @options[:debug]
       end
 
+      def display_cop_names?
+        debug? || @options[:display_cop_names]
+      end
+
       def message(node = nil)
         self.class::MSG
       end
@@ -127,7 +120,7 @@ module Rubocop
         severity = custom_severity || severity || default_severity
 
         message = message ? message : message(node)
-        message = debug? ? "#{name}: #{message}" : message
+        message = display_cop_names? ? "#{name}: #{message}" : message
 
         corrected = begin
                       autocorrect(node) if autocorrect?
@@ -154,32 +147,12 @@ module Rubocop
 
       alias_method :name, :cop_name
 
-      def ignore_node(node)
-        @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']
+        buffer_name_matches_any?('Include', true)
       end
 
       def exclude_file?(file)
-        return false unless exclude_paths
-
-        exclude_paths.any? do |regex|
-          processed_source.buffer.name =~ /#{regex}/
-        end
+        buffer_name_matches_any?('Exclude', false)
       end
 
       def relevant_file?(file)
@@ -188,27 +161,27 @@ module Rubocop
 
       private
 
-      def disabled_line?(line_number)
-        return false unless @processed_source
-        disabled_lines = @processed_source.disabled_lines_for_cops[name]
-        return false unless disabled_lines
-        disabled_lines.include?(line_number)
+      def buffer_name_matches_any?(parameter, default_result)
+        paths = cop_config && cop_config[parameter]
+        return default_result unless paths
+        paths.any? { |path| match_path?(path, processed_source.buffer.name) }
       end
 
-      def part_of_ignored_node?(node)
-        expression = node.loc.expression
-        @ignored_nodes.each do |ignored_node|
-          if ignored_node.loc.expression.begin_pos <= expression.begin_pos &&
-            ignored_node.loc.expression.end_pos >= expression.end_pos
-            return true
-          end
+      def match_path?(pattern, path)
+        case pattern
+        when String
+          basename = File.basename(path)
+          basename == pattern || File.fnmatch(pattern, basename)
+        when Regexp
+          path =~ pattern
         end
-
-        false
       end
 
-      def ignored_node?(node)
-        @ignored_nodes.any? { |n| n.eql?(node) } # Same object found in array?
+      def disabled_line?(line_number)
+        return false unless @processed_source
+        disabled_lines = @processed_source.disabled_lines_for_cops[name]
+        return false unless disabled_lines
+        disabled_lines.include?(line_number)
       end
 
       def default_severity