software.amazon.smithy.build.transforms.IncludeTraits Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *  http://aws.amazon.com/apache2.0
 *
 * or in the "license" file accompanying this file. This file 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 software.amazon.smithy.build.transforms;

import java.util.Collections;
import java.util.Set;
import java.util.logging.Logger;
import java.util.stream.Collectors;
import software.amazon.smithy.build.TransformContext;
import software.amazon.smithy.model.Model;
import software.amazon.smithy.model.shapes.Shape;
import software.amazon.smithy.model.shapes.ShapeId;
import software.amazon.smithy.model.traits.TraitDefinition;
import software.amazon.smithy.model.transform.ModelTransformer;
import software.amazon.smithy.utils.Pair;

/**
 * {@code includeTraits} removes trait definitions when a trait name
 * does not match one of the provided {@code traits} shape IDs. Any
 * instance of the trait is also removed from the model.
 *
 * End an argument with "#" to include the traits from an entire
 * namespace. Trait shape IDs that are relative are assumed to be part
 * of the {@code smithy.api} prelude namespace.
 */
public final class IncludeTraits extends BackwardCompatHelper {

    private static final Logger LOGGER = Logger.getLogger(IncludeTraits.class.getName());

    /**
     * {@code includeTraits} configuration settings.
     */
    public static final class Config {
        private Set traits = Collections.emptySet();

        /**
         * Gets the list of trait shape IDs to include.
         *
         * @return shape IDs to include.
         */
        public Set getTraits() {
            return traits;
        }

        /**
         * Sets the list of trait shape IDs to include.
         *
         * End an argument with "#" to include the traits from an entire
         * namespace. Trait shape IDs that are relative are assumed to be
         * part of the {@code smithy.api} prelude namespace.
         *
         * @param traits Traits to include.
         */
        public void setTraits(Set traits) {
            this.traits = traits;
        }
    }

    @Override
    public Class getConfigType() {
        return Config.class;
    }

    @Override
    public String getName() {
        return "includeTraits";
    }

    @Override
    String getBackwardCompatibleNameMapping() {
        return "traits";
    }

    @Override
    public Model transformWithConfig(TransformContext context, Config config) {
        Pair, Set> namesAndNamespaces = TraitRemovalUtils.parseTraits(config.getTraits());
        Set names = namesAndNamespaces.getLeft();
        Set namespaces = namesAndNamespaces.getRight();
        LOGGER.info(() -> "Including traits by ID " + names + " and namespaces " + namespaces);

        // Don't remove the trait definition trait because it breaks everything!
        names.add(TraitDefinition.ID);

        Model model = context.getModel();
        ModelTransformer transformer = context.getTransformer();

        Set removeTraits = model.getShapesWithTrait(TraitDefinition.class).stream()
                .filter(trait -> !TraitRemovalUtils.matchesTraitDefinition(trait, names, namespaces))
                .collect(Collectors.toSet());

        if (!removeTraits.isEmpty()) {
            LOGGER.info(() -> "Removing traits that are not explicitly allowed: " + removeTraits);
        }

        return transformer.removeShapes(model, removeTraits);
    }
}