rubocop 0.51.0 → 0.52.0

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

@@ -48,24 +48,22 @@ module RuboCop
 
         def_node_matcher :include_statement, <<-PATTERN
           (send nil? ${:include :extend :prepend}
-            (const nil? _))
+            const)
         PATTERN
 
         def on_send(node)
-          return unless (statement = include_statement(node))
-          return unless top_level_node?(node)
+          include_statement(node) do |statement|
+            return if node.argument?
+            return if accepted_include?(node)
 
-          add_offense(node, message: format(MSG, statement: statement))
+            add_offense(node, message: format(MSG, statement: statement))
+          end
         end
 
         private
 
-        def top_level_node?(node)
-          if node.parent.parent.nil?
-            node.sibling_index.zero?
-          else
-            top_level_node?(node.parent)
-          end
+        def accepted_include?(node)
+          node.parent && node.macro?
         end
       end
     end

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

@@ -8,18 +8,30 @@ module RuboCop
       #
       # Supported styles are: module_function, extend_self.
       #
-      # @example
+      # @example EnforcedStyle: module_function (default)
+      #   # bad
+      #   module Test
+      #     extend self
+      #     # ...
+      #   end
+      #
+      #   # good
+      #   module Test
+      #     module_function
+      #     # ...
+      #   end
       #
-      #   # Good if EnforcedStyle is module_function
+      # @example EnforcedStyle: extend_self
+      #   # bad
       #   module Test
       #     module_function
-      #     ...
+      #     # ...
       #   end
       #
-      #   # Good if EnforcedStyle is extend_self
+      #   # good
       #   module Test
       #     extend self
-      #     ...
+      #     # ...
       #   end
       #
       # These offenses are not auto-corrected since there are different

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

@@ -18,7 +18,7 @@ module RuboCop
         include StatementModifier
         include AutocorrectAlignment
 
-        MSG = 'Favor a normal %s-statement over a modifier' \
+        MSG = 'Favor a normal %<keyword>s-statement over a modifier' \
               ' clause in a multiline statement.'.freeze
 
         def on_if(node)
@@ -27,16 +27,16 @@ module RuboCop
           add_offense(node)
         end
 
-        private
-
         def autocorrect(node)
           lambda do |corrector|
             corrector.replace(node.source_range, to_normal_if(node))
           end
         end
 
+        private
+
         def message(node)
-          format(MSG, node.keyword)
+          format(MSG, keyword: node.keyword)
         end
 
         def to_normal_if(node)

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

@@ -5,13 +5,14 @@ module RuboCop
     module Style
       # Checks for uses of the `then` keyword in multi-line if statements.
       #
-      # @example This is considered bad practice:
-      #
+      # @example
+      #   # bad
+      #   # This is considered bad practice.
       #   if cond then
       #   end
       #
-      # @example If statements can contain `then` on the same line:
-      #
+      #   # good
+      #   # If statements can contain `then` on the same line.
       #   if cond then a
       #   elsif cond then b
       #   end
@@ -20,28 +21,28 @@ module RuboCop
 
         NON_MODIFIER_THEN = /then\s*(#.*)?$/
 
-        MSG = 'Do not use `then` for multi-line `%s`.'.freeze
+        MSG = 'Do not use `then` for multi-line `%<keyword>s`.'.freeze
 
         def on_normal_if_unless(node)
           return unless non_modifier_then?(node)
 
           add_offense(node, location: :begin,
-                            message: format(MSG, node.keyword))
-        end
-
-        private
-
-        def non_modifier_then?(node)
-          node.loc.begin && node.loc.begin.source_line =~ NON_MODIFIER_THEN
+                            message: format(MSG, keyword: node.keyword))
         end
 
         def autocorrect(node)
           lambda do |corrector|
             corrector.remove(
-              range_with_surrounding_space(node.loc.begin, :left)
+              range_with_surrounding_space(range: node.loc.begin, side: :left)
             )
           end
         end
+
+        private
+
+        def non_modifier_then?(node)
+          node.loc.begin && node.loc.begin.source_line =~ NON_MODIFIER_THEN
+        end
       end
     end
   end

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

@@ -5,33 +5,27 @@ module RuboCop
     module Style
       # This cop checks expressions wrapping styles for multiline memoization.
       #
-      # @example
-      #
-      #   # EnforcedStyle: keyword (default)
-      #
-      #   @bad
+      # @example EnforcedStyle: keyword (default)
+      #   # bad
       #   foo ||= (
       #     bar
       #     baz
       #   )
       #
-      #   @good
+      #   # good
       #   foo ||= begin
       #     bar
       #     baz
       #   end
       #
-      # @example
-      #
-      #   # EnforcedStyle: braces
-      #
-      #   @bad
+      # @example EnforcedStyle: braces
+      #   # bad
       #   foo ||= begin
       #     bar
       #     baz
       #   end
       #
-      #   @good
+      #   # good
       #   foo ||= (
       #     bar
       #     baz
@@ -49,8 +43,6 @@ module RuboCop
           add_offense(rhs, location: node.source_range)
         end
 
-        private
-
         def autocorrect(node)
           lambda do |corrector|
             if style == :keyword
@@ -62,6 +54,8 @@ module RuboCop
           end
         end
 
+        private
+
         def bad_rhs?(rhs)
           return false unless rhs.multiline?
           if style == :keyword

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

@@ -30,18 +30,6 @@ module RuboCop
           on_assignment(value)
         end
 
-        private
-
-        def on_assignment(value)
-          value = splat_value(value) if splat_value(value)
-
-          return unless value && value.mutable_literal?
-          return if FROZEN_STRING_LITERAL_TYPES.include?(value.type) &&
-                    frozen_string_literals_enabled?
-
-          add_offense(value)
-        end
-
         def autocorrect(node)
           expr = node.source_range
 
@@ -55,6 +43,18 @@ module RuboCop
           end
         end
 
+        private
+
+        def on_assignment(value)
+          value = splat_value(value) if splat_value(value)
+
+          return unless value && value.mutable_literal?
+          return if FROZEN_STRING_LITERAL_TYPES.include?(value.type) &&
+                    frozen_string_literals_enabled?
+
+          add_offense(value)
+        end
+
         def_node_matcher :splat_value, <<-PATTERN
           (array (splat $_))
         PATTERN

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

@@ -10,17 +10,9 @@ module RuboCop
       #   - prefix
       #   - postfix
       #
-      # @example
-      #
-      #   # EnforcedStyle: both
+      # @example EnforcedStyle: both (default)
       #   # enforces `unless` for `prefix` and `postfix` conditionals
       #
-      #   # good
-      #
-      #   unless foo
-      #     bar
-      #   end
-      #
       #   # bad
       #
       #   if !foo
@@ -29,26 +21,30 @@ module RuboCop
       #
       #   # good
       #
-      #   bar unless foo
+      #   unless foo
+      #     bar
+      #   end
       #
       #   # bad
       #
       #   bar if !foo
       #
-      # @example
+      #   # good
       #
-      #   # EnforcedStyle: prefix
+      #   bar unless foo
+      #
+      # @example EnforcedStyle: prefix
       #   # enforces `unless` for just `prefix` conditionals
       #
-      #   # good
+      #   # bad
       #
-      #   unless foo
+      #   if !foo
       #     bar
       #   end
       #
-      #   # bad
+      #   # good
       #
-      #   if !foo
+      #   unless foo
       #     bar
       #   end
       #
@@ -56,21 +52,19 @@ module RuboCop
       #
       #   bar if !foo
       #
-      # @example
-      #
-      #   # EnforcedStyle: postfix
+      # @example EnforcedStyle: postfix
       #   # enforces `unless` for just `postfix` conditionals
       #
-      #   # good
-      #
-      #   bar unless foo
-      #
       #   # bad
       #
       #   bar if !foo
       #
       #   # good
       #
+      #   bar unless foo
+      #
+      #   # good
+      #
       #   if !foo
       #     bar
       #   end
@@ -78,8 +72,6 @@ module RuboCop
         include ConfigurableEnforcedStyle
         include NegativeConditional
 
-        MSG = 'Favor `%s` over `%s` for negative conditions.'.freeze
-
         def on_if(node)
           return if node.elsif? || node.ternary?
           return if correct_style?(node)
@@ -87,14 +79,14 @@ module RuboCop
           check_negative_conditional(node)
         end
 
+        def autocorrect(node)
+          negative_conditional_corrector(node)
+        end
+
         private
 
         def message(node)
-          format(MSG, node.inverse_keyword, node.keyword)
-        end
-
-        def autocorrect(node)
-          negative_conditional_corrector(node)
+          format(MSG, inverse: node.inverse_keyword, current: node.keyword)
         end
 
         def correct_style?(node)

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

@@ -7,8 +7,6 @@ module RuboCop
       class NegatedWhile < Cop
         include NegativeConditional
 
-        MSG = 'Favor `%s` over `%s` for negative conditions.'.freeze
-
         def on_while(node)
           check_negative_conditional(node)
         end
@@ -18,11 +16,9 @@ module RuboCop
         end
 
         def message(node)
-          format(MSG, node.inverse_keyword, node.keyword)
+          format(MSG, inverse: node.inverse_keyword, current: node.keyword)
         end
 
-        private
-
         def autocorrect(node)
           negative_conditional_corrector(node)
         end

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

@@ -7,13 +7,13 @@ module RuboCop
       # of a parenthesized method call.
       #
       # @example
-      #   @good
+      #   # good
       #   method1(method2(arg), method3(arg))
       #
-      #   @bad
+      #   # bad
       #   method1(method2 arg, method3, arg)
       class NestedParenthesizedCalls < Cop
-        MSG = 'Add parentheses to nested method call `%s`.'.freeze
+        MSG = 'Add parentheses to nested method call `%<source>s`.'.freeze
 
         def on_send(node)
           return unless node.parenthesized?
@@ -23,7 +23,21 @@ module RuboCop
 
             add_offense(nested,
                         location: nested.source_range,
-                        message: format(MSG, nested.source))
+                        message: format(MSG, source: nested.source))
+          end
+        end
+
+        def autocorrect(nested)
+          first_arg = nested.first_argument.source_range
+          last_arg = nested.last_argument.source_range
+
+          leading_space =
+            range_with_surrounding_space(range: first_arg,
+                                         side: :left).begin.resize(1)
+
+          lambda do |corrector|
+            corrector.replace(leading_space, '(')
+            corrector.insert_after(last_arg, ')')
           end
         end
 
@@ -41,19 +55,6 @@ module RuboCop
             send_node.arguments.one?
         end
 
-        def autocorrect(nested)
-          first_arg = nested.first_argument.source_range
-          last_arg = nested.last_argument.source_range
-
-          leading_space =
-            range_with_surrounding_space(first_arg, :left).begin.resize(1)
-
-          lambda do |corrector|
-            corrector.replace(leading_space, '(')
-            corrector.insert_after(last_arg, ')')
-          end
-        end
-
         def whitelisted_methods
           cop_config['Whitelist'] || []
         end

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

@@ -5,7 +5,35 @@ module RuboCop
     module Style
       # Use `next` to skip iteration instead of a condition at the end.
       #
-      # @example
+      # @example EnforcedStyle: skip_modifier_ifs (default)
+      #   # bad
+      #   [1, 2].each do |a|
+      #     if a == 1
+      #       puts a
+      #     end
+      #   end
+      #
+      #   # good
+      #   [1, 2].each do |a|
+      #     next unless a == 1
+      #     puts a
+      #   end
+      #
+      #   # good
+      #   [1, 2].each do |o|
+      #     puts o unless o == 1
+      #   end
+      #
+      # @example EnforcedStyle: always
+      #   # With `always` all conditions at the end of an iteration needs to be
+      #   # replaced by next - with `skip_modifier_ifs` the modifier if like
+      #   # this one are ignored: `[1, 2].each { |a| return 'yes' if a == 1 }`
+      #
+      #   # bad
+      #   [1, 2].each do |o|
+      #     puts o unless o == 1
+      #   end
+      #
       #   # bad
       #   [1, 2].each do |a|
       #     if a == 1
@@ -44,6 +72,16 @@ module RuboCop
         alias on_until on_while
         alias on_for on_while
 
+        def autocorrect(node)
+          lambda do |corrector|
+            if node.modifier_form?
+              autocorrect_modifier(corrector, node)
+            else
+              autocorrect_block(corrector, node)
+            end
+          end
+        end
+
         private
 
         def check(node)
@@ -102,16 +140,6 @@ module RuboCop
           offense_begin_pos.join(condition_expression.source_range)
         end
 
-        def autocorrect(node)
-          lambda do |corrector|
-            if node.modifier_form?
-              autocorrect_modifier(corrector, node)
-            else
-              autocorrect_block(corrector, node)
-            end
-          end
-        end
-
         def autocorrect_modifier(corrector, node)
           cond, if_body, else_body = *node
           body = if_body || else_body