couchbase 3.0.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 241594e3c8b47ca837a1eb6ef09c83bb5e1babdac18869a9b66bf821bf77c882
-  data.tar.gz: 0cf2f466bf600b6908e34ed7a495a9738cd74bed7f5ee7b83afaf3053a99aad1
+  metadata.gz: 24cc8f415bbff9e3e132ee47c16e04a2090c8a26cc9afbd21899263f735a10cd
+  data.tar.gz: 3e26641abb3b31354b496effc0002794c82af25a5626ccd784591f311c03c2c8
 SHA512:
-  metadata.gz: 9e9257498ef7c86c9b8ba6473a28ac55f4d725f56b818835904373a2ba934cdb7a5333eb6c978746954b1e98016250c2710d875eda8e6c45240ba468c5d1a0b4
-  data.tar.gz: cd31b914bd512515efd067aea2baff1ca0cfaa5bb5b7eebd96c1fd3fe12999811876f045c111b91d90565abb82306ef560a262e5f770ff3b7209e231a25be3b8
+  metadata.gz: 7f57fb43563e563c4d0ab75330108a199ec63c36794ceb3afe0b5702cf117a2350b3e9b02027ea1129de8a3e4cc464248284a8973d6c4d442ce8f83fc69d84b0
+  data.tar.gz: b020a7a1049d9d63d64684e83c82c7b8c8aae90a80188e79eb09850e6c7bad242ce4642be0051ed6355b3789c5bb7a0253523218b5917bb4f78e208b3edcd30e

data/README.md

@@ -1,11 +1,17 @@
-# Couchbase Ruby Client [![gem](https://badge.fury.io/rb/couchbase.svg)](https://rubygems.org/gems/couchbase) [![tests](https://github.com/couchbase/couchbase-ruby-client/workflows/tests/badge.svg)](https://github.com/couchbase/couchbase-ruby-client/actions?query=workflow%3Atests)
+# Couchbase Ruby Client
+
+[![license](https://img.shields.io/github/license/couchbase/couchbase-ruby-client?color=brightgreen)](https://opensource.org/licenses/Apache-2.0)
+[![gem](https://img.shields.io/gem/v/couchbase?color=brightgreen)](https://rubygems.org/gems/couchbase)
+[![commits](https://img.shields.io/github/commits-since/couchbase/couchbase-ruby-client/latest?color=brightgreen)](https://github.com/couchbase/couchbase-ruby-client/commits/master)
+[![tests](https://img.shields.io/github/workflow/status/couchbase/couchbase-ruby-client/tests?label=tests)](https://github.com/couchbase/couchbase-ruby-client/actions?query=workflow%3Atests)
+[![linters](https://img.shields.io/github/workflow/status/couchbase/couchbase-ruby-client/linters?label=linters)](https://github.com/couchbase/couchbase-ruby-client/actions?query=workflow%3Alinters)
 
 This repository contains the third generation of the official Couchbase SDK for Ruby (aka. SDKv3)
 
 ## Support and Feedback
 
-If you find an issue, please file it in [our JIRA issue tracker](https://couchbase.com/issues/browse/RCBC).
-Also you are always welcome on [our forum](https://forums.couchbase.com/c/ruby-sdk).
+If you find an issue, please file it in [our JIRA issue tracker](https://couchbase.com/issues/browse/RCBC). Also you are
+always welcome on [our forum](https://forums.couchbase.com/c/ruby-sdk).
 
 Please attach version information to ticket/post. To obtain this information use the following command:
 
@@ -13,12 +19,12 @@ Please attach version information to ticket/post. To obtain this information use
 
 ## Installation
 
-The library tested with the MRI 2.5, 2.6 and 2.7. Supported platforms are Linux and MacOS.
+The library tested with the MRI 2.5, 2.6, 2.7 and 3.0. Supported platforms are Linux and MacOS.
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "couchbase", "3.0.0"
+gem "couchbase", "3.1.1"
 ```
 
 And then execute:
@@ -33,6 +39,54 @@ For some platforms we precompile binary packages. When, for some reason, binary
 `--platform=ruby` to `gem install` command (or check `specific_platform` and `force_ruby_platform` options of Bundler).
 In latter case, see [Development](#development) section for build dependencies.
 
+## Usage
+
+Here is a basic steps demonstrating basic operations with data:
+
+```ruby
+require "couchbase"
+include Couchbase # include Couchbase module for brevity
+
+# initialize library
+cluster = Cluster.connect("couchbase://127.0.0.1", "Administrator", "password")
+
+# open bucket and collection for data operations
+bucket = cluster.bucket("my_bucket")
+collection = bucket.default_collection
+
+# update or insert the document
+res = collection.upsert("foo", {"bar" => 42})
+res.cas
+#=> 22120998714646
+
+# retrieve document from the collection
+res = collection.get("foo")
+res.cas
+#=> 22120998714646
+res.content
+#=> {"bar"=>42}
+
+# remove document
+res = collection.remove("foo")
+res.cas
+#=> 47891154812182
+
+# fetch top-3 cities by number of hotels in the collection
+res = cluster.query("
+          SELECT city, COUNT(*) AS cnt FROM `travel-sample`
+          WHERE type = $type
+          GROUP BY city
+          ORDER BY cnt DESC
+          LIMIT 3",
+        Options::Query(named_parameters: {type: "hotel"}, metrics: true))
+res.rows.each do |row|
+  p row
+end
+#=> {"city"=>"San Francisco", "cnt"=>132}
+#   {"city"=>"London", "cnt"=>67}
+#   {"city"=>"Paris", "cnt"=>64}
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive
@@ -60,3 +114,17 @@ Now the API reference is accessible using web browser (where `VERSION` is curren
 ## License
 
 The gem is available as open source under the terms of the [Apache2 License](https://opensource.org/licenses/Apache-2.0).
+
+    Copyright 2011-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.

data/ext/CMakeLists.txt

@@ -1,210 +1,132 @@
 cmake_minimum_required(VERSION 3.15)
 project(ruby_client LANGUAGES CXX C)
+include(cmake/PreventInSourceBuilds.cmake)
+include(cmake/StandardProjectSettings.cmake)
 
-set(CMAKE_CXX_STANDARD 17)
-
-find_program(CCACHE ccache)
-if(CCACHE)
-    set(CMAKE_CXX_COMPILER_LAUNCHER ${CCACHE})
+# 'library' to set the c++ standard / compile-time options requested
+add_library(project_options INTERFACE)
+target_compile_features(project_options INTERFACE cxx_std_17)
+if(CMAKE_CXX_COMPILER_ID MATCHES ".*Clang")
+  target_compile_options(project_options INTERFACE -fdeclspec)
 endif()
 
-include(CMakePushCheckState)
-include(CheckSymbolExists)
-
-cmake_push_check_state(RESET)
-find_library(EXECINFO_LIBRARY NAMES execinfo)
-if(EXECINFO_LIBRARY)
-    set(CMAKE_REQUIRED_LIBRARIES "${EXECINFO_LIBRARY}")
-    list(APPEND PLATFORM_LIBRARIES "${EXECINFO_LIBRARY}")
-endif(EXECINFO_LIBRARY)
-check_symbol_exists(backtrace execinfo.h HAVE_BACKTRACE)
-cmake_pop_check_state()
-
-cmake_push_check_state(RESET)
-set(CMAKE_REQUIRED_DEFINITIONS "-D_GNU_SOURCE")
-find_library(DL_LIBRARY NAMES dl)
-if(DL_LIBRARY)
-    set(CMAKE_REQUIRED_LIBRARIES "${DL_LIBRARY}")
-    list(APPEND PLATFORM_LIBRARIES "${DL_LIBRARY}")
-endif(DL_LIBRARY)
-check_symbol_exists(dladdr dlfcn.h HAVE_DLADDR)
-cmake_pop_check_state()
-
-if(HAVE_BACKTRACE)
-    add_definitions(-DHAVE_BACKTRACE=1)
-endif()
+# 'library' to use the warnings specified in CompilerWarnings.cmake
+add_library(project_warnings INTERFACE)
 
-if(HAVE_DLADDR)
-    add_definitions(-DHAVE_DLADDR=1)
-endif()
+include(cmake/BuildTracing.cmake)
 
-add_subdirectory(third_party/gsl)
-add_subdirectory(third_party/json)
-add_subdirectory(third_party/spdlog)
-add_subdirectory(third_party/snappy)
+# enable cache system
+include(cmake/Cache.cmake)
 
-include_directories(BEFORE SYSTEM third_party/gsl/include)
-include_directories(BEFORE SYSTEM third_party/asio/asio/include)
-include_directories(BEFORE SYSTEM third_party/json/include)
-include_directories(BEFORE SYSTEM third_party/spdlog/include)
-include_directories(BEFORE SYSTEM third_party/http_parser)
+# standard compiler warnings
+include(cmake/CompilerWarnings.cmake)
+set_project_warnings(project_warnings)
 
-add_library(project_warnings INTERFACE)
-add_library(project_options INTERFACE)
+# sanitizer options if supported by compiler
+include(cmake/Sanitizers.cmake)
+enable_sanitizers(project_options)
 
-target_compile_features(project_options INTERFACE cxx_std_17)
-target_include_directories(project_options INTERFACE include)
+# allow for static analysis options
+include(cmake/StaticAnalyzers.cmake)
 
-if(MSVC)
-    target_compile_options(project_warnings INTERFACE /W4 /WX "/permissive-")
-else()
-    option(ONLY_COVERAGE "Build only tests necessary for coverage" FALSE)
-    option(STATIC_STDLIB "Statically link C++ standard library" FALSE)
-    option(ENABLE_COVERAGE "Enable coverage reporting for gcc/clang" FALSE)
-    option(ENABLE_FUZZERS "Enable fuzz testing tools" FALSE)
-
-    if(ONLY_COVERAGE OR ENABLE_COVERAGE)
-        target_compile_options(project_options INTERFACE --coverage -O0 -g)
-        target_link_libraries(project_options INTERFACE --coverage)
-    endif()
-
-    option(ENABLE_ASAN "Enable address sanitizer" FALSE)
-
-    if(ENABLE_ASAN)
-        target_compile_options(project_options INTERFACE -fsanitize=address)
-        target_link_libraries(project_options INTERFACE -fsanitize=address)
-    endif()
-
-    option(ENABLE_TSAN "Enable thread sanitizer" FALSE)
-
-    if(ENABLE_TSAN)
-        target_compile_options(project_options INTERFACE -fsanitize=thread)
-        target_link_libraries(project_options INTERFACE -fsanitize=thread)
-    endif()
-
-    if(STATIC_STDLIB)
-        target_compile_options(project_options INTERFACE -static-libgcc -static-libstdc++)
-        target_link_options(project_options INTERFACE -static-libgcc -static-libstdc++)
-    endif()
-
-    target_compile_options(
-        project_warnings
-        INTERFACE -Wall
-                  -Werror # treat all warnings as errors
-                  -Wextra # reasonable and standard
-                  -Wshadow # warn the user if a variable declaration shadows one from a parent
-                  # context
-                  -Wnon-virtual-dtor # warn the user if a class with virtual functions has a non-
-                  # virtual destructor. This helps catch hard to track down memory errors
-                  -Wcast-align # warn for potential performance problem casts
-                  -Wunused # warn on anything being unused
-                  -Woverloaded-virtual # warn if you overload (not override) a virtual function
-                  -Wpedantic # warn if non-standard C++ is used
-                  -Wold-style-cast # warn for c-style casts
-                  -Wconversion # warn on type conversions that may lose data
-                  -Wsign-conversion # warn on sign conversions
-                  -Wnull-dereference # warn if a null dereference is detected
-                  -Wformat=2 # warn on security issues around functions that format output (ie
-                  # printf)
-    )
-
-    if("${CMAKE_CXX_COMPILER_ID}" STREQUAL "GNU")
-        target_compile_options(
-            project_warnings
-            INTERFACE -Wmisleading-indentation # warn if indentation implies blocks where blocks do
-                      # not exist
-                      -Wduplicated-cond # warn if if / else chain has duplicated conditions
-                      -Wduplicated-branches # warn if if / else branches have duplicated code
-                      -Wlogical-op # warn about logical operations being used where bitwise were
-                      # probably wanted
-                      -Wuseless-cast # warn if you perform a cast to the same type
-        )
-    endif()
-
-    if(HAVE_BACKTRACE OR HAVE_DLADDR)
-        target_compile_options(project_options INTERFACE -ggdb3)
-        target_link_libraries(project_options INTERFACE -rdynamic)
-        add_definitions(-D_GNU_SOURCE=1)
-    endif()
+include(cmake/Backtrace.cmake)
+
+include(cmake/ThirdPartyDependencies.cmake)
+
+option(STATIC_STDLIB "Statically link C++ standard library" FALSE)
+if("${CMAKE_CXX_COMPILER_ID}" STREQUAL "GNU")
+  if(STATIC_STDLIB)
+    target_compile_options(project_options INTERFACE -static-libgcc -static-libstdc++)
+    target_link_libraries(project_options INTERFACE -static-libgcc -static-libstdc++)
+  endif()
 endif()
 
+option(STATIC_OPENSSL "Statically link OpenSSL library" FALSE)
 # Read more at https://wiki.wireshark.org/TLS
 option(TLS_KEY_LOG_FILE "Path to file to write per-session secrets (Useful for Wireshark SSL/TLS dissection)")
-
+if(STATIC_OPENSSL)
+  set(OPENSSL_USE_STATIC_LIBS ON)
+endif()
 include(FindOpenSSL)
-message(STATUS "OPENSSL_VERSION: ${OPENSSL_VERSION}")
-message(STATUS "OPENSSL_INCLUDEDIRS: ${OPENSSL_INCLUDE_DIR}")
-message(STATUS "OPENSSL_LIBRARIES: ${OPENSSL_LIBRARIES}")
+if(OPENSSL_LIBRARIES AND OPENSSL_INCLUDE_DIR)
+  message(STATUS "OPENSSL_VERSION: ${OPENSSL_VERSION}")
+  message(STATUS "OPENSSL_INCLUDE_DIR: ${OPENSSL_INCLUDE_DIR}")
+  message(STATUS "OPENSSL_LIBRARIES: ${OPENSSL_LIBRARIES}")
+else()
+  message(FATAL_ERROR "Cannot build couchbase extension without OpenSSL")
+endif()
+
+include(cmake/VersionInfo.cmake)
 
 include_directories(${CMAKE_SOURCE_DIR}/couchbase)
 
 add_library(
-    platform OBJECT couchbase/platform/string_hex.cc couchbase/platform/uuid.cc couchbase/platform/random.cc
-                    couchbase/platform/base64.cc couchbase/platform/backtrace.c couchbase/platform/terminate_handler.cc)
+  platform OBJECT
+  couchbase/platform/string_hex.cc
+  couchbase/platform/uuid.cc
+  couchbase/platform/random.cc
+  couchbase/platform/base64.cc
+  couchbase/platform/backtrace.c
+  couchbase/platform/terminate_handler.cc)
 target_include_directories(platform PRIVATE ${PROJECT_BINARY_DIR}/generated)
+target_link_libraries(platform PRIVATE ${PLATFORM_LIBRARIES})
 
 add_library(cbcrypto OBJECT couchbase/cbcrypto/cbcrypto.cc)
-
-add_library(http_parser OBJECT third_party/http_parser/http_parser.c)
-set_target_properties(http_parser PROPERTIES C_VISIBILITY_PRESET hidden POSITION_INDEPENDENT_CODE TRUE)
+target_link_libraries(
+  cbcrypto
+  PRIVATE project_options
+          project_warnings
+          OpenSSL::SSL
+          OpenSSL::Crypto)
 
 add_library(
-    cbsasl OBJECT
-    couchbase/cbsasl/client.cc couchbase/cbsasl/context.cc couchbase/cbsasl/mechanism.cc
-    couchbase/cbsasl/plain/plain.cc couchbase/cbsasl/scram-sha/scram-sha.cc couchbase/cbsasl/scram-sha/stringutils.cc)
+  cbsasl OBJECT
+  couchbase/cbsasl/client.cc
+  couchbase/cbsasl/context.cc
+  couchbase/cbsasl/mechanism.cc
+  couchbase/cbsasl/plain/plain.cc
+  couchbase/cbsasl/scram-sha/scram-sha.cc
+  couchbase/cbsasl/scram-sha/stringutils.cc)
 
 if(RUBY_HDR_DIR)
-    set(RUBY_INCLUDE_DIR ${RUBY_HDR_DIR} ${RUBY_ARCH_HDR_DIR})
+  set(RUBY_INCLUDE_DIR ${RUBY_HDR_DIR} ${RUBY_ARCH_HDR_DIR})
 else()
-    find_package(Ruby REQUIRED)
-    message(STATUS "RUBY_VERSION: ${RUBY_VERSION}")
-    message(STATUS "RUBY_EXECUTABLE: ${RUBY_EXECUTABLE}")
+  find_package(Ruby REQUIRED)
+  message(STATUS "RUBY_VERSION: ${RUBY_VERSION}")
+  message(STATUS "RUBY_EXECUTABLE: ${RUBY_EXECUTABLE}")
 endif()
-message(STATUS "RUBY_INCLUDE_DIR: ${RUBY_INCLUDE_DIR}")
 message(STATUS "RUBY_LIBRARY: ${RUBY_LIBRARY}")
-include_directories(BEFORE SYSTEM "${RUBY_INCLUDE_DIR}")
-
-find_program(GIT git)
-if(GIT)
-    execute_process(
-        COMMAND git rev-parse HEAD
-        WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
-        OUTPUT_STRIP_TRAILING_WHITESPACE
-        OUTPUT_VARIABLE BACKEND_GIT_REVISION)
+if(RUBY_INCLUDE_DIR)
+  message(STATUS "RUBY_INCLUDE_DIR: ${RUBY_INCLUDE_DIR}")
+  include_directories(BEFORE SYSTEM "${RUBY_INCLUDE_DIR}")
 endif()
 
-string(TIMESTAMP BACKEND_BUILD_TIMESTAMP "%Y-%m-%d %H:%M:%S" UTC)
-configure_file(${PROJECT_SOURCE_DIR}/build_version.hxx.in ${PROJECT_BINARY_DIR}/generated/build_version.hxx @ONLY)
-configure_file(${PROJECT_SOURCE_DIR}/build_config.hxx.in ${PROJECT_BINARY_DIR}/generated/build_config.hxx @ONLY)
 add_library(couchbase SHARED couchbase/couchbase.cxx)
 target_include_directories(couchbase PRIVATE ${PROJECT_BINARY_DIR}/generated)
 target_link_libraries(
-    couchbase
-    PRIVATE project_options
-            project_warnings
-            OpenSSL::SSL
-            OpenSSL::Crypto
-            platform
-            cbcrypto
-            cbsasl
-            http_parser
-            snappy
-            spdlog::spdlog_header_only)
-set_target_properties(cbcrypto cbsasl platform snappy PROPERTIES POSITION_INDEPENDENT_CODE TRUE)
+  couchbase
+  PRIVATE project_options
+          project_warnings
+          OpenSSL::SSL
+          OpenSSL::Crypto
+          platform
+          cbcrypto
+          cbsasl
+          http_parser
+          snappy
+          spdlog::spdlog_header_only)
+
+set_target_properties(
+  cbcrypto
+  cbsasl
+  platform
+  snappy
+  PROPERTIES POSITION_INDEPENDENT_CODE TRUE)
 
 if(APPLE)
-    target_link_options(couchbase PRIVATE -Wl,-undefined,dynamic_lookup)
+  target_link_libraries(couchbase PRIVATE -Wl,-undefined,dynamic_lookup)
 else()
-    set_target_properties(cbcrypto cbsasl platform PROPERTIES CXX_VISIBILITY_PRESET hidden)
+  set_target_properties(cbcrypto cbsasl platform PROPERTIES CXX_VISIBILITY_PRESET hidden)
 endif()
 
-if(BUILD_EXAMPLES)
-    file(
-        GENERATE
-        OUTPUT ${PROJECT_BINARY_DIR}/generated/generated_config.hxx
-        CONTENT "#pragma once\n#define LIBCOUCHBASE_EXT_PATH \"$<TARGET_FILE:couchbase>\"")
-    add_executable(main test/main.cxx)
-    target_include_directories(main PRIVATE ${PROJECT_BINARY_DIR}/generated)
-    target_link_libraries(main PRIVATE project_options project_warnings ${RUBY_LIBRARY} spdlog::spdlog_header_only)
-    add_dependencies(main couchbase)
-endif()
+include(cmake/Testing.cmake)

data/ext/build_config.hxx.in

@@ -1,6 +1,6 @@
 /* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
 /*
- *     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.
@@ -18,3 +18,5 @@
 #pragma once
 
 #cmakedefine TLS_KEY_LOG_FILE "@TLS_KEY_LOG_FILE@"
+#cmakedefine STATIC_STDLIB 1
+#cmakedefine STATIC_OPENSSL 1

data/ext/build_version.hxx.in

@@ -1,6 +1,6 @@
 /* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
 /*
- *     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.
@@ -17,10 +17,14 @@
 
 #pragma once
 
-#define BACKEND_BUILD_TIMESTAMP "@BACKEND_BUILD_TIMESTAMP@"
-#define BACKEND_CXX_COMPILER "@CMAKE_CXX_COMPILER_ID@ @CMAKE_CXX_COMPILER_VERSION@"
-#define BACKEND_C_COMPILER "@CMAKE_C_COMPILER_ID@ @CMAKE_C_COMPILER_VERSION@"
-#define BACKEND_SYSTEM "@CMAKE_SYSTEM@"
-#define BACKEND_SYSTEM_PROCESSOR "@CMAKE_SYSTEM_PROCESSOR@"
-#define BACKEND_GIT_REVISION "a23527c044e32c037f4a001c2b2a836716d85d35"
+#include <build_config.hxx>
 
+namespace couchbase
+{
+constexpr auto BACKEND_BUILD_TIMESTAMP = "@BACKEND_BUILD_TIMESTAMP@";
+constexpr auto BACKEND_CXX_COMPILER = "@CMAKE_CXX_COMPILER_ID@ @CMAKE_CXX_COMPILER_VERSION@";
+constexpr auto BACKEND_C_COMPILER = "@CMAKE_C_COMPILER_ID@ @CMAKE_C_COMPILER_VERSION@";
+constexpr auto BACKEND_SYSTEM = "@CMAKE_SYSTEM@";
+constexpr auto BACKEND_SYSTEM_PROCESSOR = "@CMAKE_SYSTEM_PROCESSOR@";
+constexpr auto BACKEND_GIT_REVISION = "a79d098eb238b3883e49e1738c35167642e8834f";
+} // namespace couchbase