google-cloud-firestore 2.9.0 → 2.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5c050184924a624eb5f83c42f528334296cc01392d5a9b1d891d81c2b7f4e50
-  data.tar.gz: '085ffdcff90414ab769e585164e331a4d27b1edcfed7341d6c09998aca4a58c6'
+  metadata.gz: 31a027bd1f01c1bd2568417742a77525e4e5659316a9e81ff123062d095b580c
+  data.tar.gz: d85d3a069d0f3f3847a10ea0963896c3be546f8452a1eb8eb06e9d7c664ec525
 SHA512:
-  metadata.gz: d5b99c1fa86740df4973731ecf715158cfbb8025fc46833f7b78cf9102d78245106133aed9e92311d5ae0879289054bbc7c832396792141e0df09abc7e6d7357
-  data.tar.gz: 9ccefface707ebaf31f3c8e7a998e7ae7f95713a9ec71df4e691d3be3997eadc528f95dfaf5de8bce00162a2c69856b704b198fd4ccea0376f4804451f1f4c77
+  metadata.gz: d6d1ebeb7079ce28256ab3348110fdbab52d73db16e0cf6d7a1ee27f343d9918d1b8a3e7225504c268a13d3e7371706028487e2a14fcbf0e2b7e2cf8dcbda371
+  data.tar.gz: 7c34ced999d1368fdc3e645e128197fc7e9cb51850bf39cb753b680bbd5d6a1f70ba3572be04d5ab4c909008104c8a5cd4f1144d24e630ebbebb8333fef6baf1

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Release History
 
+### 2.9.1 (2023-02-03)
+
+#### Bug Fixes
+
+* Change "aggregate_alias" to optional param ([#20082](https://github.com/googleapis/google-cloud-ruby/issues/20082)) 
+
 ### 2.9.0 (2023-01-26)
 
 #### Features

data/lib/google/cloud/firestore/aggregate_query.rb

@@ -38,7 +38,7 @@ module Google
       #                          .add_count
       #
       #   aggregate_query.get do |aggregate_snapshot|
-      #     puts aggregate_snapshot.get('count')
+      #     puts aggregate_snapshot.get
       #   end
       #
       # @example Alias an aggregate query
@@ -102,7 +102,7 @@ module Google
         #                          .add_count
         #
         #   aggregate_query.get do |aggregate_snapshot|
-        #     puts aggregate_snapshot.get('count')
+        #     puts aggregate_snapshot.get
         #   end
         #
         def add_count aggregate_alias: nil
@@ -135,7 +135,7 @@ module Google
         #                          .add_count
         #
         #   aggregate_query.get do |aggregate_snapshot|
-        #     puts aggregate_snapshot.get('count')
+        #     puts aggregate_snapshot.get
         #   end
         #
         def get

data/lib/google/cloud/firestore/aggregate_query_snapshot.rb

@@ -34,16 +34,31 @@ module Google
       #                          .add_count
       #
       #   aggregate_query.get do |aggregate_snapshot|
-      #     puts aggregate_snapshot.get('count')
+      #     puts aggregate_snapshot.get
       #   end
+      # @return [Integer] The aggregate value.
       #
+      # @example Alias an aggregate query
+      #   require "google/cloud/firestore"
+      #
+      #   firestore = Google::Cloud::Firestore.new
+      #
+      #   query = firestore.col "cities"
+      #
+      #   # Create an aggregate query
+      #   aggregate_query = query.aggregate_query
+      #                          .add_count aggregate_alias: 'total'
+      #
+      #   aggregate_query.get do |aggregate_snapshot|
+      #     puts aggregate_snapshot.get('total')
+      #   end
       class AggregateQuerySnapshot
         ##
         # Retrieves the aggregate data.
         #
-        # @param [String] aggregate_alias The alias used
-        #   to access the aggregate value. For count, the
-        #   default value is "count".
+        # @param aggregate_alias [String] The alias used to access
+        #   the aggregate value. For an AggregateQuery with a
+        #   single aggregate field, this parameter can be omitted.
         #
         # @return [Integer] The aggregate value.
         #
@@ -59,9 +74,29 @@ module Google
         #                          .add_count
         #
         #   aggregate_query.get do |aggregate_snapshot|
-        #     puts aggregate_snapshot.get('count')
+        #     puts aggregate_snapshot.get
         #   end
-        def get aggregate_alias
+        # @return [Integer] The aggregate value.
+        #
+        # @example Alias an aggregate query
+        #   require "google/cloud/firestore"
+        #
+        #   firestore = Google::Cloud::Firestore.new
+        #
+        #   query = firestore.col "cities"
+        #
+        #   # Create an aggregate query
+        #   aggregate_query = query.aggregate_query
+        #                          .add_count aggregate_alias: 'total'
+        #
+        #   aggregate_query.get do |aggregate_snapshot|
+        #     puts aggregate_snapshot.get('total')
+        #   end
+        def get aggregate_alias = nil
+          if @aggregate_fields.count > 1 && aggregate_alias.nil?
+            raise ArgumentError, "Required param aggregate_alias for AggregateQuery with multiple aggregate fields"
+          end
+          aggregate_alias ||= @aggregate_fields.keys.first
           @aggregate_fields[aggregate_alias]
         end
 

data/lib/google/cloud/firestore/transaction.rb

@@ -286,9 +286,15 @@ module Google
         #
         #   firestore = Google::Cloud::Firestore.new
         #
+        #   query = firestore.col "cities"
+        #
+        #   # Create an aggregate query
+        #   aq = query.aggregate_query
+        #             .add_count
+        #
         #   firestore.transaction do |tx|
         #     tx.get_aggregate aq do |aggregate_snapshot|
-        #       puts aggregate_snapshot.get('count')
+        #       puts aggregate_snapshot.get
         #     end
         #   end
         #

data/lib/google/cloud/firestore/version.rb

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Firestore
-      VERSION = "2.9.0".freeze
+      VERSION = "2.9.1".freeze
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-firestore
 version: !ruby/object:Gem::Version
-  version: 2.9.0
+  version: 2.9.1
 platform: ruby
 authors:
 - Google Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-27 00:00:00.000000000 Z
+date: 2023-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core