nl.geodienstencentrum.maven.plugin.sass.AbstractSassMojo Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of sass-maven-plugin Show documentation
Show all versions of sass-maven-plugin Show documentation
A Maven Plugin that compiles Sass files.
/*
* Copyright 2014-2015 Mark Prins, GeoDienstenCentrum.
* Copyright 2010-2014 Jasig.
*
* See the NOTICE file distributed with this work for additional information
* regarding copyright ownership.
*
* 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 nl.geodienstencentrum.maven.plugin.sass;
import java.io.File;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import javax.script.ScriptContext;
import javax.script.ScriptEngine;
import javax.script.ScriptEngineManager;
import javax.script.ScriptException;
import nl.geodienstencentrum.maven.plugin.sass.compiler.CompilerCallback;
import org.apache.commons.io.FilenameUtils;
import org.apache.maven.model.FileSet;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugin.logging.Log;
import org.apache.maven.plugins.annotations.Parameter;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
/**
* Base for batching Sass Mojos.
*
*/
public abstract class AbstractSassMojo extends AbstractMojo {
/**
* Sources for compilation with their destination directory containing Sass
* files. Allows for multiple resource sources and destinations. If
* specified it precludes the direct specification of
* sassSourceDirectory/relativeOutputDirectory/destination parameters.
*
* Example configuration:
*
*
* <resource>
* <source>
* <directory>${basedir}/src/main/webapp</directory>
* <includes>
* <include>**/scss</include>
* </includes>
* </source>
* <relativeOutputDirectory>..</relativeOutputDirectory>
* <destination>${project.build.directory}/${project.build.finalName}</destination>
* </resource>
*
*
* @since 2.0
*/
@Parameter
private List resources = Collections.emptyList();
/**
* Defines paths where jruby will look for gems. E.g. a maven build could
* download gems into ${project.build.directory}/rubygems and a gemPath
* pointed to this directory. Finally, individual gems can be loaded via the
* <gems> configuration.
*
* @since 2.0
*/
@Parameter(defaultValue = "${project.build.directory}/rubygems")
private String[] gemPaths = new String[0];
/**
* Defines gems to be loaded before Sass/Compass. This is useful to add gems
* with custom Sass functions or stylesheets. Gems that hook into Compass
* are transparently added to Sass' load_path.
*
* @since 2.0
*/
@Parameter
private String[] gems = new String[0];
/**
* Build directory for the plugin.
*
* @since 2.0
*/
@Parameter(defaultValue = "${project.build.directory}")
private File buildDirectory;
/**
* Fail the build if errors occur during compilation of sass/scss templates.
*
* @since 2.0
*/
@Parameter(defaultValue = "true")
protected boolean failOnError;
/**
* Defines options for Sass::Plugin.options. See Sass
* options If the value is a string it must by quoted in the maven
* configuration: <cache_location>'/tmp/sass'</cache_location>
*
* If no options are set the default configuration set is used which is:
*
*
* <unix_newlines>true</unix_newlines>
* <cache>true</cache>
* <always_update>true</always_update>
* <cache_location>${project.build.directory}/sass_cache</cache_location>
* <style>:expanded</style>
*
*
* @since 2.0
*/
@Parameter
private Map sassOptions = new HashMap(
ImmutableMap.of("unix_newlines", "true", "cache", "true",
"always_update", "true", "style", ":expanded"));
/**
* Enable the use of Compass style library mixins.
*
* @since 2.0
*/
@Parameter(defaultValue = "false")
private boolean useCompass;
/**
* Directory containing Sass files, defaults to the Maven Web application
* sources directory (${basedir}/src/main/sass).
*
* @since 2.0
*/
@Parameter(defaultValue = "${basedir}/src/main/sass", property = "sassSourceDirectory")
private File sassSourceDirectory;
/**
* Defines files in the source directories to include.
*
* Defaults to: {@code **/scss}
*
* @since 2.0
*/
@Parameter
private String[] includes = new String[] { "**/scss" };
/**
* Defines which of the included files in the source directories to exclude
* (none by default).
*
* @since 2.0
*/
@Parameter
private String[] excludes;
/**
* Defines an additional path section when calculating the destination for
* the SCSS file. Allows, for example
* "/media/skins/universality/coal/scss/portal.scss" to end up at
* "/media/skins/universality/coal/portal.css" by specifying ".."
*
* @since 2.0
*/
@Parameter(defaultValue = "..")
private String relativeOutputDirectory;
/**
* Where to put the compiled CSS files.
*
* @since 2.0
*/
@Parameter(defaultValue = "${project.build.directory}/${project.build.finalName}/css")
private File destination;
/**
* Ruby version to use. Valid versions depend on the currently embedded JRuby runtime.
* For JRuby 1.7.x this is {@code 1.8}, {@code 1.9} (default) or
* {@code 2.0} (experimental).
*
* @since 2.1
*/
@Parameter(defaultValue = "1.9")
private Float rubyVersion;
/**
* Execute the Sass Compilation Ruby Script.
*
* @param sassScript
* the sass script
* @throws MojoExecutionException
* the mojo execution exception
* @throws MojoFailureException
* the mojo failure exception
*/
protected void executeSassScript(String sassScript)
throws MojoExecutionException, MojoFailureException {
final Log log = this.getLog();
System.setProperty("org.jruby.embed.localcontext.scope", "threadsafe");
System.setProperty("org.jruby.embed.compat.version",
String.format("ruby%2.0f", rubyVersion * 10));
log.debug("Setting 'org.jruby.embed.compat.version' to: "
+ String.format("ruby%2.0f", rubyVersion * 10));
log.debug("Execute Sass Ruby script:\n\n" + sassScript);
final ScriptEngineManager scriptEngineManager = new ScriptEngineManager();
final ScriptEngine jruby = scriptEngineManager.getEngineByName("jruby");
try {
final CompilerCallback compilerCallback = new CompilerCallback(log);
jruby.getBindings(ScriptContext.ENGINE_SCOPE).put(
"compiler_callback", compilerCallback);
jruby.eval(sassScript);
if (this.failOnError && compilerCallback.hadError()) {
throw new MojoFailureException(
"Sass compilation encountered errors (see above for details).");
}
} catch (final ScriptException e) {
throw new MojoExecutionException(
"Failed to execute Sass ruby script:\n" + sassScript, e);
}
log.debug("\n");
}
/**
* Builds the basic sass script.
*
* @param sassScript
* the sass script
* @throws MojoExecutionException
* the mojo execution exception
*/
protected void buildBasicSassScript(final StringBuilder sassScript)
throws MojoExecutionException {
final Log log = this.getLog();
sassScript.append("require 'rubygems'").append('\n');
if (this.gemPaths.length > 0) {
sassScript.append("env = { 'GEM_PATH' => [\n");
for (final String gemPath : this.gemPaths) {
sassScript.append(" '").append(gemPath).append("',\n");
}
final String gemPath = System.getenv("GEM_PATH");
if (gemPath != null) {
for (final String p : gemPath.split(File.pathSeparator)) {
sassScript.append(" '").append(p).append("',\n");
}
}
/* remove trailing comma+\n */
sassScript.setLength(sassScript.length() - 2);
sassScript.append('\n');
sassScript.append("] }").append('\n');
sassScript.append("Gem.paths = env").append('\n');
}
for (final String gem : this.gems) {
sassScript.append("require '").append(gem).append("'\n");
}
sassScript.append("require 'sass/plugin'\n");
sassScript.append("require 'java'\n");
if (this.useCompass) {
log.info("Running with Compass enabled.");
sassScript.append("require 'compass'").append('\n');
sassScript.append("require 'compass/exec'").append('\n');
sassScript.append("require 'compass/core'").append('\n');
sassScript.append("require 'compass/import-once'").append('\n');
sassScript.append("Compass.add_project_configuration ")
.append('\n');
this.sassOptions.put("load_paths",
"Compass.configuration.sass_load_paths");
}
// Get all template locations from resources and set option
// 'template_location' and
// 'css_location' (to override default "./public/stylesheets/sass",
// "./public/stylesheets")
// remaining locations are added later with 'add_template_location'
final Iterator> templateLocations = this
.getTemplateLocations();
if (templateLocations.hasNext()) {
final Entry location = templateLocations.next();
this.sassOptions.put("template_location",
"'" + location.getKey() + "'");
this.sassOptions.put("css_location",
"'" + location.getValue() + "'");
}
// If not explicitly set place the cache location in the target dir
if (!this.sassOptions.containsKey("cache_location")) {
final File sassCacheDir = new File(this.buildDirectory,
"sass_cache");
final String sassCacheDirStr = sassCacheDir.toString();
this.sassOptions.put("cache_location",
"'" + FilenameUtils.separatorsToUnix(sassCacheDirStr) + "'");
}
// Add the plugin configuration options
sassScript.append("Sass::Plugin.options.merge!(").append('\n');
for (final Iterator> entryItr = this.sassOptions
.entrySet().iterator(); entryItr.hasNext();) {
final Entry optEntry = entryItr.next();
final String opt = optEntry.getKey();
final String value = optEntry.getValue();
sassScript.append(" :").append(opt).append(" => ").append(value);
if (entryItr.hasNext()) {
sassScript.append(",");
}
sassScript.append('\n');
}
sassScript.append(")").append('\n');
// add remaining template locations with 'add_template_location' (need
// to be done after options.merge)
while (templateLocations.hasNext()) {
final Entry location = templateLocations.next();
sassScript.append("Sass::Plugin.add_template_location('")
.append(location.getKey()).append("', '")
.append(location.getValue()).append("')").append('\n');
}
// set up sass compiler callback for reporting
sassScript
.append("Sass::Plugin.on_compilation_error {|error, template, css| $compiler_callback.compilationError(error.message, template, css) }")
.append('\n');
sassScript
.append("Sass::Plugin.on_updated_stylesheet {|template, css| $compiler_callback.updatedStylesheeet(template, css) }")
.append('\n');
sassScript
.append("Sass::Plugin.on_template_modified {|template| $compiler_callback.templateModified(template) }")
.append('\n');
sassScript
.append("Sass::Plugin.on_template_created {|template| $compiler_callback.templateCreated(template) }")
.append('\n');
sassScript
.append("Sass::Plugin.on_template_deleted {|template| $compiler_callback.templateDeleted(template) }")
.append('\n');
// make ruby give use some debugging info when requested
if (log.isDebugEnabled()) {
sassScript.append("require 'pp'").append('\n');
sassScript.append("pp Sass::Plugin.options").append('\n');
if (this.useCompass) {
sassScript.append("pp Compass.base_directory").append('\n');
sassScript.append("pp Compass::Core.base_directory").append('\n');
sassScript.append("pp Compass::configuration").append('\n');
}
}
}
/**
* Gets the template locations.
*
* @return the template locations
*/
private Iterator> getTemplateLocations() {
final Log log = this.getLog();
List _resources = this.resources;
if (_resources.isEmpty()) {
log.info("No resource element was specified, using short configuration.");
// If no resources specified, create a resource based on the other
// parameters and defaults
final Resource resource = new Resource();
resource.source = new FileSet();
if (this.sassSourceDirectory != null) {
log.debug("Setting source directory: "
+ this.sassSourceDirectory.toString());
resource.source.setDirectory(this.sassSourceDirectory
.toString());
} else {
log.error("\"" + this.sassSourceDirectory
+ "\" is not a directory.");
resource.source.setDirectory("./src/main/sass");
}
if (this.includes != null) {
log.debug("Setting includes: " + Arrays.toString(this.includes));
resource.source.setIncludes(Arrays.asList(this.includes));
}
if (this.excludes != null) {
log.debug("Setting excludes: " + Arrays.toString(this.excludes));
resource.source.setExcludes(Arrays.asList(this.excludes));
}
resource.relativeOutputDirectory = this.relativeOutputDirectory;
resource.destination = this.destination;
_resources = ImmutableList.of(resource);
}
final List> locations = new ArrayList>();
for (final Resource source : _resources) {
for (final Entry entry : source
.getDirectoriesAndDestinations().entrySet()) {
log.info("Queueing Sass template for compile: "
+ entry.getKey() + " => " + entry.getValue());
locations.add(entry);
}
}
return locations.iterator();
}
/**
* @return the resources
*/
protected List getResources() {
return this.resources;
}
/**
* @return the useCompass
*/
protected boolean isUseCompass() {
return this.useCompass;
}
/**
* @return the sassSourceDirectory
*/
protected File getSassSourceDirectory() {
return this.sassSourceDirectory;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy