jmms.plugins.SwaggerDoc Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jmms-plugins-swagger-doc Show documentation
There is a newer version: 0.6.2
Show newest version
/*
 *  Copyright 2018 the original author or authors.
 *
 *  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 jmms.plugins;

import leap.lang.Charsets;
import leap.lang.Strings;
import leap.lang.Try;
import leap.lang.io.*;
import leap.lang.json.JSON;
import leap.lang.json.JsonObject;
import leap.lang.logging.Log;
import leap.lang.logging.LogFactory;
import leap.lang.resource.Resource;
import leap.lang.resource.ResourceSet;
import leap.lang.resource.Resources;
import leap.lang.yaml.YAML;

import java.io.File;
import java.io.FileInputStream;
import java.io.FileReader;
import java.io.InputStreamReader;
import java.nio.charset.Charset;
import java.nio.file.*;
import java.nio.file.Files;
import java.nio.file.Paths;
import java.util.Map;

public class SwaggerDoc {

    private static final Log log = LogFactory.get(SwaggerDoc.class);

    private FileChangeMonitor monitor;

    private volatile JsonObject swagger;

    private final String dir;

    public SwaggerDoc() {
        this("./doc/");
    }

    public SwaggerDoc(String dir) {
        this.dir = leap.lang.path.Paths.suffixWithSlash(dir);

        Map map = null;
        File swaggerFile = Paths.get(dir).resolve("./swagger.json").toFile();
        if(swaggerFile.exists()) {
            map = JSON.decodeMap(IO.readString(swaggerFile, Charsets.UTF_8));
        }else {
            swaggerFile = Paths.get(dir).resolve("./swagger.yaml").toFile();
            if(swaggerFile.exists()) {
                map = YAML.decode(Resources.createFileResource(swaggerFile).getContent());
            }
        }
        if(null != map) {
            this.swagger = JsonObject.of(map);
        }
    }

    public String getDir() {
        return dir;
    }

    public void init() {
        Path doc  = Paths.get(dir);
        copyGitbookFiles(doc);
        copyGitbookTemplates(doc);

        File dir1 = new File(dir + "_i18n/");
        File dir2 = new File(dir + "_templates/");

        if(dir1.exists() || dir2.exists()) {
            if(null == monitor) {
                monitor = new FileChangeMonitor(2000);
            }

            FileChangeListener listener = new FileChangeListenerAdaptor2() {
                @Override
                protected void onChanged(FileChangeObserver observer, FileChangeEvent event, File fileOrDirectory) {
                    log.info("Doc changed, re-generate it");
                    gen();
                }
            };

            if(dir1.exists()) {
                monitor.addObserver(new FileChangeObserver(dir1, listener));
            }
            if(dir2.exists()) {
                monitor.addObserver(new FileChangeObserver(dir2, listener));
            }

            Try.throwUnchecked(() -> monitor.start());
            log.info("Watching doc changes...");
        }
    }

    protected void copyGitbookFiles(Path doc) {
        String root = Templates.ROOT_CLASS_PATH + "gitbook/";
        String loc  = "classpath:" + root + "**/*.*";
        ResourceSet rs = Resources.scan(loc);
        log.info("Scan {} gitbook files from '{}'", rs.size(), loc);
        for(Resource r : rs) {
            if(r.exists()) {
                Path path = doc.resolve(Strings.removeStart(r.getClasspath(), root));
                File file = path.toFile();
                if(!file.exists()) {
                    Try.throwUnchecked(() -> Files.createDirectories(path.getParent()));
                    log.info("Create gitbook file : {}", path.normalize());
                    IO.writeString(path.toFile(), r.getContent());
                }
            }
        }
    }

    protected void copyGitbookTemplates(Path doc) {
        doc = doc.resolve("./_templates/");
        String root = Templates.ROOT_CLASS_PATH + "markdown/";
        String loc  = "classpath:" + root + "**/*.*";
        ResourceSet rs = Resources.scan(loc);
        log.info("Scan {} templates files from '{}'", rs.size(), loc);
        for(Resource r : rs) {
            if(r.exists()) {
                Path path = doc.resolve(Strings.removeStart(r.getClasspath(), root));
                File file = path.toFile();
                if(!file.exists()) {
                    Try.throwUnchecked(() -> Files.createDirectories(path.getParent()));
                    log.info("Create template file : {}", path.normalize());
                    IO.writeString(path.toFile(), r.getContent());
                }
            }
        }
    }

    public void close() {
        if(null != monitor) {
            try {
                monitor.stop();
            }catch (Exception e) {
                log.warn("Err stop file monitor : {}", e.getMessage());
            }finally {
                monitor = null;
            }
        }
    }

    public boolean hasSwagger() {
        return null != swagger;
    }

    public void gen(JsonObject swagger) {
        this.swagger = swagger;
        gen();
    }

    public void gen() {
        SwaggerDocGen gen = new SwaggerDocGen(dir, "zh");
        gen.execute(swagger);
        log.info("Swagger doc generated");
    }
}