rubocop 1.12.0 → 1.16.0

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

@@ -31,10 +31,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

@@ -19,8 +19,7 @@ module RuboCop
         MSG = 'Use `proc` instead of `Proc.new`.'
 
         # @!method proc_new?(node)
-        def_node_matcher :proc_new?,
-                         '(block $(send (const {nil? cbase} :Proc) :new) ...)'
+        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,105 @@
+# 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`.
+      #
+      # 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_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 correct_quotes(str)
+          if style == :single_quotes
+            to_string_literal(str)
+          else
+            str.inspect
+          end
+        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

@@ -43,10 +43,8 @@ module RuboCop
         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 +64,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 +139,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,8 +26,7 @@ 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)
@@ -63,13 +62,9 @@ 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

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'parser/current'
-
 module RuboCop
   module Cop
     module Style
@@ -68,17 +66,10 @@ module RuboCop
         end
 
         def redundant_arg_for_method(method_name)
-          return nil unless cop_config['Methods'].key?(method_name)
+          arg = cop_config['Methods'].fetch(method_name) { return }
 
           @mem ||= {}
-          @mem[method_name] ||=
-            begin
-              arg = cop_config['Methods'].fetch(method_name)
-              buffer = Parser::Source::Buffer.new('(string)', 1)
-              buffer.source = arg.inspect
-              builder = RuboCop::AST::Builder.new
-              Parser::CurrentRuby.new(builder).parse(buffer)
-            end
+          @mem[method_name] ||= parse(arg.inspect).ast
         end
 
         def argument_range(node)

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

@@ -81,9 +81,7 @@ module RuboCop
         end
 
         def check_rescue_node(node)
-          node.child_nodes.each do |child_node|
-            check_branch(child_node)
-          end
+          node.child_nodes.each { |child_node| check_branch(child_node) }
         end
 
         def check_ensure_node(node)

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

@@ -36,7 +36,6 @@ module RuboCop
       #   do_something
       #
       #   # bad
-      #   # When using Ruby 2.5 or later.
       #   do_something do
       #     begin
       #       something
@@ -76,8 +75,6 @@ module RuboCop
         alias on_defs on_def
 
         def on_block(node)
-          return if target_ruby_version < 2.5
-
           return if node.send_node.lambda_literal?
           return if node.braces?
           return unless node.body&.kwbegin_type?
@@ -112,8 +109,22 @@ module RuboCop
         def replace_begin_with_statement(corrector, offense_range, node)
           first_child = node.children.first
 
-          corrector.replace(offense_range, first_child.source)
+          source = first_child.source
+          source = "(#{source})" if first_child.if_type? && first_child.modifier_form?
+
+          corrector.replace(offense_range, source)
           corrector.remove(range_between(offense_range.end_pos, first_child.source_range.end_pos))
+
+          restore_removed_comments(corrector, offense_range, node, first_child)
+        end
+
+        # Restore comments that occur between "begin" and "first_child".
+        # These comments will be moved to above the assignment line.
+        def restore_removed_comments(corrector, offense_range, node, first_child)
+          comments_range = range_between(offense_range.end_pos, first_child.source_range.begin_pos)
+          comments = comments_range.source
+
+          corrector.insert_before(node.parent, comments) unless comments.blank?
         end
 
         def empty_begin?(node)

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

@@ -18,8 +18,7 @@ module RuboCop
         include PercentLiteral
         extend AutoCorrector
 
-        MSG = 'Do not use `%W` unless interpolation is needed. ' \
-              'If not, use `%w`.'
+        MSG = 'Do not use `%W` unless interpolation is needed. If not, use `%w`.'
 
         def on_array(node)
           process(node, '%W')

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

@@ -78,9 +78,7 @@ module RuboCop
           return false if use_if_branch?(else_branch) || use_hash_key_assignment?(else_branch)
 
           condition == if_branch && !node.elsif? && (
-            node.ternary? ||
-            !else_branch.instance_of?(AST::Node) ||
-            else_branch.single_line?
+            node.ternary? || !else_branch.instance_of?(AST::Node) || else_branch.single_line?
           )
         end
 
@@ -104,8 +102,7 @@ module RuboCop
 
         def make_ternary_form(node)
           _condition, if_branch, else_branch = *node
-          ternary_form = [if_branch.source,
-                          else_source(else_branch)].join(' || ')
+          ternary_form = [if_branch.source, else_source(else_branch)].join(' || ')
 
           if node.parent&.send_type?
             "(#{ternary_form})"

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

@@ -31,8 +31,7 @@ module RuboCop
         operators = RuboCop::AST::Node::COMPARISON_OPERATORS.to_a
         COMPARISON_OPERATOR_MATCHER = "{:#{operators.join(' :')}}"
 
-        MSG = 'This conditional expression can just be replaced ' \
-              'by `%<msg>s`.'
+        MSG = 'This conditional expression can just be replaced by `%<msg>s`.'
 
         def on_if(node)
           return unless offense?(node)
@@ -78,11 +77,9 @@ module RuboCop
 
         def invert_expression?(node)
           (
-            (node.if? || node.elsif? || node.ternary?) &&
-            redundant_condition_inverted?(node)
+            (node.if? || node.elsif? || node.ternary?) && redundant_condition_inverted?(node)
           ) || (
-            node.unless? &&
-            redundant_condition?(node)
+            node.unless? && redundant_condition?(node)
           )
         end
 

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

@@ -20,8 +20,7 @@ module RuboCop
         extend AutoCorrector
 
         MSG_1 = 'Redundant `RuntimeError` argument can be removed.'
-        MSG_2 = 'Redundant `RuntimeError.new` call can be replaced with ' \
-                'just the message.'
+        MSG_2 = 'Redundant `RuntimeError.new` call can be replaced with just the message.'
 
         RESTRICT_ON_SEND = %i[raise fail].freeze
 
@@ -35,11 +34,9 @@ module RuboCop
           exploded?(node) do |command, message|
             add_offense(node, message: MSG_1) do |corrector|
               if node.parenthesized?
-                corrector.replace(node,
-                                  "#{command}(#{message.source})")
+                corrector.replace(node, "#{command}(#{message.source})")
               else
-                corrector.replace(node,
-                                  "#{command} #{message.source}")
+                corrector.replace(node, "#{command} #{message.source}")
               end
             end
           end

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

@@ -40,7 +40,7 @@ module RuboCop
             return unless name_node.value.end_with?('.rb')
 
             add_offense(name_node) do |corrector|
-              correction = name_node.value.sub(/\.rb\z/, '')
+              correction = name_node.value.delete_suffix('.rb')
 
               corrector.replace(name_node, "'#{correction}'")
             end

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

@@ -17,8 +17,7 @@ module RuboCop
         extend AutoCorrector
         include FrozenStringLiteral
 
-        MSG = 'Do not freeze immutable objects, as freezing them has no ' \
-              'effect.'
+        MSG = 'Do not freeze immutable objects, as freezing them has no effect.'
         RESTRICT_ON_SEND = %i[freeze].freeze
 
         def on_send(node)

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

@@ -72,8 +72,7 @@ module RuboCop
         end
 
         def embedded_in_percent_array?(node)
-          node.parent&.array_type? &&
-            percent_literal?(node.parent)
+          node.parent&.array_type? && percent_literal?(node.parent)
         end
 
         def autocorrect_variable_interpolation(corrector, embedded_node, node)

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

@@ -18,8 +18,7 @@ module RuboCop
         extend AutoCorrector
 
         # @!method square_brackets?(node)
-        def_node_matcher :square_brackets?,
-                         '(send {(send _recv _msg) str array hash} :[] ...)'
+        def_node_matcher :square_brackets?, '(send {(send _recv _msg) str array hash} :[] ...)'
 
         # @!method range_end?(node)
         def_node_matcher :range_end?, '^^{irange erange}'
@@ -31,8 +30,7 @@ module RuboCop
         def_node_matcher :rescue?, '{^resbody ^^resbody}'
 
         # @!method arg_in_call_with_block?(node)
-        def_node_matcher :arg_in_call_with_block?,
-                         '^^(block (send _ _ equal?(%0) ...) ...)'
+        def_node_matcher :arg_in_call_with_block?, '^^(block (send _ _ equal?(%0) ...) ...)'
 
         def on_begin(node)
           return if !parentheses?(node) || parens_allowed?(node) || ignore_syntax?(node)
@@ -135,8 +133,7 @@ module RuboCop
 
           node = node.children.first while suspect_unary?(node)
 
-          return if node.send_type? &&
-                    !method_call_with_redundant_parentheses?(node)
+          return if node.send_type? && !method_call_with_redundant_parentheses?(node)
 
           offense(begin_node, 'an unary operation')
         end
@@ -161,16 +158,11 @@ module RuboCop
           # { a: (1
           #      ), }
           # ```
-          (hash_element?(node) || array_element?(node)) &&
-            only_closing_paren_before_comma?(node)
+          hash_or_array_element?(node) && only_closing_paren_before_comma?(node)
         end
 
-        def hash_element?(node)
-          node.parent&.pair_type?
-        end
-
-        def array_element?(node)
-          node.parent&.array_type?
+        def hash_or_array_element?(node)
+          node.each_ancestor(:array, :hash).any?
         end
 
         def only_closing_paren_before_comma?(node)
@@ -181,9 +173,7 @@ module RuboCop
         end
 
         def disallowed_literal?(begin_node, node)
-          node.literal? &&
-            !node.range_type? &&
-            !raised_to_power_negative_numeric?(begin_node, node)
+          node.literal? && !node.range_type? && !raised_to_power_negative_numeric?(begin_node, node)
         end
 
         def raised_to_power_negative_numeric?(begin_node, node)
@@ -225,9 +215,7 @@ module RuboCop
         end
 
         def first_argument?(node)
-          first_send_argument?(node) ||
-            first_super_argument?(node) ||
-            first_yield_argument?(node)
+          first_send_argument?(node) || first_super_argument?(node) || first_yield_argument?(node)
         end
 
         # @!method first_send_argument?(node)