couchbase 3.5.1 → 3.5.2

data/lib/couchbase/search_options.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #  Copyright 2020-2021 Couchbase, Inc.
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
@@ -92,8 +94,8 @@ module Couchbase
     # @yieldparam [MatchQuery] query
     #
     # @return [MatchQuery]
-    def self.match(match, &block)
-      MatchQuery.new(match, &block)
+    def self.match(match, &)
+      MatchQuery.new(match, &)
     end
 
     # A match query analyzes the input text and uses that analyzed text to query the index.
@@ -143,8 +145,8 @@ module Couchbase
     # @yieldparam [MatchPhraseQuery] query
     #
     # @return [MatchPhraseQuery]
-    def self.match_phrase(match_phrase, &block)
-      MatchPhraseQuery.new(match_phrase, &block)
+    def self.match_phrase(match_phrase, &)
+      MatchPhraseQuery.new(match_phrase, &)
     end
 
     # The input text is analyzed and a phrase query is built with the terms resulting from the analysis.
@@ -183,8 +185,8 @@ module Couchbase
     # @yieldparam [RegexpQuery] query
     #
     # @return [RegexpQuery]
-    def self.regexp(regexp, &block)
-      RegexpQuery.new(regexp, &block)
+    def self.regexp(regexp, &)
+      RegexpQuery.new(regexp, &)
     end
 
     # Finds documents containing terms that match the specified regular expression.
@@ -219,8 +221,8 @@ module Couchbase
     # @yieldparam [QueryStringQuery] query
     #
     # @return [QueryStringQuery]
-    def self.query_string(query_string, &block)
-      QueryStringQuery.new(query_string, &block)
+    def self.query_string(query_string, &)
+      QueryStringQuery.new(query_string, &)
     end
 
     # The query string query allows humans to describe complex queries using a simple syntax.
@@ -251,8 +253,8 @@ module Couchbase
     # @yieldparam [WildcardQuery] query
     #
     # @return [WildcardQuery]
-    def self.wildcard(wildcard, &block)
-      WildcardQuery.new(wildcard, &block)
+    def self.wildcard(wildcard, &)
+      WildcardQuery.new(wildcard, &)
     end
 
     # Interprets * and ? wildcards as found in a lot of applications, for an easy implementation of such a search feature.
@@ -354,8 +356,8 @@ module Couchbase
     # @yieldparam [DateRangeQuery] query
     #
     # @return [DateRangeQuery]
-    def self.date_range(&block)
-      DateRangeQuery.new(&block)
+    def self.date_range(&)
+      DateRangeQuery.new(&)
     end
 
     # The date range query finds documents containing a date value in the specified field within the specified range.
@@ -402,11 +404,11 @@ module Couchbase
         yield self if block_given?
       end
 
-      DATE_FORMAT_RFC3339 = "%Y-%m-%dT%H:%M:%S%:z".freeze
+      DATE_FORMAT_RFC3339 = "%Y-%m-%dT%H:%M:%S%:z"
 
       # @return [Hash<Symbol, #to_json>]
       def to_h
-        raise ArgumentError, "either start_time or end_time must be set for DateRangeQuery" if @start_time.nil? && @end_time.nil?
+        raise Error::InvalidArgument, "either start_time or end_time must be set for DateRangeQuery" if @start_time.nil? && @end_time.nil?
 
         data = {}
         data[:boost] = boost if boost
@@ -437,8 +439,8 @@ module Couchbase
     # @yieldparam [NumericRangeQuery] query
     #
     # @return [NumericRangeQuery]
-    def self.numeric_range(&block)
-      NumericRangeQuery.new(&block)
+    def self.numeric_range(&)
+      NumericRangeQuery.new(&)
     end
 
     # The numeric range query finds documents containing a numeric value in the specified field within the specified range.
@@ -483,7 +485,7 @@ module Couchbase
 
       # @return [Hash<Symbol, #to_json>]
       def to_h
-        raise ArgumentError, "either min or max must be set for NumericRangeQuery" if @min.nil? && @max.nil?
+        raise Error::InvalidArgument, "either min or max must be set for NumericRangeQuery" if @min.nil? && @max.nil?
 
         data = {}
         data[:boost] = boost if boost
@@ -505,8 +507,8 @@ module Couchbase
     # @yieldparam [TermRangeQuery] query
     #
     # @return [TermRangeQuery]
-    def self.term_range(&block)
-      TermRangeQuery.new(&block)
+    def self.term_range(&)
+      TermRangeQuery.new(&)
     end
 
     # The term range query finds documents containing a string value in the specified field within the specified range.
@@ -551,7 +553,7 @@ module Couchbase
 
       # @return [Hash<Symbol, #to_json>]
       def to_h
-        raise ArgumentError, "either min or max must be set for TermRangeQuery" if @min.nil? && @max.nil?
+        raise Error::InvalidArgument, "either min or max must be set for TermRangeQuery" if @min.nil? && @max.nil?
 
         data = {}
         data[:boost] = boost if boost
@@ -577,8 +579,8 @@ module Couchbase
     # @param [String] distance how big is area (number with units)
     #
     # @return [GeoDistanceQuery]
-    def self.geo_distance(longitude, latitude, distance, &block)
-      GeoDistanceQuery.new(longitude, latitude, distance, &block)
+    def self.geo_distance(longitude, latitude, distance, &)
+      GeoDistanceQuery.new(longitude, latitude, distance, &)
     end
 
     # Finds `geopoint` indexed matches around a point with the given distance.
@@ -623,8 +625,8 @@ module Couchbase
     # @param [Float] bottom_right_latitude
     #
     # @return [GeoBoundingBoxQuery]
-    def self.geo_bounding_box(top_left_longitude, top_left_latitude, bottom_right_longitude, bottom_right_latitude, &block)
-      GeoBoundingBoxQuery.new(top_left_longitude, top_left_latitude, bottom_right_longitude, bottom_right_latitude, &block)
+    def self.geo_bounding_box(top_left_longitude, top_left_latitude, bottom_right_longitude, bottom_right_latitude, &)
+      GeoBoundingBoxQuery.new(top_left_longitude, top_left_latitude, bottom_right_longitude, bottom_right_latitude, &)
     end
 
     # Finds `geopoint` indexed matches in a given bounding box.
@@ -688,8 +690,8 @@ module Couchbase
     # @return [GeoPolygonQuery]
     #
     # @!macro uncommitted
-    def self.geo_polygon(coordinates, &block)
-      GeoPolygonQuery.new(coordinates, &block)
+    def self.geo_polygon(coordinates, &)
+      GeoPolygonQuery.new(coordinates, &)
     end
 
     # A search query which allows to match inside a geo polygon.
@@ -754,7 +756,7 @@ module Couchbase
 
       # @return [Hash<Symbol, #to_json>]
       def to_h
-        raise ArgumentError, "compound conjunction query must have sub-queries" if @queries.nil? || @queries.empty?
+        raise Error::InvalidArgument, "compound conjunction query must have sub-queries" if @queries.nil? || @queries.empty?
 
         data = {:conjuncts => @queries.uniq.map(&:to_h)}
         data[:boost] = boost if boost
@@ -799,11 +801,11 @@ module Couchbase
 
       # @return [Hash<Symbol, #to_json>]
       def to_h
-        raise ArgumentError, "compound disjunction query must have sub-queries" if @queries.nil? || @queries.empty?
+        raise Error::InvalidArgument, "compound disjunction query must have sub-queries" if @queries.nil? || @queries.empty?
 
         data = {:disjuncts => @queries.uniq.map(&:to_h)}
         if min
-          raise ArgumentError, "disjunction query has fewer sub-queries than configured minimum" if @queries.size < min
+          raise Error::InvalidArgument, "disjunction query has fewer sub-queries than configured minimum" if @queries.size < min
 
           data[:min] = min
         end
@@ -817,8 +819,8 @@ module Couchbase
     # @yieldparam [BooleanQuery] query
     #
     # @return [BooleanQuery]
-    def self.booleans(&block)
-      BooleanQuery.new(&block)
+    def self.booleans(&)
+      BooleanQuery.new(&)
     end
 
     # The boolean query is a useful combination of conjunction and disjunction queries.
@@ -828,7 +830,7 @@ module Couchbase
 
       # @yieldparam [BooleanQuery] self
       def initialize
-        super()
+        super
         @must = ConjunctionQuery.new
         @must_not = DisjunctionQuery.new
         @should = DisjunctionQuery.new
@@ -861,7 +863,10 @@ module Couchbase
 
       # @return [Hash<Symbol, #to_json>]
       def to_h
-        raise ArgumentError, "BooleanQuery must have at least one non-empty sub-query" if @must.empty? && @must_not.empty? && @should.empty?
+        if @must.empty? && @must_not.empty? && @should.empty?
+          raise Error::InvalidArgument,
+                "BooleanQuery must have at least one non-empty sub-query"
+        end
 
         data = {}
         data[:must] = @must.to_h unless @must.empty?
@@ -878,8 +883,8 @@ module Couchbase
     # @param [String] term
     #
     # @return [TermQuery]
-    def self.term(term, &block)
-      TermQuery.new(term, &block)
+    def self.term(term, &)
+      TermQuery.new(term, &)
     end
 
     # A query that looks for **exact** matches of the term in the index (no analyzer, no stemming). Useful to check what the actual
@@ -925,8 +930,8 @@ module Couchbase
     # @param [String] prefix
     #
     # @return [PrefixQuery]
-    def self.prefix(prefix, &block)
-      PrefixQuery.new(prefix, &block)
+    def self.prefix(prefix, &)
+      PrefixQuery.new(prefix, &)
     end
 
     # The prefix query finds documents containing terms that start with the provided prefix. Usual better alternative is `MatchQuery`.
@@ -999,15 +1004,15 @@ module Couchbase
     # @yieldparam [MatchAllQuery] query
     #
     # @return [MatchAllQuery]
-    def self.match_all(&block)
-      MatchAllQuery.new(&block)
+    def self.match_all(&)
+      MatchAllQuery.new(&)
     end
 
     # A query that matches all indexed documents.
     class MatchAllQuery < SearchQuery
       # @yieldparam [MatchAllQuery] self
       def initialize
-        super()
+        super
         yield self if block_given?
       end
 
@@ -1022,15 +1027,15 @@ module Couchbase
     # @yieldparam [MatchNoneQuery] query
     #
     # @return [MatchNoneQuery]
-    def self.match_none(&block)
-      MatchNoneQuery.new(&block)
+    def self.match_none(&)
+      MatchNoneQuery.new(&)
     end
 
     # A query that matches nothing.
     class MatchNoneQuery < SearchQuery
       # @yieldparam [MatchNoneQuery] self
       def initialize
-        super()
+        super
         yield self if block_given?
       end
 
@@ -1054,6 +1059,8 @@ module Couchbase
 
     # @api private
     def to_backend
+      raise Error::InvalidArgument, "Vector search requires at least one vector query" if @vector_queries.empty?
+
       {vector_queries: @vector_queries.map(&:to_h).to_json}.merge(@options.to_backend)
     end
   end
@@ -1068,13 +1075,23 @@ module Couchbase
 
     # Constructs a +VectorQuery+ instance
     #
-    # @param [String] vector_field_name the document field that contains the vector.
-    # @param [Array<Float>] vector_query the vector query to run.
+    # @overload initialize(vector_field_name, vector_query)
+    #   @param [String] vector_field_name the document field that contains the vector.
+    #   @param [Array<Float>] vector_query the vector query.
     #
-    # @yieldparam [MatchPhraseQuery] self
+    # @overload initialize(vector_field_name, base64_vector_query)
+    #   @param [String] vector_field_name the document field that contains the vector.
+    #   @param [String] base64_vector_query the vector query represented as a base64-encoded sequence of little-endian IEEE 754 floats.
+    #
+    # @yieldparam [VectorQuery] self
     def initialize(vector_field_name, vector_query)
       @vector_field_name = vector_field_name
-      @vector_query = vector_query
+
+      if vector_query.respond_to?(:to_str)
+        @base64_vector_query = vector_query.to_str
+      else
+        @vector_query = vector_query
+      end
 
       yield self if block_given?
     end
@@ -1086,12 +1103,23 @@ module Couchbase
               "Number of candidates must be at least 1, #{num_candidates} given"
       end
 
-      {
+      h = {
         field: @vector_field_name,
         vector: @vector_query,
+        vector_base64: @base64_vector_query,
         k: num_candidates || 3,
         boost: boost,
       }.compact
+
+      raise Error::InvalidArgument, "The vector cannot be nil" if !h.include?(:vector) && !h.include?(:vector_base64)
+      raise Error::InvalidArgument, "The vector query cannot be an empty array" if h.include?(:vector) && h[:vector].empty?
+
+      if h.include?(:vector_base64) && h[:vector_base64].empty?
+        raise Error::InvalidArgument,
+              "The base64-encoded vector query cannot be empty"
+      end
+
+      h
     end
 
     # @api private
@@ -1103,21 +1131,21 @@ module Couchbase
   class SearchSort
     # @yieldparam [SearchSortScore]
     # @return [SearchSortScore]
-    def self.score(&block)
-      SearchSortScore.new(&block)
+    def self.score(&)
+      SearchSortScore.new(&)
     end
 
     # @yieldparam [SearchSortId]
     # @return [SearchSortScore]
-    def self.id(&block)
-      SearchSortId.new(&block)
+    def self.id(&)
+      SearchSortId.new(&)
     end
 
     # @param [String] name field name
     # @yieldparam [SearchSortField]
     # @return [SearchSortField]
-    def self.field(name, &block)
-      SearchSortField.new(name, &block)
+    def self.field(name, &)
+      SearchSortField.new(name, &)
     end
 
     # @param [String] name field name
@@ -1125,8 +1153,8 @@ module Couchbase
     # @param [Float] latitude
     # @yieldparam [SearchSortField]
     # @return [SearchSortGeoDistance]
-    def self.geo_distance(name, longitude, latitude, &block)
-      SearchSortGeoDistance.new(name, longitude, latitude, &block)
+    def self.geo_distance(name, longitude, latitude, &)
+      SearchSortGeoDistance.new(name, longitude, latitude, &)
     end
 
     class SearchSortScore < SearchSort
@@ -1229,20 +1257,20 @@ module Couchbase
   class SearchFacet
     # @param [String] field_name
     # @return [SearchFacetTerm]
-    def self.term(field_name, &block)
-      SearchFacetTerm.new(field_name, &block)
+    def self.term(field_name, &)
+      SearchFacetTerm.new(field_name, &)
     end
 
     # @param [String] field_name
     # @return [SearchFacetNumericRange]
-    def self.numeric_range(field_name, &block)
-      SearchFacetNumericRange.new(field_name, &block)
+    def self.numeric_range(field_name, &)
+      SearchFacetNumericRange.new(field_name, &)
     end
 
     # @param [String] field_name
     # @return [SearchFacetDateRange]
-    def self.date_range(field_name, &block)
-      SearchFacetDateRange.new(field_name, &block)
+    def self.date_range(field_name, &)
+      SearchFacetDateRange.new(field_name, &)
     end
 
     class SearchFacetTerm
@@ -1306,7 +1334,7 @@ module Couchbase
         yield self if block_given?
       end
 
-      DATE_FORMAT_RFC3339 = "%Y-%m-%dT%H:%M:%S%:z".freeze
+      DATE_FORMAT_RFC3339 = "%Y-%m-%dT%H:%M:%S%:z"
 
       # @param [String] name the name of the range
       # @param [Time, String, nil] start_time lower bound of the range (pass +nil+ if there is no lower bound)

data/lib/couchbase/subdoc.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #  Copyright 2020-2021 Couchbase, Inc.
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
@@ -245,9 +247,9 @@ module Couchbase
       @expand_macros
     end
 
-    CAS = "${Mutation.CAS}".freeze
-    SEQ_NO = "${Mutation.seqno}".freeze
-    VALUE_CRC32C = "${Mutation.value_crc32c}".freeze
+    CAS = "${Mutation.CAS}"
+    SEQ_NO = "${Mutation.seqno}"
+    VALUE_CRC32C = "${Mutation.value_crc32c}"
 
     attr_reader :type
     attr_reader :path

data/lib/couchbase/transcoder_flags.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #  Copyright 2023. Couchbase, Inc.
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");

data/lib/couchbase/utils/generic_logger_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #   Copyright 2021 Couchbase, Inc.
 #  Copyright 2020-Present Couchbase, Inc.
 #
@@ -18,7 +20,7 @@ require "time"
 module Couchbase
   module Utils
     class GenericLoggerAdapter
-      DATETIME_FORMAT = "%Y-%m-%dT%H:%M:%S.%6N".freeze
+      DATETIME_FORMAT = "%Y-%m-%dT%H:%M:%S.%6N"
 
       def initialize(logger, verbose: false)
         @logger = logger

data/lib/couchbase/utils/stdlib_logger_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #   Copyright 2021 Couchbase, Inc.
 #  Copyright 2020-Present Couchbase, Inc.
 #

data/lib/couchbase/utils/time.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #  Copyright 2020-2021 Couchbase, Inc.
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
@@ -59,7 +61,7 @@ module Couchbase
         return number_or_duration if number_or_duration.class == Integer # rubocop:disable Style/ClassEqualityComparison avoid overrides of #is_a?, #kind_of?
 
         if number_or_duration.respond_to?(:in_milliseconds)
-          number_or_duration.public_send(:in_milliseconds)
+          number_or_duration.in_milliseconds
         else
           number_or_duration
         end.to_i

data/lib/couchbase/utils.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #  Copyright 2020-2021 Couchbase, Inc.
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");

data/lib/couchbase/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #  Copyright 2020-2021 Couchbase, Inc.
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
@@ -19,5 +21,5 @@ module Couchbase
   #   $ ruby -rcouchbase -e 'pp Couchbase::VERSION'
   #   {:sdk=>"3.4.0", :ruby_abi=>"3.1.0", :revision=>"416fe68e6029ec8a4c40611cf6e6b30d3b90d20f"}
   VERSION = {} unless defined?(VERSION) # rubocop:disable Style/MutableConstant
-  VERSION.update(:sdk => "3.5.1".freeze)
+  VERSION.update(:sdk => "3.5.2")
 end

data/lib/couchbase/view_options.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #  Copyright 2020-2021 Couchbase, Inc.
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");

data/lib/couchbase.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #  Copyright 2020-2021 Couchbase, Inc.
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");

data/lib/rails/generators/couchbase/config/config_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #  Copyright 2020-2021 Couchbase, Inc.
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");