rubocop 1.9.1 → 1.22.3

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

@@ -31,8 +31,7 @@ module RuboCop
         include IntegerNode
         extend AutoCorrector
 
-        MSG = 'Use underscores(_) as thousands separator and ' \
-              'separate every 3 digits with them.'
+        MSG = 'Use underscores(_) as thousands separator and separate every 3 digits with them.'
         DELIMITER_REGEXP = /[eE.]/.freeze
 
         # The parameter is called MinDigits (meaning the minimum number of
@@ -59,18 +58,15 @@ module RuboCop
 
           case int
           when /^\d+$/
-            return unless (self.min_digits = int.size + 1)
-
-            register_offense(node)
+            register_offense(node) { self.min_digits = int.size + 1 }
           when /\d{4}/, short_group_regex
-            return unless (self.config_to_allow_offenses = { 'Enabled' => false })
-
-            register_offense(node)
+            register_offense(node) { self.config_to_allow_offenses = { 'Enabled' => false } }
           end
         end
 
-        def register_offense(node)
+        def register_offense(node, &_block)
           add_offense(node) do |corrector|
+            yield
             corrector.replace(node, format_number(node))
           end
         end
@@ -95,12 +91,7 @@ module RuboCop
         # @param int_part [String]
         def format_int_part(int_part)
           int_part = Integer(int_part)
-          formatted_int = int_part
-                          .abs
-                          .to_s
-                          .reverse
-                          .gsub(/...(?=.)/, '\&_')
-                          .reverse
+          formatted_int = int_part.abs.to_s.reverse.gsub(/...(?=.)/, '\&_').reverse
           formatted_int.insert(0, '-') if int_part.negative?
           formatted_int
         end

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

@@ -16,6 +16,11 @@ module RuboCop
       # populated with objects which can be compared with integers, but are
       # not themselves `Integer` polymorphic.
       #
+      # @safety
+      #   This cop is unsafe because it cannot be guaranteed that the receiver
+      #   defines the predicates or can be compared to a number, which may lead
+      #   to a false positive for non-standard classes.
+      #
       # @example EnforcedStyle: predicate (default)
       #   # bad
       #
@@ -48,11 +53,7 @@ module RuboCop
 
         MSG = 'Use `%<prefer>s` instead of `%<current>s`.'
 
-        REPLACEMENTS = {
-          'zero?' => '==',
-          'positive?' => '>',
-          'negative?' => '<'
-        }.freeze
+        REPLACEMENTS = { 'zero?' => '==', 'positive?' => '>', 'negative?' => '<' }.freeze
 
         RESTRICT_ON_SEND = %i[== > < positive? negative? zero?].freeze
 
@@ -88,8 +89,7 @@ module RuboCop
 
         def replacement(numeric, operation)
           if style == :predicate
-            [parenthesized_source(numeric),
-             REPLACEMENTS.invert[operation.to_s]].join('.')
+            [parenthesized_source(numeric), REPLACEMENTS.invert[operation.to_s]].join('.')
           else
             [numeric.source, REPLACEMENTS[operation.to_s], 0].join(' ')
           end
@@ -115,14 +115,17 @@ module RuboCop
           end
         end
 
+        # @!method predicate(node)
         def_node_matcher :predicate, <<~PATTERN
           (send $(...) ${:zero? :positive? :negative?})
         PATTERN
 
+        # @!method comparison(node)
         def_node_matcher :comparison, <<~PATTERN
           (send [$(...) !gvar_type?] ${:== :> :<} (int 0))
         PATTERN
 
+        # @!method inverted_comparison(node)
         def_node_matcher :inverted_comparison, <<~PATTERN
           (send (int 0) ${:== :> :<} [$(...) !gvar_type?])
         PATTERN

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

@@ -139,8 +139,7 @@ module RuboCop
           return false unless node.keyword?
           return true if node.respond_to?(:prefix_not?) && node.prefix_not?
 
-          node.respond_to?(:arguments?) && node.arguments? &&
-            !node.parenthesized_call?
+          node.respond_to?(:arguments?) && node.arguments? && !node.parenthesized_call?
         end
       end
     end

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

@@ -22,6 +22,7 @@ module RuboCop
       class OptionHash < Base
         MSG = 'Prefer keyword arguments to options hashes.'
 
+        # @!method option_hash(node)
         def_node_matcher :option_hash, <<~PATTERN
           (args ... $(optarg [#suspicious_name? _] (hash)))
         PATTERN
@@ -30,9 +31,7 @@ module RuboCop
           return if super_used?(node)
           return if allowlist.include?(node.parent.method_name.to_s)
 
-          option_hash(node) do |options|
-            add_offense(options)
-          end
+          option_hash(node) { |options| add_offense(options) }
         end
 
         private

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

@@ -6,6 +6,10 @@ module RuboCop
       # This cop checks for optional arguments to methods
       # that do not come at the end of the argument list.
       #
+      # @safety
+      #   This cop is unsafe because changing a method signature will
+      #   implicitly change behaviour.
+      #
       # @example
       #   # bad
       #   def foo(a = 1, b, c)
@@ -18,13 +22,10 @@ module RuboCop
       #   def foobar(a = 1, b = 2, c = 3)
       #   end
       class OptionalArguments < Base
-        MSG = 'Optional arguments should appear at the end ' \
-              'of the argument list.'
+        MSG = 'Optional arguments should appear at the end of the argument list.'
 
         def on_def(node)
-          each_misplaced_optional_arg(node.arguments) do |argument|
-            add_offense(argument)
-          end
+          each_misplaced_optional_arg(node.arguments) { |argument| add_offense(argument) }
         end
 
         private

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

@@ -7,6 +7,10 @@ module RuboCop
       # boolean arguments when defining methods. `respond_to_missing?` method is allowed by default.
       # These are customizable with `AllowedMethods` option.
       #
+      # @safety
+      #   This cop is unsafe because changing a method signature will
+      #   implicitly change behaviour.
+      #
       # @example
       #   # bad
       #   def some_method(bar = false)
@@ -33,8 +37,8 @@ module RuboCop
       class OptionalBooleanParameter < Base
         include AllowedMethods
 
-        MSG = 'Use keyword arguments when defining method with boolean argument.'
-        BOOLEAN_TYPES = %i[true false].freeze
+        MSG = 'Prefer keyword arguments for arguments with a boolean default value; ' \
+              'use `%<replacement>s` instead of `%<original>s`.'
 
         def on_def(node)
           return if allowed_method?(node.method_name)
@@ -42,11 +46,17 @@ module RuboCop
           node.arguments.each do |arg|
             next unless arg.optarg_type?
 
-            _name, value = *arg
-            add_offense(arg) if BOOLEAN_TYPES.include?(value.type)
+            add_offense(arg, message: format_message(arg)) if arg.default_value.boolean_type?
           end
         end
         alias on_defs on_def
+
+        private
+
+        def format_message(argument)
+          source = argument.source
+          format(MSG, original: source, replacement: source.sub(/\s+=/, ':'))
+        end
       end
     end
   end

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

@@ -31,6 +31,7 @@ module RuboCop
 
         MSG = 'Use the double pipe equals operator `||=` instead.'
 
+        # @!method ternary_assignment?(node)
         def_node_matcher :ternary_assignment?, <<~PATTERN
           ({lvasgn ivasgn cvasgn gvasgn} _var
             (if
@@ -39,6 +40,7 @@ module RuboCop
               $_))
         PATTERN
 
+        # @!method unless_assignment?(node)
         def_node_matcher :unless_assignment?, <<~PATTERN
           (if
             ({lvar ivar cvar gvar} _var) nil?
@@ -49,18 +51,14 @@ module RuboCop
         def on_if(node)
           return unless unless_assignment?(node)
 
-          add_offense(node) do |corrector|
-            autocorrect(corrector, node)
-          end
+          add_offense(node) { |corrector| autocorrect(corrector, node) }
         end
 
         def on_lvasgn(node)
           return unless (else_branch = ternary_assignment?(node))
           return if else_branch.if_type?
 
-          add_offense(node) do |corrector|
-            autocorrect(corrector, node)
-          end
+          add_offense(node) { |corrector| autocorrect(corrector, node) }
         end
 
         alias on_ivasgn on_lvasgn

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

@@ -36,9 +36,7 @@ module RuboCop
           return if allowed_lhs?(lhs) || allowed_rhs?(rhs) ||
                     allowed_masign?(lhs_elements, rhs_elements)
 
-          add_offense(node) do |corrector|
-            autocorrect(corrector, node)
-          end
+          add_offense(node) { |corrector| autocorrect(corrector, node) }
         end
 
         private
@@ -72,9 +70,7 @@ module RuboCop
           elements = Array(node).compact
 
           # Account for edge case of `Constant::CONSTANT`
-          !node.array_type? ||
-            return_of_method_call?(node) ||
-            elements.any?(&:splat_type?)
+          !node.array_type? || return_of_method_call?(node) || elements.any?(&:splat_type?)
         end
 
         def return_of_method_call?(node)
@@ -115,6 +111,7 @@ module RuboCop
           end
         end
 
+        # @!method implicit_self_getter?(node)
         def_node_matcher :implicit_self_getter?, '(send nil? $_)'
 
         # Helper class necessitated by silly design of TSort prior to Ruby 2.1
@@ -123,8 +120,13 @@ module RuboCop
           include TSort
           extend RuboCop::NodePattern::Macros
 
+          # @!method var_name(node)
           def_node_matcher :var_name, '{(casgn _ $_) (_ $_)}'
+
+          # @!method uses_var?(node)
           def_node_search :uses_var?, '{({lvar ivar cvar gvar} %) (const _ %)}'
+
+          # @!method matching_calls(node, receiver, method_name)
           def_node_search :matching_calls, '(send %1 %2 $...)'
 
           def initialize(assignments)
@@ -151,16 +153,17 @@ module RuboCop
 
           def dependency?(lhs, rhs)
             uses_var?(rhs, var_name(lhs)) ||
-              lhs.send_type? && lhs.assignment_method? && accesses?(rhs, lhs)
+              (lhs.send_type? && lhs.assignment_method? && accesses?(rhs, lhs))
           end
 
           # `lhs` is an assignment method call like `obj.attr=` or `ary[idx]=`.
           # Does `rhs` access the same value which is assigned by `lhs`?
           def accesses?(rhs, lhs)
             if lhs.method?(:[]=)
-              matching_calls(rhs, lhs.receiver, :[]).any? do |args|
-                args == lhs.arguments
-              end
+              # FIXME: Workaround `rubocop:disable` comment for JRuby.
+              # rubocop:disable Performance/RedundantEqualityComparisonBlock
+              matching_calls(rhs, lhs.receiver, :[]).any? { |args| args == lhs.arguments }
+              # rubocop:enable Performance/RedundantEqualityComparisonBlock
             else
               access_method = lhs.method_name.to_s.chop.to_sym
               matching_calls(rhs, lhs.receiver, access_method).any?

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

@@ -71,6 +71,7 @@ module RuboCop
 
         private
 
+        # @!method control_op_condition(node)
         def_node_matcher :control_op_condition, <<~PATTERN
           (begin $_ ...)
         PATTERN

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

@@ -68,13 +68,11 @@ module RuboCop
           delimiters = preferred_delimiters_for(type)
 
           "`#{type}`-literals should be delimited by " \
-          "`#{delimiters[0]}` and `#{delimiters[1]}`."
+            "`#{delimiters[0]}` and `#{delimiters[1]}`."
         end
 
         def preferred_delimiters_for(type)
-          PreferredDelimiters
-            .new(type, @config, nil)
-            .delimiters
+          PreferredDelimiters.new(type, @config, nil).delimiters
         end
 
         def uses_preferred_delimiter?(node, type)

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

@@ -30,8 +30,7 @@ module RuboCop
         include ConfigurableEnforcedStyle
         extend AutoCorrector
 
-        LOWER_CASE_Q_MSG = 'Do not use `%Q` unless interpolation is ' \
-                           'needed. Use `%q`.'
+        LOWER_CASE_Q_MSG = 'Do not use `%Q` unless interpolation is needed. Use `%q`.'
         UPPER_CASE_Q_MSG = 'Use `%Q` instead of `%q`.'
 
         def on_str(node)
@@ -54,8 +53,8 @@ module RuboCop
         end
 
         def correct_literal_style?(node)
-          style == :lower_case_q && type(node) == '%q' ||
-            style == :upper_case_q && type(node) == '%Q'
+          (style == :lower_case_q && type(node) == '%q') ||
+            (style == :upper_case_q && type(node) == '%Q')
         end
 
         def message(_range)

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

@@ -36,11 +36,7 @@ module RuboCop
         # @param [RuboCop::AST::Node] node
         # @return [Boolean]
         def derived_from_braceless_interpolation?(node)
-          %i[
-            dstr
-            regexp
-            xstr
-          ].include?(node.parent&.type)
+          %i[dstr regexp xstr].include?(node.parent&.type)
         end
 
         # @private
@@ -95,10 +91,7 @@ module RuboCop
 
           add_offense(
             node,
-            message: format_message(
-              node: node,
-              preferred_expression: preferred_expression
-            )
+            message: format_message(node: node, preferred_expression: preferred_expression)
           ) do |corrector|
             if derived_from_braceless_interpolation?(node)
               preferred_expression = "{#{preferred_expression}}"

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

@@ -3,10 +3,15 @@
 module RuboCop
   module Cop
     module Style
-      # This cop (by default) checks for uses of methods Hash#has_key? and
-      # Hash#has_value? where it enforces Hash#key? and Hash#value?
-      # It is configurable to enforce the inverse, using `verbose` method
-      # names also.
+      # This cop checks for uses of methods `Hash#has_key?` and
+      # `Hash#has_value?`, and suggests using `Hash#key?` and `Hash#value?` instead.
+      #
+      # It is configurable to enforce the verbose method names, by using the
+      # `EnforcedStyle: verbose` configuration.
+      #
+      # @safety
+      #   This cop is unsafe because it cannot be guaranteed that the receiver
+      #   is a `Hash` or responds to the replacement methods.
       #
       # @example EnforcedStyle: short (default)
       #  # bad
@@ -31,10 +36,7 @@ module RuboCop
 
         MSG = 'Use `Hash#%<prefer>s` instead of `Hash#%<current>s`.'
 
-        OFFENDING_SELECTORS = {
-          short: %i[has_key? has_value?],
-          verbose: %i[key? value?]
-        }.freeze
+        OFFENDING_SELECTORS = { short: %i[has_key? has_value?], verbose: %i[key? value?] }.freeze
 
         RESTRICT_ON_SEND = OFFENDING_SELECTORS.values.flatten.freeze
 

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

@@ -18,8 +18,8 @@ module RuboCop
 
         MSG = 'Use `proc` instead of `Proc.new`.'
 
-        def_node_matcher :proc_new?,
-                         '(block $(send (const {nil? cbase} :Proc) :new) ...)'
+        # @!method proc_new?(node)
+        def_node_matcher :proc_new?, '(block $(send (const {nil? cbase} :Proc) :new) ...)'
 
         def on_block(node)
           proc_new?(node) do |block_method|

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

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Checks if the quotes used for quoted symbols match the configured defaults.
+      # By default uses the same configuration as `Style/StringLiterals`; if that
+      # cop is not enabled, the default `EnforcedStyle` is `single_quotes`.
+      #
+      # String interpolation is always kept in double quotes.
+      #
+      # Note: `Lint/SymbolConversion` can be used in parallel to ensure that symbols
+      # are not quoted that don't need to be. This cop is for configuring the quoting
+      # style to use for symbols that require quotes.
+      #
+      # @example EnforcedStyle: same_as_string_literals (default) / single_quotes
+      #   # bad
+      #   :"abc-def"
+      #
+      #   # good
+      #   :'abc-def'
+      #   :"#{str}"
+      #   :"a\'b"
+      #
+      # @example EnforcedStyle: double_quotes
+      #   # bad
+      #   :'abc-def'
+      #
+      #   # good
+      #   :"abc-def"
+      #   :"#{str}"
+      #   :"a\'b"
+      class QuotedSymbols < Base
+        include ConfigurableEnforcedStyle
+        include SymbolHelp
+        include StringLiteralsHelp
+        extend AutoCorrector
+
+        MSG_SINGLE = "Prefer single-quoted symbols when you don't need string interpolation " \
+                     'or special symbols.'
+        MSG_DOUBLE = 'Prefer double-quoted symbols unless you need single quotes to ' \
+                     'avoid extra backslashes for escaping.'
+
+        def on_sym(node)
+          return unless quoted?(node)
+
+          message = style == :single_quotes ? MSG_SINGLE : MSG_DOUBLE
+
+          if wrong_quotes?(node)
+            add_offense(node, message: message) do |corrector|
+              opposite_style_detected
+              autocorrect(corrector, node)
+            end
+          else
+            correct_style_detected
+          end
+        end
+
+        private
+
+        def autocorrect(corrector, node)
+          str = if hash_colon_key?(node)
+                  # strip quotes
+                  correct_quotes(node.source[1..-2])
+                else
+                  # strip leading `:` and quotes
+                  ":#{correct_quotes(node.source[2..-2])}"
+                end
+
+          corrector.replace(node, str)
+        end
+
+        def hash_colon_key?(node)
+          # Is the node a hash key with the colon style?
+          hash_key?(node) && node.parent.colon?
+        end
+
+        def correct_quotes(str)
+          correction = if style == :single_quotes
+                         to_string_literal(str)
+                       else
+                         str.gsub("\\'", "'").inspect
+                       end
+
+          # The conversion process doubles escaped slashes, so they have to be reverted
+          correction.gsub('\\\\', '\\')
+        end
+
+        def style
+          return super unless super == :same_as_string_literals
+
+          string_literals_config = config.for_cop('Style/StringLiterals')
+          return :single_quotes unless string_literals_config['Enabled']
+
+          string_literals_config['EnforcedStyle'].to_sym
+        end
+
+        def alternative_style
+          (supported_styles - [style, :same_as_string_literals]).first
+        end
+
+        def quoted?(sym_node)
+          sym_node.source.match?(/\A:?(['"]).*?\1\z/m)
+        end
+
+        def wrong_quotes?(node)
+          return super if hash_key?(node)
+
+          super(node.source[1..-1])
+        end
+      end
+    end
+  end
+end

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

@@ -23,6 +23,7 @@ module RuboCop
       #   # good
       #   raise StandardError, 'message'
       #   fail 'message'
+      #   raise MyCustomError
       #   raise MyCustomError.new(arg1, arg2, arg3)
       #   raise MyKwArgError.new(key1: val1, key2: val2)
       #
@@ -37,16 +38,15 @@ module RuboCop
       #
       #   # good
       #   raise StandardError.new('message')
+      #   raise MyCustomError
       #   raise MyCustomError.new(arg1, arg2, arg3)
       #   fail 'message'
       class RaiseArgs < Base
         include ConfigurableEnforcedStyle
         extend AutoCorrector
 
-        EXPLODED_MSG = 'Provide an exception class and message ' \
-          'as arguments to `%<method>s`.'
-        COMPACT_MSG = 'Provide an exception object ' \
-          'as an argument to `%<method>s`.'
+        EXPLODED_MSG = 'Provide an exception class and message as arguments to `%<method>s`.'
+        COMPACT_MSG = 'Provide an exception object as an argument to `%<method>s`.'
 
         RESTRICT_ON_SEND = %i[raise fail].freeze
 
@@ -66,8 +66,7 @@ module RuboCop
         def correction_compact_to_exploded(node)
           exception_node, _new, message_node = *node.first_argument
 
-          arguments =
-            [exception_node, message_node].compact.map(&:source).join(', ')
+          arguments = [exception_node, message_node].compact.map(&:source).join(', ')
 
           if node.parent && requires_parens?(node.parent)
             "#{node.method_name}(#{arguments})"
@@ -142,8 +141,7 @@ module RuboCop
         end
 
         def requires_parens?(parent)
-          parent.and_type? || parent.or_type? ||
-            parent.if_type? && parent.ternary?
+          parent.and_type? || parent.or_type? || (parent.if_type? && parent.ternary?)
         end
       end
     end

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

@@ -26,10 +26,10 @@ module RuboCop
       class RandomWithOffset < Base
         extend AutoCorrector
 
-        MSG = 'Prefer ranges when generating random numbers instead of ' \
-          'integers with offsets.'
+        MSG = 'Prefer ranges when generating random numbers instead of integers with offsets.'
         RESTRICT_ON_SEND = %i[+ - succ pred next].freeze
 
+        # @!method integer_op_rand?(node)
         def_node_matcher :integer_op_rand?, <<~PATTERN
           (send
             int {:+ :-}
@@ -39,6 +39,7 @@ module RuboCop
               {int (irange int int) (erange int int)}))
         PATTERN
 
+        # @!method rand_op_integer?(node)
         def_node_matcher :rand_op_integer?, <<~PATTERN
           (send
             (send
@@ -49,6 +50,7 @@ module RuboCop
             int)
         PATTERN
 
+        # @!method rand_modified?(node)
         def_node_matcher :rand_modified?, <<~PATTERN
           (send
             (send
@@ -60,17 +62,14 @@ module RuboCop
 
         def on_send(node)
           return unless node.receiver
-          return unless integer_op_rand?(node) ||
-                        rand_op_integer?(node) ||
-                        rand_modified?(node)
+          return unless integer_op_rand?(node) || rand_op_integer?(node) || rand_modified?(node)
 
-          add_offense(node) do |corrector|
-            autocorrect(corrector, node)
-          end
+          add_offense(node) { |corrector| autocorrect(corrector, node) }
         end
 
         private
 
+        # @!method random_call(node)
         def_node_matcher :random_call, <<~PATTERN
           {(send (send $_ _ $_) ...)
            (send _ _ (send $_ _ $_))}
@@ -144,6 +143,7 @@ module RuboCop
           end
         end
 
+        # @!method to_int(node)
         def_node_matcher :to_int, <<~PATTERN
           (int $_)
         PATTERN