thinking-sphinx 3.1.4 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c37a8158a4baca6cab0f26af120eeb5465ee53fc
-  data.tar.gz: 875569737b2a9456c28302c2bfd5a06b9571f3ea
+  metadata.gz: 3f8b8aa71063530ab0e184d27cc0fd8afe17da77
+  data.tar.gz: c54952a5a6aa5a4b84e75ceb57071ddfc2244851
 SHA512:
-  metadata.gz: 8409e713da894877707dfd5d0bad3fc6454b1c1b21edce294778fedad926d04e6947db05d938fb9473af59f4636c57d65b9ffc682e9afdfde467ab86a552bf6c
-  data.tar.gz: 486a6e944456d0d007e44759259d915e32c09bbd8e263699762d56be1a5ad736de8576f41a2ceb6b035552bb6cf0baf44c7d8c440a54d0c1dff470d159bfba64
+  metadata.gz: 5684d082b99b5e6131d3244711316d099df261a9b07a1c1452f47150344e2e5ed32f55bdc0fe69948d62f291ef8fd99aeb71b936aebd845d96a2cee78453bc08
+  data.tar.gz: 8d6de05c533ff85787d7d248a548e53fdc1c370c7a625a5a6dd717b2c1bb449c16a1a54b643e87f8ea16ad8b0b844c0ac7c31c453da4a23ec6c763b03bf74cbf

data/.travis.yml

@@ -1,8 +1,8 @@
 language: ruby
 rvm:
-  - 1.9.3
   - 2.0.0
-  - 2.1.0
+  - 2.1
+  - 2.2
   - jruby-19mode
 before_install:
   - gem update --system
@@ -19,3 +19,8 @@ env:
   - DATABASE=postgresql SPHINX_BIN=/usr/local/sphinx-2.1.9/bin/ SPHINX_VERSION=2.1.9
   - DATABASE=mysql2 SPHINX_BIN=/usr/local/sphinx-2.2.6/bin/ SPHINX_VERSION=2.2.6
   - DATABASE=postgresql SPHINX_BIN=/usr/local/sphinx-2.2.6/bin/ SPHINX_VERSION=2.2.6
+sudo: false
+addons:
+  postgresql: "9.4"
+services:
+  - postgresql

data/Appraisals

@@ -1,15 +1,15 @@
 appraise 'rails_3_2' do
-  gem 'rails',  '~> 3.2.21'
+  gem 'rails',  '~> 3.2.22.2'
 end
 
 appraise 'rails_4_0' do
-  gem 'rails', '~> 4.0.12'
+  gem 'rails', '~> 4.0.13'
 end
 
 appraise 'rails_4_1' do
-  gem 'rails', '~> 4.1.8'
+  gem 'rails', '~> 4.1.15'
 end
 
 appraise 'rails_4_2' do
-  gem 'rails', '~> 4.2.0'
+  gem 'rails', '~> 4.2.6'
 end

data/Gemfile

@@ -5,5 +5,7 @@ gemspec
 gem 'mysql2', '~> 0.3.12b4', :platform => :ruby
 gem 'pg',     '~> 0.16.0',   :platform => :ruby
 
+gem 'jdbc-mysql',                          '5.1.35',   :platform => :jruby
 gem 'activerecord-jdbcmysql-adapter',      '~> 1.3.4', :platform => :jruby
 gem 'activerecord-jdbcpostgresql-adapter', '~> 1.3.4', :platform => :jruby
+

data/HISTORY

@@ -1,3 +1,27 @@
+2016-05-13: 3.2.0
+* [FIX] Ensure SQL table aliases are reliable for SQL-backed index queries.
+* [FEATURE] Add JSON attribute support for real-time indices.
+* [FEATURE] Add ability to disable *all* Sphinx-related callbacks via ThinkingSphinx::Callbacks.suspend! and ThinkingSphinx::Callbacks.resume!. Particularly useful for unit tests.
+* [FEATURE] Add native OutOfBoundsError for search queries outside the pagination bounds.
+* [CHANGE] Improved error messages for duplicate property names and missing columns.
+* [FIX] Fixed mysql2 compatibility for memory references (Roman Usherenko).
+* [FIX] Fixed JRuby compatibility with camelCase method names (Brandon Dewitt).
+* [FEATURE] Support MySQL SSL options on a per-index level (@arrtchiu).
+* [CHANGE] Don't populate search results when requesting just the count values (Andrew Roth).
+* [CHANGE] Reset delta column before core indexing begins (reverting behaviour introduced in 3.1.0). See issue #958 for further discussion.
+* [FEATURE] Allow for different indexing strategies (e.g. all at once, or one by one).
+* [FIX] Fix stale id handling for multiple search contexts (Jonathan del Strother).
+* [CHANGE] Use Sphinx's bulk insert ability (Chance Downs).
+* [CHANGE] Reduce memory/object usage for model references (Jonathan del Strother).
+* [CHANGE] Disable deletion callbacks when real-time indices are in place and all other real-time callbacks are disabled.
+* [FIX] Handle quoting of namespaced tables (Roman Usherenko).
+* [FIX] Make preload_indices thread-safe.
+* [FIX] Improved handling of marshalled/demarshalled search results.
+* [FEATURE] Allow rand_seed as a select option (Mattia Gheda).
+* [FEATURE] Add primary_key option for index definitions (Nathaneal Gray).
+* [FEATURE] Add ability to start searchd in the foreground (Andrey Novikov).
+* [CHANGE] Only use ERB to parse the YAML file if ERB is loaded.
+
 2015-06-01: 3.1.4
 * [FIX] Kaminari expects prev_page to be available.
 * [CHANGE] Add a contributor code of conduct.

data/README.textile

@@ -1,11 +1,12 @@
 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.1.4.
+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.2.0.
 
 h2. Upgrading
 
 Please refer to the release notes for any changes you need to make when upgrading:
 
+* "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
@@ -20,10 +21,10 @@ 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.18', :platform => :ruby
-gem 'jdbc-mysql',      '~> 5.1.35', :platform => :jruby
-gem 'thinking-sphinx', '~> 3.1.4'</code></pre>
+gem 'jdbc-mysql',      '= 5.1.35', :platform => :jruby
+gem 'thinking-sphinx', '~> 3.2.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.
+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.
 
 You'll also need to install Sphinx - this is covered in "the extended documentation":http://pat.github.io/thinking-sphinx/installing_sphinx.html.
 

data/gemfiles/rails_3_2.gemfile

@@ -4,8 +4,9 @@ source "https://rubygems.org"
 
 gem "mysql2", "~> 0.3.12b4", :platform => :ruby
 gem "pg", "~> 0.16.0", :platform => :ruby
+gem "jdbc-mysql", "5.1.35", :platform => :jruby
 gem "activerecord-jdbcmysql-adapter", "~> 1.3.4", :platform => :jruby
 gem "activerecord-jdbcpostgresql-adapter", "~> 1.3.4", :platform => :jruby
-gem "rails", "~> 3.2.21"
+gem "rails", "~> 3.2.22.2"
 
 gemspec :path => "../"

data/gemfiles/rails_4_0.gemfile

@@ -4,8 +4,9 @@ source "https://rubygems.org"
 
 gem "mysql2", "~> 0.3.12b4", :platform => :ruby
 gem "pg", "~> 0.16.0", :platform => :ruby
+gem "jdbc-mysql", "5.1.35", :platform => :jruby
 gem "activerecord-jdbcmysql-adapter", "~> 1.3.4", :platform => :jruby
 gem "activerecord-jdbcpostgresql-adapter", "~> 1.3.4", :platform => :jruby
-gem "rails", "~> 4.0.12"
+gem "rails", "~> 4.0.13"
 
 gemspec :path => "../"

data/gemfiles/rails_4_1.gemfile

@@ -4,8 +4,9 @@ source "https://rubygems.org"
 
 gem "mysql2", "~> 0.3.12b4", :platform => :ruby
 gem "pg", "~> 0.16.0", :platform => :ruby
+gem "jdbc-mysql", "5.1.35", :platform => :jruby
 gem "activerecord-jdbcmysql-adapter", "~> 1.3.4", :platform => :jruby
 gem "activerecord-jdbcpostgresql-adapter", "~> 1.3.4", :platform => :jruby
-gem "rails", "~> 4.1.8"
+gem "rails", "~> 4.1.15"
 
 gemspec :path => "../"

data/gemfiles/rails_4_2.gemfile

@@ -4,8 +4,9 @@ source "https://rubygems.org"
 
 gem "mysql2", "~> 0.3.12b4", :platform => :ruby
 gem "pg", "~> 0.16.0", :platform => :ruby
+gem "jdbc-mysql", "5.1.35", :platform => :jruby
 gem "activerecord-jdbcmysql-adapter", "~> 1.3.4", :platform => :jruby
 gem "activerecord-jdbcpostgresql-adapter", "~> 1.3.4", :platform => :jruby
-gem "rails", "~> 4.2.0"
+gem "rails", "~> 4.2.6"
 
 gemspec :path => "../"

data/lib/thinking_sphinx.rb

@@ -16,7 +16,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 = {})
@@ -39,6 +39,7 @@ module ThinkingSphinx
   @before_index_hooks = []
 
   module Subscribers; end
+  module IndexingStrategies; end
 end
 
 # Core
@@ -57,6 +58,8 @@ require 'thinking_sphinx/float_formatter'
 require 'thinking_sphinx/frameworks'
 require 'thinking_sphinx/guard'
 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/masks'
 require 'thinking_sphinx/middlewares'

data/lib/thinking_sphinx/active_record.rb

@@ -23,6 +23,7 @@ require 'thinking_sphinx/active_record/polymorpher'
 require 'thinking_sphinx/active_record/property_query'
 require 'thinking_sphinx/active_record/property_sql_presenter'
 require 'thinking_sphinx/active_record/simple_many_query'
+require 'thinking_sphinx/active_record/source_joins'
 require 'thinking_sphinx/active_record/sql_builder'
 require 'thinking_sphinx/active_record/sql_source'
 

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

@@ -29,7 +29,7 @@ class ThinkingSphinx::ActiveRecord::AssociationProxy::AttributeFinder
     @indices ||= begin
       configuration.preload_indices
       configuration.indices_for_references(
-        *@association.klass.name.underscore.to_sym
+        *ThinkingSphinx::IndexSet.reference_name(@association.klass)
       ).reject &:distributed?
     end
   end

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

@@ -72,7 +72,7 @@ class ThinkingSphinx::ActiveRecord::Attribute::Type
 
   def type_from_database
     raise ThinkingSphinx::MissingColumnError,
-      "column #{column_name} does not exist" if database_column.nil?
+      "Cannot determine the database type of column #{column_name}, as it does not exist" if database_column.nil?
 
     return :bigint if big_integer?
 

data/lib/thinking_sphinx/active_record/base.rb

@@ -21,7 +21,7 @@ module ThinkingSphinx::ActiveRecord::Base
     end
 
     def search_count(query = nil, options = {})
-      search(query, options).total_entries
+      search_for_ids(query, options).total_entries
     end
 
     def search_for_ids(query = nil, options = {})

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

@@ -4,7 +4,7 @@ class ThinkingSphinx::ActiveRecord::Callbacks::DeleteCallbacks <
   callbacks :after_destroy
 
   def after_destroy
-    return if instance.new_record?
+    return if ThinkingSphinx::Callbacks.suspended? || instance.new_record?
 
     indices.each { |index|
       ThinkingSphinx::Deletion.perform index, instance.id

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

@@ -4,9 +4,9 @@ class ThinkingSphinx::ActiveRecord::Callbacks::DeltaCallbacks <
   callbacks :after_commit, :before_save
 
   def after_commit
-    return unless delta_indices? && processors.any? { |processor|
+    return unless !suspended? && delta_indices? && processors.any? { |processor|
       processor.toggled?(instance)
-    } && !ThinkingSphinx::Deltas.suspended?
+    }
 
     delta_indices.each do |index|
       index.delta_processor.index index
@@ -18,7 +18,7 @@ class ThinkingSphinx::ActiveRecord::Callbacks::DeltaCallbacks <
   end
 
   def before_save
-    return unless delta_indices?
+    return unless !ThinkingSphinx::Callbacks.suspended? && delta_indices?
 
     processors.each { |processor| processor.toggle instance }
   end
@@ -48,4 +48,8 @@ class ThinkingSphinx::ActiveRecord::Callbacks::DeltaCallbacks <
   def processors
     delta_indices.collect &:delta_processor
   end
+
+  def suspended?
+    ThinkingSphinx::Callbacks.suspended? || ThinkingSphinx::Deltas.suspended?
+  end
 end

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

@@ -4,7 +4,7 @@ class ThinkingSphinx::ActiveRecord::Callbacks::UpdateCallbacks <
   callbacks :after_update
 
   def after_update
-    return unless updates_enabled?
+    return unless !ThinkingSphinx::Callbacks.suspended? && updates_enabled?
 
     indices.each do |index|
       update index unless index.distributed?
@@ -35,7 +35,7 @@ class ThinkingSphinx::ActiveRecord::Callbacks::UpdateCallbacks <
   end
 
   def reference
-    instance.class.name.underscore.to_sym
+    ThinkingSphinx::IndexSet.reference_name(instance.class)
   end
 
   def update(index)

data/lib/thinking_sphinx/active_record/column_sql_presenter.rb

@@ -13,7 +13,7 @@ class ThinkingSphinx::ActiveRecord::ColumnSQLPresenter
     return __name if string?
     return nil unless exists?
 
-    quoted_table = escape_table? ? adapter.quote(table) : table
+    quoted_table = escape_table? ? escape_table(table) : table
 
     "#{quoted_table}.#{adapter.quote __name}"
   end
@@ -24,6 +24,10 @@ class ThinkingSphinx::ActiveRecord::ColumnSQLPresenter
 
   delegate :__stack, :__name, :string?, :to => :column
 
+  def escape_table(table_name)
+    table_name.split('.').map { |t| adapter.quote(t) }.join('.')
+  end
+
   def escape_table?
     table[/[`"]/].nil?
   end

data/lib/thinking_sphinx/active_record/index.rb

@@ -28,6 +28,10 @@ class ThinkingSphinx::ActiveRecord::Index < Riddle::Configuration::Index
     @facets ||= sources.collect(&:facets).flatten
   end
 
+  def fields
+    sources.collect(&:fields).flatten
+  end
+
   def sources
     interpret_definition!
     super
@@ -44,10 +48,6 @@ class ThinkingSphinx::ActiveRecord::Index < Riddle::Configuration::Index
       adapter_for(model)
   end
 
-  def fields
-    sources.collect(&:fields).flatten
-  end
-
   def interpreter
     ThinkingSphinx::ActiveRecord::Interpreter
   end

data/lib/thinking_sphinx/active_record/source_joins.rb

@@ -0,0 +1,55 @@
+class ThinkingSphinx::ActiveRecord::SourceJoins
+  def self.call(model, source)
+    new(model, source).call
+  end
+
+  def initialize(model, source)
+    @model, @source = model, source
+  end
+
+  def call
+    append_specified_associations
+    append_property_associations
+
+    joins
+  end
+
+  private
+
+  attr_reader :model, :source
+
+  def append_property_associations
+    source.properties.collect(&:columns).each do |columns|
+      columns.each { |column| append_column_associations column }
+    end
+  end
+
+  def append_column_associations(column)
+    return if column.__stack.empty?
+
+    joins.add_join_to column.__stack if column_exists?(column)
+  end
+
+  def append_specified_associations
+    source.associations.reject(&:string?).each do |association|
+      joins.add_join_to association.stack
+    end
+  end
+
+  def column_exists?(column)
+    Joiner::Path.new(model, column.__stack).model
+    true
+  rescue Joiner::AssociationNotFound
+    false
+  end
+
+  def joins
+    @joins ||= begin
+      joins = Joiner::Joins.new model
+      if joins.respond_to?(:join_association_class)
+        joins.join_association_class = ThinkingSphinx::ActiveRecord::JoinAssociation
+      end
+      joins
+    end
+  end
+end

data/lib/thinking_sphinx/active_record/sql_builder.rb

@@ -20,12 +20,6 @@ module ThinkingSphinx
         query.to_query
       end
 
-      def sql_query_post_index
-        return [] unless delta_processor && !source.delta?
-
-        [delta_processor.reset_query]
-      end
-
       private
 
       delegate :adapter, :model, :delta_processor, :to => :source
@@ -49,18 +43,9 @@ module ThinkingSphinx
       end
 
       def associations
-        @associations ||= begin
-          joins = Joiner::Joins.new model
-          if joins.respond_to?(:join_association_class)
-            joins.join_association_class = ThinkingSphinx::ActiveRecord::JoinAssociation
-          end
-
-          source.associations.reject(&:string?).each do |association|
-            joins.add_join_to association.stack
-          end
-
-          joins
-        end
+        @associations ||= ThinkingSphinx::ActiveRecord::SourceJoins.call(
+          model, source
+        )
       end
 
       def quote_column(column)

data/lib/thinking_sphinx/active_record/sql_builder/query.rb

@@ -18,10 +18,17 @@ module ThinkingSphinx
 
       def filter_by_query_pre
         scope_by_time_zone
+        scope_by_delta_processor
         scope_by_session
         scope_by_utf8
       end
 
+      def scope_by_delta_processor
+        return unless delta_processor && !source.delta?
+
+        self.scope << delta_processor.reset_query
+      end
+
       def scope_by_session
         return unless max_len = source.options[:group_concat_max_len]
 

data/lib/thinking_sphinx/active_record/sql_source.rb

@@ -61,6 +61,10 @@ module ThinkingSphinx
         options[:primary_key]
       end
 
+      def properties
+        fields + attributes
+      end
+
       def render
         prepare_for_render unless @prepared
 
@@ -74,6 +78,9 @@ module ThinkingSphinx
         @sql_db   ||= settings[:database]
         @sql_port ||= settings[:port]
         @sql_sock ||= settings[:socket]
+        @mysql_ssl_cert ||= settings[:sslcert]
+        @mysql_ssl_key  ||= settings[:sslkey]
+        @mysql_ssl_ca   ||= settings[:sslca]
       end
 
       def type
@@ -119,7 +126,6 @@ module ThinkingSphinx
         @sql_query             = builder.sql_query
         @sql_query_range     ||= builder.sql_query_range
         @sql_query_pre        += builder.sql_query_pre
-        @sql_query_post_index += builder.sql_query_post_index
       end
 
       def config
@@ -136,10 +142,6 @@ module ThinkingSphinx
 
         @prepared = true
       end
-
-      def properties
-        fields + attributes
-      end
     end
   end
 end