couchbase 3.0.0.beta.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e71b3d69cab6a09f02460f5b983a908c256a76e12dd68f57fab9173c6a50d0e
-  data.tar.gz: b58766149d745a869828fe7f2f04f56182560de48a3365b95b253313f7f428c4
+  metadata.gz: 241594e3c8b47ca837a1eb6ef09c83bb5e1babdac18869a9b66bf821bf77c882
+  data.tar.gz: 0cf2f466bf600b6908e34ed7a495a9738cd74bed7f5ee7b83afaf3053a99aad1
 SHA512:
-  metadata.gz: 12b4ab101a664897933c2ca98841c1d7cd27c6b5a15653eb2b48e59eba69f76f431ce25b316eba392ad8f104cdcde0fa44b38004a341e316141d821a7256c852
-  data.tar.gz: 4a1723022980425bc7b0a907d5487ae72c654d29709f1137a32349a98eab7e11f23d75a95414df60a35097e9eae4cd9ec2414d184877b95c06f62cb97825770a
+  metadata.gz: 9e9257498ef7c86c9b8ba6473a28ac55f4d725f56b818835904373a2ba934cdb7a5333eb6c978746954b1e98016250c2710d875eda8e6c45240ba468c5d1a0b4
+  data.tar.gz: cd31b914bd512515efd067aea2baff1ca0cfaa5bb5b7eebd96c1fd3fe12999811876f045c111b91d90565abb82306ef560a262e5f770ff3b7209e231a25be3b8

data/.rubocop.yml

@@ -0,0 +1,227 @@
+inherit_from: .rubocop_todo.yml
+require:
+  - rubocop-performance
+  - rubocop-minitest
+
+AllCops:
+  TargetRubyVersion: 2.5
+
+Layout/LineLength:
+  Max: 140
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+  EnforcedStyleForEmptyBraces: no_space
+
+Style/Copyright:
+  Enabled: true
+  Notice: 'Copyright .*2020 Couchbase, Inc.'
+  AutocorrectNotice: 'Copyright 2020 Couchbase, Inc.'
+
+Style/Lambda:
+  EnforcedStyle: lambda
+
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+Style/RegexpLiteral:
+  EnforcedStyle: mixed
+  AllowInnerSlashes: true
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Lint/BinaryOperatorWithIdenticalOperands:
+  Enabled: true
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+
+Lint/DuplicateElsifCondition:
+  Enabled: true
+
+Lint/DuplicateRescueException:
+  Enabled: true
+
+Lint/EmptyConditionalBody:
+  Enabled: true
+
+Lint/FloatComparison:
+  Enabled: true
+
+Lint/MissingSuper:
+  Enabled: true
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+
+Lint/OutOfRangeRegexpRef:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/SelfAssignment:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Lint/TopLevelReturnWithArgument:
+  Enabled: true
+
+Lint/UnreachableLoop:
+  Enabled: true
+
+Style/ArrayCoercion:
+  Enabled: true
+
+Style/BisectedAttrAccessor:
+  Enabled: true
+
+Style/CaseLikeIf:
+  Enabled: true
+
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/GlobalStdStream:
+  Enabled: true
+
+Style/HashAsLastArrayItem:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashLikeCase:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/OptionalBooleanParameter:
+  Enabled: true
+
+Style/RedundantAssignment:
+  Enabled: true
+
+Style/RedundantFetchBlock:
+  Enabled: true
+
+Style/RedundantFileExtensionInRequire:
+  Enabled: true
+
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+
+Style/RedundantRegexpEscape:
+  Enabled: true
+
+Style/SingleArgumentDig:
+  Enabled: true
+
+Style/SlicingWithRange:
+  Enabled: true
+
+Style/StringConcatenation:
+  Enabled: true
+
+Performance/AncestorsInclude:
+  Enabled: true
+
+Performance/BigDecimalWithNumericArgument:
+  Enabled: true
+
+Performance/RedundantSortBlock:
+  Enabled: true
+
+Performance/RedundantStringChars:
+  Enabled: true
+
+Performance/ReverseFirst:
+  Enabled: true
+
+Performance/SortReverse:
+  Enabled: true
+
+Performance/Squeeze:
+  Enabled: true
+
+Performance/StringInclude:
+  Enabled: true
+
+Minitest/AssertInDelta:
+  Enabled: true
+
+Minitest/AssertionInLifecycleHook:
+  Enabled: true
+
+Minitest/AssertKindOf:
+  Enabled: true
+
+Minitest/AssertOutput:
+  Enabled: true
+
+Minitest/AssertPathExists:
+  Enabled: true
+
+Minitest/AssertSilent:
+  Enabled: true
+
+Minitest/LiteralAsActualArgument:
+  Enabled: true
+
+Minitest/RefuteInDelta:
+  Enabled: true
+
+Minitest/RefuteKindOf:
+  Enabled: true
+
+Minitest/RefutePathExists:
+  Enabled: true
+
+Minitest/TestMethodName:
+  Enabled: true
+
+Minitest/UnspecifiedException:
+  Enabled: true
+
+Lint/DuplicateRequire:
+  Enabled: true
+
+Lint/EmptyFile:
+  Enabled: true
+
+Lint/TrailingCommaInAttributeDeclaration:
+  Enabled: true
+
+Lint/UselessMethodDefinition:
+  Enabled: true
+
+Style/CombinableLoops:
+  Enabled: true
+
+Style/KeywordParametersOrder:
+  Enabled: true
+
+Style/RedundantSelfAssignment:
+  Enabled: true
+
+Style/SoleNestedConditional:
+  Enabled: true

data/.rubocop_todo.yml

@@ -0,0 +1,47 @@
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/HashSyntax:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Naming/AccessorMethodName:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Naming/PredicateName:
+  Enabled: false
+
+Style/AccessorGrouping:
+  Enabled: false
+
+Style/ExplicitBlockArgument:
+  Enabled: false
+
+Minitest/MultipleAssertions:
+  Enabled: false

data/CONTRIBUTING.md

@@ -0,0 +1,110 @@
+# Contributing
+
+In addition to filing bugs, you may contribute by submitting patches to fix bugs in the library.  Contributions may be
+submitting to http://review.couchbase.com.
+
+We use Gerrit as our code review system --- and thus submitting a change requires an account there.  Note that pull
+requests will not be ignored but will be responded to more quickly and with more detail in Gerrit.
+
+For something to be accepted into the codebase, it must be formatted properly and have undergone proper testing.
+We use `rubocop` for linting with a configuration stored in `.rubocop.yml`.
+
+To install and use the linter you can use `./bin/setup` and then run `rubocop` in the project root directory.
+
+## Branches and Tags
+
+Released versions of the library are marked as annotated tags inside the repository.
+
+* The `master` branch represents the mainline branch. The master branch typically consists of content going into the
+  next release.
+
+## Contributing Patches
+
+If you wish to contribute a new feature or a bug fix to the library, try to follow the following guidelines to help
+ensure your change gets merged upstream.
+
+### Before you begin
+
+For any code change, ensure the new code you write looks similar to the code surrounding it and that linting does not
+produce errors.
+
+If your change is going to involve a substantial amount of time or effort, please attempt to discuss it with the project
+developers first who will provide assistance and direction where possible.
+
+#### For new features
+
+Ensure the feature you are adding does not already exist, and think about how this feature may be useful for other users.
+In general less intrusive changes are more likely to be accepted.
+
+#### For fixing bugs
+
+Ensure the bug you are fixing is actually a bug (and not a usage error), and that it has not been fixed in a more recent
+version. Please read the release notes as well as the issue tracker to see a list of open and resolved issues.
+
+### Code Review
+
+#### Signing up on Gerrit
+
+Everything that is merged into the library goes through a code review process.  The code review process is done via
+[Gerrit](https://review.couchbase.org).
+
+To sign up for a gerrit account, go to https://review.couchbase.org and click on the _Register_ link at the top right.
+Once you've signed in you will need to agree to the CLA (Contributor License Agreement) by going you your gerrit
+account page and selecting the _Agreements_ link on the left.
+
+When you've done that, everything should flow through just fine.
+
+Be sure that you have registered your email address at http://review.couchbase.org/#/settings/contact as many sign-up
+methods won't pass emails along.
+
+Note that your email address in your code commit and in the gerrit settings must match.
+
+Add your public SSH key to gerrit before submitting.
+
+#### Setting up your fork with Gerrit
+
+Assuming you have a repository created like so:
+
+```
+$ git clone git://github.com/couchbase/couchbase-ruby-client.git
+```
+
+you can simply perform two simple steps to get started with gerrit:
+
+```
+$ git remote add gerrit ssh://${USERNAME}@review.couchbase.org:29418/couchbase-ruby-client
+
+$ scp -P 29418 ${USERNAME}@review.couchbase.org:hooks/commit-msg .git/hooks
+$ chmod a+x .git/hooks/commit-msg
+```
+
+The last change is required for annotating each commit message with a special header known as `Change-Id`.
+This allows Gerrit to group together different revisions of the same patch.
+
+#### Pushing a changeset
+
+Now that you have your change and a gerrit account to push to, you need to upload the change for review.
+To do so, invoke the following incantation:
+
+```
+$ git push gerrit HEAD:refs/for/master
+```
+
+Where `gerrit` is the name of the _remote_ added earlier.
+You may encounter some errors when pushing.
+The most common are:
+
+* "You are not authorized to push to this repository".
+  You will get this if your account has not yet been approved.
+  Feel free to ask about in gitter.im/couchbase or in the forums for help if blocked.
+
+* "Missing Change-Id". You need to install the `commit-msg` hook as described above.
+  Note that even once you do this, you will need to ensure that any prior commits already have this header --- this may be
+  done by doing an interactive rebase (e.g.  `git rebase -i origin/master` and selecting `reword` for all the commits;
+  which will automatically fillin the Change-Id).
+
+
+Once you've pushed your changeset you can add people to review.
+Currently these are:
+
+* Sergey Avseyev

data/Gemfile

@@ -20,6 +20,10 @@ gemspec
 gem "rake"
 
 group :development do
+  gem "rubocop"
+  gem "rubocop-minitest"
+  gem "rubocop-performance"
+  gem "standard"
   gem "yard"
   platforms :mri do
     gem "byebug"

data/README.md

@@ -1,4 +1,4 @@
-# Couchbase Ruby Client [![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 [![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)
 
 This repository contains the third generation of the official Couchbase SDK for Ruby (aka. SDKv3)
 
@@ -18,7 +18,7 @@ The library tested with the MRI 2.5, 2.6 and 2.7. Supported platforms are Linux
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "couchbase", "3.0.0.beta.1"
+gem "couchbase", "3.0.0"
 ```
 
 And then execute:
@@ -27,7 +27,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install --pre couchbase
+    $ gem install couchbase
 
 For some platforms we precompile binary packages. When, for some reason, binary package cannot be used, pass
 `--platform=ruby` to `gem install` command (or check `specific_platform` and `force_ruby_platform` options of Bundler).

data/Rakefile

@@ -24,7 +24,7 @@ end
 task :compile do
   require 'tempfile'
   Dir.chdir(Dir.tmpdir) do
-    sh "ruby #{File.join(__dir__, "ext", "extconf.rb")}"
+    sh "ruby #{File.join(__dir__, 'ext', 'extconf.rb')}"
   end
 end
 

data/couchbase.gemspec

@@ -12,7 +12,7 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "couchbase/version"
 
@@ -25,53 +25,54 @@ Gem::Specification.new do |spec|
   spec.description = "Modern SDK for Couchbase Server"
   spec.homepage = "https://www.couchbase.com"
   spec.license = "Apache-2.0"
+  spec.required_ruby_version = "~> 2.5"
 
   spec.metadata = {
-      "homepage_uri" => "https://docs.couchbase.com/ruby-sdk/3.0/hello-world/start-using-sdk.html",
-      "bug_tracker_uri" => "https://couchbase.com/issues/browse/RCBC",
-      "mailing_list_uri" => "https://forums.couchbase.com/c/ruby-sdk",
-      "source_code_uri" => "https://github.com/couchbasse/couchbase-ruby-client/tree/#{spec.version}",
-      "changelog_uri" => "https://github.com/couchbase/couchbase-ruby-client/releases/tag/#{spec.version}",
-      "documentation_uri" => "https://docs.couchbase.com/sdk-api/couchbase-ruby-client-#{spec.version}/index.html",
-      "github_repo" => "ssh://github.com/couchbase/couchbase-ruby-client",
+    "homepage_uri" => "https://docs.couchbase.com/ruby-sdk/3.0/hello-world/start-using-sdk.html",
+    "bug_tracker_uri" => "https://couchbase.com/issues/browse/RCBC",
+    "mailing_list_uri" => "https://forums.couchbase.com/c/ruby-sdk",
+    "source_code_uri" => "https://github.com/couchbase/couchbase-ruby-client/tree/#{spec.version}",
+    "changelog_uri" => "https://github.com/couchbase/couchbase-ruby-client/releases/tag/#{spec.version}",
+    "documentation_uri" => "https://docs.couchbase.com/sdk-api/couchbase-ruby-client-#{spec.version}/index.html",
+    "github_repo" => "ssh://github.com/couchbase/couchbase-ruby-client",
   }
 
-  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     exclude_paths = %w[
-        .idea
-        .github
-        .gitignore
-        .gitmodules
-        bin
-        test
-        spec
-        features
-        test_data
-        ext/third_party/asio/asio/src/examples
-        ext/third_party/asio/asio/src/tests
-        ext/third_party/asio/asio/src/tools
-        ext/third_party/gsl/tests
-        ext/third_party/http_parser/contrib
-        ext/third_party/http_parser/fuzzers
-        ext/third_party/json/contrib
-        ext/third_party/json/doc
-        ext/third_party/json/src/example
-        ext/third_party/json/src/perf
-        ext/third_party/json/src/test
-        ext/third_party/json/tests
-        ext/third_party/snappy/testdata
-        ext/third_party/spdlog/bench
-        ext/third_party/spdlog/example
-        ext/third_party/spdlog/logos
-        ext/third_party/spdlog/scripts
-        ext/third_party/spdlog/tests
+      .idea
+      .github
+      .gitignore
+      .gitmodules
+      bin
+      test
+      spec
+      features
+      test_data
+      ext/third_party/asio/asio/src/examples
+      ext/third_party/asio/asio/src/tests
+      ext/third_party/asio/asio/src/tools
+      ext/third_party/gsl/tests
+      ext/third_party/http_parser/contrib
+      ext/third_party/http_parser/fuzzers
+      ext/third_party/json/contrib
+      ext/third_party/json/doc
+      ext/third_party/json/src/example
+      ext/third_party/json/src/perf
+      ext/third_party/json/src/test
+      ext/third_party/json/tests
+      ext/third_party/snappy/testdata
+      ext/third_party/spdlog/bench
+      ext/third_party/spdlog/example
+      ext/third_party/spdlog/logos
+      ext/third_party/spdlog/scripts
+      ext/third_party/spdlog/tests
     ]
     `git ls-files --recurse-submodules -z`
-        .split("\x0")
-        .reject { |f| f.match(%r{^(#{Regexp.union(exclude_paths)})}) }
+      .split("\x0")
+      .reject { |f| f.match?(/^(#{Regexp.union(exclude_paths)})/) }
   end
   spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.executables = spec.files.grep(/^exe\//) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
   spec.extensions = ["ext/extconf.rb"]
   spec.rdoc_options << "--exclude" << "ext/"