rubocop 0.47.1 → 0.48.0

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

@@ -57,7 +57,7 @@ module RuboCop
         PERCENT_I = '%i'.freeze
         PERCENT_CAPITAL_I = '%I'.freeze
         ARRAY_NEW_PATTERN = '$(send (const nil :Array) :new ...)'.freeze
-        ASSIGNMENT_TYPES = [:lvasgn, :ivasgn, :cvasgn, :gvasgn].freeze
+        ASSIGNMENT_TYPES = %i(lvasgn ivasgn cvasgn gvasgn).freeze
 
         def_node_matcher :literal_expansion?, <<-PATTERN
           (splat {$({str dstr int float array} ...) (block #{ARRAY_NEW_PATTERN} ...) #{ARRAY_NEW_PATTERN}} ...)

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

@@ -26,14 +26,15 @@ module RuboCop
       class UnreachableCode < Cop
         MSG = 'Unreachable code detected.'.freeze
 
-        NODE_TYPES = [:return, :next, :break, :retry, :redo].freeze
-        FLOW_COMMANDS = [:throw, :raise, :fail].freeze
+        NODE_TYPES = %i(return next break retry redo).freeze
+        FLOW_COMMANDS = %i(throw raise fail).freeze
 
         def on_begin(node)
           expressions = *node
 
           expressions.each_cons(2) do |e1, e2|
             next unless NODE_TYPES.include?(e1.type) || flow_command?(e1)
+
             add_offense(e2, :expression)
           end
         end
@@ -41,6 +42,8 @@ module RuboCop
         private
 
         def flow_command?(node)
+          return false unless node.send_type?
+
           FLOW_COMMANDS.any? { |c| node.command?(c) }
         end
       end

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

@@ -7,33 +7,33 @@ module RuboCop
       #
       # @example
       #
-      #   #good
+      #   # bad
       #
       #   do_something do |used, unused|
       #     puts used
       #   end
       #
-      #   do_something do
+      #   do_something do |bar|
       #     puts :foo
       #   end
       #
-      #   define_method(:foo) do |_bar|
+      #   define_method(:foo) do |bar|
       #     puts :baz
       #   end
       #
       # @example
       #
-      #   # bad
+      #   #good
       #
       #   do_something do |used, _unused|
       #     puts used
       #   end
       #
-      #   do_something do |bar|
+      #   do_something do
       #     puts :foo
       #   end
       #
-      #   define_method(:foo) do |bar|
+      #   define_method(:foo) do |_bar|
       #     puts :baz
       #   end
       class UnusedBlockArgument < Cop

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

@@ -89,7 +89,8 @@ module RuboCop
           return unless assignment.meta_assignment_node
                                   .equal?(return_value_node)
 
-          " Use just operator `#{assignment.operator.sub(/=$/, '')}`."
+          " Use `#{assignment.operator.sub(/=$/, '')}` " \
+          "instead of `#{assignment.operator}`."
         end
 
         def similar_name_message(variable)

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

@@ -14,12 +14,13 @@ module RuboCop
         MSG = 'Comparison of something with itself detected.'.freeze
         OPS = %w(== === != < > <= >= <=>).freeze
 
-        def_node_matcher :comparison?, "(send $_ {:#{OPS.join(' :')}} $_)"
+        def_node_matcher :useless_comparison?,
+                         "(send $_match {:#{OPS.join(' :')}} $_match)"
 
         def on_send(node)
-          comparison?(node) do |receiver, args|
-            add_offense(node, :selector) if receiver == args
-          end
+          return unless useless_comparison?(node)
+
+          add_offense(node, :selector)
         end
       end
     end

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

@@ -28,7 +28,7 @@ module RuboCop
         include OnMethodDef
 
         MSG = 'Useless setter call to local variable `%s`.'.freeze
-        ASSIGNMENT_TYPES = [:lvasgn, :ivasgn, :cvasgn, :gvasgn].freeze
+        ASSIGNMENT_TYPES = %i(lvasgn ivasgn cvasgn gvasgn).freeze
 
         private
 

data/lib/rubocop/cop/message_annotator.rb

@@ -28,7 +28,7 @@ module RuboCop
       # @option cop_config [String] :Reference Full reference URL
       # @option cop_config [String] :Details
       #
-      # @param [Hash] options
+      # @param [Hash, nil] optional options
       # @option option [Boolean] :display_style_guide
       #   Include style guide and reference URLs
       # @option option [Boolean] :extra_details
@@ -51,12 +51,16 @@ module RuboCop
         message = "#{name}: #{message}" if display_cop_names?
         message += " #{details}" if extra_details?
         if display_style_guide?
-          links = [style_guide_url, reference_url].compact.join(', ')
+          links = urls.join(', ')
           message = "#{message} (#{links})"
         end
         message
       end
 
+      def urls
+        [style_guide_url, reference_url].compact
+      end
+
       private
 
       def style_guide_url
@@ -70,7 +74,7 @@ module RuboCop
       end
 
       def display_style_guide?
-        (style_guide_url || reference_url) &&
+        !urls.empty? &&
           (options[:display_style_guide] ||
             config.for_all_cops['DisplayStyleGuide'])
       end

data/lib/rubocop/cop/metrics/abc_size.rb

@@ -11,7 +11,7 @@ module RuboCop
 
         MSG = 'Assignment Branch Condition size for %s is too high. ' \
               '[%.4g/%.4g]'.freeze
-        BRANCH_NODES = [:send, :csend].freeze
+        BRANCH_NODES = %i(send csend).freeze
         CONDITION_NODES = CyclomaticComplexity::COUNTED_NODES.freeze
 
         private

data/lib/rubocop/cop/metrics/block_nesting.rb

@@ -14,10 +14,10 @@ module RuboCop
       class BlockNesting < Cop
         include ConfigurableMax
 
-        NESTING_BLOCKS = [
-          :case, :if, :while, :while_post,
-          :until, :until_post, :for, :resbody
-        ].freeze
+        NESTING_BLOCKS = %i(
+          case if while while_post
+          until until_post for resbody
+        ).freeze
 
         def investigate(processed_source)
           return unless processed_source.ast

data/lib/rubocop/cop/metrics/cyclomatic_complexity.rb

@@ -17,8 +17,8 @@ module RuboCop
         include MethodComplexity
 
         MSG = 'Cyclomatic complexity for %s is too high. [%d/%d]'.freeze
-        COUNTED_NODES = [:if, :while, :until, :for,
-                         :rescue, :when, :and, :or].freeze
+        COUNTED_NODES = %i(if while until for
+                           rescue when and or).freeze
 
         private
 

data/lib/rubocop/cop/metrics/line_length.rb

@@ -9,6 +9,7 @@ module RuboCop
       # The maximum length is configurable.
       class LineLength < Cop
         include ConfigurableMax
+        include IgnoredPattern
 
         MSG = 'Line is too long. [%d/%d]'.freeze
 
@@ -86,14 +87,6 @@ module RuboCop
           end
         end
 
-        def matches_ignored_pattern?(line)
-          ignored_patterns.any? { |pattern| Regexp.new(pattern).match(line) }
-        end
-
-        def ignored_patterns
-          cop_config['IgnoredPatterns'] || []
-        end
-
         def allow_uri?
           cop_config['AllowURI']
         end
@@ -159,7 +152,7 @@ module RuboCop
         end
 
         def line_length_without_directive(line)
-          before_comment, = line.split('#')
+          before_comment, = line.split(CommentConfig::COMMENT_DIRECTIVE_REGEXP)
           before_comment.rstrip.length
         end
 

data/lib/rubocop/cop/metrics/parameter_lists.rb

@@ -10,13 +10,14 @@ module RuboCop
       class ParameterLists < Cop
         include ConfigurableMax
 
-        MSG = 'Avoid parameter lists longer than %d parameters.'.freeze
+        MSG = 'Avoid parameter lists longer than %d parameters. [%d/%d]'.freeze
 
         def on_args(node)
           count = args_count(node)
           return unless count > max_params
 
-          add_offense(node, :expression, format(MSG, max_params)) do
+          message = format(MSG, max_params, count, max_params)
+          add_offense(node, :expression, message) do
             self.max = count
           end
         end
@@ -27,7 +28,7 @@ module RuboCop
           if count_keyword_args?
             node.children.size
           else
-            node.children.count { |a| ![:kwoptarg, :kwarg].include?(a.type) }
+            node.children.count { |a| !%i(kwoptarg kwarg).include?(a.type) }
           end
         end
 

data/lib/rubocop/cop/metrics/perceived_complexity.rb

@@ -30,8 +30,8 @@ module RuboCop
         include MethodComplexity
 
         MSG = 'Perceived complexity for %s is too high. [%d/%d]'.freeze
-        COUNTED_NODES = [:if, :case, :while, :until,
-                         :for, :rescue, :and, :or].freeze
+        COUNTED_NODES = %i(if case while until
+                           for rescue and or).freeze
 
         private
 

data/lib/rubocop/cop/mixin/access_modifier_node.rb

@@ -32,7 +32,7 @@ module RuboCop
           if ancestor.block_type?
             return true if ancestor.class_constructor?
           elsif !ancestor.begin_type?
-            return [:casgn, :sclass, :class, :module].include?(ancestor.type)
+            return %i(casgn sclass class module).include?(ancestor.type)
           end
         end
       end

data/lib/rubocop/cop/mixin/array_hash_indentation.rb

@@ -5,11 +5,11 @@ module RuboCop
     # Common code for indenting literal arrays and hashes.
     module ArrayHashIndentation
       def each_argument_node(node, type)
-        _receiver, _method_name, *args = *node
         left_parenthesis = node.loc.begin
+
         return unless left_parenthesis
 
-        args.each do |arg|
+        node.arguments.each do |arg|
           on_node(type, arg, :send) do |type_node|
             left_brace = type_node.loc.begin
             if left_brace && left_brace.line == left_parenthesis.line

data/lib/rubocop/cop/mixin/check_assignment.rb

@@ -11,13 +11,13 @@ module RuboCop
       end
 
       def on_send(node)
-        # we only want to indent relative to the receiver
-        # when the method called looks like a setter
-        return unless node.asgn_method_call?
+        return unless node.setter_method?
 
-        # This will match if, case, begin, blocks, etc.
         rhs = extract_rhs(node)
-        check_assignment(node, rhs) if rhs.is_a?(AST::Node)
+
+        return unless rhs
+
+        check_assignment(node, rhs)
       end
 
       module_function
@@ -30,7 +30,7 @@ module RuboCop
         elsif Util::ASGN_NODES.include?(node.type)
           _lhs, rhs = *node
         elsif node.send_type?
-          rhs = node.children.last
+          rhs = node.last_argument
         end
 
         rhs

data/lib/rubocop/cop/mixin/duplication.rb

@@ -37,7 +37,7 @@ module RuboCop
       # element and all duplicate instances.
       #
       # @param [Array] collection an array to group duplicates for
-      # @return [Hash] the grouped duplicates
+      # @return [Array] the grouped duplicates
       def grouped_duplicates(collection)
         collection.group_by { |item| item }.values.reject(&:one?)
       end

data/lib/rubocop/cop/mixin/frozen_string_literal.rb

@@ -8,7 +8,7 @@ module RuboCop
 
       FROZEN_STRING_LITERAL = '# frozen_string_literal:'.freeze
       FROZEN_STRING_LITERAL_ENABLED = '# frozen_string_literal: true'.freeze
-      FROZEN_STRING_LITERAL_TYPES = [:str, :dstr].freeze
+      FROZEN_STRING_LITERAL_TYPES = %i(str dstr).freeze
 
       def frozen_string_literal_comment_exists?
         leading_comment_lines.any? do |line|

data/lib/rubocop/cop/mixin/ignored_pattern.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    # This module encapsulates the ability to ignore certain lines when
+    # parsing.
+    module IgnoredPattern
+      def ignored_line?(line)
+        line = if line.respond_to?(:source_line)
+                 line.source_line
+               elsif line.respond_to?(:node)
+                 line.node.source_range.source_line
+               end
+
+        matches_ignored_pattern?(line)
+      end
+
+      def matches_ignored_pattern?(line)
+        ignored_patterns.any? { |pattern| Regexp.new(pattern).match(line) }
+      end
+
+      def ignored_patterns
+        cop_config['IgnoredPatterns'] || []
+      end
+    end
+  end
+end

data/lib/rubocop/cop/mixin/method_preference.rb

@@ -4,6 +4,8 @@ module RuboCop
   module Cop
     # Common code for cops that deal with preferred methods.
     module MethodPreference
+      private
+
       def preferred_method(method)
         preferred_methods[method.to_sym]
       end

data/lib/rubocop/cop/mixin/multiline_expression_indentation.rb

@@ -6,13 +6,10 @@ module RuboCop
     # operations.
     module MultilineExpressionIndentation
       def on_send(node)
+        return if !node.receiver || node.method?(:[])
         return unless relevant_node?(node)
 
-        receiver, method_name, *_args = *node
-        return unless receiver
-        return if method_name == :[] # Don't check parameters inside [].
-
-        lhs = left_hand_side(receiver)
+        lhs = left_hand_side(node.receiver)
         rhs = right_hand_side(node)
         range = offending_range(node, lhs, rhs, style)
         check(range, node, lhs, rhs)
@@ -29,9 +26,8 @@ module RuboCop
       end
 
       def right_hand_side(send_node)
-        _, method_name, *args = *send_node
-        if operator?(method_name) && args.any?
-          args.first.source_range # not used for method calls
+        if send_node.operator_method? && send_node.arguments?
+          send_node.first_argument.source_range # not used for method calls
         else
           regular_method_right_hand_side(send_node)
         end
@@ -40,12 +36,11 @@ module RuboCop
       def regular_method_right_hand_side(send_node)
         dot = send_node.loc.dot
         selector = send_node.loc.selector
-        if dot && selector && dot.line == selector.line
+        if send_node.dot? && selector && dot.line == selector.line
           dot.join(selector)
         elsif selector
           selector
-        elsif dot.line == send_node.loc.begin.line
-          # lambda.(args)
+        elsif send_node.implicit_call?
           dot.join(send_node.loc.begin)
         end
       end
@@ -116,9 +111,9 @@ module RuboCop
           # is an argument in a method call. It doesn't count.
           break false if a.block_type?
 
-          _, method_name, *args = *a
-          next if assignment_call?(method_name)
-          args.any? { |arg| within_node?(node, arg) }
+          next if a.setter_method?
+
+          a.arguments.any? { |arg| within_node?(node, arg) }
         end
       end
 
@@ -139,20 +134,14 @@ module RuboCop
 
       # The []= operator and setters (a.b = c) are parsed as :send nodes.
       def valid_method_rhs_candidate?(candidate, node)
-        _receiver, method_name, *args = *node
-
-        assignment_call?(method_name) &&
-          valid_rhs_candidate?(candidate, args.last)
+        node.setter_method? &&
+          valid_rhs_candidate?(candidate, node.last_argument)
       end
 
       def valid_rhs_candidate?(candidate, node)
         !candidate || within_node?(candidate, node)
       end
 
-      def assignment_call?(method_name)
-        method_name == :[]= || method_name.to_s =~ /^\w.*=$/
-      end
-
       def part_of_block_body?(candidate, node)
         _method, _args, body = *node
         body && within_node?(candidate, body)
@@ -162,14 +151,14 @@ module RuboCop
         case node.type
         when :casgn   then _scope, _lhs, rhs = *node
         when :op_asgn then _lhs, _op, rhs = *node
-        when :send    then _receiver, _method_name, *_args, rhs = *node
+        when :send    then rhs = node.last_argument
         else               _lhs, rhs = *node
         end
         rhs
       end
 
       def not_for_this_cop?(node)
-        node.each_ancestor.any? do |ancestor|
+        node.ancestors.any? do |ancestor|
           grouped_expression?(ancestor) ||
             inside_arg_list_parentheses?(node, ancestor)
         end
@@ -180,11 +169,10 @@ module RuboCop
       end
 
       def inside_arg_list_parentheses?(node, ancestor)
-        a = ancestor.loc
-        return false unless ancestor.send_type? && a.begin &&
-                            a.begin.is?('(')
-        n = node.source_range
-        n.begin_pos > a.begin.begin_pos && n.end_pos < a.end.end_pos
+        return false unless ancestor.send_type? && ancestor.parenthesized?
+
+        node.source_range.begin_pos > ancestor.loc.begin.begin_pos &&
+          node.source_range.end_pos < ancestor.loc.end.end_pos
       end
     end
   end