com.liferay.gradle.plugins.css.builder.CSSBuilderPlugin Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of com.liferay.gradle.plugins.css.builder Show documentation
The CSS Builder Gradle plugin lets you run the Liferay CSS Builder tool to compile Sass files in your project.
There is a newer version: 2.0.0
Show newest version
/**
 * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 * details.
 */

package com.liferay.gradle.plugins.css.builder;

import com.liferay.gradle.util.GradleUtil;
import com.liferay.gradle.util.copy.StripPathSegmentsAction;

import groovy.lang.Closure;

import java.io.File;

import java.util.Iterator;
import java.util.Set;
import java.util.concurrent.Callable;

import org.gradle.api.Action;
import org.gradle.api.Plugin;
import org.gradle.api.Project;
import org.gradle.api.Task;
import org.gradle.api.artifacts.Configuration;
import org.gradle.api.file.FileCollection;
import org.gradle.api.file.FileTree;
import org.gradle.api.file.SourceDirectorySet;
import org.gradle.api.plugins.BasePlugin;
import org.gradle.api.plugins.JavaPlugin;
import org.gradle.api.plugins.PluginContainer;
import org.gradle.api.plugins.WarPlugin;
import org.gradle.api.plugins.WarPluginConvention;
import org.gradle.api.tasks.Copy;
import org.gradle.api.tasks.SourceSet;
import org.gradle.api.tasks.TaskContainer;

/**
 * @author Andrea Di Giorgi
 */
public class CSSBuilderPlugin implements Plugin {

	public static final String BUILD_CSS_TASK_NAME = "buildCSS";

	public static final String CSS_BUILDER_CONFIGURATION_NAME = "cssBuilder";

	public static final String EXPAND_PORTAL_COMMON_CSS_TASK_NAME =
		"expandPortalCommonCSS";

	public static final String PORTAL_COMMON_CSS_CONFIGURATION_NAME =
		"portalCommonCSS";

	@Override
	public void apply(Project project) {
		Configuration cssBuilderConfiguration = addConfigurationCSSBuilder(
			project);
		Configuration portalCommonCSSConfiguration =
			addConfigurationPortalCommonCSS(project);

		addTaskBuildCSS(project);

		Copy expandPortalCommonCSSTask = addTaskExpandPortalCommonCSS(
			project, portalCommonCSSConfiguration);

		configureTasksBuildCSS(
			project, cssBuilderConfiguration, expandPortalCommonCSSTask);
	}

	protected Configuration addConfigurationCSSBuilder(final Project project) {
		Configuration configuration = GradleUtil.addConfiguration(
			project, CSS_BUILDER_CONFIGURATION_NAME);

		configuration.setDescription(
			"Configures Liferay CSS Builder for this project.");
		configuration.setVisible(false);

		GradleUtil.executeIfEmpty(
			configuration,
			new Action() {

				@Override
				public void execute(Configuration configuration) {
					addDependenciesCSSBuilder(project);
				}

			});

		return configuration;
	}

	protected Configuration addConfigurationPortalCommonCSS(
		final Project project) {

		Configuration configuration = GradleUtil.addConfiguration(
			project, PORTAL_COMMON_CSS_CONFIGURATION_NAME);

		configuration.setDescription(
			"Configures com.liferay.frontend.css.common for compiling CSS " +
				"files.");
		configuration.setTransitive(false);
		configuration.setVisible(false);

		GradleUtil.executeIfEmpty(
			configuration,
			new Action() {

				@Override
				public void execute(Configuration configuration) {
					addDependenciesPortalCommonCSS(project);
				}

			});

		return configuration;
	}

	protected void addDependenciesCSSBuilder(Project project) {
		GradleUtil.addDependency(
			project, CSS_BUILDER_CONFIGURATION_NAME, "com.liferay",
			"com.liferay.css.builder", "latest.release");
	}

	protected void addDependenciesPortalCommonCSS(Project project) {
		GradleUtil.addDependency(
			project, PORTAL_COMMON_CSS_CONFIGURATION_NAME, "com.liferay",
			"com.liferay.frontend.css.common", "latest.release", false);
	}

	protected BuildCSSTask addTaskBuildCSS(Project project) {
		final BuildCSSTask buildCSSTask = GradleUtil.addTask(
			project, BUILD_CSS_TASK_NAME, BuildCSSTask.class);

		buildCSSTask.setDescription("Build CSS files.");
		buildCSSTask.setGroup(BasePlugin.BUILD_GROUP);

		PluginContainer pluginContainer = project.getPlugins();

		pluginContainer.withType(
			JavaPlugin.class,
			new Action() {

				@Override
				public void execute(JavaPlugin javaPlugin) {
					configureTaskBuildCSSForJavaPlugin(buildCSSTask);
				}

			});

		pluginContainer.withType(
			WarPlugin.class,
			new Action() {

				@Override
				public void execute(WarPlugin warPlugin) {
					configureTaskBuildCSSForWarPlugin(buildCSSTask);
				}

			});

		return buildCSSTask;
	}

	protected Copy addTaskExpandPortalCommonCSS(
		final Project project,
		final Configuration portalCommonCSSConfiguration) {

		Copy copy = GradleUtil.addTask(
			project, EXPAND_PORTAL_COMMON_CSS_TASK_NAME, Copy.class);

		copy.eachFile(new StripPathSegmentsAction(2));

		Closure closure = new Closure(null) {

			@SuppressWarnings("unused")
			public FileTree doCall() {
				return project.zipTree(
					portalCommonCSSConfiguration.getSingleFile());
			}

		};

		copy.from(closure);

		copy.include("META-INF/resources/**");
		copy.into(new File(project.getBuildDir(), "portal-common-css"));
		copy.setIncludeEmptyDirs(false);

		return copy;
	}

	protected void configureTaskBuildCSSClasspath(
		BuildCSSTask buildCSSTask, Configuration cssBuilderConfiguration) {

		buildCSSTask.setClasspath(cssBuilderConfiguration);
	}

	protected void configureTaskBuildCSSDependsOn(
		BuildCSSTask buildCSSTask, final Copy expandPortalCommonCSSTask) {

		Closure closure = new Closure(null) {

			@SuppressWarnings("unused")
			public Task doCall(BuildCSSTask buildCSSTask) {
				FileCollection cssFiles = buildCSSTask.getCSSFiles();
				File portalCommonDir = buildCSSTask.getPortalCommonDir();

				if (!cssFiles.isEmpty() &&
					portalCommonDir.equals(
						expandPortalCommonCSSTask.getDestinationDir())) {

					return expandPortalCommonCSSTask;
				}

				return null;
			}

		};

		buildCSSTask.dependsOn(closure);
	}

	protected void configureTaskBuildCSSForJavaPlugin(
		final BuildCSSTask buildCSSTask) {

		buildCSSTask.setDocrootDir(
			new Callable() {

				@Override
				public File call() throws Exception {
					return getResourcesDir(buildCSSTask.getProject());
				}

			});

		Task processResourcesTask = GradleUtil.getTask(
			buildCSSTask.getProject(), JavaPlugin.PROCESS_RESOURCES_TASK_NAME);

		processResourcesTask.dependsOn(buildCSSTask);
	}

	protected void configureTaskBuildCSSForWarPlugin(
		final BuildCSSTask buildCSSTask) {

		buildCSSTask.setDocrootDir(
			new Callable() {

				@Override
				public File call() throws Exception {
					return getWebAppDir(buildCSSTask.getProject());
				}

			});
	}

	protected void configureTaskBuildCSSPortalCommonDir(
		BuildCSSTask buildCSSTask, final Copy expandPortalCommonCSSTask) {

		buildCSSTask.setPortalCommonDir(
			new Callable() {

				@Override
				public File call() throws Exception {
					return expandPortalCommonCSSTask.getDestinationDir();
				}

			});
	}

	protected void configureTasksBuildCSS(
		Project project, final Configuration cssBuilderConfiguration,
		final Copy expandPortalCommonCSSTask) {

		TaskContainer taskContainer = project.getTasks();

		taskContainer.withType(
			BuildCSSTask.class,
			new Action() {

				@Override
				public void execute(BuildCSSTask buildCSSTask) {
					configureTaskBuildCSSClasspath(
						buildCSSTask, cssBuilderConfiguration);
					configureTaskBuildCSSDependsOn(
						buildCSSTask, expandPortalCommonCSSTask);
					configureTaskBuildCSSPortalCommonDir(
						buildCSSTask, expandPortalCommonCSSTask);
				}

			});
	}

	protected File getResourcesDir(Project project) {
		SourceSet sourceSet = GradleUtil.getSourceSet(
			project, SourceSet.MAIN_SOURCE_SET_NAME);

		return getSrcDir(sourceSet.getResources());
	}

	protected File getSrcDir(SourceDirectorySet sourceDirectorySet) {
		Set srcDirs = sourceDirectorySet.getSrcDirs();

		Iterator iterator = srcDirs.iterator();

		return iterator.next();
	}

	protected File getWebAppDir(Project project) {
		WarPluginConvention warPluginConvention = GradleUtil.getConvention(
			project, WarPluginConvention.class);

		return warPluginConvention.getWebAppDir();
	}

}