google-cloud-datastore 2.7.1 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 646ed90d461784d6870d425a6f98271a249338a72696200b3b2707d3e4725098
-  data.tar.gz: 963afff082dd55de2dce0f58715bd76c17497e118b0db92b7a542b6dd813b00d
+  metadata.gz: ed10b12e2ec3c4588dba12b44b76116605981600f15623e1a4a48af8646424ba
+  data.tar.gz: '095dcff60d7ab782f182264f20f0294be2f01b61278fbd448b307b9d7b922504'
 SHA512:
-  metadata.gz: 832baf39842dd1261ee5394284a0cc8448bd65fbf08162cc49a95f16654676f4dae76d4cb80be58a2692f7035f613b3b1668bf6e5f7d73f175a3f3ad7d6e3eb0
-  data.tar.gz: dd2b0d16cf4727a342e305a6c3dee82add4ce10f5faac8c691216e9e4a88d356d89cb49684cc71b92bfe162bc9aa099abca54c260698ca96722400a729a952e7
+  metadata.gz: abddd5e808cb0b94c4fd26f5c0a18df08cbf211894e1b732cbbe1f611f225cf311450df52d61c6eca430b74483b222ea48b55a30d8139d92bdc25e355fb1d55a
+  data.tar.gz: 3df7cd4c6ca17d8ab1770ec93a92c4426f67f16eb0fe15335c6986a1f568ca16c2058290605a490984b5598fc266380339ac0b6f613562ceda2fc541d7e24063

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Release History
 
+### 2.9.0 (2024-03-10)
+
+#### Features
+
+* Update minimum supported Ruby version to 2.7 ([#25298](https://github.com/googleapis/google-cloud-ruby/issues/25298)) 
+
+### 2.8.0 (2023-09-12)
+
+#### Features
+
+* Support sum & avg aggregate functions ([#22884](https://github.com/googleapis/google-cloud-ruby/issues/22884)) 
+
 ### 2.7.1 (2023-05-18)
 
 #### Documentation

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

@@ -56,6 +56,15 @@ module Google
       #   puts aggregate_query_results.get('total')
       #
       class AggregateQuery
+        # @private
+        DEFAULT_COUNT_AGGREGATE_ALIAS = "count".freeze
+
+        # @private
+        DEFAULT_SUM_AGGREGATE_ALIAS = "sum".freeze
+
+        # @private
+        DEFAULT_AVG_AGGREGATE_ALIAS = "avg".freeze
+
         ##
         # @private The Google::Cloud::Datastore::V1::AggregationQuery object.
         attr_reader :grpc
@@ -113,7 +122,7 @@ module Google
         #   puts aggregate_query_results.get('total')
         #
         def add_count aggregate_alias: nil
-          aggregate_alias ||= ALIASES[:count]
+          aggregate_alias ||= DEFAULT_COUNT_AGGREGATE_ALIAS
           @grpc.aggregations << Google::Cloud::Datastore::V1::AggregationQuery::Aggregation.new(
             count: Google::Cloud::Datastore::V1::AggregationQuery::Aggregation::Count.new,
             alias: aggregate_alias
@@ -122,16 +131,118 @@ module Google
           self
         end
 
-        # @private
-        def to_grpc
-          @grpc
+        ##
+        # Adds a sum aggregate.
+        #
+        # @param name [String] The property to sum by.
+        # @param aggregate_alias [String] Alias to refer to the aggregate. Optional
+        #
+        # @return [AggregateQuery] The modified aggregate query object with the added SUM aggregate.
+        #
+        # @example
+        #   require "google/cloud/datastore"
+        #
+        #   datastore = Google::Cloud::Datastore.new
+        #
+        #   query = Google::Cloud::Datastore::Query.new
+        #   query.kind("Task")
+        #        .where("done", "=", false)
+        #
+        #   Create an aggregate query
+        #   aggregate_query = query.aggregate_query
+        #                          .add_sum("score")
+        #
+        #   aggregate_query_results = dataset.run_aggregation aggregate_query
+        #   puts aggregate_query_results.get
+        #
+        # @example Alias an aggregate SUM query
+        #   require "google/cloud/datastore"
+        #
+        #   datastore = Google::Cloud::Datastore.new
+        #
+        #   query = Google::Cloud::Datastore::Query.new
+        #   query.kind("Task")
+        #        .where("done", "=", false)
+        #
+        #   # Create an aggregate query
+        #   aggregate_query = query.aggregate_query
+        #                          .add_sum("score", aggregate_alias: 'total_score')
+        #
+        #   aggregate_query_results = dataset.run_aggregation aggregate_query
+        #   puts aggregate_query_results.get('total_score')
+        #
+        def add_sum name, aggregate_alias: nil
+          aggregate_alias ||= DEFAULT_SUM_AGGREGATE_ALIAS
+          @grpc.aggregations << Google::Cloud::Datastore::V1::AggregationQuery::Aggregation.new(
+            sum: Google::Cloud::Datastore::V1::AggregationQuery::Aggregation::Sum.new(
+              property: Google::Cloud::Datastore::V1::PropertyReference.new(
+                name: name
+              )
+            ),
+            alias: aggregate_alias
+          )
+
+          self
         end
 
         ##
+        # Adds an average aggregate.
+        #
+        # @param name [String] The property to apply average on.
+        # @param aggregate_alias [String] Alias to refer to the aggregate. Optional
+        #
+        # @return [AggregateQuery] The modified aggregate query object with the added AVG aggregate.
+        #
+        # @example
+        #   require "google/cloud/datastore"
+        #
+        #   datastore = Google::Cloud::Datastore.new
+        #
+        #   query = Google::Cloud::Datastore::Query.new
+        #   query.kind("Task")
+        #        .where("done", "=", false)
+        #
+        #   Create an aggregate query
+        #   aggregate_query = query.aggregate_query
+        #                          .add_avg("score")
+        #
+        #   aggregate_query_results = dataset.run_aggregation aggregate_query
+        #   puts aggregate_query_results.get
+        #
+        # @example Alias an aggregate AVG query
+        #   require "google/cloud/datastore"
+        #
+        #   datastore = Google::Cloud::Datastore.new
+        #
+        #   query = Google::Cloud::Datastore::Query.new
+        #   query.kind("Task")
+        #        .where("done", "=", false)
+        #
+        #   # Create an aggregate query
+        #   aggregate_query = query.aggregate_query
+        #                          .add_avg("score", aggregate_alias: 'avg_score')
+        #
+        #   aggregate_query_results = dataset.run_aggregation aggregate_query
+        #   puts aggregate_query_results.get('avg_score')
+        #
+        def add_avg name, aggregate_alias: nil
+          aggregate_alias ||= DEFAULT_AVG_AGGREGATE_ALIAS
+          @grpc.aggregations << Google::Cloud::Datastore::V1::AggregationQuery::Aggregation.new(
+            avg: Google::Cloud::Datastore::V1::AggregationQuery::Aggregation::Avg.new(
+              property: Google::Cloud::Datastore::V1::PropertyReference.new(
+                name: name
+              )
+            ),
+            alias: aggregate_alias
+          )
+
+          self
+        end
+
         # @private
-        ALIASES = {
-          count: "count"
-        }.freeze
+        def to_grpc
+          @grpc
+        end
       end
     end
   end

data/lib/google/cloud/datastore/dataset/aggregate_query_results.rb

@@ -39,6 +39,17 @@ module Google
         #   puts aggregate_query_results.get
         #
         class AggregateQueryResults
+          ##
+          # @private Object of type [Hash{String => Object}].
+          #
+          # String can have the following values:
+          #   - an aggregate literal "sum", "avg", or "count"
+          #   - a custom aggregate alias
+          # Object can have the following types:
+          #   - Integer
+          #   - Float
+          attr_reader :aggregate_fields
+
           ##
           # Read timestamp the query was done on the database at.
           #
@@ -52,7 +63,8 @@ module Google
           #   the aggregate value. For an AggregateQuery with a
           #   single aggregate field, this parameter can be omitted.
           #
-          # @return [Integer] The aggregate value.
+          # @return [Integer, Float, nil] The aggregate value. Returns `nil`
+          # if the aggregate_alias does not exist.
           #
           # @example
           #   require "google/cloud/datastore"
@@ -101,10 +113,16 @@ module Google
                                .batch
                                .aggregation_results[0]
                                .aggregate_properties
-                               .to_h
-                               .transform_values { |v| v[:integer_value] }
+                               .map do |aggregate_alias, value|
+                                 if value.has_integer_value?
+                                   [aggregate_alias, value.integer_value]
+                                 else
+                                   [aggregate_alias, value.double_value]
+                                 end
+                               end
+
             new.tap do |s|
-              s.instance_variable_set :@aggregate_fields, aggregate_fields
+              s.instance_variable_set :@aggregate_fields, aggregate_fields.to_h
               s.instance_variable_set :@read_time, aggregate_query_response.batch.read_time
             end
           end

data/lib/google/cloud/datastore/gql_query.rb

@@ -127,15 +127,14 @@ module Google
         #   query string to valid GQL arguments
         #
         def named_bindings
-          bindings = Hash[@grpc.named_bindings.map do |name, gql_query_param|
+          bindings_elems = @grpc.named_bindings.map do |name, gql_query_param|
             if gql_query_param.parameter_type == :cursor
               [name, Cursor.from_grpc(gql_query_param.cursor)]
             else
               [name, Convert.from_value(gql_query_param.value)]
             end
-          end]
-          bindings.freeze
-          bindings
+          end
+          bindings_elems.to_h.freeze
         end
 
         ##

data/lib/google/cloud/datastore/key.rb

@@ -261,7 +261,7 @@ module Google
         #
         def path
           new_path = parent ? parent.path : []
-          new_path << [kind, (id || name)]
+          new_path << [kind, id || name]
         end
 
         ##

data/lib/google/cloud/datastore/properties.rb

@@ -74,12 +74,13 @@ module Google
 
         def to_grpc
           # Convert to Hash with Google::Cloud::Datastore::V1::Value values.
-          Hash[@hash.map { |k, v| [k.to_s, Convert.to_value(v)] }]
+          @hash.to_h { |k, v| [k.to_s, Convert.to_value(v)] }
         end
 
         def self.from_grpc grpc_map
           # Convert to Hash of string keys and raw values.
-          new Hash[grpc_map.map { |k, v| [k.to_s, Convert.from_value(v)] }]
+          map_elems = grpc_map.map { |k, v| [k.to_s, Convert.from_value(v)] }
+          new map_elems.to_h
         end
 
         protected

data/lib/google/cloud/datastore/service.rb

@@ -117,14 +117,13 @@ module Google
         def begin_transaction read_only: nil, previous_transaction: nil, read_time: nil
           if read_only
             transaction_options = Google::Cloud::Datastore::V1::TransactionOptions.new
-            transaction_options.read_only = \
+            transaction_options.read_only =
               Google::Cloud::Datastore::V1::TransactionOptions::ReadOnly.new \
                 read_time: read_time_to_timestamp(read_time)
 
           end
           if previous_transaction
-            transaction_options ||= \
-              Google::Cloud::Datastore::V1::TransactionOptions.new
+            transaction_options ||= Google::Cloud::Datastore::V1::TransactionOptions.new
             rw = Google::Cloud::Datastore::V1::TransactionOptions::ReadWrite.new(
               previous_transaction: previous_transaction.encode("ASCII-8BIT")
             )

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

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

data/lib/google/cloud/datastore.rb

@@ -127,7 +127,7 @@ module Google
           )
         end
 
-        credentials ||= (keyfile || default_credentials(scope: scope))
+        credentials ||= keyfile || default_credentials(scope: scope)
         unless credentials.is_a? Google::Auth::Credentials
           credentials = Datastore::Credentials.new credentials, scope: scope
         end

data/lib/google-cloud-datastore.rb

@@ -68,8 +68,10 @@ module Google
     #   datastore = gcloud.datastore scope: platform_scope
     #
     def datastore scope: nil, timeout: nil, database_id: nil
+      timeout ||= @timeout
       Google::Cloud.datastore @project, @keyfile,
-                              scope: scope, timeout: (timeout || @timeout),
+                              scope: scope,
+                              timeout: timeout,
                               database_id: database_id
     end
 
@@ -117,7 +119,8 @@ module Google
       require "google/cloud/datastore"
       Google::Cloud::Datastore.new project_id: project_id,
                                    credentials: credentials,
-                                   scope: scope, timeout: timeout,
+                                   scope: scope,
+                                   timeout: timeout,
                                    database_id: database_id
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-datastore
 version: !ruby/object:Gem::Version
-  version: 2.7.1
+  version: 2.9.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-19 00:00:00.000000000 Z
+date: 2024-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -39,146 +39,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.0'
-- !ruby/object:Gem::Dependency
-  name: google-style
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.25.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.25.1
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.16'
-- !ruby/object:Gem::Dependency
-  name: minitest-autotest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: minitest-focus
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-- !ruby/object:Gem::Dependency
-  name: minitest-rg
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.2'
-- !ruby/object:Gem::Dependency
-  name: autotest-suffix
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-- !ruby/object:Gem::Dependency
-  name: redcarpet
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-- !ruby/object:Gem::Dependency
-  name: yard-doctest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.13
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.13
 description: google-cloud-datastore is the official library for Google Cloud Datastore.
 email:
 - mike@blowmage.com
@@ -231,14 +91,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.2
+rubygems_version: 3.5.6
 signing_key: 
 specification_version: 4
 summary: API Client library for Google Cloud Datastore