/*
* Copyright 2022 the original author or authors.
*
* 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
*
* http://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.
*/
@file:Incubating
package org.gradle.kotlin.dsl
import org.gradle.api.Action
import org.gradle.api.Incubating
import org.gradle.api.artifacts.Dependency
import org.gradle.api.artifacts.ExternalModuleDependency
import org.gradle.api.artifacts.FileCollectionDependency
import org.gradle.api.artifacts.MinimalExternalModuleDependency
import org.gradle.api.artifacts.dsl.Dependencies
import org.gradle.api.artifacts.dsl.DependencyAdder
import org.gradle.api.artifacts.dsl.DependencyFactory
import org.gradle.api.file.FileCollection
import org.gradle.api.provider.Provider
import org.gradle.api.provider.ProviderConvertible
/**
* This class is used to add extra methods to {@link DependencyAdder} for the Kotlin DSL to make the DSL more idiomatic.
* This is implemented as Kotlin extension functions.
*
* These extension methods allow an interface exposing an instance of {@code DependencyAdder} to add dependencies without explicitly calling {@code add(...)}.
*
* For example:
*
* interface MyDependencies {
* DependencyAdder getImplementation()
* }
* // In the build script
* myDependencies {
* implementation("org:foo:1.0")
* }
*
*
* In this Kotlin DSL example, {@code implementation("org:foo:1.0")}
*
* - is equivalent to {@code getImplementation().invoke("org:foo:1.0")} because of these extension functions
* - has the same effect as {@code getImplementation().add("org:foo:1.0")} in Java
*
*
* There are {@code invoke(...)} equivalents for all the {@code add(...)} methods in {@code DependencyAdder}.
*
*/
/**
* Creates a dependency based on the group, name and version (GAV) coordinates.
*
* @since 7.6
*/
fun Dependencies.module(group: String?, name: String, version: String?) = module(group, name, version)
/**
* Add a dependency.
*
* @param dependencyNotation dependency to add
* @see DependencyFactory.create
* @since 7.6
*/
operator fun DependencyAdder.invoke(dependencyNotation: CharSequence) = add(dependencyNotation)
/**
* Add a dependency.
*
* @param dependencyNotation dependency to add
* @param configuration an action to configure the dependency
* @see DependencyFactory.create
* @since 7.6
*/
operator fun DependencyAdder.invoke(dependencyNotation: CharSequence, configuration: Action) = add(dependencyNotation, configuration)
/**
* Add a dependency.
*
* @param files files to add as a dependency
* @since 7.6
*/
operator fun DependencyAdder.invoke(files: FileCollection) = add(files)
/**
* Add a dependency.
*
* @param files files to add as a dependency
* @param configuration an action to configure the dependency
* @since 7.6
*/
operator fun DependencyAdder.invoke(files: FileCollection, configuration: Action) = add(files, configuration)
/**
* Add a dependency.
*
* @param externalModule external module to add as a dependency
* @since 7.6
*/
operator fun DependencyAdder.invoke(externalModule: ProviderConvertible) = add(externalModule)
/**
* Add a dependency.
*
* @param externalModule external module to add as a dependency
* @param configuration an action to configure the dependency
* @since 7.6
*/
operator fun DependencyAdder.invoke(externalModule: ProviderConvertible, configuration: Action) = add(externalModule, configuration)
/**
* Add a dependency.
*
* @param dependency dependency to add
* @since 7.6
*/
operator fun DependencyAdder.invoke(dependency: Dependency) = add(dependency)
/**
* Add a dependency.
*
* @param dependency dependency to add
* @param configuration an action to configure the dependency
* @since 7.6
*/
operator fun DependencyAdder.invoke(dependency: D, configuration: Action) = add(dependency, configuration)
/**
* Add a dependency.
*
* @param dependency dependency to add
* @since 7.6
*/
operator fun DependencyAdder.invoke(dependency: Provider) = add(dependency)
/**
* Add a dependency.
*
* @param dependency dependency to add
* @param configuration an action to configure the dependency
* @since 7.6
*/
operator fun DependencyAdder.invoke(dependency: Provider, configuration: Action) = add(dependency, configuration)