thinking-sphinx 3.1.2 → 3.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 629217e38872edc12e92be134409a509b84f1304
-  data.tar.gz: 4b19eec90cfe3b560b1fcdd56a7018f07704ec94
+  metadata.gz: c17f93cf2e09238f8df63a50264d09abe50051ba
+  data.tar.gz: 90d74a5a5d8f5b7edc71826ec67adeb9ae4550b3
 SHA512:
-  metadata.gz: 5116aad817ad119c97f05ec5bcdf330ca89ecae39ecac5695c4b9573ba062a88e25b6c8db22c596a32ec57ca8c044b2805360696b4b6342196d19b775886e340
-  data.tar.gz: 6923c30ad7163f0ec5c286b5cf98403c27618dc57191bff659808000f9f51bcf2e1ef0eec22fbf6ecc54752a9e1e6474d6e62a65b65db6cc462d8657beae183e
+  metadata.gz: c861cf2251899f29b7f82d7c471918f9147042792f5856e5205f4dc431dfac38e1e41204e74415710848ce8d1ce72333c296cf695250930d3070aa55f629ff48
+  data.tar.gz: af1e25122e4710693c232f98e1ffd9a03092222417a2b5f20a274dcabc30785047f05bade7212689de939ee2724ce47161a665b14b6b14731ef8220d76bf75c1

data/.travis.yml

@@ -19,3 +19,5 @@ env:
 gemfile:
   - gemfiles/rails_3_2.gemfile
   - gemfiles/rails_4_0.gemfile
+  - gemfiles/rails_4_1.gemfile
+  - gemfiles/rails_4_2.gemfile

data/Appraisals

@@ -1,11 +1,15 @@
 appraise 'rails_3_2' do
-  gem 'rails',  '~> 3.2.0'
+  gem 'rails',  '~> 3.2.21'
 end
 
 appraise 'rails_4_0' do
-  gem 'rails', '~> 4.0.2'
+  gem 'rails', '~> 4.0.12'
 end
 
 appraise 'rails_4_1' do
-  gem 'rails', '~> 4.1.0.beta1'
+  gem 'rails', '~> 4.1.8'
+end
+
+appraise 'rails_4_2' do
+  gem 'rails', '~> 4.2.0'
 end

data/HISTORY

@@ -1,3 +1,15 @@
+2015-01-21: 3.1.3
+* [CHANGE] Log excerpt SphinxQL queries just like the search queries.
+* [CHANGE] Load Railtie if Rails::Railtie is defined, instead of just Rails (Andrew Cone).
+* [CHANGE] Convert raw Sphinx results to an array when querying (Bryan Ricker).
+* [FIX] Generate de-polymorphised associations properly for Rails 4.2
+* [FIX] Use reflect_on_association instead of reflections, to stick to the public ActiveRecord::Base API.
+* [FIX] Don't load ActiveRecord early - fixes a warning in Rails 4.2.
+* [FEATURE] Allow for custom offset references with the :offset_as option - thus one model across many schemas with Apartment can be treated differently.
+* [FEATURE] Allow for custom IndexSet classes.
+* [FIX] Don't double-up on STI filtering, already handled by Rails.
+* [CHANGE] Add bigint support for real-time indices, and use bigints for the sphinx_internal_id attribute (mapped to model primary keys) (Chance Downs).
+
 2014-11-04: 3.1.2
 * [CHANGE] regenerate task now only deletes index files for real-time indices.
 * [CHANGE] Raise an exception when a populated search query is modified (as it can't be requeried).

data/README.textile

@@ -1,11 +1,13 @@
 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.1.
+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.3.
 
 h2. Upgrading
 
 Please refer to the release notes for any changes you need to make when upgrading:
 
+* "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
@@ -18,7 +20,7 @@ It's a gem, so install it like you would any other gem. You will also need to sp
 
 <pre><code>gem 'mysql2',          '~> 0.3.13', :platform => :ruby
 gem 'jdbc-mysql',      '~> 5.1.28', :platform => :jruby
-gem 'thinking-sphinx', '~> 3.1.1'</code></pre>
+gem 'thinking-sphinx', '~> 3.1.3'</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.
 
@@ -75,4 +77,4 @@ You can then run the unit tests with @rake spec:unit@, the acceptance tests with
 
 h2. Licence
 
-Copyright (c) 2007-2014, 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-2015, 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/gemfiles/rails_3_2.gemfile

@@ -6,6 +6,6 @@ gem "mysql2", "~> 0.3.12b4", :platform=>:ruby
 gem "pg", "~> 0.16.0", :platform=>:ruby
 gem "activerecord-jdbcmysql-adapter", "~> 1.3.4", :platform=>:jruby
 gem "activerecord-jdbcpostgresql-adapter", "~> 1.3.4", :platform=>:jruby
-gem "rails", "~> 3.2.0"
+gem "rails", "~> 3.2.21"
 
 gemspec :path=>"../"

data/gemfiles/rails_4_0.gemfile

@@ -6,6 +6,6 @@ gem "mysql2", "~> 0.3.12b4", :platform=>:ruby
 gem "pg", "~> 0.16.0", :platform=>:ruby
 gem "activerecord-jdbcmysql-adapter", "~> 1.3.4", :platform=>:jruby
 gem "activerecord-jdbcpostgresql-adapter", "~> 1.3.4", :platform=>:jruby
-gem "rails", "~> 4.0.2"
+gem "rails", "~> 4.0.12"
 
 gemspec :path=>"../"

data/gemfiles/rails_4_1.gemfile

@@ -6,6 +6,6 @@ gem "mysql2", "~> 0.3.12b4", :platform=>:ruby
 gem "pg", "~> 0.16.0", :platform=>:ruby
 gem "activerecord-jdbcmysql-adapter", "~> 1.3.4", :platform=>:jruby
 gem "activerecord-jdbcpostgresql-adapter", "~> 1.3.4", :platform=>:jruby
-gem "rails", "~> 4.1.0.beta1"
+gem "rails", "~> 4.1.8"
 
 gemspec :path=>"../"

data/gemfiles/rails_4_2.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "mysql2", "~> 0.3.12b4", :platform=>:ruby
+gem "pg", "~> 0.16.0", :platform=>:ruby
+gem "activerecord-jdbcmysql-adapter", "~> 1.3.4", :platform=>:jruby
+gem "activerecord-jdbcpostgresql-adapter", "~> 1.3.4", :platform=>:jruby
+gem "rails", "~> 4.2.0"
+
+gemspec :path=>"../"

data/lib/thinking_sphinx.rb

@@ -77,4 +77,4 @@ require 'thinking_sphinx/distributed'
 require 'thinking_sphinx/logger'
 require 'thinking_sphinx/real_time'
 
-require 'thinking_sphinx/railtie' if defined?(Rails)
+require 'thinking_sphinx/railtie' if defined?(Rails::Railtie)

data/lib/thinking_sphinx/active_record.rb

@@ -14,7 +14,7 @@ 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/filtered_reflection'
+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'

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

@@ -14,6 +14,8 @@ class ThinkingSphinx::ActiveRecord::Callbacks::DeleteCallbacks <
   private
 
   def indices
-    ThinkingSphinx::IndexSet.new([instance.class], []).to_a
+    ThinkingSphinx::Configuration.instance.index_set_class.new(
+      :classes => [instance.class]
+    ).to_a
   end
 end

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

@@ -42,7 +42,7 @@ class ThinkingSphinx::ActiveRecord::Callbacks::DeltaCallbacks <
   end
 
   def indices
-    @indices ||= ThinkingSphinx::IndexSet.new [instance.class], []
+    @indices ||= config.index_set_class.new :classes => [instance.class]
   end
 
   def processors

data/lib/thinking_sphinx/active_record/filter_reflection.rb

@@ -0,0 +1,75 @@
+class ThinkingSphinx::ActiveRecord::FilterReflection
+  attr_reader :reflection, :class_name
+
+  delegate :foreign_type, :active_record, :to => :reflection
+
+  def self.call(reflection, name, class_name)
+    filter = new(reflection, class_name)
+    klass  = reflection.class
+
+    if defined?(ActiveRecord::Reflection::MacroReflection)
+      klass.new name, filter.scope, filter.options, reflection.active_record
+    elsif reflection.respond_to?(:scope)
+      klass.new reflection.macro, name, filter.scope, filter.options,
+        reflection.active_record
+    else
+      klass.new reflection.macro, name, filter.options,
+        reflection.active_record
+    end
+  end
+
+  def initialize(reflection, class_name)
+    @reflection, @class_name = reflection, class_name
+    @options = reflection.options.clone
+  end
+
+  def options
+    @options.delete :polymorphic
+    @options[:class_name]    = class_name
+    @options[:foreign_key] ||= "#{reflection.name}_id"
+    @options[:foreign_type]  = reflection.foreign_type
+
+    if reflection.respond_to?(:scope)
+      @options[:sphinx_internal_filtered] = true
+      return @options
+    end
+
+    case @options[:conditions]
+    when nil
+      @options[:conditions] = condition
+    when Array
+      @options[:conditions] << condition
+    when Hash
+      @options[:conditions].merge!(reflection.foreign_type => @options[:class_name])
+    else
+      @options[:conditions] << " AND #{condition}"
+    end
+
+    @options
+  end
+
+  def scope
+    if ::Joiner::Joins.instance_methods.include?(:join_association_class)
+      return nil
+    end
+
+    lambda { |association|
+      reflection = association.reflection
+      klass      = reflection.class_name.constantize
+      where(
+        association.parent.aliased_table_name.to_sym =>
+        {reflection.foreign_type => klass.base_class.name}
+      )
+    }
+  end
+
+  private
+
+  def condition
+    "::ts_join_alias::.#{quoted_foreign_type} = '#{class_name}'"
+  end
+
+  def quoted_foreign_type
+    active_record.connection.quote_column_name foreign_type
+  end
+end

data/lib/thinking_sphinx/active_record/polymorpher.rb

@@ -14,7 +14,7 @@ class ThinkingSphinx::ActiveRecord::Polymorpher
 
   def append_reflections
     mappings.each do |class_name, name|
-      next if klass.reflections[name]
+      next if klass.reflect_on_association(name)
 
       reflection = clone_with name, class_name
       if ActiveRecord::Reflection.respond_to?(:add_reflection)
@@ -26,7 +26,7 @@ class ThinkingSphinx::ActiveRecord::Polymorpher
   end
 
   def clone_with(name, class_name)
-    ThinkingSphinx::ActiveRecord::FilteredReflection.clone_with_filter(
+    ThinkingSphinx::ActiveRecord::FilterReflection.call(
       reflection, name, class_name
     )
   end
@@ -51,12 +51,12 @@ class ThinkingSphinx::ActiveRecord::Polymorpher
   end
 
   def reflection
-    @reflection ||= klass.reflections[column.__name]
+    @reflection ||= klass.reflect_on_association column.__name
   end
 
   def klass
     @klass ||= column.__stack.inject(source.model) { |parent, key|
-      parent.reflections[key].klass
+      parent.reflect_on_association(key).klass
     }
   end
 end

data/lib/thinking_sphinx/active_record/property_query.rb

@@ -110,7 +110,7 @@ primary key.
       base = source.model
 
       column.__stack.collect { |key|
-        reflection = base.reflections[key]
+        reflection = base.reflect_on_association key
         base = reflection.klass
 
         extend_reflection reflection

data/lib/thinking_sphinx/active_record/simple_many_query.rb

@@ -8,7 +8,7 @@ class ThinkingSphinx::ActiveRecord::SimpleManyQuery <
   private
 
   def reflection
-    @reflection ||= source.model.reflections[column.__stack.first]
+    @reflection ||= source.model.reflect_on_association column.__stack.first
   end
 
   def quoted_foreign_key

data/lib/thinking_sphinx/active_record/sql_builder.rb

@@ -100,10 +100,6 @@ module ThinkingSphinx
         "($id - #{source.offset}) / #{config.indices.count}"
       end
 
-      def inheritance_column_condition
-        "#{quoted_inheritance_column} = '#{model_name}'"
-      end
-
       def range_condition
         condition = []
         condition << "#{quoted_primary_key} BETWEEN $start AND $end" unless source.disable_range?

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

@@ -129,7 +129,6 @@ module ThinkingSphinx
 
       def where_clause(for_range = false)
         builder = SQLBuilder::ClauseBuilder.new(nil)
-        builder.add_clause inheritance_column_condition unless model.descends_from_active_record?
         builder.add_clause delta_processor.clause(source.delta?) if delta_processor
         builder.add_clause range_condition unless for_range
         builder.separated(' AND ')

data/lib/thinking_sphinx/configuration.rb

@@ -3,7 +3,7 @@ require 'pathname'
 class ThinkingSphinx::Configuration < Riddle::Configuration
   attr_accessor :configuration_file, :indices_location, :version
   attr_reader :index_paths
-  attr_writer :controller
+  attr_writer :controller, :index_set_class
 
   delegate :environment, :to => :framework
 
@@ -56,9 +56,12 @@ class ThinkingSphinx::Configuration < Riddle::Configuration
     end
   end
 
+  def index_set_class
+    @index_set_class ||= ThinkingSphinx::IndexSet
+  end
+
   def indices_for_references(*references)
-    preload_indices
-    indices.select { |index| references.include?(index.reference) }
+    index_set_class.new(:references => references).to_a
   end
 
   def next_offset(reference)

data/lib/thinking_sphinx/core/index.rb

@@ -12,7 +12,7 @@ module ThinkingSphinx::Core::Index
     @docinfo      = :extern
     @charset_type = 'utf-8'
     @options      = options
-    @offset       = config.next_offset(reference)
+    @offset       = config.next_offset(options[:offset_as] || reference)
     @type         = 'plain'
 
     super "#{options[:name] || reference.to_s.gsub('/', '_')}_#{name_suffix}"

data/lib/thinking_sphinx/excerpter.rb

@@ -15,7 +15,10 @@ class ThinkingSphinx::Excerpter
 
   def excerpt!(text)
     result = ThinkingSphinx::Connection.take do |connection|
-      connection.execute(statement_for(text)).first['snippet']
+      query = statement_for text
+      ThinkingSphinx::Logger.log :query, query do
+        connection.execute(query).first['snippet']
+      end
     end
 
     encoded? ? result : ThinkingSphinx::UTF8.encode(result)

data/lib/thinking_sphinx/facet_search.rb

@@ -63,6 +63,10 @@ class ThinkingSphinx::FacetSearch
 
   private
 
+  def configuration
+    ThinkingSphinx::Configuration.instance
+  end
+
   def facets
     @facets ||= properties.group_by(&:name).collect { |name, matches|
       ThinkingSphinx::Facet.new name, matches
@@ -92,11 +96,13 @@ class ThinkingSphinx::FacetSearch
   end
 
   def indices
-    @indices ||= ThinkingSphinx::IndexSet.new options[:classes], options[:indices]
+    @indices ||= configuration.index_set_class.new(
+      options.slice(:classes, :indices)
+    )
   end
 
   def max_matches
-    ThinkingSphinx::Configuration.instance.settings['max_matches'] || 1000
+    configuration.settings['max_matches'] || 1000
   end
 
   def limit

data/lib/thinking_sphinx/index_set.rb

@@ -3,9 +3,9 @@ class ThinkingSphinx::IndexSet
 
   delegate :each, :empty?, :to => :indices
 
-  def initialize(classes, index_names, configuration = nil)
-    @classes       = classes || []
-    @index_names   = index_names
+  def initialize(options = {}, configuration = nil)
+    @options       = options
+    @index_names   = options[:indices] || []
     @configuration = configuration || ThinkingSphinx::Configuration.instance
   end
 
@@ -19,7 +19,20 @@ class ThinkingSphinx::IndexSet
 
   private
 
-  attr_reader :classes, :configuration, :index_names
+  attr_reader :configuration, :options
+
+  def all_indices
+    configuration.preload_indices
+    configuration.indices
+  end
+
+  def classes
+    options[:classes] || []
+  end
+
+  def classes_specified?
+    classes.any? || references_specified?
+  end
 
   def classes_and_ancestors
     @classes_and_ancestors ||= classes.collect { |model|
@@ -31,21 +44,30 @@ class ThinkingSphinx::IndexSet
     }.flatten
   end
 
-  def indices
-    configuration.preload_indices
+  def index_names
+    options[:indices] || []
+  end
 
-    return configuration.indices.select { |index|
+  def indices
+    return all_indices.select { |index|
       index_names.include?(index.name)
-    } if index_names && index_names.any?
+    } if index_names.any?
 
-    everything = classes.empty? ? configuration.indices :
-      configuration.indices_for_references(*references)
+    everything = classes_specified? ? indices_for_references : all_indices
     everything.reject &:distributed?
   end
 
+  def indices_for_references
+    all_indices.select { |index| references.include? index.reference }
+  end
+
   def references
-    classes_and_ancestors.collect { |klass|
+    options[:references] || classes_and_ancestors.collect { |klass|
       klass.name.underscore.to_sym
     }
   end
+
+  def references_specified?
+    options[:references] && options[:references].any?
+  end
 end