rubocop 0.52.0 → 0.52.1

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

@@ -60,7 +60,7 @@ module RuboCop
 
         def offensive?(line)
           line = line.lstrip
-          line.start_with?(*KEYWORDS) &&
+          KEYWORDS.any? { |word| line =~ /^#{word}\s/ } &&
             ALLOWED_COMMENTS.none? { |c| line =~ /#\s*#{c}/ }
         end
 

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

@@ -137,7 +137,7 @@ module RuboCop
           add_offense(
             node,
             location: line_node.loc.expression,
-            message: message_incorrect_line(line_node, sign, line_diff)
+            message: message_incorrect_line(line_node, sign, line_diff.abs)
           )
         end
       end

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

@@ -5,6 +5,13 @@ module RuboCop
     module Style
       # Use a consistent style for named format string tokens.
       #
+      # **Note:**
+      # `unannotated` style cop only works for strings
+      # which are passed as arguments to those methods:
+      # `sprintf`, `format`, `%`.
+      # The reason is that *unannotated* format is very similar
+      # to encoded URLs or Date/Time formatting strings.
+      #
       # @example EnforcedStyle: annotated (default)
       #
       #   # bad
@@ -35,6 +42,7 @@ module RuboCop
         include ConfigurableEnforcedStyle
 
         FIELD_CHARACTERS = Regexp.union(%w[A B E G X a b c d e f g i o p s u x])
+        FORMAT_STRING_METHODS = %i[sprintf format %].freeze
 
         STYLE_PATTERNS = {
           annotated: /(?<token>%<[^>]+>#{FIELD_CHARACTERS})/,
@@ -42,13 +50,12 @@ module RuboCop
           unannotated: /(?<token>%#{FIELD_CHARACTERS})/
         }.freeze
 
-        TOKEN_PATTERN = Regexp.union(STYLE_PATTERNS.values)
-
         def on_str(node)
-          return if node.each_ancestor(:xstr).any?
+          return if node.each_ancestor(:xstr, :regexp).any?
 
           tokens(node) do |detected_style, token_range|
-            if detected_style == style
+            if detected_style == style ||
+               unannotated_format?(node, detected_style)
               correct_style_detected
             else
               style_detected(detected_style)
@@ -60,6 +67,19 @@ 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)
+          end
+        end
+
+        def unannotated_format?(node, detected_style)
+          detected_style == :unannotated && !includes_format_methods?(node)
+        end
+
         def message(detected_style)
           "Prefer #{message_text(style)} over #{message_text(detected_style)}."
         end

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

@@ -8,6 +8,52 @@ module RuboCop
       # enable frozen string literals. Frozen string literals may be default
       # in Ruby 3.0. The comment will be added below a shebang and encoding
       # comment. The frozen string literal comment is only valid in Ruby 2.3+.
+      #
+      # @example EnforcedStyle: when_needed (default)
+      #   # The `when_needed` style will add the frozen string literal comment
+      #   # to files only when the `TargetRubyVersion` is set to 2.3+.
+      #   # bad
+      #   module Foo
+      #     # ...
+      #   end
+      #
+      #   # good
+      #   # frozen_string_literal: true
+      #
+      #   module Foo
+      #     # ...
+      #   end
+      #
+      # @example EnforcedStyle: always
+      #   # The `always` style will always add the frozen string literal comment
+      #   # to a file, regardless of the Ruby version or if `freeze` or `<<` are
+      #   # called on a string literal.
+      #   # bad
+      #   module Bar
+      #     # ...
+      #   end
+      #
+      #   # good
+      #   # frozen_string_literal: true
+      #
+      #   module Bar
+      #     # ...
+      #   end
+      #
+      # @example EnforcedStyle: never
+      #   # The `never` will enforce that the frozen string literal comment does
+      #   # not exist in a file.
+      #   # bad
+      #   # frozen_string_literal: true
+      #
+      #   module Baz
+      #     # ...
+      #   end
+      #
+      #   # good
+      #   module Baz
+      #     # ...
+      #   end
       class FrozenStringLiteralComment < Cop
         include ConfigurableEnforcedStyle
         include FrozenStringLiteral

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

@@ -173,11 +173,12 @@ module RuboCop
           range = range_between(key.source_range.begin_pos, op.end_pos)
           range = range_with_surrounding_space(range: range, side: :right)
 
-          new_key = key.sym_type? ? key.value : key.source
-
           space = argument_without_space?(pair_node.parent) ? ' ' : ''
 
-          corrector.replace(range, "#{space}#{new_key}: ")
+          corrector.replace(
+            range,
+            range.source.sub(/^:(.*\S)\s*=>\s*$/, space.to_s + '\1: ')
+          )
         end
 
         def argument_without_space?(node)

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

@@ -6,6 +6,20 @@ module RuboCop
       # Checks for if and unless statements that would fit on one line
       # if written as a modifier if/unless. The maximum line length is
       # configured in the `Metrics/LineLength` cop.
+      #
+      # @example
+      #   # bad
+      #   if condition
+      #     do_stuff(bar)
+      #   end
+      #
+      #   unless qux.empty?
+      #     Foo.do_something
+      #   end
+      #
+      #   # good
+      #   do_stuff(bar) if condition
+      #   Foo.do_something unless qux.empty?
       class IfUnlessModifier < Cop
         include StatementModifier
 

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

@@ -5,6 +5,85 @@ module RuboCop
     module Style
       # This cops checks for parentheses around the arguments in method
       # definitions. Both instance and class/singleton methods are checked.
+      #
+      # @example EnforcedStyle: require_parentheses (default)
+      #   # The `require_parentheses` style requires method definitions
+      #   # to always use parentheses
+      #
+      #   # bad
+      #   def bar num1, num2
+      #     num1 + num2
+      #   end
+      #
+      #   def foo descriptive_var_name,
+      #           another_descriptive_var_name,
+      #           last_descriptive_var_name
+      #     do_something
+      #   end
+      #
+      #   # good
+      #   def bar(num1, num2)
+      #     num1 + num2
+      #   end
+      #
+      #   def foo(descriptive_var_name,
+      #           another_descriptive_var_name,
+      #           last_descriptive_var_name)
+      #     do_something
+      #   end
+      #
+      # @example EnforcedStyle: require_no_parentheses
+      #   # The `require_no_parentheses` style requires method definitions
+      #   # to never use parentheses
+      #
+      #   # bad
+      #   def bar(num1, num2)
+      #     num1 + num2
+      #   end
+      #
+      #   def foo(descriptive_var_name,
+      #           another_descriptive_var_name,
+      #           last_descriptive_var_name)
+      #     do_something
+      #   end
+      #
+      #   # good
+      #   def bar num1, num2
+      #     num1 + num2
+      #   end
+      #
+      #   def foo descriptive_var_name,
+      #           another_descriptive_var_name,
+      #           last_descriptive_var_name
+      #     do_something
+      #   end
+      #
+      # @example EnforcedStyle: require_no_parentheses_except_multiline
+      #   # The `require_no_parentheses_except_multiline` style prefers no
+      #   # parantheses when method definition arguments fit on single line,
+      #   # but prefers parantheses when arguments span multiple lines.
+      #
+      #   # bad
+      #   def bar(num1, num2)
+      #     num1 + num2
+      #   end
+      #
+      #   def foo descriptive_var_name,
+      #           another_descriptive_var_name,
+      #           last_descriptive_var_name
+      #     do_something
+      #   end
+      #
+      #   # good
+      #   def bar num1, num2
+      #     num1 + num2
+      #   end
+      #
+      #   def foo(descriptive_var_name,
+      #           another_descriptive_var_name,
+      #           last_descriptive_var_name)
+      #     do_something
+      #   end
       class MethodDefParentheses < Cop
         include ConfigurableEnforcedStyle
 

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

@@ -53,8 +53,9 @@ module RuboCop
 
         def on_send(node)
           include_statement(node) do |statement|
-            return if node.argument?
-            return if accepted_include?(node)
+            return if node.argument? ||
+                      accepted_include?(node) ||
+                      belongs_to_class_or_module?(node)
 
             add_offense(node, message: format(MSG, statement: statement))
           end
@@ -65,6 +66,16 @@ module RuboCop
         def accepted_include?(node)
           node.parent && node.macro?
         end
+
+        def belongs_to_class_or_module?(node)
+          if !node.parent
+            false
+          else
+            return true if node.parent.class_type? || node.parent.module_type?
+
+            belongs_to_class_or_module?(node.parent)
+          end
+        end
       end
     end
   end

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

@@ -16,7 +16,7 @@ module RuboCop
       #   { result: 'ok' } if cond
       class MultilineIfModifier < Cop
         include StatementModifier
-        include AutocorrectAlignment
+        include Alignment
 
         MSG = 'Favor a normal %<keyword>s-statement over a modifier' \
               ' clause in a multiline statement.'.freeze

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

@@ -4,6 +4,25 @@ module RuboCop
   module Cop
     module Style
       # This cop checks for multi-line ternary op expressions.
+      #
+      # @example
+      #   # bad
+      #   a = cond ?
+      #     b : c
+      #   a = cond ? b :
+      #       c
+      #   a = cond ?
+      #       b :
+      #       c
+      #
+      #   # good
+      #   a = cond ? b : c
+      #   a =
+      #     if cond
+      #       b
+      #     else
+      #       c
+      #     end
       class MultilineTernaryOperator < Cop
         MSG = 'Avoid multi-line ternary operators, ' \
               'use `if` or `unless` instead.'.freeze

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

@@ -80,7 +80,7 @@ module RuboCop
         end
 
         def autocorrect(node)
-          negative_conditional_corrector(node)
+          ConditionCorrector.correct_negative_condition(node)
         end
 
         private

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

@@ -15,12 +15,14 @@ module RuboCop
           check_negative_conditional(node)
         end
 
-        def message(node)
-          format(MSG, inverse: node.inverse_keyword, current: node.keyword)
+        def autocorrect(node)
+          ConditionCorrector.correct_negative_condition(node)
         end
 
-        def autocorrect(node)
-          negative_conditional_corrector(node)
+        private
+
+        def message(node)
+          format(MSG, inverse: node.inverse_keyword, current: node.keyword)
         end
       end
     end

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

@@ -174,7 +174,7 @@ module RuboCop
 
         # An internal class for correcting parallel assignment
         class GenericCorrector
-          include AutocorrectAlignment
+          include Alignment
 
           attr_reader :config, :node
 

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

@@ -37,6 +37,10 @@ module RuboCop
         end
         alias on_until on_while
 
+        def autocorrect(node)
+          ParenthesesCorrector.correct(node)
+        end
+
         private
 
         def_node_matcher :control_op_condition, <<-PATTERN

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

@@ -25,7 +25,7 @@ module RuboCop
       #   # good
       #   x != y
       class RedundantConditional < Cop
-        include AutocorrectAlignment
+        include Alignment
 
         COMPARISON_OPERATORS = RuboCop::AST::Node::COMPARISON_OPERATORS
 

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

@@ -31,6 +31,10 @@ module RuboCop
           check(node)
         end
 
+        def autocorrect(node)
+          ParenthesesCorrector.correct(node)
+        end
+
         private
 
         def parens_allowed?(node)

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

@@ -16,7 +16,7 @@ module RuboCop
       #     handle_error
       #   end
       class RescueModifier < Cop
-        include AutocorrectAlignment
+        include Alignment
         include RescueNode
 
         MSG = 'Avoid using `rescue` in its modifier form.'.freeze

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

@@ -18,7 +18,7 @@ module RuboCop
       #   def @table.columns; end
       #
       class SingleLineMethods < Cop
-        include AutocorrectAlignment
+        include Alignment
 
         MSG = 'Avoid single-line method definitions.'.freeze
 

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

@@ -54,6 +54,10 @@ module RuboCop
           ignore_node(node)
         end
 
+        def autocorrect(node)
+          StringLiteralCorrector.correct(node, style)
+        end
+
         private
 
         def all_string_literals?(nodes)

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

@@ -23,6 +23,10 @@ module RuboCop
         include ConfigurableEnforcedStyle
         include StringLiteralsHelp
 
+        def autocorrect(node)
+          StringLiteralCorrector.correct(node, style)
+        end
+
         private
 
         def message(*)

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

@@ -25,7 +25,7 @@ module RuboCop
       #   end
       #
       class TrailingBodyOnMethodDefinition < Cop
-        include AutocorrectAlignment
+        include Alignment
 
         MSG = "Place the first line of a multi-line method definition's " \
               'body on its own line.'.freeze