dependabot-maven 0.319.1 → 0.320.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3268690eeb4f7ee69aa0672721dd0305c0f07bd76354bc902dea5dc801a8f012
-  data.tar.gz: f7080365f342e6ecfdc094718c5bb186d2e228b014bb7e824db1648814320302
+  metadata.gz: 24dcdf6874641aec6d60da3c09b81c70878cc61e754b0809e6246f9265a1b831
+  data.tar.gz: 2dce537d8680b9eb276b2a12010261ad6be4824140d1cf277b92743cc89304a0
 SHA512:
-  metadata.gz: b0b4883e8cfecd7bb7d3f3937c09ca59489102c23bc87e6ba1829d01a23232d3c773765eb8ca33c05e8659509e3e9f2359edd24c4d7cc18c4fd59712927ba43d
-  data.tar.gz: 6308ea5cb891f6f7bed9f9095381bdaceacd75ef3fef890b7d2fcdce0b5ac3b84f800924b0ff718f4fcc8cb35bcdc5c85592a99606c7af35bf77ec598bf5fb0c
+  metadata.gz: 155fcc04c0b1323649702406c89c6bf9079a17007ea51053de3b1f1a372220c4948b3c9325cee0091ef6dae37fd293dd22bcbf1a2ac237b066599ce3318136a7
+  data.tar.gz: 51b8c75dceb8a7fbca841478dbe7a6278cdfc5cee4c9782dd29577a44a5a59f9e478dd8f11cdc41a169aea29b6b07f88e9aa62b8061bfa3ff85583d2faedee96

data/lib/dependabot/maven/file_updater.rb

@@ -2,6 +2,7 @@
 # frozen_string_literal: true
 
 require "nokogiri"
+require "rexml/document"
 require "sorbet-runtime"
 require "dependabot/file_updaters"
 require "dependabot/file_updaters/base"
@@ -149,43 +150,40 @@ module Dependabot
         ).returns(String)
       end
       def add_new_declaration(content, dependency, requirement) # rubocop:disable Metrics/AbcSize
-        doc = Nokogiri::XML(content) { |config| config.default_xml.noblanks }
-        doc.remove_namespaces!
-
-        project = doc.at_xpath("//project")
+        doc = REXML::Document.new(content)
+        project = doc.get_elements("//project").first
         raise "<project> element not found in the XML content" unless project
 
-        dependency_management = project.at_xpath("dependencyManagement")
-        unless dependency_management
-          dependency_management = Nokogiri::XML::Node.new("dependencyManagement", doc)
-          dependencies = Nokogiri::XML::Node.new("dependencies", doc)
-          dependency_management.add_child(dependencies)
-          project.add_child(dependency_management)
-        end
+        # Detect indentation of the file from indentation of the project tag children
+        indentation_config = detect_indentation_config(project)
 
-        dependencies = dependency_management.at_xpath("dependencies")
-        unless dependencies
-          dependencies = Nokogiri::XML::Node.new("dependencies", doc)
-          dependency_management.add_child(dependencies)
-        end
+        dependency_management, dependency_management_created = ensure_dependency_management_element(project,
+                                                                                                    indentation_config)
+        dependencies, dependencies_created = ensure_dependencies_element(dependency_management, indentation_config)
 
-        dependency_node = Nokogiri::XML::Node.new("dependency", doc)
-
-        group_id = Nokogiri::XML::Node.new("groupId", doc)
-        group_id.content = dependency.name.split(":").first
-        dependency_node.add_child(group_id)
+        if dependencies.children.last&.to_s&.start_with?("\n")
+          dependencies.children.last.value = "\n#{indentation_config[:levels][:dependencies]}"
+        else
+          dependencies.add_text("\n#{indentation_config[:levels][:dependencies]}")
+        end
 
-        artifact_id = Nokogiri::XML::Node.new("artifactId", doc)
-        artifact_id.content = dependency.name.split(":").last
-        dependency_node.add_child(artifact_id)
+        # Create the dependency element with the required fields, adding the appropriate indentation as text nodes
+        add_dependency_entry(dependency, requirement, dependencies, indentation_config[:levels][:dependency],
+                             indentation_config[:levels][:dependencies])
 
-        version = Nokogiri::XML::Node.new("version", doc)
-        version.content = requirement.fetch(:requirement)
-        dependency_node.add_child(version)
+        # Close all sections with appropriate indentation
+        dependencies.add_text("\n#{indentation_config[:levels][:dependency_management]}")
+        dependency_management.add_text("\n#{indentation_config[:levels][:base]}") if dependencies_created
+        project.add_text("\n") if dependency_management_created
 
-        dependencies.add_child(dependency_node)
+        # If dependencyManagement was created, replace entire document content with parser output
+        # Unfortunately, this might include unrelated formatting changes sometimes
+        return doc.to_s if dependency_management_created
 
-        doc.to_xml
+        # If dependencyManagement was not created, we just replace the existing dependencyManagement element
+        # with the updated one, preserving the rest of the document
+        content.gsub(%r{\<dependencyManagement\>[\s\S]*\</dependencyManagement\>},
+                     dependency_management.to_s)
       end
 
       sig do
@@ -267,6 +265,90 @@ module Dependabot
           T.nilable(T::Array[Dependabot::DependencyFile])
         )
       end
+
+      sig do
+        params(project: REXML::Element,
+               indent_config: T::Hash[Symbol, T.untyped]).returns([REXML::Element, T::Boolean])
+      end
+      def ensure_dependency_management_element(project, indent_config)
+        dependency_management = project.get_elements("dependencyManagement").first
+        is_created = false
+
+        unless dependency_management
+          project.add_text("\n#{indent_config[:levels][:base]}")
+          dependency_management = REXML::Element.new("dependencyManagement", project)
+          is_created = true
+        end
+
+        [dependency_management, is_created]
+      end
+
+      sig do
+        params(dependency_management: REXML::Element,
+               indent_config: T::Hash[Symbol, T.untyped]).returns([REXML::Element, T::Boolean])
+      end
+      def ensure_dependencies_element(dependency_management, indent_config)
+        dependencies = dependency_management.get_elements("dependencies").first
+        is_created = false
+
+        unless dependencies
+          dependency_management.add_text("\n#{indent_config[:levels][:dependency_management]}")
+          dependencies = REXML::Element.new("dependencies", dependency_management)
+          is_created = true
+        end
+
+        [dependencies, is_created]
+      end
+
+      sig do
+        params(dependency: Dependabot::Dependency, requirement: T::Hash[Symbol, T.untyped],
+               dependencies_node: REXML::Element, current_indentation_level: String,
+               parent_indentation_level: String).void
+      end
+      def add_dependency_entry(dependency, requirement, dependencies_node, current_indentation_level,
+                               parent_indentation_level)
+        dependency_node = REXML::Element.new("dependency", dependencies_node)
+        dependency_node.add_text("\n#{current_indentation_level}")
+        group_id = REXML::Element.new("groupId", dependency_node)
+        group_id.text = dependency.name.split(":").first
+        dependency_node.add_text("\n#{current_indentation_level}")
+        artifact_id = REXML::Element.new("artifactId", dependency_node)
+        artifact_id.text = dependency.name.split(":").last
+        dependency_node.add_text("\n#{current_indentation_level}")
+        version = REXML::Element.new("version", dependency_node)
+        version.text = requirement.fetch(:requirement)
+        dependency_node.add_text("\n#{parent_indentation_level}")
+      end
+
+      sig { params(base_indentation: String, is_tabs: T::Boolean).returns(Integer) }
+      def get_indent_size(base_indentation, is_tabs)
+        if is_tabs
+          indent_size = base_indentation.to_s.scan(/\t+$/).length
+          indent_size.positive? ? indent_size : 1
+        else
+          base_indentation.to_s.scan(/ +$/).last&.length || 2
+        end
+      end
+
+      sig { params(project: REXML::Element).returns(T::Hash[Symbol, T.untyped]) }
+      def detect_indentation_config(project)
+        sample_indent = project.children.find do |child|
+          child.to_s.match?(/\n(\t+| +)$/)
+        end&.to_s&.match(/\n(\t+| +)$/)&.[](1)
+
+        base_indent = sample_indent || "  "
+
+        {
+          base: base_indent,
+          is_tabs: base_indent.include?("\t"),
+          levels: {
+            base: base_indent,
+            dependency_management: base_indent + base_indent,
+            dependencies: base_indent + base_indent + base_indent,
+            dependency: base_indent + base_indent + base_indent + base_indent
+          }
+        }
+      end
     end
   end
 end

data/lib/dependabot/maven/update_checker/version_finder.rb

@@ -68,7 +68,7 @@ module Dependabot
 
         sig { returns(T::Boolean) }
         def cooldown_enabled?
-          Dependabot::Experiments.enabled?(:enable_cooldown_for_maven)
+          true
         end
 
         sig do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dependabot-maven
 version: !ruby/object:Gem::Version
-  version: 0.319.1
+  version: 0.320.1
 platform: ruby
 authors:
 - Dependabot
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.319.1
+        version: 0.320.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.319.1
+        version: 0.320.1
 - !ruby/object:Gem::Dependency
   name: debug
   requirement: !ruby/object:Gem::Requirement
@@ -270,7 +270,7 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/dependabot/dependabot-core/issues
-  changelog_uri: https://github.com/dependabot/dependabot-core/releases/tag/v0.319.1
+  changelog_uri: https://github.com/dependabot/dependabot-core/releases/tag/v0.320.1
 rdoc_options: []
 require_paths:
 - lib