org.jmolecules.bytebuddy.JMoleculesElementMatchers Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jmolecules-bytebuddy-nodep Show documentation
Modules to integrate jMolecules abstractions with implementation technologies
There is a newer version: 0.24.1
Show newest version
/*
 * Copyright 2021-2024 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.jmolecules.bytebuddy;

import static java.util.function.Predicate.*;
import static org.jmolecules.bytebuddy.PluginUtils.*;

import net.bytebuddy.description.annotation.AnnotationList;
import net.bytebuddy.description.field.FieldDescription;
import net.bytebuddy.description.method.MethodDescription;
import net.bytebuddy.description.type.TypeDefinition;
import net.bytebuddy.description.type.TypeDescription;
import net.bytebuddy.description.type.TypeDescription.Generic;
import net.bytebuddy.matcher.ElementMatcher;

import java.lang.annotation.Annotation;
import java.util.Arrays;
import java.util.Collection;
import java.util.List;
import java.util.Objects;

import org.jmolecules.bytebuddy.PluginLogger.Log;
import org.jmolecules.ddd.types.Entity;
import org.jmolecules.ddd.types.ValueObject;

/**
 * @author Oliver Drotbohm
 * @author Simon Zambrovski
 */
class JMoleculesElementMatchers {

	private static final List PACKAGE_PREFIX_TO_SKIP = Arrays.asList("java", "javax", "kotlin");

	public static ElementMatcher isEntity() {
		return it -> it.isAssignableTo(Entity.class) || hasAnnotation(it, org.jmolecules.ddd.annotation.Entity.class);
	}

	public static ElementMatcher isCollectionOfEntity() {

		return it -> it.asErasure().isAssignableTo(Collection.class) //
				&& isEntity().matches(it.asGenericType().getTypeArguments().get(0).asErasure());
	}

	public static ElementMatcher isCollectionOfValueObject() {

		return it -> it.asErasure().isAssignableTo(Collection.class) //
				&& isValueObject().matches(it.asGenericType().getTypeArguments().get(0).asErasure());
	}

	static boolean hasAnnotation(TypeDescription type, Class annotation) {

		Objects.requireNonNull(type, "Type must not be null!");

		AnnotationList found = type.getDeclaredAnnotations();

		if (found.isAnnotationPresent(annotation)) {
			return true;
		}

		if (found.isEmpty()) {
			return false;
		}

		return found.asTypeList() //
				.stream() //
				.filter(not(JMoleculesElementMatchers::residesInPlatformPackage)) //
				.anyMatch(it -> hasAnnotation(it, annotation));
	}

	/**
	 * Matcher checking, if the method is annotated.
	 *
	 * @param type type to check for.
	 * @param source source code.
	 * @param target target representation.
	 * @return element matcher.
	 */
	static ElementMatcher hasAnnotatedMethod(TypeDescription type,
			Class source, Class target, PluginLogger.Log log) {

		return method -> {

			TypeDefinition owningType = method.getDeclaringType();

			if (!owningType.equals(type) || residesInPlatformPackage(owningType.asErasure())) {
				return false;
			}

			AnnotationList annotations = method.getDeclaredAnnotations();

			if (annotations.isAnnotationPresent(target)) {
				// log.info("Already annotated with @{}.", PluginUtils.abbreviate(target));
				return false;
			}

			if (!annotations.isAnnotationPresent(source)) {
				// log.info("Annotation {} not found.", PluginUtils.abbreviate(source));
				return false;
			}

			log.info("Adding @{} to {}.", abbreviate(target), abbreviate(method));

			return true;
		};
	}

	/**
	 * Matcher checking, whether the field is annotated with the given annotation type.
	 *
	 * @param type type to check for.
	 * @param source source code.
	 * @param target target representation.
	 * @return element matcher.
	 */
	static ElementMatcher hasAnnotatedField(TypeDescription type,
			Class source, Class target, Log log) {

		if (type == null) {
			throw new IllegalArgumentException("Type must not be null!");
		}

		return field -> {

			TypeDefinition owningType = field.getDeclaringType();

			if (!owningType.equals(type) || residesInPlatformPackage(owningType.asErasure())) {
				return false;
			}

			AnnotationList annotations = field.getDeclaredAnnotations();
			String signature = toLog(field);

			if (annotations.isAnnotationPresent(target)) {
				// log.info("{} - Already annotated with @{}.", signature, abbreviate(target));
				return false;
			}

			if (!annotations.isAnnotationPresent(source)) {
				// log.info("{} - Annotation {} not found.", signature, abbreviate(source));
				return false;
			}

			log.info("Adding @{} to {}.", abbreviate(target), signature);

			return true;
		};
	}

	public static boolean residesInPlatformPackage(TypeDescription type) {
		return residesInAnyPackageStartingWith(type, PACKAGE_PREFIX_TO_SKIP);
	}

	/**
	 * Check that passes if given type is living in one of packages that start with the given prefixes.
	 *
	 * @param target type description
	 * @param prefixes the prefixes to skip
	 * @return true if the type is inside a package starting with one of specified prefix.
	 */
	private static boolean residesInAnyPackageStartingWith(TypeDescription target, List prefixes) {

		return target.getPackage() != null //
				&& prefixes.stream().anyMatch(it -> target.getPackage().getName().startsWith(it));
	}

	private static ElementMatcher isValueObject() {

		return it -> it.isAssignableTo(ValueObject.class)
				|| hasAnnotation(it, org.jmolecules.ddd.annotation.ValueObject.class);
	}
}