All Downloads are FREE. Search and download functionalities are using the official Maven repository.

stream.doc.DocFinder Maven / Gradle / Ivy

There is a newer version: 0.9.24
Show newest version
/*
 *  streams library
 *
 *  Copyright (C) 2011-2014 by Christian Bockermann, Hendrik Blom
 * 
 *  streams is a library, API and runtime environment for processing high
 *  volume data streams. It is composed of three submodules "stream-api",
 *  "stream-core" and "stream-runtime".
 *
 *  The streams library (and its submodules) is free software: you can 
 *  redistribute it and/or modify it under the terms of the 
 *  GNU Affero General Public License as published by the Free Software 
 *  Foundation, either version 3 of the License, or (at your option) any 
 *  later version.
 *
 *  The stream.ai library (and its submodules) is distributed in the hope
 *  that it will be useful, but WITHOUT ANY WARRANTY; without even the implied 
 *  warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Affero General Public License for more details.
 *
 *  You should have received a copy of the GNU Affero General Public License
 *  along with this program.  If not, see http://www.gnu.org/licenses/.
 */
package stream.doc;

import java.lang.reflect.Modifier;
import java.net.URL;
import java.text.DecimalFormat;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.SortedSet;
import java.util.TreeSet;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import stream.Processor;
import stream.annotations.Internal;
import stream.io.Stream;

/**
 * @author chris
 * 
 */
public class DocFinder {

	static Logger log = LoggerFactory.getLogger(DocFinder.class);

	public final static Class[] CLASSES = new Class[] { Processor.class,
			Stream.class };

	public static boolean matches(String[] patterns, Class clazz) {

		if (patterns == null || patterns.length == 0)
			return true;

		try {
			String className = clazz.getCanonicalName();
			if (className == null)
				return false;
			log.info("ClassName is: {}", className);

			for (String pattern : patterns) {
				if (className.startsWith(pattern)) {
					return true;
				}
			}
		} catch (Exception e) {
			return false;
		}
		return false;
	}

	public static boolean implementsInterface(Class clazz, Class intf) {
		if (intf.isAssignableFrom(clazz))
			return true;
		return false;
	}

	/**
	 * @param args
	 */
	public static void main(String[] args) throws Exception {

		List> classes = ClassFinder.getClasses("");

		SortedSet docs = new TreeSet();
		SortedSet missing = new TreeSet();

		for (Class clazz : classes) {

			if (Modifier.isAbstract(clazz.getModifiers())
					|| Modifier.isInterface(clazz.getModifiers()))
				continue;

			if (clazz.isAnnotationPresent(Internal.class)) {
				System.out.println("Skipping internal class " + clazz);
				continue;
			}

			for (Class apiClass : CLASSES) {

				if (apiClass.isAssignableFrom(clazz)) {

					if (!matches(args, clazz)) {
						log.info("Skipping class {}", clazz);
						continue;
					}

					if (clazz.isAnnotationPresent(java.lang.Deprecated.class)) {
						System.out
								.println("Skipping deprecated class " + clazz);
						break;
					}

					log.debug("Found processor-class {}", clazz);
					log.debug("    clazz.getName() = {}", clazz.getName());
					String doc = "/" + clazz.getName().replace('.', '/')
							+ ".md";
					log.debug("    docs are at {}", doc);

					URL url = DocFinder.class.getResource(doc);
					if (url != null)
						docs.add(doc);
					else {
						missing.add(doc);
						log.error("No documentation provided for class {}",
								clazz);
					}
				}
			}
		}

		for (String doc : docs) {
			System.out.println("   " + doc);
		}
		System.out.println("");
		System.out.println("Missing documentation:");
		for (String doc : missing) {
			System.out.println("   " + doc);
		}

		Integer total = missing.size() + docs.size();
		Integer complete = docs.size();

		DecimalFormat fmt = new DecimalFormat("0.00%");
		System.out.println("Documentation completness is "
				+ fmt.format(complete.doubleValue() / total.doubleValue()));
	}

	/**
	 * @param packages
	 */
	public static Map, URL> findDocumentations(String[] packages)
			throws Exception {

		Map, URL> docTexts = new LinkedHashMap, URL>();

		List> classes = ClassFinder.getClasses("");

		SortedSet docs = new TreeSet();
		SortedSet missing = new TreeSet();

		for (Class clazz : classes) {

			if (Modifier.isAbstract(clazz.getModifiers())
					|| Modifier.isInterface(clazz.getModifiers()))
				continue;

			if (clazz.isAnnotationPresent(Internal.class)) {
				// System.out.println("Skipping internal class " + clazz);
				continue;
			}

			for (Class apiClass : CLASSES) {

				if (apiClass.isAssignableFrom(clazz)) {

					if (!matches(packages, clazz)) {
						log.info("Skipping class {}", clazz);
						continue;
					}

					if (clazz.isAnnotationPresent(java.lang.Deprecated.class)) {
						System.out
								.println("Skipping deprecated class " + clazz);
						break;
					}

					log.debug("Found processor-class {}", clazz);
					log.debug("    clazz.getName() = {}", clazz.getName());
					String doc = "/" + clazz.getName().replace('.', '/')
							+ ".md";
					log.debug("    docs are at {}", doc);

					URL url = DocFinder.class.getResource(doc);

					String tex = "/" + clazz.getName().replace('.', '/')
							+ ".tex";
					URL texUrl = DocFinder.class.getResource(tex);
					if (texUrl != null)
						url = texUrl;

					if (url != null) {
						docs.add(doc);

						docTexts.put(clazz, url);

					} else {
						missing.add(doc);
						log.error("No documentation provided for class {}",
								clazz);
					}
				}
			}
		}

		return docTexts;
	}
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy