[ggj][engx] refactor: move comment composers into dedicated package

src/main/java/com/google/api/generator/gapic/BUILD.bazel

@@ -6,6 +6,7 @@ filegroup(
     name = "gapic_files",
     srcs = glob(["*.java"]) + [
         "//src/main/java/com/google/api/generator/gapic/composer:composer_files",
+        "//src/main/java/com/google/api/generator/gapic/composer/comment:comment_files",
         "//src/main/java/com/google/api/generator/gapic/composer/samplecode:samplecode_files",
         "//src/main/java/com/google/api/generator/gapic/composer/store:store_files",
         "//src/main/java/com/google/api/generator/gapic/model:model_files",

src/main/java/com/google/api/generator/gapic/composer/BUILD.bazel

@@ -17,8 +17,10 @@ java_library(
         "//src/main/java/com/google/api/generator/engine/ast",
         "//src/main/java/com/google/api/generator/engine/writer",
         "//src/main/java/com/google/api/generator/gapic:status_java_proto",
+        "//src/main/java/com/google/api/generator/gapic/composer/comment",
         "//src/main/java/com/google/api/generator/gapic/composer/samplecode",
         "//src/main/java/com/google/api/generator/gapic/composer/store",
+        "//src/main/java/com/google/api/generator/gapic/composer/utils",
         "//src/main/java/com/google/api/generator/gapic/model",
         "//src/main/java/com/google/api/generator/gapic/utils",
         "@com_google_api_api_common//jar",

src/main/java/com/google/api/generator/gapic/composer/ClientLibraryPackageInfoComposer.java

@@ -20,6 +20,7 @@
 import com.google.api.generator.engine.ast.JavaDocComment;
 import com.google.api.generator.engine.ast.PackageInfoDefinition;
 import com.google.api.generator.engine.ast.TypeNode;
+import com.google.api.generator.gapic.composer.utils.ClassNames;
 import com.google.api.generator.gapic.model.GapicContext;
 import com.google.api.generator.gapic.model.GapicPackageInfo;
 import com.google.api.generator.gapic.model.Service;

src/main/java/com/google/api/generator/gapic/composer/Composer.java

@@ -16,6 +16,7 @@
 
 import com.google.api.generator.engine.ast.ClassDefinition;
 import com.google.api.generator.engine.ast.ScopeNode;
+import com.google.api.generator.gapic.composer.comment.CommentComposer;
 import com.google.api.generator.gapic.model.GapicClass;
 import com.google.api.generator.gapic.model.GapicClass.Kind;
 import com.google.api.generator.gapic.model.GapicContext;

src/main/java/com/google/api/generator/gapic/composer/GrpcServiceCallableFactoryClassComposer.java

@@ -37,7 +37,9 @@
 import com.google.api.generator.engine.ast.TypeNode;
 import com.google.api.generator.engine.ast.Variable;
 import com.google.api.generator.engine.ast.VariableExpr;
+import com.google.api.generator.gapic.composer.comment.StubCommentComposer;
 import com.google.api.generator.gapic.composer.store.TypeStore;
+import com.google.api.generator.gapic.composer.utils.ClassNames;
 import com.google.api.generator.gapic.model.GapicClass;
 import com.google.api.generator.gapic.model.GapicClass.Kind;
 import com.google.api.generator.gapic.model.Message;

src/main/java/com/google/api/generator/gapic/composer/GrpcServiceStubClassComposer.java

@@ -48,7 +48,9 @@
 import com.google.api.generator.engine.ast.ValueExpr;
 import com.google.api.generator.engine.ast.Variable;
 import com.google.api.generator.engine.ast.VariableExpr;
+import com.google.api.generator.gapic.composer.comment.StubCommentComposer;
 import com.google.api.generator.gapic.composer.store.TypeStore;
+import com.google.api.generator.gapic.composer.utils.ClassNames;
 import com.google.api.generator.gapic.model.GapicClass;
 import com.google.api.generator.gapic.model.GapicClass.Kind;
 import com.google.api.generator.gapic.model.Message;

src/main/java/com/google/api/generator/gapic/composer/MockServiceClassComposer.java

@@ -30,6 +30,7 @@
 import com.google.api.generator.engine.ast.Variable;
 import com.google.api.generator.engine.ast.VariableExpr;
 import com.google.api.generator.gapic.composer.store.TypeStore;
+import com.google.api.generator.gapic.composer.utils.ClassNames;
 import com.google.api.generator.gapic.model.GapicClass;
 import com.google.api.generator.gapic.model.GapicClass.Kind;
 import com.google.api.generator.gapic.model.Message;

src/main/java/com/google/api/generator/gapic/composer/MockServiceImplClassComposer.java

@@ -38,6 +38,7 @@
 import com.google.api.generator.engine.ast.Variable;
 import com.google.api.generator.engine.ast.VariableExpr;
 import com.google.api.generator.gapic.composer.store.TypeStore;
+import com.google.api.generator.gapic.composer.utils.ClassNames;
 import com.google.api.generator.gapic.model.GapicClass;
 import com.google.api.generator.gapic.model.GapicClass.Kind;
 import com.google.api.generator.gapic.model.Message;

src/main/java/com/google/api/generator/gapic/composer/ResourceNameHelperClassComposer.java

@@ -46,6 +46,7 @@
 import com.google.api.generator.engine.ast.ValueExpr;
 import com.google.api.generator.engine.ast.Variable;
 import com.google.api.generator.engine.ast.VariableExpr;
+import com.google.api.generator.gapic.composer.comment.CommentComposer;
 import com.google.api.generator.gapic.composer.store.TypeStore;
 import com.google.api.generator.gapic.model.GapicClass;
 import com.google.api.generator.gapic.model.ResourceName;

src/main/java/com/google/api/generator/gapic/composer/ServiceClientClassComposer.java

@@ -54,8 +54,10 @@
 import com.google.api.generator.engine.ast.ValueExpr;
 import com.google.api.generator.engine.ast.Variable;
 import com.google.api.generator.engine.ast.VariableExpr;
+import com.google.api.generator.gapic.composer.comment.ServiceClientCommentComposer;
 import com.google.api.generator.gapic.composer.samplecode.ServiceClientSampleCodeComposer;
 import com.google.api.generator.gapic.composer.store.TypeStore;
+import com.google.api.generator.gapic.composer.utils.ClassNames;
 import com.google.api.generator.gapic.model.Field;
 import com.google.api.generator.gapic.model.GapicClass;
 import com.google.api.generator.gapic.model.GapicClass.Kind;
@@ -95,6 +97,7 @@ public class ServiceClientClassComposer implements ClassComposer {
 
   private static final Reference LIST_REFERENCE = ConcreteReference.withClazz(List.class);
   private static final Reference MAP_REFERENCE = ConcreteReference.withClazz(Map.class);
+
   private static final TypeNode OBJECTS_TYPE =
       TypeNode.withReference(ConcreteReference.withClazz(Objects.class));
 

src/main/java/com/google/api/generator/gapic/composer/ServiceClientTestClassComposer.java

@@ -58,6 +58,7 @@
 import com.google.api.generator.engine.ast.Variable;
 import com.google.api.generator.engine.ast.VariableExpr;
 import com.google.api.generator.gapic.composer.store.TypeStore;
+import com.google.api.generator.gapic.composer.utils.ClassNames;
 import com.google.api.generator.gapic.model.Field;
 import com.google.api.generator.gapic.model.GapicClass;
 import com.google.api.generator.gapic.model.GapicClass.Kind;

src/main/java/com/google/api/generator/gapic/composer/ServiceSettingsClassComposer.java

@@ -50,8 +50,10 @@
 import com.google.api.generator.engine.ast.VaporReference;
 import com.google.api.generator.engine.ast.Variable;
 import com.google.api.generator.engine.ast.VariableExpr;
+import com.google.api.generator.gapic.composer.comment.SettingsCommentComposer;
 import com.google.api.generator.gapic.composer.samplecode.SettingsSampleCodeComposer;
 import com.google.api.generator.gapic.composer.store.TypeStore;
+import com.google.api.generator.gapic.composer.utils.ClassNames;
 import com.google.api.generator.gapic.model.GapicClass;
 import com.google.api.generator.gapic.model.GapicClass.Kind;
 import com.google.api.generator.gapic.model.Message;

src/main/java/com/google/api/generator/gapic/composer/ServiceStubClassComposer.java

@@ -29,7 +29,9 @@
 import com.google.api.generator.engine.ast.Statement;
 import com.google.api.generator.engine.ast.ThrowExpr;
 import com.google.api.generator.engine.ast.TypeNode;
+import com.google.api.generator.gapic.composer.comment.StubCommentComposer;
 import com.google.api.generator.gapic.composer.store.TypeStore;
+import com.google.api.generator.gapic.composer.utils.ClassNames;
 import com.google.api.generator.gapic.model.GapicClass;
 import com.google.api.generator.gapic.model.GapicClass.Kind;
 import com.google.api.generator.gapic.model.Message;

src/main/java/com/google/api/generator/gapic/composer/ServiceStubSettingsClassComposer.java

@@ -81,8 +81,10 @@
 import com.google.api.generator.engine.ast.VaporReference;
 import com.google.api.generator.engine.ast.Variable;
 import com.google.api.generator.engine.ast.VariableExpr;
+import com.google.api.generator.gapic.composer.comment.SettingsCommentComposer;
 import com.google.api.generator.gapic.composer.samplecode.SettingsSampleCodeComposer;
 import com.google.api.generator.gapic.composer.store.TypeStore;
+import com.google.api.generator.gapic.composer.utils.ClassNames;
 import com.google.api.generator.gapic.model.Field;
 import com.google.api.generator.gapic.model.GapicBatchingSettings;
 import com.google.api.generator.gapic.model.GapicClass;

src/main/java/com/google/api/generator/gapic/composer/comment/BUILD.bazel

@@ -0,0 +1,22 @@
+load("@rules_java//java:defs.bzl", "java_library")
+
+package(default_visibility = ["//visibility:public"])
+
+filegroup(
+    name = "comment_files",
+    srcs = glob(["*.java"]),
+)
+
+java_library(
+    name = "comment",
+    srcs = [
+        ":comment_files",
+    ],
+    deps = [
+        "//src/main/java/com/google/api/generator/engine/ast",
+        "//src/main/java/com/google/api/generator/gapic/composer/utils",
+        "//src/main/java/com/google/api/generator/gapic/model",
+        "//src/main/java/com/google/api/generator/gapic/utils",
+        "@com_google_guava_guava//jar",
+    ],
+)

src/main/java/com/google/api/generator/gapic/composer/CommentComposer.java → src/main/java/com/google/api/generator/gapic/composer/comment/CommentComposer.java

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package com.google.api.generator.gapic.composer;
+package com.google.api.generator.gapic.composer.comment;
 
 import com.google.api.generator.engine.ast.BlockComment;
 import com.google.api.generator.engine.ast.CommentStatement;

src/main/java/com/google/api/generator/gapic/composer/ServiceClientCommentComposer.java → src/main/java/com/google/api/generator/gapic/composer/comment/ServiceClientCommentComposer.java

@@ -12,11 +12,12 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package com.google.api.generator.gapic.composer;
+package com.google.api.generator.gapic.composer.comment;
 
 import com.google.api.generator.engine.ast.CommentStatement;
 import com.google.api.generator.engine.ast.JavaDocComment;
 import com.google.api.generator.engine.ast.TypeNode;
+import com.google.api.generator.gapic.composer.utils.ClassNames;
 import com.google.api.generator.gapic.model.Method;
 import com.google.api.generator.gapic.model.MethodArgument;
 import com.google.api.generator.gapic.model.Service;
@@ -29,7 +30,7 @@
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
-class ServiceClientCommentComposer {
+public class ServiceClientCommentComposer {
   // Tokens.
   private static final String COLON = ":";
   private static final String EMPTY_STRING = "";
@@ -102,12 +103,12 @@ class ServiceClientCommentComposer {
           + " should be preferred.";
 
   // Comments.
-  static final CommentStatement GET_OPERATIONS_CLIENT_METHOD_COMMENT =
+  public static final CommentStatement GET_OPERATIONS_CLIENT_METHOD_COMMENT =
       toSimpleComment(
           "Returns the OperationsClient that can be used to query the status of a long-running"
               + " operation returned by another API method call.");
 
-  static List<CommentStatement> createClassHeaderComments(
+  public static List<CommentStatement> createClassHeaderComments(
       Service service, String credentialsSampleCode, String endpointSampleCode) {
     JavaDocComment.Builder classHeaderJavadocBuilder = JavaDocComment.builder();
     if (service.hasDescription()) {
@@ -150,14 +151,14 @@ static List<CommentStatement> createClassHeaderComments(
         CommentStatement.withComment(classHeaderJavadocBuilder.build()));
   }
 
-  static CommentStatement createCreateMethodStubArgComment(
+  public static CommentStatement createCreateMethodStubArgComment(
       String serviceName, TypeNode settingsType) {
     return toSimpleComment(
         String.format(
             CREATE_METHOD_STUB_ARG_PATTERN, serviceName, settingsType.reference().name()));
   }
 
-  static List<CommentStatement> createRpcMethodHeaderComment(
+  public static List<CommentStatement> createRpcMethodHeaderComment(
       Method method, List<MethodArgument> methodArguments) {
     JavaDocComment.Builder methodJavadocBuilder = JavaDocComment.builder();
 
@@ -191,23 +192,23 @@ static List<CommentStatement> createRpcMethodHeaderComment(
     return comments;
   }
 
-  static List<CommentStatement> createRpcMethodHeaderComment(Method method) {
+  public static List<CommentStatement> createRpcMethodHeaderComment(Method method) {
     return createRpcMethodHeaderComment(method, Collections.emptyList());
   }
 
-  static CommentStatement createMethodNoArgComment(String serviceName) {
+  public static CommentStatement createMethodNoArgComment(String serviceName) {
     return toSimpleComment(String.format(CREATE_METHOD_NO_ARG_PATTERN, serviceName));
   }
 
-  static CommentStatement createProtectedCtorSettingsArgComment(String serviceName) {
+  public static CommentStatement createProtectedCtorSettingsArgComment(String serviceName) {
     return toSimpleComment(String.format(PROTECTED_CONSTRUCTOR_SETTINGS_ARG_PATTERN, serviceName));
   }
 
-  static CommentStatement createMethodSettingsArgComment(String serviceName) {
+  public static CommentStatement createMethodSettingsArgComment(String serviceName) {
     return toSimpleComment(String.format(CREATE_METHOD_SETTINGS_ARG_PATTERN, serviceName));
   }
 
-  static List<CommentStatement> createRpcCallableMethodHeaderComment(Method method) {
+  public static List<CommentStatement> createRpcCallableMethodHeaderComment(Method method) {
     JavaDocComment.Builder methodJavadocBuilder = JavaDocComment.builder();
 
     if (method.hasDescription()) {

src/main/java/com/google/api/generator/gapic/composer/SettingsCommentComposer.java → src/main/java/com/google/api/generator/gapic/composer/comment/SettingsCommentComposer.java

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package com.google.api.generator.gapic.composer;
+package com.google.api.generator.gapic.composer.comment;
 
 import com.google.api.generator.engine.ast.CommentStatement;
 import com.google.api.generator.engine.ast.JavaDocComment;
@@ -25,7 +25,7 @@
 import java.util.Optional;
 import java.util.stream.Collectors;
 
-class SettingsCommentComposer {
+public class SettingsCommentComposer {
   private static final String COLON = ":";
 
   private static final String STUB_PATTERN = "%sStub";
@@ -54,29 +54,29 @@ class SettingsCommentComposer {
   private static final String CLASS_HEADER_DEFAULTS_RETRIES_DESCRIPTION =
       "Retries are configured for idempotent methods but not for non-idempotent methods.";
 
-  static final CommentStatement DEFAULT_SCOPES_COMMENT =
+  public static final CommentStatement DEFAULT_SCOPES_COMMENT =
       toSimpleComment("The default scopes of the service.");
 
-  static final CommentStatement DEFAULT_EXECUTOR_PROVIDER_BUILDER_METHOD_COMMENT =
+  public static final CommentStatement DEFAULT_EXECUTOR_PROVIDER_BUILDER_METHOD_COMMENT =
       toSimpleComment("Returns a builder for the default ExecutorProvider for this service.");
-  static final CommentStatement DEFAULT_SERVICE_ENDPOINT_METHOD_COMMENT =
+  public static final CommentStatement DEFAULT_SERVICE_ENDPOINT_METHOD_COMMENT =
       toSimpleComment("Returns the default service endpoint.");
-  static final CommentStatement DEFAULT_SERVICE_SCOPES_METHOD_COMMENT =
+  public static final CommentStatement DEFAULT_SERVICE_SCOPES_METHOD_COMMENT =
       toSimpleComment("Returns the default service scopes.");
 
-  static final CommentStatement DEFAULT_CREDENTIALS_PROVIDER_BUILDER_METHOD_COMMENT =
+  public static final CommentStatement DEFAULT_CREDENTIALS_PROVIDER_BUILDER_METHOD_COMMENT =
       toSimpleComment("Returns a builder for the default credentials for this service.");
 
-  static final CommentStatement DEFAULT_GRPC_TRANSPORT_PROVIDER_BUILDER_METHOD_COMMENT =
+  public static final CommentStatement DEFAULT_GRPC_TRANSPORT_PROVIDER_BUILDER_METHOD_COMMENT =
       toSimpleComment("Returns a builder for the default ChannelProvider for this service.");
 
-  static final CommentStatement NEW_BUILDER_METHOD_COMMENT =
+  public static final CommentStatement NEW_BUILDER_METHOD_COMMENT =
       toSimpleComment("Returns a new builder for this class.");
 
-  static final CommentStatement TO_BUILDER_METHOD_COMMENT =
+  public static final CommentStatement TO_BUILDER_METHOD_COMMENT =
       toSimpleComment("Returns a builder containing all the values of this settings class.");
 
-  static final List<CommentStatement> APPLY_TO_ALL_UNARY_METHODS_METHOD_COMMENTS =
+  public static final List<CommentStatement> APPLY_TO_ALL_UNARY_METHODS_METHOD_COMMENTS =
       Arrays.asList(
               LineComment.withComment("NEXT_MAJOR_VER: remove 'throws Exception'."),
               JavaDocComment.builder()
@@ -90,19 +90,19 @@ class SettingsCommentComposer {
           .map(c -> CommentStatement.withComment(c))
           .collect(Collectors.toList());
 
-  static CommentStatement createCallSettingsGetterComment(String javaMethodName) {
+  public static CommentStatement createCallSettingsGetterComment(String javaMethodName) {
     return toSimpleComment(String.format(CALL_SETTINGS_METHOD_DOC_PATTERN, javaMethodName));
   }
 
-  static CommentStatement createBuilderClassComment(String outerClassName) {
+  public static CommentStatement createBuilderClassComment(String outerClassName) {
     return toSimpleComment(String.format(BUILDER_CLASS_DOC_PATTERN, outerClassName));
   }
 
-  static CommentStatement createCallSettingsBuilderGetterComment(String javaMethodName) {
+  public static CommentStatement createCallSettingsBuilderGetterComment(String javaMethodName) {
     return toSimpleComment(String.format(CALL_SETTINGS_BUILDER_METHOD_DOC_PATTERN, javaMethodName));
   }
 
-  static List<CommentStatement> createClassHeaderComments(
+  public static List<CommentStatement> createClassHeaderComments(
       String configuredClassName,
       String defaultHost,
       Optional<String> methodNameOpt,

src/main/java/com/google/api/generator/gapic/composer/StubCommentComposer.java → src/main/java/com/google/api/generator/gapic/composer/comment/StubCommentComposer.java

@@ -12,14 +12,14 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package com.google.api.generator.gapic.composer;
+package com.google.api.generator.gapic.composer.comment;
 
 import com.google.api.generator.engine.ast.CommentStatement;
 import com.google.api.generator.engine.ast.JavaDocComment;
 import java.util.Arrays;
 import java.util.List;
 
-class StubCommentComposer {
+public class StubCommentComposer {
   private static final String STUB_CLASS_HEADER_SUMMARY_PATTERN =
       "Base stub class for the %s service API.";
   private static final String GRPC_CALLABLE_FACTORY_CLASS_HEADER_SUMMARY_PATTERN =
@@ -31,7 +31,8 @@ class StubCommentComposer {
   private static final String ADVANCED_USAGE_API_REFLECTION_DESCRIPTION =
       "This class is for advanced usage and reflects the underlying API directly.";
 
-  static List<CommentStatement> createGrpcServiceStubClassHeaderComments(String serviceName) {
+  public static List<CommentStatement> createGrpcServiceStubClassHeaderComments(
+      String serviceName) {
     return Arrays.asList(
         CommentComposer.AUTO_GENERATED_CLASS_COMMENT,
         CommentStatement.withComment(
@@ -41,7 +42,7 @@ static List<CommentStatement> createGrpcServiceStubClassHeaderComments(String se
                 .build()));
   }
 
-  static List<CommentStatement> createGrpcServiceCallableFactoryClassHeaderComments(
+  public static List<CommentStatement> createGrpcServiceCallableFactoryClassHeaderComments(
       String serviceName) {
     return Arrays.asList(
         CommentComposer.AUTO_GENERATED_CLASS_COMMENT,
@@ -53,7 +54,7 @@ static List<CommentStatement> createGrpcServiceCallableFactoryClassHeaderComment
                 .build()));
   }
 
-  static List<CommentStatement> createServiceStubClassHeaderComments(String serviceName) {
+  public static List<CommentStatement> createServiceStubClassHeaderComments(String serviceName) {
     return Arrays.asList(
         CommentComposer.AUTO_GENERATED_CLASS_COMMENT,
         CommentStatement.withComment(

src/main/java/com/google/api/generator/gapic/composer/utils/BUILD.bazel

@@ -0,0 +1,18 @@
+load("@rules_java//java:defs.bzl", "java_library")
+
+package(default_visibility = ["//visibility:public"])
+
+filegroup(
+    name = "utils_files",
+    srcs = glob(["*.java"]),
+)
+
+java_library(
+    name = "utils",
+    srcs = [
+        ":utils_files",
+    ],
+    deps = [
+        "//src/main/java/com/google/api/generator/gapic/model",
+    ],
+)