couchbase 3.0.0.alpha.2 → 3.0.0.alpha.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd8c352b8e6f1752e4a465be62889b7d00f89fa6dbb217ceb6a2fbcff601d4c2
-  data.tar.gz: 232734648d18dddac6acbc8f5ea1b3d40cec2efa1ef2e021e568b4491152cfcd
+  metadata.gz: 14fb151cf764b9a7d9550d43dc17749b354d08407e0b47facd30b662893e8fd7
+  data.tar.gz: e38fe6aa52f37a4a1914d73291696de7b22146635e7c138525216618428f4642
 SHA512:
-  metadata.gz: ec3182ef85d573758801b9ed34ad034c441b247fe9aa52c23b8fead63671572ec338fa8c735c0194464d957d0eb0eddcc64aa4e300b83f40bb02a8a0dcf8d074
-  data.tar.gz: 35973818ce61c6b8a1d984125bcf5398940566d5f8f0d16b280fcdf7e2e5eea3c1dddf4cd2d9ee16b0ddff0d85933f683759996ed4feb6660f8279cf0213e19f
+  metadata.gz: 4008f666a840187479ddf68a4fd61ae53c30be3cdd3a69b73ff5acf5e97493b596f9ddfe943d0a1bdcf5495afdedb21c9504796ef07ce3fff8244aa6928cd1dd
+  data.tar.gz: 8d09ec6c24df6a1080e845f9056330edc0d13081bbed689f6357b1b9fb2fd093bb81e5bcd29c047187e714b21d7ffdbf8eb78588c308f6be059f221cb5872950

data/.github/workflows/tests-dev-preview.yml

@@ -0,0 +1,52 @@
+name: tests-dev-preview
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    services:
+      couchbase:
+        image: couchbase:enterprise-6.5.1
+        ports:
+          - 8091-8094:8091-8094
+          - 11210:11210
+
+    steps:
+      - name: Install build environment
+        run: sudo apt-get install -y libssl-dev cmake gcc g++ curl
+
+      - uses: actions/checkout@v2
+        with:
+          submodules: recursive
+
+      - name: Set up ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Initialize couchbase
+        run: ./bin/init-cluster
+        env:
+          DEVELOPER_PREVIEW: yes
+
+      - name: Compile extension
+        run: bundle exec rake compile
+
+      - name: Display library version
+        run: bundle exec ruby -I lib -r couchbase -e 'pp Couchbase::VERSION'
+
+      - name: Run tests
+        run: bundle exec rake test
+        env:
+          DEVELOPER_PREVIEW: yes
+          TEST_SERVER_VERSION: 6.5.1

data/.gitmodules

@@ -16,3 +16,6 @@
 [submodule "ext/third_party/snappy"]
 	path = ext/third_party/snappy
 	url = git://github.com/google/snappy.git
+[submodule "test_data/sdk_test_cases"]
+	path = test_data/sdk_test_cases
+	url = git://github.com/couchbaselabs/sdk-testcases

data/.idea/vcs.xml

@@ -8,5 +8,6 @@
     <mapping directory="$PROJECT_DIR$/ext/third_party/json" vcs="Git" />
     <mapping directory="$PROJECT_DIR$/ext/third_party/snappy" vcs="Git" />
     <mapping directory="$PROJECT_DIR$/ext/third_party/spdlog" vcs="Git" />
+    <mapping directory="$PROJECT_DIR$/test_data/sdk_test_cases" vcs="Git" />
   </component>
 </project>

data/.yardopts

@@ -0,0 +1 @@
+--output-dir doc/couchbase-ruby-client-master lib - README.md

data/README.md

@@ -16,7 +16,7 @@ Please attach version information to ticket/post. To obtain this information use
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "couchbase", "3.0.0.alpha.2"
+gem "couchbase", "3.0.0.alpha.3"
 ```
 
 And then execute:

data/Rakefile

@@ -33,12 +33,16 @@ task :doc do
   input_dir = File.join(__dir__, "lib")
   output_dir = File.join(__dir__, "doc", "couchbase-ruby-client-#{Couchbase::VERSION[:sdk]}")
   rm_rf output_dir
-  sh "yard doc --output-dir #{output_dir} #{input_dir}"
+  sh "yard doc --output-dir #{output_dir} #{input_dir} - README.md"
   puts "#{File.realpath(output_dir)}/index.html"
 end
 
 task :docs => :doc
 
+task :undocumented => :doc do
+  sh "yard stats --list-undoc --compact"
+end
+
 task :render_git_revision do
   build_version_path = File.join(__dir__, 'ext', 'build_version.hxx.in')
   File.write(build_version_path, File.read(build_version_path).gsub('@BACKEND_GIT_REVISION@', `git rev-parse HEAD`.strip))

data/bin/init-cluster

@@ -14,9 +14,12 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
-HOST="localhost"
-USERNAME="Administrator"
-PASSWORD="password"
+HOST=${HOST:-localhost}
+USERNAME=${USERNAME:-Administrator}
+PASSWORD=${PASSWOWRD:-password}
+QUOTA=${QUOTA:-256}
+DEVELOPER_PREVIEW=${DEVELOPER_PREVIEW:-no}
+
 CREDS="${USERNAME}:${PASSWORD}"
 
 sleep 1
@@ -33,11 +36,11 @@ curl -sS -w "\n" -u ${CREDS} http://${HOST}:8091/nodes/self/controller/settings
 
 # Setup Services
 curl -sS -w "\n" -u ${CREDS} http://${HOST}:8091/node/controller/setupServices \
-     -d 'services=kv%2Cn1ql%2Cindex'
+     -d 'services=kv%2Cn1ql%2Cindex%2Cfts'
 
 # Setup Memory Quotas
 curl -sS -w "\n" -u ${CREDS} http://${HOST}:8091/pools/default \
-  -d 'memoryQuota=256' \
+  -d "memoryQuota=${QUOTA}" \
   -d 'indexMemoryQuota=256'
 
 # Setup Administrator username and password
@@ -60,3 +63,8 @@ curl -sS -w "\n" -u ${CREDS} http://${HOST}:8091/pools/default/buckets \
      -d 'ramQuotaMB=100' \
      -d 'bucketType=membase' \
      -d 'name=default'
+
+if [ "x${DEVELOPER_PREVIEW}" != "xno" ]; then
+curl -sS -w "\n" -u ${CREDS} http://${HOST}:8091/settings/developerPreview \
+     -d "enabled=true"
+fi

data/couchbase.gemspec

@@ -29,9 +29,10 @@ Gem::Specification.new do |spec|
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/couchbase/couchbase-ruby-client"
   spec.metadata["changelog_uri"] = "#{spec.metadata["source_code_uri"]}/releases"
+  spec.metadata["github_repo"] = "ssh://github.com/couchbase/couchbase-ruby-client"
 
   spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
-    `git ls-files --recurse-submodules -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files --recurse-submodules -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|test_data)/}) }
   end
   spec.bindir = "exe"
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }

data/examples/managing_query_indexes.rb

@@ -28,7 +28,7 @@ bucket_name = "beer-sample"
 
 options = Cluster::ClusterOptions.new
 options.authenticate("Administrator", "password")
-cluster = Cluster.connect("couchbase://192.168.42.101", options)
+cluster = Cluster.connect("couchbase://localhost", options)
 
 display_indexes(cluster.query_indexes.get_all_indexes(bucket_name), bucket_name)
 

data/examples/managing_search_indexes.rb

@@ -0,0 +1,62 @@
+require "couchbase"
+include Couchbase
+
+def measure(msg)
+  start = Time.now
+  yield
+  printf "%s in %.2f seconds\n", msg, Time.now - start
+end
+
+options = Cluster::ClusterOptions.new
+options.authenticate("Administrator", "password")
+cluster = Cluster.connect("couchbase://localhost", options)
+
+search_indexes = cluster.search_indexes.get_all_indexes
+puts "There are #{search_indexes.size} search indexes on the cluster"
+search_indexes.each do |index|
+  num_docs = cluster.search_indexes.get_indexed_documents_count(index.name)
+  puts "* #{index.name.inspect} contains #{num_docs} documents"
+end
+
+search_index_name = "my_index"
+begin
+  index = cluster.search_indexes.get_index(search_index_name)
+  measure("index #{index.name.inspect} has been dropped") do
+    cluster.search_indexes.drop_index(index.name)
+  end
+rescue Error::IndexNotFound
+  # Ignored
+end
+
+index = Management::SearchIndex.new
+index.type = "fulltext-index"
+index.name = search_index_name
+index.source_type = "couchbase"
+index.source_name = "beer-sample"
+
+measure("index #{search_index_name.inspect} has been created") do
+  cluster.search_indexes.upsert_index(index)
+end
+num_indexed = 0
+loop do
+  sleep(1)
+  num = cluster.search_indexes.get_indexed_documents_count(search_index_name)
+  break if num_indexed == num
+  num_indexed = num
+  puts "#{index.name.inspect} indexed #{num_indexed}"
+end
+
+search_indexes = cluster.search_indexes.get_all_indexes
+puts "There are #{search_indexes.size} search indexes on the cluster"
+search_indexes.each do |index|
+  num_docs = cluster.search_indexes.get_indexed_documents_count(index.name)
+  puts "* #{index.name.inspect} contains #{num_docs} documents"
+end
+
+document = {
+    title: "Hello world",
+    content: "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."
+}
+analysis = cluster.search_indexes.analyze_document(search_index_name, document)
+puts "Analysis of document using definition of the index #{search_index_name}:"
+pp analysis

data/examples/search.rb

@@ -0,0 +1,187 @@
+require 'couchbase'
+
+include Couchbase
+
+options = Cluster::ClusterOptions.new
+options.authenticate("Administrator", "password")
+cluster = Cluster.connect("couchbase://localhost", options)
+
+# create index definition, if it does not exist already
+search_index_name = "beer_search"
+
+begin
+  cluster.search_indexes.get_index(search_index_name)
+rescue Error::IndexNotFound
+  index = Management::SearchIndex.new
+  index.type = "fulltext-index"
+  index.name = search_index_name
+  index.source_type = "couchbase"
+  index.source_name = "beer-sample"
+  index.params = {
+      mapping: {
+          default_datetime_parser: "dateTimeOptional",
+          types: {
+              "beer" => {
+                  properties: {
+                      "abv" => {
+                          fields: [
+                              {
+                                  name: "abv",
+                                  type: "number",
+                                  include_in_all: true,
+                                  index: true,
+                                  store: true,
+                                  docvalues: true,
+                              }
+                          ]
+                      },
+                      "category" => {
+                          fields: [
+                              {
+                                  name: "category",
+                                  type: "text",
+                                  include_in_all: true,
+                                  include_term_vectors: true,
+                                  index: true,
+                                  store: true,
+                                  docvalues: true,
+                              }
+                          ]
+                      },
+                      "description" => {
+                          fields: [
+                              {
+                                  name: "description",
+                                  type: "text",
+                                  include_in_all: true,
+                                  include_term_vectors: true,
+                                  index: true,
+                                  store: true,
+                                  docvalues: true,
+                              }
+                          ]
+                      },
+                      "name" => {
+                          fields: [
+                              {
+                                  name: "name",
+                                  type: "text",
+                                  include_in_all: true,
+                                  include_term_vectors: true,
+                                  index: true,
+                                  store: true,
+                                  docvalues: true,
+                              }
+                          ]
+                      },
+                      "style" => {
+                          fields: [
+                              {
+                                  name: "style",
+                                  type: "text",
+                                  include_in_all: true,
+                                  include_term_vectors: true,
+                                  index: true,
+                                  store: true,
+                                  docvalues: true,
+                              }
+                          ]
+                      },
+                      "updated" => {
+                          fields: [
+                              {
+                                  name: "updated",
+                                  type: "datetime",
+                                  include_in_all: true,
+                                  index: true,
+                                  store: true,
+                                  docvalues: true,
+                              }
+                          ]
+                      },
+                  }
+              }
+          }
+      }
+  }
+
+  cluster.search_indexes.upsert_index(index)
+
+  num_indexed = 0
+  loop do
+    sleep(1)
+    num = cluster.search_indexes.get_indexed_documents_count(search_index_name)
+    break if num_indexed == num
+    num_indexed = num
+    puts "indexing #{search_index_name.inspect}: #{num_indexed} documents"
+  end
+end
+
+# search with facets advanced sort
+query = Cluster::SearchQuery.match_phrase("hop beer")
+options = Cluster::SearchOptions.new
+options.limit = 10
+options.fields = %w[name]
+options.highlight_style = :html
+options.highlight_fields = %w[name description]
+options.sort = [
+    Cluster::SearchSort.field("abv") do |spec|
+      spec.type = :number
+    end,
+    Cluster::SearchSort.score do |spec|
+      spec.desc = true
+    end,
+    "category",
+    Cluster::SearchSort.id,
+]
+
+res = cluster.search_query(search_index_name, query, options)
+res.rows.each_with_index do |row, idx|
+  document = row.fields
+  puts "\n#{idx}. #{document["name"]} (id: #{row.id.inspect})"
+  row.fragments.each do |field, fragments|
+    puts "  * #{field}"
+    fragments.each do |fragment|
+      puts "      - #{fragment.gsub(/\n/, ' ')}"
+    end
+  end
+end
+
+# search with facets
+query = Cluster::SearchQuery.term("beer")
+query.field = "type"
+
+options = Cluster::SearchOptions.new
+options.facets = {}
+
+term_facet = Cluster::SearchFacet.term("name")
+term_facet.size = 3
+options.facets["by_name"] = term_facet
+
+date_facet = Cluster::SearchFacet.date_range("updated")
+date_facet.add("old", nil, Time.new(2013, 1, 1))
+date_facet.size = 3
+options.facets["by_time"] = date_facet
+
+numeric_facet = Cluster::SearchFacet.numeric_range("abv")
+numeric_facet.size = 3
+numeric_facet.add("strong", 4.9, nil)
+numeric_facet.add("light", nil, 4.89)
+options.facets["by_strength"] = numeric_facet
+
+res = cluster.search_query(search_index_name, query, options)
+
+puts "\n==== Top 3 beer names (out of #{res.facets["by_name"].total}):"
+res.facets["by_name"].terms.each_with_index do |term, idx|
+  puts "#{idx}. #{term.term} (#{term.count} records)"
+end
+
+puts "\n==== Beer by strength (out of #{res.facets["by_strength"].total}):"
+res.facets["by_strength"].numeric_ranges.each_with_index do |range, idx|
+  puts "#{idx}. #{range.name}, ABV: [#{range.min}..#{range.max}] (#{range.count} records)"
+end
+
+puts "\n==== The most recently updated (out of #{res.facets["by_time"].total}):"
+res.facets["by_time"].date_ranges.each_with_index do |range, idx|
+  puts "#{idx}. #{range.name} [#{range.start_time}..#{range.end_time}] (#{range.count} records)"
+end

data/ext/.clang-tidy

@@ -17,4 +17,5 @@ Checks: |-
   -cppcoreguidelines-avoid-magic-numbers,
   -cppcoreguidelines-pro-bounds-pointer-arithmetic,
   -modernize-use-trailing-return-type,
+  -llvmlibc-callee-namespace,
   -fuchsia-*

data/ext/build_version.hxx.in

@@ -22,5 +22,5 @@
 #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 "5b91db73c89347cfb4985490051aea4d82f56c0e"
+#define BACKEND_GIT_REVISION "86b887957baf7230bfbe853de48b4507b9c2c18d"
 

data/ext/couchbase/bucket.hxx

@@ -24,7 +24,6 @@
 
 namespace couchbase
 {
-
 class bucket
 {
   public:
@@ -51,16 +50,6 @@ class bucket
             return;
         }
 
-        auto session_manifest = session->manifest();
-        if (!manifest_cache_) {
-            if (session_manifest) {
-                manifest_cache_ = session_manifest.value();
-            }
-        } else {
-            if (session_manifest && session_manifest->uid > manifest_cache_->uid) {
-                manifest_cache_ = session->manifest().value();
-            }
-        }
         sessions_.emplace(index, std::move(session));
     }
 
@@ -81,14 +70,6 @@ class bucket
         size_t index = 0;
         std::tie(request.partition, index) = config_.map_key(request.id.key);
         auto session = sessions_.at(index);
-        if (manifest_cache_) {
-            request.id.collection_uid = get_collection_uid(request.id.collection);
-        } else {
-            if (!request.id.collection.empty() && request.id.collection != "_default._default") {
-                handler(make_response(std::make_error_code(error::common_errc::unsupported_operation), request, {}));
-                return;
-            }
-        }
         auto cmd = std::make_shared<operations::command<Request>>(ctx_, std::move(request));
         cmd->send_to(session, std::forward<Handler>(handler));
     }
@@ -105,32 +86,11 @@ class bucket
     }
 
   private:
-    [[nodiscard]] uint32_t get_collection_uid(const std::string& collection_path)
-    {
-        Expects(manifest_cache_.has_value());
-        Expects(!collection_path.empty());
-        auto dot = collection_path.find('.');
-        Expects(dot != std::string::npos);
-        std::string scope = collection_path.substr(0, dot);
-        std::string collection = collection_path.substr(dot + 1);
-        for (const auto& s : manifest_cache_->scopes) {
-            if (s.name == scope) {
-                for (const auto& c : s.collections) {
-                    if (c.name == collection) {
-                        return gsl::narrow_cast<std::uint32_t>(c.uid);
-                    }
-                }
-            }
-        }
-        Ensures(false); // FIXME: return collection not found
-        return 0;
-    }
 
     asio::io_context& ctx_;
     std::string name_;
     configuration config_;
     bool closed_{ false };
-    std::optional<collections_manifest> manifest_cache_{};
     std::map<size_t, std::shared_ptr<io::mcbp_session>> sessions_{};
 };
 } // namespace couchbase