org.thymeleaf.testing.templateengine.engine.resolver.TestEngineTemplateResolver Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of thymeleaf-testing Show documentation
XML/XHTML/HTML5 template engine for Java
There is a newer version: 3.1.0.M2
/*
 * =============================================================================
 * 
 *   Copyright (c) 2011-2016, The THYMELEAF team (http://www.thymeleaf.org)
 * 
 *   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.thymeleaf.testing.templateengine.engine.resolver;

import java.util.Map;

import org.thymeleaf.IEngineConfiguration;
import org.thymeleaf.cache.AlwaysValidCacheEntryValidity;
import org.thymeleaf.cache.ICacheEntryValidity;
import org.thymeleaf.cache.NonCacheableCacheEntryValidity;
import org.thymeleaf.templatemode.TemplateMode;
import org.thymeleaf.templateresolver.ITemplateResolver;
import org.thymeleaf.templateresolver.TemplateResolution;
import org.thymeleaf.templateresource.ITemplateResource;
import org.thymeleaf.testing.templateengine.engine.TestExecutor;
import org.thymeleaf.testing.templateengine.exception.TestEngineExecutionException;
import org.thymeleaf.testing.templateengine.resource.ITestResource;
import org.thymeleaf.testing.templateengine.testable.ITest;
import org.thymeleaf.util.Validate;







public class TestEngineTemplateResolver implements ITemplateResolver {

    public static final String TEST_TEMPLATE_CONVERSION_CHARSET = "UTF-8";


    private String name = this.getClass().getName();
    private Integer order = null;




    public TestEngineTemplateResolver() {
        super();
    }



    /**
     * 
     *   Returns the name of the template resolver
     * 
     *
     * @return the name of the template resolver
     */
    public String getName() {
        return this.name;
    }


    /**
     * 
     *   Sets a new name for the Template Resolver.
     * 
     *
     * @param name the new name
     */
    public void setName(final String name) {
        this.name = name;
    }


    /**
     * 
     *   Returns the order in which this template resolver will be asked to resolve
     *   templates as a part of the chain of resolvers configured into the template engine.
     * 
     * 
     *   Order should start with 1.
     * 
     *
     * @return the order in which this template resolver will be called in the chain.
     */
    public Integer getOrder() {
        return this.order;
    }


    /**
     * 
     *   Sets a new order for the template engine in the chain. Order should start with 1.
     * 
     *
     * @param order the new order.
     */
    public void setOrder(final Integer order) {
        this.order = order;
    }


    public TemplateResolution resolveTemplate(
            final IEngineConfiguration configuration, final String ownerTemplate, final String template, final Map templateResolutionAttributes) {

        Validate.notNull(configuration, "Configuration cannot be null");

        final ITest test = TestExecutor.getThreadTest(); 
        final String testName = TestExecutor.getThreadTestName();

        // Check template mode
        final Map additionalTemplateModes = test.getAdditionalTemplateModes();
        final TemplateMode templateMode;
        if (additionalTemplateModes != null && additionalTemplateModes.containsKey(template)) {
            templateMode = additionalTemplateModes.get(template);
        } else {
            templateMode = test.getTemplateMode();
        }
        if (templateMode == null) {
            throw new TestEngineExecutionException(
                    "Template mode is null for test \"" + testName + "\", which is forbidden");
        }

        
        // Check input
        final ITestResource input = test.getInput();
        if (input == null) {
            throw new TestEngineExecutionException(
                    "Input is null for test \"" + testName + "\", which is forbidden");
        }

        final ITestResource testResource;
        if (testName.equals(template)) {
            // We have been asked for the main test resource
            testResource = test.getInput();
        } else {
            if (test.getAdditionalInputs() != null) {
                testResource = test.getAdditionalInputs().get(template);
            } else {
                testResource = null;
            }
        }

        if (testResource == null) {
            // Not found!
            return null;
        }

        final ITemplateResource templateResource =
                new TestEngineTemplateResource(testResource, TEST_TEMPLATE_CONVERSION_CHARSET);

        // Compute validity according to the "inputCacheable" property established at the test
        final ICacheEntryValidity validity =
                (test.isInputCacheable()?
                        AlwaysValidCacheEntryValidity.INSTANCE :
                        NonCacheableCacheEntryValidity.INSTANCE);
                
        
        
        // Create the template resolution object with all the gathered info
        return new TemplateResolution(
                templateResource,
                true,         // Test template resolver always verifies the existence of resources (might be improvable)
                templateMode,
                false,
                validity);
        
    }
    
    
}