org.grails.cli.compiler.GenericBomAstTransformation Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of grace-shell Show documentation
Grace Framework : Grace Shell
There is a newer version: 2023.1.0-RC1
/*
 * Copyright 2012-2023 the original author or authors.
 *
 * 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
 *
 *      https://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 org.grails.cli.compiler;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;

import org.codehaus.groovy.ast.ASTNode;
import org.codehaus.groovy.ast.AnnotatedNode;
import org.codehaus.groovy.ast.AnnotationNode;
import org.codehaus.groovy.ast.ClassHelper;
import org.codehaus.groovy.ast.ClassNode;
import org.codehaus.groovy.ast.ModuleNode;
import org.codehaus.groovy.ast.PackageNode;
import org.codehaus.groovy.ast.expr.ConstantExpression;
import org.codehaus.groovy.ast.expr.Expression;
import org.codehaus.groovy.ast.expr.ListExpression;
import org.codehaus.groovy.control.CompilePhase;
import org.codehaus.groovy.control.SourceUnit;
import org.codehaus.groovy.transform.GroovyASTTransformation;
import org.springframework.core.Ordered;

import org.grails.cli.groovy.DependencyManagementBom;

/**
 * A base class that lets plugin authors easily add additional BOMs to all apps. All the
 * dependencies in the BOM (and its transitives) will be added to the dependency
 * management lookup, so an app can use just the artifact id (e.g. "spring-jdbc") in a
 * {@code @Grab}. To install, implement the missing methods and list the class in
 * {@code META-INF/services/org.springframework.boot.cli.compiler.SpringBootAstTransformation}
 * . The {@link #getOrder()} value needs to be before
 * {@link DependencyManagementBomTransformation#ORDER}.
 *
 * @author Dave Syer
 * @since 2022.1.0
 */
@GroovyASTTransformation(phase = CompilePhase.CONVERSION)
public abstract class GenericBomAstTransformation implements SpringBootAstTransformation, Ordered {

    private static final ClassNode BOM = ClassHelper.make(DependencyManagementBom.class);

    @Override
    public void visit(ASTNode[] nodes, SourceUnit source) {
        for (ASTNode astNode : nodes) {
            if (astNode instanceof ModuleNode) {
                visitModule((ModuleNode) astNode, getBomModule());
            }
        }
    }

    /**
     * The bom to be added to dependency management in compact form:
     * {@code "::"} (like in a {@code @Grab}).
     *
     * @return the maven co-ordinates of the BOM to add
     */
    protected abstract String getBomModule();

    private void visitModule(ModuleNode node, String module) {
        addDependencyManagementBom(node, module);
    }

    private void addDependencyManagementBom(ModuleNode node, String module) {
        AnnotatedNode annotated = getAnnotatedNode(node);
        if (annotated != null) {
            AnnotationNode bom = getAnnotation(annotated);
            List expressions = new ArrayList<>(getConstantExpressions(bom.getMember("value")));
            expressions.add(new ConstantExpression(module));
            bom.setMember("value", new ListExpression(expressions));
        }
    }

    private AnnotationNode getAnnotation(AnnotatedNode annotated) {
        List annotations = annotated.getAnnotations(BOM);
        if (!annotations.isEmpty()) {
            return annotations.get(0);
        }
        AnnotationNode annotation = new AnnotationNode(BOM);
        annotated.addAnnotation(annotation);
        return annotation;
    }

    private AnnotatedNode getAnnotatedNode(ModuleNode node) {
        PackageNode packageNode = node.getPackage();
        if (packageNode != null && !packageNode.getAnnotations(BOM).isEmpty()) {
            return packageNode;
        }
        if (!node.getClasses().isEmpty()) {
            return node.getClasses().get(0);
        }
        return packageNode;
    }

    private List getConstantExpressions(Expression valueExpression) {
        if (valueExpression instanceof ListExpression) {
            return getConstantExpressions((ListExpression) valueExpression);
        }
        if (valueExpression instanceof ConstantExpression
                && ((ConstantExpression) valueExpression).getValue() instanceof String) {
            return Arrays.asList((ConstantExpression) valueExpression);
        }
        return Collections.emptyList();
    }

    private List getConstantExpressions(ListExpression valueExpression) {
        List expressions = new ArrayList<>();
        for (Expression expression : valueExpression.getExpressions()) {
            if (expression instanceof ConstantExpression
                    && ((ConstantExpression) expression).getValue() instanceof String) {
                expressions.add((ConstantExpression) expression);
            }
        }
        return expressions;
    }

}