rubocop 0.19.1 → 0.20.0

data/lib/rubocop/cli.rb

@@ -103,7 +103,7 @@ module Rubocop
     end
 
     def target_finder
-      @target_finder ||= TargetFinder.new(@config_store, @options[:debug])
+      @target_finder ||= TargetFinder.new(@config_store, @options)
     end
   end
 end

data/lib/rubocop/comment_config.rb

@@ -20,12 +20,12 @@ module Rubocop
       disabled_line_ranges.none? { |range| range.include?(line_number) }
     end
 
-    private
-
     def cop_disabled_line_ranges
       @cop_disabled_line_ranges ||= analyze
     end
 
+    private
+
     def analyze
       disabled_line_ranges = Hash.new { |hash, key| hash[key] = [] }
       disablement_start_line_numbers = {}
@@ -55,6 +55,8 @@ module Rubocop
     def each_mentioned_cop
       all_cop_names = nil # For performance improvement
 
+      return if processed_source.comments.nil?
+
       processed_source.comments.each do |comment|
         match = comment.text.match(COMMENT_DIRECTIVE_REGEXP)
         next unless match

data/lib/rubocop/config.rb

@@ -10,6 +10,8 @@ module Rubocop
   # during a run of the rubocop program, if files in several
   # directories are inspected.
   class Config < DelegateClass(Hash)
+    include PathUtil
+
     class ValidationError < StandardError; end
 
     COMMON_PARAMS = %w(Exclude Include Severity)
@@ -66,7 +68,7 @@ module Rubocop
     end
 
     def file_to_include?(file)
-      relative_file_path = relative_path_to_loaded_dir(file)
+      relative_file_path = path_relative_to_config(file)
       patterns_to_include.any? do |pattern|
         match_path?(pattern, relative_file_path)
       end
@@ -78,34 +80,26 @@ module Rubocop
     end
 
     def patterns_to_include
-      @hash['AllCops']['Includes']
+      @hash['AllCops']['Include']
     end
 
     def patterns_to_exclude
-      @hash['AllCops']['Excludes']
+      @hash['AllCops']['Exclude']
     end
 
-    private
-
-    def relative_path_to_loaded_dir(file)
-      return file unless loaded_path
-      ConfigLoader.relative_path(file, loaded_dir_pathname)
-    end
-
-    def loaded_dir_pathname
-      return nil unless loaded_path
-      @loaded_dir ||= begin
-        loaded_dir = File.expand_path(File.dirname(loaded_path))
-        Pathname.new(loaded_dir)
-      end
+    def path_relative_to_config(path)
+      relative_path(path, base_dir_for_path_parameters)
     end
 
-    def match_path?(pattern, path)
-      case pattern
-      when String
-        File.basename(path) == pattern || File.fnmatch(pattern, path)
-      when Regexp
-        path =~ pattern
+    # Paths specified in .rubocop.yml files are relative to the directory where
+    # that file is. Paths in other config files are relative to the current
+    # directory. This is so that paths in config/default.yml, for example, are
+    # not relative to RuboCop's config directory since that wouldn't work.
+    def base_dir_for_path_parameters
+      if File.basename(loaded_path) == ConfigLoader::DOTFILE
+        File.dirname(loaded_path)
+      else
+        Dir.pwd
       end
     end
   end

data/lib/rubocop/config_loader.rb

@@ -31,15 +31,28 @@ module Rubocop
 
         hash.delete('inherit_from')
         config = Config.new(hash, path)
+        deprecation_check(config)
         config.warn_unless_valid
+        make_excludes_absolute(config)
         config
       end
 
+      def deprecation_check(config)
+        return unless config['AllCops']
+        if config['AllCops']['Excludes']
+          warn('AllCops/Excludes was renamed to AllCops/Exclude')
+          exit(-1)
+        elsif config['AllCops']['Includes']
+          warn('AllCops/Includes was renamed to AllCops/Include')
+          exit(-1)
+        end
+      end
+
       def make_excludes_absolute(config)
-        if config['AllCops'] && config['AllCops']['Excludes']
-          config['AllCops']['Excludes'].map! do |exclude_elem|
+        if config['AllCops'] && config['AllCops']['Exclude']
+          config['AllCops']['Exclude'].map! do |exclude_elem|
             if exclude_elem.is_a?(String) && !exclude_elem.start_with?('/')
-              File.join(File.dirname(config.loaded_path), exclude_elem)
+              File.join(config.base_dir_for_path_parameters, exclude_elem)
             else
               exclude_elem
             end
@@ -47,36 +60,30 @@ module Rubocop
         end
       end
 
-      def relative_path(path, base)
-        path_name = Pathname.new(File.expand_path(path))
-        path_name.relative_path_from(Pathname.new(base)).to_s
-      end
-
-      # Return an extended merge of two hashes. That is, a normal hash merge,
+      # Return a recursive merge of two hashes. That is, a normal hash merge,
       # with the addition that any value that is a hash, and occurs in both
-      # arguments (i.e., cop names), will also be merged.
+      # arguments, will also be merged. And so on.
       def merge(base_hash, derived_hash)
         result = base_hash.merge(derived_hash)
         keys_appearing_in_both = base_hash.keys & derived_hash.keys
         keys_appearing_in_both.each do |key|
           if base_hash[key].is_a?(Hash)
-            result[key] = base_hash[key].merge(derived_hash[key])
+            result[key] = merge(base_hash[key], derived_hash[key])
           end
         end
         result
       end
 
       def base_configs(path, inherit_from)
-        Array(inherit_from).map do |f|
+        configs = 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)
-            warn "Remove #{AUTO_GENERATED_FILE} from the current " \
-                 'configuration before generating it again.'
-            exit(1)
+          unless auto_gen_config? && f.include?(AUTO_GENERATED_FILE)
+            print 'Inheriting ' if debug?
+            load_file(f)
           end
-          print 'Inheriting ' if debug?
-          load_file(f)
         end
+
+        configs.compact
       end
 
       # Returns the path of .rubocop.yml searching upwards in the
@@ -94,18 +101,17 @@ module Rubocop
 
         found_files = config_files_in_path(config_file)
         if found_files.any? && found_files.last != config_file
-          print 'AllCops/Excludes ' if debug?
+          print 'AllCops/Exclude ' if debug?
           add_excludes_from_higher_level(config, load_file(found_files.last))
         end
-        make_excludes_absolute(config)
         merge_with_default(config, config_file)
       end
 
       def add_excludes_from_higher_level(config, highest_config)
-        if highest_config['AllCops'] && highest_config['AllCops']['Excludes']
+        if highest_config['AllCops'] && highest_config['AllCops']['Exclude']
           config['AllCops'] ||= {}
-          excludes = config['AllCops']['Excludes'] ||= []
-          highest_config['AllCops']['Excludes'].each do |path|
+          excludes = config['AllCops']['Exclude'] ||= []
+          highest_config['AllCops']['Exclude'].each do |path|
             unless path.is_a?(Regexp) || path.start_with?('/')
               path = File.join(File.dirname(highest_config.loaded_path), path)
             end
@@ -129,9 +135,6 @@ module Rubocop
 
       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 |k, v|
             hash[k] = hash.key?(k) ? merge(v, hash[k]) : v if v.is_a?(Hash)
           end

data/lib/rubocop/cop/commissioner.rb

@@ -2,7 +2,7 @@
 
 module Rubocop
   module Cop
-    # Commissioner class is responsible for processing the AST and delagating
+    # Commissioner class is responsible for processing the AST and delegating
     # work to the specified cops.
     class Commissioner < Parser::AST::Processor
       attr_reader :errors

data/lib/rubocop/cop/cop.rb

@@ -145,11 +145,11 @@ module Rubocop
       alias_method :name, :cop_name
 
       def include_file?(file)
-        buffer_name_matches_any?('Include', true)
+        file_name_matches_any?(file, 'Include', true)
       end
 
       def exclude_file?(file)
-        buffer_name_matches_any?('Exclude', false)
+        file_name_matches_any?(file, 'Exclude', false)
       end
 
       def relevant_file?(file)
@@ -158,10 +158,10 @@ module Rubocop
 
       private
 
-      def buffer_name_matches_any?(parameter, default_result)
+      def file_name_matches_any?(file, parameter, default_result)
         patterns = cop_config && cop_config[parameter]
         return default_result unless patterns
-        path = relative_path(processed_source.buffer.name)
+        path = config.path_relative_to_config(file)
         patterns.any? { |pattern| match_path?(pattern, path) }
       end
 
@@ -178,11 +178,11 @@ module Rubocop
       def custom_severity
         severity = cop_config && cop_config['Severity']
         if severity
-          if Offense::SEVERITIES.include?(severity.to_sym)
+          if Severity::NAMES.include?(severity.to_sym)
             severity.to_sym
           else
             warn "Warning: Invalid severity '#{severity}'. " +
-                 "Valid severities are #{Offense::SEVERITIES.join(', ')}."
+                 "Valid severities are #{Severity::NAMES.join(', ')}."
                  .color(:red)
           end
         end

data/lib/rubocop/cop/lint/assignment_in_condition.rb

@@ -8,7 +8,7 @@ module Rubocop
       class AssignmentInCondition < Cop
         include SafeAssignment
 
-        MSG = 'Assignment in condition - you probably meant to use ==.'
+        MSG = 'Assignment in condition - you probably meant to use `==`.'
 
         def on_if(node)
           check(node)

data/lib/rubocop/cop/lint/condition_position.rb

@@ -40,7 +40,7 @@ module Rubocop
         end
 
         def message(keyword)
-          "Place the condition on the same line as #{keyword}."
+          "Place the condition on the same line as `#{keyword}`."
         end
 
         def on_different_line?(keyword_line, cond_line)

data/lib/rubocop/cop/lint/debugger.rb

@@ -5,7 +5,7 @@ module Rubocop
     module Lint
       # This cop checks for calls to debugger or pry.
       class Debugger < Cop
-        MSG = 'Remove calls to debugger.'
+        MSG = 'Remove calls to `debugger`.'
 
         # debugger call node
         #

data/lib/rubocop/cop/lint/deprecated_class_methods.rb

@@ -7,7 +7,7 @@ module Rubocop
       class DeprecatedClassMethods < Cop
         include AST::Sexp
 
-        MSG = '%s is deprecated in favor of %s.'
+        MSG = '`%s` is deprecated in favor of `%s`.'
 
         DEPRECATED_METHODS = [
           [:File, :exists?, :exist?],
@@ -18,12 +18,13 @@ module Rubocop
           receiver, method_name, *_args = *node
 
           DEPRECATED_METHODS.each do |data|
-            next unless receiver == class_node(data)
+            next unless class_nodes(data).include?(receiver)
             next unless method_name == data[1]
 
             add_offense(node, :selector,
-                        MSG.format(deprecated_method(data),
-                                   replacement_method(data)))
+                        format(MSG,
+                               deprecated_method(data),
+                               replacement_method(data)))
           end
         end
 
@@ -32,7 +33,7 @@ module Rubocop
             receiver, method_name, *_args = *node
 
             DEPRECATED_METHODS.each do |data|
-              next unless receiver == class_node(data)
+              next unless class_nodes(data).include?(receiver)
               next unless method_name == data[1]
 
               corrector.replace(node.loc.selector,
@@ -43,8 +44,9 @@ module Rubocop
 
         private
 
-        def class_node(data)
-          s(:const, nil, data[0])
+        def class_nodes(data)
+          [s(:const, nil, data[0]),
+           s(:const, s(:cbase), data[0])]
         end
 
         def deprecated_method(data)

data/lib/rubocop/cop/lint/else_layout.rb

@@ -49,7 +49,7 @@ module Rubocop
         end
 
         def message
-          'Odd else layout detected. Perhaps you meant to use elsif instead?'
+          'Odd `else` layout detected. Did you mean to use `elsif`?'
         end
       end
     end

data/lib/rubocop/cop/lint/empty_ensure.rb

@@ -5,7 +5,7 @@ module Rubocop
     module Lint
       # This cop checks for empty `ensure` blocks
       class EmptyEnsure < Cop
-        MSG = 'Empty ensure block detected.'
+        MSG = 'Empty `ensure` block detected.'
 
         def on_ensure(node)
           _body, ensure_body = *node

data/lib/rubocop/cop/lint/empty_interpolation.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+module Rubocop
+  module Cop
+    module Lint
+      # This cop checks for empty interpolation.
+      #
+      # @example
+      #
+      #   "result is #{}"
+      class EmptyInterpolation < Cop
+        MSG = 'Empty interpolation detected.'
+
+        def on_dstr(node)
+          node.children.select { |n| n.type == :begin }.each do |begin_node|
+            add_offense(begin_node, :expression) if begin_node.children.empty?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/lint/end_in_method.rb

@@ -7,7 +7,7 @@ module Rubocop
       class EndInMethod < Cop
         include CheckMethods
 
-        MSG = 'END found in method definition. Use `at_exit` instead.'
+        MSG = '`END` found in method definition. Use `at_exit` instead.'
 
         private
 

data/lib/rubocop/cop/lint/ensure_return.rb

@@ -5,7 +5,7 @@ module Rubocop
     module Lint
       # This cop checks for *return* from an *ensure* block.
       class EnsureReturn < Cop
-        MSG = 'Never return from an ensure block.'
+        MSG = 'Never return from an `ensure` block.'
 
         def on_ensure(node)
           _body, ensure_body = *node

data/lib/rubocop/cop/lint/eval.rb

@@ -5,7 +5,7 @@ module Rubocop
     module Lint
       # This cop checks for the use of *Kernel#eval*.
       class Eval < Cop
-        MSG = 'The use of eval is a serious security risk.'
+        MSG = 'The use of `eval` is a serious security risk.'
 
         def on_send(node)
           receiver, method_name, = *node

data/lib/rubocop/cop/lint/literal_in_condition.rb

@@ -18,7 +18,7 @@ module Rubocop
       #   end
       #
       class LiteralInCondition < Cop
-        MSG = 'Literal %s appeared in a condition.'
+        MSG = 'Literal `%s` appeared in a condition.'
 
         LITERALS = [:str, :dstr, :int, :float, :array,
                     :hash, :regexp, :nil, :true, :false]
@@ -58,7 +58,7 @@ module Rubocop
         end
 
         def message(node)
-          MSG.format(node.loc.expression.source)
+          format(MSG, node.loc.expression.source)
         end
 
         private

data/lib/rubocop/cop/lint/literal_in_interpolation.rb

@@ -17,11 +17,20 @@ module Rubocop
         def on_dstr(node)
           node.children.select { |n| n.type == :begin }.each do |begin_node|
             final_node = begin_node.children.last
+            next unless final_node
+            # handle strings like __FILE__
+            return if special_string?(final_node)
             next unless LITERALS.include?(final_node.type)
 
             add_offense(final_node, :expression)
           end
         end
+
+        private
+
+        def special_string?(node)
+          node.type == :str && !node.loc.respond_to?(:begin)
+        end
       end
     end
   end