elasticsearch-model 0.1.9 → 7.1.1

data/spec/elasticsearch/model/adapters/active_record/multi_model_spec.rb

@@ -0,0 +1,127 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+require 'spec_helper'
+
+describe 'Elasticsearch::Model::Adapter::ActiveRecord MultiModel' do
+
+  before(:all) do
+    ActiveRecord::Schema.define do
+      create_table Episode.table_name do |t|
+        t.string :name
+        t.datetime :created_at, :default => 'NOW()'
+      end
+
+      create_table Series.table_name do |t|
+        t.string :name
+        t.datetime :created_at, :default => 'NOW()'
+      end
+    end
+  end
+
+  before do
+    models = [ Episode, Series ]
+    clear_tables(models)
+    models.each do |model|
+      model.__elasticsearch__.create_index! force: true
+      model.create name: "The #{model.name}"
+      model.create name: "A great #{model.name}"
+      model.create name: "The greatest #{model.name}"
+      model.__elasticsearch__.refresh_index!
+    end
+  end
+
+  after do
+    clear_indices(Episode, Series)
+    clear_tables(Episode, Series)
+  end
+
+  context 'when the search is across multimodels' do
+
+    let(:search_result) do
+      Elasticsearch::Model.search(%q<"The greatest Episode"^2 OR "The greatest Series">, [Series, Episode])
+    end
+
+    it 'executes the search across models' do
+      expect(search_result.results.size).to eq(2)
+      expect(search_result.records.size).to eq(2)
+    end
+
+    describe '#results' do
+
+      it 'returns an instance of Elasticsearch::Model::Response::Result' do
+        expect(search_result.results[0]).to be_a(Elasticsearch::Model::Response::Result)
+        expect(search_result.results[1]).to be_a(Elasticsearch::Model::Response::Result)
+      end
+
+      it 'returns the correct model instance' do
+        expect(search_result.results[0].name).to eq('The greatest Episode')
+        expect(search_result.results[1].name).to eq('The greatest Series')
+      end
+
+      it 'provides access to the results' do
+        expect(search_result.results[0].name).to eq('The greatest Episode')
+        expect(search_result.results[0].name?).to be(true)
+        expect(search_result.results[0].boo?).to be(false)
+
+        expect(search_result.results[1].name).to eq('The greatest Series')
+        expect(search_result.results[1].name?).to be(true)
+        expect(search_result.results[1].boo?).to be(false)
+      end
+    end
+
+    describe '#records' do
+
+      it 'returns an instance of Elasticsearch::Model::Response::Result' do
+        expect(search_result.records[0]).to be_a(Episode)
+        expect(search_result.records[1]).to be_a(Series)
+      end
+
+      it 'returns the correct model instance' do
+        expect(search_result.records[0].name).to eq('The greatest Episode')
+        expect(search_result.records[1].name).to eq('The greatest Series')
+      end
+
+      context 'when the data store is changed' do
+
+        before do
+          Series.find_by_name("The greatest Series").delete
+          Series.__elasticsearch__.refresh_index!
+        end
+
+        it 'only returns matching records' do
+          expect(search_result.results.size).to eq(2)
+          expect(search_result.records.size).to eq(1  )
+          expect(search_result.records[0].name).to eq('The greatest Episode')
+        end
+      end
+    end
+
+    describe 'pagination' do
+
+      let(:search_result) do
+        Elasticsearch::Model.search('series OR episode', [Series, Episode])
+      end
+
+      it 'properly paginates the results' do
+        expect(search_result.page(1).per(3).results.size).to eq(3)
+        expect(search_result.page(2).per(3).results.size).to eq(3)
+        expect(search_result.page(3).per(3).results.size).to eq(0)
+      end
+    end
+  end
+end

data/spec/elasticsearch/model/adapters/active_record/namespaced_model_spec.rb

@@ -0,0 +1,55 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+require 'spec_helper'
+
+describe 'Elasticsearch::Model::Adapter::ActiveRecord Namespaced Model' do
+
+  before(:all) do
+    ActiveRecord::Schema.define(:version => 1) do
+      create_table :books do |t|
+        t.string   :title
+      end
+    end
+
+    MyNamespace::Book.delete_all
+    MyNamespace::Book.__elasticsearch__.create_index!(force: true, include_type_name: true)
+    MyNamespace::Book.create!(title: 'Test')
+    MyNamespace::Book.__elasticsearch__.refresh_index!
+  end
+
+  after do
+    clear_indices(MyNamespace::Book)
+    clear_tables(MyNamespace::Book)
+  end
+
+  context 'when the model is namespaced' do
+
+    it 'has the proper index name' do
+      expect(MyNamespace::Book.index_name).to eq('my_namespace-books')
+    end
+
+    it 'has the proper document type' do
+      expect(MyNamespace::Book.document_type).to eq('book')
+    end
+
+    it 'saves the document into the index' do
+      expect(MyNamespace::Book.search('title:test').results.size).to eq(1)
+      expect(MyNamespace::Book.search('title:test').results.first.title).to eq('Test')
+    end
+  end
+end

data/spec/elasticsearch/model/adapters/active_record/pagination_spec.rb

@@ -0,0 +1,332 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+require 'spec_helper'
+
+describe 'Elasticsearch::Model::Adapter::ActiveRecord Pagination' do
+
+  before(:all) do
+    ActiveRecord::Schema.define(:version => 1) do
+      create_table ArticleForPagination.table_name do |t|
+        t.string   :title
+        t.datetime :created_at, :default => 'NOW()'
+        t.boolean  :published
+      end
+    end
+
+    Kaminari::Hooks.init if defined?(Kaminari::Hooks)
+
+    ArticleForPagination.__elasticsearch__.create_index! force: true
+
+    68.times do |i|
+      ArticleForPagination.create! title: "Test #{i}", published: (i % 2 == 0)
+    end
+
+    ArticleForPagination.import
+    ArticleForPagination.__elasticsearch__.refresh_index!
+  end
+
+  context 'when no other page is specified' do
+
+    let(:records) do
+      ArticleForPagination.search('title:test').page(1).records
+    end
+
+    describe '#size' do
+
+      it 'returns the correct size' do
+        expect(records.size).to eq(25)
+      end
+    end
+
+    describe '#current_page' do
+
+      it 'returns the correct current page' do
+        expect(records.current_page).to eq(1)
+      end
+    end
+
+    describe '#prev_page' do
+
+      it 'returns the correct previous page' do
+        expect(records.prev_page).to be_nil
+      end
+    end
+
+    describe '#next_page' do
+
+      it 'returns the correct next page' do
+        expect(records.next_page).to eq(2)
+      end
+    end
+
+    describe '#total_pages' do
+
+      it 'returns the correct total pages' do
+        expect(records.total_pages).to eq(3)
+      end
+    end
+
+    describe '#first_page?' do
+
+      it 'returns the correct first page' do
+        expect(records.first_page?).to be(true)
+      end
+    end
+
+    describe '#last_page?' do
+
+      it 'returns the correct last page' do
+        expect(records.last_page?).to be(false)
+      end
+    end
+
+    describe '#out_of_range?' do
+
+      it 'returns whether the pagination is out of range' do
+        expect(records.out_of_range?).to be(false)
+      end
+    end
+  end
+
+  context 'when a specific page is specified' do
+
+    let(:records) do
+      ArticleForPagination.search('title:test').page(2).records
+    end
+
+    describe '#size' do
+
+      it 'returns the correct size' do
+        expect(records.size).to eq(25)
+      end
+    end
+
+    describe '#current_page' do
+
+      it 'returns the correct current page' do
+        expect(records.current_page).to eq(2)
+      end
+    end
+
+    describe '#prev_page' do
+
+      it 'returns the correct previous page' do
+        expect(records.prev_page).to eq(1)
+      end
+    end
+
+    describe '#next_page' do
+
+      it 'returns the correct next page' do
+        expect(records.next_page).to eq(3)
+      end
+    end
+
+    describe '#total_pages' do
+
+      it 'returns the correct total pages' do
+        expect(records.total_pages).to eq(3)
+      end
+    end
+
+    describe '#first_page?' do
+
+      it 'returns the correct first page' do
+        expect(records.first_page?).to be(false)
+      end
+    end
+
+    describe '#last_page?' do
+
+      it 'returns the correct last page' do
+        expect(records.last_page?).to be(false)
+      end
+    end
+
+    describe '#out_of_range?' do
+
+      it 'returns whether the pagination is out of range' do
+        expect(records.out_of_range?).to be(false)
+      end
+    end
+  end
+
+  context 'when a the last page is specified' do
+
+    let(:records) do
+      ArticleForPagination.search('title:test').page(3).records
+    end
+
+    describe '#size' do
+
+      it 'returns the correct size' do
+        expect(records.size).to eq(18)
+      end
+    end
+
+    describe '#current_page' do
+
+      it 'returns the correct current page' do
+        expect(records.current_page).to eq(3)
+      end
+    end
+
+    describe '#prev_page' do
+
+      it 'returns the correct previous page' do
+        expect(records.prev_page).to eq(2)
+      end
+    end
+
+    describe '#next_page' do
+
+      it 'returns the correct next page' do
+        expect(records.next_page).to be_nil
+      end
+    end
+
+    describe '#total_pages' do
+
+      it 'returns the correct total pages' do
+        expect(records.total_pages).to eq(3)
+      end
+    end
+
+    describe '#first_page?' do
+
+      it 'returns the correct first page' do
+        expect(records.first_page?).to be(false)
+      end
+    end
+
+    describe '#last_page?' do
+
+      it 'returns the correct last page' do
+        expect(records.last_page?).to be(true)
+      end
+    end
+
+    describe '#out_of_range?' do
+
+      it 'returns whether the pagination is out of range' do
+        expect(records.out_of_range?).to be(false)
+      end
+    end
+  end
+
+  context 'when an invalid page is specified' do
+
+    let(:records) do
+      ArticleForPagination.search('title:test').page(6).records
+    end
+
+    describe '#size' do
+
+      it 'returns the correct size' do
+        expect(records.size).to eq(0)
+      end
+    end
+
+    describe '#current_page' do
+
+      it 'returns the correct current page' do
+        expect(records.current_page).to eq(6)
+      end
+    end
+
+    describe '#next_page' do
+
+      it 'returns the correct next page' do
+        expect(records.next_page).to be_nil
+      end
+    end
+
+    describe '#total_pages' do
+
+      it 'returns the correct total pages' do
+        expect(records.total_pages).to eq(3)
+      end
+    end
+
+    describe '#first_page?' do
+
+      it 'returns the correct first page' do
+        expect(records.first_page?).to be(false)
+      end
+    end
+
+    describe '#last_page?' do
+
+      it 'returns whether it is the last page', if: !(Kaminari::VERSION < '1') do
+        expect(records.last_page?).to be(false)
+      end
+
+      it 'returns whether it is the last page', if: Kaminari::VERSION < '1' do
+        expect(records.last_page?).to be(true) # Kaminari returns current_page >= total_pages in version < 1.0
+      end
+    end
+
+    describe '#out_of_range?' do
+
+      it 'returns whether the pagination is out of range' do
+        expect(records.out_of_range?).to be(true)
+      end
+    end
+  end
+
+  context 'when a scope is also specified' do
+
+    let(:records) do
+      ArticleForPagination.search('title:test').page(2).records.published
+    end
+
+    describe '#size' do
+
+      it 'returns the correct size' do
+        expect(records.size).to eq(12)
+      end
+    end
+  end
+
+  context 'when a sorting is specified' do
+
+    let(:search) do
+      ArticleForPagination.search({ query: { match: { title: 'test' } }, sort: [ { id: 'desc' } ] })
+    end
+
+    it 'applies the sort' do
+      expect(search.page(2).records.first.id).to eq(43)
+      expect(search.page(3).records.first.id).to eq(18)
+      expect(search.page(2).per(5).records.first.id).to eq(63)
+    end
+  end
+
+  context 'when the model has a specific default per page set' do
+
+    around do |example|
+      original_default = ArticleForPagination.instance_variable_get(:@_default_per_page)
+      ArticleForPagination.paginates_per 50
+      example.run
+      ArticleForPagination.paginates_per original_default
+    end
+
+    it 'uses the default per page setting' do
+      expect(ArticleForPagination.search('*').page(1).records.size).to eq(50)
+    end
+  end
+end

data/spec/elasticsearch/model/adapters/active_record/parent_child_spec.rb

@@ -0,0 +1,92 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+require 'spec_helper'
+
+describe 'Elasticsearch::Model::Adapter::ActiveRecord Parent-Child' do
+
+  before(:all) do
+    ActiveRecord::Schema.define(version: 1) do
+      create_table :questions do |t|
+        t.string     :title
+        t.text       :text
+        t.string     :author
+        t.timestamps null: false
+      end
+
+      create_table :answers do |t|
+        t.text       :text
+        t.string     :author
+        t.references :question
+        t.timestamps null: false
+      end
+
+      add_index(:answers, :question_id) unless index_exists?(:answers, :question_id)
+
+      clear_tables(Question)
+      ParentChildSearchable.create_index!(force: true, include_type_name: true)
+
+      q_1 = Question.create!(title: 'First Question',  author: 'John')
+      q_2 = Question.create!(title: 'Second Question', author: 'Jody')
+
+      q_1.answers.create!(text: 'Lorem Ipsum', author: 'Adam')
+      q_1.answers.create!(text: 'Dolor Sit',   author: 'Ryan')
+
+      q_2.answers.create!(text: 'Amet Et', author: 'John')
+
+      Question.__elasticsearch__.refresh_index!
+    end
+  end
+
+  describe 'has_child search' do
+
+    let(:search_result) do
+      Question.search(query: { has_child: { type: 'answer', query: { match: { author: 'john' } } } })
+    end
+
+    it 'finds parents by matching on child search criteria' do
+      expect(search_result.records.first.title).to eq('Second Question')
+    end
+  end
+
+  describe 'hash_parent search' do
+
+    let(:search_result) do
+      Answer.search(query: { has_parent: { parent_type: 'question', query: { match: { author: 'john' } } } })
+    end
+
+    it 'finds children by matching in parent criteria' do
+      expect(search_result.records.map(&:author)).to match(['Adam', 'Ryan'])
+    end
+  end
+
+  context 'when a parent is deleted' do
+
+    before do
+      Question.where(title: 'First Question').each(&:destroy)
+      Question.__elasticsearch__.refresh_index!
+    end
+
+    let(:search_result) do
+      Answer.search(query: { has_parent: { parent_type: 'question', query: { match_all: {} } } })
+    end
+
+    it 'deletes the children' do
+      expect(search_result.results.total).to eq(1)
+    end
+  end
+end

data/spec/elasticsearch/model/adapters/active_record/serialization_spec.rb

@@ -0,0 +1,78 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+require 'spec_helper'
+
+describe 'Elasticsearch::Model::Adapter::ActiveRecord Serialization' do
+
+  before(:all) do
+    ActiveRecord::Schema.define(:version => 1) do
+      create_table ArticleWithCustomSerialization.table_name do |t|
+        t.string   :title
+        t.string   :status
+      end
+    end
+
+    ArticleWithCustomSerialization.delete_all
+    ArticleWithCustomSerialization.__elasticsearch__.create_index!(force: true)
+  end
+
+  context 'when the model has a custom serialization defined' do
+
+    before do
+      ArticleWithCustomSerialization.create!(title: 'Test', status: 'green')
+      ArticleWithCustomSerialization.__elasticsearch__.refresh_index!
+    end
+
+    context 'when a document is indexed' do
+
+      let(:search_result) do
+        ArticleWithCustomSerialization.__elasticsearch__.client.get(index: 'article_with_custom_serializations',
+                                                                    type:  '_doc',
+                                                                    id:    '1')
+      end
+
+      it 'applies the serialization when indexing' do
+        expect(search_result['_source']).to eq('title' => 'Test')
+      end
+    end
+
+    context 'when a document is updated' do
+
+      before do
+        article.update_attributes(title: 'UPDATED', status: 'yellow')
+        ArticleWithCustomSerialization.__elasticsearch__.refresh_index!
+      end
+
+      let!(:article) do
+        art = ArticleWithCustomSerialization.create!(title: 'Test', status: 'red')
+        ArticleWithCustomSerialization.__elasticsearch__.refresh_index!
+        art
+      end
+
+      let(:search_result) do
+        ArticleWithCustomSerialization.__elasticsearch__.client.get(index: 'article_with_custom_serializations',
+                                                                    type:  '_doc',
+                                                                    id:    article.id)
+      end
+
+      it 'applies the serialization when updating' do
+        expect(search_result['_source']).to eq('title' => 'UPDATED')
+      end
+    end
+  end
+end