Update dependencies, fix linting issues

jasonbosco · jasonbosco · commit 222bf66d83f1 · 2023-10-25T17:59:57.000-05:00
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -1,3 +1,5 @@
+require: rubocop-rspec
+
 AllCops:
   NewCops: enable
 
@@ -37,3 +39,12 @@ Layout/LineLength:
 Lint/SuppressedException:
   Exclude:
     - examples/**
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+Style/HashSyntax:
+  Enabled: false # We still want to support older versions of Ruby
diff --git a/Gemfile b/Gemfile
@@ -4,5 +4,21 @@ source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
+# Dev dependencies
+gem 'awesome_print', '~> 1.8'
+gem 'bundler', '~> 2.0'
+gem 'codecov', '~> 0.1'
+gem 'guard', '~> 2.16'
+gem 'guard-rubocop', '~> 1.3'
+gem 'rake', '~> 13.0'
+gem 'rspec', '~> 3.9'
+gem 'rspec_junit_formatter', '~> 0.4'
+gem 'rspec-legacy_formatters', '~> 1.0' # For codecov formatter
+gem 'rubocop', '~> 1.56'
+gem 'rubocop-rspec', '~> 2.24', require: false
+gem 'simplecov', '~> 0.18'
+gem 'timecop', '~> 0.9'
+gem 'webmock', '~> 3.8'
+
 # Specify your gem's dependencies in typesense.gemspec
 gemspec
diff --git a/examples/aliases.rb b/examples/aliases.rb
@@ -3,47 +3,47 @@
 ##
 # These examples walk you through operations specifically related to aliases
 
-require_relative './client_initialization'
+require_relative 'client_initialization'
 
 # Create a collection
 create_response = @typesense.collections.create(
-  "name": 'books_january',
-  "fields": [
-    { "name": 'title', "type": 'string' },
-    { "name": 'authors', "type": 'string[]' },
-    { "name": 'authors_facet', "type": 'string[]', "facet": true },
-    { "name": 'publication_year', "type": 'int32' },
-    { "name": 'publication_year_facet', "type": 'string', "facet": true },
-    { "name": 'ratings_count', "type": 'int32' },
-    { "name": 'average_rating', "type": 'float' },
-    { "name": 'image_url', "type": 'string' }
+  name: 'books_january',
+  fields: [
+    { name: 'title', type: 'string' },
+    { name: 'authors', type: 'string[]' },
+    { name: 'authors_facet', type: 'string[]', facet: true },
+    { name: 'publication_year', type: 'int32' },
+    { name: 'publication_year_facet', type: 'string', facet: true },
+    { name: 'ratings_count', type: 'int32' },
+    { name: 'average_rating', type: 'float' },
+    { name: 'image_url', type: 'string' }
   ],
-  "default_sorting_field": 'ratings_count'
+  default_sorting_field: 'ratings_count'
 )
 
 ap create_response
 
 # Create or update an existing alias
 create_alias_response = @typesense.aliases.upsert('books',
-                                                  "collection_name": 'books_january')
+                                                  collection_name: 'books_january')
 ap create_alias_response
 
 # Add a book using the alias name `books`
 hunger_games_book = {
-  'id': '1', 'original_publication_year': 2008, 'authors': ['Suzanne Collins'], 'average_rating': 4.34,
-  'publication_year': 2008, 'publication_year_facet': '2008', 'authors_facet': ['Suzanne Collins'],
-  'title': 'The Hunger Games',
-  'image_url': 'https://images.gr-assets.com/books/1447303603m/2767052.jpg',
-  'ratings_count': 4_780_653
+  id: '1', original_publication_year: 2008, authors: ['Suzanne Collins'], average_rating: 4.34,
+  publication_year: 2008, publication_year_facet: '2008', authors_facet: ['Suzanne Collins'],
+  title: 'The Hunger Games',
+  image_url: 'https://images.gr-assets.com/books/1447303603m/2767052.jpg',
+  ratings_count: 4_780_653
 }
 
 @typesense.collections['books'].documents.create(hunger_games_book)
 
 # Search using the alias
 ap @typesense.collections['books'].documents.search(
-  'q': 'hunger',
-  'query_by': 'title',
-  'sort_by': 'ratings_count:desc'
+  q: 'hunger',
+  query_by: 'title',
+  sort_by: 'ratings_count:desc'
 )
 
 # List all aliases
diff --git a/examples/collections_and_documents.rb b/examples/collections_and_documents.rb
@@ -4,7 +4,7 @@
 # These examples walk you through all the operations you can do on a collection and a document
 # Search is specifically covered in another file in the examples folder
 
-require_relative './client_initialization'
+require_relative 'client_initialization'
 
 ##
 # Create a collection
diff --git a/examples/keys.rb b/examples/keys.rb
@@ -3,7 +3,7 @@
 ##
 # These examples walk you through operations to manage API Keys
 
-require_relative './client_initialization'
+require_relative 'client_initialization'
 
 # Let's setup some test data for this example
 schema = {
@@ -95,18 +95,18 @@
 #  This is useful when you store multi-tenant data in a single Typesense server, but you only want
 #  a particular tenant to access their own data. You'd generate one scoped search key per tenant.
 #  IMPORTANT: scoped search keys should only be generated *server-side*, so as to not leak the unscoped main search key to clients
-scoped_search_only_api_key = @typesense.keys.generate_scoped_search_key(unscoped_search_only_api_key, { 'filter_by': 'company_id:124' })
+scoped_search_only_api_key = @typesense.keys.generate_scoped_search_key(unscoped_search_only_api_key, { filter_by: 'company_id:124' })
 ap "scoped_search_only_api_key: #{scoped_search_only_api_key}"
 
 # Now let's search the data using the scoped API Key for company_id:124
 # You can do searches with this scoped_search_only_api_key from the server-side or client-side
 scoped_typesense_client = Typesense::Client.new({
-                                                  'nodes': [{
-                                                    'host': 'localhost',
-                                                    'port': '8108',
-                                                    'protocol': 'http'
+                                                  nodes: [{
+                                                    host: 'localhost',
+                                                    port: '8108',
+                                                    protocol: 'http'
                                                   }],
-                                                  'api_key': scoped_search_only_api_key
+                                                  api_key: scoped_search_only_api_key
                                                 })
 
 search_results = scoped_typesense_client.collections['users'].documents.search({
@@ -117,8 +117,8 @@
 
 # Search for a user that exists, but is outside the current key's scope
 search_results = scoped_typesense_client.collections['users'].documents.search({
-                                                                                 'q': 'Maxwell',
-                                                                                 'query_by': 'user_name'
+                                                                                 q: 'Maxwell',
+                                                                                 query_by: 'user_name'
                                                                                })
 ap search_results # Will return empty result set
 
diff --git a/examples/overrides.rb b/examples/overrides.rb
@@ -3,7 +3,7 @@
 ##
 # These examples walk you through operations specifically related to result overrides / curation
 
-require_relative './client_initialization'
+require_relative 'client_initialization'
 
 # Delete the collection if it already exists
 begin
@@ -69,19 +69,19 @@
 
 @typesense.collections['companies'].overrides.upsert(
   'promote-doofenshmirtz',
-  "rule": {
-    "query": 'doofen',
-    "match": 'exact'
+  rule: {
+    query: 'doofen',
+    match: 'exact'
   },
-  "includes": [{ 'id' => '126', 'position' => 1 }]
+  includes: [{ 'id' => '126', 'position' => 1 }]
 )
 @typesense.collections['companies'].overrides.upsert(
   'promote-acme',
-  "rule": {
-    "query": 'stark',
-    "match": 'exact'
+  rule: {
+    query: 'stark',
+    match: 'exact'
   },
-  "includes": [{ 'id' => '125', 'position' => 1 }]
+  includes: [{ 'id' => '125', 'position' => 1 }]
 )
 
 ##
diff --git a/examples/search.rb b/examples/search.rb
@@ -3,7 +3,7 @@
 ##
 # These examples walk you through operations specifically related to search
 
-require_relative './client_initialization'
+require_relative 'client_initialization'
 
 ##
 # Create a collection
diff --git a/examples/synonyms.rb b/examples/synonyms.rb
@@ -3,7 +3,7 @@
 ##
 # These examples walk you through operations specifically related to synonyms
 
-require_relative './client_initialization'
+require_relative 'client_initialization'
 
 # Delete the collection if it already exists
 begin
diff --git a/lib/typesense/configuration.rb b/lib/typesense/configuration.rb
@@ -11,7 +11,7 @@ def initialize(options = {})
       @nearest_node = options[:nearest_node]
       @connection_timeout_seconds = options[:connection_timeout_seconds] || options[:timeout_seconds] || 10
       @healthcheck_interval_seconds = options[:healthcheck_interval_seconds] || 15
-      @num_retries = options[:num_retries] || @nodes.length + (@nearest_node.nil? ? 0 : 1) || 3
+      @num_retries = options[:num_retries] || (@nodes.length + (@nearest_node.nil? ? 0 : 1)) || 3
       @retry_interval_seconds = options[:retry_interval_seconds] || 0.1
       @api_key = options[:api_key]
 
diff --git a/spec/typesense/aliases_spec.rb b/spec/typesense/aliases_spec.rb
@@ -47,7 +47,7 @@
     it 'returns an alias object' do
       result = aliases['books']
 
-      expect(result).to be_a_kind_of(Typesense::Alias)
+      expect(result).to be_a(Typesense::Alias)
       expect(result.instance_variable_get(:@name)).to eq('books')
     end
   end
diff --git a/spec/typesense/analytics_rules_spec.rb b/spec/typesense/analytics_rules_spec.rb
@@ -55,7 +55,7 @@
     it 'creates an analytics rule object and returns it' do
       result = analytics_rules['search_suggestions']
 
-      expect(result).to be_a_kind_of(Typesense::AnalyticsRule)
+      expect(result).to be_a(Typesense::AnalyticsRule)
       expect(result.instance_variable_get(:@rule_name)).to eq('search_suggestions')
     end
   end
diff --git a/spec/typesense/client_spec.rb b/spec/typesense/client_spec.rb
@@ -11,15 +11,15 @@
     it 'creates a collections object and returns it' do
       result = typesense.collections
 
-      expect(result).to be_a_kind_of(Typesense::Collections)
+      expect(result).to be_a(Typesense::Collections)
     end
   end
 
   describe '#debug' do
     it 'creates a debug object and returns it' do
       result = typesense.debug
 
-      expect(result).to be_a_kind_of(Typesense::Debug)
+      expect(result).to be_a(Typesense::Debug)
     end
   end
 end
diff --git a/spec/typesense/collection_spec.rb b/spec/typesense/collection_spec.rb
@@ -47,6 +47,7 @@
       expect(result).to eq(company_schema)
     end
   end
+
   describe '#update' do
     it 'updates the specified collection' do
       update_schema = {
@@ -88,7 +89,7 @@
     it 'creates a documents object and returns it' do
       result = companies_collection.documents
 
-      expect(result).to be_a_kind_of(Typesense::Documents)
+      expect(result).to be_a(Typesense::Documents)
     end
   end
 end
diff --git a/spec/typesense/collections_spec.rb b/spec/typesense/collections_spec.rb
@@ -36,7 +36,7 @@
   describe '#create' do
     it 'creates a collection and returns it' do
       # since num_documents is a read-only attribute
-      schema_for_creation = company_schema.reject { |key, _| key == 'num_documents' }
+      schema_for_creation = company_schema.except('num_documents')
 
       stub_request(:post, Typesense::ApiCall.new(typesense.configuration).send(:uri_for, '/collections', typesense.configuration.nodes[0]))
         .with(body: schema_for_creation,
@@ -71,7 +71,7 @@
     it 'returns a collection object' do
       result = collections['companies']
 
-      expect(result).to be_a_kind_of(Typesense::Collection)
+      expect(result).to be_a(Typesense::Collection)
       expect(result.instance_variable_get(:@name)).to eq('companies')
     end
   end
diff --git a/spec/typesense/document_spec.rb b/spec/typesense/document_spec.rb
@@ -4,7 +4,7 @@
 require_relative 'shared_configuration_context'
 
 describe Typesense::Document do
-  subject(:document_124) { typesense.collections['companies'].documents['124'] }
+  subject(:document124) { typesense.collections['companies'].documents['124'] }
 
   include_context 'with Typesense configuration'
 
@@ -51,7 +51,7 @@
               })
         .to_return(status: 200, body: JSON.dump(document), headers: { 'Content-Type': 'application/json' })
 
-      result = document_124.retrieve
+      result = document124.retrieve
 
       expect(result).to eq(document)
     end
@@ -75,7 +75,7 @@
         )
         .to_return(status: 200, body: JSON.dump(partial_document), headers: { 'Content-Type': 'application/json' })
 
-      result = document_124.update(partial_document, dirty_values: 'coerce_or_reject')
+      result = document124.update(partial_document, dirty_values: 'coerce_or_reject')
 
       expect(result).to eq(partial_document)
     end
@@ -89,7 +89,7 @@
               })
         .to_return(status: 200, body: JSON.dump(document), headers: { 'Content-Type': 'application/json' })
 
-      result = document_124.delete
+      result = document124.delete
 
       expect(result).to eq(document)
     end
diff --git a/spec/typesense/documents_spec.rb b/spec/typesense/documents_spec.rb
@@ -62,7 +62,7 @@
   end
 
   describe '#update' do
-    context 'update by query' do
+    context 'when using update by query' do
       it 'updates the document and returns it' do
         stub_request(:patch, Typesense::ApiCall.new(typesense.configuration).send(:uri_for, '/collections/companies/documents', typesense.configuration.nodes[0]))
           .with(body: document,
@@ -174,6 +174,7 @@
         expect(result).to eq('{}')
       end
     end
+
     context 'when an array of docs is passed' do
       it 'converts it to JSONL and returns an array of results' do
         stub_request(:post, Typesense::ApiCall.new(typesense.configuration).send(:uri_for, '/collections/companies/documents/import', typesense.configuration.nodes[0]))
@@ -188,8 +189,9 @@
         expect(result).to eq([{}, {}])
       end
     end
+
     context 'when a JSONL string is passed' do
-      it 'it sends the string as is and returns a string' do
+      it 'sends the string as is and returns a string' do
         stub_request(:post, Typesense::ApiCall.new(typesense.configuration).send(:uri_for, '/collections/companies/documents/import', typesense.configuration.nodes[0]))
           .with(body: "#{JSON.dump(document)}\n#{JSON.dump(document)}",
                 headers: {
@@ -289,7 +291,7 @@
     it 'creates a document object and returns it' do
       result = companies_documents['124']
 
-      expect(result).to be_a_kind_of(Typesense::Document)
+      expect(result).to be_a(Typesense::Document)
       expect(result.instance_variable_get(:@document_id)).to eq('124')
     end
   end
diff --git a/spec/typesense/keys_spec.rb b/spec/typesense/keys_spec.rb
@@ -59,7 +59,7 @@
     it 'returns an key object' do
       result = keys['123']
 
-      expect(result).to be_a_kind_of(Typesense::Key)
+      expect(result).to be_a(Typesense::Key)
       expect(result.instance_variable_get(:@id)).to eq('123')
     end
   end
diff --git a/spec/typesense/overrides_spec.rb b/spec/typesense/overrides_spec.rb
@@ -55,7 +55,7 @@
     it 'creates an override object and returns it' do
       result = companies_overrides['lex-override']
 
-      expect(result).to be_a_kind_of(Typesense::Override)
+      expect(result).to be_a(Typesense::Override)
       expect(result.instance_variable_get(:@override_id)).to eq('lex-override')
     end
   end
diff --git a/spec/typesense/presets_spec.rb b/spec/typesense/presets_spec.rb
@@ -54,7 +54,7 @@
     it 'creates a preset object and returns it' do
       result = presets['search-view']
 
-      expect(result).to be_a_kind_of(Typesense::Preset)
+      expect(result).to be_a(Typesense::Preset)
       expect(result.instance_variable_get(:@preset_name)).to eq('search-view')
     end
   end
diff --git a/spec/typesense/synonyms_spec.rb b/spec/typesense/synonyms_spec.rb
diff --git a/spec/typesense_spec.rb b/spec/typesense_spec.rb
diff --git a/typesense.gemspec b/typesense.gemspec
