com.wandrell.velocity.tool.ConfigTool Maven / Gradle / Ivy
Show all versions of velocity-config-tool Show documentation
/**
* The MIT License (MIT)
*
* Copyright (c) 2017 the original author or authors.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package com.wandrell.velocity.tool;
import static com.google.common.base.Preconditions.checkNotNull;
import java.util.regex.Pattern;
import org.apache.maven.doxia.site.decoration.DecorationModel;
import org.apache.velocity.tools.ToolContext;
import org.apache.velocity.tools.config.DefaultKey;
import org.apache.velocity.tools.generic.SafeConfig;
import org.apache.velocity.tools.generic.ValueParser;
import org.codehaus.plexus.util.xml.Xpp3Dom;
/**
* Utilities class to ease using custom Maven Site configuration values through
* Velocity.
*
* The configuration values should be in the site.xml file, inside a {@code
* }, itself inside the {@code } element, like this:
*
*
* {@code
*
*
* }
*
*
* Any value stored there can be acquired through the use of the
* {@link #get(String) get} method. Note that thanks to Velocity inside a
* template any getter can be replaced by the field it returns, and this works
* with the {@code get} method too.
*
* This means that instead of using {@code $config.get("myproperty")}, the same
* value can be acquired with {@code $config.myproperty}.
*
* This tool is stateful, as it binds itself to the context and data of the page
* being rendered.
*
* @author Bernardo Martínez Garrido
*/
@DefaultKey("config")
public final class ConfigTool extends SafeConfig {
/**
* Identifier for the current file.
*
* This is a slug created from the current file's name.
*/
private String fileId;
/**
* Regex for multiple hyphens.
*/
private final Pattern multipleHyphen = Pattern.compile("-+");
/**
* Regex for non-latin characters.
*/
private final Pattern nonLatin = Pattern.compile("[^\\w-]");
/**
* Skin configuration node.
*
* This contains the custom configuration for the skin, as set inside the
* site.xml file, inside the {@code } node.
*/
private Xpp3Dom skinConfig = new Xpp3Dom("");
/**
* Regex for whitespaces.
*/
private final Pattern whitespace = Pattern.compile("[\\s]");
/**
* Constructs an instance of the {@code ConfigTool}.
*/
public ConfigTool() {
super();
}
/**
* Returns a configuration's node property.
*
* This node will be acquired from the custom skin configuration inside the
* site.xml file. If there is no node with a matching name then the returned
* value will be {@code null}.
*
* @param property
* the property being acquired
* @return the value assigned to the property in the skin custom
* configuration
*/
public final Xpp3Dom get(final String property) {
checkNotNull(property, "Received a null pointer as property");
return getSkinConfig().getChild(property);
}
/**
* Returns the file identifier.
*
* This is a slugged version of the current file name.
*
* With Velocity the value can be acquired by using the command
* {@code $config.fileId}.
*
* @return the file identifier
*/
public final String getFileId() {
return fileId;
}
/**
* Returns the regular expression for multiple hyphens.
*
* @return the regular expression for multiple hyphens
*/
private final Pattern getMultipleHyphenPattern() {
return multipleHyphen;
}
/**
* Returns the non-latin characters regular expression.
*
* @return the non-latin characters regular expression
*/
private final Pattern getNonLatinPattern() {
return nonLatin;
}
/**
* Returns the skin config node.
*
* This contains the custom configuration for the skin, as set inside the
* site.xml file, inside the {@code } node.
*
* @return the skin config node
*/
private final Xpp3Dom getSkinConfig() {
return skinConfig;
}
/**
* Returns the regular expression for whitespaces.
*
* @return the regular expression for whitespaces
*/
private final Pattern getWhitespacePattern() {
return whitespace;
}
/**
* Loads the file identifier from the velocity tools context.
*
* This is generated from the file's name.
*
* @param context
* the Velocity tools context
*/
private final void loadFileId(final ToolContext context) {
final Integer lastDot; // Location of the extension dot
final Object currentFileObj; // File's name as received
String currentFile; // File's name
if (context.containsKey(ConfigToolConstants.CURRENT_FILE_NAME_KEY)) {
currentFileObj = context
.get(ConfigToolConstants.CURRENT_FILE_NAME_KEY);
if (currentFileObj == null) {
setFileId("");
} else {
currentFile = String.valueOf(currentFileObj);
// Drops the extension
lastDot = currentFile.lastIndexOf('.');
if (lastDot >= 0) {
currentFile = currentFile.substring(0, lastDot);
}
// File name is slugged
setFileId(slug(currentFile));
}
} else {
setFileId("");
}
}
/**
* Processes the decoration model, acquiring the skin and page
* configuration.
*
* The decoration model are the contents of the site.xml file.
*
* @param model
* decoration data
*/
private final void processDecoration(final DecorationModel model) {
final Object customObj; // Object for the node
final Xpp3Dom customNode; // node
final Xpp3Dom skinNode; // node
customObj = model.getCustom();
if (customObj instanceof Xpp3Dom) {
// This is the node in the site.xml file
customNode = (Xpp3Dom) customObj;
// Acquires node
skinNode = customNode.getChild(ConfigToolConstants.SKIN_KEY);
if (skinNode == null) {
setSkinConfig(new Xpp3Dom(""));
} else {
setSkinConfig(skinNode);
}
}
}
/**
* Sets the identifier for the current file.
*
* @param id
* the identifier for the current file
*/
private final void setFileId(final String id) {
fileId = id;
}
/**
* Sets the skin config node.
*
* @param config
* the skin config node.
*/
private final void setSkinConfig(final Xpp3Dom config) {
skinConfig = config;
}
/**
* Returns a URL slug created from the received text.
*
* A slug is a human-readable version of the text, where all the special
* characters have been removed, and spaces have been swapped by dashes.
*
* For example: This, That & the Other! Various Outré
* Considerations would become
* this-that-the-other-various-outre-considerations
*
* Of course, this can be applied to any text, not just URLs, but it is
* usually used in the context of an URL.
*
* @param text
* text to generate the slug from
* @return the slug of the given text
*/
private final String slug(final String text) {
final String separator; // Separator for swapping whitespaces
String corrected; // Modified string
checkNotNull(text, "Received a null pointer as the text");
separator = "-";
corrected = text.replace('/', '-').replace('\\', '-').replace('.', '-')
.replace('_', '-');
// Removes multiple lines
corrected = getMultipleHyphenPattern().matcher(corrected)
.replaceAll(separator);
// Removes white spaces
corrected = getWhitespacePattern().matcher(corrected)
.replaceAll(separator);
// Removes non-latin characters
corrected = getNonLatinPattern().matcher(corrected).replaceAll("");
return corrected.toLowerCase();
}
/**
* Sets up the tool with the skin configuration and file id.
*/
@Override
protected final void configure(final ValueParser values) {
final Object velocityContext; // Value from the parser
final ToolContext ctxt; // Casted context
final Object decorationObj; // Value of the decoration key
checkNotNull(values, "Received a null pointer as values");
velocityContext = values.get(ConfigToolConstants.VELOCITY_CONTEXT_KEY);
if (velocityContext instanceof ToolContext) {
ctxt = (ToolContext) velocityContext;
loadFileId(ctxt);
decorationObj = ctxt.get(ConfigToolConstants.DECORATION_KEY);
if (decorationObj instanceof DecorationModel) {
processDecoration((DecorationModel) decorationObj);
}
}
}
}