MainGapicProviderFactory.java

/* Copyright 2016 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.api.codegen.gapic;

import com.google.api.codegen.ApiConfig;
import com.google.api.codegen.InterfaceView;
import com.google.api.codegen.ProtoFileView;
import com.google.api.codegen.SnippetSetRunner;
import com.google.api.codegen.clientconfig.ClientConfigGapicContext;
import com.google.api.codegen.clientconfig.ClientConfigSnippetSetRunner;
import com.google.api.codegen.csharp.CSharpCodePathMapper;
import com.google.api.codegen.csharp.CSharpGapicContext;
import com.google.api.codegen.csharp.CSharpSnippetSetRunner;
import com.google.api.codegen.go.GoGapicContext;
import com.google.api.codegen.go.GoSnippetSetRunner;
import com.google.api.codegen.nodejs.NodeJSCodePathMapper;
import com.google.api.codegen.nodejs.NodeJSGapicContext;
import com.google.api.codegen.nodejs.NodeJSSnippetSetRunner;
import com.google.api.codegen.py.PythonGapicContext;
import com.google.api.codegen.py.PythonInterfaceInitializer;
import com.google.api.codegen.py.PythonProtoFileInitializer;
import com.google.api.codegen.py.PythonSnippetSetRunner;
import com.google.api.codegen.rendering.CommonSnippetSetRunner;
import com.google.api.codegen.ruby.RubyGapicContext;
import com.google.api.codegen.ruby.RubySnippetSetRunner;
import com.google.api.codegen.transformer.java.JavaGapicSurfaceTestTransformer;
import com.google.api.codegen.transformer.java.JavaGapicSurfaceTransformer;
import com.google.api.codegen.transformer.php.PhpGapicSurfaceTransformer;
import com.google.api.codegen.util.CommonRenderingUtil;
import com.google.api.codegen.util.java.JavaRenderingUtil;
import com.google.api.tools.framework.model.Interface;
import com.google.api.tools.framework.model.Model;
import com.google.api.tools.framework.model.ProtoFile;

import org.apache.commons.lang3.NotImplementedException;

import java.util.Arrays;
import java.util.List;

/** MainGapicProviderFactory creates GapicProvider instances based on an id. */
public class MainGapicProviderFactory
    implements GapicProviderFactory<GapicProvider<? extends Object>> {

  public static final String CLIENT_CONFIG = "client_config";
  public static final String CSHARP = "csharp";
  public static final String GO = "go";
  public static final String JAVA = "java";
  public static final String NODEJS = "nodejs";
  public static final String PHP = "php";
  public static final String PYTHON = "python";
  public static final String PYTHON_DOC = "python_doc";
  public static final String RUBY = "ruby";
  public static final String RUBY_DOC = "ruby_doc";

  /** Create the GapicProviders based on the given id */
  public static List<GapicProvider<? extends Object>> defaultCreate(
      Model model, ApiConfig apiConfig, String id) {

    // Please keep the following IDs in alphabetical order

    if (id.equals(CLIENT_CONFIG)) {
      GapicProvider<? extends Object> provider =
          CommonGapicProvider.<Interface>newBuilder()
              .setModel(model)
              .setView(new InterfaceView())
              .setContext(new ClientConfigGapicContext(model, apiConfig))
              .setSnippetSetRunner(
                  new ClientConfigSnippetSetRunner<Interface>(
                      SnippetSetRunner.SNIPPET_RESOURCE_ROOT))
              .setSnippetFileNames(Arrays.asList("clientconfig/json.snip"))
              .setCodePathMapper(CommonGapicCodePathMapper.defaultInstance())
              .build();
      return Arrays.<GapicProvider<? extends Object>>asList(provider);

    } else if (id.equals(CSHARP)) {
      GapicProvider<? extends Object> provider =
          CommonGapicProvider.<Interface>newBuilder()
              .setModel(model)
              .setView(new InterfaceView())
              .setContext(new CSharpGapicContext(model, apiConfig))
              .setSnippetSetRunner(
                  new CSharpSnippetSetRunner<Interface>(SnippetSetRunner.SNIPPET_RESOURCE_ROOT))
              .setSnippetFileNames(Arrays.asList("csharp/wrapper.snip"))
              .setCodePathMapper(new CSharpCodePathMapper())
              .build();
      return Arrays.<GapicProvider<? extends Object>>asList(provider);

    } else if (id.equals(GO)) {
      GapicProvider<? extends Object> provider =
          CommonGapicProvider.<Interface>newBuilder()
              .setModel(model)
              .setView(new InterfaceView())
              .setContext(new GoGapicContext(model, apiConfig))
              .setSnippetSetRunner(
                  new GoSnippetSetRunner<Interface>(SnippetSetRunner.SNIPPET_RESOURCE_ROOT))
              .setSnippetFileNames(
                  Arrays.asList("go/main.snip", "go/example.snip", "go/doc.snip", "go/common.snip"))
              .setCodePathMapper(CommonGapicCodePathMapper.defaultInstance())
              .build();
      return Arrays.<GapicProvider<? extends Object>>asList(provider);

    } else if (id.equals(JAVA)) {
      GapicCodePathMapper javaPathMapper =
          CommonGapicCodePathMapper.newBuilder()
              .setPrefix("src/main/java")
              .setShouldAppendPackage(true)
              .build();
      GapicProvider<? extends Object> mainProvider =
          ViewModelGapicProvider.newBuilder()
              .setModel(model)
              .setApiConfig(apiConfig)
              .setSnippetSetRunner(new CommonSnippetSetRunner(new JavaRenderingUtil()))
              .setModelToViewTransformer(new JavaGapicSurfaceTransformer(javaPathMapper))
              .build();

      GapicCodePathMapper javaTestPathMapper =
          CommonGapicCodePathMapper.newBuilder()
              .setPrefix("src/test/java")
              .setShouldAppendPackage(true)
              .build();
      GapicProvider<? extends Object> testProvider =
          ViewModelGapicProvider.newBuilder()
              .setModel(model)
              .setApiConfig(apiConfig)
              .setSnippetSetRunner(new CommonSnippetSetRunner(new CommonRenderingUtil()))
              .setModelToViewTransformer(new JavaGapicSurfaceTestTransformer(javaTestPathMapper))
              .build();

      return Arrays.<GapicProvider<? extends Object>>asList(mainProvider, testProvider);

    } else if (id.equals(NODEJS)) {
      GapicCodePathMapper nodeJSPathMapper = new NodeJSCodePathMapper();
      GapicProvider<? extends Object> mainProvider =
          CommonGapicProvider.<Interface>newBuilder()
              .setModel(model)
              .setView(new InterfaceView())
              .setContext(new NodeJSGapicContext(model, apiConfig))
              .setSnippetSetRunner(
                  new NodeJSSnippetSetRunner<Interface>(SnippetSetRunner.SNIPPET_RESOURCE_ROOT))
              .setSnippetFileNames(Arrays.asList("nodejs/main.snip"))
              .setCodePathMapper(nodeJSPathMapper)
              .build();
      GapicProvider<? extends Object> clientConfigProvider =
          CommonGapicProvider.<Interface>newBuilder()
              .setModel(model)
              .setView(new InterfaceView())
              .setContext(new ClientConfigGapicContext(model, apiConfig))
              .setSnippetSetRunner(
                  new ClientConfigSnippetSetRunner<Interface>(
                      SnippetSetRunner.SNIPPET_RESOURCE_ROOT))
              .setSnippetFileNames(Arrays.asList("clientconfig/json.snip"))
              .setCodePathMapper(nodeJSPathMapper)
              .build();

      return Arrays.<GapicProvider<? extends Object>>asList(mainProvider, clientConfigProvider);

    } else if (id.equals(PHP)) {
      GapicCodePathMapper phpPathMapper =
          CommonGapicCodePathMapper.newBuilder().setPrefix("src").build();
      GapicProvider<? extends Object> provider =
          ViewModelGapicProvider.newBuilder()
              .setModel(model)
              .setApiConfig(apiConfig)
              .setSnippetSetRunner(new CommonSnippetSetRunner(new CommonRenderingUtil()))
              .setModelToViewTransformer(new PhpGapicSurfaceTransformer(apiConfig, phpPathMapper))
              .build();

      GapicCodePathMapper phpClientConfigPathMapper =
          CommonGapicCodePathMapper.newBuilder().setPrefix("resources").build();
      GapicProvider<? extends Object> clientConfigProvider =
          CommonGapicProvider.<Interface>newBuilder()
              .setModel(model)
              .setView(new InterfaceView())
              .setContext(new ClientConfigGapicContext(model, apiConfig))
              .setSnippetSetRunner(
                  new ClientConfigSnippetSetRunner<Interface>(
                      SnippetSetRunner.SNIPPET_RESOURCE_ROOT))
              .setSnippetFileNames(Arrays.asList("clientconfig/json.snip"))
              .setCodePathMapper(phpClientConfigPathMapper)
              .build();
      return Arrays.<GapicProvider<? extends Object>>asList(provider, clientConfigProvider);

    } else if (id.equals(PYTHON) || id.equals(PYTHON_DOC)) {
      GapicCodePathMapper pythonPathMapper =
          CommonGapicCodePathMapper.newBuilder().setShouldAppendPackage(true).build();
      GapicProvider<? extends Object> mainProvider =
          CommonGapicProvider.<Interface>newBuilder()
              .setModel(model)
              .setView(new InterfaceView())
              .setContext(new PythonGapicContext(model, apiConfig))
              .setSnippetSetRunner(
                  new PythonSnippetSetRunner<Interface>(
                      new PythonInterfaceInitializer(), SnippetSetRunner.SNIPPET_RESOURCE_ROOT))
              .setSnippetFileNames(Arrays.asList("py/main.snip"))
              .setCodePathMapper(pythonPathMapper)
              .build();
      GapicProvider<? extends Object> clientConfigProvider =
          CommonGapicProvider.<Interface>newBuilder()
              .setModel(model)
              .setView(new InterfaceView())
              .setContext(new ClientConfigGapicContext(model, apiConfig))
              .setSnippetSetRunner(
                  new ClientConfigSnippetSetRunner<Interface>(
                      SnippetSetRunner.SNIPPET_RESOURCE_ROOT))
              .setSnippetFileNames(Arrays.asList("clientconfig/json.snip"))
              .setCodePathMapper(pythonPathMapper)
              .build();

      if (id.equals(PYTHON)) {
        return Arrays.<GapicProvider<? extends Object>>asList(mainProvider, clientConfigProvider);
      }

      GapicProvider<? extends Object> messageProvider =
          CommonGapicProvider.<ProtoFile>newBuilder()
              .setModel(model)
              .setView(new ProtoFileView())
              .setContext(new PythonGapicContext(model, apiConfig))
              .setSnippetSetRunner(
                  new PythonSnippetSetRunner<ProtoFile>(
                      new PythonProtoFileInitializer(), SnippetSetRunner.SNIPPET_RESOURCE_ROOT))
              .setSnippetFileNames(Arrays.asList("py/message.snip"))
              .setCodePathMapper(CommonGapicCodePathMapper.defaultInstance())
              .build();
      return Arrays.<GapicProvider<? extends Object>>asList(
          mainProvider, messageProvider, clientConfigProvider);

    } else if (id.equals(RUBY) || id.equals(RUBY_DOC)) {
      GapicCodePathMapper rubyPathMapper =
          CommonGapicCodePathMapper.newBuilder()
              .setPrefix("lib")
              .setShouldAppendPackage(true)
              .build();
      GapicProvider<? extends Object> mainProvider =
          CommonGapicProvider.<Interface>newBuilder()
              .setModel(model)
              .setView(new InterfaceView())
              .setContext(new RubyGapicContext(model, apiConfig))
              .setSnippetSetRunner(
                  new RubySnippetSetRunner<Interface>(SnippetSetRunner.SNIPPET_RESOURCE_ROOT))
              .setSnippetFileNames(Arrays.asList("ruby/main.snip"))
              .setCodePathMapper(rubyPathMapper)
              .build();
      GapicProvider<? extends Object> clientConfigProvider =
          CommonGapicProvider.<Interface>newBuilder()
              .setModel(model)
              .setView(new InterfaceView())
              .setContext(new ClientConfigGapicContext(model, apiConfig))
              .setSnippetSetRunner(
                  new ClientConfigSnippetSetRunner<Interface>(
                      SnippetSetRunner.SNIPPET_RESOURCE_ROOT))
              .setSnippetFileNames(Arrays.asList("clientconfig/json.snip"))
              .setCodePathMapper(rubyPathMapper)
              .build();

      if (id.equals(RUBY)) {
        return Arrays.<GapicProvider<? extends Object>>asList(mainProvider, clientConfigProvider);
      }

      GapicProvider<? extends Object> messageProvider =
          CommonGapicProvider.<ProtoFile>newBuilder()
              .setModel(model)
              .setView(new ProtoFileView())
              .setContext(new RubyGapicContext(model, apiConfig))
              .setSnippetSetRunner(
                  new RubySnippetSetRunner<ProtoFile>(SnippetSetRunner.SNIPPET_RESOURCE_ROOT))
              .setSnippetFileNames(Arrays.asList("ruby/message.snip"))
              .setCodePathMapper(rubyPathMapper)
              .build();
      return Arrays.<GapicProvider<? extends Object>>asList(
          mainProvider, messageProvider, clientConfigProvider);

    } else {
      throw new NotImplementedException("GapicProviderFactory: invalid id \"" + id + "\"");
    }
  }

  /** Create the GapicProviders based on the given id */
  @Override
  public List<GapicProvider<? extends Object>> create(Model model, ApiConfig apiConfig, String id) {
    return defaultCreate(model, apiConfig, id);
  }
}