toolkit.model.37.0.0.source-code.VcsInfo.kt Maven / Gradle / Ivy
/*
* Copyright (C) 2017 The ORT Project Authors (see )
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* SPDX-License-Identifier: Apache-2.0
* License-Filename: LICENSE
*/
package org.ossreviewtoolkit.model
import org.ossreviewtoolkit.utils.ort.normalizeVcsUrl
/**
* Bundles general Version Control System information.
*/
data class VcsInfo(
/**
* The type of the VCS, for example Git, GitRepo, Mercurial, etc.
*/
val type: VcsType,
/**
* The URL to the VCS repository.
*/
val url: String,
/**
* The VCS-specific revision (tag, branch, SHA1) that the version of the package maps to.
*/
val revision: String,
/**
* The path inside the VCS to take into account. If the VCS supports checking out only a subdirectory, only this
* path is checked out.
*/
val path: String = ""
) {
companion object {
/**
* A constant for a [VcsInfo] where all properties are empty strings.
*/
@JvmField
val EMPTY = VcsInfo(
type = VcsType.UNKNOWN,
url = "",
revision = "",
path = ""
)
}
/**
* Merge two sources of VCS information by mixing and matching fields to get as complete information as possible.
* If in question, information in this instance has precedence over information in the other instance.
*/
fun merge(other: VcsInfo): VcsInfo {
if (this == EMPTY) return other
return VcsInfo(
type.takeUnless { it == EMPTY.type } ?: other.type,
url.takeUnless { it == EMPTY.url } ?: other.url,
revision.takeUnless { it == EMPTY.revision } ?: other.revision,
path.takeUnless { it == EMPTY.path } ?: other.path
)
}
/**
* Return this [VcsInfo] in normalized form by applying [normalizeVcsUrl] to the [url].
*/
fun normalize() = copy(url = normalizeVcsUrl(url))
/**
* Return a [VcsInfoCurationData] with the properties from this [VcsInfo].
*/
fun toCuration() = VcsInfoCurationData(type, url, revision, path)
}
/**
* Return this [VcsInfo] if not null or else [VcsInfo.EMPTY].
*/
fun VcsInfo?.orEmpty(): VcsInfo = this ?: VcsInfo.EMPTY