All Downloads are FREE. Search and download functionalities are using the official Maven repository.
Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
ru.vyarus.gradle.plugin.lib.JavaLibPlugin.groovy Maven / Gradle / Ivy
package ru.vyarus.gradle.plugin.lib
import groovy.transform.CompileStatic
import groovy.transform.TypeCheckingMode
import org.gradle.api.Plugin
import org.gradle.api.Project
import org.gradle.api.internal.FeaturePreviews
import org.gradle.api.java.archives.Attributes
import org.gradle.api.plugins.GroovyPlugin
import org.gradle.api.plugins.JavaPlugin
import org.gradle.api.publish.maven.MavenPublication
import org.gradle.api.tasks.bundling.Jar
import org.gradle.util.GradleVersion
import ru.vyarus.gradle.plugin.pom.PomPlugin
import javax.inject.Inject
/**
* Plugin performs common configuration for java or groovy library:
*
* Fills manifest for main jar, add pom and generated pom.properties inside jar (as maven do)
* Add sourcesJar task
* Add javadocJar or (and) groovydocJar tasks
* Configures maven publication named 'maven' with all jars (jar, sources, javadock and maybe groovydoc)
* Applies 'ru.vyarus.pom' plugin which fixes pom dependencies, adds provided and optional support and
* 'pom' closure fot simpler pom configuration
* Add 'install' task as shortcut for publishToMavenLocal
*
* Plugin must be registered after java or groovy plugins, otherwise wil do nothing.
*
* @author Vyacheslav Rusakov
* @since 07.11.2015
*/
@SuppressWarnings('DuplicateStringLiteral')
@CompileStatic(TypeCheckingMode.SKIP)
class JavaLibPlugin implements Plugin {
private static final String BUILD_GROUP = 'build'
private static final String JAVADOC_JAR = 'javadocJar'
private static final String GROOVYDOC_JAR = 'groovydocJar'
private final FeaturePreviews previews
// plugin will fail to initialize on gradle before 4.6
@Inject
JavaLibPlugin(FeaturePreviews featurePreviews) {
this.previews = featurePreviews
}
@Override
void apply(Project project) {
// activated only when java plugin is enabled
project.plugins.withType(JavaPlugin) {
project.plugins.apply(PomPlugin)
configureJar(project)
addSourcesJarTask(project)
addJavadocJarTask(project)
addGroovydocJarTask(project)
if (isStablePublishingEnabled()) {
configureStableMavenPublication(project)
} else {
configureMavenPublication(project)
}
addInstallTask(project)
}
}
private void configureJar(Project project) {
project.tasks.create('generatePomPropertiesFile') {
inputs.properties([
'version': "${ -> project.version }",
'groupId': "${ -> project.group }",
'artifactId': "${ -> project.name }",
])
outputs.file "$project.buildDir/generatePomPropertiesFile/pom.properties"
doLast {
File file = outputs.files.singleFile
file.parentFile.mkdirs()
file << inputs.properties.collect { key, value -> "$key: $value" }.join('\n')
}
}
project.configure(project) {
// delayed to be able to use version
afterEvaluate {
// do not override user attributes
Attributes attributes = jar.manifest.attributes
putIfAbsent(attributes, 'Implementation-Title', project.description ?: project.name)
putIfAbsent(attributes, 'Implementation-Version', project.version)
putIfAbsent(attributes, 'Built-By', System.getProperty('user.name'))
putIfAbsent(attributes, 'Built-Date', new Date())
putIfAbsent(attributes, 'Built-JDK', System.getProperty('java.version'))
putIfAbsent(attributes, 'Built-Gradle', project.gradle.gradleVersion)
putIfAbsent(attributes, 'Target-JDK', project.targetCompatibility)
}
model {
tasks.jar {
into("META-INF/maven/$project.group/$project.name") {
from generatePomFileForMavenPublication
rename '.*.xml', 'pom.xml'
from generatePomPropertiesFile
}
}
}
}
}
private void addSourcesJarTask(Project project) {
project.configure(project) {
tasks.create('sourcesJar', Jar)
sourcesJar {
dependsOn classes
group BUILD_GROUP
from sourceSets.main.allSource
classifier = 'sources'
}
}
}
private void addJavadocJarTask(Project project) {
// apply only if java sources exist
boolean hasJavaSources = project.sourceSets.main.java.srcDirs.find { it.exists() }
if (hasJavaSources) {
project.configure(project) {
tasks.create(JAVADOC_JAR, Jar)
javadocJar {
dependsOn javadoc
group BUILD_GROUP
classifier 'javadoc'
from javadoc.destinationDir
}
}
}
}
private void addGroovydocJarTask(Project project) {
// apply only if groovy enabled
project.plugins.withType(GroovyPlugin) {
// apply only if groovy sources exist
boolean hasGroovySources = project.sourceSets.main.groovy.srcDirs.find { it.exists() }
if (hasGroovySources) {
project.configure(project) {
tasks.create(GROOVYDOC_JAR, Jar)
groovydocJar {
dependsOn groovydoc
group BUILD_GROUP
// very important to have at least one javadoc package, because otherwise maven cantral
// would not accept package
classifier project.tasks.findByName(JAVADOC_JAR) ? 'groovydoc' : 'javadoc'
from groovydoc.destinationDir
}
}
}
}
}
private boolean isStablePublishingEnabled() {
if (GradleVersion.current() >= GradleVersion.version('5.0')) {
// since 5.0 stable publishing should be enabled by default
return true
}
// option available from gradle 4.8
try {
FeaturePreviews.Feature stablePublishingFeature = FeaturePreviews.Feature
.withName('STABLE_PUBLISHING')
return stablePublishingFeature.isActive() && !previews.isFeatureEnabled(stablePublishingFeature)
} catch (IllegalArgumentException ignored) {
// do nothing if option doesn't exists anymore (.withName() failed)
return false
}
}
private void configureMavenPublication(Project project) {
project.configure(project) {
// lazy initialized publication (could be directly overridden)
publishing {
publications {
maven(MavenPublication) {
from components.java
artifact sourcesJar
if (project.tasks.findByName(JAVADOC_JAR)) {
artifact javadocJar
}
if (project.tasks.findByName(GROOVYDOC_JAR)) {
artifact groovydocJar
}
}
}
}
}
}
@SuppressWarnings('NestedBlockDepth')
private void configureStableMavenPublication(Project project) {
project.configure(project) {
publishing {
publications {
maven(MavenPublication) {
// apply configuration only if it wasn't configured manually,
// for example like publishing.publications.maven.artifacts = [jar, javadocJar]
afterEvaluate {
if (artifacts.empty) {
artifact jar
artifact sourcesJar
if (project.tasks.findByName(JAVADOC_JAR)) {
artifact javadocJar
}
if (project.tasks.findByName(GROOVYDOC_JAR)) {
artifact groovydocJar
}
}
}
}
}
}
}
}
private void addInstallTask(Project project) {
project.tasks.create('install') {
dependsOn 'publishToMavenLocal'
group 'publishing'
description 'Alias for publishToMavenLocal task'
doLast {
logger.warn "INSTALLED $project.group:$project.name:$project.version"
}
}
}
private void putIfAbsent(Attributes attributes, String name, Object value) {
if (!attributes.containsKey(name)) {
attributes.put(name, value)
}
}
}
