gapic-generator 0.10.1 → 0.45.1

data/lib/gapic/presenters/package_presenter.rb

@@ -61,16 +61,68 @@ module Gapic
       def services
         @services ||= begin
           files = @api.generate_files.select { |f| f.package == @package }
-          services = files.map(&:services).flatten
+          service_list = files.map(&:services).flatten
+          mixin_service_names = gem.mixins_model.mixin_services
+          service_list.delete_if { |s| mixin_service_names.include? s.full_name }
           # Omit common services in this package. Common service clients do not
           # go into their own package.
-          normal_services = services.select { |s| @api.delegate_service_for(s).nil? }
+          normal_services = service_list.select { |s| @api.delegate_service_for(s).nil? }
           # But include common services that delegate to normal services in this package.
           common_services = normal_services.flat_map { |s| @api.common_services_for s }
           (normal_services + common_services).map { |s| ServicePresenter.new @gem_presenter, @api, s }
         end
       end
 
+      ##
+      # @return [Boolean] Whether the generation of REST clients is requested
+      #    and can be done because at least one method has rest bindings.
+      #
+      def generate_rest_clients?
+        @api.generate_rest_clients? && !first_service_with_rest.nil?
+      end
+
+      ##
+      # @return [Boolean] Whether the generation of gRPC clients is requested
+      #
+      def generate_grpc_clients?
+        @api.generate_grpc_clients?
+      end
+
+      ##
+      # First service with REST bindings.
+      # @return [Gapic::Presenters::ServicePresenter, nil]
+      #
+      def first_service_with_rest
+        services.find(&:methods_rest_bindings?)
+      end
+
+      ##
+      # Whether there are mixin services that this package has http binding overrides for.
+      #
+      # @return [Boolean]
+      #
+      def mixin_binding_overrides?
+        first_service_with_rest&.rest&.mixin_binding_overrides? || false
+      end
+
+      ##
+      # Requires path for the mixin binding overrides file
+      #
+      # @return [String]
+      #
+      def mixin_binding_overrides_require
+        "#{ruby_file_path @api, namespace}/bindings_override"
+      end
+
+      ##
+      # File path for the mixin binding overrides file
+      #
+      # @return [String]
+      #
+      def mixin_binding_overrides_file_path
+        "#{mixin_binding_overrides_require}.rb"
+      end
+
       def address
         @package.split "."
       end
@@ -79,10 +131,18 @@ module Gapic
         ruby_file_path @api, namespace
       end
 
+      def package_rest_require
+        "#{ruby_file_path @api, namespace}/rest"
+      end
+
       def package_file_path
         "#{package_require}.rb"
       end
 
+      def package_rest_file_path
+        "#{package_rest_require}.rb"
+      end
+
       def package_directory_name
         package_require.split("/").last
       end
@@ -117,24 +177,9 @@ module Gapic
           language:       "ruby",
           protoPackage:   name,
           libraryPackage: namespace,
-          services:       services.map { |s| [s.grpc_service_name, s.drift_manifest] }.to_h
+          services:       services.to_h { |s| [s.grpc_service_name, s.drift_manifest] }
         }
       end
-
-      ##
-      # How comments in the generated libraries refer to the GRPC client
-      # if no REST code is generated, this should just be "client",
-      # if REST code is generated, this should be disambiguated into the "GRPC client"
-      #
-      # Since we are using first service for an indication of whether package generates
-      # REST code, it's OK to defer this to the first service as well.
-      # For packages with no services the value of this does not really matter as
-      # no client generation docs will be generated.
-      #
-      # @return [String]
-      def grpc_client_designation
-        services.first&.grpc_client_designation || ""
-      end
     end
   end
 end

data/lib/gapic/presenters/resource_presenter.rb

@@ -15,7 +15,6 @@
 # limitations under the License.
 
 require "gapic/path_pattern"
-require "active_support/inflector"
 
 module Gapic
   module Presenters
@@ -58,12 +57,10 @@ module Gapic
       #
       class PatternPresenter
         def initialize pattern_string
-          @pattern = pattern_string
           @parsed_pattern = Gapic::PathPattern.parse pattern_string
           @path_string = build_path_string
         end
 
-        attr_reader :pattern
         attr_reader :path_string
 
         def pattern_template
@@ -78,6 +75,11 @@ module Gapic
           @parsed_pattern.arguments
         end
 
+        # @return [String] The conflicting argument name escaped with local binding.
+        def escape_argument arg
+          Gapic::RubyInfo.keywords.include?(arg) ? "binding.local_variable_get(:#{arg})" : arg
+        end
+
         def formal_arguments
           @parsed_pattern.arguments.map { |name| "#{name}:" }.join ", "
         end
@@ -103,6 +105,10 @@ module Gapic
           end.join "/"
         end
 
+        def pattern
+          @parsed_pattern.path_pattern
+        end
+
         private
 
         def build_path_string

data/lib/gapic/presenters/service/lro_client_presenter.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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.
+
+require "gapic/presenters/service/sub_client_presenter"
+
+module Gapic
+  module Presenters
+    module Service
+      ##
+      # @private
+      # Presenter for the generation of the sub-client for LRO
+      # inside a host service's client class
+      #
+      # @!attribute [r] service
+      #   Full name of the service providing the nonstandard LRO functionality
+      #   @return [String]
+      # @!attribute [r] client_class_name
+      #   Full name of the class of the client of the service
+      #   @return [String]
+      # @!attribute [r] client_class_docname
+      #   Name of the class as it should appear in the documentation
+      #   @return [String]
+      # @!attribute [r] client_var_name
+      #   Name for the variable for the client of the service
+      #   @return [String]
+      # @!attribute [r] require_str
+      #   Path to `require` the client of the service
+      #   @return [String]
+      # @!attribute [r] service_description
+      #   The description to place in the comments to this client's
+      #   attribute in the library services's client class
+      #   @return [String]
+      # @!attribute [r] helper_type
+      #   The type of a helper generated for this service if any
+      #   @return [String. nil]
+      #
+      class LroClientPresenter < SubClientPresenter
+        attr_reader :helper_type
+
+        ##
+        # @param service [String]
+        #   Full name of the service providing the nonstandard LRO functionality
+        # @param client_class_name [String]
+        #   Full name of the class of the client of the service
+        # @param client_class_docname [String]
+        #   Name of the class as it should appear in the documentation
+        # @param client_var_name [String]
+        #   Name for the variable for the client of the service
+        # @param require_str [String]
+        #   Path to `require` the client of the service
+        # @param service_description [String]
+        #   The description to place in the comments to this client's
+        #   attribute in the library services's client class
+        # @param helper_type [String, nil]
+        #   The type of a helper generated for this service if any
+        #
+        def initialize service:,
+                       client_class_name:,
+                       client_class_docname:,
+                       client_var_name:,
+                       require_str:,
+                       service_description:,
+                       helper_type: nil
+          super(service: service,
+                client_class_name: client_class_name,
+                client_class_docname: client_class_docname,
+                client_var_name: client_var_name,
+                require_str: require_str,
+                service_description: service_description
+              )
+
+          @helper_type = helper_type
+        end
+      end
+    end
+  end
+end

data/lib/gapic/presenters/service/mixin_client_presenter.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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.
+
+require "gapic/presenters/service/sub_client_presenter"
+
+module Gapic
+  module Presenters
+    module Service
+      ##
+      # @private
+      # Presenter for the generation of the sub-client for mixins
+      # inside a host service's client class
+      #
+      # @!attribute [r] service
+      #   Full name of the service providing the nonstandard LRO functionality
+      #   @return [String]
+      # @!attribute [r] client_class_name
+      #   Full name of the class of the client of the service
+      #   @return [String]
+      # @!attribute [r] client_class_docname
+      #   Name of the class as it should appear in the documentation
+      #   @return [String]
+      # @!attribute [r] client_var_name
+      #   Name for the variable for the client of the service
+      #   @return [String]
+      # @!attribute [r] require_str
+      #   Path to `require` the client of the service
+      #   @return [String]
+      # @!attribute [r] service_description
+      #   The description to place in the comments to this client's
+      #   attribute in the library services's client class
+      #   @return [String]
+      # @!attribute [r] bindings_override
+      #   Override of Http bindings for the methods of the mixin service
+      #     methods are specified by their full name, e.g. `google.cloud.location.Locations.ListLocations`
+      #   @return [Hash{String, Array<::Gapic::Model::Method::HttpAnnotation::HttpBinding>}]
+      #
+      class MixinClientPresenter < SubClientPresenter
+        attr_reader :bindings_override
+
+        ##
+        # @param service [String]
+        #   Full name of the service providing the nonstandard LRO functionality
+        # @param client_class_name [String]
+        #   Full name of the class of the client of the service
+        # @param client_class_docname [String]
+        #   Name of the class as it should appear in the documentation
+        # @param client_var_name [String]
+        #   Name for the variable for the client of the service
+        # @param require_str [String]
+        #   Path to `require` the client of the service
+        # @param service_description [String]
+        #   The description to place in the comments to this client's
+        #   attribute in the library services's client class
+        #
+        def initialize service:,
+                       client_class_name:,
+                       client_class_docname:,
+                       client_var_name:,
+                       require_str:,
+                       service_description:,
+                       bindings_override:
+          super(service: service,
+                client_class_name: client_class_name,
+                client_class_docname: client_class_docname,
+                client_var_name: client_var_name,
+                require_str: require_str,
+                service_description: service_description
+              )
+
+          @bindings_override = bindings_override
+        end
+      end
+    end
+  end
+end

data/lib/gapic/presenters/service/sub_client_presenter.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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 Presenters
+    module Service
+      ##
+      # @private
+      # Base class for the presenter for the generation of the clients
+      # for sub-services (mixins, lros) inside a host service's client class
+      #
+      # @!attribute [r] service
+      #   Full name of the service providing the nonstandard LRO functionality
+      #   @return [String]
+      # @!attribute [r] client_class_name
+      #   Full name of the class of the client of the service
+      #   @return [String]
+      # @!attribute [r] client_class_docname
+      #   Name of the class as it should appear in the documentation
+      #   @return [String]
+      # @!attribute [r] client_var_name
+      #   Name for the variable for the client of the service
+      #   @return [String]
+      # @!attribute [r] require_str
+      #   Path to `require` the client of the service
+      #   @return [String]
+      # @!attribute [r] service_description
+      #   The description to place in the comments to this client's
+      #   attribute in the library services's client class
+      #   @return [String]
+      #
+      class SubClientPresenter
+        attr_reader :service
+        attr_reader :client_class_name
+        attr_reader :client_class_docname
+        attr_reader :client_var_name
+        attr_reader :require_str
+        attr_reader :service_description
+
+        ##
+        # @param service [String]
+        #   Full name of the service providing the nonstandard LRO functionality
+        # @param client_class_name [String]
+        #   Full name of the class of the client of the service
+        # @param client_class_docname [String]
+        #   Name of the class as it should appear in the documentation
+        # @param client_var_name [String]
+        #   Name for the variable for the client of the service
+        # @param require_str [String]
+        #   Path to `require` the client of the service
+        # @param service_description [String]
+        #   The description to place in the comments to this client's
+        #   attribute in the library services's client class
+        #
+        def initialize service:,
+                       client_class_name:,
+                       client_class_docname:,
+                       client_var_name:,
+                       require_str:,
+                       service_description:
+          @service = service
+          @client_class_name = client_class_name
+          @client_class_docname = client_class_docname
+          @client_var_name = client_var_name
+          @require_str = require_str
+          @service_description = service_description
+        end
+      end
+    end
+  end
+end