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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of smithy-build Show documentation

This module is a library used to validate Smithy models, create filtered projections of a model, and generate build artifacts.

There is a newer version: 1.54.0

Show newest version

/*
 * 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.function.Predicate;
import software.amazon.smithy.build.TransformContext;
import software.amazon.smithy.model.Model;
import software.amazon.smithy.model.shapes.Shape;
import software.amazon.smithy.model.transform.ModelTransformer;

/**
 * {@code removeUnusedShapes} removes shapes from the model that are not
 * connected to any service shape.
 *
 * Shapes from the prelude *are* removed if they are not referenced as
 * part of a model.
 */
public final class RemoveUnusedShapes extends BackwardCompatHelper {

    /**
     * {@code removeUnusedShapes} configuration settings.
     */
    public static final class Config {

        private Set exportTagged = Collections.emptySet();

        /**
         * You can export shapes that are not connected to any service
         * shape by applying specific tags to the shape and adding the list of
         * export tags as an argument to the transformer.
         *
         * @param exportByTags Tags that cause shapes to be exported.
         */
        public void setExportTagged(Set exportByTags) {
            this.exportTagged = exportByTags;
        }

        /**
         * Gets the set of tags that are used to export shapes.
         *
         * @return the tags that are used to export shapes.
         */
        public Set getExportTagged() {
            return exportTagged;
        }
    }

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

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

    @Override
    public String getBackwardCompatibleNameMapping() {
        return "exportTagged";
    }

    @Override
    protected Model transformWithConfig(TransformContext context, Config config) {
        Predicate keepShapesByTag = shape -> config.getExportTagged().stream().noneMatch(shape::hasTag);
        Predicate keepTraitDefsByTag = trait -> config.getExportTagged().stream().noneMatch(trait::hasTag);
        Model model = context.getModel();
        ModelTransformer transformer = context.getTransformer();

        int currentShapeCount;
        do {
            currentShapeCount = model.toSet().size();
            model = transformer.removeUnreferencedShapes(model, keepShapesByTag);
            model = transformer.removeUnreferencedTraitDefinitions(model, keepTraitDefsByTag);
        } while (currentShapeCount != model.toSet().size());

        return model;
    }
}