couchbase 3.0.1 → 3.0.2

data/lib/couchbase/collection_options.rb

@@ -15,79 +15,11 @@
 require "rubygems/deprecate"
 
 require "couchbase/json_transcoder"
-require "couchbase/common_options"
 require "couchbase/subdoc"
 require "couchbase/mutation_state"
 
 module Couchbase
   class Collection
-    class GetOptions < CommonOptions
-      # @return [Boolean] if the expiration should also fetched with get
-      attr_accessor :with_expiry
-
-      # @return [JsonTranscoder] transcoder used for decoding
-      attr_accessor :transcoder
-
-      # @yieldparam [GetOptions] self
-      def initialize
-        super
-        @transcoder = JsonTranscoder.new
-        @preserve_array_indexes = false
-        @with_expiry = nil
-        @projections = nil
-        yield self if block_given?
-      end
-
-      # Allows to specify a custom list paths to fetch from the document instead of the whole.
-      #
-      # Note that a maximum of 16 individual paths can be projected at a time due to a server limitation. If you need
-      # more than that, think about fetching less-generic paths or the full document straight away.
-      #
-      # @param [String, Array<String>] paths a path that should be loaded if present.
-      def project(*paths)
-        @projections ||= []
-        @projections |= paths.flatten # union with current projections
-      end
-
-      # @api private
-      # @return [Boolean] whether to use sparse arrays (default false)
-      attr_accessor :preserve_array_indexes
-
-      # @api private
-      # @return [Array<String>] list of paths to project
-      attr_accessor :projections
-
-      # @api private
-      # @return [Boolean]
-      def need_projected_get?
-        @with_expiry || !@projections.nil?
-      end
-    end
-
-    class GetAndLockOptions < CommonOptions
-      # @return [JsonTranscoder] transcoder used for decoding
-      attr_accessor :transcoder
-
-      # @yieldparam [GetAndLockOptions] self
-      def initialize
-        super
-        @transcoder = JsonTranscoder.new
-        yield self if block_given?
-      end
-    end
-
-    class GetAndTouchOptions < CommonOptions
-      # @return [JsonTranscoder] transcoder used for decoding
-      attr_accessor :transcoder
-
-      # @yieldparam [GetAndTouchOptions] self
-      def initialize
-        super
-        @transcoder = JsonTranscoder.new
-        yield self if block_given?
-      end
-    end
-
     class GetResult
       extend Gem::Deprecate
 
@@ -97,6 +29,9 @@ module Couchbase
       # @return [Integer] the expiration if fetched and present
       attr_writer :expiry
 
+      # @return [Error::CouchbaseError, nil] error associated with the result, or nil (used in {Collection#get_multi})
+      attr_accessor :error
+
       # @return [String] The encoded content when loading the document
       # @api private
       attr_accessor :encoded
@@ -107,7 +42,7 @@ module Couchbase
       #
       # @return [Object]
       def content(transcoder = self.transcoder)
-        transcoder.decode(@encoded, @flags)
+        transcoder ? transcoder.decode(@encoded, @flags) : @encoded
       end
 
       # @return [Time] time when the document will expire
@@ -118,6 +53,7 @@ module Couchbase
       # @yieldparam [GetResult] self
       def initialize
         @expiry = nil
+        @error = nil
         yield self if block_given?
       end
 
@@ -130,48 +66,18 @@ module Couchbase
 
       # @deprecated Use {#expiry_time}
       # @return [Integer] the expiration if fetched and present
-      def expiry
+      def expiry # rubocop:disable Style/TrivialAccessors will be removed in next major release
         @expiry
       end
       deprecate :expiry, :expiry_time, 2021, 1
     end
 
-    class GetAllReplicasOptions < CommonOptions
-      # @return [JsonTranscoder] transcoder used for decoding
-      attr_accessor :transcoder
-
-      # @yieldparam [GetAllReplicasOptions] self
-      def initialize
-        super
-        yield self if block_given?
-      end
-    end
-
-    class GetAnyReplicaOptions < CommonOptions
-      # @return [JsonTranscoder] transcoder used for decoding
-      attr_accessor :transcoder
-
-      # @yieldparam [GetAnyReplicaOptions] self
-      def initialize
-        super
-        yield self if block_given?
-      end
-    end
-
     class GetReplicaResult < GetResult
       # @return [Boolean] true if this result came from a replica
       attr_accessor :is_replica
       alias replica? is_replica
     end
 
-    class ExistsOptions < CommonOptions
-      # @yieldparam [ExistsOptions] self
-      def initialize
-        super
-        yield self if block_given?
-      end
-    end
-
     class ExistsResult
       # @return [Integer] holds the CAS value of the fetched document
       attr_accessor :cas
@@ -195,81 +101,6 @@ module Couchbase
       attr_accessor :partition_id
     end
 
-    class RemoveOptions < CommonOptions
-      # @return [Integer] Specifies a CAS value that will be taken into account on the server side for optimistic concurrency
-      attr_accessor :cas
-
-      # @return [:none, :majority, :majority_and_persist_to_active, :persist_to_majority] level of durability
-      attr_accessor :durability_level
-
-      # @yieldparam [RemoveOptions]
-      def initialize
-        super
-        @durability_level = :none
-        yield self if block_given?
-      end
-    end
-
-    class InsertOptions < CommonOptions
-      # @return [Integer] expiration time to associate with the document
-      attr_accessor :expiry
-
-      # @return [Proc] transcoder used for encoding
-      attr_accessor :transcoder
-
-      # @return [:none, :majority, :majority_and_persist_to_active, :persist_to_majority] level of durability
-      attr_accessor :durability_level
-
-      # @yieldparam [InsertOptions]
-      def initialize
-        super
-        @transcoder = JsonTranscoder.new
-        @durability_level = :none
-        yield self if block_given?
-      end
-    end
-
-    class UpsertOptions < CommonOptions
-      # @return [Integer] expiration time to associate with the document
-      attr_accessor :expiry
-
-      # @return [JsonTranscoder] transcoder used for encoding
-      attr_accessor :transcoder
-
-      # @return [:none, :majority, :majority_and_persist_to_active, :persist_to_majority] level of durability
-      attr_accessor :durability_level
-
-      # @yieldparam [UpsertOptions]
-      def initialize
-        super
-        @transcoder = JsonTranscoder.new
-        @durability_level = :none
-        yield self if block_given?
-      end
-    end
-
-    class ReplaceOptions < CommonOptions
-      # @return [Integer] expiration time to associate with the document
-      attr_accessor :expiry
-
-      # @return [JsonTranscoder] transcoder used for encoding
-      attr_accessor :transcoder
-
-      # @return [Integer] Specifies a CAS value that will be taken into account on the server side for optimistic concurrency
-      attr_accessor :cas
-
-      # @return [:none, :majority, :majority_and_persist_to_active, :persist_to_majority] level of durability
-      attr_accessor :durability_level
-
-      # @yieldparam [ReplaceOptions]
-      def initialize
-        super
-        @transcoder = JsonTranscoder.new
-        @durability_level = :none
-        yield self if block_given?
-      end
-    end
-
     class MutationResult
       # @return [Integer] holds the CAS value of the document after the mutation
       attr_accessor :cas
@@ -277,39 +108,13 @@ module Couchbase
       # @return [MutationToken] if returned, holds the mutation token of the document after the mutation
       attr_accessor :mutation_token
 
-      # @yieldparam [MutationResult] self
-      def initialize
-        yield self if block_given?
-      end
-    end
-
-    class TouchOptions < CommonOptions
-      # @yieldparam [TouchOptions] self
-      def initialize
-        super
-        yield self if block_given?
-      end
-    end
-
-    class UnlockOptions < CommonOptions
-      # @yieldparam [UnlockOptions] self
-      def initialize
-        super
-        yield self if block_given?
-      end
-    end
-
-    class LookupInOptions < CommonOptions
-      # @return [Boolean] For internal use only: allows access to deleted documents that are in 'tombstone' form
-      attr_accessor :access_deleted
-
-      # @return [JsonTranscoder] transcoder used for decoding
-      attr_accessor :transcoder
+      # @return [Error::CouchbaseError, nil] error or nil (used in multi-operations like {Collection#upsert_multi},
+      #   {Collection#remove_multi})
+      attr_accessor :error
 
-      # @yieldparam [LookupInOptions] self
+      # @yieldparam [MutationResult] self
       def initialize
-        super
-        @transcoder = JsonTranscoder.new
+        @error = nil
         yield self if block_given?
       end
     end
@@ -336,11 +141,21 @@ module Couchbase
         !encoded[index].nil? && encoded[index].exists
       end
 
+      # @see MutateInOptions#create_as_deleted
+      #
+      # @return [Boolean] true if the document is a tombstone (created in deleted state)
+      def deleted?
+        @deleted
+      end
+
+      attr_accessor :deleted
+
       # @return [Array<SubDocumentField>] holds the encoded subdocument responses
       attr_accessor :encoded
 
       # @yieldparam [LookupInResult] self
       def initialize
+        @deleted = false
         yield self if block_given?
       end
 
@@ -359,43 +174,6 @@ module Couchbase
       end
     end
 
-    class MutateInOptions < CommonOptions
-      # @return [Integer] expiration time to associate with the document
-      attr_accessor :expiry
-
-      # Describes how the outer document store semantics on subdoc should act
-      #
-      # * +:replace+: replace the document, fail if it does not exist. This is the default
-      # * +:upsert+: replace the document or create if it does not exist
-      # * +:insert+: create the document, fail if it exists
-      #
-      # @return [:replace, :upsert, :insert]
-      attr_accessor :store_semantics
-
-      # @return [Integer] Specifies a CAS value that will be taken into account on the server side for optimistic concurrency
-      attr_accessor :cas
-
-      # @return [Boolean] For internal use only: allows access to deleted documents that are in 'tombstone' form
-      attr_accessor :access_deleted
-
-      # @return [Boolean] For internal use only: allows creating documents in 'tombstone' form
-      attr_accessor :create_as_deleted
-
-      # @return [:none, :majority, :majority_and_persist_to_active, :persist_to_majority] level of durability
-      attr_accessor :durability_level
-
-      # @yieldparam [MutateInOptions]
-      def initialize
-        super
-        @durability_level = :none
-        @store_semantics = :replace
-        @transcoder = JsonTranscoder.new
-        yield self if block_given?
-      end
-
-      attr_accessor :transcoder
-    end
-
     class MutateInResult < MutationResult
       # Decodes the content at the given index
       #
@@ -411,6 +189,15 @@ module Couchbase
         end
       end
 
+      # @see MutateInOptions#create_as_deleted
+      #
+      # @return [Boolean] true if the document is a tombstone (created in deleted state)
+      def deleted?
+        @deleted
+      end
+
+      attr_accessor :deleted
+
       # @yieldparam [MutateInResult] self
       def initialize
         super

data/lib/couchbase/datastructures/couchbase_list.rb

@@ -14,6 +14,7 @@
 
 require "couchbase/collection"
 require "couchbase/errors"
+require "couchbase/options"
 
 module Couchbase
   module Datastructures
@@ -28,8 +29,8 @@ module Couchbase
       #
       # @param [String] id the id of the document to back the list.
       # @param [Collection] collection the Couchbase collection through which to interact with the document.
-      # @param [CouchbaseListOptions] options customization of the datastructure
-      def initialize(id, collection, options = CouchbaseListOptions.new)
+      # @param [Options::CouchbaseList] options customization of the datastructure
+      def initialize(id, collection, options = Options::CouchbaseList.new)
         @id = id
         @collection = collection
         @options = options
@@ -153,19 +154,7 @@ module Couchbase
       end
     end
 
-    class CouchbaseListOptions
-      attr_accessor :get_options
-      attr_accessor :lookup_in_options
-      attr_accessor :mutate_in_options
-      attr_accessor :remove_options
-
-      def initialize
-        @get_options = Collection::GetOptions.new
-        @remove_options = Collection::RemoveOptions.new
-        @lookup_in_options = Collection::LookupInOptions.new
-        @mutate_in_options = Collection::MutateInOptions.new
-        @mutate_in_options.store_semantics = :upsert
-      end
-    end
+    # @api private
+    CouchbaseListOptions = ::Couchbase::Options::CouchbaseList
   end
 end

data/lib/couchbase/datastructures/couchbase_map.rb

@@ -13,6 +13,7 @@
 #  limitations under the License.
 
 require "couchbase/collection"
+require "couchbase/options"
 require "couchbase/errors"
 
 module Couchbase
@@ -28,8 +29,8 @@ module Couchbase
       #
       # @param [String] id the id of the document to back the map.
       # @param [Collection] collection the Couchbase collection through which to interact with the document.
-      # @param [CouchbaseMapOptions] options customization of the datastructure
-      def initialize(id, collection, options = CouchbaseMapOptions.new)
+      # @param [Options::CouchbaseMap] options customization of the datastructure
+      def initialize(id, collection, options = Options::CouchbaseMap.new)
         @id = id
         @collection = collection
         @options = options
@@ -187,19 +188,7 @@ module Couchbase
       end
     end
 
-    class CouchbaseMapOptions
-      attr_accessor :get_options
-      attr_accessor :lookup_in_options
-      attr_accessor :mutate_in_options
-      attr_accessor :remove_options
-
-      def initialize
-        @get_options = Collection::GetOptions.new
-        @remove_options = Collection::RemoveOptions.new
-        @lookup_in_options = Collection::LookupInOptions.new
-        @mutate_in_options = Collection::MutateInOptions.new
-        @mutate_in_options.store_semantics = :upsert
-      end
-    end
+    # @api private
+    CouchbaseMapOptions = ::Couchbase::Options::CouchbaseMap
   end
 end

data/lib/couchbase/datastructures/couchbase_queue.rb

@@ -13,6 +13,7 @@
 #  limitations under the License.
 
 require "couchbase/collection"
+require "couchbase/options"
 require "couchbase/errors"
 
 module Couchbase
@@ -28,8 +29,8 @@ module Couchbase
       #
       # @param [String] id the id of the document to back the queue.
       # @param [Collection] collection the collection through which to interact with the document.
-      # @param [CouchbaseListOptions] options customization of the datastructure
-      def initialize(id, collection, options = CouchbaseQueueOptions.new)
+      # @param [Options::CouchbaseList] options customization of the datastructure
+      def initialize(id, collection, options = Options::CouchbaseQueue.new)
         @id = id
         @collection = collection
         @options = options
@@ -127,19 +128,7 @@ module Couchbase
       alias shift pop
     end
 
-    class CouchbaseQueueOptions
-      attr_accessor :get_options
-      attr_accessor :lookup_in_options
-      attr_accessor :mutate_in_options
-      attr_accessor :remove_options
-
-      def initialize
-        @get_options = Collection::GetOptions.new
-        @remove_options = Collection::RemoveOptions.new
-        @lookup_in_options = Collection::LookupInOptions.new
-        @mutate_in_options = Collection::MutateInOptions.new
-        @mutate_in_options.store_semantics = :upsert
-      end
-    end
+    # @api private
+    CouchbaseQueueOptions = ::Couchbase::Options::CouchbaseQueue
   end
 end