[STORE] Add more tests and update documentation

Author: estolfo

elasticsearch-persistence/lib/elasticsearch/persistence/repository.rb

@@ -22,46 +22,58 @@ def self.included(base)
         base.send(:extend, Elasticsearch::Model::Indexing::ClassMethods)
       end
 
+      # These methods are necessary to define at the class-level so that the methods available
+      # via Elasticsearch::Model::Indexing::ClassMethod have the references they need.
+      #
+      # @since 6.0.0
       module ClassMethods
 
-        # Get the class-level document type setting.
+        # Get or set the class-level document type setting.
         #
         # @example
         #   MyRepository.document_type
         #
-        # @return [ String, Symbol ] The repository's document type.
+        # @return [ String, Symbol ] _type The repository's document type.
         #
         # @since 6.0.0
-        def document_type(type = nil)
-          @document_type ||= (type || DEFAULT_DOC_TYPE)
+        def document_type(_type = nil)
+          @document_type ||= (_type || DEFAULT_DOC_TYPE)
         end
 
-        # Get the class-level index name setting.
+        # Get or set the class-level index name setting.
         #
         # @example
         #   MyRepository.index_name
         #
-        # @return [ String, Symbol ] The repository's index name.
+        # @return [ String, Symbol ] _name The repository's index name.
         #
         # @since 6.0.0
-        def index_name(name = nil)
-          @index_name ||= (name || DEFAULT_INDEX_NAME)
+        def index_name(_name = nil)
+          @index_name ||= (_name || DEFAULT_INDEX_NAME)
         end
 
-        # Get the class-level setting for the class used by the repository when deserializing.
+        # Get or set the class-level setting for the class used by the repository when deserializing.
         #
         # @example
         #   MyRepository.klass
         #
-        # @return [ Class ] The repository's klass for deserializing.
+        # @return [ Class ] _class The repository's klass for deserializing.
         #
         # @since 6.0.0
         def klass(_class = nil)
           instance_variables.include?(:@klass) ? @klass : @klass = _class
         end
 
-        def client(client = client)
-          @client ||= (client || Elasticsearch::Transport::Client.new)
+        # Get or set the class-level setting for the client used by the repository.
+        #
+        # @example
+        #   MyRepository.client
+        #
+        # @return [ Class ] _client The repository's client.
+        #
+        # @since 6.0.0
+        def client(_client = nil)
+          @client ||= (_client || Elasticsearch::Transport::Client.new)
         end
       end
 

elasticsearch-persistence/spec/repository_spec.rb

@@ -14,6 +14,10 @@ class UserRepo
     end
   end
 
+  after do
+    begin; DEFAULT_REPOSITORY.delete_index!; rescue; end
+  end
+
   describe '#initialize' do
 
     context 'when options are not provided' do
@@ -118,19 +122,13 @@ class UserRepo
 
   describe 'class methods' do
 
-    before do
-      if defined?(NoteRepository)
-        Object.send(:remove_const, NoteRepository.name)
-      end
+    before(:all) do
       class NoteRepository
         include Elasticsearch::Persistence::Repository
 
         document_type 'note'
-
         index_name 'notes_repo'
-
         klass Hash
-
         client(_class: 'client')
 
         settings number_of_shards: 1, number_of_replicas: 0 do
@@ -144,6 +142,16 @@ class NoteRepository
       end
     end
 
+    after(:all) do
+      if defined?(NoteRepository)
+        Object.send(:remove_const, NoteRepository.name)
+      end
+    end
+
+    after do
+      begin; NoteRepository.delete_index!; rescue; end
+    end
+
     context '#client' do
 
       it 'allows the value to be set only once' do
@@ -160,7 +168,7 @@ class NoteRepository
       end
 
       it 'allows the value to be overwritten with options on the instance' do
-        expect(NoteRepository.new(client: double('client', class: 'other_client')).client.class).to eq('other_client')
+        expect(NoteRepository.new(client: double('client', instance: 'other')).client.instance).to eq('other')
       end
     end
 
@@ -239,12 +247,33 @@ class NoteRepository
 
       context 'when the method is called on an instance' do
 
+        let(:repository) do
+          DEFAULT_REPOSITORY
+        end
+
         before do
-          DEFAULT_REPOSITORY.create_index!
+          begin; repository.delete_index!; rescue; end
+          repository.create_index!
         end
 
         it 'creates the index' do
-          expect(DEFAULT_REPOSITORY.index_exists?).to be(true)
+          expect(repository.index_exists?).to be(true)
+        end
+      end
+
+      context 'when the method is called on the class' do
+
+        let(:repository) do
+          DEFAULT_REPOSITORY.class
+        end
+
+        before do
+          begin; repository.delete_index!; rescue; end
+          repository.create_index!
+        end
+
+        it 'creates the index' do
+          expect(repository.index_exists?).to be(true)
         end
       end
     end
@@ -253,13 +282,33 @@ class NoteRepository
 
       context 'when the method is called on an instance' do
 
+        let(:repository) do
+          DEFAULT_REPOSITORY
+        end
+
         before do
-          DEFAULT_REPOSITORY.create_index!
-          DEFAULT_REPOSITORY.delete_index!
+          repository.create_index!
+          begin; repository.delete_index!; rescue; end
         end
 
         it 'creates the index' do
-          expect(DEFAULT_REPOSITORY.index_exists?).to be(false)
+          expect(repository.index_exists?).to be(false)
+        end
+      end
+
+      context 'when the method is called on the class' do
+
+        let(:repository) do
+          DEFAULT_REPOSITORY.class
+        end
+
+        before do
+          begin; repository.delete_index!; rescue; end
+          repository.create_index!
+        end
+
+        it 'creates the index' do
+          expect(repository.index_exists?).to be(true)
         end
       end
     end
@@ -268,12 +317,31 @@ class NoteRepository
 
       context 'when the method is called on an instance' do
 
+        let(:repository) do
+          DEFAULT_REPOSITORY
+        end
+
         before do
-          DEFAULT_REPOSITORY.create_index!
+          repository.create_index!
         end
 
         it 'creates the index' do
-          expect(DEFAULT_REPOSITORY.refresh_index!['_shards']).to be_a(Hash)
+          expect(repository.refresh_index!['_shards']).to be_a(Hash)
+        end
+      end
+
+      context 'when the method is called on the class' do
+
+        let(:repository) do
+          DEFAULT_REPOSITORY.class
+        end
+
+        before do
+          repository.create_index!
+        end
+
+        it 'creates the index' do
+          expect(repository.refresh_index!['_shards']).to be_a(Hash)
         end
       end
     end
@@ -282,12 +350,31 @@ class NoteRepository
 
       context 'when the method is called on an instance' do
 
+        let(:repository) do
+          DEFAULT_REPOSITORY
+        end
+
         before do
-          DEFAULT_REPOSITORY.create_index!
+          repository.create_index!
         end
 
         it 'creates the index' do
-          expect(DEFAULT_REPOSITORY.index_exists?).to be(true)
+          expect(repository.index_exists?).to be(true)
+        end
+      end
+
+      context 'when the method is called on the class' do
+
+        let(:repository) do
+          DEFAULT_REPOSITORY.class
+        end
+
+        before do
+          repository.create_index!
+        end
+
+        it 'creates the index' do
+          expect(repository.index_exists?).to be(true)
         end
       end
     end
@@ -303,11 +390,6 @@ class NoteRepository
         }
       end
 
-      it 'allows the value to be set only once' do
-        NoteRepository.mapping(dynamic: 'strict') { indexes :foo, type: 'long' }
-        #expect(NoteRepository.mapping.to_hash).to eq('note')
-      end
-
       it 'sets the value at the class level' do
         expect(NoteRepository.mapping.to_hash).to eq(expected_mapping)
       end
@@ -343,11 +425,6 @@ class NoteRepository
 
     describe '#settings' do
 
-      it 'allows the value to be set only once' do
-        NoteRepository.settings(number_of_shards: 3)
-        #expect(NoteRepository.settings.to_hash).to eq()
-      end
-
       it 'sets the value at the class level' do
         expect(NoteRepository.settings.to_hash).to eq(number_of_shards: 1, number_of_replicas: 0)
       end

elasticsearch-persistence/spec/spec_helper.rb

@@ -5,17 +5,18 @@
   config.color = true
 end
 
-class NoteRepository
-  include Elasticsearch::Persistence::Repository
-end
-
 # The default client to be used by the repositories.
 #
 # @since 6.0.0
 DEFAULT_CLIENT = Elasticsearch::Client.new(host: "localhost:#{(ENV['TEST_CLUSTER_PORT'] || 9250)}",
                                            tracer: (ENV['QUIET'] ? nil : ::Logger.new(STDERR)))
 
-# The default client to be used by the repositories.
+class MyTestRepository
+  include Elasticsearch::Persistence::Repository
+  client DEFAULT_CLIENT
+end
+
+# The default repository to be used by tests.
 #
 # @since 6.0.0
-DEFAULT_REPOSITORY = NoteRepository.new(index_name: 'notes', document_type: 'note', client: DEFAULT_CLIENT)
+DEFAULT_REPOSITORY = MyTestRepository.new(index_name: 'my_test_repository', document_type: 'test')