elasticsearch-model-extensions 0.2.2 → 0.3.0

data/spec/integration_spec.rb

@@ -1,6 +1,6 @@
 require 'elasticsearch/model/extensions/all'
 
-RSpec.shared_examples 'a normal elasticsearch-model object' do
+RSpec.shared_examples 'a search supporting automatic as_indexed_json creation' do
   describe 'a record creation' do
     before(:each) do
       ::Article.create(title: 'foo', created_at: Time.now)
@@ -42,6 +42,318 @@ RSpec.shared_examples 'a normal elasticsearch-model object' do
   end
 end
 
+RSpec.shared_examples 'a search supporting association' do
+  describe 'a record creation' do
+    before(:each) do
+      ::Article.create(title: 'foo', created_at: Time.now, comments_attributes: [{body: 'new_comment'}])
+
+      ::Article.__elasticsearch__.refresh_index!
+    end
+
+    it 'makes the document searchable' do
+      expect(Article.search('foo').records.size).to eq(1)
+      expect(Article.search('new_comment').records.size).to eq(1)
+      expect(Article.search(query: {term: {'comments.body' => 'new_comment'}}).records.size).to eq(1)
+      expect(Article.search(query: {term: {'num_comments' => 1}}).records.size).to eq(2)
+    end
+  end
+
+  describe 'a record update' do
+    before(:each) do
+      Article.first.update_attributes title: 'Test2', comments_attributes: [{body: 'new_comment'}]
+
+      Article.__elasticsearch__.refresh_index!
+    end
+
+    it 'makes the document unsearchable using the old content' do
+      expect(Article.search('Test').records.size).to eq(0)
+    end
+
+    it 'makes the document searchable using the new content' do
+      expect(Article.search('Test2').records.size).to eq(1)
+      expect(Article.search('new_comment').records.size).to eq(1)
+      expect(Article.search(query: {term: {'comments.body' => 'new_comment'}}).records.size).to eq(1)
+    end
+
+    it 'updates the dependent field' do
+      expect(Article.search(query: {term: {'num_comments' => 1}}).records.size).to eq(2)
+    end
+  end
+
+  describe 'a record deletion' do
+    before(:each) do
+      Article.first.destroy
+
+      Article.__elasticsearch__.refresh_index!
+    end
+
+    it 'makes the document unsearchable' do
+      expect(Article.search('Test').records.size).to eq(0)
+    end
+  end
+
+  context 'when an article\'s comment updated' do
+    def updating_articles_comment
+      Article.last.tap do |a|
+        a.comments.where(body: 'Comment1').first.tap do |c|
+          c.body = 'Comment2'
+          c.save!
+        end
+      end
+
+      Article.__elasticsearch__.refresh_index!
+    end
+
+    def number_of_articles_found_for_the_old_comment
+      Article.search('Comment1').records.size
+    end
+
+    def number_of_articles_found_for_the_new_comment
+      Article.search('Comment2').records.size
+    end
+
+    it 'makes the article unsearchable with the old comment' do
+      expect { updating_articles_comment }.to change { number_of_articles_found_for_the_old_comment }.by(-1)
+    end
+
+    it 'makes the article searchable with the new comment' do
+      expect { updating_articles_comment }.to change { number_of_articles_found_for_the_new_comment }.by(1)
+    end
+  end
+
+  context 'when an article\'s comment destroyed' do
+    def destroying_articles_comment
+      Article.last.tap do |a|
+        a.comments.where(body: 'Comment1').first.tap do |c|
+          c.destroy
+        end
+      end
+
+      Article.__elasticsearch__.refresh_index!
+    end
+
+    def number_of_articles_found_for_the_comment
+      Article.search('Comment1').records.size
+    end
+
+    it 'makes the article unsearchable with the old comment' do
+      expect { destroying_articles_comment }.to change { number_of_articles_found_for_the_comment }.by(-1)
+    end
+  end
+end
+
+RSpec.shared_examples 'a search supporting polymorphic associations' do
+  def find_author_by_nickname(name)
+    if Author.respond_to?(:find_by)
+      # Rails 4
+      Author.find_by(nickname: name)
+    else
+      # Rails 3
+      Author.find_by_nickname(name)
+    end
+  end
+
+  def find_book_by_title(title)
+    if Book.respond_to?(:find_by)
+      Book.find_by(title: title)
+    else
+      Book.find_by_title(title)
+    end
+  end
+
+  context 'when an author is created' do
+    before(:each) do
+      ::Author.create(nickname: 'Touma', created_at: Time.now, books_attributes: [{title: 'new_book'}])
+
+      ::Author.__elasticsearch__.refresh_index!
+    end
+
+    it 'makes the author\'s document searchable' do
+      expect(Author.search('Touma').records.size).to eq(1)
+      expect(Author.search('new_book').records.size).to eq(1)
+      expect(Author.search(query: {term: {'books.title' => 'new_book'}}).records.size).to eq(1)
+      expect(Author.search(query: {term: {'num_books' => 2}}).records.size).to eq(1)
+      expect(Author.search(query: {term: {'num_books' => 1}}).records.size).to eq(2)
+    end
+  end
+
+  context 'when one of the books is updated' do
+    def updating_the_book_with_new_title
+      find_book_by_title('Code').update_attributes title: 'Think'
+
+      Author.__elasticsearch__.refresh_index!
+      Book.__elasticsearch__.refresh_index!
+    end
+
+    def number_of_authors_found_for_the_new_title
+      Author.search('Think').records.size
+    end
+
+    def number_of_books_found_for_the_new_title
+      Book.search('Think').records.size
+    end
+
+    it 'makes the author\'s document searchable' do
+      expect { updating_the_book_with_new_title }.to change { number_of_authors_found_for_the_new_title }.by(1)
+    end
+
+    it 'makes the book\'s document searchable' do
+      expect { updating_the_book_with_new_title }.to change { number_of_books_found_for_the_new_title }.by(1)
+    end
+  end
+
+  context 'when one of the books is destroyed' do
+    def destroying_the_book
+      find_book_by_title('Test').destroy
+
+      Author.__elasticsearch__.refresh_index!
+      Book.__elasticsearch__.refresh_index!
+    end
+
+    def number_of_authors_found
+      Author.search('Test').records.size
+    end
+
+    def number_of_books_found
+      Book.search('Test').records.size
+    end
+
+    it 'makes the author having the book unsearchable' do
+      expect { destroying_the_book }.to change { number_of_authors_found }.by(-1)
+    end
+
+    it 'makes the book unsearchable' do
+      expect { destroying_the_book }.to change { number_of_books_found }.by(-1)
+    end
+  end
+
+  context 'when the author is updated' do
+    before(:each) do
+      find_author_by_nickname('Kuroko').update_attributes nickname: 'Test2', books_attributes: [{title: 'new_book'}]
+
+      Author.__elasticsearch__.refresh_index!
+    end
+
+    it 'makes the document unsearchable using the old content' do
+      expect(Author.search('Kuroko').records.size).to eq(0)
+      expect(Author.search(query: {term: {'num_books' => 2}}).records.size).to eq(0)
+    end
+
+    it 'makes the document searchable using the new content' do
+      expect(Author.search('Test2').records.size).to eq(1)
+      expect(Author.search('new_book').records.size).to eq(1)
+      expect(Author.search(query: {term: {'books.title' => 'new_book'}}).records.size).to eq(1)
+    end
+
+    it 'updates the dependent field' do
+      expect(Author.search(query: {term: {'num_books' => 1}}).records.size).to eq(1)
+      expect(Author.search(query: {term: {'num_books' => 3}}).records.size).to eq(1)
+    end
+  end
+
+  context 'when the author is deleted' do
+    before(:each) do
+      find_author_by_nickname('Kuroko').destroy
+
+      Author.__elasticsearch__.refresh_index!
+    end
+
+    it 'makes the document unsearchable' do
+      expect(Author.search('Kuroko').records.size).to eq(0)
+    end
+  end
+
+  context 'when an author\'s tag is updated' do
+    def updating_an_authors_tag
+      tag = find_author_by_nickname('Kuroko').tags.where(body: 'coding').first
+      tag.tap do |t|
+        t.body = 'thinking'
+        t.save!
+      end
+
+      Author.__elasticsearch__.refresh_index!
+    end
+
+    def number_of_authors_found_for_the_old_tag
+      Author.search('coding').records.size
+    end
+
+    def number_of_authors_found_for_the_new_tag
+      Author.search('thinking').records.size
+    end
+
+    it 'makes the author unsearchable with the old tag' do
+      expect { updating_an_authors_tag }.to change { number_of_authors_found_for_the_old_tag }.by(-1)
+    end
+
+    it 'makes the author seachable with the new tag' do
+      expect { updating_an_authors_tag }.to change { number_of_authors_found_for_the_new_tag }.by(1)
+    end
+  end
+
+  context 'when an author\'s tag is destroyed' do
+    def destroying_a_tag_for_an_author
+      tag = find_author_by_nickname('Kuroko').tags.where(body: 'coding').first
+      tag.destroy
+
+      Author.__elasticsearch__.refresh_index!
+    end
+
+    def number_of_authors_found_for_the_tag
+      Author.search('coding').records.size
+    end
+
+    it 'makes an author unsearchable' do
+      expect { destroying_a_tag_for_an_author }.to change { number_of_authors_found_for_the_tag }.by(-1)
+    end
+  end
+
+  context 'when an book\'s tag is destroyed' do
+    def destroying_a_books_tag
+      find_book_by_title('Test').tags.where(body: 'testing').first.destroy
+
+      Book.__elasticsearch__.refresh_index!
+    end
+
+    def number_of_books_found_for_the_tag
+      Book.search('testing').records.size
+    end
+
+    it 'makes the book unsearchable' do
+      expect { destroying_a_books_tag }.to change { number_of_books_found_for_the_tag }.by(-1)
+    end
+  end
+
+  context 'when an book\'s tag is updated' do
+    def updating_a_books_tag_with_a_new_body
+      find_book_by_title('Test').tags.where(body: 'testing').first.tap do |t|
+        t.body = 'thinking'
+        t.save!
+      end
+
+      Book.__elasticsearch__.refresh_index!
+    end
+
+    def number_of_books_found_for_the_old_tag
+      Book.search('testing').records.size
+    end
+
+    def number_of_books_found_for_the_new_tag
+      Book.search('thinking').records.size
+    end
+
+    it 'makes the book unsearchable with the old tag' do
+      expect { updating_a_books_tag_with_a_new_body }.to change { number_of_books_found_for_the_old_tag }.by(-1)
+    end
+
+    it 'makes the book searchable with the new tag' do
+      expect { updating_a_books_tag_with_a_new_body }.to change { number_of_books_found_for_the_new_tag }.by(1)
+    end
+  end
+
+  # TODO Describe about logical deletion
+end
+
 RSpec.describe 'integration' do
   context 'with articles' do
     before :each do
@@ -54,10 +366,26 @@ RSpec.describe 'integration' do
       end
     end
 
-    it_behaves_like 'a normal elasticsearch-model object'
+    it_behaves_like 'a search supporting automatic as_indexed_json creation'
   end
 
-  context 'with articles_with_comments_and_delayed_jobs' do
+  context 'with articles and comments' do
+    before(:each) do
+      load 'setup/articles_with_comments.rb'
+    end
+
+    after(:each) do
+      ActiveRecord::Schema.define(:version => 2) do
+        drop_table :articles
+        drop_table :comments
+      end
+    end
+
+    it_behaves_like 'a search supporting automatic as_indexed_json creation'
+    it_behaves_like 'a search supporting association'
+  end
+
+  context 'with articles, comments and delayed_jobs' do
     before(:each) do
       load 'setup/articles_with_comments_and_delayed_jobs.rb'
     end
@@ -70,6 +398,24 @@ RSpec.describe 'integration' do
       end
     end
 
-    it_behaves_like 'a normal elasticsearch-model object'
+    it_behaves_like 'a search supporting automatic as_indexed_json creation'
+    it_behaves_like 'a search supporting association'
+  end
+
+  context 'with authors, books and tags' do
+    before(:each) do
+      load 'setup/authors_and_books_with_tags.rb'
+    end
+
+    after(:each) do
+      ActiveRecord::Schema.define(:version => 2) do
+        drop_table :books
+        drop_table :tags
+        drop_table :author_profiles
+        drop_table :authors
+      end
+    end
+
+    it_behaves_like 'a search supporting polymorphic associations'
   end
 end

data/spec/partial_updating_spec.rb

@@ -12,19 +12,49 @@ RSpec.describe Elasticsearch::Model::Extensions::PartialUpdating do
     end
   end
 
-  let(:as_json_options) {
-    described_class.build_as_json_options(klass: Article, props: Article.mappings.to_hash[Article.document_type.intern][:properties])
-  }
-
   subject {
     Article.last
   }
 
   specify {
-    expect(as_json_options).to include(methods: :num_comments)
+    expect(subject.respond_to? :partially_update_document).to be_truthy
   }
 
   specify {
-    expect(subject.build_partial_document_for_update(:comments)).to include(:comments, :num_comments)
+    expect(subject.as_indexed_json).to eq(
+                                         "comments"=>[{"body"=>'Comment1'}],
+                                         "num_comments"=>1,
+                                         "title"=>'Coding',
+                                         "created_at"=>subject.created_at
+                                       )
   }
+
+  describe Elasticsearch::Model::Extensions::PartialUpdating::PartialUpdater do
+    subject {
+      described_class.new(Article)
+    }
+
+    specify {
+      expect(subject.as_json_options).to include(methods: "num_comments")
+    }
+
+    specify {
+      expect(subject.build_partial_document_for_update(record: Article.last, changed_attributes: [:comments])).to include(:comments, :num_comments)
+    }
+
+    def partially_updating_a_record
+      article = Article.last
+      subject.update_document(id: article.id, doc: { comments: [ { body: 'ModifiedComment ' } ] })
+      Article.__elasticsearch__.refresh_index!
+    end
+
+    def number_of_articles_for_the_new_comment
+      Article.search('ModifiedComment').records.size
+    end
+
+    specify {
+      expect { partially_updating_a_record }.to change { number_of_articles_for_the_new_comment }.by(1)
+    }
+  end
 end
+

data/spec/setup/articles_with_comments.rb

@@ -26,12 +26,10 @@ class ::Article < ActiveRecord::Base
   include Elasticsearch::Model::Extensions::BatchUpdating
   include Elasticsearch::Model::Extensions::PartialUpdating
 
-  DEPENDENT_CUSTOM_ATTRIBUTES = {
-    %w| comments | => %w| num_comments |
-  }
-
   include Elasticsearch::Model::Extensions::DependencyTracking
 
+  tracks_attributes_dependencies %w| comments | => %w| num_comments |
+
   settings index: {number_of_shards: 1, number_of_replicas: 0} do
     mapping do
       indexes :title, type: 'string', analyzer: 'snowball'