rubocop 1.30.1 → 1.64.0

data/lib/rubocop/cop/correctors/multiline_literal_brace_corrector.rb

@@ -28,7 +28,10 @@ module RuboCop
           # put the comment.
           return if new_line_needed_before_closing_brace?(node)
 
-          correct_next_line_brace(corrector)
+          end_range = last_element_range_with_trailing_comma(node).end
+
+          correct_next_line_brace(corrector, end_range)
+          correct_heredoc_argument_method_chain(corrector, end_range)
         end
       end
 
@@ -40,18 +43,24 @@ module RuboCop
         corrector.insert_before(node.loc.end, "\n")
       end
 
-      def correct_next_line_brace(corrector)
-        corrector.remove(range_with_surrounding_space(range: node.loc.end, side: :left))
+      def correct_next_line_brace(corrector, end_range)
+        corrector.remove(range_with_surrounding_space(node.loc.end, side: :left))
+        corrector.insert_before(end_range, content_if_comment_present(corrector, node))
+      end
+
+      def correct_heredoc_argument_method_chain(corrector, end_range)
+        return unless (parent = node.parent)
+        return unless use_heredoc_argument_method_chain?(parent)
 
-        corrector.insert_before(
-          last_element_range_with_trailing_comma(node).end,
-          content_if_comment_present(corrector, node)
-        )
+        chained_method = range_between(parent.loc.dot.begin_pos, parent.source_range.end_pos)
+
+        corrector.remove(chained_method)
+        corrector.insert_after(end_range, chained_method.source)
       end
 
       def content_if_comment_present(corrector, node)
         range = range_with_surrounding_space(
-          range: children(node).last.source_range,
+          children(node).last.source_range,
           side: :right
         ).end.resize(1)
         if range.source == '#'
@@ -61,10 +70,17 @@ module RuboCop
         end
       end
 
+      def use_heredoc_argument_method_chain?(parent)
+        return false unless node.respond_to?(:first_argument)
+        return false unless (first_argument = node.first_argument)
+
+        parent.call_type? && first_argument.str_type? && first_argument.heredoc?
+      end
+
       def select_content_to_be_inserted_after_last_element(corrector, node)
         range = range_between(
           node.loc.end.begin_pos,
-          range_by_whole_lines(node.loc.expression).end.end_pos
+          range_by_whole_lines(node.source_range).end.end_pos
         )
 
         remove_trailing_content_of_comment(corrector, range)
@@ -86,7 +102,7 @@ module RuboCop
 
       def last_element_trailing_comma_range(node)
         range = range_with_surrounding_space(
-          range: children(node).last.source_range,
+          children(node).last.source_range,
           side: :right
         ).end.resize(1)
 

data/lib/rubocop/cop/correctors/ordered_gem_corrector.rb

@@ -18,7 +18,7 @@ module RuboCop
           current_range = declaration_with_comment(node)
           previous_range = declaration_with_comment(previous_declaration)
 
-          ->(corrector) { swap_range(corrector, current_range, previous_range) }
+          ->(corrector) { corrector.swap(current_range, previous_range) }
         end
 
         private
@@ -26,17 +26,12 @@ module RuboCop
         def declaration_with_comment(node)
           buffer = processed_source.buffer
           begin_pos = range_by_whole_lines(get_source_range(node, comments_as_separators)).begin_pos
-          end_line = buffer.line_for_position(node.loc.expression.end_pos)
+          end_line = buffer.line_for_position(node.source_range.end_pos)
           end_pos = range_by_whole_lines(buffer.line_range(end_line),
                                          include_final_newline: true).end_pos
 
           range_between(begin_pos, end_pos)
         end
-
-        def swap_range(corrector, range1, range2)
-          corrector.insert_before(range2, range1.source)
-          corrector.remove(range1)
-        end
       end
     end
   end

data/lib/rubocop/cop/correctors/parentheses_corrector.rb

@@ -5,9 +5,15 @@ module RuboCop
     # This autocorrects parentheses
     class ParenthesesCorrector
       class << self
+        include RangeHelp
+
+        COMMA_REGEXP = /(?<=\))\s*,/.freeze
+
         def correct(corrector, node)
           corrector.remove(node.loc.begin)
           corrector.remove(node.loc.end)
+          handle_orphaned_comma(corrector, node)
+
           return unless ternary_condition?(node) && next_char_is_question_mark?(node)
 
           corrector.insert_after(node.loc.end, ' ')
@@ -22,6 +28,58 @@ module RuboCop
         def next_char_is_question_mark?(node)
           node.loc.last_column == node.parent.loc.question.column
         end
+
+        def only_closing_paren_before_comma?(node)
+          source_buffer = node.source_range.source_buffer
+          line_range = source_buffer.line_range(node.loc.end.line)
+
+          line_range.source.start_with?(/\s*\)\s*,/)
+        end
+
+        # If removing parentheses leaves a comma on its own line, remove all the whitespace
+        # preceding it to prevent a syntax error.
+        def handle_orphaned_comma(corrector, node)
+          return unless only_closing_paren_before_comma?(node)
+
+          range = extend_range_for_heredoc(node, parens_range(node))
+          corrector.remove(range)
+
+          add_heredoc_comma(corrector, node)
+        end
+
+        # Get a range for the closing parenthesis and all whitespace to the left of it
+        def parens_range(node)
+          range_with_surrounding_space(
+            range: node.loc.end,
+            buffer: node.source_range.source_buffer,
+            side: :left,
+            newlines: true,
+            whitespace: true,
+            continuations: true
+          )
+        end
+
+        # If the node contains a heredoc, remove the comma too
+        # It'll be added back in the right place later
+        def extend_range_for_heredoc(node, range)
+          return range unless heredoc?(node)
+
+          comma_line = range_by_whole_lines(node.loc.end, buffer: node.source_range.source_buffer)
+          offset = comma_line.source.match(COMMA_REGEXP)[0]&.size || 0
+
+          range.adjust(end_pos: offset)
+        end
+
+        # Add a comma back after the heredoc identifier
+        def add_heredoc_comma(corrector, node)
+          return unless heredoc?(node)
+
+          corrector.insert_after(node.child_nodes.last, ',')
+        end
+
+        def heredoc?(node)
+          node.child_nodes.last.loc.is_a?(Parser::Source::Map::Heredoc)
+        end
       end
     end
   end

data/lib/rubocop/cop/correctors/percent_literal_corrector.rb

@@ -66,10 +66,10 @@ module RuboCop
         end
       end
 
-      def line_breaks(node, source, previous_line_num, base_line_num, node_indx)
+      def line_breaks(node, source, previous_line_num, base_line_num, node_index)
         source_in_lines = source.split("\n")
         if first_line?(node, previous_line_num)
-          node_indx.zero? && node.first_line == base_line_num ? '' : ' '
+          node_index.zero? && node.first_line == base_line_num ? '' : ' '
         else
           process_lines(node, previous_line_num, base_line_num, source_in_lines)
         end

data/lib/rubocop/cop/correctors/unused_arg_corrector.rb

@@ -29,7 +29,7 @@ module RuboCop
         end
 
         def correct_for_blockarg_type(corrector, node)
-          range = range_with_surrounding_space(range: node.source_range, side: :left)
+          range = range_with_surrounding_space(node.source_range, side: :left)
           range = range_with_surrounding_comma(range, :left)
 
           corrector.remove(range)

data/lib/rubocop/cop/documentation.rb

@@ -17,23 +17,33 @@ module RuboCop
         fragment = cop_class.cop_name.downcase.gsub(/[^a-z]/, '')
         base_url = base_url_for(cop_class, config)
 
-        "#{base_url}/#{base}.html##{fragment}"
+        "#{base_url}/#{base}.html##{fragment}" if base_url
       end
 
       # @api private
       def base_url_for(cop_class, config)
-        return default_base_url unless config
+        if config
+          department_name = cop_class.department.to_s
+          url = config.for_department(department_name)['DocumentationBaseURL']
+          return url if url
+        end
 
-        department_name = cop_class.department.to_s
-
-        config.for_department(department_name)['DocumentationBaseURL'] ||
-          config.for_all_cops['DocumentationBaseURL']
+        default_base_url if builtin?(cop_class)
       end
 
       # @api private
       def default_base_url
         'https://docs.rubocop.org/rubocop'
       end
+
+      # @api private
+      def builtin?(cop_class)
+        # any custom method will do
+        return false unless (m = cop_class.instance_methods(false).first)
+
+        path, _line = cop_class.instance_method(m).source_location
+        path.start_with?(__dir__)
+      end
     end
   end
 end

data/lib/rubocop/cop/exclude_limit.rb

@@ -8,7 +8,7 @@ module RuboCop
     # The parameter name given is transformed into a method name (eg. `Max`
     # becomes `self.max=` and `MinDigits` becomes `self.min_digits=`).
     def exclude_limit(parameter_name, method_name: transform(parameter_name))
-      define_method("#{method_name}=") do |value|
+      define_method(:"#{method_name}=") do |value|
         cfg = config_to_allow_offenses
         cfg[:exclude_limit] ||= {}
         current_max = cfg[:exclude_limit][parameter_name]

data/lib/rubocop/cop/gemspec/dependency_version.rb

@@ -58,8 +58,13 @@ module RuboCop
         FORBIDDEN_MSG = 'Dependency version specification is forbidden.'
         VERSION_SPECIFICATION_REGEX = /^\s*[~<>=]*\s*[0-9.]+/.freeze
 
-        # @!method add_dependency_method_declarations(node)
-        def_node_search :add_dependency_method_declarations, <<~PATTERN
+        ADD_DEPENDENCY_METHODS = %i[
+          add_dependency add_runtime_dependency add_development_dependency
+        ].freeze
+        RESTRICT_ON_SEND = ADD_DEPENDENCY_METHODS
+
+        # @!method add_dependency_method_declaration?(node)
+        def_node_matcher :add_dependency_method_declaration?, <<~PATTERN
           (send
             (lvar #match_block_variable_name?) #add_dependency_method? ...)
         PATTERN
@@ -74,38 +79,33 @@ module RuboCop
           (send _ #add_dependency_method? <(hash <(pair (sym {:branch :ref :tag}) (str _)) ...>) ...>)
         PATTERN
 
-        def on_new_investigation
-          return if processed_source.blank?
-
-          add_dependency_method_nodes.each do |node|
-            next if allowed_gem?(node)
+        def on_send(node)
+          return unless add_dependency_method_declaration?(node)
+          return if allowed_gem?(node)
 
-            if offense?(node)
-              add_offense(node)
-              opposite_style_detected
-            else
-              correct_style_detected
-            end
+          if offense?(node)
+            add_offense(node)
+            opposite_style_detected
+          else
+            correct_style_detected
           end
         end
 
         private
 
         def allowed_gem?(node)
-          allowed_gems.include?(node.first_argument.value)
+          allowed_gems.include?(node.first_argument.str_content)
         end
 
         def allowed_gems
           Array(cop_config['AllowedGems'])
         end
 
-        def message(range)
-          gem_specification = range.source
-
+        def message(_range)
           if required_style?
-            format(REQUIRED_MSG, gem_specification: gem_specification)
+            REQUIRED_MSG
           elsif forbidden_style?
-            format(FORBIDDEN_MSG, gem_specification: gem_specification)
+            FORBIDDEN_MSG
           end
         end
 
@@ -116,11 +116,7 @@ module RuboCop
         end
 
         def add_dependency_method?(method_name)
-          method_name.to_s.end_with?('_dependency')
-        end
-
-        def add_dependency_method_nodes
-          add_dependency_method_declarations(processed_source.ast)
+          ADD_DEPENDENCY_METHODS.include?(method_name)
         end
 
         def offense?(node)
@@ -128,13 +124,13 @@ module RuboCop
         end
 
         def required_offense?(node)
-          return unless required_style?
+          return false unless required_style?
 
           !includes_version_specification?(node) && !includes_commit_reference?(node)
         end
 
         def forbidden_offense?(node)
-          return unless forbidden_style?
+          return false unless forbidden_style?
 
           includes_version_specification?(node) || includes_commit_reference?(node)
         end

data/lib/rubocop/cop/gemspec/deprecated_attribute_assignment.rb

@@ -3,8 +3,8 @@
 module RuboCop
   module Cop
     module Gemspec
-      # Checks that deprecated attribute attributes are not set in a gemspec file.
-      # Removing `test_files` allows the user to receive smaller packed gems.
+      # Checks that deprecated attributes are not set in a gemspec file.
+      # Removing deprecated attributes allows the user to receive smaller packed gems.
       #
       # @example
       #
@@ -29,7 +29,7 @@ module RuboCop
         include RangeHelp
         extend AutoCorrector
 
-        MSG = 'Do not set `test_files` in gemspec.'
+        MSG = 'Do not set `%<attribute>s` in gemspec.'
 
         # @!method gem_specification(node)
         def_node_matcher :gem_specification, <<~PATTERN
@@ -43,16 +43,16 @@ module RuboCop
         def on_block(block_node)
           return unless gem_specification(block_node)
 
-          block_parameter = block_node.arguments.first.source
+          block_parameter = block_node.first_argument.source
 
-          date_assignment = block_node.descendants.detect do |node|
-            use_test_files?(node, block_parameter)
+          assignment = block_node.descendants.detect do |node|
+            use_deprecated_attributes?(node, block_parameter)
           end
+          return unless assignment
 
-          return unless date_assignment
-
-          add_offense(date_assignment) do |corrector|
-            range = range_by_whole_lines(date_assignment.source_range, include_final_newline: true)
+          message = format_message_from
+          add_offense(assignment, message: message) do |corrector|
+            range = range_by_whole_lines(assignment.source_range, include_final_newline: true)
 
             corrector.remove(range)
           end
@@ -60,16 +60,31 @@ module RuboCop
 
         private
 
-        def use_test_files?(node, block_parameter)
-          node, method_name = if node.op_asgn_type?
-                                lhs, _op, _rhs = *node
+        def node_and_method_name(node, attribute)
+          if node.op_asgn_type?
+            lhs, _op, _rhs = *node
+            [lhs, attribute]
+          else
+            [node, :"#{attribute}="]
+          end
+        end
+
+        def use_deprecated_attributes?(node, block_parameter)
+          %i[test_files date specification_version rubygems_version].each do |attribute|
+            node, method_name = node_and_method_name(node, attribute)
+            unless node.send_type? && node.receiver&.source == block_parameter &&
+                   node.method?(method_name)
+              next
+            end
 
-                                [lhs, :test_files]
-                              else
-                                [node, :test_files=]
-                              end
+            @attribute = attribute.to_s
+            return true
+          end
+          false
+        end
 
-          node.send_type? && node.receiver&.source == block_parameter && node.method?(method_name)
+        def format_message_from
+          format(MSG, attribute: @attribute)
         end
       end
     end

data/lib/rubocop/cop/gemspec/development_dependencies.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Gemspec
+      # Enforce that development dependencies for a gem are specified in
+      # `Gemfile`, rather than in the `gemspec` using
+      # `add_development_dependency`. Alternatively, using `EnforcedStyle:
+      # gemspec`, enforce that all dependencies are specified in `gemspec`,
+      # rather than in `Gemfile`.
+      #
+      # @example EnforcedStyle: Gemfile (default)
+      #   # Specify runtime dependencies in your gemspec,
+      #   # but all other dependencies in your Gemfile.
+      #
+      #   # bad
+      #   # example.gemspec
+      #   s.add_development_dependency "foo"
+      #
+      #   # good
+      #   # Gemfile
+      #   gem "foo"
+      #
+      #   # good
+      #   # gems.rb
+      #   gem "foo"
+      #
+      #   # good (with AllowedGems: ["bar"])
+      #   # example.gemspec
+      #   s.add_development_dependency "bar"
+      #
+      # @example EnforcedStyle: gems.rb
+      #   # Specify runtime dependencies in your gemspec,
+      #   # but all other dependencies in your Gemfile.
+      #   #
+      #   # Identical to `EnforcedStyle: Gemfile`, but with a different error message.
+      #   # Rely on Bundler/GemFilename to enforce the use of `Gemfile` vs `gems.rb`.
+      #
+      #   # bad
+      #   # example.gemspec
+      #   s.add_development_dependency "foo"
+      #
+      #   # good
+      #   # Gemfile
+      #   gem "foo"
+      #
+      #   # good
+      #   # gems.rb
+      #   gem "foo"
+      #
+      #   # good (with AllowedGems: ["bar"])
+      #   # example.gemspec
+      #   s.add_development_dependency "bar"
+      #
+      # @example EnforcedStyle: gemspec
+      #   # Specify all dependencies in your gemspec.
+      #
+      #   # bad
+      #   # Gemfile
+      #   gem "foo"
+      #
+      #   # good
+      #   # example.gemspec
+      #   s.add_development_dependency "foo"
+      #
+      #   # good (with AllowedGems: ["bar"])
+      #   # Gemfile
+      #   gem "bar"
+      #
+      class DevelopmentDependencies < Base
+        include ConfigurableEnforcedStyle
+
+        MSG = 'Specify development dependencies in %<preferred>s.'
+        RESTRICT_ON_SEND = %i[add_development_dependency gem].freeze
+
+        # @!method add_development_dependency?(node)
+        def_node_matcher :add_development_dependency?, <<~PATTERN
+          (send _ :add_development_dependency (str #forbidden_gem? ...) _? _?)
+        PATTERN
+
+        # @!method gem?(node)
+        def_node_matcher :gem?, <<~PATTERN
+          (send _ :gem (str #forbidden_gem? ...))
+        PATTERN
+
+        def on_send(node)
+          case style
+          when :Gemfile, :'gems.rb'
+            add_offense(node) if add_development_dependency?(node)
+          when :gemspec
+            add_offense(node) if gem?(node)
+          end
+        end
+
+        private
+
+        def forbidden_gem?(gem_name)
+          !cop_config['AllowedGems'].include?(gem_name)
+        end
+
+        def message(_range)
+          format(MSG, preferred: style)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/gemspec/duplicated_assignment.rb

@@ -38,7 +38,7 @@ module RuboCop
         include RangeHelp
         include GemspecHelp
 
-        MSG = '`%<assignment>s` method calls already given on line '\
+        MSG = '`%<assignment>s` method calls already given on line ' \
               '%<line_of_first_occurrence>d of the gemspec.'
 
         # @!method assignment_method_declarations(node)

data/lib/rubocop/cop/gemspec/ordered_dependencies.rb

@@ -45,7 +45,15 @@ module RuboCop
       #
       #   spec.add_runtime_dependency 'rspec'
       #
-      #   # good only if TreatCommentsAsGroupSeparators is true
+      # @example TreatCommentsAsGroupSeparators: true (default)
+      #   # good
+      #   # For code quality
+      #   spec.add_dependency 'rubocop'
+      #   # For tests
+      #   spec.add_dependency 'rspec'
+      #
+      # @example TreatCommentsAsGroupSeparators: false
+      #   # bad
       #   # For code quality
       #   spec.add_dependency 'rubocop'
       #   # For tests
@@ -55,7 +63,7 @@ module RuboCop
         include OrderedGemNode
 
         MSG = 'Dependencies should be sorted in an alphabetical order within ' \
-              'their section of the gemspec. '\
+              'their section of the gemspec. ' \
               'Dependency `%<previous>s` should appear before `%<current>s`.'
 
         def on_new_investigation

data/lib/rubocop/cop/gemspec/require_mfa.rb

@@ -36,29 +36,29 @@ module RuboCop
       #     spec.metadata['rubygems_mfa_required'] = 'true'
       #   end
       #
-      #  # bad
-      #  Gem::Specification.new do |spec|
-      #    spec.metadata = {
-      #      'rubygems_mfa_required' => 'false'
-      #    }
-      #  end
+      #   # bad
+      #   Gem::Specification.new do |spec|
+      #     spec.metadata = {
+      #       'rubygems_mfa_required' => 'false'
+      #     }
+      #   end
       #
-      #  # good
-      #  Gem::Specification.new do |spec|
-      #    spec.metadata = {
-      #      'rubygems_mfa_required' => 'true'
-      #    }
-      #  end
+      #   # good
+      #   Gem::Specification.new do |spec|
+      #     spec.metadata = {
+      #       'rubygems_mfa_required' => 'true'
+      #     }
+      #   end
       #
-      #  # bad
-      #  Gem::Specification.new do |spec|
-      #    spec.metadata['rubygems_mfa_required'] = 'false'
-      #  end
+      #   # bad
+      #   Gem::Specification.new do |spec|
+      #     spec.metadata['rubygems_mfa_required'] = 'false'
+      #   end
       #
-      #  # good
-      #  Gem::Specification.new do |spec|
-      #    spec.metadata['rubygems_mfa_required'] = 'true'
-      #  end
+      #   # good
+      #   Gem::Specification.new do |spec|
+      #     spec.metadata['rubygems_mfa_required'] = 'true'
+      #   end
       #
       class RequireMFA < Base
         include GemspecHelp
@@ -84,7 +84,7 @@ module RuboCop
           (str "true")
         PATTERN
 
-        def on_block(node) # rubocop:disable Metrics/MethodLength
+        def on_block(node) # rubocop:disable Metrics/MethodLength, InternalAffairs/NumblockHandler
           gem_specification(node) do |block_var|
             metadata_value = metadata(node)
             mfa_value = mfa_value(metadata_value)

data/lib/rubocop/cop/gemspec/required_ruby_version.rb

@@ -76,7 +76,9 @@ module RuboCop
         PATTERN
 
         def on_new_investigation
-          add_global_offense(MISSING_MSG) unless required_ruby_version?(processed_source.ast)
+          return if processed_source.ast && required_ruby_version?(processed_source.ast)
+
+          add_global_offense(MISSING_MSG)
         end
 
         def on_send(node)
@@ -110,6 +112,8 @@ module RuboCop
             end
           end
 
+          return unless required_ruby_version
+
           required_ruby_version.str_content.scan(/\d/).first(2).join('.')
         end
 

data/lib/rubocop/cop/generator/require_file_injector.rb

@@ -55,8 +55,8 @@ module RuboCop
           end
         end
 
-        def require_path_fragments(require_directove)
-          path = require_directove.match(REQUIRE_PATH)
+        def require_path_fragments(require_directive)
+          path = require_directive.match(REQUIRE_PATH)
 
           path ? path.captures.first.split('/') : []
         end
@@ -67,7 +67,7 @@ module RuboCop
 
         def require_path
           path = source_path.relative_path_from(root_file_path.dirname)
-          path.to_s.sub('.rb', '')
+          path.to_s.delete_suffix('.rb')
         end
       end
     end