thinking-sphinx 3.1.4 → 6.0.0

data/lib/thinking_sphinx/test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ThinkingSphinx::Test
   def self.init(suppress_delta_output = true)
     FileUtils.mkdir_p config.indices_location
@@ -40,7 +42,7 @@ class ThinkingSphinx::Test
       config.indices_location,
       config.searchd.binlog_path
     ].each do |path|
-      FileUtils.rm_r(path) if File.exists?(path)
+      FileUtils.rm_rf(path) if File.exist?(path)
     end
   end
 

data/lib/thinking_sphinx/utf8.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ThinkingSphinx::UTF8
   attr_reader :string
 

data/lib/thinking_sphinx/wildcard.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ThinkingSphinx::Wildcard
   DEFAULT_TOKEN = /\p{Word}+/
 
@@ -14,7 +16,7 @@ class ThinkingSphinx::Wildcard
     query.gsub(extended_pattern) do
       pre, proper, post = $`, $&, $'
       # E.g. "@foo", "/2", "~3", but not as part of a token pattern
-      is_operator = pre == '@' ||
+      is_operator = pre.match(%r{@$}) ||
                     pre.match(%r{([^\\]+|\A)[~/]\Z}) ||
                     pre.match(%r{(\W|^)@\([^\)]*$})
       # E.g. "foo bar", with quotes

data/lib/thinking_sphinx/with_output.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ThinkingSphinx::WithOutput
+  def initialize(configuration, options = {}, stream = STDOUT)
+    @configuration = configuration
+    @options       = options
+    @stream        = stream
+  end
+
+  private
+
+  attr_reader :configuration, :options, :stream
+end

data/lib/thinking_sphinx.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 if RUBY_PLATFORM == 'java'
   require 'java'
   require 'jdbc/mysql'
@@ -16,7 +18,7 @@ require 'active_support/core_ext/module/attribute_accessors'
 
 module ThinkingSphinx
   def self.count(query = '', options = {})
-    search(query, options).total_entries
+    search_for_ids(query, options).total_entries
   end
 
   def self.facets(query = '', options = {})
@@ -32,22 +34,45 @@ module ThinkingSphinx
     ThinkingSphinx::Search::Merger.new(search).merge! nil, :ids_only => true
   end
 
+  def self.none
+    ThinkingSphinx::Search.new nil, :none => true
+  end
+
   def self.before_index_hooks
     @before_index_hooks
   end
 
   @before_index_hooks = []
 
+  def self.output
+    @output
+  end
+
+  @output = STDOUT
+
+  def self.rake_interface
+    @rake_interface ||= ThinkingSphinx::RakeInterface
+  end
+
+  def self.rake_interface=(interface)
+    @rake_interface = interface
+  end
+
+  module Hooks; end
+  module IndexingStrategies; end
   module Subscribers; end
 end
 
 # Core
+require 'thinking_sphinx/attribute_types'
 require 'thinking_sphinx/batched_search'
 require 'thinking_sphinx/callbacks'
 require 'thinking_sphinx/core'
+require 'thinking_sphinx/with_output'
+require 'thinking_sphinx/commander'
+require 'thinking_sphinx/commands'
 require 'thinking_sphinx/configuration'
 require 'thinking_sphinx/connection'
-require 'thinking_sphinx/controller'
 require 'thinking_sphinx/deletion'
 require 'thinking_sphinx/errors'
 require 'thinking_sphinx/excerpter'
@@ -56,25 +81,31 @@ require 'thinking_sphinx/facet_search'
 require 'thinking_sphinx/float_formatter'
 require 'thinking_sphinx/frameworks'
 require 'thinking_sphinx/guard'
+require 'thinking_sphinx/hooks/guard_presence'
 require 'thinking_sphinx/index'
+require 'thinking_sphinx/indexing_strategies/all_at_once'
+require 'thinking_sphinx/indexing_strategies/one_at_a_time'
 require 'thinking_sphinx/index_set'
+require 'thinking_sphinx/interfaces'
 require 'thinking_sphinx/masks'
 require 'thinking_sphinx/middlewares'
 require 'thinking_sphinx/panes'
+require 'thinking_sphinx/processor'
 require 'thinking_sphinx/query'
 require 'thinking_sphinx/rake_interface'
 require 'thinking_sphinx/scopes'
 require 'thinking_sphinx/search'
-require 'thinking_sphinx/sphinxql'
+require 'thinking_sphinx/settings'
 require 'thinking_sphinx/subscribers/populator_subscriber'
 require 'thinking_sphinx/test'
 require 'thinking_sphinx/utf8'
 require 'thinking_sphinx/wildcard'
 # Extended
-require 'thinking_sphinx/active_record'
 require 'thinking_sphinx/deltas'
 require 'thinking_sphinx/distributed'
 require 'thinking_sphinx/logger'
 require 'thinking_sphinx/real_time'
 
 require 'thinking_sphinx/railtie' if defined?(Rails::Railtie)
+
+ThinkingSphinx.before_index_hooks << ThinkingSphinx::Hooks::GuardPresence

data/spec/acceptance/association_scoping_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'acceptance/spec_helper'
 
 describe 'Scoping association search calls by foreign keys', :live => true do
@@ -9,7 +11,7 @@ describe 'Scoping association search calls by foreign keys', :live => true do
       dublin    = Article.create :title => 'Guide to Dublin',    :user => paul
       index
 
-      pat.articles.search('Guide').to_a.should == [melbourne]
+      expect(pat.articles.search('Guide').to_a).to eq([melbourne])
     end
 
     it "limits id-only results to those matching the foreign key" do
@@ -19,7 +21,7 @@ describe 'Scoping association search calls by foreign keys', :live => true do
       dublin    = Article.create :title => 'Guide to Dublin',    :user => paul
       index
 
-      pat.articles.search_for_ids('Guide').to_a.should == [melbourne.id]
+      expect(pat.articles.search_for_ids('Guide').to_a).to eq([melbourne.id])
     end
   end
 
@@ -31,7 +33,7 @@ describe 'Scoping association search calls by foreign keys', :live => true do
       audi = Manufacturer.create :name => 'Audi'
       r_eight = Car.create :name => 'R8 Spyder', :manufacturer => audi
 
-      porsche.cars.search('Spyder').to_a.should == [spyder]
+      expect(porsche.cars.search('Spyder').to_a).to eq([spyder])
     end
 
     it "limits id-only results to those matching the foreign key" do
@@ -41,7 +43,7 @@ describe 'Scoping association search calls by foreign keys', :live => true do
       audi = Manufacturer.create :name => 'Audi'
       r_eight = Car.create :name => 'R8 Spyder', :manufacturer => audi
 
-      porsche.cars.search_for_ids('Spyder').to_a.should == [spyder.id]
+      expect(porsche.cars.search_for_ids('Spyder').to_a).to eq([spyder.id])
     end
   end
 
@@ -57,7 +59,7 @@ describe 'Scoping association search calls by foreign keys', :live => true do
       pancakes.categories << flat
       waffles.categories  << food
 
-      flat.products.search('Low').to_a.should == [pancakes]
+      expect(flat.products.search('Low').to_a).to eq([pancakes])
     end
   end
 end

data/spec/acceptance/attribute_access_spec.rb

@@ -1,41 +1,58 @@
+# frozen_string_literal: true
+
 require 'acceptance/spec_helper'
 
 describe 'Accessing attributes directly via search results', :live => true do
   it "allows access to attribute values" do
-    Book.create! :title => 'American Gods', :year => 2001
+    Book.create! :title => 'American Gods', :publishing_year => 2001
     index
 
     search = Book.search('gods')
     search.context[:panes] << ThinkingSphinx::Panes::AttributesPane
 
-    search.first.sphinx_attributes['year'].should == 2001
+    expect(search.first.sphinx_attributes['publishing_year']).to eq(2001)
   end
 
   it "provides direct access to the search weight/relevance scores" do
-    Book.create! :title => 'American Gods', :year => 2001
+    Book.create! :title => 'American Gods', :publishing_year => 2001
     index
 
-    search = Book.search 'gods',
-      :select => "*, #{ThinkingSphinx::SphinxQL.weight[:select]}"
+    search = Book.search 'gods', :select => "*, weight()"
+    search.context[:panes] << ThinkingSphinx::Panes::WeightPane
+
+    if ENV["SPHINX_ENGINE"] == "sphinx" && ENV["SPHINX_VERSION"].to_f > 3.3
+      expect(search.first.weight).to eq(20_000.0)
+    else
+      expect(search.first.weight).to eq(2500)
+    end
+  end
+
+  it "provides direct access to the weight with alternative primary keys" do
+    album = Album.create! :name => 'Sing to the Moon', :artist => 'Laura Mvula'
+
+    search = Album.search 'sing', :select => "*, weight()"
     search.context[:panes] << ThinkingSphinx::Panes::WeightPane
 
-    search.first.weight.should == 2500
+    expect(search.first.weight).to be >= 1000
   end
 
   it "can enumerate with the weight" do
-    gods = Book.create! :title => 'American Gods', :year => 2001
+    gods = Book.create! :title => 'American Gods', :publishing_year => 2001
     index
 
-    search = Book.search 'gods',
-      :select => "*, #{ThinkingSphinx::SphinxQL.weight[:select]}"
+    search = Book.search 'gods', :select => "*, weight()"
     search.masks << ThinkingSphinx::Masks::WeightEnumeratorMask
 
-    expectations = [[gods, 2500]]
+    if ENV["SPHINX_ENGINE"] == "sphinx" && ENV["SPHINX_VERSION"].to_f > 3.3
+      expectations = [[gods, 20_000.0]]
+    else
+      expectations = [[gods, 2500]]
+    end
     search.each_with_weight do |result, weight|
       expectation = expectations.shift
 
-      result.should == expectation.first
-      weight.should == expectation.last
+      expect(result).to eq(expectation.first)
+      expect(weight).to eq(expectation.last)
     end
   end
 end

data/spec/acceptance/attribute_updates_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'acceptance/spec_helper'
 
 describe 'Update attributes automatically where possible', :live => true do
@@ -5,12 +7,12 @@ describe 'Update attributes automatically where possible', :live => true do
     article = Article.create :title => 'Pancakes', :published => false
     index
 
-    Article.search('pancakes', :with => {:published => true}).should be_empty
+    expect(Article.search('pancakes', :with => {:published => true})).to be_empty
 
     article.published = true
     article.save
 
-    Article.search('pancakes', :with => {:published => true}).to_a
-      .should == [article]
+    expect(Article.search('pancakes', :with => {:published => true}).to_a)
+      .to eq([article])
   end
 end

data/spec/acceptance/batch_searching_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'acceptance/spec_helper'
 
 describe 'Executing multiple searches in one Sphinx call', :live => true do
@@ -12,10 +14,10 @@ describe 'Executing multiple searches in one Sphinx call', :live => true do
 
     batch.populate
 
-    batch.searches.first.should include(pancakes)
-    batch.searches.first.should_not include(waffles)
+    expect(batch.searches.first).to include(pancakes)
+    expect(batch.searches.first).not_to include(waffles)
 
-    batch.searches.last.should include(waffles)
-    batch.searches.last.should_not include(pancakes)
+    expect(batch.searches.last).to include(waffles)
+    expect(batch.searches.last).not_to include(pancakes)
   end
 end

data/spec/acceptance/big_integers_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'acceptance/spec_helper'
 
 describe '64 bit integer support' do
@@ -21,17 +23,17 @@ describe '64 bit integer support' do
       [small_index, large_index, real_time_index]
     ).reconcile
 
-    large_index.sources.first.attributes.detect { |attribute|
+    expect(large_index.sources.first.attributes.detect { |attribute|
       attribute.name == 'sphinx_internal_id'
-    }.type.should == :bigint
+    }.type).to eq(:bigint)
 
-    small_index.sources.first.attributes.detect { |attribute|
+    expect(small_index.sources.first.attributes.detect { |attribute|
       attribute.name == 'sphinx_internal_id'
-    }.type.should == :bigint
+    }.type).to eq(:bigint)
 
-    real_time_index.attributes.detect { |attribute|
+    expect(real_time_index.attributes.detect { |attribute|
       attribute.name == 'sphinx_internal_id'
-    }.type.should == :bigint
+    }.type).to eq(:bigint)
   end
 end
 
@@ -50,7 +52,7 @@ describe '64 bit document ids', :live => true do
   context 'with Real-Time' do
     it 'handles large 32 bit integers with an offset multiplier' do
       product = Product.create! :name => "Widget"
-      product.update_attributes :id => 980190962
+      product.update :id => 980190962
       expect(
         Product.search('widget', :indices => ['product_core']).to_a
       ).to eq([product])

data/spec/acceptance/excerpts_spec.rb

@@ -1,28 +1,29 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 require 'acceptance/spec_helper'
 
 describe 'Accessing excerpts for methods on a search result', :live => true do
   it "returns excerpts for a given method" do
-    Book.create! :title => 'American Gods', :year => 2001
+    Book.create! :title => 'American Gods', :publishing_year => 2001
     index
 
     search = Book.search('gods')
     search.context[:panes] << ThinkingSphinx::Panes::ExcerptsPane
 
-    search.first.excerpts.title.
-      should == 'American <span class="match">Gods</span>'
+    expect(search.first.excerpts.title).
+      to eq('American <span class="match">Gods</span>')
   end
 
   it "handles UTF-8 text for excerpts" do
-    Book.create! :title => 'Война и миръ', :year => 1869
+    Book.create! :title => 'Война и миръ', :publishing_year => 1869
     index
 
     search = Book.search 'миръ'
     search.context[:panes] << ThinkingSphinx::Panes::ExcerptsPane
 
-    search.first.excerpts.title.
-      should == 'Война и <span class="match">миръ</span>'
+    expect(search.first.excerpts.title).
+      to eq('Война и <span class="match">миръ</span>')
   end if ENV['SPHINX_VERSION'].try :[], /2.2.\d/
 
   it "does not include class names in excerpts" do
@@ -32,8 +33,8 @@ describe 'Accessing excerpts for methods on a search result', :live => true do
     search = Book.search('graveyard')
     search.context[:panes] << ThinkingSphinx::Panes::ExcerptsPane
 
-    search.first.excerpts.title.
-      should == 'The <span class="match">Graveyard</span> Book'
+    expect(search.first.excerpts.title).
+      to eq('The <span class="match">Graveyard</span> Book')
   end
 
   it "respects the star option with queries" do
@@ -43,7 +44,7 @@ describe 'Accessing excerpts for methods on a search result', :live => true do
     search = Article.search('thin', :star => true)
     search.context[:panes] << ThinkingSphinx::Panes::ExcerptsPane
 
-    search.first.excerpts.title.
-      should == '<span class="match">Something</span>'
+    expect(search.first.excerpts.title).
+      to eq('<span class="match">Something</span>')
   end
 end

data/spec/acceptance/facets_spec.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 require 'acceptance/spec_helper'
 
@@ -16,9 +17,9 @@ describe 'Faceted searching', :live => true do
     Tee.create! :colour => green
     index
 
-    Tee.facets.to_hash[:colour_id].should == {
+    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
@@ -28,11 +29,9 @@ describe 'Faceted searching', :live => true do
     Article.create!
     index
 
-    article_count = ENV['SPHINX_VERSION'].try(:[], /2.0.\d/) ? 2 : 1
-
-    ThinkingSphinx.facets.to_hash[:class].should == {
-      'Tee' => 2, 'City' => 1, 'Article' => article_count
-    }
+    expect(ThinkingSphinx.facets.to_hash[:class]).to eq({
+      'Tee' => 2, 'City' => 1, 'Article' => 1
+    })
   end
 
   it "handles field facets" do
@@ -42,9 +41,9 @@ describe 'Faceted searching', :live => true do
     Book.create! :title => '1Q84',          :author => '村上 春樹'
     index
 
-    Book.facets.to_hash[:author].should == {
+    expect(Book.facets.to_hash[:author]).to eq({
       'Neil Gaiman' => 2, 'Terry Pratchett' => 1, '村上 春樹' => 1
-    }
+    })
   end
 
   it "handles MVA facets" do
@@ -62,9 +61,9 @@ describe 'Faceted searching', :live => true do
       :tag => pancakes
     index
 
-    User.facets.to_hash[:tag_ids].should == {
+    expect(User.facets.to_hash[:tag_ids]).to eq({
       pancakes.id => 2, waffles.id => 1
-    }
+    })
   end
 
   it "can filter on integer facet results" do
@@ -76,7 +75,7 @@ describe 'Faceted searching', :live => true do
     r1 = Tee.create! :colour => red
     index
 
-    Tee.facets.for(:colour_id => blue.id).to_a.should == [b1, b2]
+    expect(Tee.facets.for(:colour_id => blue.id).to_a).to eq([b1, b2])
   end
 
   it "can filter on MVA facet results" do
@@ -91,7 +90,7 @@ describe 'Faceted searching', :live => true do
     Tagging.create! :article => Article.create!(:user => u2), :tag => pancakes
     index
 
-    User.facets.for(:tag_ids => waffles.id).to_a.should == [u1]
+    expect(User.facets.for(:tag_ids => waffles.id).to_a).to eq([u1])
   end
 
   it "can filter on string facet results" do
@@ -100,7 +99,7 @@ describe 'Faceted searching', :live => true do
     snuff = Book.create! :title => 'Snuff', :author => 'Terry Pratchett'
     index
 
-    Book.facets.for(:author => 'Neil Gaiman').to_a.should == [gods, boys]
+    expect(Book.facets.for(:author => 'Neil Gaiman').to_a).to eq([gods, boys])
   end
 
   it "allows enumeration" do
@@ -119,10 +118,24 @@ describe 'Faceted searching', :live => true do
       [:class, {'Tee' => 3}]
     ]
     Tee.facets.each do |facet, hash|
-      facet.should == expectations[calls].first
-      hash.should == expectations[calls].last
+      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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'acceptance/spec_helper'
 
 describe 'Searching by latitude and longitude', :live => true do
@@ -7,8 +9,8 @@ describe 'Searching by latitude and longitude', :live => true do
     bri = City.create :name => 'Brisbane',  :lat => -0.4794031, :lng => 2.670838
     index
 
-    City.search(:geo => [-0.616241, 2.602712], :order => 'geodist ASC').
-      to_a.should == [syd, mel, bri]
+    expect(City.search(:geo => [-0.616241, 2.602712], :order => 'geodist ASC').
+      to_a).to eq([syd, mel, bri])
   end
 
   it "filters by distance" do
@@ -17,10 +19,10 @@ describe 'Searching by latitude and longitude', :live => true do
     bri = City.create :name => 'Brisbane',  :lat => -0.4794031, :lng => 2.670838
     index
 
-    City.search(
+    expect(City.search(
       :geo  => [-0.616241, 2.602712],
       :with => {:geodist => 0.0..470_000.0}
-    ).to_a.should == [mel, syd]
+    ).to_a).to eq([mel, syd])
   end
 
   it "provides the distance for each search result" do
@@ -30,16 +32,26 @@ describe 'Searching by latitude and longitude', :live => true do
     index
 
     cities = City.search(:geo => [-0.616241, 2.602712], :order => 'geodist ASC')
-    if ENV['SPHINX_VERSION'].try :[], /2.2.\d/
+    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
 
-    if ActiveRecord::Base.configurations['test']['adapter'][/postgres/]
-      cities.first.geodist.should == expected[:postgresql]
+    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
-      cities.first.geodist.should == expected[:mysql]
+      expect(cities.first.geodist).to be_within(0.01).of(expected[:mysql])
     end
   end
 
@@ -49,10 +61,10 @@ describe 'Searching by latitude and longitude', :live => true do
     bri = City.create :name => 'Brisbane',  :lat => -0.4794031, :lng => 2.670838
     index
 
-    City.search(
+    expect(City.search(
       :geo  => [-0.616241, 2.602712],
       :with => {:geodist => 0.0..470_000.0},
       :select => "*, geodist as custom_weight"
-    ).to_a.should == [mel, syd]
+    ).to_a).to eq([mel, syd])
   end
 end