rubocop 1.15.0 → 1.18.1

data/lib/rubocop/cop/bundler/duplicated_gem.rb

@@ -39,7 +39,7 @@ module RuboCop
         include RangeHelp
 
         MSG = 'Gem `%<gem_name>s` requirements already given on line '\
-          '%<line_of_first_occurrence>d of the Gemfile.'
+              '%<line_of_first_occurrence>d of the Gemfile.'
 
         def on_new_investigation
           return if processed_source.blank?

data/lib/rubocop/cop/bundler/gem_version.rb

@@ -3,8 +3,8 @@
 module RuboCop
   module Cop
     module Bundler
-      # Enforce that Gem version specifications are either required
-      # or forbidden.
+      # Enforce that Gem version specifications or a commit reference (branch,
+      # ref, or tag) are either required or forbidden.
       #
       # @example EnforcedStyle: required (default)
       #  # bad
@@ -19,6 +19,15 @@ module RuboCop
       #  # good
       #  gem 'rubocop', '>= 1.5.0', '< 1.10.0'
       #
+      #  # good
+      #  gem 'rubocop', branch: 'feature-branch'
+      #
+      #  # good
+      #  gem 'rubocop', ref: '74b5bfbb2c4b6fd6cdbbc7254bd7084b36e0c85b'
+      #
+      #  # good
+      #  gem 'rubocop', tag: 'v1.17.0'
+      #
       # @example EnforcedStyle: forbidden
       #  # good
       #  gem 'rubocop'
@@ -32,6 +41,15 @@ module RuboCop
       #  # bad
       #  gem 'rubocop', '>= 1.5.0', '< 1.10.0'
       #
+      #  # bad
+      #  gem 'rubocop', branch: 'feature-branch'
+      #
+      #  # bad
+      #  gem 'rubocop', ref: '74b5bfbb2c4b6fd6cdbbc7254bd7084b36e0c85b'
+      #
+      #  # bad
+      #  gem 'rubocop', tag: 'v1.17.0'
+      #
       class GemVersion < Base
         include ConfigurableEnforcedStyle
         include GemDeclaration
@@ -45,6 +63,11 @@ module RuboCop
           (send nil? :gem <(str #version_specification?) ...>)
         PATTERN
 
+        # @!method includes_commit_reference?(node)
+        def_node_matcher :includes_commit_reference?, <<~PATTERN
+          (send nil? :gem <(hash <(pair (sym {:branch :ref :tag}) (str _)) ...>) ...>)
+        PATTERN
+
         def on_send(node)
           return unless gem_declaration?(node)
           return if allowed_gem?(node)
@@ -78,8 +101,19 @@ module RuboCop
         end
 
         def offense?(node)
-          (required_style? && !includes_version_specification?(node)) ||
-            (forbidden_style? && includes_version_specification?(node))
+          required_offense?(node) || forbidden_offense?(node)
+        end
+
+        def required_offense?(node)
+          return unless required_style?
+
+          !includes_version_specification?(node) && !includes_commit_reference?(node)
+        end
+
+        def forbidden_offense?(node)
+          return unless forbidden_style?
+
+          includes_version_specification?(node) || includes_commit_reference?(node)
         end
 
         def forbidden_style?

data/lib/rubocop/cop/corrector.rb

@@ -32,7 +32,7 @@ module RuboCop
 
       # Removes `size` characters prior to the source range.
       #
-      # @param [Parser::Source::Range, Rubocop::AST::Node] range or node
+      # @param [Parser::Source::Range, RuboCop::AST::Node] range or node
       # @param [Integer] size
       def remove_preceding(node_or_range, size)
         range = to_range(node_or_range)
@@ -44,7 +44,7 @@ module RuboCop
       # If `size` is greater than the size of `range`, the removed region can
       # overrun the end of `range`.
       #
-      # @param [Parser::Source::Range, Rubocop::AST::Node] range or node
+      # @param [Parser::Source::Range, RuboCop::AST::Node] range or node
       # @param [Integer] size
       def remove_leading(node_or_range, size)
         range = to_range(node_or_range)
@@ -56,7 +56,7 @@ module RuboCop
       # If `size` is greater than the size of `range`, the removed region can
       # overrun the beginning of `range`.
       #
-      # @param [Parser::Source::Range, Rubocop::AST::Node] range or node
+      # @param [Parser::Source::Range, RuboCop::AST::Node] range or node
       # @param [Integer] size
       def remove_trailing(node_or_range, size)
         range = to_range(node_or_range)
@@ -90,7 +90,7 @@ module RuboCop
                 else
                   raise TypeError,
                         'Expected a Parser::Source::Range, Comment or ' \
-                        "Rubocop::AST::Node, got #{node_or_range.class}"
+                        "RuboCop::AST::Node, got #{node_or_range.class}"
                 end
         validate_buffer(range.source_buffer)
         range

data/lib/rubocop/cop/generator.rb

@@ -104,7 +104,7 @@ module RuboCop
 
       CONFIGURATION_ADDED_MESSAGE =
         '[modify] A configuration for the cop is added into ' \
-          '%<configuration_file_path>s.'
+        '%<configuration_file_path>s.'
 
       def initialize(name, github_user, output: $stdout)
         @badge = Badge.parse(name)

data/lib/rubocop/cop/internal_affairs/node_matcher_directive.rb

@@ -25,7 +25,7 @@ module RuboCop
 
         MSG = 'Preceed `%<method>s` with a `@!method` YARD directive.'
         MSG_WRONG_NAME = '`@!method` YARD directive has invalid method name, ' \
-          'use `%<expected>s` instead of `%<actual>s`.'
+                         'use `%<expected>s` instead of `%<actual>s`.'
         MSG_TOO_MANY = 'Multiple `@!method` YARD directives found for this matcher.'
 
         RESTRICT_ON_SEND = %i[def_node_matcher def_node_search].to_set.freeze

data/lib/rubocop/cop/layout/argument_alignment.rb

@@ -50,14 +50,15 @@ module RuboCop
         ALIGN_PARAMS_MSG = 'Align the arguments of a method call if they span more than one line.'
 
         FIXED_INDENT_MSG = 'Use one level of indentation for arguments ' \
-          'following the first line of a multi-line method call.'
+                           'following the first line of a multi-line method call.'
 
         def on_send(node)
           first_arg = node.first_argument
           return if !multiple_arguments?(node, first_arg) || node.send_type? && node.method?(:[]=)
 
-          if first_arg.hash_type?
-            check_alignment(first_arg.pairs, base_column(node, first_arg.pairs.first))
+          if first_arg.hash_type? && !first_arg.braces?
+            pairs = first_arg.pairs
+            check_alignment(pairs, base_column(node, pairs.first))
           else
             check_alignment(node.arguments, base_column(node, first_arg))
           end

data/lib/rubocop/cop/layout/array_alignment.rb

@@ -38,10 +38,10 @@ module RuboCop
         extend AutoCorrector
 
         ALIGN_ELEMENTS_MSG = 'Align the elements of an array literal ' \
-          'if they span more than one line.'
+                             'if they span more than one line.'
 
         FIXED_INDENT_MSG = 'Use one level of indentation for elements ' \
-          'following the first line of a multi-line array.'
+                           'following the first line of a multi-line array.'
 
         def on_array(node)
           return if node.children.size < 2

data/lib/rubocop/cop/layout/block_alignment.rb

@@ -210,7 +210,7 @@ module RuboCop
 
         def format_source_line_column(source_line_column)
           "`#{source_line_column[:source]}` at #{source_line_column[:line]}, " \
-          "#{source_line_column[:column]}"
+            "#{source_line_column[:column]}"
         end
 
         def compute_start_col(ancestor_node, node)

data/lib/rubocop/cop/layout/case_indentation.rb

@@ -3,10 +3,10 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop checks how the ``when``s of a `case` expression
+      # This cop checks how the `when` and `in`s of a `case` expression
       # are indented in relation to its `case` or `end` keyword.
       #
-      # It will register a separate offense for each misaligned `when`.
+      # It will register a separate offense for each misaligned `when` and `in`.
       #
       # @example
       #   # If Layout/EndAlignment is set to keyword style (default)
@@ -22,6 +22,13 @@ module RuboCop
       #       y / 3
       #   end
       #
+      #   case n
+      #     in pattern
+      #       x * 2
+      #     else
+      #       y / 3
+      #   end
+      #
       #   # good for all styles
       #   case n
       #   when 0
@@ -30,6 +37,13 @@ module RuboCop
       #     y / 3
       #   end
       #
+      #   case n
+      #   in pattern
+      #     x * 2
+      #   else
+      #     y / 3
+      #   end
+      #
       # @example EnforcedStyle: case (default)
       #   # if EndAlignment is set to other style such as
       #   # start_of_line (as shown below), then *when* alignment
@@ -43,6 +57,13 @@ module RuboCop
       #     y / 3
       #   end
       #
+      #   a = case n
+      #   in pattern
+      #     x * 2
+      #   else
+      #     y / 3
+      #   end
+      #
       #   # good
       #   a = case n
       #       when 0
@@ -51,6 +72,13 @@ module RuboCop
       #         y / 3
       #   end
       #
+      #   a = case n
+      #       in pattern
+      #         x * 2
+      #       else
+      #         y / 3
+      #   end
+      #
       # @example EnforcedStyle: end
       #   # bad
       #   a = case n
@@ -60,6 +88,13 @@ module RuboCop
       #         y / 3
       #   end
       #
+      #   a = case n
+      #       in pattern
+      #         x * 2
+      #       else
+      #         y / 3
+      #   end
+      #
       #   # good
       #   a = case n
       #   when 0
@@ -67,30 +102,43 @@ module RuboCop
       #   else
       #     y / 3
       #   end
+      #
+      #   a = case n
+      #   in pattern
+      #     x * 2
+      #   else
+      #     y / 3
+      #   end
       class CaseIndentation < Base
         include Alignment
         include ConfigurableEnforcedStyle
         include RangeHelp
         extend AutoCorrector
 
-        MSG = 'Indent `when` %<depth>s `%<base>s`.'
+        MSG = 'Indent `%<branch_type>s` %<depth>s `%<base>s`.'
 
         def on_case(case_node)
           return if case_node.single_line?
 
-          case_node.each_when { |when_node| check_when(when_node) }
+          case_node.each_when { |when_node| check_when(when_node, 'when') }
+        end
+
+        def on_case_match(case_match_node)
+          return if case_match_node.single_line?
+
+          case_match_node.each_in_pattern { |in_pattern_node| check_when(in_pattern_node, 'in') }
         end
 
         private
 
-        def check_when(when_node)
+        def check_when(when_node, branch_type)
           when_column = when_node.loc.keyword.column
           base_column = base_column(when_node.parent, style)
 
           if when_column == base_column + indentation_width
             correct_style_detected
           else
-            incorrect_style(when_node)
+            incorrect_style(when_node, branch_type)
           end
         end
 
@@ -102,9 +150,9 @@ module RuboCop
           indent_one_step? ? configured_indentation_width : 0
         end
 
-        def incorrect_style(when_node)
+        def incorrect_style(when_node, branch_type)
           depth = indent_one_step? ? 'one step more than' : 'as deep as'
-          message = format(MSG, depth: depth, base: style)
+          message = format(MSG, branch_type: branch_type, depth: depth, base: style)
 
           add_offense(when_node.loc.keyword, message: message) do |corrector|
             detect_incorrect_style(when_node)
@@ -141,7 +189,7 @@ module RuboCop
         end
 
         def replacement(node)
-          case_node = node.each_ancestor(:case).first
+          case_node = node.each_ancestor(:case, :case_match).first
           base_type = cop_config[style_parameter_name] == 'end' ? :end : :case
 
           column = base_column(case_node, base_type)

data/lib/rubocop/cop/layout/closing_parenthesis_indentation.rb

@@ -155,7 +155,13 @@ module RuboCop
         end
 
         def all_elements_aligned?(elements)
-          elements.map { |e| e.loc.column }.uniq.count == 1
+          elements.flat_map do |e|
+            if e.hash_type?
+              e.each_pair.map { |pair| pair.loc.column }
+            else
+              e.loc.column
+            end
+          end.uniq.count == 1
         end
 
         def first_argument_line(elements)

data/lib/rubocop/cop/layout/comment_indentation.rb

@@ -37,7 +37,7 @@ module RuboCop
         extend AutoCorrector
 
         MSG = 'Incorrect indentation detected (column %<column>d ' \
-          'instead of %<correct_comment_indentation>d).'
+              'instead of %<correct_comment_indentation>d).'
 
         def on_new_investigation
           processed_source.comments.each { |comment| check(comment) }

data/lib/rubocop/cop/layout/dot_position.rb

@@ -24,6 +24,7 @@ module RuboCop
       #     method
       class DotPosition < Base
         include ConfigurableEnforcedStyle
+        include RangeHelp
         extend AutoCorrector
 
         def on_send(node)
@@ -42,7 +43,12 @@ module RuboCop
         private
 
         def autocorrect(corrector, dot, node)
-          corrector.remove(dot)
+          dot_range = if processed_source[dot.line - 1].strip == '.'
+                        range_by_whole_lines(dot, include_final_newline: true)
+                      else
+                        dot
+                      end
+          corrector.remove(dot_range)
           case style
           when :leading
             corrector.insert_before(selector_range(node), dot.source)

data/lib/rubocop/cop/layout/empty_line_after_guard_clause.rb

@@ -45,8 +45,7 @@ module RuboCop
         def on_if(node)
           return if correct_style?(node)
 
-          if node.modifier_form? && last_argument_is_heredoc?(node)
-            heredoc_node = last_heredoc_argument(node)
+          if node.modifier_form? && (heredoc_node = last_heredoc_argument(node))
             return if next_line_empty_or_enable_directive_comment?(heredoc_line(node, heredoc_node))
 
             add_offense(heredoc_node.loc.heredoc_end) do |corrector|
@@ -62,7 +61,7 @@ module RuboCop
         private
 
         def autocorrect(corrector, node)
-          node_range = if node.respond_to?(:heredoc?) && node.heredoc?
+          node_range = if heredoc?(node)
                          range_by_whole_lines(node.loc.heredoc_body)
                        else
                          range_by_whole_lines(node.source_range)
@@ -125,19 +124,8 @@ module RuboCop
           next_sibling.if_type? && contains_guard_clause?(next_sibling)
         end
 
-        def last_argument_is_heredoc?(node)
-          last_children = node.if_branch
-          return false unless last_children&.send_type?
-
-          heredoc?(last_heredoc_argument(node))
-        end
-
         def last_heredoc_argument(node)
-          n = if node.respond_to?(:if_branch)
-                node.if_branch.children.last
-              else
-                node
-              end
+          n = last_heredoc_argument_node(node)
 
           return n if heredoc?(n)
           return unless n.respond_to?(:arguments)
@@ -150,6 +138,16 @@ module RuboCop
           return last_heredoc_argument(n.receiver) if n.respond_to?(:receiver)
         end
 
+        def last_heredoc_argument_node(node)
+          return node unless node.respond_to?(:if_branch)
+
+          if node.if_branch.and_type?
+            node.if_branch.children.first
+          else
+            node.if_branch.children.last
+          end
+        end
+
         def heredoc_line(node, heredoc_node)
           heredoc_body = heredoc_node.loc.heredoc_body
           num_of_heredoc_lines = heredoc_body.last_line - heredoc_body.first_line

data/lib/rubocop/cop/layout/first_array_element_indentation.rb

@@ -161,10 +161,10 @@ module RuboCop
             'Indent the right bracket the same as the left bracket.'
           elsif style == :special_inside_parentheses && left_parenthesis
             'Indent the right bracket the same as the first position ' \
-            'after the preceding left parenthesis.'
+              'after the preceding left parenthesis.'
           else
             'Indent the right bracket the same as the start of the line' \
-            ' where the left bracket is.'
+              ' where the left bracket is.'
           end
         end
       end