thinking-sphinx 1.2.13 → 6.0.0

data/spec/acceptance/sphinx_scopes_spec.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require 'acceptance/spec_helper'
+
+describe 'Sphinx scopes', :live => true do
+  it "allows calling sphinx scopes from models" do
+    gods  = Book.create! :title => 'American Gods',      :publishing_year => 2001
+    boys  = Book.create! :title => 'Anansi Boys',        :publishing_year => 2005
+    grave = Book.create! :title => 'The Graveyard Book', :publishing_year => 2009
+    index
+
+    expect(Book.by_publishing_year(2009).to_a).to eq([grave])
+  end
+
+  it "allows scopes to return both query and options" do
+    gods  = Book.create! :title => 'American Gods',      :publishing_year => 2001
+    boys  = Book.create! :title => 'Anansi Boys',        :publishing_year => 2005
+    grave = Book.create! :title => 'The Graveyard Book', :publishing_year => 2009
+    index
+
+    expect(Book.by_query_and_publishing_year('Graveyard', 2009).to_a).to eq([grave])
+  end
+
+  it "allows chaining of scopes" do
+    gods  = Book.create! :title => 'American Gods',      :publishing_year => 2001
+    boys  = Book.create! :title => 'Anansi Boys',        :publishing_year => 2005
+    grave = Book.create! :title => 'The Graveyard Book', :publishing_year => 2009
+    index
+
+    expect(Book.by_publishing_year(2001..2005).ordered.to_a).to eq([boys, gods])
+  end
+
+  it "allows chaining of scopes that include queries" do
+    gods  = Book.create! :title => 'American Gods',      :publishing_year => 2001
+    boys  = Book.create! :title => 'Anansi Boys',        :publishing_year => 2005
+    grave = Book.create! :title => 'The Graveyard Book', :publishing_year => 2009
+    index
+
+    expect(Book.by_publishing_year(2001).by_query_and_publishing_year('Graveyard', 2009).to_a).
+      to eq([grave])
+  end
+
+  it "allows further search calls on scopes" do
+    gaiman    = Book.create! :title => 'American Gods'
+    pratchett = Book.create! :title => 'Small Gods'
+    index
+
+    expect(Book.by_query('Gods').search('Small').to_a).to eq([pratchett])
+  end
+
+  it "allows facet calls on scopes" do
+    Book.create! :title => 'American Gods', :author => 'Neil Gaiman'
+    Book.create! :title => 'Anansi Boys',   :author => 'Neil Gaiman'
+    Book.create! :title => 'Small Gods',    :author => 'Terry Pratchett'
+    index
+
+    expect(Book.by_query('Gods').facets.to_hash[:author]).to eq({
+      'Neil Gaiman' => 1, 'Terry Pratchett' => 1
+    })
+  end
+
+  it "allows accessing counts on scopes" do
+    Book.create! :title => 'American Gods'
+    Book.create! :title => 'Anansi Boys'
+    Book.create! :title => 'Small Gods'
+    Book.create! :title => 'Night Watch'
+    index
+
+    expect(Book.by_query('gods').count).to eq(2)
+  end
+
+  it 'raises an exception when trying to modify a populated request' do
+    request = Book.by_query('gods')
+    request.count
+
+    expect { request.search('foo') }.to raise_error(
+      ThinkingSphinx::PopulatedResultsError
+    )
+  end
+
+  it "handles a chainable 'none' scope and returns nothing" do
+    Book.create! :title => 'Small Gods'
+    index
+
+    expect(Book.by_query('gods').none).to be_empty
+  end
+end

data/spec/acceptance/sql_deltas_spec.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'acceptance/spec_helper'
+
+describe 'SQL delta indexing', :live => true do
+  it "automatically indexes new records" do
+    guards = Book.create(
+      :title => 'Guards! Guards!', :author => 'Terry Pratchett'
+    )
+    index
+
+    expect(Book.search('Terry Pratchett').to_a).to eq([guards])
+
+    men = Book.create(
+      :title => 'Men At Arms', :author => 'Terry Pratchett'
+    )
+    sleep 0.25
+
+    expect(Book.search('Terry Pratchett').to_a).to match_array([guards, men])
+  end
+
+  it "automatically indexes updated records" do
+    book = Book.create :title => 'Night Watch', :author => 'Harry Pritchett'
+    index
+
+    expect(Book.search('Harry').to_a).to eq([book])
+
+    book.reload.update(:author => 'Terry Pratchett')
+    sleep 0.25
+
+    expect(Book.search('Terry').to_a).to eq([book])
+  end
+
+  it "does not match on old values" do
+    book = Book.create :title => 'Night Watch', :author => 'Harry Pritchett'
+    index
+
+    expect(Book.search('Harry').to_a).to eq([book])
+
+    book.reload.update(:author => 'Terry Pratchett')
+    sleep 0.25
+
+    expect(Book.search('Harry')).to be_empty
+  end
+
+  it "does not match on old values with alternative ids" do
+    album = Album.create :name => 'Eternal Nightcap', :artist => 'The Whitloms'
+    index
+
+    expect(Album.search('Whitloms').to_a).to eq([album])
+
+    album.reload.update(:artist => 'The Whitlams')
+    sleep 0.25
+
+    expect(Book.search('Whitloms')).to be_empty
+  end
+
+  it "automatically indexes new records of subclasses" do
+    book = Hardcover.create(
+      :title => 'American Gods', :author => 'Neil Gaiman'
+    )
+    sleep 0.25
+
+    expect(Book.search('Gaiman').to_a).to eq([book])
+  end
+
+  it "updates associated models" do
+    colour = Colour.create(:name => 'green')
+    sleep 0.25
+
+    expect(Colour.search('green').to_a).to eq([colour])
+
+    tee = colour.tees.create
+    sleep 0.25
+
+    expect(Colour.search(:with => {:tee_ids => tee.id}).to_a).to eq([colour])
+  end
+end

data/spec/acceptance/support/database_cleaner.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :truncation
+  end
+
+  config.after(:each) do |example|
+    if example.example_group_instance.class.metadata[:live]
+      DatabaseCleaner.clean
+    end
+  end
+end

data/spec/acceptance/support/sphinx_controller.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+class SphinxController
+  def initialize
+    config.searchd.mysql41 = 9307
+  end
+
+  def setup
+    FileUtils.mkdir_p config.indices_location
+    config.controller.bin_path = ENV['SPHINX_BIN'] || ''
+    config.render_to_file && index
+
+    ThinkingSphinx::Configuration.reset
+
+    if Rails::VERSION::MAJOR < 7
+      ActiveSupport::Dependencies.loaded.each do |path|
+        $LOADED_FEATURES.delete "#{path}.rb"
+      end
+
+      ActiveSupport::Dependencies.clear
+    end
+
+    config.searchd.mysql41 = 9307
+    config.settings['quiet_deltas']      = true
+    config.settings['attribute_updates'] = true
+    config.controller.bin_path           = ENV['SPHINX_BIN'] || ''
+  end
+
+  def start
+    config.controller.start
+  rescue Riddle::CommandFailedError => error
+    puts <<-TXT
+
+The Sphinx start command failed:
+  Command: #{error.command_result.command}
+  Status:  #{error.command_result.status}
+  Output:  #{error.command_result.output}
+    TXT
+    raise error
+  end
+
+  def stop
+    while config.controller.running? do
+      config.controller.stop
+      sleep(0.1)
+    end
+  end
+
+  def index(*indices)
+    ThinkingSphinx::Commander.call :index_sql, config, :indices => indices
+  end
+
+  def merge
+    ThinkingSphinx::Commander.call(:merge_and_update, config, {})
+  end
+
+  private
+
+  def config
+    ThinkingSphinx::Configuration.instance
+  end
+end

data/spec/acceptance/support/sphinx_helpers.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module SphinxHelpers
+  def sphinx
+    @sphinx ||= SphinxController.new
+  end
+
+  def index(*indices)
+    sleep 0.5 if ENV['CI']
+
+    yield if block_given?
+
+    sphinx.index *indices
+    sleep 0.25
+    sleep 0.5 if ENV['CI']
+  end
+
+  def merge
+    sleep 0.5 if ENV['CI']
+    sleep 0.5
+
+    sphinx.merge
+    sleep 1.5
+    sleep 0.5 if ENV['CI']
+  end
+end
+
+RSpec.configure do |config|
+  config.include SphinxHelpers
+
+  config.before :all do |group|
+    FileUtils.rm_rf ThinkingSphinx::Configuration.instance.indices_location
+    FileUtils.rm_rf ThinkingSphinx::Configuration.instance.searchd.binlog_path
+
+    sphinx.setup && sphinx.start if group.class.metadata[:live]
+  end
+
+  config.after :all do |group|
+    sphinx.stop if group.class.metadata[:live]
+  end
+
+  config.after :suite do
+    SphinxController.new.stop
+  end
+end

data/spec/acceptance/suspended_deltas_spec.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'acceptance/spec_helper'
+
+describe 'Suspend deltas for a given action', :live => true do
+  it "does not update the delta indices until after the block is finished" do
+    book = Book.create :title => 'Night Watch', :author => 'Harry Pritchett'
+    index
+
+    expect(Book.search('Harry').to_a).to eq([book])
+
+    ThinkingSphinx::Deltas.suspend :book do
+      book.reload.update(:author => 'Terry Pratchett')
+      sleep 0.25
+
+      expect(Book.search('Terry').to_a).to eq([])
+    end
+
+    sleep 0.25
+    expect(Book.search('Terry').to_a).to eq([book])
+  end
+
+  it "returns core records even though they are no longer valid" do
+    book = Book.create :title => 'Night Watch', :author => 'Harry Pritchett'
+    index
+
+    expect(Book.search('Harry').to_a).to eq([book])
+
+    ThinkingSphinx::Deltas.suspend :book do
+      book.reload.update(:author => 'Terry Pratchett')
+      sleep 0.25
+
+      expect(Book.search('Terry').to_a).to eq([])
+    end
+
+    sleep 0.25
+    expect(Book.search('Harry').to_a).to eq([book])
+  end
+
+  it "marks core records as deleted" do
+    book = Book.create :title => 'Night Watch', :author => 'Harry Pritchett'
+    index
+
+    expect(Book.search('Harry').to_a).to eq([book])
+
+    ThinkingSphinx::Deltas.suspend_and_update :book do
+      book.reload.update(:author => 'Terry Pratchett')
+      sleep 0.25
+
+      expect(Book.search('Terry').to_a).to eq([])
+    end
+
+    sleep 0.25
+    expect(Book.search('Harry').to_a).to be_empty
+  end
+end

data/spec/fixtures/database.yml

@@ -0,0 +1,4 @@
+username: root
+password: thinking_sphinx
+host: localhost
+database: thinking_sphinx

data/spec/internal/app/indices/admin_person_index.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+ThinkingSphinx::Index.define 'admin/person', :with => :active_record do
+  indexes name
+end
+
+ThinkingSphinx::Index.define 'admin/person', :with => :real_time, :name => 'admin_person_rt' do
+  indexes name
+end

data/spec/internal/app/indices/album_index.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+ThinkingSphinx::Index.define :album, :with => :active_record, :primary_key => :integer_id, :delta => true do
+  indexes name, artist
+end
+
+ThinkingSphinx::Index.define :album, :with => :real_time, :primary_key => :integer_id, :name => :album_real do
+  indexes name, artist
+end

data/spec/internal/app/indices/animal_index.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+ThinkingSphinx::Index.define :animal, :with => :active_record do
+  indexes name
+end

data/spec/internal/app/indices/article_index.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+ThinkingSphinx::Index.define :article, :with => :active_record do
+  indexes title, content
+  indexes user.name, :as => :user
+  indexes user.articles.title, :as => :related_titles
+
+  has published, user_id
+  has taggings.tag_id, :as => :tag_ids, :source => :query
+  has taggings.created_at, :as => :taggings_at, :type => :timestamp
+
+  set_property :min_infix_len => 4
+end
+
+ThinkingSphinx::Index.define :article, :with => :active_record,
+  :name => 'stemmed_article' do
+
+  indexes title
+
+  has published, user_id
+  has taggings.tag_id, :as => :tag_ids
+  has taggings.created_at, :as => :taggings_at, :type => :timestamp
+
+  set_property :morphology => 'stem_en'
+end
+
+ThinkingSphinx::Index.define :article, :name => :published_articles, :with => :real_time do
+  indexes title, content
+
+  scope { Article.where :published => true }
+end

data/spec/internal/app/indices/bird_index.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+FlightlessBird
+ThinkingSphinx::Index.define :bird, :with => :active_record do
+  indexes name
+end

data/spec/internal/app/indices/book_index.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+ThinkingSphinx::Index.define :book, :with => :active_record, :delta => true do
+  indexes title, :sortable => true
+  indexes author, :facet => true
+  indexes [title, author], :as => :info
+  indexes blurb_file, :file => true
+
+  has publishing_year
+  has created_at, :type => :timestamp
+end

data/spec/internal/app/indices/car_index.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+ThinkingSphinx::Index.define :car, :with => :real_time do
+  indexes name, :sortable => true
+
+  has manufacturer_id, :type => :integer
+end

data/spec/internal/app/indices/city_index.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+ThinkingSphinx::Index.define :city, :with => :active_record do
+  indexes name
+  has lat, lng
+
+  set_property :charset_table => '0..9, A..Z->a..z, _, a..z, U+410..U+42F->U+430..U+44F, U+430..U+44F, U+0130'
+  set_property :utf8? => true
+end

data/spec/internal/app/indices/colour_index.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+ThinkingSphinx::Index.define :colour, :with => :active_record, :delta => true do
+  indexes name
+
+  has tees.id, :as => :tee_ids
+end

data/spec/internal/app/indices/product_index.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+multi_schema = MultiSchema.new
+
+ThinkingSphinx::Index.define :product, :with => :real_time do
+  indexes name, :sortable => true
+
+  has category_ids, :type => :integer, :multi => true
+  has options, :type => :json if JSONColumn.call
+end
+
+if multi_schema.active?
+  ThinkingSphinx::Index.define(:product,
+    :name => :product_two, :offset_as => :product_two, :with => :real_time
+  ) do
+    indexes name, prefixes: true
+
+    set_property min_prefix_len: 1, dict: :keywords
+
+    scope do
+      multi_schema.switch :thinking_sphinx
+      User
+    end
+  end
+
+  multi_schema.switch :public
+end

data/spec/internal/app/indices/tee_index.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+ThinkingSphinx::Index.define :tee, :with => :active_record do
+  indexes colour.name
+  has colour_id, :facet => true
+end

data/spec/internal/app/indices/user_index.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+ThinkingSphinx::Index.define :user, :with => :active_record do
+  indexes name
+
+  has articles.taggings.tag_id, :as => :tag_ids, :facet => true
+
+  set_property :big_document_ids => true
+end

data/spec/internal/app/models/admin/person.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class Admin::Person < ActiveRecord::Base
+  self.table_name = 'admin_people'
+
+  ThinkingSphinx::Callbacks.append(
+    self, 'admin/person', :behaviours => [:sql, :real_time]
+  )
+end

data/spec/internal/app/models/album.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+class Album < ActiveRecord::Base
+  self.primary_key = :id
+
+  before_validation :set_id, :on => :create
+  before_validation :set_integer_id, :on => :create
+
+  ThinkingSphinx::Callbacks.append(
+    self, :behaviours => [:sql, :real_time, :deltas]
+  )
+
+  validates :id,         :presence => true, :uniqueness => true
+  validates :integer_id, :presence => true, :uniqueness => true
+
+  private
+
+  def set_id
+    self.id = (Album.maximum(:id) || "a").next
+  end
+
+  def set_integer_id
+    self.integer_id = (Album.maximum(:integer_id) || 0) + 1
+  end
+end

data/spec/internal/app/models/animal.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Animal < ActiveRecord::Base
+  ThinkingSphinx::Callbacks.append(self, :behaviours => [:sql])
+end

data/spec/internal/app/models/article.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class Article < ActiveRecord::Base
+  belongs_to :user
+  has_many :taggings
+  has_many :tags, :through => :taggings
+
+  ThinkingSphinx::Callbacks.append(self, :behaviours => [:sql, :updates])
+end

data/spec/internal/app/models/bird.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Bird < Animal
+  ThinkingSphinx::Callbacks.append(self, :behaviours => [:sql])
+end

data/spec/internal/app/models/book.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class Book < ActiveRecord::Base
+  include ThinkingSphinx::Scopes
+
+  has_and_belongs_to_many :genres
+
+  ThinkingSphinx::Callbacks.append(self, :behaviours => [:sql, :deltas])
+
+  sphinx_scope(:by_query) { |query| query }
+  sphinx_scope(:by_publishing_year) do |year|
+    {:with => {:publishing_year => year}}
+  end
+  sphinx_scope(:by_query_and_publishing_year) do |query, year|
+    [query, {:with => {:publishing_year =>year}}]
+  end
+  sphinx_scope(:ordered) { {:order => 'publishing_year DESC'} }
+end

data/spec/internal/app/models/car.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Car < ActiveRecord::Base
+  belongs_to :manufacturer
+
+  ThinkingSphinx::Callbacks.append(self, :behaviours => [:real_time])
+end

data/spec/internal/app/models/categorisation.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class Categorisation < ActiveRecord::Base
+  belongs_to :category
+  belongs_to :product
+
+  after_commit :update_product
+
+  private
+
+  def update_product
+    product.reload
+    ThinkingSphinx::RealTime.callback_for(:product, [:product]).after_save self
+  end
+end

data/spec/internal/app/models/category.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+class Category < ActiveRecord::Base
+  has_many :categorisations
+  has_many :products, :through => :categorisations
+end

data/spec/internal/app/models/city.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class City < ActiveRecord::Base
+  ThinkingSphinx::Callbacks.append(self, :behaviours => [:sql])
+
+  scope :ordered, lambda { order(:name) }
+end

data/spec/internal/app/models/colour.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Colour < ActiveRecord::Base
+  has_many :tees
+
+  ThinkingSphinx::Callbacks.append(self, behaviours: [:sql, :deltas])
+end

data/spec/internal/app/models/event.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Event < ActiveRecord::Base
+  belongs_to :eventable, :polymorphic => true
+end

data/spec/internal/app/models/flightless_bird.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class FlightlessBird < Bird
+end

data/spec/internal/app/models/genre.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Genre < ActiveRecord::Base
+  #
+end

data/spec/internal/app/models/hardcover.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Hardcover < Book
+  #
+end

data/spec/internal/app/models/mammal.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class Mammal < Animal
+end