Rubocop fixes

.github/workflows/linters.yml

@@ -18,11 +18,13 @@ jobs:
       - name: Set up ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.0
+          ruby-version: 3.3
       - name: Install dependencies
         run: bundle install
       - name: Run rubocop
-        run: bundle exec rubocop
+        run: |
+          bundle exec rubocop -v
+          bundle exec rubocop
 
   clang_format:
     runs-on: ubuntu-20.04
@@ -54,7 +56,7 @@ jobs:
       - name: Set up ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.0
+          ruby-version: 3.3
       - name: Install dependencies
         run: |
           sudo apt-get update -y

bin/console

@@ -20,7 +20,7 @@ require "irb"
 require "open3"
 require "couchbase"
 
-include Couchbase # rubocop:disable Style/MixinUsage for brevity
+include Couchbase # rubocop:disable Style/MixinUsage -- for brevity
 
 customer123 = {
   "name" => "Douglas Reynholm",
@@ -105,4 +105,4 @@ alias collection default_collection
 #   cluster             # returns connected cluster
 #   default_collection  # returns default collection (accept bucket name, defaults to "default")
 #   customer123         # returns sample document
-binding.irb # rubocop:disable Lint/Debugger start REPL
+binding.irb # rubocop:disable Lint/Debugger -- start REPL

bin/init-cluster

@@ -39,7 +39,7 @@ options = {
   sample_buckets: Set.new,
 }
 default_port = options[:strict_encryption] ? 18091 : 8091
-if (options[:cluster_run_nodes]).positive?
+if options[:cluster_run_nodes].positive?
   default_port = options[:strict_encryption] ? 19000 : 9000
 end
 options[:port] = ENV.fetch("CB_PORT", default_port).to_i

bin/jenkins/check-rubocop

@@ -40,4 +40,5 @@ chruby ruby-${CB_RUBY_VERSION}
 bundle config set --local path ${PROJECT_ROOT}/vendor/bundle
 
 bundle install
+bundle exec rubocop -v
 bundle exec rubocop

examples/analytics.rb

@@ -16,9 +16,9 @@
 
 require "couchbase"
 
-include Couchbase # rubocop:disable Style/MixinUsage for brevity
+include Couchbase # rubocop:disable Style/MixinUsage -- for brevity
 
-options = Cluster::ClusterOptions.new
+options = Options::Cluster.new
 options.authenticate("Administrator", "password")
 cluster = Cluster.connect("couchbase://localhost", options)
 
@@ -202,7 +202,7 @@
 
 # Named parameters
 puts "---- named parameters"
-options = Cluster::AnalyticsOptions.new
+options = Options::Analytics.new
 options.named_parameters({user_id: 2})
 res = cluster.analytics_query("
 USE #{dataverse_name};
@@ -223,7 +223,7 @@
 
 # Positional parameters
 puts "---- positional parameters"
-options = Cluster::AnalyticsOptions.new
+options = Options::Analytics.new
 options.positional_parameters([2])
 res = cluster.analytics_query("
 USE #{dataverse_name};

examples/auth.rb

@@ -15,9 +15,9 @@
 #  limitations under the License.
 
 require "couchbase"
-include Couchbase # rubocop:disable Style/MixinUsage for brevity
+include Couchbase # rubocop:disable Style/MixinUsage -- for brevity
 
-options = Cluster::ClusterOptions.new
+options = Options::Cluster.new
 # initializes {PasswordAuthenticator} internally
 options.authenticate("Administrator", "password")
 Cluster.connect("couchbase://localhost", options)

examples/crud.rb

@@ -15,9 +15,9 @@
 #  limitations under the License.
 
 require "couchbase"
-include Couchbase # rubocop:disable Style/MixinUsage for brevity
+include Couchbase # rubocop:disable Style/MixinUsage -- for brevity
 
-options = Cluster::ClusterOptions.new
+options = Options::Cluster.new
 
 options.authenticate("Administrator", "password")
 cluster = Cluster.connect("couchbase://localhost", options)

examples/managing_analytics_indexes.rb

@@ -15,15 +15,15 @@
 #  limitations under the License.
 
 require "couchbase"
-include Couchbase # rubocop:disable Style/MixinUsage for brevity
+include Couchbase # rubocop:disable Style/MixinUsage -- for brevity
 
 def measure(msg)
   start = Time.now
   yield
   printf "%<msg>s in %<elapsed>.2f seconds\n", msg: msg, elapsed: Time.now - start
 end
 
-options = Cluster::ClusterOptions.new
+options = Options::Cluster.new
 options.authenticate("Administrator", "password")
 cluster = Cluster.connect("couchbase://localhost", options)
 

examples/managing_buckets.rb

@@ -15,15 +15,15 @@
 #  limitations under the License.
 
 require "couchbase"
-include Couchbase # rubocop:disable Style/MixinUsage for brevity
+include Couchbase # rubocop:disable Style/MixinUsage -- for brevity
 
 def measure(msg)
   start = Time.now
   yield
   printf "%<msg>s in %<elapsed>.2f seconds\n", msg: msg, elapsed: Time.now - start
 end
 
-options = Cluster::ClusterOptions.new
+options = Options::Cluster.new
 options.authenticate("Administrator", "password")
 cluster = Cluster.connect("couchbase://localhost", options)
 

examples/managing_collections.rb

@@ -15,7 +15,7 @@
 #  limitations under the License.
 
 require "couchbase"
-include Couchbase # rubocop:disable Style/MixinUsage for brevity
+include Couchbase # rubocop:disable Style/MixinUsage -- for brevity
 
 def measure(msg)
   start = Time.now
@@ -26,7 +26,7 @@ def measure(msg)
 bucket_name = "travel-sample"
 scope_name = "myapp"
 
-options = Cluster::ClusterOptions.new
+options = Options::Cluster.new
 options.authenticate("Administrator", "password")
 cluster = Cluster.connect("couchbase://localhost", options)
 bucket = cluster.bucket(bucket_name)

examples/managing_query_indexes.rb

@@ -15,7 +15,7 @@
 #  limitations under the License.
 
 require "couchbase"
-include Couchbase # rubocop:disable Style/MixinUsage for brevity
+include Couchbase # rubocop:disable Style/MixinUsage -- for brevity
 
 def measure(msg)
   start = Time.now
@@ -36,7 +36,7 @@ def display_indexes(indexes, bucket_name)
 
 bucket_name = "beer-sample"
 
-options = Cluster::ClusterOptions.new
+options = Options::Cluster.new
 options.authenticate("Administrator", "password")
 cluster = Cluster.connect("couchbase://localhost", options)
 

examples/managing_search_indexes.rb

@@ -15,15 +15,15 @@
 #  limitations under the License.
 
 require "couchbase"
-include Couchbase # rubocop:disable Style/MixinUsage for brevity
+include Couchbase # rubocop:disable Style/MixinUsage -- for brevity
 
 def measure(msg)
   start = Time.now
   yield
   printf "%<msg>s in %<elapsed>.2f seconds\n", msg: msg, elapsed: Time.now - start
 end
 
-options = Cluster::ClusterOptions.new
+options = Options::Cluster.new
 options.authenticate("Administrator", "password")
 cluster = Cluster.connect("couchbase://localhost", options)
 

examples/managing_users.rb

@@ -15,9 +15,9 @@
 #  limitations under the License.
 
 require "couchbase"
-include Couchbase # rubocop:disable Style/MixinUsage for brevity
+include Couchbase # rubocop:disable Style/MixinUsage -- for brevity
 
-options = Cluster::ClusterOptions.new
+options = Options::Cluster.new
 options.authenticate("Administrator", "password")
 cluster = Cluster.connect("couchbase://localhost", options)
 
@@ -71,7 +71,7 @@
 
 # Using a user created in the SDK to access data
 bucket_name = "travel-sample"
-options = Cluster::ClusterOptions.new
+options = Options::Cluster.new
 options.authenticate("testUsername", "testPassword")
 user_cluster = Cluster.connect("couchbase://localhost", options)
 user_bucket = user_cluster.bucket(bucket_name)

examples/managing_view_indexes.rb

@@ -15,7 +15,7 @@
 #  limitations under the License.
 
 require "couchbase"
-include Couchbase # rubocop:disable Style/MixinUsage for brevity
+include Couchbase # rubocop:disable Style/MixinUsage -- for brevity
 
 def measure(msg)
   start = Time.now
@@ -38,7 +38,7 @@ def display_indexes(manager, namespace)
 
 bucket_name = "beer-sample"
 
-options = Cluster::ClusterOptions.new
+options = Options::Cluster.new
 options.authenticate("Administrator", "password")
 cluster = Cluster.connect("couchbase://localhost", options)
 

examples/query.rb

@@ -16,15 +16,15 @@
 
 require "couchbase"
 
-include Couchbase # rubocop:disable Style/MixinUsage for brevity
+include Couchbase # rubocop:disable Style/MixinUsage -- for brevity
 
-options = Cluster::ClusterOptions.new
+options = Options::Cluster.new
 options.authenticate("Administrator", "password")
 cluster = Cluster.connect("couchbase://localhost", options)
 
 cluster.bucket("travel-sample") # this is necessary for 6.0.x
 
-options = Cluster::QueryOptions.new
+options = Options::Query.new
 options.named_parameters({type: "hotel"})
 options.metrics = true
 res = cluster.query("SELECT * FROM `travel-sample` WHERE type = $type LIMIT 10", options)

examples/query_with_consistency.rb

@@ -16,9 +16,9 @@
 
 require "couchbase"
 
-include Couchbase # rubocop:disable Style/MixinUsage for brevity
+include Couchbase # rubocop:disable Style/MixinUsage -- for brevity
 
-options = Cluster::ClusterOptions.new
+options = Options::Cluster.new
 options.authenticate("Administrator", "password")
 cluster = Cluster.connect("couchbase://localhost", options)
 
@@ -42,7 +42,7 @@
   "data" => random_number,
 })
 
-options = Cluster::QueryOptions.new
+options = Options::Query.new
 options.timeout = 10_000
 options.positional_parameters(["Brass"])
 options.scan_consistency = :request_plus
@@ -73,7 +73,7 @@
 state = MutationState.new(res.mutation_token)
 # state.add(*tokens) could be used to add more tokens
 
-options = Cluster::QueryOptions.new
+options = Options::Query.new
 options.timeout = 10_000
 options.positional_parameters(["Brass"])
 options.consistent_with(state)

examples/range_scan.rb

@@ -16,9 +16,9 @@
 
 require 'couchbase'
 
-include Couchbase # rubocop:disable Style/MixinUsage for brevity
+include Couchbase # rubocop:disable Style/MixinUsage -- for brevity
 
-options = Cluster::ClusterOptions.new
+options = Options::Cluster.new
 options.authenticate("Administrator", "password")
 cluster = Cluster.connect("couchbase://localhost", options)
 

examples/search.rb

@@ -16,9 +16,9 @@
 
 require "couchbase"
 
-include Couchbase # rubocop:disable Style/MixinUsage for brevity
+include Couchbase # rubocop:disable Style/MixinUsage -- for brevity
 
-options = Cluster::ClusterOptions.new
+options = Options::Cluster.new
 options.authenticate("Administrator", "password")
 cluster = Cluster.connect("couchbase://localhost", options)
 
@@ -136,7 +136,7 @@
 
 # search with facets advanced sort
 query = Cluster::SearchQuery.match_phrase("hop beer")
-options = Cluster::SearchOptions.new
+options = Options::Search.new
 options.limit = 10
 options.fields = %w[name]
 options.highlight_style = :html
@@ -168,7 +168,7 @@
 query = Cluster::SearchQuery.term("beer")
 query.field = "type"
 
-options = Cluster::SearchOptions.new
+options = Options::Search.new
 options.facets = {}
 
 term_facet = Cluster::SearchFacet.term("name")

examples/search_with_consistency.rb

@@ -16,9 +16,9 @@
 
 require "couchbase"
 
-include Couchbase # rubocop:disable Style/MixinUsage for brevity
+include Couchbase # rubocop:disable Style/MixinUsage -- for brevity
 
-options = Cluster::ClusterOptions.new
+options = Options::Cluster.new
 options.authenticate("Administrator", "password")
 cluster = Cluster.connect("couchbase://localhost", options)
 
@@ -85,7 +85,7 @@
 # state.add(*tokens) could be used to add more tokens
 
 query = Cluster::SearchQuery.term("doorknob")
-options = Cluster::SearchOptions.new
+options = Options::Search.new
 options.timeout = 10_000
 options.consistent_with(state)
 res = cluster.search_query(search_index_name, query, options)

examples/subdocument.rb

@@ -15,9 +15,9 @@
 #  limitations under the License.
 
 require "couchbase"
-include Couchbase # rubocop:disable Style/MixinUsage for brevity
+include Couchbase # rubocop:disable Style/MixinUsage -- for brevity
 
-options = Cluster::ClusterOptions.new
+options = Options::Cluster.new
 options.authenticate("Administrator", "password")
 cluster = Cluster.connect("couchbase://localhost", options)
 bucket = cluster.bucket("default")

examples/view.rb

@@ -16,16 +16,16 @@
 
 require "couchbase"
 
-include Couchbase # rubocop:disable Style/MixinUsage for brevity
+include Couchbase # rubocop:disable Style/MixinUsage -- for brevity
 
-options = Cluster::ClusterOptions.new
+options = Options::Cluster.new
 options.authenticate("Administrator", "password")
 cluster = Cluster.connect("couchbase://localhost", options)
 
 bucket = cluster.bucket("beer-sample")
 collection = bucket.default_collection
 
-options = Bucket::ViewOptions.new
+options = Options::View.new
 options.reduce = true
 options.group_level = 1
 res = bucket.view_query("beer", "by_location", options)
@@ -34,7 +34,7 @@
   puts "#{row.key.first}: #{row.value} breweries"
 end
 
-options = Bucket::ViewOptions.new
+options = Options::View.new
 options.limit = 10
 options.order = :descending
 res = bucket.view_query("beer", "brewery_beers", options)
@@ -52,7 +52,7 @@
   "type" => "brewery",
 })
 puts "\nRequest with consistency. Generated brewery name: #{unique_brewery_id}"
-options = Bucket::ViewOptions.new
+options = Options::View.new
 options.start_key = ["random_brewery:"]
 options.scan_consistency = :request_plus
 res = bucket.view_query("beer", "brewery_beers", options)