FreemarkerConfigurer.java

package fr.sii.ogham.spring.template;

import static fr.sii.ogham.core.util.ConfigurationValueUtils.firstValue;
import static java.util.Optional.ofNullable;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.autoconfigure.freemarker.FreeMarkerProperties;
import org.springframework.context.ApplicationContext;

import fr.sii.ogham.core.builder.configurer.MessagingConfigurerAdapter;
import fr.sii.ogham.email.builder.EmailBuilder;
import fr.sii.ogham.sms.builder.SmsBuilder;
import fr.sii.ogham.spring.common.OghamTemplateProperties;
import fr.sii.ogham.spring.common.SpringMessagingConfigurer;
import fr.sii.ogham.spring.email.OghamEmailProperties;
import fr.sii.ogham.spring.sms.OghamSmsProperties;
import fr.sii.ogham.spring.template.freemarker.SpringBeansTemplateHashModelEx;
import fr.sii.ogham.template.freemarker.FreeMarkerParser;
import fr.sii.ogham.template.freemarker.FreemarkerConstants;
import fr.sii.ogham.template.freemarker.builder.AbstractFreemarkerBuilder;
import fr.sii.ogham.template.freemarker.builder.FreemarkerEmailBuilder;
import fr.sii.ogham.template.freemarker.builder.FreemarkerSmsBuilder;
import freemarker.ext.beans.BeansWrapper;
import freemarker.ext.beans.BeansWrapperBuilder;
import freemarker.template.Configuration;
import freemarker.template.ObjectWrapper;

/**
 * Integrates with Spring templating system by using Freemarker
 * {@link Configuration} object provided by Spring and by using Spring
 * properties defined with prefix {@code spring.freemarker} (see
 * {@link FreeMarkerProperties}).
 * 
 * If both Spring property and Ogham property is defined, Ogham property is
 * used.
 * 
 * For example, if the file application.properties contains the following
 * configuration:
 * 
 * <pre>
 * spring.freemarker.prefix=/email/
 * ogham.email.freemarker.path-prefix=/foo/
 * </pre>
 * 
 * The {@link FreeMarkerParser} will use the templates in "/foo/".
 * 
 * <p>
 * This configurer is also useful to support property naming variants (see
 * <a href=
 * "https://github.com/spring-projects/spring-boot/wiki/relaxed-binding-2.0">Relaxed
 * Binding</a>).
 * 
 * <p>
 * If ogham.freemarker.enable-spring-beans is true (default value), then Spring
 * Beans are available from the template using syntax
 * {@code @beanName.method(args)}.
 * 
 * <p>
 * If {@code ogham.freemarker.static-method-access.enable} is true (default
 * value), then static methods can be called from templates using
 * 
 * <pre>
 * {@code statics['full.package.name.ClassName'].method(args)}
 * </pre>
 * 
 * If {@code ogham.freemarker.static-method-access.variable-name} value is
 * changed (default value is 'statics'), then static methods can be called from
 * templates using another variable name. For example, configuring
 * {@code ogham.freemarker.static-method-access.variable-name=global} gives
 * access to static methods using name global:
 * 
 * <pre>
 * {@code global['full.package.name.ClassName'].method(args)}
 * </pre>
 * 
 * 
 * @author Aurélien Baudet
 *
 */
public class FreemarkerConfigurer extends MessagingConfigurerAdapter implements SpringMessagingConfigurer {
	private static final int SPRING_CONFIGURER_PRIORITY_OFFSET = 1000;

	private static final Logger LOG = LoggerFactory.getLogger(FreemarkerConfigurer.class);

	private final Configuration emailConfiguration;
	private final Configuration smsConfiguration;
	private final OghamCommonTemplateProperties templateProperties;
	private final OghamEmailProperties emailProperties;
	private final OghamSmsProperties smsProperties;
	private final FreeMarkerProperties springProperties;
	private final OghamFreemarkerProperties oghamFreemarkerProperties;
	private final ApplicationContext applicationContext;

	public FreemarkerConfigurer(Configuration emailConfiguration, Configuration smsConfiguration, OghamCommonTemplateProperties templateProperties, OghamEmailProperties emailProperties,
			OghamSmsProperties smsProperties, FreeMarkerProperties springProperties, OghamFreemarkerProperties oghamFreemarkerProperties, ApplicationContext applicationContext) {
		super();
		this.emailConfiguration = emailConfiguration;
		this.smsConfiguration = smsConfiguration;
		this.templateProperties = templateProperties;
		this.emailProperties = emailProperties;
		this.smsProperties = smsProperties;
		this.springProperties = springProperties;
		this.oghamFreemarkerProperties = oghamFreemarkerProperties;
		this.applicationContext = applicationContext;
	}

	@Override
	public void configure(EmailBuilder emailBuilder) {
		AbstractFreemarkerBuilder<?, ?> builder = emailBuilder.template(FreemarkerEmailBuilder.class);
		builder.mergeConfiguration(emailConfiguration);
		// specific Ogham properties explicitly take precedence over Spring
		// properties
		if (springProperties != null) {
			applySpringConfiguration(builder);
		}
		if (emailProperties != null) {
			applyOghamConfiguration(builder, emailProperties);
		}
		if (oghamFreemarkerProperties.getSpringBeans().isEnable()) {
			registerSpringBeans(builder, emailConfiguration);
		}
		if (oghamFreemarkerProperties.getStaticMethodAccess().isEnable()) {
			registerStatics(builder);
		}
	}

	@Override
	public void configure(SmsBuilder smsBuilder) {
		AbstractFreemarkerBuilder<?, ?> builder = smsBuilder.template(FreemarkerSmsBuilder.class);
		builder.mergeConfiguration(smsConfiguration);
		// specific Ogham properties explicitly take precedence over Spring
		// properties
		if (springProperties != null) {
			applySpringConfiguration(builder);
		}
		if (smsProperties != null) {
			applyOghamConfiguration(builder, smsProperties);
		}
		if (oghamFreemarkerProperties.getSpringBeans().isEnable()) {
			registerSpringBeans(builder, smsConfiguration);
		}
		if (oghamFreemarkerProperties.getStaticMethodAccess().isEnable()) {
			registerStatics(builder);
		}
	}

	@Override
	public int getOrder() {
		return FreemarkerConstants.DEFAULT_FREEMARKER_EMAIL_CONFIGURER_PRIORITY + SPRING_CONFIGURER_PRIORITY_OFFSET;
	}

	private void applyOghamConfiguration(AbstractFreemarkerBuilder<?, ?> builder, OghamTemplateProperties props) {
		LOG.debug("[{}] apply ogham configuration properties to {}", this, builder);
		// @formatter:off
		builder
			.classpath()
				.pathPrefix()
					.value(ofNullable(firstValue(props.getFreemarker().getClasspath().getPathPrefix(),
												props.getTemplate().getClasspath().getPathPrefix(),
												props.getFreemarker().getPathPrefix(),
												props.getTemplate().getPathPrefix(),
												templateProperties.getPathPrefix())))
					.and()
				.pathSuffix()
					.value(ofNullable(firstValue(props.getFreemarker().getClasspath().getPathSuffix(),
												props.getTemplate().getClasspath().getPathSuffix(),
												props.getFreemarker().getPathSuffix(),
												props.getTemplate().getPathSuffix(),
												templateProperties.getPathSuffix())))
					.and()
				.and()
			.file()
				.pathPrefix()
					.value(ofNullable(firstValue(props.getFreemarker().getFile().getPathPrefix(),
												props.getTemplate().getFile().getPathPrefix(),
												props.getFreemarker().getPathPrefix(),
												props.getTemplate().getPathPrefix(),
												templateProperties.getPathPrefix())))
					.and()
				.pathSuffix()
					.value(ofNullable(firstValue(props.getFreemarker().getFile().getPathSuffix(),
											props.getTemplate().getFile().getPathSuffix(),
											props.getFreemarker().getPathSuffix(),
											props.getTemplate().getPathSuffix(),
											templateProperties.getPathSuffix())));
		builder
			.configuration()
				.defaultEncoding().value(ofNullable(oghamFreemarkerProperties.getDefaultEncoding()));
		// @formatter:on
	}

	private void applySpringConfiguration(AbstractFreemarkerBuilder<?, ?> builder) {
		LOG.debug("[{}] apply spring configuration properties to {}", this, builder);
		// @formatter:off
		builder
			.classpath()
				.pathPrefix().value(ofNullable(springProperties.getPrefix())).and()
				.pathSuffix().value(ofNullable(springProperties.getSuffix())).and()
				.and()
			.file()
				.pathPrefix().value(ofNullable(springProperties.getPrefix())).and()
				.pathSuffix().value(ofNullable(springProperties.getSuffix()));
		builder
			.configuration()
				.defaultEncoding().value(ofNullable(springProperties.getCharsetName()));
		// @formatter:on
	}

	private void registerSpringBeans(AbstractFreemarkerBuilder<?, ?> builder, Configuration configuration) {
		builder.configuration().addSharedVariables(new SpringBeansTemplateHashModelEx(applicationContext, getBeansWrapper(configuration)));
	}

	private static BeansWrapper getBeansWrapper(Configuration configuration) {
		ObjectWrapper objectWrapper = configuration.getObjectWrapper();
		if (objectWrapper instanceof BeansWrapper) {
			return (BeansWrapper) objectWrapper;
		}
		return new BeansWrapperBuilder(configuration.getIncompatibleImprovements()).build();
	}

	private void registerStatics(AbstractFreemarkerBuilder<?, ?> builder) {
		builder.configuration()
			.enableStaticMethodAccess(true)
			.staticMethodAccessVariableName(oghamFreemarkerProperties.getStaticMethodAccess().getVariableName());
	}
}






















Active mutators

org.pitest.mutationtest.engine.gregor.mutators.BooleanFalseReturnValsMutator
org.pitest.mutationtest.engine.gregor.mutators.BooleanTrueReturnValsMutator
org.pitest.mutationtest.engine.gregor.mutators.ConditionalsBoundaryMutator
org.pitest.mutationtest.engine.gregor.mutators.EmptyObjectReturnValsMutator
org.pitest.mutationtest.engine.gregor.mutators.IncrementsMutator
org.pitest.mutationtest.engine.gregor.mutators.InvertNegsMutator
org.pitest.mutationtest.engine.gregor.mutators.MathMutator
org.pitest.mutationtest.engine.gregor.mutators.NegateConditionalsMutator
org.pitest.mutationtest.engine.gregor.mutators.NullReturnValsMutator
org.pitest.mutationtest.engine.gregor.mutators.PrimitiveReturnsMutator
org.pitest.mutationtest.engine.gregor.mutators.VoidMethodCallMutator

Tests examined

Report generated by PIT OGHAM

1		package fr.sii.ogham.spring.template;
2
3		import static fr.sii.ogham.core.util.ConfigurationValueUtils.firstValue;
4		import static java.util.Optional.ofNullable;
5
6		import org.slf4j.Logger;
7		import org.slf4j.LoggerFactory;
8		import org.springframework.boot.autoconfigure.freemarker.FreeMarkerProperties;
9		import org.springframework.context.ApplicationContext;
10
11		import fr.sii.ogham.core.builder.configurer.MessagingConfigurerAdapter;
12		import fr.sii.ogham.email.builder.EmailBuilder;
13		import fr.sii.ogham.sms.builder.SmsBuilder;
14		import fr.sii.ogham.spring.common.OghamTemplateProperties;
15		import fr.sii.ogham.spring.common.SpringMessagingConfigurer;
16		import fr.sii.ogham.spring.email.OghamEmailProperties;
17		import fr.sii.ogham.spring.sms.OghamSmsProperties;
18		import fr.sii.ogham.spring.template.freemarker.SpringBeansTemplateHashModelEx;
19		import fr.sii.ogham.template.freemarker.FreeMarkerParser;
20		import fr.sii.ogham.template.freemarker.FreemarkerConstants;
21		import fr.sii.ogham.template.freemarker.builder.AbstractFreemarkerBuilder;
22		import fr.sii.ogham.template.freemarker.builder.FreemarkerEmailBuilder;
23		import fr.sii.ogham.template.freemarker.builder.FreemarkerSmsBuilder;
24		import freemarker.ext.beans.BeansWrapper;
25		import freemarker.ext.beans.BeansWrapperBuilder;
26		import freemarker.template.Configuration;
27		import freemarker.template.ObjectWrapper;
28
29		/**
30		* Integrates with Spring templating system by using Freemarker
31		* {@link Configuration} object provided by Spring and by using Spring
32		* properties defined with prefix {@code spring.freemarker} (see
33		* {@link FreeMarkerProperties}).
34		*
35		* If both Spring property and Ogham property is defined, Ogham property is
36		* used.
37		*
38		* For example, if the file application.properties contains the following
39		* configuration:
40		*

FreemarkerConfigurer.java

Mutations

Active mutators

Tests examined