com.lewisd.maven.lint.util.ModelUtil Maven / Gradle / Ivy

Go to download
package com.lewisd.maven.lint.util;

import java.lang.reflect.Field;
import java.util.Collection;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;

import org.apache.maven.model.Dependency;
import org.apache.maven.model.Exclusion;
import org.apache.maven.model.InputLocation;
import org.apache.maven.model.Model;
import org.apache.maven.model.Plugin;
import org.apache.maven.model.PluginExecution;
import org.apache.maven.plugin.logging.Log;
import org.apache.maven.project.MavenProject;
import org.springframework.beans.factory.annotation.Autowired;

import com.lewisd.maven.lint.model.Coordinates;
import com.lewisd.maven.lint.model.ExtDependency;
import com.lewisd.maven.lint.model.ExtPlugin;
import com.lewisd.maven.lint.model.ObjectWithPath;

public class ModelUtil {

    private static final Object[] EMPTY_OBJECT_ARRAY = new Object[] {};
    @SuppressWarnings("rawtypes")
    private static final Class[] EMPTY_CLASS_ARRAY = new Class[] {};
    private final ReflectionUtil reflectionUtil;
    private final ExpressionEvaluator expressionEvaluator;
    private final Log log;

    @Autowired
    public ModelUtil(final ReflectionUtil reflectionUtil, final ExpressionEvaluator expressionEvaluator,
                     final Log log) {
        this.reflectionUtil = reflectionUtil;
        this.expressionEvaluator = expressionEvaluator;
        this.log = log;
    }

    /*
     * TODO: This reflection nonsense is all a bit rubish.  Let's add useful interfaces to the ExtPlugin, ExtDependency, etc
     * classes, and create instances of those instead.
     */

    public InputLocation getLocation(final Object modelObject) {
        return getLocation(modelObject, "");
    }

    public InputLocation getLocation(final Object modelObject, final Object key) {
        final String methodName = "getLocation";
        return (InputLocation) reflectionUtil.callMethod(modelObject, methodName, new Class[] { Object.class }, new Object[] { key });
    }

    public String getVersion(final Object modelObject) {
        final String methodName = "getVersion";
        return (String) reflectionUtil.callMethod(modelObject, methodName, EMPTY_CLASS_ARRAY, EMPTY_OBJECT_ARRAY);
    }

    public String getArtifactId(final Object modelObject) {
        final String methodName = "getArtifactId";
        return (String) reflectionUtil.callMethod(modelObject, methodName, EMPTY_CLASS_ARRAY, EMPTY_OBJECT_ARRAY);
    }

    public String getGroupId(final Object modelObject) {
        final String methodName = "getGroupId";
        return (String) reflectionUtil.callMethod(modelObject, methodName, EMPTY_CLASS_ARRAY, EMPTY_OBJECT_ARRAY);
    }

    public String getType(final Object modelObject) {
        final String methodName = "getType";
        return (String) reflectionUtil.callMethod(modelObject, methodName, EMPTY_CLASS_ARRAY, EMPTY_OBJECT_ARRAY);
    }

    public String tryGetType(final Object modelObject) {
        try {
            return getType(modelObject);
        } catch (final IllegalArgumentException e) {
            return null;
        }
    }

    public String getClassifier(final Object modelObject) {
        final String methodName = "getClassifier";
        return (String) reflectionUtil.callMethod(modelObject, methodName, EMPTY_CLASS_ARRAY, EMPTY_OBJECT_ARRAY);
    }

    public String tryGetClassifier(final Object modelObject) {
        try {
            return getClassifier(modelObject);
        } catch (final IllegalArgumentException e) {
            return null;
        }
    }

    public String getKey(final Object modelObject) {

        if (modelObject instanceof Dependency) {
            return ((Dependency) modelObject).getManagementKey();
        } else if (modelObject instanceof Plugin) {
            return ((Plugin) modelObject).getKey();
        } else {
            throw new IllegalArgumentException("Unknown object type: " + modelObject.getClass());
        }
    }

    @SuppressWarnings("rawtypes")
    public Map getLocations(final Object modelObject) {
        final Class klass = modelObject.getClass();
        final Map locations = getLocations(modelObject, klass);

        if (modelObject instanceof Plugin) {
            final Plugin plugin = (Plugin) modelObject;
            final List executions = plugin.getExecutions();
            if (executions != null && !executions.isEmpty()) {
                final PluginExecution pluginExecution = executions.get(0);
                final InputLocation location = pluginExecution.getLocation("");
                if (location != null) {
                    locations.put("execution", location);
                } else {
                    log.warn("Unable to determine location for " + pluginExecution);
                }
            }
        } else if (modelObject instanceof Dependency) {
            final Dependency dependency = (Dependency) modelObject;
            final List exclusions = dependency.getExclusions();
            if (exclusions != null && !exclusions.isEmpty()) {
                final Exclusion exclusion = exclusions.get(0);
                final InputLocation location = exclusion.getLocation("");
                if (location != null) {
                    locations.put("exclusion", location);
                } else {
                    log.warn("Unable to determine location for " + exclusion);
                }
            }
        }

        return locations;
    }

    public Collection