Refactoring PHP generation to use the MVVM pattern

src/main/java/com/google/api/codegen/ServiceConfig.java

@@ -20,9 +20,9 @@
 import com.google.api.tools.framework.model.Interface;
 
 import java.util.Arrays;
-import java.util.HashSet;
 import java.util.List;
 import java.util.Set;
+import java.util.TreeSet;
 
 /**
  * Utility class that provides service configuration data from an Interface.
@@ -50,7 +50,7 @@ public String getTitle(Interface service) {
    * Return a list of scopes for authentication.
    */
   public Iterable<String> getAuthScopes(Interface service) {
-    Set<String> result = new HashSet<>();
+    Set<String> result = new TreeSet<>();
     Service config = service.getModel().getServiceConfig();
     Authentication auth = config.getAuthentication();
     for (AuthenticationRule rule : auth.getRulesList()) {

src/main/java/com/google/api/codegen/ServiceMessages.java

@@ -33,6 +33,10 @@ public class ServiceMessages {
    * Returns true if the message is the empty message.
    */
   public boolean isEmptyType(TypeRef type) {
+    return s_isEmptyType(type);
+  }
+
+  public static boolean s_isEmptyType(TypeRef type) {
     return type.isMessage()
         && type.getMessageType().getFullName().equals(Empty.getDescriptor().getFullName());
   }

src/main/java/com/google/api/codegen/csharp/CSharpContextCommon.java

@@ -50,6 +50,7 @@ public String addImport(String namespace) {
    */
   public Iterable<String> getXmlDocLines(String text, String element) {
     // TODO(jonskeet): Convert markdown to XML documentation format.
+    // https://github.com/googleapis/toolkit/issues/331
     List<String> result = new ArrayList<>();
     result.add("/// <" + element + ">");
     for (String line : Splitter.on(String.format("%n")).split(text)) {
@@ -65,6 +66,7 @@ public Iterable<String> getXmlDocLines(String text, String element) {
    */
   public Iterable<String> getXmlParameterLines(String text, String parameterName) {
     // TODO(jonskeet): Convert markdown to XML documentation format.
+    // https://github.com/googleapis/toolkit/issues/331
     List<String> result = new ArrayList<>();
     result.add("/// <paramref name=\"" + parameterName + "\">");
     for (String line : Splitter.on(String.format("%n")).split(text)) {

src/main/java/com/google/api/codegen/gapic/MainGapicProviderFactory.java

@@ -15,11 +15,11 @@
 package com.google.api.codegen.gapic;
 
 import com.google.api.codegen.ApiConfig;
-import com.google.api.codegen.clientconfig.ClientConfigGapicContext;
 import com.google.api.codegen.InterfaceListView;
 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;
@@ -31,23 +31,24 @@
 import com.google.api.codegen.java.JavaSnippetSetRunner;
 import com.google.api.codegen.nodejs.NodeJSGapicContext;
 import com.google.api.codegen.nodejs.NodeJSSnippetSetRunner;
-import com.google.api.codegen.php.PhpGapicContext;
-import com.google.api.codegen.php.PhpSnippetSetRunner;
 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.php.PhpGapicSurfaceTransformer;
+import com.google.api.codegen.util.CommonRenderingUtil;
 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;
 
+import org.apache.commons.lang3.NotImplementedException;
+
 /**
  * MainGapicProviderFactory creates GapicProvider instances based on an id.
  */
@@ -173,14 +174,11 @@ public static List<GapicProvider<? extends Object>> defaultCreate(
       GapicCodePathMapper phpPathMapper =
           CommonGapicCodePathMapper.newBuilder().setPrefix("src").build();
       GapicProvider<? extends Object> provider =
-          CommonGapicProvider.<Interface>newBuilder()
+          ViewModelGapicProvider.newBuilder()
               .setModel(model)
-              .setView(new InterfaceView())
-              .setContext(new PhpGapicContext(model, apiConfig))
-              .setSnippetSetRunner(
-                  new PhpSnippetSetRunner<Interface>(SnippetSetRunner.SNIPPET_RESOURCE_ROOT))
-              .setSnippetFileNames(Arrays.asList("php/main.snip"))
-              .setCodePathMapper(phpPathMapper)
+              .setApiConfig(apiConfig)
+              .setSnippetSetRunner(new CommonSnippetSetRunner(new CommonRenderingUtil()))
+              .setModelToViewTransformer(new PhpGapicSurfaceTransformer(apiConfig, phpPathMapper))
               .build();
 
       GapicCodePathMapper phpClientConfigPathMapper =

src/main/java/com/google/api/codegen/gapic/ViewModelGapicProvider.java

@@ -0,0 +1,122 @@
+/* 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.rendering.CommonSnippetSetRunner;
+import com.google.api.codegen.transformer.ModelToViewTransformer;
+import com.google.api.codegen.viewmodel.ViewModel;
+import com.google.api.tools.framework.model.Interface;
+import com.google.api.tools.framework.model.Model;
+import com.google.api.tools.framework.model.stages.Merged;
+import com.google.api.tools.framework.snippet.Doc;
+
+import java.util.List;
+import java.util.Map;
+import java.util.TreeMap;
+
+public class ViewModelGapicProvider implements GapicProvider<Interface> {
+  private final Model model;
+  private final ApiConfig apiConfig;
+  private final CommonSnippetSetRunner snippetSetRunner;
+  private final ModelToViewTransformer modelToViewTransformer;
+
+  private ViewModelGapicProvider(
+      Model model,
+      ApiConfig apiConfig,
+      CommonSnippetSetRunner snippetSetRunner,
+      ModelToViewTransformer modelToViewTransformer) {
+    this.model = model;
+    this.apiConfig = apiConfig;
+    this.snippetSetRunner = snippetSetRunner;
+    this.modelToViewTransformer = modelToViewTransformer;
+  }
+
+  @Override
+  public List<String> getSnippetFileNames() {
+    return modelToViewTransformer.getTemplateFileNames();
+  }
+
+  @Override
+  public Map<String, Doc> generate() {
+    return generate(null);
+  }
+
+  @Override
+  public Map<String, Doc> generate(String snippetFileName) {
+    // Establish required stage for generation.
+    model.establishStage(Merged.KEY);
+    if (model.getDiagCollector().getErrorCount() > 0) {
+      return null;
+    }
+
+    List<ViewModel> surfaceDocs = modelToViewTransformer.transform(model, apiConfig);
+    if (model.getDiagCollector().getErrorCount() > 0) {
+      return null;
+    }
+
+    Map<String, Doc> docs = new TreeMap<>();
+    for (ViewModel surfaceDoc : surfaceDocs) {
+      if (snippetFileName != null && !surfaceDoc.templateFileName().equals(snippetFileName)) {
+        continue;
+      }
+      Doc doc = snippetSetRunner.generate(surfaceDoc);
+      if (doc == null) {
+        // generation failed; failures are captured in the model.
+        continue;
+      }
+      docs.put(surfaceDoc.outputPath(), doc);
+    }
+
+    return docs;
+  }
+
+  public static Builder newBuilder() {
+    return new Builder();
+  }
+
+  public static class Builder {
+    private Model model;
+    private ApiConfig apiConfig;
+    private CommonSnippetSetRunner snippetSetRunner;
+    private ModelToViewTransformer modelToViewTransformer;
+
+    private Builder() {}
+
+    public Builder setModel(Model model) {
+      this.model = model;
+      return this;
+    }
+
+    public Builder setApiConfig(ApiConfig apiConfig) {
+      this.apiConfig = apiConfig;
+      return this;
+    }
+
+    public Builder setSnippetSetRunner(CommonSnippetSetRunner snippetSetRunner) {
+      this.snippetSetRunner = snippetSetRunner;
+      return this;
+    }
+
+    public Builder setModelToViewTransformer(ModelToViewTransformer modelToViewTransformer) {
+      this.modelToViewTransformer = modelToViewTransformer;
+      return this;
+    }
+
+    public ViewModelGapicProvider build() {
+      return new ViewModelGapicProvider(model, apiConfig, snippetSetRunner, modelToViewTransformer);
+    }
+  }
+}

src/main/java/com/google/api/codegen/java/JavaContextCommon.java

@@ -128,7 +128,8 @@ public Iterable<String> getJavaDocLines(String text) {
    * firstLinePrefix. Markdown will be translated to javadoc.
    */
   public Iterable<String> getJavaDocLinesWithPrefix(String text, String firstLinePrefix) {
-    // TODO(wgg): convert markdown to javadoc
+    // TODO: convert markdown to javadoc
+    // https://github.com/googleapis/toolkit/issues/331
     List<String> result = new ArrayList<>();
     String linePrefix = firstLinePrefix;
     text = JAVADOC_ESCAPER.escape(text);

src/main/java/com/google/api/codegen/metacode/FieldSetting.java

@@ -14,6 +14,7 @@
  */
 package com.google.api.codegen.metacode;
 
+import com.google.api.codegen.util.Name;
 import com.google.api.tools.framework.model.TypeRef;
 import com.google.auto.value.AutoValue;
 
@@ -25,7 +26,7 @@
 public abstract class FieldSetting {
 
   public static FieldSetting create(
-      TypeRef type, String fieldName, String identifier, InitValueConfig initValueConfig) {
+      TypeRef type, Name fieldName, Name identifier, InitValueConfig initValueConfig) {
     return new AutoValue_FieldSetting(type, fieldName, identifier, initValueConfig);
   }
 
@@ -37,12 +38,12 @@ public static FieldSetting create(
   /**
    * Returns the name of the field in the containing structure.
    */
-  public abstract String getFieldName();
+  public abstract Name getFieldName();
 
   /**
    * Returns the name of the identifier being set on the field.
    */
-  public abstract String getIdentifier();
+  public abstract Name getIdentifier();
 
   /**
    * Returns the InitValueConfig for the original identifier.