gapic-common 0.18.0 → 0.19.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 609c468f1e8a7e60f8b4ba911901dd99f8816cb367371dd5479d79dcd06bca82
-  data.tar.gz: 23a01faa58af17577e262852d434a6746b33f090247b05ea9dc8ce2ae07772bb
+  metadata.gz: 9f42f8b965f312b70a2746fa345c8a546ecfe319c5189ed19654145b7206b66d
+  data.tar.gz: a97b42149a8fb5f6797cb608716b8b639bf1cd04d657e8fdf83ab455ae6ca147
 SHA512:
-  metadata.gz: 7fc2a7f8c0fdcc79434966a1e6431c29d957dd1a646cae5a8cd023da1320b7f5253b69f4edd915c98656b12e681aac66bf11713c2bb47f0482798601635ba948
-  data.tar.gz: 49a6c6aaa7fca24979d8707bc7a6ba2b8daed51951539d2235be32f932e73a02fa4cd8d7699f811b358bd216ca99ffbe63dab0469196b1815cdf37eb6ad4055c
+  metadata.gz: '02587d4f734c88f473265b1ef1d8fce02086be8c270fc679846697860bb37e4bf43a8cf8ed2126df64641040f0123741b965162dab2e889f0223955372c94b52'
+  data.tar.gz: 55105ce9ce9b47684ce10fe0bdeba37ec0caeba7949767d5829225fb0993266a52e0975db50fcac8a8f82df8cd04309709be45699e748b6f74175adf0f19aaeb

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Release History
 
+### 0.19.1 (2023-05-30)
+
+#### Bug Fixes
+
+* Fixed handling of optional fields in coerce ([#954](https://github.com/googleapis/gapic-generator-ruby/issues/954)) 
+
+### 0.19.0 (2023-05-26)
+
+#### Features
+
+* Compatibility with protobuf v23 generated map fields ([#948](https://github.com/googleapis/gapic-generator-ruby/issues/948)) 
+
 ### 0.18.0 (2023-02-27)
 
 #### Features

data/lib/gapic/common/version.rb

@@ -14,6 +14,6 @@
 
 module Gapic
   module Common
-    VERSION = "0.18.0".freeze
+    VERSION = "0.19.1".freeze
   end
 end

data/lib/gapic/protobuf.rb

@@ -16,7 +16,8 @@ require "google/protobuf/timestamp_pb"
 
 module Gapic
   ##
-  # TODO: Describe Protobuf
+  # A set of internal utilities for coercing data to protobuf messages.
+  #
   module Protobuf
     ##
     # Creates an instance of a protobuf message from a hash that may include nested hashes. `google/protobuf` allows
@@ -30,11 +31,15 @@ module Gapic
     # @return [Object] An instance of the given message class.
     def self.coerce hash, to:
       return hash if hash.is_a? to
+      return nil if hash.nil?
+
+      # Special case handling of certain types
+      return time_to_timestamp hash if to == Google::Protobuf::Timestamp && hash.is_a?(Time)
 
       # Sanity check: input must be a Hash
       raise ArgumentError, "Value #{hash} must be a Hash or a #{to.name}" unless hash.is_a? Hash
 
-      hash = coerce_submessages hash, to
+      hash = coerce_submessages hash, to.descriptor
       to.new hash
     end
 
@@ -44,89 +49,58 @@ module Gapic
     # @private
     #
     # @param hash [Hash] The hash whose nested hashes will be coerced.
-    # @param message_class [Class] The corresponding protobuf message class of the given hash.
+    # @param message_descriptor [Google::Protobuf::Descriptor] The protobuf descriptor for the message.
     #
     # @return [Hash] A hash whose nested hashes have been coerced.
-    def self.coerce_submessages hash, message_class
+    def self.coerce_submessages hash, message_descriptor
       return nil if hash.nil?
       coerced = {}
-      message_descriptor = message_class.descriptor
       hash.each do |key, val|
         field_descriptor = message_descriptor.lookup key.to_s
-        coerced[key] = if field_descriptor && field_descriptor.type == :message
-                         coerce_submessage val, field_descriptor
-                       elsif field_descriptor && field_descriptor.type == :bytes &&
-                             (val.is_a?(IO) || val.is_a?(StringIO))
-                         val.binmode.read
-                       else
-                         # `google/protobuf` should throw an error if no field descriptor is
-                         # found. Simply pass through.
-                         val
-                       end
+        coerced[key] =
+          if field_descriptor&.type == :message
+            coerce_submessage val, field_descriptor
+          elsif field_descriptor&.type == :bytes && (val.is_a?(IO) || val.is_a?(StringIO))
+            val.binmode.read
+          else
+            # For non-message fields, just pass the scalar value through.
+            # Note: if field_descriptor is not found, we just pass the value
+            # through and let protobuf raise an error.
+            val
+          end
       end
       coerced
     end
 
     ##
-    # Coerces the value of a field to be acceptable by the instantiation method of the wrapping message.
+    # Coerces a message-typed field.
+    # The field can be a normal single message, a repeated message, or a map.
     #
     # @private
     #
-    # @param val [Object] The value to be coerced.
-    # @param field_descriptor [Google::Protobuf::FieldDescriptor] The field descriptor of the value.
+    # @param val [Object] The value to coerce
+    # @param field_descriptor [Google::Protobuf::FieldDescriptor] The field descriptor.
     #
-    # @return [Object] The coerced version of the given value.
     def self.coerce_submessage val, field_descriptor
-      if (field_descriptor.label == :repeated) && !(map_field? field_descriptor)
-        coerce_array val, field_descriptor
-      elsif field_descriptor.subtype.msgclass == Google::Protobuf::Timestamp && val.is_a?(Time)
-        time_to_timestamp val
+      if val.is_a? Array
+        # Assume this is a repeated message field, iterate over it and coerce
+        # each to the message class.
+        # Protobuf will raise an error if this assumption is incorrect.
+        val.map do |elem|
+          coerce elem, to: field_descriptor.subtype.msgclass
+        end
+      elsif field_descriptor.label == :repeated
+        # Non-array passed to a repeated field: assume this is a map, and that
+        # a hash is being passed, and let protobuf handle the conversion.
+        # Protobuf will raise an error if this assumption is incorrect.
+        val
       else
-        coerce_value val, field_descriptor
+        # Assume this is a normal single message, and coerce to the message
+        # class.
+        coerce val, to: field_descriptor.subtype.msgclass
       end
     end
 
-    ##
-    # Coerces the values of an array to be acceptable by the instantiation method the wrapping message.
-    #
-    # @private
-    #
-    # @param array [Array<Object>] The values to be coerced.
-    # @param field_descriptor [Google::Protobuf::FieldDescriptor] The field descriptor of the values.
-    #
-    # @return [Array<Object>] The coerced version of the given values.
-    def self.coerce_array array, field_descriptor
-      raise ArgumentError, "Value #{array} must be an array" unless array.is_a? Array
-      array.map do |val|
-        coerce_value val, field_descriptor
-      end
-    end
-
-    ##
-    # Hack to determine if field_descriptor is for a map.
-    #
-    # TODO(geigerj): Remove this once protobuf Ruby supports an official way
-    # to determine if a FieldDescriptor represents a map.
-    # See: https://github.com/google/protobuf/issues/3425
-    def self.map_field? field_descriptor
-      (field_descriptor.label == :repeated) &&
-        (field_descriptor.subtype.name.include? "_MapEntry_")
-    end
-
-    ##
-    # Coerces the value of a field to be acceptable by the instantiation method of the wrapping message.
-    #
-    # @private
-    #
-    # @param val [Object] The value to be coerced.
-    # @param field_descriptor [Google::Protobuf::FieldDescriptor] The field descriptor of the value.
-    #
-    # @return [Object] The coerced version of the given value.
-    def self.coerce_value val, field_descriptor
-      return val unless (val.is_a? Hash) && !(map_field? field_descriptor)
-      coerce val, to: field_descriptor.subtype.msgclass
-    end
-
     ##
     # Utility for converting a Google::Protobuf::Timestamp instance to a Ruby time.
     #
@@ -147,6 +121,6 @@ module Gapic
       Google::Protobuf::Timestamp.new seconds: time.to_i, nanos: time.nsec
     end
 
-    private_class_method :coerce_submessages, :coerce_submessage, :coerce_array, :coerce_value, :map_field?
+    private_class_method :coerce_submessages, :coerce_submessage
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gapic-common
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.19.1
 platform: ruby
 authors:
 - Google API Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-27 00:00:00.000000000 Z
+date: 2023-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday