toolkit.reporter.33.0.0.source-code.ReporterInput.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of reporter Show documentation
Part of the OSS Review Toolkit (ORT), a suite to automate software compliance checks.
The newest version!
/*
 * Copyright (C) 2019 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.reporter

import org.ossreviewtoolkit.model.Issue
import org.ossreviewtoolkit.model.OrtResult
import org.ossreviewtoolkit.model.config.CopyrightGarbage
import org.ossreviewtoolkit.model.config.OrtConfiguration
import org.ossreviewtoolkit.model.config.createFileArchiver
import org.ossreviewtoolkit.model.licenses.DefaultLicenseInfoProvider
import org.ossreviewtoolkit.model.licenses.LicenseClassifications
import org.ossreviewtoolkit.model.licenses.LicenseInfoResolver
import org.ossreviewtoolkit.reporter.StatisticsCalculator.getStatistics

/**
 * A bundle of input to be used by [Reporter] implementations.
 */
data class ReporterInput(
    /**
     * The [OrtResult] to generate a report for.
     */
    val ortResult: OrtResult,

    /**
     * The [OrtConfiguration], can be used by the reporter to adapt the output based on how ORT is configured.
     */
    val ortConfig: OrtConfiguration = OrtConfiguration(),

    /**
     * A [LicenseTextProvider], can be used to integrate licenses texts into reports.
     */
    val licenseTextProvider: LicenseTextProvider = DefaultLicenseTextProvider(),

    /**
     * A [CopyrightGarbage] container, can be used to clean up copyrights used in reports.
     */
    val copyrightGarbage: CopyrightGarbage = CopyrightGarbage(),

    /**
     * A resolver for license information for the projects and packages contained in [ortResult].
     */
    val licenseInfoResolver: LicenseInfoResolver = LicenseInfoResolver(
        provider = DefaultLicenseInfoProvider(ortResult),
        copyrightGarbage = copyrightGarbage,
        addAuthorsToCopyrights = ortConfig.addAuthorsToCopyrights,
        archiver = ortConfig.scanner.archive.createFileArchiver(),
        licenseFilePatterns = ortConfig.licenseFilePatterns
    ),

    /**
     * [LicenseClassifications], can be used to handle licenses based on the user's configuration, for example to
     * determine which licenses to include in a notice file.
     */
    val licenseClassifications: LicenseClassifications = LicenseClassifications(),

    /**
     * A [HowToFixTextProvider], can be used to integrate how to fix texts for [Issue]s into reports.
     */
    val howToFixTextProvider: HowToFixTextProvider = HowToFixTextProvider.NONE
) {
    /**
     * Statistics for [ortResult].
     */
    @Suppress("UNUSED") // This can be used from templates.
    val statistics: Statistics by lazy { getStatistics(ortResult, licenseInfoResolver, ortConfig) }
}