rubocop 1.11.0 → 1.15.0

data/lib/rubocop/cop/lint/safe_navigation_with_empty.rb

@@ -22,8 +22,7 @@ module RuboCop
       class SafeNavigationWithEmpty < Base
         extend AutoCorrector
 
-        MSG = 'Avoid calling `empty?` with the safe navigation operator ' \
-          'in conditionals.'
+        MSG = 'Avoid calling `empty?` with the safe navigation operator in conditionals.'
 
         # @!method safe_navigation_empty_in_conditional?(node)
         def_node_matcher :safe_navigation_empty_in_conditional?, <<~PATTERN

data/lib/rubocop/cop/lint/send_with_mixin_argument.rb

@@ -53,9 +53,7 @@ module RuboCop
 
         def on_send(node)
           send_with_mixin_argument?(node) do |method, module_name|
-            message = message(
-              method, module_name.source, bad_location(node).source
-            )
+            message = message(method, module_name.source, bad_location(node).source)
 
             bad_location = bad_location(node)
             add_offense(bad_location, message: message) do |corrector|
@@ -73,10 +71,7 @@ module RuboCop
         end
 
         def message(method, module_name, bad_method)
-          format(
-            MSG,
-            method: method, module_name: module_name, bad_method: bad_method
-          )
+          format(MSG, method: method, module_name: module_name, bad_method: bad_method)
         end
 
         def mixin_method?(node)

data/lib/rubocop/cop/lint/shadowed_argument.rb

@@ -64,8 +64,7 @@ module RuboCop
       #   end
       #
       class ShadowedArgument < Base
-        MSG = 'Argument `%<argument>s` was shadowed by a local variable ' \
-              'before it was used.'
+        MSG = 'Argument `%<argument>s` was shadowed by a local variable before it was used.'
 
         # @!method uses_var?(node)
         def_node_search :uses_var?, '(lvar %)'
@@ -75,9 +74,7 @@ module RuboCop
         end
 
         def after_leaving_scope(scope, _variable_table)
-          scope.variables.each_value do |variable|
-            check_argument(variable)
-          end
+          scope.variables.each_value { |variable| check_argument(variable) }
         end
 
         private
@@ -128,8 +125,7 @@ module RuboCop
             next false if assignment_node.shorthand_asgn?
 
             node_within_block_or_conditional =
-              node_within_block_or_conditional?(assignment_node.parent,
-                                                argument.scope.node)
+              node_within_block_or_conditional?(assignment_node.parent, argument.scope.node)
 
             unless uses_var?(assignment_node, argument.name)
               # It's impossible to decide whether a branch or block is executed,
@@ -162,10 +158,7 @@ module RuboCop
         # Get argument references without assignments' references
         #
         def argument_references(argument)
-          assignment_references = argument
-                                  .assignments
-                                  .flat_map(&:references)
-                                  .map(&:source_range)
+          assignment_references = argument.assignments.flat_map(&:references).map(&:source_range)
 
           argument.references.reject do |ref|
             next false unless ref.explicit?

data/lib/rubocop/cop/lint/shadowed_exception.rb

@@ -59,8 +59,7 @@ module RuboCop
             contains_multiple_levels_of_exceptions?(group)
           end
 
-          return if !rescue_group_rescues_multiple_levels &&
-                    sorted?(rescued_groups)
+          return if !rescue_group_rescues_multiple_levels && sorted?(rescued_groups)
 
           add_offense(offense_range(rescues))
         end
@@ -74,18 +73,14 @@ module RuboCop
         end
 
         def rescued_groups_for(rescues)
-          rescues.map do |group|
-            evaluate_exceptions(group)
-          end
+          rescues.map { |group| evaluate_exceptions(group) }
         end
 
         def contains_multiple_levels_of_exceptions?(group)
           # Always treat `Exception` as the highest level exception.
           return true if group.size > 1 && group.include?(Exception)
 
-          group.combination(2).any? do |a, b|
-            compare_exceptions(a, b)
-          end
+          group.combination(2).any? { |a, b| compare_exceptions(a, b) }
         end
 
         def compare_exceptions(exception, other_exception)
@@ -111,6 +106,9 @@ module RuboCop
 
           if rescued_exceptions.any?
             rescued_exceptions.each_with_object([]) do |exception, converted|
+              # FIXME: Workaround `rubocop:disable` comment for JRuby.
+              #        https://github.com/jruby/jruby/issues/6642
+              # rubocop:disable Style/RedundantBegin
               begin
                 RuboCop::Util.silence_warnings do
                   # Avoid printing deprecation warnings about constants
@@ -119,6 +117,7 @@ module RuboCop
               rescue NameError
                 converted << nil
               end
+              # rubocop:enable Style/RedundantBegin
             end
           else
             # treat an empty `rescue` as `rescue StandardError`

data/lib/rubocop/cop/lint/struct_new_override.rb

@@ -48,8 +48,7 @@ module RuboCop
 
               next unless STRUCT_METHOD_NAMES.include?(member_name.to_sym)
 
-              message = format(MSG, member_name: member_name.inspect,
-                                    method_name: member_name.to_s)
+              message = format(MSG, member_name: member_name.inspect, method_name: member_name.to_s)
               add_offense(arg, message: message)
             end
           end

data/lib/rubocop/cop/lint/suppressed_exception.rb

@@ -64,12 +64,51 @@ module RuboCop
       #   rescue
       #     # do nothing
       #   end
+      #
+      # @example AllowNil: true (default)
+      #
+      #   # good
+      #   def some_method
+      #     do_something
+      #   rescue
+      #     nil
+      #   end
+      #
+      #   # good
+      #   begin
+      #     do_something
+      #   rescue
+      #     # do nothing
+      #   end
+      #
+      #   # good
+      #   do_something rescue nil
+      #
+      # @example AllowNil: false
+      #
+      #   # bad
+      #   def some_method
+      #     do_something
+      #   rescue
+      #     nil
+      #   end
+      #
+      #   # bad
+      #   begin
+      #     do_something
+      #   rescue
+      #     nil
+      #   end
+      #
+      #   # bad
+      #   do_something rescue nil
       class SuppressedException < Base
         MSG = 'Do not suppress exceptions.'
 
         def on_resbody(node)
-          return if node.body
+          return if node.body && !nil_body?(node)
           return if cop_config['AllowComments'] && comment_between_rescue_and_end?(node)
+          return if cop_config['AllowNil'] && nil_body?(node)
 
           add_offense(node)
         end
@@ -83,6 +122,10 @@ module RuboCop
           end_line = ancestor.loc.end.line
           processed_source[node.first_line...end_line].any? { |line| comment_line?(line) }
         end
+
+        def nil_body?(node)
+          node.body&.nil_type?
+        end
       end
     end
   end

data/lib/rubocop/cop/lint/symbol_conversion.rb

@@ -6,6 +6,12 @@ module RuboCop
       # This cop checks for uses of literal strings converted to
       # a symbol where a literal symbol could be used instead.
       #
+      # There are two possible styles for this cop.
+      # `strict` (default) will register an offense for any incorrect usage.
+      # `consistent` additionally requires hashes to use the same style for
+      # every symbol key (ie. if any symbol key needs to be quoted it requires
+      # all keys to be quoted).
+      #
       # @example
       #   # bad
       #   'string'.to_sym
@@ -21,10 +27,49 @@ module RuboCop
       #   :underscored_symbol
       #   :'hyphenated-string'
       #
+      # @example EnforcedStyle: strict (default)
+      #
+      #   # bad
+      #   {
+      #     'a': 1,
+      #     "b": 2,
+      #     'c-d': 3
+      #   }
+      #
+      #   # good (don't quote keys that don't require quoting)
+      #   {
+      #     a: 1,
+      #     b: 2,
+      #     'c-d': 3
+      #   }
+      #
+      # @example EnforcedStyle: consistent
+      #
+      #   # bad
+      #   {
+      #     a: 1,
+      #     'b-c': 2
+      #   }
+      #
+      #   # good (quote all keys if any need quoting)
+      #   {
+      #     'a': 1,
+      #     'b-c': 2
+      #   }
+      #
+      #   # good (no quoting required)
+      #   {
+      #     a: 1,
+      #     b: 2
+      #   }
+      #
       class SymbolConversion < Base
         extend AutoCorrector
+        include ConfigurableEnforcedStyle
 
         MSG = 'Unnecessary symbol conversion; use `%<correction>s` instead.'
+        MSG_CONSISTENCY = 'Symbol hash key should be quoted for consistency; ' \
+          'use `%<correction>s` instead.'
         RESTRICT_ON_SEND = %i[to_sym intern].freeze
 
         def on_send(node)
@@ -35,7 +80,7 @@ module RuboCop
         end
 
         def on_sym(node)
-          return if properly_quoted?(node.source, node.value.inspect)
+          return if ignored_node?(node) || properly_quoted?(node.source, node.value.inspect)
 
           # `alias` arguments are symbols but since a symbol that requires
           # being quoted is not a valid method identifier, it can be ignored
@@ -51,16 +96,29 @@ module RuboCop
           register_offense(node, correction: node.value.inspect)
         end
 
+        def on_hash(node)
+          # For `EnforcedStyle: strict`, hash keys are evaluated in `on_sym`
+          return unless style == :consistent
+
+          keys = node.keys.select(&:sym_type?)
+
+          if keys.any? { |key| requires_quotes?(key) }
+            correct_inconsistent_hash_keys(keys)
+          else
+            # If there are no symbol keys requiring quoting,
+            # treat the hash like `EnforcedStyle: strict`.
+            keys.each { |key| correct_hash_key(key) }
+          end
+        end
+
         private
 
         def register_offense(node, correction:, message: format(MSG, correction: correction))
-          add_offense(node, message: message) do |corrector|
-            corrector.replace(node, correction)
-          end
+          add_offense(node, message: message) { |corrector| corrector.replace(node, correction) }
         end
 
         def properly_quoted?(source, value)
-          return true if !source.match?(/['"]/) || value.end_with?('=')
+          return true if style == :strict && (!source.match?(/['"]/) || value.end_with?('='))
 
           source == value ||
             # `Symbol#inspect` uses double quotes, but allow single-quoted
@@ -68,6 +126,10 @@ module RuboCop
             source.tr("'", '"') == value
         end
 
+        def requires_quotes?(sym_node)
+          sym_node.value.inspect.match?(/^:".*?"|=$/)
+        end
+
         def in_alias?(node)
           node.parent&.alias_type?
         end
@@ -88,7 +150,7 @@ module RuboCop
           # will be ignored.
           return unless node.value.to_s.match?(/\A[a-z0-9_]/i)
 
-          correction = node.value.inspect.gsub(/\A:/, '')
+          correction = node.value.inspect.delete_prefix(':')
           return if properly_quoted?(node.source, correction)
 
           register_offense(
@@ -97,6 +159,29 @@ module RuboCop
             message: format(MSG, correction: "#{correction}:")
           )
         end
+
+        def correct_inconsistent_hash_keys(keys)
+          keys.each do |key|
+            ignore_node(key)
+
+            next if requires_quotes?(key)
+            next if properly_quoted?(key.source, %("#{key.value}"))
+
+            correction = "#{quote_type}#{key.value}#{quote_type}"
+            register_offense(
+              key,
+              correction: correction,
+              message: format(MSG_CONSISTENCY, correction: "#{correction}:")
+            )
+          end
+        end
+
+        def quote_type
+          # Use the `Style/StringLiterals` configuration for quoting symbols
+          return '"' unless config.for_cop('Style/StringLiterals')['Enabled']
+
+          config.for_cop('Style/StringLiterals')['EnforcedStyle'] == 'single_quotes' ? "'" : '"'
+        end
       end
     end
   end

data/lib/rubocop/cop/lint/syntax.rb

@@ -21,9 +21,7 @@ module RuboCop
           message =
             "#{diagnostic.message}\n(Using Ruby #{ruby_version} parser; " \
             'configure using `TargetRubyVersion` parameter, under `AllCops`)'
-          add_offense(diagnostic.location,
-                      message: message,
-                      severity: diagnostic.level)
+          add_offense(diagnostic.location, message: message, severity: diagnostic.level)
         end
 
         def add_offense_from_error(error)

data/lib/rubocop/cop/lint/to_json.rb

@@ -31,8 +31,7 @@ module RuboCop
       class ToJSON < Base
         extend AutoCorrector
 
-        MSG = '`#to_json` requires an optional argument to be parsable ' \
-          'via JSON.generate(obj).'
+        MSG = '`#to_json` requires an optional argument to be parsable via JSON.generate(obj).'
 
         def on_def(node)
           return unless node.method?(:to_json) && node.arguments.empty?

data/lib/rubocop/cop/lint/trailing_comma_in_attribute_declaration.rb

@@ -38,9 +38,7 @@ module RuboCop
 
           trailing_comma = trailing_comma_range(node)
 
-          add_offense(trailing_comma) do |corrector|
-            corrector.remove(trailing_comma)
-          end
+          add_offense(trailing_comma) { |corrector| corrector.remove(trailing_comma) }
         end
 
         private

data/lib/rubocop/cop/lint/underscore_prefixed_variable_name.rb

@@ -48,9 +48,7 @@ module RuboCop
         end
 
         def after_leaving_scope(scope, _variable_table)
-          scope.variables.each_value do |variable|
-            check_variable(variable)
-          end
+          scope.variables.each_value { |variable| check_variable(variable) }
         end
 
         def check_variable(variable)

data/lib/rubocop/cop/lint/unreachable_code.rb

@@ -81,8 +81,7 @@ module RuboCop
         def check_if(node)
           if_branch = node.if_branch
           else_branch = node.else_branch
-          if_branch && else_branch &&
-            flow_expression?(if_branch) && flow_expression?(else_branch)
+          if_branch && else_branch && flow_expression?(if_branch) && flow_expression?(else_branch)
         end
 
         def check_case(node)
@@ -90,9 +89,7 @@ module RuboCop
           return false unless else_branch
           return false unless flow_expression?(else_branch)
 
-          node.when_branches.all? do |branch|
-            branch.body && flow_expression?(branch.body)
-          end
+          node.when_branches.all? { |branch| branch.body && flow_expression?(branch.body) }
         end
       end
     end

data/lib/rubocop/cop/lint/unreachable_loop.rb

@@ -87,6 +87,7 @@ module RuboCop
         include IgnoredPattern
 
         MSG = 'This loop will have at most one iteration.'
+        CONTINUE_KEYWORDS = %i[next redo].freeze
 
         def on_while(node)
           check(node)
@@ -116,7 +117,10 @@ module RuboCop
           break_statement = statements.find { |statement| break_statement?(statement) }
           return unless break_statement
 
-          add_offense(node) unless preceded_by_continue_statement?(break_statement)
+          unless preceded_by_continue_statement?(break_statement) ||
+                 conditional_continue_keyword?(break_statement)
+            add_offense(node)
+          end
         end
 
         def statements(node)
@@ -162,8 +166,7 @@ module RuboCop
         def check_if(node)
           if_branch = node.if_branch
           else_branch = node.else_branch
-          if_branch && else_branch &&
-            break_statement?(if_branch) && break_statement?(else_branch)
+          if_branch && else_branch && break_statement?(if_branch) && break_statement?(else_branch)
         end
 
         def check_case(node)
@@ -171,18 +174,22 @@ module RuboCop
           return false unless else_branch
           return false unless break_statement?(else_branch)
 
-          node.when_branches.all? do |branch|
-            branch.body && break_statement?(branch.body)
-          end
+          node.when_branches.all? { |branch| branch.body && break_statement?(branch.body) }
         end
 
         def preceded_by_continue_statement?(break_statement)
           break_statement.left_siblings.any? do |sibling|
             next if sibling.loop_keyword? || loop_method?(sibling)
 
-            sibling.each_descendant(:next, :redo).any?
+            sibling.each_descendant(*CONTINUE_KEYWORDS).any?
           end
         end
+
+        def conditional_continue_keyword?(break_statement)
+          or_node = break_statement.each_descendant(:or).to_a.last
+
+          or_node && CONTINUE_KEYWORDS.include?(or_node.rhs.type)
+        end
       end
     end
   end