rubocop 0.52.1 → 0.53.0

data/lib/rubocop/cop/style/for.rb

@@ -7,8 +7,41 @@ module RuboCop
       # preferred alternative is set in the EnforcedStyle configuration
       # parameter. An *each* call with a block on a single line is always
       # allowed, however.
+      #
+      # @example EnforcedStyle: each (default)
+      #   # bad
+      #   def foo
+      #     for n in [1, 2, 3] do
+      #       puts n
+      #     end
+      #   end
+      #
+      #   # good
+      #   def foo
+      #     [1, 2, 3].each do |n|
+      #       puts n
+      #     end
+      #   end
+      #
+      # @example EnforcedStyle: for
+      #   # bad
+      #   def foo
+      #     [1, 2, 3].each do |n|
+      #       puts n
+      #     end
+      #   end
+      #
+      #   # good
+      #   def foo
+      #     for n in [1, 2, 3] do
+      #       puts n
+      #     end
+      #   end
+      #
       class For < Cop
         include ConfigurableEnforcedStyle
+        include RangeHelp
+
         EACH_LENGTH = 'each'.length
 
         def on_for(node)

data/lib/rubocop/cop/style/format_string.rb

@@ -11,7 +11,7 @@ module RuboCop
       # if the first argument is a string literal and if the second
       # argument is an array literal.
       #
-      # @example EnforcedStyle: format(default)
+      # @example EnforcedStyle: format (default)
       #   # bad
       #   puts sprintf('%10s', 'hoge')
       #   puts '%10s' % 'hoge'

data/lib/rubocop/cop/style/format_string_token.rb

@@ -68,11 +68,8 @@ module RuboCop
         private
 
         def includes_format_methods?(node)
-          root_node = node.ancestors.last
-          return unless root_node
-
-          root_node.descendants.any? do |desc_node|
-            FORMAT_STRING_METHODS.include?(desc_node.method_name)
+          node.each_ancestor.any? do |ancestor|
+            FORMAT_STRING_METHODS.include?(ancestor.method_name)
           end
         end
 
@@ -84,6 +81,7 @@ module RuboCop
           "Prefer #{message_text(style)} over #{message_text(detected_style)}."
         end
 
+        # rubocop:disable Style/FormatStringToken
         def message_text(style)
           case style
           when :annotated then 'annotated tokens (like `%<foo>s`)'
@@ -91,6 +89,7 @@ module RuboCop
           when :unannotated then 'unannotated tokens (like `%s`)'
           end
         end
+        # rubocop:enable Style/FormatStringToken
 
         def tokens(str_node, &block)
           return if str_node.source == '__FILE__'

data/lib/rubocop/cop/style/frozen_string_literal_comment.rb

@@ -57,6 +57,7 @@ module RuboCop
       class FrozenStringLiteralComment < Cop
         include ConfigurableEnforcedStyle
         include FrozenStringLiteral
+        include RangeHelp
 
         MSG = 'Missing magic comment `# frozen_string_literal: true`.'.freeze
         MSG_UNNECESSARY = 'Unnecessary frozen string literal comment.'.freeze
@@ -117,7 +118,7 @@ module RuboCop
         end
 
         def frozen_string_literal_comment(processed_source)
-          processed_source.tokens.find do |token|
+          processed_source.find_token do |token|
             token.text.start_with?(FrozenStringLiteral::FROZEN_STRING_LITERAL)
           end
         end

data/lib/rubocop/cop/style/hash_syntax.rb

@@ -56,6 +56,7 @@ module RuboCop
       #   {:c => 3, 'd' => 4}
       class HashSyntax < Cop
         include ConfigurableEnforcedStyle
+        include RangeHelp
 
         MSG_19 = 'Use the new Ruby 1.9 hash syntax.'.freeze
         MSG_NO_MIXED_KEYS = "Don't mix styles in the same hash.".freeze

data/lib/rubocop/cop/style/if_unless_modifier.rb

@@ -85,7 +85,7 @@ module RuboCop
 
         def first_line_comment(node)
           comment =
-            processed_source.comments.find { |c| c.loc.line == node.loc.line }
+            processed_source.find_comment { |c| c.loc.line == node.loc.line }
 
           comment ? comment.loc.expression.source : nil
         end

data/lib/rubocop/cop/style/inline_comment.rb

@@ -21,7 +21,7 @@ module RuboCop
         MSG = 'Avoid trailing inline comments.'.freeze
 
         def investigate(processed_source)
-          processed_source.comments.each do |comment|
+          processed_source.each_comment do |comment|
             next if comment_line?(processed_source[comment.loc.line - 1])
             add_offense(comment)
           end

data/lib/rubocop/cop/style/lambda.rb

@@ -173,7 +173,7 @@ module RuboCop
           end
 
           return false unless parent && parent.send_type?
-          return false if parenthesized_call?(parent)
+          return false if parent.parenthesized_call?
 
           arg_node.sibling_index > 1
         end

data/lib/rubocop/cop/style/line_end_concatenation.rb

@@ -20,6 +20,8 @@ module RuboCop
       #              'bala'
       #
       class LineEndConcatenation < Cop
+        include RangeHelp
+
         MSG = 'Use `\\` instead of `+` or `<<` to concatenate ' \
               'those strings.'.freeze
         CONCAT_TOKEN_TYPES = %i[tPLUS tLSHFT].freeze

data/lib/rubocop/cop/style/method_called_on_do_end_block.rb

@@ -13,6 +13,8 @@ module RuboCop
       #     b
       #   end.c
       class MethodCalledOnDoEndBlock < Cop
+        include RangeHelp
+
         MSG = 'Avoid chaining a method call on a do...end block.'.freeze
 
         def on_block(node)

data/lib/rubocop/cop/style/method_def_parentheses.rb

@@ -86,6 +86,7 @@ module RuboCop
       #   end
       class MethodDefParentheses < Cop
         include ConfigurableEnforcedStyle
+        include RangeHelp
 
         MSG_PRESENT = 'Use def without parentheses.'.freeze
         MSG_MISSING = 'Use def with parentheses when there are ' \

data/lib/rubocop/cop/style/missing_else.rb

@@ -4,29 +4,94 @@ module RuboCop
   module Cop
     module Style
       # Checks for `if` expressions that do not have an `else` branch.
-      # SupportedStyles
       #
-      # if
-      # @example
+      # Supported styles are: if, case, both.
+      #
+      # @example EnforcedStyle: if
+      #   # warn when an `if` expression is missing an `else` branch.
+      #
       #   # bad
       #   if condition
       #     statement
       #   end
       #
-      # case
-      # @example
+      #   # good
+      #   if condition
+      #     statement
+      #   else
+      #     # the content of `else` branch will be determined by Style/EmptyElse
+      #   end
+      #
+      #   # good
+      #   case var
+      #   when condition
+      #     statement
+      #   end
+      #
+      #   # good
+      #   case var
+      #   when condition
+      #     statement
+      #   else
+      #     # the content of `else` branch will be determined by Style/EmptyElse
+      #   end
+      #
+      # @example EnforcedStyle: case
+      #   # warn when a `case` expression is missing an `else` branch.
+      #
       #   # bad
       #   case var
       #   when condition
       #     statement
       #   end
       #
-      # @example
+      #   # good
+      #   case var
+      #   when condition
+      #     statement
+      #   else
+      #     # the content of `else` branch will be determined by Style/EmptyElse
+      #   end
+      #
       #   # good
       #   if condition
       #     statement
+      #   end
+      #
+      #   # good
+      #   if condition
+      #     statement
+      #   else
+      #     # the content of `else` branch will be determined by Style/EmptyElse
+      #   end
+      #
+      # @example EnforcedStyle: both (default)
+      #   # warn when an `if` or `case` expression is missing an `else` branch.
+      #
+      #   # bad
+      #   if condition
+      #     statement
+      #   end
+      #
+      #   # bad
+      #   case var
+      #   when condition
+      #     statement
+      #   end
+      #
+      #   # good
+      #   if condition
+      #     statement
+      #   else
+      #     # the content of `else` branch will be determined by Style/EmptyElse
+      #   end
+      #
+      #   # good
+      #   case var
+      #   when condition
+      #     statement
       #   else
-      #   # the content of the else branch will be determined by Style/EmptyElse
+      #     # the content of `else` branch will be determined by Style/EmptyElse
       #   end
       class MissingElse < Cop
         include OnNormalIfUnless

data/lib/rubocop/cop/style/mixin_usage.rb

@@ -3,11 +3,9 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks that `include`, `extend` and `prepend` exists at
-      # the top level.
-      # Using these at the top level affects the behavior of `Object`.
-      # There will not be using `include`, `extend` and `prepend` at
-      # the top level. Let's use it inside `class` or `module`.
+      # This cop checks that `include`, `extend` and `prepend` statements appear
+      # inside classes and modules, not at the top level, so as to not affect
+      # the behavior of `Object`.
       #
       # @example
       #   # bad

data/lib/rubocop/cop/style/module_function.rb

@@ -56,6 +56,16 @@ module RuboCop
           end
         end
 
+        def autocorrect(node)
+          lambda do |corrector|
+            if extend_self_node?(node)
+              corrector.replace(node.source_range, 'module_function')
+            else
+              corrector.replace(node.source_range, 'extend self')
+            end
+          end
+        end
+
         private
 
         def each_wrong_style(nodes)

data/lib/rubocop/cop/style/multiline_block_chain.rb

@@ -14,6 +14,8 @@ module RuboCop
       #     t.object_id
       #   end
       class MultilineBlockChain < Cop
+        include RangeHelp
+
         MSG = 'Avoid multi-line chains of blocks.'.freeze
 
         def on_block(node)

data/lib/rubocop/cop/style/multiline_if_then.rb

@@ -18,6 +18,7 @@ module RuboCop
       #   end
       class MultilineIfThen < Cop
         include OnNormalIfUnless
+        include RangeHelp
 
         NON_MODIFIER_THEN = /then\s*(#.*)?$/
 

data/lib/rubocop/cop/style/nested_modifier.rb

@@ -14,6 +14,8 @@ module RuboCop
       #   # good
       #   something if b && a
       class NestedModifier < Cop
+        include RangeHelp
+
         MSG = 'Avoid using nested modifiers.'.freeze
 
         def on_while(node)

data/lib/rubocop/cop/style/nested_parenthesized_calls.rb

@@ -13,6 +13,8 @@ module RuboCop
       #   # bad
       #   method1(method2 arg, method3, arg)
       class NestedParenthesizedCalls < Cop
+        include RangeHelp
+
         MSG = 'Add parentheses to nested method call `%<source>s`.'.freeze
 
         def on_send(node)

data/lib/rubocop/cop/style/next.rb

@@ -49,6 +49,7 @@ module RuboCop
       class Next < Cop
         include ConfigurableEnforcedStyle
         include MinBodyLength
+        include RangeHelp
 
         MSG = 'Use `next` to skip iteration.'.freeze
         EXIT_TYPES = %i[break return].freeze

data/lib/rubocop/cop/style/not.rb

@@ -14,6 +14,8 @@ module RuboCop
       #   x = !something
       #
       class Not < Cop
+        include RangeHelp
+
         MSG = 'Use `!` instead of `not`.'.freeze
 
         OPPOSITE_METHODS = {

data/lib/rubocop/cop/style/numeric_literals.rb

@@ -76,7 +76,7 @@ module RuboCop
 
         def format_number(node)
           int_part, float_part = node.source.split('.')
-          int_part = int_part.to_i
+          int_part = Integer(int_part)
           formatted_int = int_part
                           .abs
                           .to_s

data/lib/rubocop/cop/style/one_line_conditional.rb

@@ -63,7 +63,7 @@ module RuboCop
 
         def method_call_with_changed_precedence?(node)
           return false unless node.send_type? && node.arguments?
-          return false if parenthesized_call?(node)
+          return false if node.parenthesized_call?
 
           !operator?(node.method_name)
         end
@@ -72,7 +72,7 @@ module RuboCop
           return false unless node.keyword?
           return true if node.keyword_not?
 
-          !parenthesized_call?(node)
+          !node.parenthesized_call?
         end
       end
     end

data/lib/rubocop/cop/style/redundant_exception.rb

@@ -28,11 +28,16 @@ module RuboCop
 
         # Switch `raise RuntimeError, 'message'` to `raise 'message'`, and
         # `raise RuntimeError.new('message')` to `raise 'message'`.
-        def autocorrect(node)
+        def autocorrect(node) # rubocop:disable Metrics/MethodLength
           exploded?(node) do |command, message|
             return lambda do |corrector|
-              corrector.replace(node.source_range,
-                                "#{command} #{message.source}")
+              if node.parenthesized?
+                corrector.replace(node.source_range,
+                                  "#{command}(#{message.source})")
+              else
+                corrector.replace(node.source_range,
+                                  "#{command} #{message.source}")
+              end
             end
           end
           compact?(node) do |new_call, message|

data/lib/rubocop/cop/style/redundant_return.rb

@@ -6,11 +6,15 @@ module RuboCop
       # This cop checks for redundant `return` expressions.
       #
       # @example
+      #   # These bad cases should be extended to handle methods whose body is
+      #   # if/else or a case expression with a default branch.
       #
+      #   # bad
       #   def test
       #     return something
       #   end
       #
+      #   # bad
       #   def test
       #     one
       #     two
@@ -18,9 +22,22 @@ module RuboCop
       #     return something
       #   end
       #
-      # It should be extended to handle methods whose body is if/else
-      # or a case expression with a default branch.
+      #   # good
+      #   def test
+      #     return something if something_else
+      #   end
+      #
+      #   # good
+      #   def test
+      #     if x
+      #     elsif y
+      #     else
+      #     end
+      #   end
+      #
       class RedundantReturn < Cop
+        include RangeHelp
+
         MSG = 'Redundant `return` detected.'.freeze
         MULTI_RETURN_MSG = 'To return multiple values, use an array.'.freeze
 
@@ -71,14 +88,20 @@ module RuboCop
           !args.first.begin_type? || !args.first.children.empty?
         end
 
+        # rubocop:disable Metrics/CyclomaticComplexity
         def check_branch(node)
           case node.type
           when :return then check_return_node(node)
           when :case   then check_case_node(node)
           when :if     then check_if_node(node)
-          when :begin  then check_begin_node(node)
+          when :rescue, :resbody
+            check_rescue_node(node)
+          when :ensure then check_ensure_node(node)
+          when :begin, :kwbegin
+            check_begin_node(node)
           end
         end
+        # rubocop:enable Metrics/CyclomaticComplexity
 
         def check_return_node(node)
           return if cop_config['AllowMultipleReturnValues'] &&
@@ -108,6 +131,17 @@ module RuboCop
           check_branch(else_node) if else_node
         end
 
+        def check_rescue_node(node)
+          node.child_nodes.each do |child_node|
+            check_branch(child_node)
+          end
+        end
+
+        def check_ensure_node(node)
+          rescue_node = node.node_parts[0]
+          check_branch(rescue_node)
+        end
+
         def check_begin_node(node)
           expressions = *node
           last_expr = expressions.last