com.github.juanmf.java2plant.Parser.java Source code

Java tutorial

Introduction

Here is the source code for com.github.juanmf.java2plant.Parser.java

Source

/*
 *  Copyright 2016 Juan Manuel Fernandez
 *
 *  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.juanmf.java2plant;

import java.lang.reflect.Constructor;
import java.lang.reflect.Field;
import java.lang.reflect.Member;
import java.lang.reflect.Method;
import java.lang.reflect.Modifier;
import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
import java.net.URL;
import java.net.URLClassLoader;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Set;

import com.github.juanmf.java2plant.structure.Implementation;
import com.github.juanmf.java2plant.util.CanonicalName;
import com.github.juanmf.java2plant.util.TypesHelper;
import com.google.common.eventbus.EventBus;
import org.apache.commons.lang3.StringUtils;
import org.reflections.Reflections;
import org.reflections.scanners.ResourcesScanner;
import org.reflections.scanners.SubTypesScanner;
import org.reflections.scanners.TypeElementsScanner;
import org.reflections.util.ClasspathHelper;
import org.reflections.util.ConfigurationBuilder;
import org.reflections.util.FilterBuilder;

import com.github.juanmf.java2plant.render.PlantRenderer;
import com.github.juanmf.java2plant.render.filters.Filter;
import com.github.juanmf.java2plant.structure.Aggregation;
import com.github.juanmf.java2plant.structure.Extension;
import com.github.juanmf.java2plant.structure.Relation;
import com.github.juanmf.java2plant.structure.Use;

/**
 * Iterates over all types available at runtime, under given package, creating:
 * <pre>
 *       Implementations: for Type implemented interfaces
 *       Extensions: for Type extended class
 *       Aggregations: for non private Types declared in Type, taking care of Collection<ActualType> situations
 *       Uses: for dependencies created by non private methods and constructors' parameters.
 * </pre>
 *
 * @author juanmf@gmail.com
 */

public class Parser {
    public static URLClassLoader CLASS_LOADER = null;
    private static final EventBus eventBus = new EventBus();

    /**
     * Parse the given package recursively, then iterates over found types to fetch their relations.
     *
     * @param packageToPase The root package to be parsed.
     *
     * @return PlantUML src code of a Collaboration Diagram for the types found in package and all
     * related Types.
     */
    public static String parse(String packageToPase, Filter<Class<? extends Relation>> relationTypeFilter,
            Filter<Class<?>> classesFilter, Filter<Relation> relationsFilter) throws ClassNotFoundException {
        List<ClassLoader> classLoadersList = new LinkedList<>();

        return parse(packageToPase, relationTypeFilter, classesFilter, relationsFilter, classLoadersList);
    }

    public static String parse(String packageToPase, Filter<Class<? extends Relation>> relationTypeFilter,
            Filter<Class<?>> classesFilter, Filter<Relation> relationsFilter, ClassLoader classLoader) {
        List<ClassLoader> classLoadersList = new LinkedList<>();
        classLoadersList.add(classLoader);
        return parse(packageToPase, relationTypeFilter, classesFilter, relationsFilter, classLoadersList);
    }

    public static String parse(String packageToPase, Filter<Class<? extends Relation>> relationTypeFilter,
            Filter<Class<?>> classesFilter, Filter<Relation> relationsFilter, List<ClassLoader> classLoadersList) {
        Set<Relation> relations = new HashSet<Relation>();
        Set<Class<?>> classes = getTypes(packageToPase, classLoadersList);
        for (Class<?> aClass : classes) {
            addFromTypeRelations(relations, aClass);
        }
        return new PlantRenderer(classes, relations, packageToPase, relationTypeFilter, classesFilter,
                relationsFilter).render();
    }

    public static EventBus getEventBus() {
        return eventBus;
    }

    private static Set<Class<?>> getTypes(String packageToPase, List<ClassLoader> classLoadersList) {
        Collection<URL> urls = getUrls(classLoadersList);
        Set<Class<?>> classes = new HashSet<>();
        for (String aPackage : TypesHelper.splitPackages(packageToPase)) {
            classes.addAll(getPackageTypes(aPackage, urls));
        }
        addSuperClassesAndInterfaces(classes);
        return classes;
    }

    private static void addSuperClassesAndInterfaces(Set<Class<?>> classes) {
        Set<Class<?>> newClasses = new HashSet<>();
        for (Class<?> c : classes) {
            addSuperClass(c, newClasses);
            addInterfaces(c, newClasses);
        }
        classes.addAll(newClasses);
    }

    private static void addInterfaces(Class<?> c, Set<Class<?>> newClasses) {
        Class<?>[] interfaces = c.getInterfaces();
        for (Class<?> i : interfaces) {
            newClasses.add(i);
            addInterfaces(i, newClasses);
        }
    }

    private static void addSuperClass(Class<?> c, Set<Class<?>> newClasses) {
        Class<?> superclass = c.getSuperclass();
        if (null == superclass || Object.class.equals(superclass)) {
            return;
        }
        newClasses.add(superclass);
        addSuperClass(superclass, newClasses);
        addInterfaces(superclass, newClasses);
    }

    private static Collection<? extends Class<?>> getPackageTypes(String packageToPase, Collection<URL> urls) {
        Set<Class<?>> classes = new HashSet<>();
        Reflections reflections = new Reflections(new ConfigurationBuilder()
                .setScanners(new SubTypesScanner(false /* exclude Object.class */), new ResourcesScanner(),
                        new TypeElementsScanner())
                .setUrls(urls).filterInputsBy(
                        new FilterBuilder().include(FilterBuilder.prefix(packageToPase)).exclude("java.*")));

        Set<String> types;
        types = reflections.getStore().get("TypeElementsScanner").keySet();
        for (String type : types) {
            Class<?> aClass = TypesHelper.loadClass(type, CLASS_LOADER);
            boolean wantedElement = StringUtils.startsWith(type, packageToPase);
            if (null != aClass && wantedElement) {
                System.out.println("looking up for type: " + type);
                classes.add(aClass);
            }
        }
        return classes;
    }

    private static Collection<URL> getUrls(List<ClassLoader> classLoadersList) {
        classLoadersList.add(ClasspathHelper.contextClassLoader());
        classLoadersList.add(ClasspathHelper.staticClassLoader());
        Collection<URL> urls = ClasspathHelper.forClassLoader(classLoadersList.toArray(new ClassLoader[0]));
        CLASS_LOADER = new URLClassLoader(urls.toArray(new URL[0]));
        return urls;
    }

    /**
     * For the given type, adds to relations:
     * <pre>
     *       Implementations: for Type implemented interfaces
     *       Extensions: for Type extended class
     *       Aggregations: for non private Types declared in Type, taking care of Collection<ActualType> situations
     *       Uses: for dependencies created by non private methods and constructors' parameters.
     * </pre>
     *
     * @param relations A Set to add found relations to.
     * @param fromType  The Type originating the relation.
     */
    protected static void addFromTypeRelations(Set<Relation> relations, Class<?> fromType) {
        addImplementations(relations, fromType);
        addExtensions(relations, fromType);
        addAggregations(relations, fromType);
        addUses(relations, fromType);
    }

    protected static void addImplementations(Set<Relation> relations, Class<?> fromType) {
        Class<?>[] interfaces = fromType.getInterfaces();
        for (Class<?> i : interfaces) {
            Relation anImplements = new Implementation(fromType, i.getName());
            relations.add(anImplements);
        }
    }

    protected static void addExtensions(Set<Relation> relations, Class<?> fromType) {
        Class<?> superclass = fromType.getSuperclass();
        if (null == superclass || Object.class.equals(superclass)) {
            return;
        }
        Relation extension = new Extension(fromType, superclass.getName());
        relations.add(extension);
    }

    protected static void addAggregations(Set<Relation> relations, Class<?> fromType) {
        Field[] declaredFields = fromType.getDeclaredFields();
        for (Field f : declaredFields) {
            addAggregation(relations, fromType, f);
        }
    }

    protected static void addUses(Set<Relation> relations, Class<?> fromType) {
        Method[] methods = fromType.getDeclaredMethods();
        for (Method m : methods) {
            if (!Modifier.isPrivate(m.getModifiers())) {
                addMethodUses(relations, fromType, m);
            }
        }
        Constructor<?>[] constructors = fromType.getDeclaredConstructors();
        for (Constructor<?> c : constructors) {
            if (!Modifier.isPrivate(c.getModifiers())) {
                addConstructorUses(relations, fromType, c);
            }
        }
    }

    protected static void addConstructorUses(Set<Relation> relations, Class<?> fromType, Constructor<?> c) {
        Type[] genericParameterTypes = c.getGenericParameterTypes();
        for (int i = 0; i < genericParameterTypes.length; i++) {
            addConstructorUse(relations, fromType, genericParameterTypes[i], c);
        }
    }

    protected static void addMethodUses(Set<Relation> relations, Class<?> fromType, Method m) {
        Type[] genericParameterTypes = m.getGenericParameterTypes();
        for (int i = 0; i < genericParameterTypes.length; i++) {
            addMethodUse(relations, fromType, genericParameterTypes[i], m);
        }
    }

    protected static void addConstructorUse(Set<Relation> relations, Class<?> fromType, Type toType,
            Constructor<?> c) {
        String name = TypesHelper.getSimpleName(c.getName()) + "()";
        addUse(relations, fromType, toType, c, name);
    }

    protected static void addUse(Set<Relation> relations, Class<?> fromType, Type toType, Member m, String msg) {
        String toName = toType.toString();
        if (isMulti(toType)) {
            if (!((Class) toType).isArray()) {
                if (toType instanceof ParameterizedType) {
                    ParameterizedType pt = (ParameterizedType) toType;
                    Set<String> typeVars = getTypeParams(pt);
                    for (String t : typeVars) {
                        msg += toName;
                        Relation use = new Use(fromType, t, m, msg);
                        relations.add(use);
                    }
                    return;
                }
            }
            toName = CanonicalName.getClassName(((Class) toType).getName());
        }
        Relation use = new Use(fromType, toName, m, msg);
        relations.add(use);
    }

    protected static void addMethodUse(Set<Relation> relations, Class<?> fromType, Type fromParameterType,
            Method m) {
        String name = TypesHelper.getSimpleName(m.getName()) + "()";
        addUse(relations, fromType, fromParameterType, m, name);
    }

    protected static boolean isMulti(Type type) {
        return (type instanceof Class) && (((Class) type).isArray()
                || Collection.class.isAssignableFrom((Class) type) || Map.class.isAssignableFrom((Class) type));
    }

    protected static void addAggregation(Set<Relation> relations, Class<?> fromType, Field f) {
        Class<?> delegateType = f.getType();
        String varName = f.getName();
        String message = varName + ": " + TypesHelper.getSimpleName(f.getGenericType().toString());
        String toCardinal = "1";
        String toName = delegateType.getName();
        if (isMulti(delegateType)) {
            toCardinal = "*";
            if (!delegateType.isArray()) {
                Set<String> typeVars = getTypeParams(f);
                for (String type : typeVars) {
                    Relation aggregation = new Aggregation(fromType, type, f, toCardinal, message);
                    relations.add(aggregation);
                }
                return;
            }
            toName = CanonicalName.getClassName(delegateType.getName());
        }
        Relation aggregation = new Aggregation(fromType, toName, f, toCardinal, message);
        relations.add(aggregation);
    }

    protected static Set<String> getTypeParams(Field f) {
        Type tp = f.getGenericType();
        if (tp instanceof ParameterizedType) {
            Set<String> typeVars = getTypeParams((ParameterizedType) tp);
            return typeVars;
        }
        return Collections.emptySet();
    }

    protected static Set<String> getTypeParams(ParameterizedType f) {
        Set<String> typeVars = new HashSet<>();
        Type[] actualTypeArguments = f.getActualTypeArguments();
        for (Type t : actualTypeArguments) {
            typeVars.add(t.toString().replace("class ", ""));
        }
        return typeVars;
    }
}