dev.aherscu.qa.jgiven.reporter.TemplateUtils Maven / Gradle / Ivy

Go to download
// Generated by delombok at Thu Jan 11 10:24:50 UTC 2024
/*
 * Copyright 2024 Adrian Herscu
 *
 * 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 dev.aherscu.qa.jgiven.reporter;

import static dev.aherscu.qa.testing.utils.FileUtilsExtensions.*;
import static java.nio.charset.StandardCharsets.*;
import static java.util.Objects.*;
import static org.apache.commons.lang3.StringUtils.*;

import java.io.*;

import com.samskivert.mustache.*;

import lombok.*;
import lombok.extern.slf4j.*;

// TODO move to qa-jgiven-reporter module
/**
 * Template utilities.
 *
 * @author aherscu
 */
public final class TemplateUtils {
    /**
     * @param compiler
     *            the {@link com.samskivert.mustache.Mustache.Compiler} to use
     * @return the loader
     */
    public static Loader using(final Mustache.Compiler compiler) {
        return new TemplateUtils.Loader(compiler);
    }

    /**
     * Loads Mustache
     * Templates.
     *
     * @author aherscu
     */
    public static class Loader {
        @java.lang.SuppressWarnings("all")
        private static final org.slf4j.Logger log =
            org.slf4j.LoggerFactory.getLogger(Loader.class);
        final Mustache.Compiler               compiler;

        /**
         * @param compiler
         *            the {@link com.samskivert.mustache.Mustache.Compiler} to
         *            use
         */
        public Loader(final Mustache.Compiler compiler) {
            this.compiler = compiler;
        }

        /**
         * Loads a template from a file.
         *
         * @param file
         *            the file to load from
         * @return the template
         * @throws IOException
         *             if no such file
         */
        public Template loadFrom(final File file) throws IOException {
            log.debug("loading template from {}", file.toString()); //$NON-NLS-1$
            try (Reader fileReader = fileReader(file)) {
                return loadFrom(fileReader);
            }
        }

        /**
         * Loads a template from a stream reader.
         *
         * @param reader
         *            the stream reader
         * @return the template
         */
        public Template loadFrom(final Reader reader) {
            return compiler.defaultValue(EMPTY).compile(reader);
        }

        /**
         * Loads a template from a resource.
         *
         * @param name
         *            the name of the resource
         * @return the template
         */
        public Template loadFrom(final String name) {
            try {
                log.debug("loading template resource from {}", name); //$NON-NLS-1$
                try (var r = new InputStreamReader(requireNonNull(
                    TemplateUtils.class.getResourceAsStream(name),
                    name + " resource missing"), UTF_8)) {
                    return loadFrom(r);
                }
            } catch (final java.lang.Throwable $ex) {
                throw lombok.Lombok.sneakyThrow($ex);
            }
        }
    }

    @java.lang.SuppressWarnings("all")
    private TemplateUtils() {
        throw new java.lang.UnsupportedOperationException(
            "This is a utility class and cannot be instantiated");
    }
}