google-cloud-firestore 2.4.1 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3947e279213a82502325fd1f9245f72c9b5d3fa837907608f6bdd62bff31e69f
-  data.tar.gz: 849fc8dc2f763b24334d4accdc2ee4196059c429d273f3f661bf50d81a6d9774
+  metadata.gz: 9faa52fed532effb0c8cb260b4159cfed65ba53a790f1c2451f5a610f46fa551
+  data.tar.gz: 8e2cbe9b830a1e4c46b49080cfa717a9e6e9f8901848aea6a905edd1d3234544
 SHA512:
-  metadata.gz: 8d2a6c39cc4b321a2561b5ae50928eaec7a3acfafe5fec62a7383d5c3dc77c60ba96f81c2c027bcfe46be6f8ab02c0f76f93afd0dd5ab5bb7fdea9e141a33fe4
-  data.tar.gz: 70b462d91bd613ee0a5c333653dc096c28878d4bf28eacc6282c4edf57123985eeec8eee4d98af24aba334ea824e2e37d2add104aa8e32c26c7668c7dc62df4f
+  metadata.gz: 94c1832275adb689e4394d03fd724dd39240eedb9fbfad132f4217ea97b1d6076cc0b8e0b846eec2a1afdf1180ffd2e981c5d5ecef12e6aaf11a04fe52460b44
+  data.tar.gz: c9b0c729751b0ed24ff39be1e56905da26bec6af30410e1112325482b07b888f3f1c07e60c5b1bc7bd8e90b58a710f0cb31e4a0d6181179c69d5b23267d5904f

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Release History
 
+### 2.5.0 / 2021-03-10
+
+#### Features
+
+* Drop support for Ruby 2.4 and add support for Ruby 3.0
+
 ### 2.4.1 / 2021-01-06
 
 #### Bug Fixes

data/CONTRIBUTING.md

@@ -24,7 +24,7 @@ be able to accept your pull requests.
 In order to use the google-cloud-firestore console and run the project's tests,
 there is a small amount of setup:
 
-1. Install Ruby. google-cloud-firestore requires Ruby 2.4+. You may choose to
+1. Install Ruby. google-cloud-firestore requires Ruby 2.5+. You may choose to
    manage your Ruby and gem installations with [RVM](https://rvm.io/),
    [rbenv](https://github.com/rbenv/rbenv), or
    [chruby](https://github.com/postmodern/chruby).

data/LOGGING.md

@@ -3,7 +3,7 @@
 To enable logging for this library, set the logger for the underlying
 [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library. The logger
 that you set may be a Ruby stdlib
-[`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as
+[`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as
 shown below, or a
 [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
 that will write logs to [Stackdriver

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

@@ -322,8 +322,7 @@ module Google
 
           doc_path = coalesce_doc_path_argument doc
 
-          @writes << Convert.write_for_update(doc_path, data,
-                                              update_time: update_time)
+          @writes << Convert.write_for_update(doc_path, data, update_time: update_time)
 
           nil
         end

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

@@ -100,11 +100,11 @@ module Google
         #     puts col.collection_id
         #   end
         #
-        def cols
+        def cols &block
           ensure_service!
           grpc = service.list_collections "#{path}/documents"
           cols_enum = CollectionReferenceList.from_grpc(grpc, self, "#{path}/documents").all
-          cols_enum.each { |c| yield c } if block_given?
+          cols_enum.each(&block) if block_given?
           cols_enum
         end
         alias collections cols
@@ -256,7 +256,7 @@ module Google
           ensure_service!
 
           unless block_given?
-            return enum_for :get_all, docs, field_mask: field_mask
+            return enum_for :get_all, *docs, field_mask: field_mask
           end
 
           doc_paths = Array(docs).flatten.map do |doc_path|
@@ -634,9 +634,9 @@ module Google
             commit_return = transaction.commit
             # Conditional return value, depending on truthy commit_response
             commit_response ? commit_return : transaction_return
-          rescue Google::Cloud::UnavailableError => err
+          rescue Google::Cloud::UnavailableError => e
             # Re-raise if retried more than the max
-            raise err if backoff[:current] > backoff[:max]
+            raise e if backoff[:current] > backoff[:max]
 
             # Sleep with incremental backoff before restarting
             sleep backoff[:delay]
@@ -649,18 +649,18 @@ module Google
             transaction = Transaction.from_client \
               self, previous_transaction: transaction.transaction_id
             retry
-          rescue Google::Cloud::InvalidArgumentError => err
+          rescue Google::Cloud::InvalidArgumentError => e
             # Return if a previous call was retried but ultimately succeeded
-            return nil if backoff[:current] > 0
+            return nil if backoff[:current].positive?
 
             # Re-raise error.
-            raise err
-          rescue StandardError => err
+            raise e
+          rescue StandardError => e
             # Rollback transaction when handling unexpected error
             transaction.rollback rescue nil
 
             # Re-raise error.
-            raise err
+            raise e
           end
         end
 

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

@@ -90,17 +90,17 @@ module Google
         #     collection_reference.collection_id
         #   end
         #
-        def all request_limit: nil
+        def all request_limit: nil, &block
           request_limit = request_limit.to_i if request_limit
           unless block_given?
             return enum_for :all, request_limit: request_limit
           end
           results = self
           loop do
-            results.each { |r| yield r }
+            results.each(&block)
             if request_limit
               request_limit -= 1
-              break if request_limit < 0
+              break if request_limit.negative?
             end
             break unless results.next?
             results = results.next

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

@@ -30,7 +30,6 @@ module Google
         # rubocop:disable Metrics/MethodLength
         # rubocop:disable Metrics/ModuleLength
         # rubocop:disable Metrics/PerceivedComplexity
-        # rubocop:disable Style/CaseEquality
         module ClassMethods
           def time_to_timestamp time
             return nil if time.nil?
@@ -263,10 +262,8 @@ module Google
             # Restore delete paths
             field_paths += delete_field_paths_and_values.keys
 
-            if data.empty? && !allow_empty
-              if field_paths_and_values.empty? && delete_field_paths_and_values.empty?
-                raise ArgumentError, "data required for set with merge"
-              end
+            if data.empty? && !allow_empty && field_paths_and_values.empty? && delete_field_paths_and_values.empty?
+              raise ArgumentError, "data required for set with merge"
             end
 
             doc = Google::Cloud::Firestore::V1::Document.new(
@@ -374,12 +371,13 @@ module Google
           def field_value_nested? obj, field_value_type = nil
             return obj if obj.is_a?(FieldValue) && (field_value_type.nil? || obj.type == field_value_type)
 
-            if obj.is_a? Array
+            case obj
+            when Array
               obj.each do |o|
                 val = field_value_nested? o, field_value_type
                 return val if val
               end
-            elsif obj.is_a? Hash
+            when Hash
               obj.each do |_k, v|
                 val = field_value_nested? v, field_value_type
                 return val if val
@@ -531,8 +529,8 @@ module Google
           end
 
           START_FIELD_PATH_CHARS = /\A[a-zA-Z_]/.freeze
-          INVALID_FIELD_PATH_CHARS = %r{[\~\*/\[\]]}.freeze
-          ESCAPED_FIELD_PATH = /\A\`(.*)\`\z/.freeze
+          INVALID_FIELD_PATH_CHARS = %r{[~*/\[\]]}.freeze
+          ESCAPED_FIELD_PATH = /\A`(.*)`\z/.freeze
 
           def build_hash_from_field_paths_and_values pairs
             pairs.each do |field_path, _value|
@@ -567,32 +565,33 @@ module Google
           end
 
           def to_field_transform field_path, field_value
-            if field_value.type == :server_time
+            case field_value.type
+            when :server_time
               Google::Cloud::Firestore::V1::DocumentTransform::FieldTransform.new(
                 field_path:          field_path.formatted_string,
                 set_to_server_value: :REQUEST_TIME
               )
-            elsif field_value.type == :array_union
+            when :array_union
               Google::Cloud::Firestore::V1::DocumentTransform::FieldTransform.new(
                 field_path:              field_path.formatted_string,
                 append_missing_elements: raw_to_value(Array(field_value.value)).array_value
               )
-            elsif field_value.type == :array_delete
+            when :array_delete
               Google::Cloud::Firestore::V1::DocumentTransform::FieldTransform.new(
                 field_path:            field_path.formatted_string,
                 remove_all_from_array: raw_to_value(Array(field_value.value)).array_value
               )
-            elsif field_value.type == :increment
+            when :increment
               Google::Cloud::Firestore::V1::DocumentTransform::FieldTransform.new(
                 field_path: field_path.formatted_string,
                 increment:  raw_to_value(field_value.value)
               )
-            elsif field_value.type == :maximum
+            when :maximum
               Google::Cloud::Firestore::V1::DocumentTransform::FieldTransform.new(
                 field_path: field_path.formatted_string,
                 maximum:    raw_to_value(field_value.value)
               )
-            elsif field_value.type == :minimum
+            when :minimum
               Google::Cloud::Firestore::V1::DocumentTransform::FieldTransform.new(
                 field_path: field_path.formatted_string,
                 minimum:    raw_to_value(field_value.value)
@@ -611,7 +610,6 @@ module Google
       # rubocop:enable Metrics/MethodLength
       # rubocop:enable Metrics/ModuleLength
       # rubocop:enable Metrics/PerceivedComplexity
-      # rubocop:enable Style/CaseEquality
     end
   end
 end

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

@@ -90,11 +90,11 @@ module Google
         #     puts col.collection_id
         #   end
         #
-        def cols
+        def cols &block
           ensure_service!
           grpc = service.list_collections path
           cols_enum = CollectionReferenceList.from_grpc(grpc, client, path).all
-          cols_enum.each { |c| yield c } if block_given?
+          cols_enum.each(&block) if block_given?
           cols_enum
         end
         alias collections cols

data/lib/google/cloud/firestore/document_reference/list.rb

@@ -86,8 +86,7 @@ module Google
           def next
             return nil unless next?
             ensure_client!
-            options = { token: token, max: @max }
-            grpc = @client.service.list_documents @parent, @collection_id, options
+            grpc = @client.service.list_documents @parent, @collection_id, token: token, max: @max
             self.class.from_grpc grpc, @client, @parent, @collection_id, @max
           end
 
@@ -143,17 +142,17 @@ module Google
           #     puts doc_ref.document_id
           #   end
           #
-          def all request_limit: nil
+          def all request_limit: nil, &block
             request_limit = request_limit.to_i if request_limit
             unless block_given?
               return enum_for :all, request_limit: request_limit
             end
             results = self
             loop do
-              results.each { |r| yield r }
+              results.each(&block)
               if request_limit
                 request_limit -= 1
-                break if request_limit < 0
+                break if request_limit.negative?
               end
               break unless results.next?
               results = results.next

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

@@ -210,14 +210,14 @@ module Google
         protected
 
         START_FIELD_PATH_CHARS = /\A[a-zA-Z_]/.freeze
-        INVALID_FIELD_PATH_CHARS = %r{[\~\*\/\[\]]}.freeze
+        INVALID_FIELD_PATH_CHARS = %r{[~*/\[\]]}.freeze
 
         def escape_field_for_path field
           field = String field
 
           if INVALID_FIELD_PATH_CHARS.match(field) ||
              field["."] || field["`"] || field["\\"]
-            escaped_field = field.gsub(/[\`\\]/, "`" => "\\\`", "\\" => "\\\\")
+            escaped_field = field.gsub(/[`\\]/, "`" => "\\\`", "\\" => "\\\\")
             return "`#{escaped_field}`"
           end
 

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

@@ -1010,11 +1010,11 @@ module Google
         }.freeze
         ##
         # @private
-        INEQUALITY_FILTERS = %i[
-          LESS_THAN
-          LESS_THAN_OR_EQUAL
-          GREATER_THAN
-          GREATER_THAN_OR_EQUAL
+        INEQUALITY_FILTERS = [
+          :LESS_THAN,
+          :LESS_THAN_OR_EQUAL,
+          :GREATER_THAN,
+          :GREATER_THAN_OR_EQUAL
         ].freeze
 
         def value_nil? value
@@ -1031,15 +1031,16 @@ module Google
           value_nil?(value) || value_nan?(value)
         end
 
-        def filter name, op, value
+        def filter name, op_key, value
           field = StructuredQuery::FieldReference.new field_path: name.to_s
-          operator = FILTER_OPS[op.to_s.downcase]
-          raise ArgumentError, "unknown operator #{op}" if operator.nil?
+          operator = FILTER_OPS[op_key.to_s.downcase]
+          raise ArgumentError, "unknown operator #{op_key}" if operator.nil?
 
           if value_unary? value
-            operator = if operator == :EQUAL
+            operator = case operator
+                       when :EQUAL
                          value_nan?(value) ? :IS_NAN : :IS_NULL
-                       elsif operator == :NOT_EQUAL
+                       when :NOT_EQUAL
                          value_nan?(value) ? :IS_NOT_NAN : :IS_NOT_NULL
                        else
                          raise ArgumentError, "can only perform '==' and '!=' comparisons on #{value} values"

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

@@ -26,7 +26,10 @@ module Google
       # @private Represents the gRPC Firestore service, including all the API
       # methods.
       class Service
-        attr_accessor :project, :credentials, :timeout, :host
+        attr_accessor :project
+        attr_accessor :credentials
+        attr_accessor :timeout
+        attr_accessor :host
 
         ##
         # Creates a new Service instance.

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

@@ -131,7 +131,7 @@ module Google
           ensure_service!
 
           unless block_given?
-            return enum_for :get_all, docs, field_mask: field_mask
+            return enum_for :get_all, *docs, field_mask: field_mask
           end
 
           doc_paths = Array(docs).flatten.map do |doc_path|

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

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

data/lib/google/cloud/firestore/watch/inventory.rb

@@ -33,7 +33,8 @@ module Google
         # make inserting and removing objects much more efficent.
         class Inventory
           attr_accessor :current
-          attr_reader :resume_token, :read_time
+          attr_reader :resume_token
+          attr_reader :read_time
 
           def initialize client, query
             @client = client
@@ -155,24 +156,24 @@ module Google
 
           protected
 
-          def query_comparison_proc a, b
+          def query_comparison_proc left, right
             # TODO: Remove this when done benchmarking
             @comp_proc_counter += 1
 
-            return Order.compare_field_values a.ref, b.ref if @query.nil?
+            return Order.compare_field_values left.ref, right.ref if @query.nil?
 
             @directions ||= @query.query.order_by.map(&:direction)
 
-            a_comps = a.query_comparisons_for @query.query
-            b_comps = b.query_comparisons_for @query.query
-            @directions.zip(a_comps, b_comps).each do |dir, a_comp, b_comp|
-              comp = a_comp <=> b_comp
+            left_comps = left.query_comparisons_for @query.query
+            right_comps = right.query_comparisons_for @query.query
+            @directions.zip(left_comps, right_comps).each do |dir, left_comp, right_comp|
+              comp = left_comp <=> right_comp
               comp = 0 - comp if dir == :DESCENDING
               return comp unless comp.zero?
             end
 
             # Compare paths when everything else is equal
-            ref_comp = Order.compare_field_values a.ref, b.ref
+            ref_comp = Order.compare_field_values left.ref, right.ref
             ref_comp = 0 - ref_comp if @directions.last == :DESCENDING
             ref_comp
           end

data/lib/google/cloud/firestore/watch/listener.rb

@@ -83,7 +83,7 @@ module Google
           def stop
             synchronize do
               @stopped = true
-              @request_queue.push self if @request_queue
+              @request_queue&.push self
             end
           end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-firestore
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 2.5.0
 platform: ruby
 authors:
 - Google Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-07 00:00:00.000000000 Z
+date: 2021-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.24.0
+        version: 1.25.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.24.0
+        version: 1.25.1
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -262,14 +262,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.13
 signing_key: 
 specification_version: 4
 summary: API Client library for Google Cloud Firestore API