rubocop 0.51.0 → 0.52.0

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

@@ -5,31 +5,32 @@ module RuboCop
     module Style
       # Use a consistent style for named format string tokens.
       #
-      # @example
-      #
-      #   EnforcedStyle: annotated
+      # @example EnforcedStyle: annotated (default)
       #
       #   # bad
-      #
       #   format('%{greeting}', greeting: 'Hello')
       #   format('%s', 'Hello')
       #
       #   # good
-      #
       #   format('%<greeting>s', greeting: 'Hello')
       #
-      # @example
-      #
-      #   EnforcedStyle: template
+      # @example EnforcedStyle: template
       #
       #   # bad
-      #
       #   format('%<greeting>s', greeting: 'Hello')
       #   format('%s', 'Hello')
       #
       #   # good
-      #
       #   format('%{greeting}', greeting: 'Hello')
+      #
+      # @example EnforcedStyle: unannotated
+      #
+      #   # bad
+      #   format('%<greeting>s', greeting: 'Hello')
+      #   format('%{greeting}', 'Hello')
+      #
+      #   # good
+      #   format('%s', 'Hello')
       class FormatStringToken < Cop
         include ConfigurableEnforcedStyle
 
@@ -37,7 +38,8 @@ module RuboCop
 
         STYLE_PATTERNS = {
           annotated: /(?<token>%<[^>]+>#{FIELD_CHARACTERS})/,
-          template:  /(?<token>%\{[^\}]+\})/
+          template: /(?<token>%\{[^\}]+\})/,
+          unannotated: /(?<token>%#{FIELD_CHARACTERS})/
         }.freeze
 
         TOKEN_PATTERN = Regexp.union(STYLE_PATTERNS.values)
@@ -62,14 +64,13 @@ module RuboCop
           "Prefer #{message_text(style)} over #{message_text(detected_style)}."
         end
 
-        # rubocop:disable FormatStringToken
         def message_text(style)
           case style
           when :annotated then 'annotated tokens (like `%<foo>s`)'
-          when :template  then 'template tokens (like `%{foo}`)'
+          when :template then 'template tokens (like `%{foo}`)'
+          when :unannotated then 'unannotated tokens (like `%s`)'
           end
         end
-        # rubocop:enable FormatStringToken
 
         def tokens(str_node, &block)
           return if str_node.source == '__FILE__'

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

@@ -5,7 +5,7 @@ module RuboCop
     module Style
       # This cop is designed to help upgrade to Ruby 3.0. It will add the
       # comment `# frozen_string_literal: true` to the top of files to
-      # enable frozen string literals. Frozen string literals will be default
+      # 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+.
       class FrozenStringLiteralComment < Cop
@@ -27,10 +27,11 @@ module RuboCop
           end
         end
 
-        def autocorrect(node)
+        def autocorrect(node) # rubocop:disable Metrics/MethodLength
           lambda do |corrector|
             if style == :never
-              corrector.remove(range_with_surrounding_space(node.pos, :right))
+              corrector.remove(range_with_surrounding_space(range: node.pos,
+                                                            side: :right))
             else
               last_special_comment = last_special_comment(processed_source)
               if last_special_comment.nil?

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

@@ -9,10 +9,20 @@ module RuboCop
       # users can allow additional variables via the AllowedVariables option.
       #
       # Note that backreferences like $1, $2, etc are not global variables.
+      #
+      # @example
+      #   # bad
+      #   $foo = 2
+      #   bar = $foo + 5
+      #
+      #   # good
+      #   FOO = 2
+      #   foo = 2
+      #   $stdin.read
       class GlobalVars < Cop
         MSG = 'Do not introduce global variables.'.freeze
 
-        # predefined global variables their English aliases
+        # built-in global variables and their English aliases
         # http://www.zenspider.com/Languages/Ruby/QuickRef.html
         BUILT_IN_VARS = %w[
           $: $LOAD_PATH

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

@@ -19,49 +19,41 @@ module RuboCop
       # * ruby19_no_mixed_keys - forces use of ruby 1.9 syntax and forbids mixed
       #   syntax hashes
       #
-      # @example
-      #   "EnforcedStyle => 'ruby19'"
+      # @example EnforcedStyle: ruby19 (default)
+      #   # bad
+      #   {:a => 2}
+      #   {b: 1, :c => 2}
       #
-      #   @good
+      #   # good
       #   {a: 2, b: 1}
       #   {:c => 2, 'd' => 2} # acceptable since 'd' isn't a symbol
       #   {d: 1, 'e' => 2} # technically not forbidden
       #
-      #   @bad
-      #   {:a => 2}
-      #   {b: 1, :c => 2}
-      #
-      # @example
-      #   "EnforcedStyle => 'hash_rockets'"
-      #
-      #   @good
-      #   {:a => 1, :b => 2}
-      #
-      #   @bad
+      # @example EnforcedStyle: hash_rockets
+      #   # bad
       #   {a: 1, b: 2}
       #   {c: 1, 'd' => 5}
       #
-      # @example
-      #   "EnforcedStyle => 'no_mixed_keys'"
-      #
-      #   @good
+      #   # good
       #   {:a => 1, :b => 2}
-      #   {c: 1, d: 2}
       #
-      #   @bad
+      # @example EnforcedStyle: no_mixed_keys
+      #   # bad
       #   {:a => 1, b: 2}
       #   {c: 1, 'd' => 2}
       #
-      # @example
-      #   "EnforcedStyle => 'ruby19_no_mixed_keys'"
-      #
-      #   @good
-      #   {a: 1, b: 2}
-      #   {:c => 3, 'd' => 4}
+      #   # good
+      #   {:a => 1, :b => 2}
+      #   {c: 1, d: 2}
       #
-      #   @bad
+      # @example EnforcedStyle: ruby19_no_mixed_keys
+      #   # bad
       #   {:a => 1, :b => 2}
       #   {c: 2, 'd' => 3} # should just use hash rockets
+      #
+      #   # good
+      #   {a: 1, b: 2}
+      #   {:c => 3, 'd' => 4}
       class HashSyntax < Cop
         include ConfigurableEnforcedStyle
 
@@ -174,30 +166,39 @@ module RuboCop
           end
         end
 
-        def autocorrect_ruby19(corrector, node)
-          key = node.children.first.source_range
-          op = node.loc.operator
+        def autocorrect_ruby19(corrector, pair_node)
+          key = pair_node.key
+          op = pair_node.loc.operator
+
+          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}: ")
+        end
 
-          range = range_between(key.begin_pos, op.end_pos)
-          range = range_with_surrounding_space(range, :right)
-          corrector.replace(range,
-                            range.source.sub(/^:(.*\S)\s*=>\s*$/, '\1: '))
+        def argument_without_space?(node)
+          node.argument? &&
+            node.loc.expression.begin_pos == node.parent.loc.selector.end_pos
         end
 
-        def autocorrect_hash_rockets(corrector, node)
-          key = node.children.first.source_range
-          op = node.loc.operator
+        def autocorrect_hash_rockets(corrector, pair_node)
+          key = pair_node.key.source_range
+          op = pair_node.loc.operator
 
-          corrector.insert_after(key, node.inverse_delimiter(true))
+          corrector.insert_after(key, pair_node.inverse_delimiter(true))
           corrector.insert_before(key, ':')
-          corrector.remove(range_with_surrounding_space(op))
+          corrector.remove(range_with_surrounding_space(range: op))
         end
 
-        def autocorrect_no_mixed_keys(corrector, node)
-          if node.colon?
-            autocorrect_hash_rockets(corrector, node)
+        def autocorrect_no_mixed_keys(corrector, pair_node)
+          if pair_node.colon?
+            autocorrect_hash_rockets(corrector, pair_node)
           else
-            autocorrect_ruby19(corrector, node)
+            autocorrect_ruby19(corrector, pair_node)
           end
         end
 

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

@@ -7,7 +7,7 @@ module RuboCop
       # each branch of a conditional statement.
       #
       # @example
-      #   @bad
+      #   # bad
       #   if condition
       #     do_x
       #     do_z
@@ -16,7 +16,7 @@ module RuboCop
       #     do_z
       #   end
       #
-      #   @good
+      #   # good
       #   if condition
       #     do_x
       #   else
@@ -24,7 +24,7 @@ module RuboCop
       #   end
       #   do_z
       #
-      #   @bad
+      #   # bad
       #   if condition
       #     do_z
       #     do_x
@@ -33,7 +33,7 @@ module RuboCop
       #     do_y
       #   end
       #
-      #   @good
+      #   # good
       #   do_z
       #   if condition
       #     do_x
@@ -41,7 +41,7 @@ module RuboCop
       #     do_y
       #   end
       #
-      #   @bad
+      #   # bad
       #   case foo
       #   when 1
       #     do_x
@@ -51,7 +51,7 @@ module RuboCop
       #     do_x
       #   end
       #
-      #   @good
+      #   # good
       #   case foo
       #   when 1
       #     do_x
@@ -63,7 +63,7 @@ module RuboCop
       #     do_z
       #   end
       class IdenticalConditionalBranches < Cop
-        MSG = 'Move `%s` out of the conditional.'.freeze
+        MSG = 'Move `%<source>s` out of the conditional.'.freeze
 
         def on_if(node)
           return if node.elsif?
@@ -105,7 +105,7 @@ module RuboCop
         end
 
         def message(node)
-          format(MSG, node.source)
+          format(MSG, source: node.source)
         end
 
         # `elsif` branches show up in the if node as nested `else` branches. We

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

@@ -8,16 +8,7 @@ module RuboCop
       # This helps to keep the nesting level from getting too deep.
       #
       # @example
-      #   @good
-      #   if condition_a
-      #     action_a
-      #   elsif condition_b
-      #     action_b
-      #   else
-      #     action_c
-      #   end
-      #
-      #   @bad
+      #   # bad
       #   if condition_a
       #     action_a
       #   else
@@ -27,6 +18,15 @@ module RuboCop
       #       action_c
       #     end
       #   end
+      #
+      #   # good
+      #   if condition_a
+      #     action_a
+      #   elsif condition_b
+      #     action_b
+      #   else
+      #     action_c
+      #   end
       class IfInsideElse < Cop
         MSG = 'Convert `if` nested inside `else` to `elsif`.'.freeze
 

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

@@ -4,13 +4,13 @@ module RuboCop
   module Cop
     module Style
       # Checks for if and unless statements that would fit on one line
-      # if written as a modifier if/unless.
-      # The maximum line length is configurable.
+      # if written as a modifier if/unless. The maximum line length is
+      # configured in the `Metrics/LineLength` cop.
       class IfUnlessModifier < Cop
         include StatementModifier
 
-        MSG = 'Favor modifier `%s` usage when having a single-line body. ' \
-              'Another good alternative is the usage of control flow ' \
+        MSG = 'Favor modifier `%<keyword>s` usage when having a single-line ' \
+              'body. Another good alternative is the usage of control flow ' \
               '`&&`/`||`.'.freeze
 
         ASSIGNMENT_TYPES = %i[lvasgn casgn cvasgn
@@ -20,17 +20,17 @@ module RuboCop
           return unless eligible_node?(node)
 
           add_offense(node, location: :keyword,
-                            message: format(MSG, node.keyword))
+                            message: format(MSG, keyword: node.keyword))
         end
 
-        private
-
         def autocorrect(node)
           lambda do |corrector|
             corrector.replace(node.source_range, to_modifier_form(node))
           end
         end
 
+        private
+
         def eligible_node?(node)
           !non_eligible_if?(node) && !node.chained? &&
             !node.nested_conditional? && single_line_as_modifier?(node)

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

@@ -25,13 +25,13 @@ module RuboCop
       class IfUnlessModifierOfIfUnless < Cop
         include StatementModifier
 
-        MSG = 'Avoid modifier `%s` after another conditional.'.freeze
+        MSG = 'Avoid modifier `%<keyword>s` after another conditional.'.freeze
 
         def on_if(node)
           return unless node.modifier_form? && node.body.if_type?
 
           add_offense(node, location: :keyword,
-                            message: format(MSG, node.keyword))
+                            message: format(MSG, keyword: node.keyword))
         end
       end
     end

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

@@ -4,6 +4,15 @@ module RuboCop
   module Cop
     module Style
       # Checks for uses of semicolon in if statements.
+      #
+      # @example
+      #
+      #   # bad
+      #   result = if some_condition; something else another_thing end
+      #
+      #   # good
+      #   result = some_condition ? something : another_thing
+      #
       class IfWithSemicolon < Cop
         include OnNormalIfUnless
 

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

@@ -9,21 +9,21 @@ module RuboCop
       # nature of the error.)
       #
       # @example
-      #   @bad
+      #   # bad
       #   raise 'Error message here'
       #
-      #   @good
+      #   # good
       #   raise ArgumentError, 'Error message here'
       class ImplicitRuntimeError < Cop
-        MSG = 'Use `%s` with an explicit exception class and message, ' \
-              'rather than just a message.'.freeze
+        MSG = 'Use `%<method>s` with an explicit exception class and message,' \
+              ' rather than just a message.'.freeze
 
         def_node_matcher :implicit_runtime_error_raise_or_fail,
                          '(send nil? ${:raise :fail} {str dstr})'
 
         def on_send(node)
           implicit_runtime_error_raise_or_fail(node) do |method|
-            add_offense(node, message: format(MSG, method))
+            add_offense(node, message: format(MSG, method: method))
           end
         end
       end

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

@@ -35,8 +35,6 @@ module RuboCop
         alias on_while_post on_while
         alias on_until_post on_until
 
-        private
-
         def autocorrect(node)
           if node.while_post_type? || node.until_post_type?
             replace_begin_end_with_modifier(node)
@@ -47,6 +45,8 @@ module RuboCop
           end
         end
 
+        private
+
         def replace_begin_end_with_modifier(node)
           lambda do |corrector|
             corrector.replace(node.body.loc.begin, 'loop do')