thinking-sphinx 1.2.13 → 6.0.0

data/spec/acceptance/facets_spec.rb

@@ -0,0 +1,141 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+require 'acceptance/spec_helper'
+
+describe 'Faceted searching', :live => true do
+  it "provides facet breakdowns across marked integer attributes" do
+    blue  = Colour.create! :name => 'blue'
+    red   = Colour.create! :name => 'red'
+    green = Colour.create! :name => 'green'
+
+    Tee.create! :colour => blue
+    Tee.create! :colour => blue
+    Tee.create! :colour => red
+    Tee.create! :colour => green
+    Tee.create! :colour => green
+    Tee.create! :colour => green
+    index
+
+    expect(Tee.facets.to_hash[:colour_id]).to eq({
+      blue.id => 2, red.id => 1, green.id => 3
+    })
+  end
+
+  it "provides facet breakdowns across classes" do
+    Tee.create!
+    Tee.create!
+    City.create!
+    Article.create!
+    index
+
+    expect(ThinkingSphinx.facets.to_hash[:class]).to eq({
+      'Tee' => 2, 'City' => 1, 'Article' => 1
+    })
+  end
+
+  it "handles field facets" do
+    Book.create! :title => 'American Gods', :author => 'Neil Gaiman'
+    Book.create! :title => 'Anansi Boys',   :author => 'Neil Gaiman'
+    Book.create! :title => 'Snuff',         :author => 'Terry Pratchett'
+    Book.create! :title => '1Q84',          :author => '村上 春樹'
+    index
+
+    expect(Book.facets.to_hash[:author]).to eq({
+      'Neil Gaiman' => 2, 'Terry Pratchett' => 1, '村上 春樹' => 1
+    })
+  end
+
+  it "handles MVA facets" do
+    pancakes = Tag.create! :name => 'pancakes'
+    waffles  = Tag.create! :name => 'waffles'
+
+    user = User.create!
+    Tagging.create! :article => Article.create!(:user => user),
+      :tag => pancakes
+    Tagging.create! :article => Article.create!(:user => user),
+      :tag => waffles
+
+    user = User.create!
+    Tagging.create! :article => Article.create!(:user => user),
+      :tag => pancakes
+    index
+
+    expect(User.facets.to_hash[:tag_ids]).to eq({
+      pancakes.id => 2, waffles.id => 1
+    })
+  end
+
+  it "can filter on integer facet results" do
+    blue  = Colour.create! :name => 'blue'
+    red   = Colour.create! :name => 'red'
+
+    b1 = Tee.create! :colour => blue
+    b2 = Tee.create! :colour => blue
+    r1 = Tee.create! :colour => red
+    index
+
+    expect(Tee.facets.for(:colour_id => blue.id).to_a).to eq([b1, b2])
+  end
+
+  it "can filter on MVA facet results" do
+    pancakes = Tag.create! :name => 'pancakes'
+    waffles  = Tag.create! :name => 'waffles'
+
+    u1 = User.create!
+    Tagging.create! :article => Article.create!(:user => u1), :tag => pancakes
+    Tagging.create! :article => Article.create!(:user => u1), :tag => waffles
+
+    u2 = User.create!
+    Tagging.create! :article => Article.create!(:user => u2), :tag => pancakes
+    index
+
+    expect(User.facets.for(:tag_ids => waffles.id).to_a).to eq([u1])
+  end
+
+  it "can filter on string facet results" do
+    gods  = Book.create! :title => 'American Gods', :author => 'Neil Gaiman'
+    boys  = Book.create! :title => 'Anansi Boys', :author => 'Neil Gaiman'
+    snuff = Book.create! :title => 'Snuff', :author => 'Terry Pratchett'
+    index
+
+    expect(Book.facets.for(:author => 'Neil Gaiman').to_a).to eq([gods, boys])
+  end
+
+  it "allows enumeration" do
+    blue  = Colour.create! :name => 'blue'
+    red   = Colour.create! :name => 'red'
+
+    b1 = Tee.create! :colour => blue
+    b2 = Tee.create! :colour => blue
+    r1 = Tee.create! :colour => red
+    index
+
+    calls = 0
+    expectations = [
+      [:sphinx_internal_class, {'Tee' => 3}],
+      [:colour_id, {blue.id => 2, red.id => 1}],
+      [:class, {'Tee' => 3}]
+    ]
+    Tee.facets.each do |facet, hash|
+      expect(facet).to eq(expectations[calls].first)
+      expect(hash).to eq(expectations[calls].last)
+
+      calls += 1
+    end
+  end
+
+  it "can be called on distributed indices" do
+    blue  = Colour.create! :name => 'blue'
+    green = Colour.create! :name => 'green'
+
+    Tee.create! :colour => blue
+    Tee.create! :colour => blue
+    Tee.create! :colour => green
+    index
+
+    expect(Tee.facets(:indices => ["tee"]).to_hash[:colour_id]).to eq({
+      blue.id => 2, green.id => 1
+    })
+  end
+end

data/spec/acceptance/geosearching_spec.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'acceptance/spec_helper'
+
+describe 'Searching by latitude and longitude', :live => true do
+  it "orders by distance" do
+    mel = City.create :name => 'Melbourne', :lat => -0.6599720, :lng => 2.530082
+    syd = City.create :name => 'Sydney',    :lat => -0.5909679, :lng => 2.639131
+    bri = City.create :name => 'Brisbane',  :lat => -0.4794031, :lng => 2.670838
+    index
+
+    expect(City.search(:geo => [-0.616241, 2.602712], :order => 'geodist ASC').
+      to_a).to eq([syd, mel, bri])
+  end
+
+  it "filters by distance" do
+    mel = City.create :name => 'Melbourne', :lat => -0.6599720, :lng => 2.530082
+    syd = City.create :name => 'Sydney',    :lat => -0.5909679, :lng => 2.639131
+    bri = City.create :name => 'Brisbane',  :lat => -0.4794031, :lng => 2.670838
+    index
+
+    expect(City.search(
+      :geo  => [-0.616241, 2.602712],
+      :with => {:geodist => 0.0..470_000.0}
+    ).to_a).to eq([mel, syd])
+  end
+
+  it "provides the distance for each search result" do
+    mel = City.create :name => 'Melbourne', :lat => -0.6599720, :lng => 2.530082
+    syd = City.create :name => 'Sydney',    :lat => -0.5909679, :lng => 2.639131
+    bri = City.create :name => 'Brisbane',  :lat => -0.4794031, :lng => 2.670838
+    index
+
+    cities = City.search(:geo => [-0.616241, 2.602712], :order => 'geodist ASC')
+    if ENV.fetch('SPHINX_VERSION', '2.1.2').to_f > 2.1
+      expected = {:mysql => 249907.171875, :postgresql => 249912.03125}
+    else
+      expected = {:mysql => 250326.906250, :postgresql => 250331.234375}
+    end
+
+    adapter = nil
+
+    if ActiveRecord::VERSION::STRING.to_f > 6.0
+      adapter = ActiveRecord::Base.configurations.configs_for.first.adapter
+    elsif ActiveRecord::VERSION::STRING.to_f > 5.2
+      adapter = ActiveRecord::Base.configurations.configs_for.first.config["adapter"]
+    else
+      adapter = ActiveRecord::Base.configurations['test']['adapter']
+    end
+
+    if adapter[/postgres/]
+      expect(cities.first.geodist).to be_within(0.01).of(expected[:postgresql])
+    else # mysql
+      expect(cities.first.geodist).to be_within(0.01).of(expected[:mysql])
+    end
+  end
+
+  it "handles custom select clauses that refer to the distance" do
+    mel = City.create :name => 'Melbourne', :lat => -0.6599720, :lng => 2.530082
+    syd = City.create :name => 'Sydney',    :lat => -0.5909679, :lng => 2.639131
+    bri = City.create :name => 'Brisbane',  :lat => -0.4794031, :lng => 2.670838
+    index
+
+    expect(City.search(
+      :geo  => [-0.616241, 2.602712],
+      :with => {:geodist => 0.0..470_000.0},
+      :select => "*, geodist as custom_weight"
+    ).to_a).to eq([mel, syd])
+  end
+end

data/spec/acceptance/grouping_by_attributes_spec.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require 'acceptance/spec_helper'
+
+describe 'Grouping search results by attributes', :live => true do
+  it "groups by the provided attribute" do
+    snuff  = Book.create! :title => 'Snuff',          :publishing_year => 2011
+    earth  = Book.create! :title => 'The Long Earth', :publishing_year => 2012
+    dodger = Book.create! :title => 'Dodger',         :publishing_year => 2012
+
+    index
+
+    expect(Book.search(:group_by => :publishing_year).to_a).to eq([snuff, earth])
+  end
+
+  it "allows sorting within the group" do
+    snuff  = Book.create! :title => 'Snuff',          :publishing_year => 2011
+    earth  = Book.create! :title => 'The Long Earth', :publishing_year => 2012
+    dodger = Book.create! :title => 'Dodger',         :publishing_year => 2012
+
+    index
+
+    expect(Book.search(:group_by => :publishing_year, :order_group_by => 'title ASC').to_a).
+      to eq([snuff, dodger])
+  end
+
+  it "allows enumerating by count" do
+    snuff  = Book.create! :title => 'Snuff',          :publishing_year => 2011
+    earth  = Book.create! :title => 'The Long Earth', :publishing_year => 2012
+    dodger = Book.create! :title => 'Dodger',         :publishing_year => 2012
+
+    index
+
+    expectations = [[snuff, 1], [earth, 2]]
+
+    Book.search(:group_by => :publishing_year).each_with_count do |book, count|
+      expectation = expectations.shift
+
+      expect(book).to  eq(expectation.first)
+      expect(count).to eq(expectation.last)
+    end
+  end
+
+  it "allows enumerating by group" do
+    snuff  = Book.create! :title => 'Snuff',          :publishing_year => 2011
+    earth  = Book.create! :title => 'The Long Earth', :publishing_year => 2012
+    dodger = Book.create! :title => 'Dodger',         :publishing_year => 2012
+
+    index
+
+    expectations = [[snuff, 2011], [earth, 2012]]
+
+    Book.search(:group_by => :publishing_year).each_with_group do |book, group|
+      expectation = expectations.shift
+
+      expect(book).to  eq(expectation.first)
+      expect(group).to eq(expectation.last)
+    end
+  end
+
+  it "allows enumerating by group and count" do
+    snuff  = Book.create! :title => 'Snuff',          :publishing_year => 2011
+    earth  = Book.create! :title => 'The Long Earth', :publishing_year => 2012
+    dodger = Book.create! :title => 'Dodger',         :publishing_year => 2012
+
+    index
+
+    expectations = [[snuff, 2011, 1], [earth, 2012, 2]]
+    search       = Book.search(:group_by => :publishing_year)
+
+    search.each_with_group_and_count do |book, group, count|
+      expectation = expectations.shift
+
+      expect(book).to  eq(expectation[0])
+      expect(group).to eq(expectation[1])
+      expect(count).to eq(expectation[2])
+    end
+  end
+end

data/spec/acceptance/index_options_spec.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+require 'acceptance/spec_helper'
+
+describe 'Index options' do
+  let(:index) { ThinkingSphinx::ActiveRecord::Index.new(:article) }
+
+  %w( infix prefix ).each do |type|
+    context "all fields are #{type}ed" do
+      before :each do
+        index.definition_block = Proc.new {
+          indexes title
+          set_property "min_#{type}_len".to_sym => 3
+        }
+        index.render
+      end
+
+      it "keeps #{type}_fields blank" do
+        expect(index.send("#{type}_fields")).to be_nil
+      end
+
+      it "sets min_#{type}_len" do
+        expect(index.send("min_#{type}_len")).to eq(3)
+      end
+    end
+
+    context "some fields are #{type}ed" do
+      before :each do
+        index.definition_block = Proc.new {
+          indexes title, "#{type}es".to_sym => true
+          indexes content
+          set_property "min_#{type}_len".to_sym => 3
+        }
+        index.render
+      end
+
+      it "#{type}_fields should contain the field" do
+        expect(index.send("#{type}_fields")).to eq('title')
+      end
+
+      it "sets min_#{type}_len" do
+        expect(index.send("min_#{type}_len")).to eq(3)
+      end
+    end
+  end
+
+  context "multiple source definitions" do
+    before :each do
+      index.definition_block = Proc.new {
+        define_source do
+          indexes title
+        end
+
+        define_source do
+          indexes title, content
+        end
+      }
+      index.render
+    end
+
+    it "stores each source definition" do
+      expect(index.sources.length).to eq(2)
+    end
+
+    it "treats each source as separate" do
+      expect(index.sources.first.fields.length).to eq(2)
+      expect(index.sources.last.fields.length).to  eq(3)
+    end
+  end
+
+  context 'wordcount fields and attributes' do
+    before :each do
+      index.definition_block = Proc.new {
+        indexes title, :wordcount => true
+
+        has content, :type => :wordcount
+      }
+      index.render
+    end
+
+    it "declares wordcount fields" do
+      expect(index.sources.first.sql_field_str2wordcount).to eq(['title'])
+    end
+
+    it "declares wordcount attributes" do
+      expect(index.sources.first.sql_attr_str2wordcount).to eq(['content'])
+    end
+  end
+
+  context 'respecting source options' do
+    before :each do
+      index.definition_block = Proc.new {
+        indexes title
+
+        set_property :sql_range_step => 5
+        set_property :disable_range? => true
+        set_property :sql_query_pre => ["DO STUFF"]
+      }
+      index.render
+    end
+
+    it "allows for core source settings" do
+      expect(index.sources.first.sql_range_step).to eq(5)
+    end
+
+    it "allows for source options" do
+      expect(index.sources.first.disable_range?).to be_truthy
+    end
+
+    it "respects sql_query_pre values" do
+      expect(index.sources.first.sql_query_pre).to include("DO STUFF")
+    end
+  end
+
+  context 'respecting index options over core configuration' do
+    before :each do
+      ThinkingSphinx::Configuration.instance.settings['min_infix_len'] = 2
+      ThinkingSphinx::Configuration.instance.settings['sql_range_step'] = 2
+
+      index.definition_block = Proc.new {
+        indexes title
+
+        set_property :min_infix_len => 1
+        set_property :sql_range_step => 20
+      }
+      index.render
+    end
+
+    after :each do
+      ThinkingSphinx::Configuration.instance.settings.delete 'min_infix_len'
+      ThinkingSphinx::Configuration.instance.settings.delete 'sql_range_step'
+    end
+
+    it "prioritises index-level options over YAML options" do
+      expect(index.min_infix_len).to eq(1)
+    end
+
+    it "prioritises index-level source options" do
+      expect(index.sources.first.sql_range_step).to eq(20)
+    end
+
+    it "keeps index-level options prioritised when rendered again" do
+      index.render
+
+      expect(index.min_infix_len).to eq(1)
+    end
+
+    it "keeps index-level options prioritised when rendered again" do
+      index.render
+
+      expect(index.sources.first.sql_range_step).to eq(20)
+    end
+  end
+end

data/spec/acceptance/indexing_spec.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'acceptance/spec_helper'
+
+describe 'Indexing', :live => true do
+  it "does not index files where the temp file exists" do
+    path = Rails.root.join('db/sphinx/test/ts-article_core.tmp')
+    FileUtils.mkdir_p Rails.root.join('db/sphinx/test')
+    FileUtils.touch path
+
+    article = Article.create! :title => 'Pancakes'
+    index 'article_core'
+    expect(Article.search).to be_empty
+
+    FileUtils.rm path
+  end
+
+  it "indexes files when other indices are already being processed" do
+    path = Rails.root.join('db/sphinx/test/ts-book_core.tmp')
+    FileUtils.mkdir_p Rails.root.join('db/sphinx/test')
+    FileUtils.touch path
+
+    article = Article.create! :title => 'Pancakes'
+    index 'article_core'
+    expect(Article.search).not_to be_empty
+
+    FileUtils.rm path
+  end
+
+  it "cleans up temp files even when an exception is raised" do
+    FileUtils.mkdir_p Rails.root.join('db/sphinx/test')
+
+    index 'article_core'
+
+    file = Rails.root.join('db/sphinx/test/ts-article_core.tmp')
+    expect(File.exist?(file)).to be_falsey
+  end
+end

data/spec/acceptance/merging_spec.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require "acceptance/spec_helper"
+
+describe "Merging deltas", :live => true do
+  it "merges in new records" do
+    guards = Book.create(
+      :title => "Guards! Guards!", :author => "Terry Pratchett"
+    )
+    sleep 0.25
+
+    expect(
+      Book.search("Terry Pratchett", :indices => ["book_delta"]).to_a
+    ).to eq([guards])
+    expect(
+      Book.search("Terry Pratchett", :indices => ["book_core"]).to_a
+    ).to be_empty
+
+    merge
+    guards.reload
+
+    expect(
+      Book.search("Terry Pratchett", :indices => ["book_core"]).to_a
+    ).to eq([guards])
+    expect(guards.delta).to eq(false)
+  end
+
+  it "merges in changed records" do
+    race = Book.create(
+      :title => "The Hate Space", :author => "Maxine Beneba Clarke"
+    )
+    index
+    expect(
+      Book.search("Space", :indices => ["book_core"]).to_a
+    ).to eq([race])
+
+    race.reload.update :title => "The Hate Race"
+    sleep 0.25
+    expect(
+      Book.search("Race", :indices => ["book_delta"]).to_a
+    ).to eq([race])
+    expect(
+      Book.search("Race", :indices => ["book_core"]).to_a
+    ).to be_empty
+
+    merge
+    race.reload
+
+    expect(
+      Book.search("Race", :indices => ["book_core"]).to_a
+    ).to eq([race])
+    expect(
+      Book.search("Race", :indices => ["book_delta"]).to_a
+    ).to eq([race])
+    expect(
+      Book.search("Space", :indices => ["book_core"]).to_a
+    ).to be_empty
+    expect(race.delta).to eq(false)
+  end
+
+  it "maintains existing records" do
+    race = Book.create(
+      :title => "The Hate Race", :author => "Maxine Beneba Clarke"
+    )
+    index
+
+    soil = Book.create(
+      :title => "Foreign Soil", :author => "Maxine Beneba Clarke"
+    )
+    sleep 0.25
+    expect(
+      Book.search("Soil", :indices => ["book_delta"]).to_a
+    ).to eq([soil])
+    expect(
+      Book.search("Soil", :indices => ["book_core"]).to_a
+    ).to be_empty
+    expect(
+      Book.search("Race", :indices => ["book_core"]).to_a
+    ).to eq([race])
+
+    merge
+
+    expect(
+      Book.search("Soil", :indices => ["book_core"]).to_a
+    ).to eq([soil])
+    expect(
+      Book.search("Race", :indices => ["book_core"]).to_a
+    ).to eq([race])
+  end
+end

data/spec/acceptance/paginating_search_results_spec.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'acceptance/spec_helper'
+
+describe 'Paginating search results', :live => true do
+  it "tracks how many results there are in total" do
+    expect(Article.search.total_entries).to be_zero
+
+    21.times { |number| Article.create :title => "Article #{number}" }
+    index
+
+    if ENV["SPHINX_ENGINE"] == "manticore" && ENV["SPHINX_VERSION"].to_f >= 4.0
+      # I suspect this is a bug in Manticore?
+      expect(Article.search.total_entries).to eq(22)
+    else
+      expect(Article.search.total_entries).to eq(21)
+    end
+  end
+
+  it "paginates the result set by default" do
+    expect(Article.search.total_entries).to be_zero
+
+    21.times { |number| Article.create :title => "Article #{number}" }
+    index
+
+    expect(Article.search.length).to eq(20)
+  end
+
+  it "tracks the number of pages" do
+    expect(Article.search.total_entries).to be_zero
+
+    21.times { |number| Article.create :title => "Article #{number}" }
+    index
+
+    if ENV["SPHINX_ENGINE"] == "manticore" && ENV["SPHINX_VERSION"].to_f >= 4.0
+      # I suspect this is a bug in Manticore?
+      expect(Article.search.total_pages).to eq(1)
+    else
+      expect(Article.search.total_pages).to eq(2)
+    end
+  end
+end