com.github.lightdocs.processor.DocumentedByAnnotationProcessor.java Source code

Introduction

Here is the source code for com.github.lightdocs.processor.DocumentedByAnnotationProcessor.java

Source

/* 
   Copyright 2013 Sebastian Esponda
    
   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 com.github.lightdocs.processor;

import groovy.lang.Binding;
import groovy.lang.GroovyShell;

import java.io.IOException;
import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
import java.net.URL;
import java.nio.charset.Charset;

import org.apache.commons.lang3.Validate;

import com.github.lightdocs.dsl.DocumentedBy;
import com.github.lightdocs.event.OperationAddedEvent;
import com.github.lightdocs.event.ParameterAddedEvent;
import com.github.lightdocs.model.Operation;
import com.google.common.base.Charsets;
import com.google.common.eventbus.Subscribe;
import com.google.common.io.Resources;

public class DocumentedByAnnotationProcessor {

    private static final String DSL_CONTAINER_SCRIPT;

    static {
        URL url = DocumentedByAnnotationProcessor.class.getResource("DSLContainer.groovy");
        try {
            DSL_CONTAINER_SCRIPT = Resources.toString(url, Charset.defaultCharset());
        } catch (IOException e) {
            throw new RuntimeException(e);
        }
    }

    @Subscribe
    public void handle(OperationAddedEvent e) {
        Method method = e.getMethod();
        Operation operation = e.getOperation();
        DocumentedBy ann = method.getAnnotation(DocumentedBy.class);

        if (ann != null) {
            runDocumentationScriptInAnnotation(operation, ann);
        }
    }

    private void runDocumentationScriptInAnnotation(Object node, DocumentedBy annotation) {
        String script = loadScript(Validate.notBlank(annotation.value()));
        Binding binding = new Binding();
        binding.setVariable("node", node);
        GroovyShell shell = new GroovyShell(binding);
        shell.evaluate(DSL_CONTAINER_SCRIPT.replace("${docScript}", script));
    }

    private String loadScript(String resPath) {
        String script;
        try {
            URL resUrl;
            if (resPath.toLowerCase().startsWith("http://") || resPath.toLowerCase().startsWith("file://")) {
                resUrl = new URL(resPath);
            } else {
                resUrl = getClass().getResource(resPath);
            }
            script = Resources.toString(resUrl, Charsets.UTF_8);
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
        return script;
    }

    @Subscribe
    public void handle(ParameterAddedEvent e) {
        for (Annotation annotation : e.getParameterAnnotations()) {
            if (annotation.annotationType().equals(DocumentedBy.class)) {
                runDocumentationScriptInAnnotation(e.getParameter(), (DocumentedBy) annotation);
                return;
            }
        }
    }
}