Split spec/integration_spec.rb

.rspec

@@ -1 +1,2 @@
 --color
+--require spec_helper

spec/configuration_spec.rb

@@ -1,4 +1,6 @@
 require 'spec_helper'
+require 'support/models/book'
+require 'support/models/color'
 
 describe MeiliSearch::Rails::Configuration do
   before { stub_const('MeiliSearch::Rails::VERSION', '0.0.1') }
@@ -63,6 +65,20 @@
     end
   end
 
+  context 'with per_environment' do
+    # per_environment is already enabled in testing
+    # no setup is required
+
+    it 'adds a Rails env-based index suffix' do
+      expect(Color.index_uid).to eq(safe_index_uid('Color') + "_#{Rails.env}")
+    end
+
+    it 'uses suffix in the additional index as well' do
+      index = Book.index(safe_index_uid('Book'))
+      expect(index.uid).to eq("#{safe_index_uid('Book')}_#{Rails.env}")
+    end
+  end
+
   context 'when use Meilisearch without configuration' do
     around do |example|
       config = MeiliSearch::Rails.configuration

spec/instance_methods_spec.rb

@@ -0,0 +1,101 @@
+require 'support/models/book'
+require 'support/models/animals'
+require 'support/models/people'
+require 'support/models/movie'
+
+describe 'Instance methods' do
+  describe '#ms_entries' do
+    it 'includes conditionally enabled indexes' do
+      book = Book.create!(
+        name: 'Frankenstein', author: 'Mary Shelley',
+        premium: false, released: true
+      )
+
+      expect(book.ms_entries).to contain_exactly(
+        a_hash_including("index_uid" => safe_index_uid('SecuredBook')),
+        a_hash_including("index_uid" => safe_index_uid('BookAuthor')),
+        a_hash_including("index_uid" => safe_index_uid('Book')),
+      )
+    end
+
+    it 'includes conditionally disabled indexes' do
+      # non public book
+      book = Book.create!(
+        name: 'Frankenstein', author: 'Mary Shelley',
+        premium: false, released: false
+      )
+
+      expect(book.ms_entries).to contain_exactly(
+        a_hash_including("index_uid" => safe_index_uid('SecuredBook')),
+        a_hash_including("index_uid" => safe_index_uid('BookAuthor')),
+        # also includes book's id as if it was a public book
+        a_hash_including("index_uid" => safe_index_uid('Book')),
+      )
+    end
+
+    context 'when models share an index' do
+      it 'does not return instances of other models' do
+        TestUtil.reset_animals!
+
+        toby_dog = Dog.create!(name: 'Toby the Dog')
+        taby_cat = Cat.create!(name: 'Taby the Cat')
+
+        expect(toby_dog.ms_entries).to contain_exactly(
+          a_hash_including('primary_key' => /dog_\d+/))
+
+        expect(taby_cat.ms_entries).to contain_exactly(
+          a_hash_including('primary_key' => /cat_\d+/))
+      end
+    end
+  end
+
+  describe '#ms_index!' do
+    it 'returns array with single task with single index' do
+      TestUtil.reset_movies!
+
+      task = Movie.create(title: 'Harry Potter').ms_index!
+
+      expect(task).to contain_exactly(a_hash_including('taskUid'))
+    end
+
+    it 'returns array of tasks with multiple indexes' do
+      TestUtil.reset_books!
+
+      moby_dick = Book.create! name: 'Moby Dick', author: 'Herman Melville', premium: false, released: true
+
+      tasks = moby_dick.ms_index!
+
+      expect(tasks).to contain_exactly(
+        a_hash_including('uid'),
+        a_hash_including('taskUid'),
+        a_hash_including('taskUid')
+      )
+    end
+
+    it 'throws error on non-persisted instances' do
+      expect { Color.new(name: 'purple').index!(true) }.to raise_error(ArgumentError)
+    end
+  end
+
+  describe '#ms_remove_from_index!' do
+    it 'throws error on non-persisted instances' do
+      expect { Color.new(name: 'purple').remove_from_index!(true) }.to raise_error(ArgumentError)
+    end
+
+    context 'when :auto_remove is disabled' do
+      it 'is able to remove manually' do
+        TestUtil.reset_people!
+
+        bob = People.create(first_name: 'Bob', last_name: 'Sponge', card_number: 75_801_889)
+
+        result = People.raw_search('Bob')
+        expect(result['hits']).to be_one
+
+        bob.remove_from_index!
+
+        result = People.raw_search('Bob')
+        expect(result['hits']).to be_empty
+      end
+    end
+  end
+end

spec/integration/active_record/attributes_have_changed_spec.rb

@@ -0,0 +1,50 @@
+require 'support/models/color'
+require 'support/models/book'
+
+describe 'When record attributes have changed' do
+  it 'detects attribute changes' do
+    color = Color.new name: 'dark-blue', short_name: 'blue'
+
+    expect(Color.ms_must_reindex?(color)).to be(true)
+    color.save
+    expect(Color.ms_must_reindex?(color)).to be(false)
+
+    color.hex = 123_456
+    expect(Color.ms_must_reindex?(color)).to be(false)
+
+    color.not_indexed = 'strstr'
+    expect(Color.ms_must_reindex?(color)).to be(false)
+    color.name = 'red'
+    expect(Color.ms_must_reindex?(color)).to be(true)
+    color.delete
+  end
+
+  it 'detects attribute changes even in a transaction' do
+    color = Color.new name: 'dark-blue', short_name: 'blue'
+    color.save
+    expect(color.instance_variable_get('@ms_must_reindex')).to be_nil
+    Color.transaction do
+      color.name = 'red'
+      color.save
+      color.not_indexed = 'strstr'
+      color.save
+      expect(color.instance_variable_get('@ms_must_reindex')).to be(true)
+    end
+    expect(color.instance_variable_get('@ms_must_reindex')).to be_nil
+    color.delete
+  end
+
+  it 'detects change with ms_dirty? method' do
+    book = Book.new name: 'My life', author: 'Myself', premium: false, released: true
+
+    allow(book).to receive(:ms_dirty?).and_return(true)
+    expect(Book.ms_must_reindex?(book)).to be(true)
+
+    allow(book).to receive(:ms_dirty?).and_return(false)
+    expect(Book.ms_must_reindex?(book)).to be(false)
+
+    allow(book).to receive(:ms_dirty?).and_return(true)
+    expect(Book.ms_must_reindex?(book)).to be(true)
+  end
+end
+

spec/integration/active_record/record_has_associations_spec.rb

@@ -0,0 +1,24 @@
+require 'support/models/post'
+
+describe 'When a record has associations' do
+  before(:all) do
+    Post.clear_index!(true)
+  end
+
+  it 'eagerly loads associations' do
+    post1 = Post.new(title: 'foo')
+    post1.comments << Comment.new(body: 'one')
+    post1.comments << Comment.new(body: 'two')
+    post1.save!
+
+    post2 = Post.new(title: 'bar')
+    post2.comments << Comment.new(body: 'three')
+    post2.comments << Comment.new(body: 'four')
+    post2.save!
+
+    assert_queries(2) do
+      Post.reindex!
+    end
+  end
+end
+

spec/integration/active_record/record_is_updated_spec.rb

@@ -0,0 +1,45 @@
+require 'support/models/book'
+require 'support/models/color'
+
+describe 'When record is updated' do
+  it 'updates the changed attributes on the index' do
+    purple = Color.create!(name: 'purple', short_name: 'p')
+    expect(Color.search('purple')).to be_one
+    expect(Color.search('pink')).to be_empty
+
+    purple.update name: 'pink'
+    expect(Color.search('purple')).to be_empty
+    expect(Color.search('pink')).to be_one
+  end
+
+  it 'automatically removes document from conditional indexes' do
+    TestUtil.reset_books!
+
+    # add a new public book which is public (not premium but released)
+    book = Book.create! name: 'Public book', author: 'me', premium: false, released: true
+
+    # should be searchable in the 'Book' index
+    index = Book.index(safe_index_uid('Book'))
+    results = index.search('Public book')
+    expect(results['hits']).to be_one
+
+    # update the book and make it non-public anymore (not premium, not released)
+    book.update released: false
+
+    # should be removed from the index
+    results = index.search('Public book')
+    expect(results['hits']).to be_empty
+  end
+
+  context 'when attributes have not changed' do
+    it 'does not call the API' do
+      TestUtil.reset_people!
+
+      jane = People.create(first_name: 'Jane', last_name: 'Doe', card_number: 75_801_887)
+
+      expect do
+        jane.update(first_name: 'Jane')
+      end.not_to change(People.index.tasks['results'], :count)
+    end
+  end
+end