google-cloud-datastore 2.6.0 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1471082bad6f76859fd0172a40bac47c81c31d3bc7f42e0f5135547f280307a6
-  data.tar.gz: a182edc1deadbfe697c45fad2bcde90379c58d07985833fd3f4bca64584bfaf2
+  metadata.gz: b372b670c25604994c20b79779906b9a7c00b21bdf3ada9a23eb2cbb5968d053
+  data.tar.gz: 2cb8cac3d2de7b1b631d1c9ee7332b7391a73a720968bf09dc0608430de2a472
 SHA512:
-  metadata.gz: 41ae448187ef6bbd842bcafcb2c6cbd107b81e4dfb55b72bbfb62857af387a82b4361cc3b86cdf00ab2657a5b98bcf6f51c1caf2090b2c922f8f3db03016e19a
-  data.tar.gz: 25725fc96567a06df8c6b75c4b29f9ff8077e77b59a7bb1c31d0c384a9a0d880d9e0d807653f75986c56d428dbcf7aaf09fa4074f7335eef76dcc520e21c9304
+  metadata.gz: dba07c333a2230e08f4c315dce2b8e28c748a082561c0692d9e419ba47565496b4b47463912e6cebea34ca3c33732df257ec6b4bcd9419b664cc16a4338b9b76
+  data.tar.gz: e817d031036cefd768ccf202a291435c6a710f69292ea61f2349bd5456732b3e0253ce94c75006abbcbc231c6c6e664bd4340dd2836f20978542dc2bb30b3b45

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Release History
 
+### 2.7.0 (2023-04-12)
+
+#### Features
+
+* Support OR filter ([#21002](https://github.com/googleapis/google-cloud-ruby/issues/21002)) 
+
 ### 2.6.0 (2023-02-13)
 
 #### Features

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

@@ -981,6 +981,38 @@ module Google
           entity
         end
 
+        ##
+        # Create a new Filter instance. This is a convenience method to make the
+        # creation of Filter objects easier.
+        #
+        # @param name [String] The property to filter by.
+        # @param operator [String] The operator to filter by. Defaults to nil.
+        # @param value The value to compare the property to. Defaults to nil.
+        #       Possible values are:
+        #         - Integer
+        #         - Float/BigDecimal
+        #         - String
+        #         - Boolean
+        #         - Array
+        #         - Date/Time
+        #         - StringIO
+        #         - Google::Cloud::Datastore::Key
+        #         - Google::Cloud::Datastore::Entity
+        #         - nil
+        #
+        # @return [Google::Cloud::Datastore::Filter]
+        #
+        # @example
+        #   require "google/cloud/datastore"
+        #
+        #   datastore = Google::Cloud::Datastore.new
+        #
+        #   filter = datastore.filter("done", "=", false)
+        #
+        def filter name, operator, value
+          Filter.new name, operator, value
+        end
+
         protected
 
         ##

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

@@ -0,0 +1,222 @@
+# Copyright 2023 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 "google/cloud/datastore/v1"
+
+module Google
+  module Cloud
+    module Datastore
+      ##
+      # Filter
+      #
+      # Represents the filter criteria for a datastore query.
+      #
+      # @example Run a query with a simple property filter.
+      #   require "google/cloud/datastore"
+      #
+      #   datastore = Google::Cloud::Datastore.new
+      #
+      #   filter = Google::Cloud::Datastore::Filter.new("done", "=", "false")
+      #
+      #   query = Google::Cloud::Datastore::Query.new
+      #   query.kind("Task")
+      #        .where(filter)
+      #
+      #   tasks = datastore.run query
+      #
+      # @example Construct a composite filter with a logical OR.
+      #   require "google/cloud/datastore"
+      #
+      #   datastore = Google::Cloud::Datastore.new
+      #
+      #   filter = Google::Cloud::Datastore::Filter.new("done", "=", "false")
+      #                                            .or("priority", ">=", "4")
+      #
+      #   query = Google::Cloud::Datastore::Query.new
+      #   query.kind("Task")
+      #        .where(filter)
+      #
+      #   tasks = datastore.run query
+      #
+      # @example Construct a composite filter by combining multiple filters.
+      #   require "google/cloud/datastore"
+      #
+      #   datastore = Google::Cloud::Datastore.new
+      #
+      #   filter_1 = Google::Cloud::Datastore::Filter.new("done", "=", "false")
+      #   filter_2 = Google::Cloud::Datastore::Filter.new("priority", ">=", "4")
+      #   filter = filter_1.or(filter_2)
+      #
+      #   query = Google::Cloud::Datastore::Query.new
+      #   query.kind("Task")
+      #        .where(filter)
+      #
+      #   tasks = datastore.run query
+      #
+      class Filter
+        ##
+        # @private Object of type
+        # Google::Cloud::Datastore::V1::Filter
+        attr_accessor :grpc
+
+        ##
+        # Creates a new Filter.
+        #
+        # @example
+        #   require "google/cloud/datastore"
+        #
+        #   filter = Google::Cloud::Datastore::Filter.new("done", "=", "false")
+        #
+        def initialize name, operator, value
+          @grpc = create_property_filter name, operator, value
+        end
+
+        ##
+        # Joins two filters with an AND operator.
+        #
+        # @overload and(name, operator, value)
+        #   Joins the filter with a property filter
+        #   @param name [String]
+        #   @param operator [String]
+        #   @param value
+        #
+        # @overload and(filter)
+        #   Joins the filter with a Filter object
+        #   @param filter [Filter]
+        #
+        # @example Join the filter with a property filter
+        #   require "google/cloud/datastore"
+        #
+        #   datastore = Google::Cloud::Datastore.new
+        #
+        #   filter = Google::Cloud::Filter.new("done", "=", false)
+        #                                 .and("priority", ">=", 4)
+        #
+        # @example Join the filter with a filter object
+        #   require "google/cloud/datastore"
+        #
+        #   datastore = Google::Cloud::Datastore.new
+        #
+        #   filter_1 = Google::Cloud::Filter.new("done", "=", false)
+        #   filter_2 = Google::Cloud::Filter.new("priority", ">=", 4)
+        #
+        #   filter = filter_1.and(filter_2)
+        #
+        def and name_or_filter, operator = nil, value = nil
+          combine_filters composite_filter_and, name_or_filter, operator, value
+        end
+
+        ##
+        # Joins two filters with an OR operator.
+        #
+        # @overload or(name, operator, value)
+        #   Joins the filter with a property filter
+        #   @param name [String] The property to filter by.
+        #   @param operator [String] The operator to filter by. Defaults to nil.
+        #   @param value [Object] The value to compare the property to. Defaults to nil.
+        #       Possible values are:
+        #         - Integer
+        #         - Float/BigDecimal
+        #         - String
+        #         - Boolean
+        #         - Array
+        #         - Date/Time
+        #         - StringIO
+        #         - Google::Cloud::Datastore::Key
+        #         - Google::Cloud::Datastore::Entity
+        #         - nil
+        #
+        # @overload or(filter)
+        #   Joins the filter with a Filter object
+        #   @param flter [Filter]
+        #
+        # @example Join the filter with a property filter
+        #   require "google/cloud/datastore"
+        #
+        #   datastore = Google::Cloud::Datastore.new
+        #
+        #   filter = Google::Cloud::Filter.new("done", "=", false)
+        #                                 .or("priority", ">=", 4)
+        #
+        # @example Join the filter with a filter object
+        #   require "google/cloud/datastore"
+        #
+        #   datastore = Google::Cloud::Datastore.new
+        #
+        #   filter_1 = Google::Cloud::Filter.new("done", "=", false)
+        #   filter_2 = Google::Cloud::Filter.new("priority", ">=", 4)
+        #
+        #   filter = filter_1.or(filter_2)
+        #
+        def or name_or_filter, operator = nil, value = nil
+          combine_filters composite_filter_or, name_or_filter, operator, value
+        end
+
+        # @private
+        def to_grpc
+          @grpc
+        end
+
+        protected
+
+        ##
+        # @private
+        #
+        # Combines self.grpc and (name_or_filter, operator, value)
+        # into the new_filter object with the specified AND/OR operator
+        def combine_filters new_filter, name_or_filter, operator, value
+          new_filter.composite_filter.filters << to_grpc
+          new_filter.composite_filter.filters << if name_or_filter.is_a? Google::Cloud::Datastore::Filter
+                                                   name_or_filter.to_grpc
+                                                 else
+                                                   create_property_filter name_or_filter, operator, value
+                                                 end
+          dup.tap do |f|
+            f.grpc = new_filter
+          end
+        end
+
+        ##
+        # @private
+        def composite_filter_and
+          Google::Cloud::Datastore::V1::Filter.new(
+            composite_filter: Google::Cloud::Datastore::V1::CompositeFilter.new(op: :AND)
+          )
+        end
+
+        ##
+        # @private
+        def composite_filter_or
+          Google::Cloud::Datastore::V1::Filter.new(
+            composite_filter: Google::Cloud::Datastore::V1::CompositeFilter.new(op: :OR)
+          )
+        end
+
+        ##
+        # @private
+        def create_property_filter name, operator, value
+          Google::Cloud::Datastore::V1::Filter.new(
+            property_filter: Google::Cloud::Datastore::V1::PropertyFilter.new(
+              property: Google::Cloud::Datastore::V1::PropertyReference.new(
+                name: name
+              ),
+              op: Convert.to_prop_filter_op(operator),
+              value: Convert.to_value(value)
+            )
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -16,6 +16,7 @@
 require "google/cloud/datastore/entity"
 require "google/cloud/datastore/key"
 require "google/cloud/datastore/aggregate_query"
+require "google/cloud/datastore/filter"
 
 module Google
   module Cloud
@@ -96,6 +97,27 @@ module Google
         ##
         # Add a property filter to the query.
         #
+        # @overload and(name, operator, value)
+        #   Joins the filter with a property filter
+        #   @param name [String] The property to filter by.
+        #   @param operator [String] The operator to filter by. Defaults to nil.
+        #   @param value [Object] The value to compare the property to. Defaults to nil.
+        #       Possible values are:
+        #         - Integer
+        #         - Float/BigDecimal
+        #         - String
+        #         - Boolean
+        #         - Array
+        #         - Date/Time
+        #         - StringIO
+        #         - Google::Cloud::Datastore::Key
+        #         - Google::Cloud::Datastore::Entity
+        #         - nil
+        #
+        # @overload and(filter)
+        #   Joins the filter with a Filter object
+        #   @param filter [Filter]
+        #
         # @example
         #   require "google/cloud/datastore"
         #
@@ -119,6 +141,34 @@ module Google
         #
         #   tasks = datastore.run query
         #
+        # @example Add a composite "AND" filter:
+        #   require "google/cloud/datastore"
+        #
+        #   datastore = Google::Cloud::Datastore.new
+        #
+        #   filter = Google::Cloud::Filter.new("done", "=", false)
+        #                                 .and("priority", ">=", 4)
+        #
+        #   query = Google::Cloud::Datastore::Query.new
+        #   query.kind("Task")
+        #        .where(filter)
+        #
+        #   tasks = datastore.run query
+        #
+        # @example Add a composite "OR" filter:
+        #   require "google/cloud/datastore"
+        #
+        #   datastore = Google::Cloud::Datastore.new
+        #
+        #   filter = Google::Cloud::Filter.new("done", "=", false)
+        #                                 .or("priority", ">=", 4)
+        #
+        #   query = Google::Cloud::Datastore::Query.new
+        #   query.kind("Task")
+        #        .where(filter)
+        #
+        #   tasks = datastore.run query
+        #
         # @example Add an inequality filter on a **single** property only:
         #   require "google/cloud/datastore"
         #
@@ -177,22 +227,18 @@ module Google
         #
         #   tasks = datastore.run query
         #
-        def where name, operator, value
+        def where name_or_filter, operator = nil, value = nil
           @grpc.filter ||= Google::Cloud::Datastore::V1::Filter.new(
             composite_filter: Google::Cloud::Datastore::V1::CompositeFilter.new(
               op: :AND
             )
           )
-          @grpc.filter.composite_filter.filters << \
-            Google::Cloud::Datastore::V1::Filter.new(
-              property_filter: Google::Cloud::Datastore::V1::PropertyFilter.new(
-                property: Google::Cloud::Datastore::V1::PropertyReference.new(
-                  name: name
-                ),
-                op: Convert.to_prop_filter_op(operator),
-                value: Convert.to_value(value)
-              )
-            )
+          if name_or_filter.is_a? Google::Cloud::Datastore::Filter
+            @grpc.filter.composite_filter.filters << name_or_filter.to_grpc
+          else
+            @grpc.filter.composite_filter.filters << \
+              Google::Cloud::Datastore::Filter.new(name_or_filter, operator, value).to_grpc
+          end
 
           self
         end

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

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-datastore
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.7.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-13 00:00:00.000000000 Z
+date: 2023-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -210,6 +210,7 @@ files:
 - lib/google/cloud/datastore/dataset/query_results.rb
 - lib/google/cloud/datastore/entity.rb
 - lib/google/cloud/datastore/errors.rb
+- lib/google/cloud/datastore/filter.rb
 - lib/google/cloud/datastore/gql_query.rb
 - lib/google/cloud/datastore/key.rb
 - lib/google/cloud/datastore/properties.rb