JsDocParser.java

package com.atlassian.labs.speakeasy.commonjs.util;

import com.google.common.base.Predicate;
import com.google.common.collect.ArrayListMultimap;
import com.google.common.collect.ListMultimap;
import org.netbeans.lib.cvsclient.commandLine.command.log;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.regex.Pattern;

import static com.google.common.collect.Iterables.filter;
import static com.google.common.collect.Maps.newHashMap;
import static java.util.Arrays.asList;

/**
 *
 */
public class JsDocParser
{
    private static final String DESCRIPTION = "desc";
    private static final Logger log = LoggerFactory.getLogger(JsDocParser.class);
    public static final JsDoc EMPTY_JSDOC = new JsDoc("");

    public static JsDoc parse(String moduleId, String content)
    {
        if (content == null)
        {
            return EMPTY_JSDOC;
        }
        if (content.startsWith("/**"))
        {
            final String noStars = stripStars(content);
            Iterable<String> tokens = filter(asList(noStars.split("(?:^|[\\r\\n])\\s*@")), new Predicate<String>()
            {
                public boolean apply(String input)
                {
                    return input.trim().length() > 0;
                }
            });

            ListMultimap<String,String> tags = ArrayListMultimap.create();
            int x = 0;
            for (String token : tokens)
            {
                if (x++ == 0 && !noStars.startsWith("@"))
                {
                    tags.put(DESCRIPTION, token.trim());
                }
                else
                {
                    int spacePos = token.indexOf(' ');
                    if (spacePos > -1)
                    {
                        String value = token.substring(spacePos + 1);
                        StringBuilder sb = new StringBuilder();
                        for (String line : value.split("(?:\\r\\n)|\\r|\\n"))
                        {
                            sb.append(line.trim()).append(" ");
                        }
                        tags.put(token.substring(0, spacePos).toLowerCase(), sb.toString().trim());
                    }
                    else
                    {
                        tags.put(token.toLowerCase(), token.toLowerCase());
                    }
                }
            }
            Map<String,Collection<String>> attributes = tags.asMap();
            Collection<String> descriptions = attributes.remove(DESCRIPTION);
            return new JsDoc(descriptions != null ? descriptions.iterator().next() : null, attributes);
        }
        else
        {
            log.debug("Module '{}' doesn't start with /** so not parsed as a jsdoc comment", moduleId);
            return EMPTY_JSDOC;
        }
    }

    static String stripStars(String jsDoc)
    {
        String noStartOrEndStars = jsDoc != null ? jsDoc.replaceAll("^\\/\\*\\*|\\*\\/$", "") : "";
        String result = Pattern.compile("^\\s*\\* ?", Pattern.MULTILINE).matcher(noStartOrEndStars).replaceAll("");
        return result.trim();
    }

    static Map<String,String> extractAttributes(String jsDocWithNoStars)
    {
        return null;
    }
}