Document and cover class-level indexing timeout options

CHANGELOG.md

@@ -1,5 +1,6 @@
 ### 0.8.3 (Next)
 
+* [#59](https://github.com/mongoid/mongoid_fulltext/pull/59): Document and cover class-level indexing timeout options - [@dblock](https://github.com/dblock).
 * [#51](https://github.com/mongoid/mongoid_fulltext/pull/51): Modernize CI through Ruby 4.0, Mongoid 9, and MongoDB 8 with real coverage, RuboCop 1.92, and fork-safe Danger workflows - [@dblock](https://github.com/dblock).
 * [#45](https://github.com/mongoid/mongoid_fulltext/pull/45): Allow for class level ngram updates to not timeout - [@roykolak](https://github.com/roykolak).
 * Your contribution here.

README.md

@@ -254,6 +254,8 @@ had never been defined - you see both models that both pass and fail the filter
 Indexing Options
 ----------------
 
+`Artwork.update_ngram_index(timeout: false)` rebuilds the index for all records without a cursor timeout; the `timeout` option belongs to the class method, not the per-document `artwork.update_ngram_index` method.
+
 Additional indexing/query options can be used as parameters to `fulltext_search_in`.
 
 * `alphabet`: letters to index, default is `abcdefghijklmnopqrstuvwxyz0123456789 `.

spec/mongoid/timeout_option_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe 'Class-level indexing timeout options' do
+  it 'rebuilds all records with cursor timeouts disabled' do
+    first = DelayedArtwork.create!(title: 'Flowers 1')
+    second = DelayedArtwork.create!(title: 'Flowers 2')
+    expect(DelayedArtwork.fulltext_search('flower')).to eq([])
+    DelayedArtwork.update_ngram_index(timeout: false)
+    expect(DelayedArtwork.fulltext_search('flower')).to match_array([first, second])
+  end
+
+  it 'applies the no_timeout option to the class criteria' do
+    items = DelayedArtwork.all
+    expect(DelayedArtwork).to receive(:all).and_return(items)
+    expect(items).to receive(:no_timeout).and_call_original
+    DelayedArtwork.update_ngram_index(timeout: false)
+  end
+end