rubocop 0.24.1 → 0.25.0

data/lib/rubocop.rb

@@ -41,15 +41,16 @@ require 'rubocop/cop/mixin/array_syntax'
 require 'rubocop/cop/mixin/autocorrect_alignment'
 require 'rubocop/cop/mixin/autocorrect_unless_changing_ast'
 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/end_keyword_alignment'
 require 'rubocop/cop/mixin/if_node'
-require 'rubocop/cop/mixin/if_then_else'
 require 'rubocop/cop/mixin/negative_conditional'
+require 'rubocop/cop/mixin/on_method'
+require 'rubocop/cop/mixin/method_complexity'
+require 'rubocop/cop/mixin/on_normal_if_unless'
 require 'rubocop/cop/mixin/parser_diagnostic'
 require 'rubocop/cop/mixin/percent_literal'
 require 'rubocop/cop/mixin/safe_assignment'
@@ -99,6 +100,14 @@ require 'rubocop/cop/lint/useless_else_without_rescue'
 require 'rubocop/cop/lint/useless_setter_call'
 require 'rubocop/cop/lint/void'
 
+require 'rubocop/cop/metrics/block_nesting'
+require 'rubocop/cop/metrics/class_length'
+require 'rubocop/cop/metrics/cyclomatic_complexity'
+require 'rubocop/cop/metrics/line_length'
+require 'rubocop/cop/metrics/method_length'
+require 'rubocop/cop/metrics/parameter_lists'
+require 'rubocop/cop/metrics/perceived_complexity'
+
 require 'rubocop/cop/style/access_modifier_indentation'
 require 'rubocop/cop/style/accessor_method_name'
 require 'rubocop/cop/style/alias'
@@ -110,9 +119,10 @@ require 'rubocop/cop/style/array_join'
 require 'rubocop/cop/style/ascii_comments'
 require 'rubocop/cop/style/ascii_identifiers'
 require 'rubocop/cop/style/attr'
+require 'rubocop/cop/style/bare_percent_literals'
 require 'rubocop/cop/style/begin_block'
 require 'rubocop/cop/style/block_comments'
-require 'rubocop/cop/style/block_nesting'
+require 'rubocop/cop/style/block_end_newline'
 require 'rubocop/cop/style/blocks'
 require 'rubocop/cop/style/braces_around_hash_parameters'
 require 'rubocop/cop/style/case_equality'
@@ -121,7 +131,6 @@ require 'rubocop/cop/style/character_literal'
 require 'rubocop/cop/style/class_and_module_camel_case'
 require 'rubocop/cop/style/class_and_module_children'
 require 'rubocop/cop/style/class_check'
-require 'rubocop/cop/style/class_length'
 require 'rubocop/cop/style/class_methods'
 require 'rubocop/cop/style/class_vars'
 require 'rubocop/cop/style/collection_methods'
@@ -129,7 +138,6 @@ require 'rubocop/cop/style/colon_method_call'
 require 'rubocop/cop/style/comment_annotation'
 require 'rubocop/cop/style/comment_indentation'
 require 'rubocop/cop/style/constant_name'
-require 'rubocop/cop/style/cyclomatic_complexity'
 require 'rubocop/cop/style/def_with_parentheses'
 require 'rubocop/cop/style/deprecated_hash_methods'
 require 'rubocop/cop/style/documentation'
@@ -163,14 +171,13 @@ require 'rubocop/cop/style/lambda'
 require 'rubocop/cop/style/lambda_call'
 require 'rubocop/cop/style/leading_comment_space'
 require 'rubocop/cop/style/line_end_concatenation'
-require 'rubocop/cop/style/line_length'
 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_block_layout'
 require 'rubocop/cop/style/multiline_if_then'
 require 'rubocop/cop/style/multiline_ternary_operator'
 require 'rubocop/cop/style/negated_if'
@@ -183,9 +190,9 @@ require 'rubocop/cop/style/not'
 require 'rubocop/cop/style/numeric_literals'
 require 'rubocop/cop/style/one_line_conditional'
 require 'rubocop/cop/style/op_method'
-require 'rubocop/cop/style/parameter_lists'
 require 'rubocop/cop/style/parentheses_around_condition'
 require 'rubocop/cop/style/percent_literal_delimiters'
+require 'rubocop/cop/style/percent_q_literals'
 require 'rubocop/cop/style/perl_backrefs'
 require 'rubocop/cop/style/predicate_name'
 require 'rubocop/cop/style/proc'

data/lib/rubocop/config_loader.rb

@@ -3,13 +3,6 @@
 require 'yaml'
 require 'pathname'
 
-# Psych can give an error when reading an empty file, so we use syck in Ruby
-# versions where it's available. Also, the problem with empty files does not
-# appear in Ruby 2 or in JRuby 1.9 mode.
-if RUBY_VERSION < '2.0.0' && RUBY_PLATFORM != 'java'
-  YAML::ENGINE.yamler = 'syck'
-end
-
 module RuboCop
   # This class represents the configuration of the RuboCop application
   # and all its cops. A Config is associated with a YAML configuration
@@ -31,7 +24,18 @@ module RuboCop
 
       def load_file(path)
         path = File.absolute_path(path)
+
+        # Psych can give an error when reading an empty file, so we use syck in
+        # Ruby versions where it's available. Also, the problem with empty
+        # files does not appear in Ruby 2 or in JRuby 1.9 mode.
+        if RUBY_VERSION < '2.0.0' && RUBY_PLATFORM != 'java'
+          original_yamler = YAML::ENGINE.yamler
+          YAML::ENGINE.yamler = 'syck'
+        end
         hash = YAML.load_file(path) || {}
+        # Restore yamler for applications using RuboCop as a library.
+        YAML::ENGINE.yamler = original_yamler if original_yamler
+
         puts "configuration from #{path}" if debug?
 
         resolve_inheritance(path, hash)

data/lib/rubocop/cop/cop.rb

@@ -58,15 +58,23 @@ module RuboCop
       end
 
       def self.qualified_cop_name(name, origin)
-        return name if name.include?('/')
+        @cop_names ||= Set.new(@all.map(&:cop_name))
+        basename = File.basename(name)
         found_ns = @all.types.map(&:capitalize).select do |ns|
-          @all.map(&:cop_name).include?("#{ns}/#{name}")
+          @cop_names.include?("#{ns}/#{basename}")
         end
 
         case found_ns.size
-        when 0 then name # No namespace found. Deal with it later in caller.
-        when 1 then "#{found_ns.first}/#{name}"
-        else fail AmbiguousCopName, "`#{name}` used in #{origin}"
+        when 0
+          name # No namespace found. Deal with it later in caller.
+        when 1
+          if name != basename && found_ns.first != File.dirname(name).to_sym
+            warn "#{origin}: #{name} has the wrong namespace - " \
+                 "should be #{found_ns.first}"
+          end
+          "#{found_ns.first}/#{basename}"
+        else
+          fail AmbiguousCopName, "`#{basename}` used in #{origin}"
         end
       end
 
@@ -168,16 +176,9 @@ module RuboCop
 
       alias_method :name, :cop_name
 
-      def include_file?(file)
-        file_name_matches_any?(file, 'Include', true)
-      end
-
-      def exclude_file?(file)
-        file_name_matches_any?(file, 'Exclude', false)
-      end
-
       def relevant_file?(file)
-        include_file?(file) && !exclude_file?(file)
+        file_name_matches_any?(file, 'Include', true) &&
+          !file_name_matches_any?(file, 'Exclude', false)
       end
 
       private
@@ -193,8 +194,7 @@ module RuboCop
 
       def enabled_line?(line_number)
         return true unless @processed_source
-        @processed_source.comment_config
-          .cop_enabled_at_line?(self, line_number)
+        @processed_source.comment_config.cop_enabled_at_line?(self, line_number)
       end
 
       def default_severity

data/lib/rubocop/cop/ignored_node.rb

@@ -9,10 +9,17 @@ module RuboCop
       end
 
       def part_of_ignored_node?(node)
-        expression = node.loc.expression
-        ignored_nodes.any? do |ignored_node|
-          ignored_node.loc.expression.begin_pos <= expression.begin_pos &&
-            ignored_node.loc.expression.end_pos >= expression.end_pos
+        ignored_nodes.map(&:loc).any? do |ignored_loc|
+          if ignored_loc.expression.begin_pos > node.loc.expression.begin_pos
+            next false
+          end
+
+          ignored_end_pos = if ignored_loc.respond_to?(:heredoc_body)
+                              ignored_loc.heredoc_end.end_pos
+                            else
+                              ignored_loc.expression.end_pos
+                            end
+          ignored_end_pos >= node.loc.expression.end_pos
         end
       end
 

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

@@ -102,12 +102,14 @@ module RuboCop
         end
 
         def check_block_alignment(start_node, block_node)
-          start_loc = start_node.loc.expression
           end_loc = block_node.loc.end
-          do_loc = block_node.loc.begin # Actually it's either do or {.
-          return if do_loc.line == end_loc.line # One-liner, not interesting.
+          return unless begins_its_line?(end_loc)
+
+          start_loc = start_node.loc.expression
           return unless start_loc.column != end_loc.column
 
+          do_loc = block_node.loc.begin # Actually it's either do or {.
+
           # We've found that "end" is not aligned with the start node (which
           # can be a block, a variable assignment, etc). But we also allow
           # the "end" to be aligned with the start of the line where the "do"
@@ -117,7 +119,7 @@ module RuboCop
           indentation_of_do_line = match.begin(0)
           return unless end_loc.column != indentation_of_do_line
 
-          add_offense(nil,
+          add_offense(block_node,
                       end_loc,
                       format(MSG, end_loc.line, end_loc.column,
                              start_loc.source.lines.to_a.first.chomp,
@@ -145,6 +147,29 @@ module RuboCop
         def block_is_on_next_line?(begin_node, block_node)
           begin_node.loc.line != block_node.loc.line
         end
+
+        def autocorrect(node)
+          key = node.children.first
+          source = node.loc.expression.source_buffer
+
+          @corrections << lambda do |corrector|
+            start_col = key.loc.expression.column
+            starting_position_of_block_end = node.loc.end.begin_pos
+            end_col = node.loc.end.column
+
+            if end_col < start_col
+              delta = start_col - end_col
+              corrector.insert_before(node.loc.end, ' ' * delta)
+            elsif end_col > start_col
+              delta = start_col - end_col
+              range_start = starting_position_of_block_end + delta
+              range_end = range_start - delta
+
+              range = Parser::Source::Range.new(source, range_start, range_end)
+              corrector.remove(range)
+            end
+          end
+        end
       end
     end
   end

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

@@ -29,11 +29,18 @@ module RuboCop
         #   (send nil :binding) :remote_pry)
         REMOTE_PRY_NODE = s(:send, s(:send, nil, :binding), :remote_pry)
 
+        # binding.pry_remote node
+        #
+        # (send
+        #   (send nil :binding) :pry_remote)
+        PRY_REMOTE_NODE = s(:send, s(:send, nil, :binding), :pry_remote)
+
         DEBUGGER_NODES = [
           DEBUGGER_NODE,
           BYEBUG_NODE,
           PRY_NODE,
-          REMOTE_PRY_NODE
+          REMOTE_PRY_NODE,
+          PRY_REMOTE_NODE
         ]
 
         def on_send(node)

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

@@ -17,11 +17,15 @@ module RuboCop
       #   private def foo
       #   end
       class DefEndAlignment < Cop
-        include CheckMethods
+        include OnMethod
         include EndKeywordAlignment
 
         MSG = '`end` at %d, %d is not aligned with `%s` at %d, %d'
 
+        def on_method(node, _method_name, _args, _body)
+          check_offset_of_node(node)
+        end
+
         def on_send(node)
           receiver, method_name, *args = *node
           return unless visibility_and_def_on_same_line?(receiver, method_name,

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

@@ -23,23 +23,23 @@ module RuboCop
         MSG = '`end` at %d, %d is not aligned with `%s` at %d, %d'
 
         def on_class(node)
-          check(node)
+          check_offset_of_node(node)
         end
 
         def on_module(node)
-          check(node)
+          check_offset_of_node(node)
         end
 
         def on_if(node)
-          check(node) unless ternary_op?(node)
+          check_offset_of_node(node) unless ternary_op?(node)
         end
 
         def on_while(node)
-          check(node)
+          check_offset_of_node(node)
         end
 
         def on_until(node)
-          check(node)
+          check_offset_of_node(node)
         end
 
         private

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

@@ -5,13 +5,13 @@ module RuboCop
     module Lint
       # This cop checks for END blocks in method definitions.
       class EndInMethod < Cop
-        include CheckMethods
+        include OnMethod
 
         MSG = '`END` found in method definition. Use `at_exit` instead.'
 
         private
 
-        def check(node, *_)
+        def on_method(node, _method_name, _args, _body)
           on_node(:postexe, node) do |end_node|
             add_offense(end_node, :keyword)
           end

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

@@ -13,7 +13,7 @@ module RuboCop
       #    x.attr = 5
       #  end
       class UselessSetterCall < Cop
-        include CheckMethods
+        include OnMethod
 
         MSG = 'Useless setter call to local variable `%s`.'
         ASSIGNMENT_TYPES = [:lvasgn, :ivasgn, :cvasgn, :gvasgn].freeze
@@ -27,7 +27,7 @@ module RuboCop
 
         private
 
-        def check(_node, _method_name, _args, body)
+        def on_method(_node, _method_name, _args, body)
           return unless body
 
           if body.type == :begin

data/lib/rubocop/cop/{style → metrics}/block_nesting.rb

@@ -2,7 +2,7 @@
 
 module RuboCop
   module Cop
-    module Style
+    module Metrics
       # This cop checks for excessive nesting of conditional and looping
       # constructs. Despite the cop's name, blocks are not considered as an
       # extra level of nesting.

data/lib/rubocop/cop/{style → metrics}/class_length.rb

@@ -2,7 +2,7 @@
 
 module RuboCop
   module Cop
-    module Style
+    module Metrics
       # This cop checks if the length a class exceeds some maximum value.
       # Comment lines can optionally be ignored.
       # The maximum allowed length is configurable.
@@ -10,13 +10,13 @@ module RuboCop
         include CodeLength
 
         def on_class(node)
-          check(node)
+          check_code_length(node)
         end
 
         private
 
-        def message
-          'Class definition is too long. [%d/%d]'
+        def message(length, max_length)
+          format('Class definition is too long. [%d/%d]', length, max_length)
         end
 
         def code_length(node)

data/lib/rubocop/cop/{style → metrics}/cyclomatic_complexity.rb

@@ -2,7 +2,7 @@
 
 module RuboCop
   module Cop
-    module Style
+    module Metrics
       # This cop checks that the cyclomatic complexity of methods is not higher
       # than the configured maximum. The cyclomatic complexity is the number of
       # linearly independent paths through a method. The algorithm counts
@@ -14,26 +14,15 @@ module RuboCop
       # and ||/or is shorthand for a sequence of ifs, so they also add one.
       # Loops can be said to have an exit condition, so they add one.
       class CyclomaticComplexity < Cop
-        include CheckMethods
-        include ConfigurableMax
+        include MethodComplexity
 
         MSG = 'Cyclomatic complexity for %s is too high. [%d/%d]'
-        DECISION_POINT_NODES = [:if, :while, :until, :for, :rescue, :when,
-                                :and, :or]
+        COUNTED_NODES = [:if, :while, :until, :for, :rescue, :when, :and, :or]
 
         private
 
-        def check(node, method_name, *_)
-          complexity = 1
-          on_node(DECISION_POINT_NODES, node) { complexity += 1 }
-
-          max = cop_config['Max']
-          return unless complexity > max
-
-          add_offense(node, :keyword,
-                      format(MSG, method_name, complexity, max)) do
-            self.max = complexity
-          end
+        def complexity_score_for(_node)
+          1
         end
       end
     end

data/lib/rubocop/cop/{style → metrics}/line_length.rb

@@ -4,7 +4,7 @@ require 'uri'
 
 module RuboCop
   module Cop
-    module Style
+    module Metrics
       # This cop checks the length of lines in the source code.
       # The maximum length is configurable.
       class LineLength < Cop

data/lib/rubocop/cop/{style → metrics}/method_length.rb

@@ -2,18 +2,22 @@
 
 module RuboCop
   module Cop
-    module Style
+    module Metrics
       # This cop checks if the length a method exceeds some maximum value.
       # Comment lines can optionally be ignored.
       # The maximum allowed length is configurable.
       class MethodLength < Cop
-        include CheckMethods
+        include OnMethod
         include CodeLength
 
         private
 
-        def message
-          'Method has too many lines. [%d/%d]'
+        def on_method(node, _method_name, _args, _body)
+          check_code_length(node)
+        end
+
+        def message(length, max_length)
+          format('Method has too many lines. [%d/%d]', length, max_length)
         end
 
         def code_length(node)