com.google.devtools.moe.client.repositories.Revision.java Source code

Introduction

Here is the source code for com.google.devtools.moe.client.repositories.Revision.java

Source

/*
 * Copyright (c) 2011 Google, Inc.
 *
 * 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
 *
 * http://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 com.google.devtools.moe.client.repositories;

import static com.google.devtools.moe.client.gson.GsonUtil.getPropertyOrLegacy;

import com.google.auto.value.AutoValue;
import com.google.common.base.Strings;
import com.google.common.collect.ImmutableList;
import com.google.devtools.moe.client.MoeProblem;
import com.google.devtools.moe.client.gson.AutoValueGsonAdapter;
import com.google.devtools.moe.client.parser.RepositoryExpression;
import com.google.devtools.moe.client.project.ProjectContext;
import com.google.gson.FieldNamingPolicy;
import com.google.gson.Gson;
import com.google.gson.JsonDeserializationContext;
import com.google.gson.JsonDeserializer;
import com.google.gson.JsonElement;
import com.google.gson.JsonParseException;
import com.google.gson.annotations.JsonAdapter;

import java.lang.reflect.Type;
import java.util.List;

/**
 * A Revision in a source control system.
 */
@AutoValue
@JsonAdapter(AutoValueGsonAdapter.class)
public abstract class Revision {
    /** The label for the configured repository from which this revision originates. */
    public abstract String repositoryName();

    /** The unique ID assigned to this revision by the underlying revision control system. */
    public abstract String revId();

    public static Builder builder() {
        return new AutoValue_Revision.Builder();
    }

    @AutoValue.Builder
    interface Builder {
        Builder revId(String revId);

        Builder repositoryName(String repositoryName);

        Revision build();
    }

    @Override
    public String toString() {
        return this.repositoryName() + "{" + revId() + "}";
    }

    /**
     * Creates a revision using a long ID for convenience, primarily in testing.
     *
     * @see #create(String, String)
     */
    public static Revision create(long revId, String repositoryName) {
        return create(String.valueOf(revId), repositoryName);
    }

    public static Revision create(String revId, String repositoryName) {
        return builder().revId(revId).repositoryName(repositoryName).build();
    }

    /**
     * Return the list of Revisions given by a RepositoryExpression like "internal(revision=3,4,5)".
     */
    public static List<Revision> fromRepositoryExpression(RepositoryExpression repoEx, ProjectContext context) {
        RepositoryType repo = context.getRepository(repoEx.getRepositoryName());
        if (Strings.isNullOrEmpty(repoEx.getOption("revision"))) {
            throw new MoeProblem(
                    "Repository expression must have a 'revision' option, e.g. internal(revision=3,4,5).");
        }

        RevisionHistory rh = repo.revisionHistory();
        ImmutableList.Builder<Revision> revBuilder = ImmutableList.builder();
        for (String revId : repoEx.getOption("revision").split(",")) {
            revBuilder.add(rh.findHighestRevision(revId));
        }
        return revBuilder.build();
    }

    /**
     * Since legacy {@link Revision} sections in the MOE Db use camelCase field names,
     * {@link Revision} can't use the standard {@link AutoValueGsonAdapter} which uses whatever
     * the field name strategy of the {@link Gson} object.  {@link Gson} in MOE has been built to
     * use {@link FieldNamingPolicy#LOWER_CASE_WITH_UNDERSCORES}. This change results in
     * {@link Revision} json looking like:
     * <pre><code>{repository_name=name, rev_id="blah"}</code></pre>
     */
    public static final class Deserializer implements JsonDeserializer<Revision> {
        @Override
        public Revision deserialize(JsonElement json, Type typeOfT, JsonDeserializationContext context)
                throws JsonParseException {
            Builder builder = Revision.builder();
            builder.revId(getPropertyOrLegacy(context, String.class, json, "rev_id", "revId"));
            builder.repositoryName(
                    getPropertyOrLegacy(context, String.class, json, "repository_name", "repositoryName"));
            return builder.build();
        }
    }
}