rubocop 0.49.1 → 0.52.0

data/lib/rubocop/cop/performance/double_start_end_with.rb

@@ -8,19 +8,14 @@ module RuboCop
       # with an single `#start_with?`/`#end_with?` call.
       #
       # @example
-      #
-      #   @bad
+      #   # bad
       #   str.start_with?("a") || str.start_with?(Some::CONST)
       #   str.start_with?("a", "b") || str.start_with?("c")
-      #   var1 = ...
-      #   var2 = ...
       #   str.end_with?(var1) || str.end_with?(var2)
       #
-      #   @good
+      #   # good
       #   str.start_with?("a", Some::CONST)
       #   str.start_with?("a", "b", "c")
-      #   var1 = ...
-      #   var2 = ...
       #   str.end_with?(var1, var2)
       class DoubleStartEndWith < Cop
         MSG = 'Use `%<receiver>s.%<method>s(%<combined_args>s)` ' \
@@ -68,34 +63,31 @@ module RuboCop
         end
 
         def add_offense_for_double_call(node, receiver, method, combined_args)
-          add_offense(node,
-                      :expression,
-                      format(
-                        MSG,
-                        receiver: receiver.source,
-                        method: method,
-                        combined_args: combined_args,
-                        original_code: node.source
-                      ))
+          msg = format(MSG, receiver: receiver.source,
+                            method: method,
+                            combined_args: combined_args,
+                            original_code: node.source)
+
+          add_offense(node, message: msg)
         end
 
         def check_for_active_support_aliases?
           cop_config['IncludeActiveSupportAliases']
         end
 
-        def_node_matcher :two_start_end_with_calls, <<-END
+        def_node_matcher :two_start_end_with_calls, <<-PATTERN
           (or
             (send $_recv [{:start_with? :end_with?} $_method] $...)
             (send _recv _method $...))
-        END
+        PATTERN
 
-        def_node_matcher :check_with_active_support_aliases, <<-END
+        def_node_matcher :check_with_active_support_aliases, <<-PATTERN
           (or
             (send $_recv
                     [{:start_with? :starts_with? :end_with? :ends_with?} $_method]
                   $...)
             (send _recv _method $...))
-        END
+        PATTERN
       end
     end
   end

data/lib/rubocop/cop/performance/end_with.rb

@@ -7,21 +7,21 @@ module RuboCop
       # would suffice.
       #
       # @example
-      #   @bad
+      #   # bad
       #   'abc' =~ /bc\Z/
       #   'abc'.match(/bc\Z/)
       #
-      #   @good
+      #   # good
       #   'abc'.end_with?('bc')
       class EndWith < Cop
         MSG = 'Use `String#end_with?` instead of a regex match anchored to ' \
               'the end of the string.'.freeze
         SINGLE_QUOTE = "'".freeze
 
-        def_node_matcher :redundant_regex?, <<-END
-          {(send $!nil {:match :=~} (regexp (str $#literal_at_end?) (regopt)))
+        def_node_matcher :redundant_regex?, <<-PATTERN
+          {(send $!nil? {:match :=~} (regexp (str $#literal_at_end?) (regopt)))
            (send (regexp (str $#literal_at_end?) (regopt)) {:match :=~} $_)}
-        END
+        PATTERN
 
         def literal_at_end?(regex_str)
           # is this regexp 'literal' in the sense of only matching literal
@@ -33,7 +33,7 @@ module RuboCop
         def on_send(node)
           return unless redundant_regex?(node)
 
-          add_offense(node, :expression)
+          add_offense(node)
         end
 
         def autocorrect(node)

data/lib/rubocop/cop/performance/fixed_size.rb

@@ -17,7 +17,7 @@ module RuboCop
           counter(node) do |var, arg|
             return if allowed_variable?(var) || allowed_argument?(arg)
 
-            add_offense(node, :expression)
+            add_offense(node)
           end
         end
 

data/lib/rubocop/cop/performance/flat_map.rb

@@ -15,7 +15,7 @@ module RuboCop
       #   [1, 2, 3, 4].map { |e| [e, e] }.flatten
       #   [1, 2, 3, 4].collect { |e| [e, e] }.flatten
       class FlatMap < Cop
-        MSG = 'Use `flat_map` instead of `%s...%s`.'.freeze
+        MSG = 'Use `flat_map` instead of `%<method>s...%<flatten>s`.'.freeze
         FLATTEN_MULTIPLE_LEVELS = ' Beware, `flat_map` only flattens 1 level ' \
                                   'and `flatten` can be used to flatten ' \
                                   'multiple levels.'.freeze
@@ -65,7 +65,10 @@ module RuboCop
           range = range_between(map_node.loc.selector.begin_pos,
                                 node.loc.expression.end_pos)
 
-          add_offense(node, range, format(message, first_method, flatten))
+          add_offense(node,
+                      location: range,
+                      message: format(message, method: first_method,
+                                               flatten: flatten))
         end
       end
     end

data/lib/rubocop/cop/performance/hash_each_methods.rb

@@ -3,7 +3,11 @@
 module RuboCop
   module Cop
     module Performance
-      # This cop checks for uses of `each_key` & `each_value` Hash methods.
+      # This cop checks for uses of `each_key` and `each_value` Hash methods.
+      #
+      # Note: If you have an array of two-element arrays, you can put
+      #   parentheses around the block arguments to indicate that you're not
+      #   working with a hash, and suppress RuboCop offenses.
       #
       # @example
       #   # bad
@@ -18,65 +22,106 @@ module RuboCop
       class HashEachMethods < Cop
         include Lint::UnusedArgument
 
-        MSG = 'Use `%s` instead of `%s`.'.freeze
+        MSG = 'Use `%<prefer>s` instead of `%<current>s`.'.freeze
 
-        def_node_matcher :plain_each, <<-END
-          (block $(send (send _ :hash) :each) (args (arg $_k) (arg $_v)) ...)
-        END
+        def_node_matcher :plain_each, <<-PATTERN
+          (block $(send !(send _ :to_a) :each) (args $(arg _k) $(arg _v)) ...)
+        PATTERN
 
-        def_node_matcher :kv_each, <<-END
-          (block $(send (send (send _ :hash) ${:keys :values}) :each) ...)
-        END
+        def_node_matcher :kv_each, <<-PATTERN
+          (block $(send (send _ ${:keys :values}) :each) ...)
+        PATTERN
 
         def on_block(node)
+          register_each_offense(node)
+          register_kv_offense(node)
+        end
+
+        def autocorrect(node)
+          receiver = node.receiver
+          _caller, first_method = *receiver
+
+          lambda do |corrector|
+            case first_method
+            when :keys, :values
+              correct_key_value_each(node, corrector)
+            else
+              correct_plain_each(node, corrector)
+            end
+          end
+        end
+
+        private
+
+        def register_each_offense(node)
           plain_each(node) do |target, k, v|
-            return if @args[k] && @args[v]
-            used = @args[k] ? :key : :value
-            add_offense(target, range(target), format(message,
-                                                      "each_#{used}",
-                                                      :each))
+            return if used?(k) && used?(v)
+            used = used?(k) ? :key : :value
+
+            add_offense(
+              target,
+              location: plain_range(target),
+              message: format(message, prefer: "each_#{used}", current: :each)
+            )
           end
+        end
+
+        def register_kv_offense(node)
           kv_each(node) do |target, method|
-            add_offense(target, range(target), format(message,
-                                                      "each_#{method[0..-2]}",
-                                                      "#{method}.each"))
+            msg = format(message, prefer: "each_#{method[0..-2]}",
+                                  current: "#{method}.each")
+
+            add_offense(target, location: kv_range(target), message: msg)
           end
         end
 
         def check_argument(variable)
           return unless variable.block_argument?
-          (@args ||= {})[variable.name] = variable.used?
+          (@block_args ||= []).push(variable)
         end
 
-        def autocorrect(node)
-          receiver, _second_method = *node
-          caller, first_method = *receiver
-          lambda do |corrector|
-            if first_method == :hash
-              method = @args.values.first ? :key : :value
-              new_source = receiver.source + ".each_#{method}"
-              corrector.replace(node.loc.expression, new_source)
-              correct_args(node, corrector)
-            else
-              new_source = caller.source + ".each_#{first_method[0..-2]}"
-              corrector.replace(node.loc.expression, new_source)
-            end
-          end
+        def used?(arg)
+          loc = arg.loc
+          variable = @block_args.find { |var| var.declaration_node.loc == loc }
+          variable.used?
         end
 
-        private
+        def correct_implicit(node, corrector, method_name)
+          corrector.replace(node.loc.expression, method_name)
+          correct_args(node, corrector)
+        end
+
+        def correct_key_value_each(node, corrector)
+          receiver = node.receiver.receiver
+          name = "each_#{node.receiver.method_name.to_s.chop}"
+          return correct_implicit(node, corrector, name) unless receiver
+
+          new_source = receiver.source + ".#{name}"
+          corrector.replace(node.loc.expression, new_source)
+        end
+
+        def correct_plain_each(node, corrector)
+          _each, key, _value = plain_each(node.parent)
+          name = used?(key) ? 'each_key' : 'each_value'
+          return correct_implicit(node, corrector, name) unless node.receiver
+
+          corrector.replace(node.loc.selector, name)
+          correct_args(node, corrector)
+        end
 
         def correct_args(node, corrector)
-          args = node.parent.children[1]
-          used_arg = "|#{@args.detect { |_k, v| v }.first}|"
-          args_range = range_between(args.loc.begin.begin_pos,
-                                     args.loc.end.end_pos)
-          corrector.replace(args_range, used_arg)
+          args = node.parent.arguments
+          name, = *args.children.find { |arg| used?(arg) }
+
+          corrector.replace(args.source_range, "|#{name}|")
+        end
+
+        def plain_range(outer_node)
+          outer_node.loc.selector
         end
 
-        def range(outer_node)
-          inner_node = outer_node.children.first
-          inner_node.loc.selector.join(outer_node.loc.selector)
+        def kv_range(outer_node)
+          outer_node.receiver.loc.selector.join(outer_node.loc.selector)
         end
       end
     end

data/lib/rubocop/cop/performance/lstrip_rstrip.rb

@@ -7,25 +7,28 @@ module RuboCop
       # `strip`.
       #
       # @example
-      #   @bad
+      #   # bad
       #   'abc'.lstrip.rstrip
       #   'abc'.rstrip.lstrip
       #
-      #   @good
+      #   # good
       #   'abc'.strip
       class LstripRstrip < Cop
-        MSG = 'Use `strip` instead of `%s.%s`.'.freeze
+        MSG = 'Use `strip` instead of `%<methods>s`.'.freeze
 
-        def_node_matcher :lstrip_rstrip, <<-END
+        def_node_matcher :lstrip_rstrip, <<-PATTERN
           {(send $(send _ $:rstrip) $:lstrip)
            (send $(send _ $:lstrip) $:rstrip)}
-        END
+        PATTERN
 
         def on_send(node)
           lstrip_rstrip(node) do |first_send, method_one, method_two|
             range = range_between(first_send.loc.selector.begin_pos,
                                   node.source_range.end_pos)
-            add_offense(node, range, format(MSG, method_one, method_two))
+            add_offense(node,
+                        location: range,
+                        message: format(MSG,
+                                        methods: "#{method_one}.#{method_two}"))
           end
         end
 

data/lib/rubocop/cop/performance/range_include.rb

@@ -22,14 +22,14 @@ module RuboCop
         # Right now, we only detect direct calls on a Range literal
         # (We don't even catch it if the Range is in double parens)
 
-        def_node_matcher :range_include, <<-END
+        def_node_matcher :range_include, <<-PATTERN
           (send {irange erange (begin {irange erange})} :include? ...)
-        END
+        PATTERN
 
         def on_send(node)
           return unless range_include(node)
 
-          add_offense(node, :selector)
+          add_offense(node, location: :selector)
         end
 
         def autocorrect(node)

data/lib/rubocop/cop/performance/redundant_block_call.rb

@@ -7,7 +7,7 @@ module RuboCop
       # where `yield` would do just as well.
       #
       # @example
-      #   @bad
+      #   # bad
       #   def method(&block)
       #     block.call
       #   end
@@ -15,7 +15,7 @@ module RuboCop
       #     func.call 1, 2, 3
       #   end
       #
-      #   @good
+      #   # good
       #   def method
       #     yield
       #   end
@@ -23,53 +23,35 @@ module RuboCop
       #     yield 1, 2, 3
       #   end
       class RedundantBlockCall < Cop
-        MSG = 'Use `yield` instead of `%s.call`.'.freeze
+        MSG = 'Use `yield` instead of `%<argname>s.call`.'.freeze
         YIELD = 'yield'.freeze
         OPEN_PAREN = '('.freeze
         CLOSE_PAREN = ')'.freeze
         SPACE = ' '.freeze
 
-        def_node_matcher :blockarg_def, <<-END
+        def_node_matcher :blockarg_def, <<-PATTERN
           {(def  _   (args ... (blockarg $_)) $_)
            (defs _ _ (args ... (blockarg $_)) $_)}
-        END
+        PATTERN
 
-        def_node_search :blockarg_calls, <<-END
+        def_node_search :blockarg_calls, <<-PATTERN
           (send (lvar %1) :call ...)
-        END
+        PATTERN
 
-        def_node_search :blockarg_assigned?, <<-END
+        def_node_search :blockarg_assigned?, <<-PATTERN
           (lvasgn %1 ...)
-        END
+        PATTERN
 
         def on_def(node)
           blockarg_def(node) do |argname, body|
             next unless body
 
             calls_to_report(argname, body).each do |blockcall|
-              add_offense(blockcall, :expression, format(MSG, argname))
+              add_offense(blockcall, message: format(MSG, argname: argname))
             end
           end
         end
 
-        private
-
-        def calls_to_report(argname, body)
-          return [] if blockarg_assigned?(body, argname)
-
-          calls = to_enum(:blockarg_calls, body, argname)
-
-          return [] if calls.any? { |call| args_include_block_pass?(call) }
-
-          calls
-        end
-
-        def args_include_block_pass?(blockcall)
-          _receiver, _call, *args = *blockcall
-
-          args.any?(&:block_pass_type?)
-        end
-
         # offenses are registered on the `block.call` nodes
         def autocorrect(node)
           _receiver, _method, *args = *node
@@ -87,6 +69,24 @@ module RuboCop
           new_source << CLOSE_PAREN if parentheses?(node) && !args.empty?
           ->(corrector) { corrector.replace(node.source_range, new_source) }
         end
+
+        private
+
+        def calls_to_report(argname, body)
+          return [] if blockarg_assigned?(body, argname)
+
+          calls = to_enum(:blockarg_calls, body, argname)
+
+          return [] if calls.any? { |call| args_include_block_pass?(call) }
+
+          calls
+        end
+
+        def args_include_block_pass?(blockcall)
+          _receiver, _call, *args = *blockcall
+
+          args.any?(&:block_pass_type?)
+        end
       end
     end
   end