couchbase 3.0.0.alpha.4-x86_64-linux → 3.5.0-x86_64-linux

data/lib/couchbase/subdoc.rb

@@ -1,4 +1,4 @@
-#    Copyright 2020 Couchbase, Inc.
+#  Copyright 2020-2021 Couchbase, Inc.
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.
@@ -16,10 +16,18 @@ module Couchbase
   class LookupInSpec
     # Fetches the content from a field (if present) at the given path
     #
-    # @param [String] path the path identifying where to get the value
+    # @param [String, Symbol] path the path identifying where to get the value. When path is a symbol, the library will try to expand it as
+    #   macro.
     # @return [LookupInSpec]
     def self.get(path)
-      new(path.empty? ? :get_doc : :get, path)
+      case path
+      when Symbol
+        new(:get, expand_macro(path))
+      when ""
+        new(:get_doc, "")
+      else
+        new(:get, path)
+      end
     end
 
     # Checks if a value at the given path exists in the document
@@ -30,7 +38,7 @@ module Couchbase
       new(:exists, path)
     end
 
-    # Counts the number of values at a given path in teh document
+    # Counts the number of values at a given path in the document
     #
     # @param [String] path the path identifying where to count the values
     # @return [LookupInSpec]
@@ -50,11 +58,41 @@ module Couchbase
     attr_reader :type
     attr_reader :path
 
+    # @api private
+    #
+    # @param [Symbol] macro
+    # @raise [Error::XattrUnknownMacro] if the macro cannot be expanded
+    def self.expand_macro(macro)
+      case macro
+      when :document
+        "$document"
+      when :expiry_time, :expiration_time
+        "$document.exptime"
+      when :cas
+        "$document.CAS"
+      when :seq_no, :sequence_number
+        "$document.seqno"
+      when :last_modified
+        "$document.last_modified"
+      when :is_deleted
+        "$document.deleted"
+      when :value_size_bytes
+        "$document.value_bytes"
+      when :rev_id, :revision_id
+        "$document.revid"
+      else
+        raise Error::XattrUnknownMacro, "unknown macro #{macro}"
+      end
+    end
+
+    private_class_method :expand_macro
+
     private
 
     # @param [:get_doc, :get, :exists, :count] type of the lookup
     # @param [String] path
     def initialize(type, path)
+      @xattr = false
       @type = type
       @path = path
     end
@@ -67,11 +105,12 @@ module Couchbase
     # error if the last element of the path does not exist.
     #
     # @param [String] path the path identifying where to replace the value.
-    # @param [Object] value the value to replace with.
+    # @param [Object, Symbol] value the value to replace with.
+    #   When symbol specified and it is matches to known macro, it will be expanded
     #
     # @return [MutateInSpec]
     def self.replace(path, value)
-      new(:replace, path, value)
+      new(path.empty? ? :set_doc : :replace, path, value)
     end
 
     # Creates a command with the intention of inserting a new value in a JSON object.
@@ -79,10 +118,11 @@ module Couchbase
     # Will error if the last element of the path already exists.
     #
     # @param [String] path the path identifying where to insert the value.
-    # @param [Object] value the value to insert
+    # @param [Object, Symbol] value the value to insert.
+    #   When symbol specified and it is matches to known macro, it will be expanded
     #
     # @return [MutateInSpec]
-    def self.dict_add(path, value)
+    def self.insert(path, value)
       new(:dict_add, path, value)
     end
 
@@ -94,7 +134,7 @@ module Couchbase
     #
     # @return [MutateInSpec]
     def self.remove(path)
-      new(:remove, path, nil)
+      new(path.empty? ? :remove_doc : :remove, path, nil)
     end
 
     # Creates a command with the intention of upserting a value in a JSON object.
@@ -102,10 +142,11 @@ module Couchbase
     # That is, the value will be replaced if the path already exists, or inserted if not.
     #
     # @param [String] path the path identifying where to upsert the value.
-    # @param [Object] value the value to upsert.
+    # @param [Object, Symbol] value the value to upsert.
+    #   When symbol specified and it is matches to known macro, it will be expanded
     #
     # @return [MutateInSpec]
-    def self.dict_upsert(path, value)
+    def self.upsert(path, value)
       new(:dict_upsert, path, value)
     end
 
@@ -118,7 +159,7 @@ module Couchbase
     #
     # @return [MutateInSpec]
     def self.array_append(path, values)
-      new(:array_append, path, values)
+      new(:array_push_last, path, values)
     end
 
     # Creates a command with the intention of prepending a value to an existing JSON array.
@@ -130,7 +171,7 @@ module Couchbase
     #
     # @return [MutateInSpec]
     def self.array_prepend(path, values)
-      new(:array_prepend, path, values)
+      new(:array_push_first, path, values)
     end
 
     # Creates a command with the intention of inserting a value into an existing JSON array.
@@ -151,7 +192,7 @@ module Couchbase
     # Will error if the last element of the path does not exist or is not an array.
     #
     # @param [String] path the path identifying an array to which to append the value, and an index.  E.g. "foo.bar[3]"
-    # @param [Object] value the value to insert.
+    # @param [Object, Symbol] value the value to insert.
     #
     # @return [MutateInSpec]
     def self.array_add_unique(path, value)
@@ -187,8 +228,8 @@ module Couchbase
       self
     end
 
-    def create_parents
-      @create_parents = true
+    def create_path
+      @create_path = true
       self
     end
 
@@ -196,17 +237,17 @@ module Couchbase
       @xattr
     end
 
-    def create_parents?
-      @create_parents
+    def create_path?
+      @create_path
     end
 
     def expand_macros?
       @expand_macros
     end
 
-    CAS = "${Mutation.CAS}"
-    SEQ_NO = "${Mutation.seqno}"
-    VALUE_CRC_32C = "${Mutation.value_crc32c}"
+    CAS = "${Mutation.CAS}".freeze
+    SEQ_NO = "${Mutation.seqno}".freeze
+    VALUE_CRC32C = "${Mutation.value_crc32c}".freeze
 
     attr_reader :type
     attr_reader :path
@@ -215,12 +256,35 @@ module Couchbase
     private
 
     def initialize(type, path, param)
+      @create_path = false
+      @param = nil
+      @xattr = false
       @type = type
       @path = path
-      @expand_macros = [CAS, SEQ_NO, VALUE_CRC_32C].include?(@param)
-      if !@expand_macros && !param.nil?
-        @param = JSON.generate(param)
-      end
+      @param =
+        case param
+        when :cas
+          CAS
+        when :seq_no, :sequence_number
+          SEQ_NO
+        when :value_crc32c, :value_crc
+          VALUE_CRC32C
+        else
+          param
+        end
+      @expand_macros = [CAS, SEQ_NO, VALUE_CRC32C].include?(@param)
+      @xattr = true if @expand_macros
+      return if @param.nil?
+
+      @param =
+        case type
+        when :counter
+          @param.to_i
+        when :array_push_first, :array_push_last, :array_insert
+          @param.map { |entry| JSON.generate(entry) }.join(",")
+        else
+          JSON.generate(@param)
+        end
     end
   end
 end

data/lib/couchbase/transcoder_flags.rb

@@ -0,0 +1,62 @@
+#  Copyright 2023. Couchbase, Inc.
+#
+#  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
+#
+#      http://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.
+
+module Couchbase
+  # @api private
+  class TranscoderFlags
+    FORMAT_MAP = {
+      reserved: 0,
+      private: 1,
+      json: 2,
+      binary: 3,
+      string: 4,
+    }.freeze
+    INV_FORMAT_MAP = FORMAT_MAP.invert.freeze
+
+    COMPRESSION_MAP = {none: 0}.freeze
+    INV_COMPRESSION_MAP = COMPRESSION_MAP.invert
+
+    attr_reader :format
+    attr_reader :compression
+    attr_reader :lower_bits
+
+    def initialize(format:, compression: :none, lower_bits: 0)
+      @format = format
+      @compression = compression
+      @lower_bits = lower_bits
+    end
+
+    def self.decode(flags)
+      return TranscoderFlags.new(format: flags) if flags.is_a?(Symbol)
+
+      common_flags = flags >> 24
+      lower_bits = flags & 0x00ffff
+
+      return TranscoderFlags.new(format: nil, lower_bits: lower_bits) if common_flags.zero?
+
+      compression_bits = common_flags >> 5
+      format_bits = common_flags & 0x0f
+      TranscoderFlags.new(
+        format: INV_FORMAT_MAP[format_bits],
+        compression: INV_COMPRESSION_MAP[compression_bits],
+        lower_bits: lower_bits
+      )
+    end
+
+    def encode
+      common_flags = (COMPRESSION_MAP[@compression] << 5) | FORMAT_MAP[@format]
+      (common_flags << 24) | @lower_bits
+    end
+  end
+end

data/lib/couchbase/utils/generic_logger_adapter.rb

@@ -0,0 +1,38 @@
+#   Copyright 2021 Couchbase, Inc.
+#  Copyright 2020-Present Couchbase, Inc.
+#
+#  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
+#
+#      http://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 "time"
+
+module Couchbase
+  module Utils
+    class GenericLoggerAdapter
+      DATETIME_FORMAT = "%Y-%m-%dT%H:%M:%S.%6N".freeze
+
+      def initialize(logger, verbose: false)
+        @logger = logger
+        @verbose = verbose
+      end
+
+      def log(level, thread_id, seconds, nanoseconds, payload, filename, line, function)
+        return unless @logger.respond_to?(level)
+
+        progname = "cxxcbc##{thread_id}"
+        payload += " at #{filename}:#{line} #{function}" if @verbose && filename
+        @logger.send(level,
+                     "[#{::Time.at(seconds, nanoseconds, :nanosecond).strftime(DATETIME_FORMAT)} #{progname}]  #{level} -- #{payload}")
+      end
+    end
+  end
+end

data/lib/couchbase/utils/stdlib_logger_adapter.rb

@@ -0,0 +1,65 @@
+#   Copyright 2021 Couchbase, Inc.
+#  Copyright 2020-Present Couchbase, Inc.
+#
+#  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
+#
+#      http://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 "logger"
+require "time"
+
+module Couchbase
+  module Utils
+    class StdlibLoggerAdapter
+      def initialize(logger, verbose: false)
+        raise ArgumentError, "logger argument must be or derive from stdlib Logger class" unless logger.is_a?(::Logger)
+
+        @logger = logger
+        @verbose = verbose
+      end
+
+      def log(level, thread_id, seconds, nanoseconds, payload, filename, line, function)
+        logdev = @logger.instance_variable_get(:@logdev)
+        return unless logdev
+
+        severity = map_spdlog_level(level)
+        return unless severity
+
+        progname = "cxxcbc##{thread_id}"
+        payload += " at #{filename}:#{line} #{function}" if @verbose && filename
+        logdev.write(
+          @logger.send(:format_message, @logger.send(:format_severity, severity), ::Time.at(seconds, nanoseconds, :nanosecond), progname,
+                       payload)
+        )
+      end
+
+      private
+
+      def map_spdlog_level(level)
+        case level
+        when :trace, :debug
+          ::Logger::Severity::DEBUG
+        when :info
+          ::Logger::Severity::INFO
+        when :warn
+          ::Logger::Severity::WARN
+        when :error
+          ::Logger::Severity::ERROR
+        when :critical
+          ::Logger::Severity::FATAL
+        else # rubocop:disable Style/EmptyElse
+          # covers :off
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/couchbase/utils/time.rb

@@ -0,0 +1,69 @@
+#  Copyright 2020-2021 Couchbase, Inc.
+#
+#  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
+#
+#      http://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 "time"
+
+module Couchbase
+  module Utils
+    # Various Time utilities
+    module Time
+      RELATIVE_EXPIRY_CUTOFF_SECONDS = 30 * 24 * 60 * 60
+      WORKAROUND_EXPIRY_CUTOFF_SECONDS = 50 * 365 * 24 * 60 * 60
+
+      module_function
+
+      # @param [Integer, #in_seconds, Time, nil] time_or_duration expiration time to associate with the document
+      def extract_expiry_time(time_or_duration)
+        if time_or_duration.respond_to?(:in_seconds) # Duration
+          [:duration, time_or_duration.in_seconds]
+        elsif time_or_duration.respond_to?(:tv_sec) # Time
+          [:time_point, time_or_duration.tv_sec]
+        elsif time_or_duration.is_a?(Integer)
+          if time_or_duration < RELATIVE_EXPIRY_CUTOFF_SECONDS
+            # looks like valid relative duration as specified in protocol (less than 30 days)
+            [:duration, time_or_duration]
+          elsif time_or_duration > WORKAROUND_EXPIRY_CUTOFF_SECONDS
+            effective_expiry = ::Time.at(time_or_duration).utc
+            warn "The specified expiry duration #{time_or_duration} is longer than 50 years. For bug-compatibility " \
+                 "with previous versions of SDK 3.0.x, the number of seconds in the duration will be interpreted as " \
+                 "the epoch second when the document should expire (#{effective_expiry}). Stuffing an epoch second " \
+                 "into a Duration is deprecated and will no longer work in SDK 3.1. Consider using Time instance instead."
+            [:time_point, time_or_duration]
+          else
+            [:time_point, ::Time.now.tv_sec + time_or_duration]
+          end
+        else
+          [:duration, time_or_duration]
+        end
+      end
+
+      # This method converts its argument to milliseconds
+      #
+      # 1. Integer values are interpreted as a number of milliseconds
+      # 2. If the argument is a Duration-like object and responds to #in_milliseconds,
+      #    then use it and convert result to Integer
+      # 3. Otherwise invoke #to_i on the argument and interpret it as a number of milliseconds
+      def extract_duration(number_or_duration)
+        return unless number_or_duration
+        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)
+        else
+          number_or_duration
+        end.to_i
+      end
+    end
+  end
+end

data/lib/couchbase/utils.rb

@@ -0,0 +1,21 @@
+#  Copyright 2020-2021 Couchbase, Inc.
+#
+#  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
+#
+#      http://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.
+
+module Couchbase
+  # Module for internal tools, extensions and utilities
+  module Utils
+  end
+end
+
+require "couchbase/utils/time"

data/lib/couchbase/version.rb

@@ -1,4 +1,4 @@
-#    Copyright 2020 Couchbase, Inc.
+#  Copyright 2020-2021 Couchbase, Inc.
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.
@@ -13,6 +13,11 @@
 #  limitations under the License.
 
 module Couchbase
-  VERSION = {} unless defined?(VERSION)
-  VERSION.update(:sdk => "3.0.0.alpha.4".freeze)
+  # Version of the library and all bundled dependencies
+  #
+  # @example Display version (+Couchbase::BUILD_INFO+ contains more details)
+  #   $ 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.0".freeze)
 end

data/lib/couchbase/view_options.rb

@@ -1,4 +1,4 @@
-#    Copyright 2020 Couchbase, Inc.
+#  Copyright 2020-2021 Couchbase, Inc.
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.
@@ -12,101 +12,10 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
-require 'json'
+require "json"
 
 module Couchbase
   class Bucket
-
-    class ViewOptions
-      # @return [Integer] Timeout in milliseconds
-      attr_accessor :timeout
-
-      # Specifies the level of consistency for the query
-      # @return [:not_bounded, :request_plus, :update_after]
-      attr_accessor :scan_consistency
-
-      # Specifies the number of results to skip from the start of the result set
-      # @return [Integer]
-      attr_accessor :skip
-
-      # Specifies the maximum number of results to return
-      # @return [Integer]
-      attr_accessor :limit
-
-      # Specifies the key, to which the engine has to skip before result generation
-      attr_accessor :start_key
-
-      # Specifies the key, at which the result generation has to be stopped
-      # @return [#to_json]
-      attr_accessor :end_key
-
-      # Specifies the document id in case {#start_key} gives multiple results within the index
-      # @return [String]
-      attr_accessor :start_key_doc_id
-
-      # Specifies the document id in case {#end_key} gives multiple results within the index
-      # @return [String]
-      attr_accessor :end_key_doc_id
-
-      # Specifies whether the {#end_key}/#{#end_key_doc_id} values should be inclusive
-      # @return [Boolean]
-      attr_accessor :inclusive_end
-
-      # Specifies whether to enable grouping of the results
-      #
-      # @return [Boolean]
-      attr_accessor :group
-
-      # Specifies the depth within the key to group the results
-      #
-      # @return [Integer]
-      attr_accessor :group_level
-
-      # Specifies the set of the keys to fetch from the index
-      # @return [#to_json]
-      attr_accessor :key
-
-      # Specifies set of the keys to fetch from the index
-      #
-      # @return [Array<#to_json>]
-      attr_accessor :keys
-
-      # Specifies the order of the results that should be returned
-      #
-      # @return [:ascending, :descending]
-      attr_accessor :order
-
-      # Specifies whether to enable the reduction function associated with this particular view index
-      # @return [Boolean]
-      attr_accessor :reduce
-
-      # Specifies the behaviour of the view engine should an error occur during the gathering of view index results
-      # which would result in only partial results being available
-      #
-      # @return [:stop, :continue]
-      attr_accessor :on_error
-
-      # @return [Boolean] allows to return debug information as part of the view response
-      attr_accessor :debug
-
-      # @return [:production, :development]
-      attr_accessor :namespace
-
-      # @yieldparam [ViewQueryOptions] self
-      def initialize
-        @namespace = :production
-        yield self if block_given?
-      end
-
-      # Allows providing custom JSON key/value pairs for advanced usage
-      #
-      # @param [String] key the parameter name (key of the JSON property)
-      # @param [Object] value the parameter value (value of the JSON property)
-      def raw(key, value)
-        @raw_parameters[key] = JSON.generate(value)
-      end
-    end
-
     class ViewRow
       # @return [String]
       attr_accessor :id
@@ -127,9 +36,10 @@ module Couchbase
       # @return [Integer]
       attr_accessor :total_rows
 
+      # @api private
       attr_writer :debug_info
 
-      def debug_info
+      def debug
         JSON.parse(@debug_info)
       end
 
@@ -140,7 +50,7 @@ module Couchbase
     end
 
     class ViewResult
-      # @return [QueryMetaData] returns object representing additional metadata associated with this query
+      # @return [ViewMetaData] returns object representing additional metadata associated with this query
       attr_accessor :meta_data
 
       # @return [Array<ViewRow>]

data/lib/couchbase.rb

@@ -1,4 +1,4 @@
-#    Copyright 2020 Couchbase, Inc.
+#  Copyright 2020-2021 Couchbase, Inc.
 #
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.
@@ -14,5 +14,15 @@
 
 require "couchbase/version"
 require "couchbase/libcouchbase"
+require "couchbase/logger"
 require "couchbase/cluster"
 
+require "couchbase/railtie" if defined?(Rails)
+
+# @!macro uncommitted
+#   @couchbase.stability
+#     Uncommitted: This API may change in the future.
+#
+# @!macro volatile
+#   @couchbase.stability
+#     Volatile: This API is subject to change at any time.

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

@@ -0,0 +1,27 @@
+#  Copyright 2020-2021 Couchbase, Inc.
+#
+#  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
+#
+#      http://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.
+
+module Couchbase
+  module Generators
+    class ConfigGenerator < Rails::Generators::Base
+      desc "Creates a Couchbase configuration file at config/couchbase.yml"
+
+      source_root File.expand_path(File.join("..", "templates"), __FILE__)
+
+      def create_config_file
+        template "couchbase.yml", File.join("config", "couchbase.yml")
+      end
+    end
+  end
+end