thinking-sphinx 3.4.2 → 4.0.0

data/Gemfile

@@ -1,17 +1,15 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec
 
-gem 'mysql2', '~> 0.3.12b4', :platform => :ruby
-gem 'pg',     '~> 0.18.4',   :platform => :ruby
-
-gem 'jdbc-mysql',                          '5.1.35',   :platform => :jruby
-gem 'activerecord-jdbcmysql-adapter',      '~> 1.3.23', :platform => :jruby
-gem 'activerecord-jdbcpostgresql-adapter', '~> 1.3.23', :platform => :jruby
+gem 'mysql2', '~> 0.5.0',  :platform => :ruby
+gem 'pg',     '~> 0.18.4', :platform => :ruby
 
-if RUBY_VERSION.to_f <= 2.1
-  gem 'rack', '~> 1.0'
-  gem 'nokogiri', '1.6.8'
+if RUBY_PLATFORM == 'java'
+  gem 'jdbc-mysql',                          '5.1.35',    :platform => :jruby
+  gem 'activerecord-jdbcmysql-adapter',      '>= 1.3.23', :platform => :jruby
+  gem 'activerecord-jdbcpostgresql-adapter', '>= 1.3.23', :platform => :jruby
+  gem 'activerecord', '>= 3.2.22'
 end
-
-gem 'activerecord', '>= 3.2.22' if RUBY_PLATFORM == 'java'

data/README.textile

@@ -1,50 +1,44 @@
 h1. Thinking Sphinx
 
-Thinking Sphinx is a library for connecting ActiveRecord to the Sphinx full-text search tool, and integrates closely with Rails (but also works with other Ruby web frameworks). The current release is v3.4.2.
+Thinking Sphinx is a library for connecting ActiveRecord to the Sphinx full-text search tool, and integrates closely with Rails (but also works with other Ruby web frameworks). The current release is v4.0.0.
 
 h2. Upgrading
 
-Please refer to the release notes for any changes you need to make when upgrading:
+Please refer to "the changelog":https://github.com/pat/thinking-sphinx/blob/develop/CHANGELOG.markdown and "release notes":https://github.com/pat/thinking-sphinx/releases for any changes you need to make when upgrading. The release notes in particular are quite good at covering breaking changes and more details for new features.
 
-* "v3.4.2":https://github.com/pat/thinking-sphinx/releases/tag/v3.4.2
-* "v3.4.1":https://github.com/pat/thinking-sphinx/releases/tag/v3.4.1
-* "v3.4.0":https://github.com/pat/thinking-sphinx/releases/tag/v3.4.0
-* "v3.3.0":https://github.com/pat/thinking-sphinx/releases/tag/v3.3.0
-* "v3.2.0":https://github.com/pat/thinking-sphinx/releases/tag/v3.2.0
-* "v3.1.4":https://github.com/pat/thinking-sphinx/releases/tag/v3.1.4
-* "v3.1.3":https://github.com/pat/thinking-sphinx/releases/tag/v3.1.3
-* "v3.1.2":https://github.com/pat/thinking-sphinx/releases/tag/v3.1.2
-* "v3.1.1":https://github.com/pat/thinking-sphinx/releases/tag/v3.1.1
-* "v3.1.0":https://github.com/pat/thinking-sphinx/releases/tag/v3.1.0
-* "v3.0.6":https://github.com/pat/thinking-sphinx/releases/tag/v3.0.6
-
-If you're upgrading from pre-v3, then the documentation has "pretty extensive notes":http://pat.github.io/thinking-sphinx/upgrading.html on what's changed.
+The documentation also has more details on what's involved for upgrading from "v3 to v4":https://freelancing-gods.com/thinking-sphinx/v4/upgrading.html, and "v1/v2 to v3":https://freelancing-gods.com/thinking-sphinx/v3/upgrading.html.
 
 h2. Installation
 
 It's a gem, so install it like you would any other gem. You will also need to specify the mysql2 gem if you're using MRI, or jdbc-mysql if you're using JRuby:
 
-<pre><code>gem 'mysql2',          '~> 0.3', :platform => :ruby
-gem 'jdbc-mysql',      '= 5.1.35', :platform => :jruby
-gem 'thinking-sphinx', '~> 3.4.2'</code></pre>
+<pre><code>gem 'mysql2',          '~> 0.3',    :platform => :ruby
+gem 'jdbc-mysql',      '~> 5.1.35', :platform => :jruby
+gem 'thinking-sphinx', '~> 4.0'</code></pre>
 
-The MySQL gems mentioned are required for connecting to Sphinx, so please include it even when you're using PostgreSQL for your database. If you're using JRuby, there is "currently an issue with Sphinx and jdbc-mysql 5.1.36 or newer":http://sphinxsearch.com/forum/view.html?id=13939, so you'll need to stick to nothing more recent than 5.1.35.
+The MySQL gems mentioned are required for connecting to Sphinx, so please include it even when you're using PostgreSQL for your database. If you're using JRuby with a version of Sphinx prior to 2.2.11, there is "currently an issue with Sphinx and jdbc-mysql 5.1.36 or newer":http://sphinxsearch.com/forum/view.html?id=13939, so you'll need to stick to nothing more recent than 5.1.35, or upgrade Sphinx.
 
-You'll also need to install Sphinx - this is covered in "the extended documentation":http://pat.github.io/thinking-sphinx/installing_sphinx.html.
+You'll also need to install Sphinx - this is covered in "the extended documentation":https://freelancing-gods.com/thinking-sphinx/installing_sphinx.html.
 
 h2. Usage
 
-Begin by reading the "quick-start guide":http://pat.github.io/thinking-sphinx/quickstart.html, and beyond that, "the documentation":http://pat.github.io/thinking-sphinx/ should serve you pretty well.
+Begin by reading the "quick-start guide":https://freelancing-gods.com/thinking-sphinx/quickstart.html, and beyond that, "the documentation":https://freelancing-gods.com/thinking-sphinx/ should serve you pretty well.
 
-h3. Extending with Middleware, Glazes and Panes
+h2. Requirements
 
-These are covered in "a blog post":http://freelancing-gods.com/posts/rewriting_thinking_sphinx_middleware_glazes_and_panes.
+The current release of Thinking Sphinx works with the following versions of its dependencies:
 
-h2. Requirements
+|_. Library |_. Minimum |_. Tested Against |
+| Ruby | v2.2 | v2.2.9, v2.3.6, v2.4.3, v2.5.0, JRuby 9.1.14 |
+| Sphinx | v2.1.2 | v2.1.9, v2.2.11, v3.0.2 |
+| Manticore | v2.6.3 | v2.6.3 |
+| ActiveRecord | v3.2 | v3.2, v4.0, v4.1, v4.2, v5.0, v5.1, v5.2 |
 
-h3. Sphinx
+It _might_ work with older versions of Ruby, but it's highly recommended to update to a supported release.
 
-Thinking Sphinx v3 is currently built for Sphinx 2.0.5 or newer, and releases since v3.1.0 expect Sphinx 2.1.2 or newer by default.
+h3. Sphinx or Manticore
+
+Thinking Sphinx v3 is currently built for Sphinx 2.1.2 or newer, or Manticore v2.6+.
 
 h3. Rails and ActiveRecord
 
@@ -56,9 +50,7 @@ If you want ActiveRecord 3.1 support, then refer to the 3.0.x releases of Thinki
 
 h3. Ruby
 
-You'll need either the standard Ruby (v1.9.3 or newer) or JRuby (1.7.9 or newer). I'm open to patches to improve Rubinius support (if required - it may work with it right now).
-
-JRuby is only supported as of Thinking Sphinx v3.1.0, and requires Sphinx 2.1.2 or newer.
+You'll need either the standard Ruby (v2.2 or newer) or JRuby (9.1 or newer).
 
 h3. Database Versions
 
@@ -66,7 +58,7 @@ MySQL 5.x and Postgres 8.4 or better are supported.
 
 h2. Contributing
 
-Please note that this project now has a "Contributor Code of Conduct":http://contributor-covenant.org/version/1/0/0/. By participating in this project you agree to abide by its terms.
+Please note that this project has a "Contributor Code of Conduct":http://contributor-covenant.org/version/1/0/0/. By participating in this project you agree to abide by its terms.
 
 To contribute, clone this repository and have a good look through the specs - you'll notice the distinction between acceptance tests that actually use Sphinx and go through the full stack, and unit tests (everything else) which use liberal test doubles to ensure they're only testing the behaviour of the class in question. I've found this leads to far better code design.
 
@@ -87,4 +79,4 @@ You can then run the unit tests with @rake spec:unit@, the acceptance tests with
 
 h2. Licence
 
-Copyright (c) 2007-2017, Thinking Sphinx is developed and maintained by Pat Allan, and is released under the open MIT Licence. Many thanks to "all who have contributed patches":https://github.com/pat/thinking-sphinx/contributors.
+Copyright (c) 2007-2018, Thinking Sphinx is developed and maintained by Pat Allan, and is released under the open MIT Licence. Many thanks to "all who have contributed patches":https://github.com/pat/thinking-sphinx/contributors.

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler'
 require 'appraisal'
 

data/bin/console

@@ -1,4 +1,5 @@
-#!/usr/bin/env ruby
+#! /usr/bin/env ruby
+# frozen_string_literal: true
 
 require "bundler/setup"
 require "thinking_sphinx"

data/bin/loadsphinx

@@ -1,14 +1,28 @@
 #!/usr/bin/env bash
 
 version=$1
-name="sphinx-$version"
-url="http://sphinxsearch.com/files/$name-release.tar.gz"
+engine=$2
+name="$engine-$version"
 bucket="thinking-sphinx"
 directory="ext/sphinx"
 prefix="`pwd`/$directory"
 file="ext/$name.tar.gz"
 
+if [ "$engine" == "sphinx" ]; then
+  url="http://sphinxsearch.com/files/$name-release.tar.gz"
+else
+  url="https://github.com/manticoresoftware/manticore.git"
+fi
+
 download_and_compile_source () {
+  if [ "$engine" == "sphinx" ]; then
+    download_and_compile_sphinx
+  else
+    download_and_compile_manticore
+  fi
+}
+
+download_and_compile_sphinx () {
   curl -O $url
   tar -zxf $name-release.tar.gz
   cd $name-release
@@ -19,6 +33,19 @@ download_and_compile_source () {
   rm -rf $name-release.tar.gz $name-release
 }
 
+download_and_compile_manticore () {
+  git clone $url $engine
+  cd $engine
+  git checkout $version
+  mkdir build
+  cd build
+  cmake -D WITH_MYSQL=TRUE -D WITH_PGSQL=TRUE -D DISABLE_TESTING=TRUE -D CMAKE_INSTALL_PREFIX=$prefix ..
+  make -j4
+  make install
+  cd ../..
+  rm -rf $engine
+}
+
 load_cache () {
   mkdir ext
   curl -o $file http://$bucket.s3.amazonaws.com/bincaches/$name.tar.gz

data/lib/thinking-sphinx.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'thinking_sphinx'

data/lib/thinking/sphinx.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'thinking_sphinx'

data/lib/thinking_sphinx.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 if RUBY_PLATFORM == 'java'
   require 'java'
   require 'jdbc/mysql'
@@ -40,9 +42,22 @@ module ThinkingSphinx
 
   @before_index_hooks = []
 
-  module Commands; end
+  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 Interfaces; end
   module Subscribers; end
 end
 
@@ -52,15 +67,10 @@ require 'thinking_sphinx/batched_search'
 require 'thinking_sphinx/callbacks'
 require 'thinking_sphinx/core'
 require 'thinking_sphinx/with_output'
-require 'thinking_sphinx/commands/base'
-require 'thinking_sphinx/commands/configure'
-require 'thinking_sphinx/commands/index'
-require 'thinking_sphinx/commands/start_attached'
-require 'thinking_sphinx/commands/start_detached'
-require 'thinking_sphinx/commands/stop'
+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'
@@ -69,13 +79,12 @@ 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/daemon'
-require 'thinking_sphinx/interfaces/real_time'
-require 'thinking_sphinx/interfaces/sql'
+require 'thinking_sphinx/interfaces'
 require 'thinking_sphinx/masks'
 require 'thinking_sphinx/middlewares'
 require 'thinking_sphinx/panes'
@@ -83,7 +92,7 @@ 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'
@@ -96,3 +105,5 @@ 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/lib/thinking_sphinx/active_record.rb

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
+
 require 'active_record'
 require 'joiner'
 
 module ThinkingSphinx::ActiveRecord
   module Callbacks; end
+  module Depolymorph; end
 end
 
 require 'thinking_sphinx/active_record/property'
@@ -14,7 +17,6 @@ require 'thinking_sphinx/active_record/column'
 require 'thinking_sphinx/active_record/column_sql_presenter'
 require 'thinking_sphinx/active_record/database_adapters'
 require 'thinking_sphinx/active_record/field'
-require 'thinking_sphinx/active_record/filter_reflection'
 require 'thinking_sphinx/active_record/index'
 require 'thinking_sphinx/active_record/interpreter'
 require 'thinking_sphinx/active_record/join_association'
@@ -30,3 +32,10 @@ require 'thinking_sphinx/active_record/sql_source'
 require 'thinking_sphinx/active_record/callbacks/delete_callbacks'
 require 'thinking_sphinx/active_record/callbacks/delta_callbacks'
 require 'thinking_sphinx/active_record/callbacks/update_callbacks'
+
+require 'thinking_sphinx/active_record/depolymorph/base_reflection'
+require 'thinking_sphinx/active_record/depolymorph/association_reflection'
+require 'thinking_sphinx/active_record/depolymorph/conditions_reflection'
+require 'thinking_sphinx/active_record/depolymorph/overridden_reflection'
+require 'thinking_sphinx/active_record/depolymorph/scoped_reflection'
+require 'thinking_sphinx/active_record/filter_reflection'

data/lib/thinking_sphinx/active_record/association.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ThinkingSphinx::ActiveRecord::Association
   def initialize(column)
     @column = column

data/lib/thinking_sphinx/active_record/association_proxy.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ThinkingSphinx::ActiveRecord::AssociationProxy
   extend ActiveSupport::Concern
 

data/lib/thinking_sphinx/active_record/association_proxy/attribute_finder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ThinkingSphinx::ActiveRecord::AssociationProxy::AttributeFinder
   def initialize(association)
     @association = association

data/lib/thinking_sphinx/active_record/association_proxy/attribute_matcher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ThinkingSphinx::ActiveRecord::AssociationProxy::AttributeMatcher
     def initialize(attribute, foreign_key)
       @attribute, @foreign_key = attribute, foreign_key.to_s

data/lib/thinking_sphinx/active_record/attribute.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ThinkingSphinx::ActiveRecord::Attribute <
   ThinkingSphinx::ActiveRecord::Property
 

data/lib/thinking_sphinx/active_record/attribute/sphinx_presenter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ThinkingSphinx::ActiveRecord::Attribute::SphinxPresenter
   SPHINX_TYPES = {
     :integer   => :uint,

data/lib/thinking_sphinx/active_record/attribute/type.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ThinkingSphinx::ActiveRecord::Attribute::Type
   UPDATEABLE_TYPES = [:integer, :timestamp, :boolean, :float]
 

data/lib/thinking_sphinx/active_record/attribute/values.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ThinkingSphinx::ActiveRecord::Attribute::Values
   def initialize(attribute)
     @attribute = attribute

data/lib/thinking_sphinx/active_record/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ThinkingSphinx::ActiveRecord::Base
   extend ActiveSupport::Concern
 

data/lib/thinking_sphinx/active_record/callbacks/delete_callbacks.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ThinkingSphinx::ActiveRecord::Callbacks::DeleteCallbacks <
   ThinkingSphinx::Callbacks
 

data/lib/thinking_sphinx/active_record/callbacks/delta_callbacks.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ThinkingSphinx::ActiveRecord::Callbacks::DeltaCallbacks <
   ThinkingSphinx::Callbacks
 

data/lib/thinking_sphinx/active_record/callbacks/update_callbacks.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ThinkingSphinx::ActiveRecord::Callbacks::UpdateCallbacks <
   ThinkingSphinx::Callbacks
 

data/lib/thinking_sphinx/active_record/column.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ThinkingSphinx::ActiveRecord::Column
   def initialize(*stack)
     @stack = stack

data/lib/thinking_sphinx/active_record/column_sql_presenter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ThinkingSphinx::ActiveRecord::ColumnSQLPresenter
   def initialize(model, column, adapter, associations)
     @model, @column, @adapter, @associations = model, column, adapter, associations

data/lib/thinking_sphinx/active_record/database_adapters.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ThinkingSphinx::ActiveRecord::DatabaseAdapters
   class << self
     attr_accessor :default

data/lib/thinking_sphinx/active_record/database_adapters/abstract_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ThinkingSphinx::ActiveRecord::DatabaseAdapters::AbstractAdapter
   def initialize(model)
     @model = model

data/lib/thinking_sphinx/active_record/database_adapters/mysql_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ThinkingSphinx::ActiveRecord::DatabaseAdapters::MySQLAdapter <
   ThinkingSphinx::ActiveRecord::DatabaseAdapters::AbstractAdapter
 

data/lib/thinking_sphinx/active_record/database_adapters/postgresql_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ThinkingSphinx::ActiveRecord::DatabaseAdapters::PostgreSQLAdapter <
   ThinkingSphinx::ActiveRecord::DatabaseAdapters::AbstractAdapter
 

data/lib/thinking_sphinx/active_record/depolymorph/association_reflection.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# This custom association approach is only available in Rails 4.1-5.1. This
+# behaviour is superseded by OverriddenReflection for Rails 5.2, and was
+# preceded by ScopedReflection for Rails 4.0.
+class ThinkingSphinx::ActiveRecord::Depolymorph::AssociationReflection <
+  ThinkingSphinx::ActiveRecord::Depolymorph::BaseReflection
+
+  # Since Rails 4.2, the macro argument has been removed. The underlying
+  # behaviour remains the same, though.
+  def call
+    if explicit_macro?
+      klass.new name, nil, options, reflection.active_record
+    else
+      klass.new reflection.macro, name, nil, options, reflection.active_record
+    end
+  end
+
+  private
+
+  def explicit_macro?
+    ActiveRecord::Reflection::MacroReflection.instance_method(:initialize).
+      arity == 4
+  end
+
+  def options
+    super
+
+    @options[:sphinx_internal_filtered] = true
+    @options
+  end
+end