gapic-generator 0.11.0 → 0.45.2

data/lib/gapic/gem_builder.rb

@@ -37,23 +37,21 @@ module Gapic
     # Writes all the files for the gem.
     #
     def bootstrap
-      gen "readme.erb",     "README.md"
-      gen "gemspec.erb",    "gapic-generator-#{gem_name}.gemspec"
-      gen "rakefile.erb",   "Rakefile"
-      gen "gemfile.erb",    "Gemfile"
-      gen "gitignore.erb",  ".gitignore"
-      gen "rubocop.erb",    ".rubocop.yml"
-      gen "dockerfile.erb", "Dockerfile"
-      gen "entrypoint.erb", "docker-entrypoint.sh"
-      gen "gapic_sh.erb",   "gapic.sh"
-      gen "binary.erb",     "bin/protoc-gen-ruby_#{gem_name}"
-      gen "generator.erb",
-          "lib/gapic/generators/#{gem_name}_generator.rb"
-      gen "version.erb",
-          "lib/gapic/generator/#{gem_name}/version.rb"
-      gen "test_helper.erb",    "test/test_helper.rb"
-      gen "test_generator.erb", "test/generators/#{gem_name}_test.rb"
-      cp  "speech_desc.bin",    "proto_input/speech_desc.bin"
+      gen "readme",          "README.md"
+      gen "gemspec",         "gapic-generator-#{gem_name}.gemspec"
+      gen "rakefile",        "Rakefile"
+      gen "gemfile",         "Gemfile"
+      gen "gitignore",       ".gitignore"
+      gen "rubocop",         ".rubocop.yml"
+      gen "dockerfile",      "Dockerfile"
+      gen "entrypoint",      "docker-entrypoint.sh"
+      gen "gapic_sh",        "gapic.sh"
+      gen "binary",          "bin/protoc-gen-ruby_#{gem_name}"
+      gen "generator",       "lib/gapic/generators/#{gem_name}_generator.rb"
+      gen "version",         "lib/gapic/generator/#{gem_name}/version.rb"
+      gen "test_helper",     "test/test_helper.rb"
+      gen "test_generator",  "test/generators/#{gem_name}_test.rb"
+      cp  "speech_desc.bin", "proto_input/speech_desc.bin"
     end
 
     private

data/lib/gapic/generator/version.rb

@@ -16,6 +16,6 @@
 
 module Gapic
   module Generator
-    VERSION = "0.11.0"
+    VERSION = "0.45.2"
   end
 end

data/lib/gapic/generators/base_generator.rb

@@ -16,7 +16,7 @@
 
 require "gapic/file_formatter"
 require "action_controller"
-require "google/protobuf/compiler/plugin.pb"
+require "google/protobuf/compiler/plugin_pb"
 require "tempfile"
 
 module Gapic
@@ -46,8 +46,10 @@ module Gapic
         template_path = File.expand_path template_path
         helpers_path = File.join template_path, "helpers"
 
-        # Configure Dependencies to know how to load helpers
-        ActiveSupport::Dependencies.autoload_paths.prepend helpers_path
+        # For some reason autoload doesn't seem to be working for helpers in Rails 8:
+        #     ActiveSupport::Dependencies.autoload_paths.prepend helpers_path
+        # So instead we eagerly load helpers
+        Dir.glob("#{helpers_path}/*_helper.rb") { |file| require file }
 
         # Configure the controller to know about the templates and helpers
         controller.prepend_view_path template_path
@@ -66,7 +68,7 @@ module Gapic
           template: template, formats: :text, locals: args
         )
         Google::Protobuf::Compiler::CodeGeneratorResponse::File.new(
-          name: filename, content: content
+          name: filename, content: String.new(content)
         )
       end
       alias_method :g, :generate_file

data/lib/gapic/generators/default_generator.rb

@@ -17,6 +17,7 @@
 require "gapic/generators/base_generator"
 require "gapic/generators/default_generator_parameters"
 require "gapic/presenters"
+require "gapic/package_snippets"
 
 module Gapic
   module Generators
@@ -47,57 +48,92 @@ module Gapic
 
         gem = gem_presenter || Gapic::Presenters.gem_presenter(@api)
 
+        if @api.generate_rest_clients? && gem.packages.find(&:generate_rest_clients?).nil?
+          raise "Rest transport specified but no services have HTTP bindings"
+        end
+
         gem.packages.each do |package|
+          package_snippets = PackageSnippets.new snippet_dir: "snippets",
+                                                 proto_package: package.name,
+                                                 gem_name: gem.name
+
           # Package level files
-          files << g("package.erb", "lib/#{package.package_file_path}", package: package)
+          files << g("package", "lib/#{package.package_file_path}", package: package)
+          files << g("package_rest", "lib/#{package.package_rest_file_path}", package: package) if package.generate_rest_clients?
+          files << g("binding_override", "lib/#{package.mixin_binding_overrides_file_path}", package: package) if package.mixin_binding_overrides? && package.generate_rest_clients?
 
           package.services.each do |service|
+            should_generate_grpc = service.generate_grpc_clients?
+            should_generate_rest = service.generate_rest_clients?
+
             # Service level files
-            files << g("service.erb",                        "lib/#{service.service_file_path}",                 service: service)
-            files << g("service/rest.erb",                   "lib/#{service.rest.service_rest_file_path}",       service: service) if @api.generate_rest_clients? and service.methods_rest_bindings?
-            files << g("service/client.erb",                 "lib/#{service.client_file_path}",                  service: service) unless @api.generate_rest_clients?
-            files << g("service/credentials.erb",            "lib/#{service.credentials_file_path}",             service: service) unless gem.generic_endpoint?
-            files << g("service/paths.erb",                  "lib/#{service.paths_file_path}",                   service: service) if service.paths?
-            files << g("service/operations.erb",             "lib/#{service.operations_file_path}",              service: service) if service.lro? && !@api.generate_rest_clients?
-            files << g("service/nonstandard_lro.erb",        "lib/#{service.nonstandard_lro_file_path}",         service: service) if service.nonstandard_lro_provider? && !service.methods_rest_bindings?
-            files << g("service/nonstandard_lro.erb",        "lib/#{service.rest.nonstandard_lro_file_path}",    service: service) if service.nonstandard_lro_provider? && service.methods_rest_bindings?
-            files << g("service/rest/client.erb",            "lib/#{service.rest.client_file_path}",             service: service) if @api.generate_rest_clients? and service.methods_rest_bindings?
-            files << g("service/rest/service_stub.erb",      "lib/#{service.rest.service_stub_file_path}",       service: service) if @api.generate_rest_clients? and service.methods_rest_bindings?
-            files << g("service/rest/test/client.erb",       "test/#{service.rest.test_client_file_path}",       service: service) if @api.generate_rest_clients? and service.methods_rest_bindings?
-            files << g("service/test/client.erb",            "test/#{service.test_client_file_path}",            service: service) unless @api.generate_rest_clients?
-            files << g("service/test/client_paths.erb",      "test/#{service.test_paths_file_path}",             service: service) if service.paths?
-            files << g("service/test/client_operations.erb", "test/#{service.test_client_operations_file_path}", service: service) if service.lro? && !@api.generate_rest_clients?
+            files << g("service",                        "lib/#{service.service_file_path}",                 service: service)
+            files << g("service/credentials",            "lib/#{service.credentials_file_path}",             service: service) unless gem.generic_endpoint?
+            files << g("service/paths",                  "lib/#{service.paths_file_path}",                   service: service) if service.paths?
+
+            # Rest module file
+            files << g("service/rest",                   "lib/#{service.rest.service_rest_file_path}",       service: service) if should_generate_rest
+
+            # client.rb
+            files << g("service/client",                 "lib/#{service.client_file_path}",                  service: service) if should_generate_grpc
+            files << g("service/rest/client",            "lib/#{service.rest.client_file_path}",             service: service) if should_generate_rest
+
+            # Standard LRO shim
+            files << g("service/operations",             "lib/#{service.operations_file_path}",              service: service) if service.lro? && should_generate_grpc
+            files << g("service/rest/operations",        "lib/#{service.rest.operations_file_path}",         service: service) if service.rest.lro? && should_generate_rest
+
+            # Nonstandard LRO shim
+            files << g("service/nonstandard_lro",        "lib/#{service.nonstandard_lro_file_path}",         service: service) if service.nonstandard_lro_provider? && should_generate_grpc
+            files << g("service/rest/nonstandard_lro",   "lib/#{service.rest.nonstandard_lro_file_path}",    service: service) if service.rest.nonstandard_lro_provider? && should_generate_rest
+            
+            # Rest-only `service.stub` file
+            files << g("service/rest/service_stub",      "lib/#{service.rest.service_stub_file_path}",       service: service) if should_generate_rest
+
+            # Unit tests for `client.rb`
+            files << g("service/test/client",            "test/#{service.test_client_file_path}",            service: service) if should_generate_grpc
+            files << g("service/rest/test/client",       "test/#{service.rest.test_client_file_path}",       service: service) if should_generate_rest
+
+            # Unit tests for `paths.rb`
+            files << g("service/test/client_paths",      "test/#{service.test_paths_file_path}",             service: service) if service.paths? && should_generate_grpc
+
+            # Unit tests for standard LRO shim
+            files << g("service/test/client_operations", "test/#{service.test_client_operations_file_path}", service: service) if service.lro? && should_generate_grpc
 
             if @api.generate_standalone_snippets?
               service.methods.each do |method|
-                snippet = method.snippet
-                files << g("snippets/standalone.erb", "snippets/#{snippet.snippet_file_path}", snippet: snippet)
+                method.all_snippets.each do |snippet|
+                  snippet_file = g("snippets/standalone", "snippets/#{snippet.snippet_file_path}", snippet: snippet)
+                  package_snippets.add(method_presenter: method, snippet_presenter: snippet, snippet_file: snippet_file)
+                end
               end
             end
           end
+
+          files += package_snippets.files if @api.generate_standalone_snippets?
         end
 
         # Gem level files
-        files << g("gem/gitignore.erb",             ".gitignore",                   gem: gem)
-        files << g("gem/version.erb",               "lib/#{gem.version_file_path}", gem: gem)
-        files << g("gem/test_helper.erb",           "test/helper.rb",               gem: gem)
-        files << g("gem/gemspec.erb",               "#{gem.name}.gemspec",          gem: gem)
-        files << g("gem/gemfile.erb",               "Gemfile",                      gem: gem)
-        files << g("gem/rakefile.erb",              "Rakefile",                     gem: gem)
-        files << g("gem/readme.erb",                "README.md",                    gem: gem)
-        files << g("gem/changelog.erb",             "CHANGELOG.md",                 gem: gem)
-        files << g("gem/rubocop.erb",               ".rubocop.yml",                 gem: gem)
-        files << g("gem/yardopts.erb",              ".yardopts",                    gem: gem)
-        files << g("gem/license.erb",               "LICENSE.md",                   gem: gem)
-        files << g("gem/entrypoint.erb",            "lib/#{gem.name}.rb",           gem: gem)
-        files << g("gem/gapic_metadata_json.erb",   "gapic_metadata.json",          gem: gem) if @api.generate_metadata
-
-        files << g("snippets/gemfile.erb",          "snippets/Gemfile",             gem: gem) if @api.generate_standalone_snippets?
+        files << g("gem/gitignore",           ".gitignore",                   gem: gem)
+        files << g("gem/version",             "lib/#{gem.version_file_path}", gem: gem)
+        files << g("gem/test_helper",         "test/helper.rb",               gem: gem)
+        files << g("gem/gemspec",             "#{gem.name}.gemspec",          gem: gem)
+        files << g("gem/gemfile",             "Gemfile",                      gem: gem)
+        files << g("gem/rakefile",            "Rakefile",                     gem: gem)
+        files << g("gem/readme",              "README.md",                    gem: gem)
+        files << g("gem/changelog",           "CHANGELOG.md",                 gem: gem)
+        files << g("gem/rubocop",             ".rubocop.yml",                 gem: gem)
+        files << g("gem/toys",                ".toys.rb",                     gem: gem)
+        files << g("gem/yardopts",            ".yardopts",                    gem: gem)
+        files << g("gem/license",             "LICENSE.md",                   gem: gem)
+        files << g("gem/entrypoint",          "lib/#{gem.name}.rb",           gem: gem)
+        files << g("gem/gapic_metadata_json", "gapic_metadata.json",          gem: gem) if @api.generate_metadata
+
+        files << g("snippets/gemfile",        "snippets/Gemfile",             gem: gem) if @api.generate_standalone_snippets?
 
         gem.proto_files.each do |proto_file|
-          files << g("proto_docs/proto_file.erb", "proto_docs/#{proto_file.docs_file_path}", file: proto_file)
+          files << g("proto_docs/proto_file", "proto_docs/#{proto_file.docs_file_path}", file: proto_file)
         end
-        files << g("proto_docs/readme.erb", "proto_docs/README.md", gem: gem)
+        files << g("proto_docs/readme",       "proto_docs/README.md", gem: gem)
 
         format_files files
 

data/lib/gapic/generators/default_generator_parameters.rb

@@ -24,6 +24,8 @@ module Gapic
         ":gem.:free_tier",
         ":gem.:yard_strict",
         ":gem.:generic_endpoint",
+        ":gem.:is_cloud_product",
+        ":gem.:rest_numeric_enums",
         ":generate_metadata",
         ":generate_standalone_snippets",
         ":generate_yardoc_snippets"
@@ -47,7 +49,8 @@ module Gapic
         ":defaults.:service.:default_host",
         "grpc_service_config",
         ":service_yaml",
-        ":overrides.:wrapper_gem_name"
+        ":overrides.:wrapper_gem_name",
+        ":snippet_configs_path"
       ].freeze
 
       ARRAY_PARAMETERS = [
@@ -66,7 +69,9 @@ module Gapic
       BOOL_PARAMETERS_ALIASES = {
         "gem-free-tier"        => ":gem.:free_tier",
         "gem-yard-strict"      => ":gem.:yard_strict",
-        "gem-generic-endpoint" => ":gem.:generic_endpoint"
+        "gem-generic-endpoint" => ":gem.:generic_endpoint",
+        "gem-is-cloud-product" => ":gem.:is_cloud_product",
+        "rest-numeric-enums"   => ":gem.:rest_numeric_enums"
       }.freeze
 
       STRING_PARAMETERS_ALIASES = {
@@ -86,7 +91,8 @@ module Gapic
         "gem-factory-method-suffix" => ":gem.:factory_method_suffix",
         "default-service-host"      => ":defaults.:service.:default_host",
         "grpc-service-config"       => "grpc_service_config",
-        "service-yaml"              => ":service_yaml"
+        "service-yaml"              => ":service_yaml",
+        "snippet-configs-path"      => ":snippet_configs_path"
       }.freeze
 
       ARRAY_PARAMETERS_ALIASES = {

data/lib/gapic/grpc_service_config/parser.rb

@@ -62,7 +62,7 @@ module Gapic
         "UNAUTHENTICATED"
       ].freeze
 
-      ERROR_STRING_MAPPING = ERROR_CODE_MAPPING.each_with_index.each_with_object({}) do |(str, num), hash|
+      ERROR_STRING_MAPPING = ERROR_CODE_MAPPING.each_with_index.with_object({}) do |(str, num), hash|
         hash[str] = num
       end.freeze
 
@@ -209,7 +209,7 @@ module Gapic
         timestring_nos = timestring.delete_suffix "s"
         unless valid_float? timestring_nos
           error_text = "Was not able to convert the string `#{timestring}` " \
-                        "to a time interval when parsing a grpc service config"
+                       "to a time interval when parsing a grpc service config"
           raise ParsingError, error_text
         end
         Float(timestring_nos)

data/lib/gapic/model/api_metadata.rb

@@ -0,0 +1,173 @@
+# frozen_string_literal: true
+
+# Copyright 2023 Google LLC
+#
+# 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
+#
+#     https://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.
+
+module Gapic
+  module Model
+    ##
+    # A collection of metadata about an API.
+    #
+    # This information generally comes from the service yaml rather than from
+    # proto input.
+    #
+    class ApiMetadata
+      ##
+      # @return [String] The full ID of the API, including `".googleapis.com"`.
+      #     For example, `"pubsub.googleapis.com"`.
+      #
+      attr_reader :name
+
+      ##
+      # @return [String] The shortname of the API, omitting `".googleapis.com"`.
+      #     For example, `"pubsub"`.
+      #
+      attr_reader :short_name
+
+      ##
+      # @return [String] A title of the API, including the version.
+      #     For example, `"Cloud Pub/Sub V1"`
+      #
+      attr_reader :title
+
+      ##
+      # @return [String] A short description of the API, suitable for the
+      #     RubyGems summary field.
+      #
+      attr_reader :summary
+
+      ##
+      # @return [String] A longer description of the API, suitable for the
+      #     RubyGems description field.
+      #
+      attr_reader :description
+
+      ##
+      # @return [String] The organization name, determining where the API's
+      #     documentation should be published, among other things. This value
+      #     is `"CLOUD"` for Google Cloud APIs.
+      #
+      attr_reader :organization
+
+      ##
+      # @return [String] The URL for the documentation.
+      #
+      attr_reader :documentation_url
+
+      ##
+      # @return [String] The prefix string for sample doc tags.
+      #
+      attr_reader :doc_tag_prefix
+
+      ##
+      # @return [Hash{String => Array<String>}] A mapping from method name to a list of auto
+      #     populated fields.
+      #
+      attr_reader :auto_populated_fields_by_method_name
+
+      ######## Internal ########
+      # @private
+      SELECTOR = "selector"
+      # @private
+      AUTO_POPULATED_FIELDS = "auto_populated_fields"
+
+      ##
+      # @private
+      # Special cases for short names
+      #
+      SHORT_NAME_MAPPING = {
+        "iam-meta-api" => "iam"
+      }.freeze
+
+      # @private
+      def update! **keywords
+        omit_patterns = [
+          nil,
+          "",
+          "CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED",
+          /\A\s*\(==.+==\)\s*\Z/
+        ]
+        keywords.each do |key, value|
+          instance_variable_set "@#{key}", value unless omit_patterns.any? { |pat| pat === value }
+        end
+        self
+      end
+
+      # @private
+      def standardize_names!
+        return unless name || short_name
+        @name ||= short_name
+        @short_name ||= name
+        @name = "#{name}.googleapis.com" unless name.include? "."
+        @short_name = short_name.split(".").first
+        @short_name = SHORT_NAME_MAPPING.fetch @short_name, @short_name
+        @doc_tag_prefix ||= short_name
+        self
+      end
+
+      # @private
+      def standardize_title! gem_name:
+        return unless title
+        @title = title.sub %r{\s+API$}, ""
+        return if title =~ /\s+V\d+\w*$/
+        vers = gem_name.split("-").last
+        @title = "#{title} #{vers.upcase}" if vers =~ /^v\d+\w*$/
+        self
+      end
+
+      # @private
+      def standardize_descriptions!
+        return unless summary || description
+        @description ||= summary
+        if summary
+          @summary = summary.gsub(/\s+/, " ").strip
+          @summary = "#{summary}." if summary =~ /\w\z/
+          @summary = remove_html_tags summary
+        end
+        @description = "#{description}." if description =~ /\w\z/
+        @description = remove_html_tags description
+        self
+      end
+
+      # @private
+      # Remove html tags and markdown links
+      def remove_html_tags str
+        str
+          .gsub(%r{</?[[:alpha:]]+(?:\s+[[:alpha:]]+\s*=\s*(?:"[^"]+"|'[^']+'|[^\s">]+))*\s*/?>}, "")
+          .gsub(%r{\[([^\]]+)\]\([^)]+\)}, "\\1")
+      end
+
+      ##
+      # @private
+      # Parses a service configuration, mapping method names to their respective
+      #     auto populated field lists.
+      #
+      def standardize_auto_populated_fields! service_config
+        @auto_populated_fields_by_method_name = {}
+        return unless !service_config.nil? && !service_config.apis.nil?
+        @method_settings.each do |setting|
+          selector = setting[SELECTOR]
+          methods = service_config.apis.filter_map do |api|
+            # Removes API prefix and trailing period.
+            selector[api.name.length + 1..].downcase if selector.start_with? api.name
+          end
+          if !methods.nil? && setting.key?(AUTO_POPULATED_FIELDS)
+            @auto_populated_fields_by_method_name[methods.first] = setting[AUTO_POPULATED_FIELDS]
+          end
+        end
+        self
+      end
+    end
+  end
+end