rubocop 1.10.0 → 1.14.0

data/lib/rubocop/cop/mixin/multiline_literal_brace_layout.rb

@@ -24,8 +24,7 @@ module RuboCop
       #    b # comment
       #   ].some_method
       def new_line_needed_before_closing_brace?(node)
-        last_element_line =
-          last_element_range_with_trailing_comma(node).last_line
+        last_element_line = last_element_range_with_trailing_comma(node).last_line
 
         last_element_commented = processed_source.comment_at_line(last_element_line)
 

data/lib/rubocop/cop/mixin/negative_conditional.rb

@@ -7,12 +7,14 @@ module RuboCop
     module NegativeConditional
       extend NodePattern::Macros
 
-      MSG = 'Favor `%<inverse>s` over `%<current>s` for ' \
-            'negative conditions.'
+      MSG = 'Favor `%<inverse>s` over `%<current>s` for negative conditions.'
 
       private
 
+      # @!method single_negative?(node)
       def_node_matcher :single_negative?, '(send !(send _ :!) :!)'
+
+      # @!method empty_condition?(node)
       def_node_matcher :empty_condition?, '(begin)'
 
       def check_negative_conditional(node, message:, &block)

data/lib/rubocop/cop/mixin/ordered_gem_node.rb

@@ -25,10 +25,7 @@ module RuboCop
       end
 
       def consecutive_lines(previous, current)
-        first_line = get_source_range(
-          current,
-          treat_comments_as_separators
-        ).first_line
+        first_line = get_source_range(current, treat_comments_as_separators).first_line
         previous.source_range.last_line == first_line - 1
       end
 

data/lib/rubocop/cop/mixin/percent_array.rb

@@ -37,9 +37,7 @@ module RuboCop
 
         return unless style == :brackets
 
-        add_offense(node) do |corrector|
-          correct_bracketed(corrector, node)
-        end
+        add_offense(node) { |corrector| correct_bracketed(corrector, node) }
       end
 
       def check_bracketed_array(node, literal_prefix)

data/lib/rubocop/cop/mixin/percent_literal.rb

@@ -27,12 +27,6 @@ module RuboCop
       def type(node)
         node.loc.begin.source[0..-2]
       end
-
-      # A range containing only the contents of the percent literal (e.g. in
-      # %i{1 2 3} this will be the range covering '1 2 3' only)
-      def contents_range(node)
-        range_between(node.loc.begin.end_pos, node.loc.end.begin_pos)
-      end
     end
   end
 end

data/lib/rubocop/cop/mixin/preceding_following_alignment.rb

@@ -50,9 +50,7 @@ module RuboCop
       end
 
       def aligned_with_any_line?(line_ranges, range, indent = nil, &predicate)
-        line_ranges.any? do |line_nos|
-          aligned_with_line?(line_nos, range, indent, &predicate)
-        end
+        line_ranges.any? { |line_nos| aligned_with_line?(line_nos, range, indent, &predicate) }
       end
 
       def aligned_with_line?(line_nos, range, indent = nil)
@@ -103,15 +101,13 @@ module RuboCop
       end
 
       def aligned_with_assignment(token, line_range)
-        token_line_indent    = processed_source
-                               .line_indentation(token.line)
+        token_line_indent    = processed_source.line_indentation(token.line)
         assignment_lines     = relevant_assignment_lines(line_range)
         relevant_line_number = assignment_lines[1]
 
         return :none unless relevant_line_number
 
-        relevant_indent = processed_source
-                          .line_indentation(relevant_line_number)
+        relevant_indent = processed_source.line_indentation(relevant_line_number)
 
         return :none if relevant_indent < token_line_indent
 
@@ -144,8 +140,7 @@ module RuboCop
       # rubocop:disable Metrics/PerceivedComplexity, Metrics/MethodLength
       def relevant_assignment_lines(line_range)
         result                        = []
-        original_line_indent          = processed_source
-                                        .line_indentation(line_range.first)
+        original_line_indent          = processed_source.line_indentation(line_range.first)
         relevant_line_indent_at_level = true
 
         line_range.each do |line_number|
@@ -161,8 +156,7 @@ module RuboCop
                                    current_line_indent == original_line_indent
 
           unless blank_line
-            relevant_line_indent_at_level = \
-              current_line_indent == original_line_indent
+            relevant_line_indent_at_level = current_line_indent == original_line_indent
           end
         end
 

data/lib/rubocop/cop/mixin/preferred_delimiters.rb

@@ -15,18 +15,16 @@ module RuboCop
       end
 
       def delimiters
-        preferred_delimiters[type].split(//)
+        preferred_delimiters[type].chars
       end
 
       private
 
       def ensure_valid_preferred_delimiters
-        invalid = preferred_delimiters_config.keys -
-                  (PERCENT_LITERAL_TYPES + %w[default])
+        invalid = preferred_delimiters_config.keys - (PERCENT_LITERAL_TYPES + %w[default])
         return if invalid.empty?
 
-        raise ArgumentError,
-              "Invalid preferred delimiter config key: #{invalid.join(', ')}"
+        raise ArgumentError, "Invalid preferred delimiter config key: #{invalid.join(', ')}"
       end
 
       def preferred_delimiters
@@ -36,8 +34,7 @@ module RuboCop
 
             if preferred_delimiters_config.key?('default')
               PERCENT_LITERAL_TYPES.map do |type|
-                [type, preferred_delimiters_config[type] ||
-                  preferred_delimiters_config['default']]
+                [type, preferred_delimiters_config[type] || preferred_delimiters_config['default']]
               end.to_h
             else
               preferred_delimiters_config

data/lib/rubocop/cop/mixin/range_help.rb

@@ -27,6 +27,12 @@ module RuboCop
         Parser::Source::Range.new(source_buffer, begin_pos, end_pos)
       end
 
+      # A range containing only the contents of a literal with delimiters (e.g. in
+      # `%i{1 2 3}` this will be the range covering `1 2 3` only).
+      def contents_range(node)
+        range_between(node.loc.begin.end_pos, node.loc.end.begin_pos)
+      end
+
       def range_between(start_pos, end_pos)
         Parser::Source::Range.new(processed_source.buffer, start_pos, end_pos)
       end
@@ -54,15 +60,9 @@ module RuboCop
         go_left, go_right = directions(side)
 
         begin_pos = range.begin_pos
-        if go_left
-          begin_pos =
-            final_pos(src, begin_pos, -1, continuations, newlines, whitespace)
-        end
+        begin_pos = final_pos(src, begin_pos, -1, continuations, newlines, whitespace) if go_left
         end_pos = range.end_pos
-        if go_right
-          end_pos =
-            final_pos(src, end_pos, 1, continuations, newlines, whitespace)
-        end
+        end_pos = final_pos(src, end_pos, 1, continuations, newlines, whitespace) if go_right
         Parser::Source::Range.new(buffer, begin_pos, end_pos)
       end
 
@@ -73,9 +73,7 @@ module RuboCop
         end_offset = last_line.length - range.last_column
         end_offset += 1 if include_final_newline
 
-        range
-          .adjust(begin_pos: -range.column, end_pos: end_offset)
-          .intersect(buffer.source_range)
+        range.adjust(begin_pos: -range.column, end_pos: end_offset).intersect(buffer.source_range)
       end
 
       def column_offset_between(base_range, range)
@@ -89,8 +87,7 @@ module RuboCop
       # line, in which case 1 is subtracted from the column value. This gives
       # the column as it appears when viewing the file in an editor.
       def effective_column(range)
-        if range.line == 1 &&
-           @processed_source.raw_source.codepoints.first == BYTE_ORDER_MARK
+        if range.line == 1 && @processed_source.raw_source.codepoints.first == BYTE_ORDER_MARK
           range.column - 1
         else
           range.column

data/lib/rubocop/cop/mixin/rational_literal.rb

@@ -8,6 +8,7 @@ module RuboCop
 
       private
 
+      # @!method rational_literal?(node)
       def_node_matcher :rational_literal?, <<~PATTERN
         (send
           (int _) :/

data/lib/rubocop/cop/mixin/rescue_node.rb

@@ -5,17 +5,13 @@ module RuboCop
     # Common functionality for checking `rescue` nodes.
     module RescueNode
       def on_new_investigation
-        @modifier_locations = processed_source
-                              .tokens
-                              .select(&:rescue_modifier?)
-                              .map(&:pos)
+        @modifier_locations = processed_source.tokens.select(&:rescue_modifier?).map(&:pos)
       end
 
       private
 
       def rescue_modifier?(node)
-        node&.resbody_type? &&
-          @modifier_locations.include?(node.loc.keyword)
+        node&.resbody_type? && @modifier_locations.include?(node.loc.keyword)
       end
 
       # @deprecated Use ResbodyNode#exceptions instead

data/lib/rubocop/cop/mixin/safe_assignment.rb

@@ -10,10 +10,14 @@ module RuboCop
 
       private
 
+      # @!method empty_condition?(node)
       def_node_matcher :empty_condition?, '(begin)'
+
+      # @!method setter_method?(node)
       def_node_matcher :setter_method?, '[(send ...) setter_method?]'
-      def_node_matcher :safe_assignment?,
-                       '(begin {equals_asgn? #setter_method?})'
+
+      # @!method safe_assignment?(node)
+      def_node_matcher :safe_assignment?, '(begin {equals_asgn? #setter_method?})'
 
       def safe_assignment_allowed?
         cop_config['AllowSafeAssignment']

data/lib/rubocop/cop/mixin/space_after_punctuation.rb

@@ -28,13 +28,11 @@ module RuboCop
       end
 
       def space_missing?(token1, token2)
-        token1.line == token2.line &&
-          token2.column == token1.column + offset
+        token1.line == token2.line && token2.column == token1.column + offset
       end
 
       def space_required_before?(token)
-        !(allowed_type?(token) ||
-          (token.right_curly_brace? && space_forbidden_before_rcurly?))
+        !(allowed_type?(token) || (token.right_curly_brace? && space_forbidden_before_rcurly?))
       end
 
       def allowed_type?(token)

data/lib/rubocop/cop/mixin/space_before_punctuation.rb

@@ -25,8 +25,7 @@ module RuboCop
           next unless space_missing?(token1, token2)
           next if space_required_after?(token1)
 
-          pos_before_punctuation = range_between(token1.end_pos,
-                                                 token2.begin_pos)
+          pos_before_punctuation = range_between(token1.end_pos, token2.begin_pos)
 
           yield token2, pos_before_punctuation
         end

data/lib/rubocop/cop/mixin/statement_modifier.rb

@@ -48,9 +48,7 @@ module RuboCop
       end
 
       def to_modifier_form(node)
-        expression = [node.body.source,
-                      node.keyword,
-                      node.condition.source].compact.join(' ')
+        expression = [node.body.source, node.keyword, node.condition.source].compact.join(' ')
         parenthesized = parenthesize?(node) ? "(#{expression})" : expression
         [parenthesized, first_line_comment(node)].compact.join(' ')
       end

data/lib/rubocop/cop/mixin/string_literals_help.rb

@@ -15,7 +15,7 @@ module RuboCop
         if style == :single_quotes
           !double_quotes_required?(src)
         else
-          !/" | \\[^'] | \#(@|\{)/x.match?(src)
+          !/" | \\[^'\\] | \#[@{$]/x.match?(src)
         end
       end
     end

data/lib/rubocop/cop/mixin/trailing_body.rb

@@ -6,8 +6,7 @@ module RuboCop
     module TrailingBody
       def trailing_body?(node)
         body = node.to_a.reverse[0]
-        body && node.multiline? &&
-          body_on_first_line?(node, body)
+        body && node.multiline? && body_on_first_line?(node, body)
       end
 
       def body_on_first_line?(node, body)

data/lib/rubocop/cop/mixin/trailing_comma.rb

@@ -95,8 +95,7 @@ module RuboCop
 
         line = node.loc.selector.nil? ? node.loc.line : node.loc.selector.line
 
-        line == node.last_argument.last_line &&
-          node.last_line == node.last_argument.last_line
+        line == node.last_argument.last_line && node.last_line == node.last_argument.last_line
       end
 
       # A single argument with the closing bracket on the same line as the end

data/lib/rubocop/cop/mixin/uncommunicative_name.rb

@@ -6,10 +6,8 @@ module RuboCop
     module UncommunicativeName
       CASE_MSG = 'Only use lowercase characters for %<name_type>s.'
       NUM_MSG = 'Do not end %<name_type>s with a number.'
-      LENGTH_MSG = '%<name_type>s must be at least %<min>s ' \
-                   'characters long.'
-      FORBIDDEN_MSG = 'Do not use %<name>s as a name for a ' \
-                      '%<name_type>s.'
+      LENGTH_MSG = '%<name_type>s must be at least %<min>s characters long.'
+      FORBIDDEN_MSG = 'Do not use %<name>s as a name for a %<name_type>s.'
 
       def check(node, args)
         args.each do |arg|
@@ -53,12 +51,10 @@ module RuboCop
       end
 
       def name_type(node)
-        @name_type ||= begin
-          case node.type
-          when :block then 'block parameter'
-          when :def, :defs then 'method parameter'
-          end
-        end
+        @name_type ||= case node.type
+                       when :block then 'block parameter'
+                       when :def, :defs then 'method parameter'
+                       end
       end
 
       def num_offense(node, range)
@@ -81,9 +77,7 @@ module RuboCop
 
       def arg_range(arg, length)
         begin_pos = arg.source_range.begin_pos
-        Parser::Source::Range.new(processed_source.buffer,
-                                  begin_pos,
-                                  begin_pos + length)
+        Parser::Source::Range.new(processed_source.buffer, begin_pos, begin_pos + length)
       end
 
       def forbidden_offense(node, range, name)

data/lib/rubocop/cop/mixin/unused_argument.rb

@@ -8,9 +8,7 @@ module RuboCop
         extend NodePattern::Macros
 
         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

data/lib/rubocop/cop/mixin/visibility_help.rb

@@ -28,6 +28,7 @@ module RuboCop
         end || right.last
       end
 
+      # @!method visibility_block?(node)
       def_node_matcher :visibility_block?, <<~PATTERN
         (send nil? { :private :protected :public })
       PATTERN

data/lib/rubocop/cop/naming/ascii_identifiers.rb

@@ -70,16 +70,14 @@ module RuboCop
         private
 
         def should_check?(token)
-          token.type == :tIDENTIFIER ||
-            (token.type == :tCONSTANT && cop_config['AsciiConstants'])
+          token.type == :tIDENTIFIER || (token.type == :tCONSTANT && cop_config['AsciiConstants'])
         end
 
         def first_offense_range(identifier)
           expression    = identifier.pos
           first_offense = first_non_ascii_chars(identifier.text)
 
-          start_position = expression.begin_pos +
-                           identifier.text.index(first_offense)
+          start_position = expression.begin_pos + identifier.text.index(first_offense)
           end_position   = start_position + first_offense.length
 
           range_between(start_position, end_position)

data/lib/rubocop/cop/naming/binary_operator_parameter_name.rb

@@ -16,12 +16,12 @@ module RuboCop
       class BinaryOperatorParameterName < Base
         extend AutoCorrector
 
-        MSG = 'When defining the `%<opr>s` operator, ' \
-              'name its argument `other`.'
+        MSG = 'When defining the `%<opr>s` operator, name its argument `other`.'
 
         OP_LIKE_METHODS = %i[eql? equal?].freeze
         EXCLUDED = %i[+@ -@ [] []= << === ` =~].freeze
 
+        # @!method op_method_candidate?(node)
         def_node_matcher :op_method_candidate?, <<~PATTERN
           (def [#op_method? $_] (args $(arg [!:other !:_other])) _)
         PATTERN

data/lib/rubocop/cop/naming/constant_name.rb

@@ -23,6 +23,7 @@ module RuboCop
         # than just standard ASCII characters
         SNAKE_CASE = /^[[:digit:][:upper:]_]+$/.freeze
 
+        # @!method class_or_struct_return_method?(node)
         def_node_matcher :class_or_struct_return_method?, <<~PATTERN
           (send
             (const _ {:Class :Struct}) :new
@@ -64,6 +65,7 @@ module RuboCop
             (node.receiver.nil? || !literal_receiver?(node))
         end
 
+        # @!method literal_receiver?(node)
         def_node_matcher :literal_receiver?, <<~PATTERN
           {(send literal? ...)
            (send (begin literal?) ...)}

data/lib/rubocop/cop/naming/file_name.rb

@@ -27,22 +27,17 @@ module RuboCop
       class FileName < Base
         include RangeHelp
 
-        MSG_SNAKE_CASE = 'The name of this source file (`%<basename>s`) ' \
-                         'should use snake_case.'
-        MSG_NO_DEFINITION = '%<basename>s should define a class or module ' \
-                            'called `%<namespace>s`.'
+        MSG_SNAKE_CASE = 'The name of this source file (`%<basename>s`) should use snake_case.'
+        MSG_NO_DEFINITION = '%<basename>s should define a class or module called `%<namespace>s`.'
         MSG_REGEX = '`%<basename>s` should match `%<regex>s`.'
 
         SNAKE_CASE = /^[\d[[:lower:]]_.?!]+$/.freeze
 
         def on_new_investigation
           file_path = processed_source.file_path
-          return if config.file_to_exclude?(file_path) ||
-                    config.allowed_camel_case_file?(file_path)
+          return if config.file_to_exclude?(file_path) || config.allowed_camel_case_file?(file_path)
 
-          for_bad_filename(file_path) do |range, msg|
-            add_offense(range, message: msg)
-          end
+          for_bad_filename(file_path) { |range, msg| add_offense(range, message: msg) }
         end
 
         private
@@ -62,8 +57,7 @@ module RuboCop
         def perform_class_and_module_naming_checks(file_path, basename)
           return unless expect_matching_definition?
 
-          if check_definition_path_hierarchy? &&
-             !matching_definition?(file_path)
+          if check_definition_path_hierarchy? && !matching_definition?(file_path)
             msg = no_definition_message(basename, file_path)
           elsif !matching_class?(basename)
             msg = no_definition_message(basename, basename)
@@ -136,8 +130,7 @@ module RuboCop
 
             const_namespace, const_name = *const
             next if name != const_name && !match_acronym?(name, const_name)
-            next unless namespace.empty? ||
-                        match_namespace(child, const_namespace, namespace)
+            next unless namespace.empty? || match_namespace(child, const_namespace, namespace)
 
             return node
           end
@@ -181,9 +174,7 @@ module RuboCop
           expected = expected.to_s
           name = name.to_s
 
-          allowed_acronyms.any? do |acronym|
-            expected.gsub(acronym.capitalize, acronym) == name
-          end
+          allowed_acronyms.any? { |acronym| expected.gsub(acronym.capitalize, acronym) == name }
         end
 
         def to_namespace(path)