gapic-generator 0.45.4 → 0.46.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3f7283592167653163c4acebf0950f43eae341db2d41e0a8ff65f5cbad56194
-  data.tar.gz: d9680dfecc27af932856241ab1e269044df8d27e33fb662b55649866dbd83554
+  metadata.gz: a1581701f0920357a40caf74e135e5893b7caef2bcbf5e675e78acc072177ed0
+  data.tar.gz: fdb1ecf452f4ae7e99ec59fba3d883aa02be16b7fe1f53e6e55f4756d7776b9f
 SHA512:
-  metadata.gz: 6cd6639f82511f747baebc0aeb4117f42561bd9987a248bfc23bdf4d9cea7f2cf04c60a00de6aefbc7e40cf3cf7861515f17b7e970ef1c7c88d793b6f52b19dd
-  data.tar.gz: 5479a3b76164c023acbe2415805809be3a33850f6fa71930882c507dce92d06ba289d41a2f5d94fca464a084dd7f440717c6fd902666415f2bb57a5c8235f7e1
+  metadata.gz: 8fc649d55af2f891a22cdef09c9d8aaa690dae27b63e5c5c0d7e13fa3a2720729d5b88c7307efa47678ea1be3c56143569fee7212d126ae8b2066419bdf361d3
+  data.tar.gz: bd3343fa686b52dea9d673de62a8dc42de92ad15bcb78c31eb42e0fee90a521ed1d85da72515610ccccd45b36ee70735a9f2ea380083b67a56a99dd00de71e17

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Release History for gapic-generator
 
+### 0.46.0 / 2025-08-13
+
+* Feature: use HTTP binding configuration class from new gapic-common
+* Fix: Remove unnecessary services_pb import from tests
+* Fix: no longer generate cross-package references for mixin objects
+* Feature: add support for multiple patterns with same arguments
+
 ### 0.45.4 / 2025-06-26
 
 * Fix: docs for oneof parameters

data/lib/gapic/formatting_utils.rb

@@ -116,7 +116,12 @@ module Gapic
       def format_line_xrefs api, line, disable_xrefs, transport
         while (m = @xref_detector.match line)
           entity = api.lookup m[:addr]
-          return line if entity.nil?
+          is_mixin_field_addr = Gapic::Model::Mixins.mixin_message_field_address?(
+            m[:addr],
+            gem_name: api.configuration.fetch(:gem, nil)&.fetch(:name, "")
+          )
+          return line if entity.nil? || is_mixin_field_addr
+
           text = m[:text]
           yard_link = disable_xrefs ? text : yard_link_for_entity(entity, text, transport)
           return line if yard_link.nil?

data/lib/gapic/generator/version.rb

@@ -16,6 +16,6 @@
 
 module Gapic
   module Generator
-    VERSION = "0.45.4"
+    VERSION = "0.46.0"
   end
 end

data/lib/gapic/model/mixins.rb

@@ -162,6 +162,25 @@ module Gapic
         MIXIN_GEM_NAMES.include?(service_address) && gem_name != MIXIN_GEM_NAMES[service_address]
       end
 
+      ##
+      # Returns true if the given service address is a mixin.
+      # This just checks the service against a (hard-coded) set of known mixins.
+      # If `gem_name` is provided, objects from the package of the service
+      # that corresponds to that gem_name are not considered mixins.
+      #
+      # @param message_field_address [String,Array<String>] The address (either array
+      #     or dot-delimited) of the message or field to check.
+      # @param gem_name [String] The name of the gem.
+      # @return [boolean]
+      #
+      def self.mixin_message_field_address? message_field_address, gem_name: nil
+        message_field_address = message_field_address.join "." unless message_field_address.is_a? String
+        # NB: messages are checked against package, not service
+        service_address = MIXIN_GEM_NAMES.keys.find { |sn| message_field_address.start_with? MIXIN_PACKAGE_NAMES[sn] }
+
+        !service_address.nil? && gem_name != MIXIN_GEM_NAMES[service_address]
+      end
+
       private
 
       # @return [Enumerable<String>] Names of all services that are specified
@@ -179,6 +198,13 @@ module Gapic
       }.freeze
       private_constant :MIXIN_GEM_NAMES
 
+      MIXIN_PACKAGE_NAMES = {
+        LOCATIONS_SERVICE => "google.cloud.location",
+        IAM_SERVICE => "google.iam.v1",
+        LRO_SERVICE => "google.longrunning.operations"
+      }.freeze
+      private_constant :MIXIN_PACKAGE_NAMES
+
       # Since mixins are scope-limited to a couple of services, it is easier to
       # have these in lookup tables than to construct a ServicePresenter
 

data/lib/gapic/presenters/gem_presenter.rb

@@ -256,7 +256,7 @@ module Gapic
 
       def dependencies
         @dependencies ||= begin
-          deps = { "gapic-common" => "~> 1.0" }
+          deps = { "gapic-common" => "~> 1.1" }
           deps["grpc-google-iam-v1"] = "~> 1.11" if iam_dependency?
           extra_deps = gem_config_dependencies
           deps.merge! mixins_model.dependencies if mixins_model.mixins?

data/lib/gapic/presenters/resource_presenter.rb

@@ -26,10 +26,13 @@ module Gapic
       def initialize resource
         @resource = resource
 
-        @patterns = resource.pattern.map { |pattern| PatternPresenter.new pattern }
+        all_patterns = resource.pattern.map { |pattern| PatternPresenter.new pattern }
 
         # Keep only patterns that can be used to create path helpers
-        @patterns.filter!(&:useful_for_helpers?)
+        all_useful_patterns = all_patterns.filter(&:useful_for_helpers?)
+
+        # Remove patterns where key is duplicated
+        @patterns = ResourcePresenter.dedup_patterns all_useful_patterns
       end
 
       def dup
@@ -52,6 +55,25 @@ module Gapic
         "#{ActiveSupport::Inflector.underscore name}_path"
       end
 
+      ##
+      # Deduplicates pattern that have the same `arguments_key`. Our design for the "paths" helper
+      # only allows for one pattern per `arguments_key`.
+      #
+      # If patterns with the same `arguments_key` are detected, the shortest is taken. If there is
+      # a tie, the lexicographically first is taken.
+      #
+      # @param patterns [Array<PatternPresenter>]
+      #
+      # @return [Array<PatternPresenter>]
+      #
+      def self.dedup_patterns patterns
+        patterns.group_by(&:arguments_key).map do |_arguments_key, group|
+          group.min_by do |pattern|
+            [pattern.pattern.length, pattern.pattern]
+          end
+        end
+      end
+
       ##
       # A presenter for a particular pattern
       #

data/templates/default/lib/_binding_override.text.erb

@@ -1,6 +1,6 @@
 <%- assert_locals package -%>
 <% @requires = capture do %>
-require "gapic/config"
+require "gapic/rest"
 <%- end -%>
 
 <%- if package.first_service_with_rest&.generate_rest_clients? -%>
@@ -19,31 +19,4 @@ module <%= package.module_name %>
   def self.configure
 <%= indent render(partial: "lib/package/self_configure", locals: { package: package }), 4 %>
   end
-
-  ##
-  # @private
-  # Configuration class for the <%= package.name %> package.
-  #
-  # This class contains common configuration for all services
-  # of the <%= package.name %> package.
-  #
-  # This configuration is for internal use of the client library classes,
-  # and it is not intended that the end-users will read or change it.
-  #
-  class Configuration
-    extend ::Gapic::Config
-
-    # @private
-    # Overrides for http bindings for the RPC of the mixins for this package.
-    # Services in this package should use these when creating clients for the mixin services.
-    # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
-    config_attr :bindings_override, {}, ::Hash, nil
-
-    # @private
-    def initialize parent_config = nil
-      @parent_config = parent_config unless parent_config.nil?
-
-      yield self if block_given?
-    end
-  end
 end

data/templates/default/lib/package/_self_configure.text.erb

@@ -8,7 +8,7 @@
                     namespace.pop
                   end
 
-  default_config = Configuration.new parent_config
+  default_config = ::Gapic::Rest::HttpBindingOverrideConfiguration.new parent_config
   <%= indent_tail render(partial: "lib/package/self_configure_defaults", locals: {package: package}), 2 %>
   default_config
 end

data/templates/default/service/test/client.text.erb

@@ -5,7 +5,6 @@ require "helper"
 require "gapic/grpc/service_stub"
 
 require "<%= service.proto_service_require %>"
-require "<%= service.proto_services_require %>"
 require "<%= service.service_require %>"
 
 class <%= service.client_name_full %>Test < Minitest::Test

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gapic-generator
 version: !ruby/object:Gem::Version
-  version: 0.45.4
+  version: 0.46.0
 platform: ruby
 authors:
 - Ernest Landrito