|
| 1 | +package com.google.firebase.gradle.plugins.datamodels |
| 2 | + |
| 3 | +import com.google.firebase.gradle.plugins.ModuleVersion |
| 4 | +import java.io.File |
| 5 | +import javax.xml.parsers.DocumentBuilderFactory |
| 6 | +import kotlinx.serialization.Serializable |
| 7 | +import kotlinx.serialization.encodeToString |
| 8 | +import nl.adaptivity.xmlutil.XmlDeclMode |
| 9 | +import nl.adaptivity.xmlutil.newReader |
| 10 | +import nl.adaptivity.xmlutil.serialization.XML |
| 11 | +import nl.adaptivity.xmlutil.serialization.XmlChildrenName |
| 12 | +import nl.adaptivity.xmlutil.serialization.XmlElement |
| 13 | +import nl.adaptivity.xmlutil.serialization.XmlSerialName |
| 14 | +import nl.adaptivity.xmlutil.xmlStreaming |
| 15 | +import org.w3c.dom.Element |
| 16 | + |
| 17 | +/** |
| 18 | + * Representation of a `<license />` element in a a pom file. |
| 19 | + * |
| 20 | + * @see PomElement |
| 21 | + */ |
| 22 | +@Serializable |
| 23 | +@XmlSerialName("license") |
| 24 | +data class LicenseElement( |
| 25 | + @XmlElement val name: String, |
| 26 | + @XmlElement val url: String? = null, |
| 27 | + @XmlElement val distribution: String? = null, |
| 28 | +) |
| 29 | + |
| 30 | +/** |
| 31 | + * Representation of an `<scm />` element in a a pom file. |
| 32 | + * |
| 33 | + * @see PomElement |
| 34 | + */ |
| 35 | +@Serializable |
| 36 | +@XmlSerialName("scm") |
| 37 | +data class SourceControlManagement(@XmlElement val connection: String, @XmlElement val url: String) |
| 38 | + |
| 39 | +/** |
| 40 | + * Representation of a `<dependency />` element in a pom file. |
| 41 | + * |
| 42 | + * @see PomElement |
| 43 | + */ |
| 44 | +@Serializable |
| 45 | +@XmlSerialName("dependency") |
| 46 | +data class ArtifactDependency( |
| 47 | + @XmlElement val groupId: String, |
| 48 | + @XmlElement val artifactId: String, |
| 49 | + // Can be null if the artifact derives its version from a bom |
| 50 | + @XmlElement val version: String? = null, |
| 51 | + @XmlElement val type: String? = null, |
| 52 | + @XmlElement val scope: String? = null, |
| 53 | +) { |
| 54 | + /** |
| 55 | + * Returns the artifact dependency as a a gradle dependency string. |
| 56 | + * |
| 57 | + * ``` |
| 58 | + * implementation("com.google.firebase:firebase-firestore:1.0.0") |
| 59 | + * ``` |
| 60 | + * |
| 61 | + * @see configuration |
| 62 | + * @see simpleDepString |
| 63 | + */ |
| 64 | + override fun toString() = "$configuration(\"$simpleDepString\")" |
| 65 | +} |
| 66 | + |
| 67 | +/** |
| 68 | + * The artifact type of this dependency, or the default inferred by gradle. |
| 69 | + * |
| 70 | + * We use a separate variable instead of inferring the default in the constructor so we can |
| 71 | + * serialize instances of [ArtifactDependency] that should specifically _not_ have a type in the |
| 72 | + * output (like in [DependencyManagementElement] instances). |
| 73 | + */ |
| 74 | +val ArtifactDependency.typeOrDefault: String |
| 75 | + get() = type ?: "jar" |
| 76 | + |
| 77 | +/** |
| 78 | + * The artifact scope of this dependency, or the default inferred by gradle. |
| 79 | + * |
| 80 | + * We use a separate variable instead of inferring the default in the constructor so we can |
| 81 | + * serialize instances of [ArtifactDependency] that should specifically _not_ have a scope in the |
| 82 | + * output (like in [DependencyManagementElement] instances). |
| 83 | + */ |
| 84 | +val ArtifactDependency.scopeOrDefault: String |
| 85 | + get() = scope ?: "compile" |
| 86 | + |
| 87 | +/** |
| 88 | + * The [version][ArtifactDependency.version] represented as a [ModuleVersion]. |
| 89 | + * |
| 90 | + * @throws RuntimeException if the version isn't valid semver, or it's missing. |
| 91 | + */ |
| 92 | +val ArtifactDependency.moduleVersion: ModuleVersion |
| 93 | + get() = |
| 94 | + version?.let { ModuleVersion.fromString(artifactId, it) } |
| 95 | + ?: throw RuntimeException( |
| 96 | + "Missing required version property for artifact dependency: $artifactId" |
| 97 | + ) |
| 98 | + |
| 99 | +/** |
| 100 | + * The fully qualified name of the artifact. |
| 101 | + * |
| 102 | + * Shorthand for: |
| 103 | + * ``` |
| 104 | + * "${artifact.groupId}:${artifact.artifactId}" |
| 105 | + * ``` |
| 106 | + */ |
| 107 | +val ArtifactDependency.fullArtifactName: String |
| 108 | + get() = "$groupId:$artifactId" |
| 109 | + |
| 110 | +/** |
| 111 | + * A string representing the dependency as a maven artifact marker. |
| 112 | + * |
| 113 | + * ``` |
| 114 | + * "com.google.firebase:firebase-common:21.0.0" |
| 115 | + * ``` |
| 116 | + */ |
| 117 | +val ArtifactDependency.simpleDepString: String |
| 118 | + get() = "$fullArtifactName${version?.let { ":$it" } ?: ""}" |
| 119 | + |
| 120 | +/** The gradle configuration that this dependency would apply to (eg; `api` or `implementation`). */ |
| 121 | +val ArtifactDependency.configuration: String |
| 122 | + get() = if (scopeOrDefault == "compile") "api" else "implementation" |
| 123 | + |
| 124 | +@Serializable |
| 125 | +@XmlSerialName("dependencyManagement") |
| 126 | +data class DependencyManagementElement( |
| 127 | + @XmlChildrenName("dependency") val dependencies: List<ArtifactDependency>? = null |
| 128 | +) |
| 129 | + |
| 130 | +/** Representation of a `<project />` element within a `pom.xml` file. */ |
| 131 | +@Serializable |
| 132 | +@XmlSerialName("project") |
| 133 | +data class PomElement( |
| 134 | + @XmlSerialName("xmlns") val namespace: String? = null, |
| 135 | + @XmlSerialName("xmlns:xsi") val schema: String? = null, |
| 136 | + @XmlSerialName("xsi:schemaLocation") val schemaLocation: String? = null, |
| 137 | + @XmlElement val modelVersion: String, |
| 138 | + @XmlElement val groupId: String, |
| 139 | + @XmlElement val artifactId: String, |
| 140 | + @XmlElement val version: String, |
| 141 | + @XmlElement val packaging: String? = null, |
| 142 | + @XmlChildrenName("licenses") val licenses: List<LicenseElement>? = null, |
| 143 | + @XmlElement val scm: SourceControlManagement? = null, |
| 144 | + @XmlElement val dependencyManagement: DependencyManagementElement? = null, |
| 145 | + @XmlChildrenName("dependency") val dependencies: List<ArtifactDependency>? = null, |
| 146 | +) { |
| 147 | + /** |
| 148 | + * Serializes this pom element into a valid XML element and saves it to the specified [file]. |
| 149 | + * |
| 150 | + * @param file Where to save the serialized pom to |
| 151 | + * @return The provided file, for chaining purposes. |
| 152 | + * @see fromFile |
| 153 | + */ |
| 154 | + fun toFile(file: File): File { |
| 155 | + val xmlWriter = XML { |
| 156 | + indent = 2 |
| 157 | + xmlDeclMode = XmlDeclMode.None |
| 158 | + } |
| 159 | + file.writeText(xmlWriter.encodeToString(this)) |
| 160 | + return file |
| 161 | + } |
| 162 | + |
| 163 | + companion object { |
| 164 | + /** |
| 165 | + * Deserializes a [PomElement] from a `pom.xml` file. |
| 166 | + * |
| 167 | + * @param file The file that contains the pom element. |
| 168 | + * @return The deserialized [PomElement] |
| 169 | + * @see toFile |
| 170 | + * @see fromElement |
| 171 | + */ |
| 172 | + fun fromFile(file: File): PomElement = |
| 173 | + fromElement( |
| 174 | + DocumentBuilderFactory.newInstance().newDocumentBuilder().parse(file).documentElement |
| 175 | + ) |
| 176 | + |
| 177 | + /** |
| 178 | + * Deserializes a [PomElement] from a document [Element]. |
| 179 | + * |
| 180 | + * @param element The HTML element representing the pom element. |
| 181 | + * @return The deserialized [PomElement] |
| 182 | + * @see fromFile |
| 183 | + */ |
| 184 | + fun fromElement(element: Element): PomElement = |
| 185 | + XML.decodeFromReader(xmlStreaming.newReader(element)) |
| 186 | + } |
| 187 | +} |
0 commit comments