ch.ifocusit.livingdoc.plugin.utils.AsciidocUtil.java Source code

Introduction

Here is the source code for ch.ifocusit.livingdoc.plugin.utils.AsciidocUtil.java

Source

/*
 * Living Documentation
 *
 * Copyright (C) 2017 Focus IT
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 ch.ifocusit.livingdoc.plugin.utils;

import ch.ifocusit.livingdoc.plugin.baseMojo.AbstractAsciidoctorMojo.Format;
import org.apache.commons.io.FilenameUtils;
import org.apache.commons.lang3.StringEscapeUtils;
import org.asciidoctor.Asciidoctor;

import java.nio.file.Path;
import java.util.Optional;

/**
 * @author Julien Boz
 */
public class AsciidocUtil {

    public static final String NEWLINE = System.getProperty("line.separator");

    public static boolean isAdoc(Path path) {
        return isAdoc(path.toString());
    }

    public static boolean isAdoc(String filename) {
        return FilenameUtils.isExtension(filename, new String[] { Format.adoc.name(), Format.asciidoc.name() });
    }

    public static Optional<String> getTitle(Asciidoctor asciidoctor, String pageContent) {
        return Optional.ofNullable(asciidoctor.readDocumentHeader(pageContent).getDocumentTitle())
                .map(title -> StringEscapeUtils.unescapeHtml4(title.getMain()));
    }
}