PublishingPlugin.java

/*
 * Copyright 2012 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.
 */

package org.gradle.api.publish.plugins;

import org.gradle.api.*;
import org.gradle.api.artifacts.dsl.RepositoryHandler;
import org.gradle.api.internal.artifacts.ArtifactPublicationServices;
import org.gradle.api.internal.tasks.TaskContainerInternal;
import org.gradle.api.publish.PublicationContainer;
import org.gradle.api.publish.PublishingExtension;
import org.gradle.api.publish.internal.DefaultPublicationContainer;
import org.gradle.api.publish.internal.DefaultPublishingExtension;
import org.gradle.api.tasks.TaskContainer;
import org.gradle.internal.reflect.Instantiator;
import org.gradle.model.ModelPathBinder;
import org.gradle.model.ModelRules;
import org.gradle.model.Open;

import javax.inject.Inject;

/**
 * Installs a {@link org.gradle.api.publish.PublishingExtension} with name {@value org.gradle.api.publish.PublishingExtension#NAME}.
 *
 * @since 1.3
 */
@Incubating
public class PublishingPlugin implements Plugin<Project> {

    public static final String PUBLISH_TASK_GROUP = "publishing";
    public static final String PUBLISH_LIFECYCLE_TASK_NAME = "publish";

    public static final String PUBLISHING_MODEL_PATH = "publishing";

    private final Instantiator instantiator;
    private final ModelRules modelRules;
    private final ArtifactPublicationServices publicationServices;

    @Inject
    public PublishingPlugin(ArtifactPublicationServices publicationServices, Instantiator instantiator, ModelRules modelRules) {
        this.publicationServices = publicationServices;
        this.instantiator = instantiator;
        this.modelRules = modelRules;
    }

    // This is really just declaring that the publishing extension contributes to the tasks model
    // We don't need to do anything ourselves, because closing the publishing extension will cause
    // the deferred configurables to run, which at the moment will create the tasks
    private static class PublishingPluginDerivedConfiguration implements Runnable {
        public PublishingPluginDerivedConfiguration(PublishingExtension extension, @Open TaskContainer tasks) {
        }

        public void run() {
        }
    }

    public void apply(final Project project) {
        RepositoryHandler repositories = publicationServices.createRepositoryHandler();
        PublicationContainer publications = instantiator.newInstance(DefaultPublicationContainer.class, instantiator);

        PublishingExtension extension = project.getExtensions().create(PublishingExtension.NAME, DefaultPublishingExtension.class, repositories, publications);
        
        modelRules.register(PUBLISHING_MODEL_PATH, extension);
        
        // This will trigger all the deferred configurables
        modelRules.configure(PUBLISHING_MODEL_PATH, PublishingExtension.class, new Action<PublishingExtension>() {
            public void execute(PublishingExtension publishingExtension) {
                project.getExtensions().getByType(DefaultPublishingExtension.class);
            }
        });
        modelRules.rule(PublishingPluginDerivedConfiguration.class, new Action<ModelPathBinder>() {
            public void execute(ModelPathBinder modelPathBinder) {
                modelPathBinder.bind(PUBLISHING_MODEL_PATH);
                modelPathBinder.bind(TaskContainerInternal.MODEL_PATH);
            }
        });

        Task publishLifecycleTask = project.getTasks().create(PUBLISH_LIFECYCLE_TASK_NAME);
        publishLifecycleTask.setDescription("Publishes all publications produced by this project.");
        publishLifecycleTask.setGroup(PUBLISH_TASK_GROUP);
    }
}