rubocop 1.9.1 → 1.13.0

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

@@ -18,8 +18,7 @@ module RuboCop
       class NestedTernaryOperator < Base
         extend AutoCorrector
 
-        MSG = 'Ternary operators must not be nested. Prefer `if` or `else` ' \
-              'constructs instead.'
+        MSG = 'Ternary operators must not be nested. Prefer `if` or `else` constructs instead.'
 
         def on_if(node)
           return unless node.ternary?
@@ -51,7 +50,7 @@ module RuboCop
         def remove_parentheses(source)
           return source unless source.start_with?('(')
 
-          source.gsub(/\A\(/, '').gsub(/\)\z/, '')
+          source.delete_prefix('(').delete_suffix(')')
         end
       end
     end

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

@@ -66,8 +66,7 @@ module RuboCop
         end
 
         def on_block(node)
-          return unless node.send_node.send_type? &&
-                        node.send_node.enumerator_method?
+          return unless node.send_node.send_type? && node.send_node.enumerator_method?
 
           check(node)
         end
@@ -180,8 +179,7 @@ module RuboCop
           source_buffer = node.source_range.source_buffer
           end_pos = node.loc.end.end_pos
           begin_pos = node.loc.end.begin_pos - node.loc.end.column
-          begin_pos -= 1 if end_followed_by_whitespace_only?(source_buffer,
-                                                             end_pos)
+          begin_pos -= 1 if end_followed_by_whitespace_only?(source_buffer, end_pos)
 
           range_between(begin_pos, end_pos)
         end
@@ -207,9 +205,7 @@ module RuboCop
 
           target_indent = range.source_line =~ /\S/
           delta = actual_indent(lines, buffer) - target_indent
-          lines.each do |lineno|
-            reindent_line(corrector, lineno, delta, buffer)
-          end
+          lines.each { |lineno| reindent_line(corrector, lineno, delta, buffer) }
         end
 
         def actual_indent(lines, buffer)
@@ -230,8 +226,7 @@ module RuboCop
           if adjustment.positive?
             corrector.remove_leading(buffer.line_range(lineno), adjustment)
           elsif adjustment.negative?
-            corrector.insert_before(buffer.line_range(lineno),
-                                    ' ' * -adjustment)
+            corrector.insert_before(buffer.line_range(lineno), ' ' * -adjustment)
           end
         end
       end

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

@@ -37,7 +37,10 @@ module RuboCop
 
         RESTRICT_ON_SEND = %i[== === nil?].freeze
 
+        # @!method nil_comparison?(node)
         def_node_matcher :nil_comparison?, '(send _ {:== :===} nil)'
+
+        # @!method nil_check?(node)
         def_node_matcher :nil_check?, '(send _ :nil?)'
 
         def on_send(node)

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

@@ -28,6 +28,7 @@ module RuboCop
 
         MSG = 'Use an empty lambda instead of always returning nil.'
 
+        # @!method nil_return?(node)
         def_node_matcher :nil_return?, <<~PATTERN
           { ({return next break} nil) (nil) }
         PATTERN

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

@@ -49,9 +49,16 @@ module RuboCop
 
         RESTRICT_ON_SEND = %i[!= nil? !].freeze
 
+        # @!method not_equal_to_nil?(node)
         def_node_matcher :not_equal_to_nil?, '(send _ :!= nil)'
+
+        # @!method unless_check?(node)
         def_node_matcher :unless_check?, '(if (send _ :nil?) ...)'
+
+        # @!method nil_check?(node)
         def_node_matcher :nil_check?, '(send _ :nil?)'
+
+        # @!method not_and_nil_check?(node)
         def_node_matcher :not_and_nil_check?, '(send (send _ :nil?) :!)'
 
         def on_send(node)
@@ -60,9 +67,7 @@ module RuboCop
           return unless register_offense?(node)
 
           message = message(node)
-          add_offense(node, message: message) do |corrector|
-            autocorrect(corrector, node)
-          end
+          add_offense(node, message: message) { |corrector| autocorrect(corrector, node) }
         end
 
         def on_def(node)
@@ -99,8 +104,7 @@ module RuboCop
         def unless_and_nil_check?(send_node)
           parent = send_node.parent
 
-          nil_check?(send_node) && unless_check?(parent) && !parent.ternary? &&
-            parent.unless?
+          nil_check?(send_node) && unless_check?(parent) && !parent.ternary? && parent.unless?
         end
 
         def message(node)

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
@@ -70,9 +69,7 @@ module RuboCop
         end
 
         def register_offense(node)
-          add_offense(node) do |corrector|
-            corrector.replace(node, format_number(node))
-          end
+          add_offense(node) { |corrector| corrector.replace(node, format_number(node)) }
         end
 
         def short_group_regex
@@ -95,12 +92,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

@@ -48,11 +48,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 +84,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 +110,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

@@ -18,13 +18,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/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)
@@ -158,9 +160,10 @@ module RuboCop
           # 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

@@ -72,9 +72,7 @@ module RuboCop
         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)

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

@@ -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

@@ -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/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