toolkit.model.37.0.0.source-code.Scope.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of model Show documentation
Part of the OSS Review Toolkit (ORT), a suite to automate software compliance checks.
There is a newer version: 33.1.0
/*
 * 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 com.fasterxml.jackson.databind.annotation.JsonSerialize

import org.ossreviewtoolkit.model.utils.PackageReferenceSortedSetConverter

/**
 * The scope class puts package dependencies into context.
 */
data class Scope(
    /**
     * The respective package manager's native name for the scope, e.g. "compile", "provided" etc. for Maven, or
     * "dependencies", "devDependencies" etc. for NPM.
     */
    val name: String,

    /**
     * The set of references to packages in this scope. Note that only the first-order packages in this set
     * actually belong to the scope of [name]. Transitive dependency packages usually belong to the scope that
     * describes the packages required to compile the product. As an example, if this was the Maven "test" scope,
     * all first-order items in [dependencies] would be packages required for testing the product. But transitive
     * dependencies would not be test dependencies of the test dependencies, but compile dependencies of test
     * dependencies.
     */
    @JsonSerialize(converter = PackageReferenceSortedSetConverter::class)
    val dependencies: Set = emptySet()
) {
    /**
     * Return the set of package [Identifier]s in this [Scope], up to and including a depth of [maxDepth] where counting
     * starts at 0 (for the [Scope] itself) and 1 are direct dependencies etc. A value below 0 means to not limit the
     * depth. If the given [filterPredicate] is false for a specific [PackageReference] the corresponding [Identifier]
     * is excluded from the result.
     */
    fun collectDependencies(
        maxDepth: Int = -1,
        filterPredicate: (PackageReference) -> Boolean = { true }
    ): Set =
        dependencies.fold(mutableSetOf()) { refs, ref ->
            refs.also {
                if (maxDepth != 0) {
                    if (filterPredicate(ref)) it += ref.id
                    it += ref.collectDependencies(maxDepth - 1, filterPredicate)
                }
            }
        }

    /**
     * Return whether the package identified by [id] is contained as a (transitive) dependency in this scope.
     */
    operator fun contains(id: Identifier) = dependencies.any { it.id == id || it.dependsOn(id) }

    /**
     * Return all references to [id] as a dependency in this scope.
     */
    fun findReferences(id: Identifier) =
        dependencies.filter { it.id == id } + dependencies.flatMap { it.findReferences(id) }
}

fun Collection.collectDependencies(): Set = flatMapTo(mutableSetOf()) { it.collectDependencies() }