thinking-sphinx 3.0.1 → 3.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2825535169716d44b3c2a897d70bdd6c44638b17
+  data.tar.gz: 30d74a154abf22f00795be4eaae8cb69e16fff19
+SHA512:
+  metadata.gz: 4f33cf2627e2944ecee27c689a60770a201a4eb54de9fd97354b3eec27cd07d0d847d79a003b4df8e188f5dc3ecdf2a36ac7003cb8cb63f158f4486f3f75f1cc
+  data.tar.gz: a66b7764fcb538650f61931d4a5bddaf9d708098db223606a120f503a1eecbbe533e6b048b942a10fe157b8a11b593b0ff4e27a80e7934378597cfe2f6fd284a

data/.travis.yml

@@ -1,10 +1,12 @@
+language: ruby
 rvm:
   - 1.9.2
   - 1.9.3
+  - 2.0.0
 before_install:
   - gem update --system
-  - curl -O http://fs-packages.s3.amazonaws.com/fs-sphinx-2.0.6_i386_12.04.deb
-  - sudo dpkg -i fs-sphinx-2.0.6_i386_12.04.deb
+  - curl -O http://fs-packages.s3.amazonaws.com/fs-sphinx-2.0.6_x86_64_12.04.deb
+  - sudo dpkg -i fs-sphinx-2.0.6_x86_64_12.04.deb
 before_script:
   - "mysql -e 'create database thinking_sphinx;' > /dev/null"
   - "psql -c 'create database thinking_sphinx;' -U postgres >/dev/null"
@@ -14,3 +16,4 @@ env:
 gemfile:
   - gemfiles/rails_3_1.gemfile
   - gemfiles/rails_3_2.gemfile
+  - gemfiles/rails_4_0.gemfile

data/Appraisals

@@ -5,3 +5,7 @@ end
 appraise 'rails_3_2' do
   gem 'rails',  '~> 3.2.0'
 end
+
+appraise 'rails_4_0' do
+  gem 'rails', '~> 4.0.0.beta1'
+end

data/Gemfile

@@ -1,4 +1,4 @@
-source :rubygems
+source 'https://rubygems.org'
 
 gemspec
 

data/HISTORY

@@ -1,3 +1,21 @@
+2013-03-23: 3.0.2
+* [CHANGE] per_page now accepts an optional paging limit, to match WillPaginate's behaviour. If none is supplied, it just returns the page size.
+* [FEATURE] Ruby 2.0 support.
+* [FEATURE] Rails 4.0.0 beta1 support.
+* [FIX] :utf8? option within index definitions is now supported, and defaults to true if the database configuration's encoding is set to 'utf8'.
+* [FIX] indices_location and configuration_file values in thinking_sphinx.yml will be applied to the configuration.
+* [CHANGE] Strings and regular expressions in ThinkingSphinx::Search::Query are now treated as UTF-8.
+* [FIX] Primary keys that are not 'id' now work correctly.
+* [CHANGE] Setting a custom framework will rebuild the core configuration around its provided settings (path and environment).
+* [CHANGE] Search masks don't rely on respond_to?, and so Object/Kernel methods are passed through to the underlying array instead.
+* [FIX] Search options specified in index definitions and thinking_sphinx.yml are now used in search requests (eg: max_matches, field_weights).
+* [FEATURE] Indexes defined in app/indices in engines are now loaded (Antonio Tapiador del Dujo).
+* [FIX] Custom association conditions are no longer presumed to be an array.
+* [CHANGE] Empty search conditions are now ignored, instead of being appended with no value (Nicholas Klick).
+* [CHANGE] Custom conditions are no longer added to the sql_query_range value, as they may involve associations.
+* [FIX] Capistrano tasks use the correct ts rake task prefix (David Celis).
+* [FEATURE] Query errors are classified as such, instead of getting the base SphinxError.
+
 2013-02-04: 3.0.1
 * [FEATURE] Provide Capistrano deployment tasks (David Celis).
 * [FEATURE] Allow specifying of Sphinx version. Is only useful for Flying Sphinx purposes at this point - has no impact on Riddle or Sphinx.

data/README.textile

@@ -28,7 +28,7 @@ ThinkingSphinx::Index.define :article, :with => :active_record do
   has published
 end</code></pre>
 
-You'll notice the first argument is the model name downcased and as a symbol, and we are specifying the processor - @:active_record@. Everything inside the block is just like previous versions of Thinking Sphinx. Same goes for @config/thinking_sphinx.yml@ (formerly @config/sphinx.yml@).
+You'll notice the first argument is the model name downcased and as a symbol, and we are specifying the processor - @:active_record@. Everything inside the block is just like previous versions of Thinking Sphinx. Same goes for most settings in @config/thinking_sphinx.yml@ (formerly @config/sphinx.yml@) unless noted below.
 
 When you're defining indices for namespaced models, use a lowercase string with /'s for namespacing as the model reference:
 
@@ -37,6 +37,8 @@ ThinkingSphinx::Index.define 'blog/article', :with => :active_record</code></pre
 
 Other changes:
 * SphinxQL is now used instead of the old socket connections (hence the dependency on the @mysql2@ gem).
+* Specifying a different port for Sphinx to use (in @config/thinking_sphinx.yml@) should be done with the mysql41 setting, not the port setting.
+* The searchd_log and searchd_query_log settings are now log and query_log (matching their Sphinx names).
 * You'll need to include @ThinkingSphinx::Scopes@ into your models if you want to use Sphinx scopes. Default scopes can be set as follows:
 
 <pre><code>class Person < ActiveRecord::Base
@@ -193,12 +195,10 @@ h2. Deployment with Capistrano
 
 Thinking Sphinx comes with several Capistrano tasks to help ease deployment of your applications. Just require the recipes:
 
-```ruby
-# config/deploy.rb
-require 'thinking_sphinx/capistrano'
-```
+<pre><code># config/deploy.rb
+require 'thinking_sphinx/capistrano'</code></pre>
 
-When running `cap deploy:setup` to get your server ready for deployments, Thinking Sphinx will also set up a shared folder for your indexes. Before finalizing a deployment, these indexes will be symlinked into the release path for use. When you deploy your application for the first time using `cap deploy:cold`, your indexes will be built for you and the search daemon will be started. Run `cap -T` to see all of the deployment tasks.
+When running @cap deploy:setup@ to get your server ready for deployments, Thinking Sphinx will also set up a shared folder for your indexes. Before finalizing a deployment, these indexes will be symlinked into the release path for use. When you deploy your application for the first time using @cap deploy:cold@, your indexes will be built for you and the search daemon will be started. Run @cap -T@ to see all of the deployment tasks.
 
 h2. Limitations
 
@@ -226,7 +226,7 @@ h3. Ruby Versions
 
 Built on MRI 1.9.3 and tested against MRI 1.9.2 as well. No plans to support MRI 1.8, but would like to support Rubinius and JRuby (the one catch with the latter is the different MySQL interfaces).
 
-There's also the complication that Sphinx 2.0.x releases don't work with JDBC (as JDBC sends several MySQL-specific comamnds through when initializing a connection). So, JRuby support won't appear until there's a stable Sphinx release that can interact with JDBC.
+There's also the complication that Sphinx 2.0.x releases don't work with JDBC (as JDBC sends several MySQL-specific commands through when initializing a connection). So, JRuby support won't appear until there's a stable Sphinx release that can interact with JDBC.
 
 h3. Database Versions
 

data/gemfiles/rails_3_1.gemfile

@@ -1,6 +1,6 @@
 # This file was generated by Appraisal
 
-source :rubygems
+source "https://rubygems.org"
 
 gem "mysql2", "~> 0.3.12b4", :platform=>:ruby
 gem "pg", "~> 0.11.0", :platform=>:ruby

data/gemfiles/rails_3_2.gemfile

@@ -1,6 +1,6 @@
 # This file was generated by Appraisal
 
-source :rubygems
+source "https://rubygems.org"
 
 gem "mysql2", "~> 0.3.12b4", :platform=>:ruby
 gem "pg", "~> 0.11.0", :platform=>:ruby

data/gemfiles/rails_4_0.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.11.0", :platform=>:ruby
+gem "activerecord-jdbcmysql-adapter", "~> 1.1.3", :platform=>:jruby
+gem "activerecord-jdbcpostgresql-adapter", "~> 1.1.3", :platform=>:jruby
+gem "rails", "~> 4.0.0.beta1"
+
+gemspec :path=>"../"

data/lib/thinking_sphinx.rb

@@ -9,6 +9,7 @@ require 'riddle'
 require 'middleware'
 require 'active_record'
 require 'innertube'
+require 'active_support/core_ext/module/delegation'
 
 module ThinkingSphinx
   def self.count(query = '', options = {})

data/lib/thinking_sphinx/active_record/associations.rb

@@ -79,8 +79,15 @@ class ThinkingSphinx::ActiveRecord::Associations
   end
 
   def rewrite_conditions_for(join)
-    conditions = Array(join.conditions).flatten
+    if join.respond_to?(:scope_chain)
+      conditions = Array(join.scope_chain).flatten
+    else
+      conditions = Array(join.conditions).flatten
+    end
+
     conditions.each do |condition|
+      next unless condition.is_a?(String)
+
       condition.gsub! /::ts_join_alias::/,
         model.connection.quote_table_name(join.parent.aliased_table_name)
     end

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

@@ -10,4 +10,8 @@ class ThinkingSphinx::ActiveRecord::DatabaseAdapters::AbstractAdapter
   def quoted_table_name
     @model.quoted_table_name
   end
+
+  def utf8_query_pre
+    []
+  end
 end

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

@@ -20,4 +20,8 @@ class ThinkingSphinx::ActiveRecord::DatabaseAdapters::MySQLAdapter <
   def group_concatenate(clause, separator = ' ')
     "GROUP_CONCAT(#{clause} SEPARATOR '#{separator}')"
   end
+
+  def utf8_query_pre
+    ['SET NAMES utf8']
+  end
 end

data/lib/thinking_sphinx/active_record/filtered_reflection.rb

@@ -1,8 +1,8 @@
 class ThinkingSphinx::ActiveRecord::FilteredReflection <
   ActiveRecord::Reflection::AssociationReflection
 
-  class Options
-    attr_reader :reflection, :class_name, :options
+  class Filter
+    attr_reader :reflection, :class_name
 
     delegate :foreign_type, :active_record, :to => :reflection
 
@@ -11,23 +11,36 @@ class ThinkingSphinx::ActiveRecord::FilteredReflection <
       @options = reflection.options.clone
     end
 
-    def filtered
-      options.delete :polymorphic
-      options[:class_name]    = class_name
-      options[:foreign_key] ||= "#{reflection.name}_id"
+    def options
+      @options.delete :polymorphic
+      @options[:class_name]    = class_name
+      @options[:foreign_key] ||= "#{reflection.name}_id"
+      @options[:foreign_type]  = reflection.foreign_type
 
-      case options[:conditions]
+      return @options if reflection.respond_to?(:scope)
+
+      case @options[:conditions]
       when nil
-        options[:conditions] = condition
+        @options[:conditions] = condition
       when Array
-        options[:conditions] << condition
+        @options[:conditions] << condition
       when Hash
-        options[:conditions].merge!(reflection.foreign_type => options[:class_name])
+        @options[:conditions].merge!(reflection.foreign_type => @options[:class_name])
       else
-        options[:conditions] << " AND #{condition}"
+        @options[:conditions] << " AND #{condition}"
       end
 
-      options
+      @options
+    end
+
+    def scope
+      lambda { |association|
+        reflection = association.reflection
+        where(
+          association.parent.aliased_table_name.to_sym =>
+          {reflection.foreign_type => reflection.class_name}
+        )
+      }
     end
 
     private
@@ -42,8 +55,13 @@ class ThinkingSphinx::ActiveRecord::FilteredReflection <
   end
 
   def self.clone_with_filter(reflection, name, class_name)
-    options = Options.new(reflection, class_name).filtered
+    filter = Filter.new(reflection, class_name)
 
-    new reflection.macro, name, options, reflection.active_record
+    if reflection.respond_to?(:scope)
+      new reflection.macro, name, filter.scope, filter.options,
+        reflection.active_record
+    else
+      new reflection.macro, name, filter.options, reflection.active_record
+    end
   end
 end

data/lib/thinking_sphinx/active_record/sql_builder.rb

@@ -43,7 +43,7 @@ class ThinkingSphinx::ActiveRecord::SQLBuilder
 
     queries << delta_processor.reset_query if reset_delta
     queries << "SET SESSION group_concat_max_len = #{max_len}" if max_len
-    queries << source.adapter.utf8_query_pre if source.options[:utf8?]
+    queries += source.adapter.utf8_query_pre if source.options[:utf8?]
 
     queries.compact
   end
@@ -129,10 +129,10 @@ class ThinkingSphinx::ActiveRecord::SQLBuilder
     ).compact.join(', ')
   end
 
-  def where_clause(without_range = false)
+  def where_clause(for_range = false)
     logic = []
 
-    unless without_range || source.disable_range?
+    unless for_range || source.disable_range?
       logic << "#{quoted_primary_key} >= $start"
       logic << "#{quoted_primary_key} <= $end"
     end
@@ -143,7 +143,7 @@ class ThinkingSphinx::ActiveRecord::SQLBuilder
     end
 
     logic << delta_processor.clause(source.delta?) if delta_processor
-    logic += source.conditions
+    logic += source.conditions unless for_range
 
     logic.compact.join(' AND ')
   end

data/lib/thinking_sphinx/active_record/sql_source.rb

@@ -9,7 +9,9 @@ class ThinkingSphinx::ActiveRecord::SQLSource < Riddle::Configuration::SQLSource
   def initialize(model, options = {})
     @model             = model
     @database_settings = model.connection.instance_variable_get(:@config).clone
-    @options           = options
+    @options           = {
+      :utf8? => (@database_settings[:encoding] == 'utf8')
+    }.merge options
 
     @fields            = []
     @attributes        = []

data/lib/thinking_sphinx/active_record/sql_source/template.rb

@@ -8,7 +8,7 @@ class ThinkingSphinx::ActiveRecord::SQLSource::Template
   def apply
     add_field class_column, :sphinx_internal_class_name
 
-    add_attribute :id,          :sphinx_internal_id,    nil
+    add_attribute primary_key,  :sphinx_internal_id,    nil
     add_attribute class_column, :sphinx_internal_class, :string, :facet => true
     add_attribute '0',          :sphinx_deleted,        :integer
   end
@@ -46,4 +46,8 @@ class ThinkingSphinx::ActiveRecord::SQLSource::Template
   def model
     source.model
   end
+
+  def primary_key
+    source.model.primary_key.to_sym
+  end
 end

data/lib/thinking_sphinx/capistrano.rb

@@ -2,29 +2,29 @@ Capistrano::Configuration.instance(:must_exist).load do
   namespace :thinking_sphinx do
     desc 'Generate the Sphinx configuration file.'
     task :configure do
-      rake 'thinking_sphinx:configure'
+      rake 'ts:configure'
     end
 
     desc 'Build Sphinx indexes into the shared path and symlink them into your release.'
     task :index do
-      rake 'thinking_sphinx:index'
+      rake 'ts:index'
     end
     after 'thinking_sphinx:index', 'thinking_sphinx:symlink_indexes'
 
     desc 'Start the Sphinx search daemon.'
     task :start do
-      rake 'thinking_sphinx:start'
+      rake 'ts:start'
     end
     before 'thinking_sphinx:start', 'thinking_sphinx:configure'
 
     desc 'Stop the Sphinx search daemon.'
     task :stop do
-      rake 'thinking_sphinx:stop'
+      rake 'ts:stop'
     end
 
     desc 'Restart the Sphinx search daemon.'
     task :restart do
-      rake 'thinking_sphinx:stop thinking_sphinx:configure thinking_sphinx:start'
+      rake 'ts:stop ts:configure ts:start'
     end
 
     desc <<-DESC
@@ -32,10 +32,9 @@ Stop, reindex, and then start the Sphinx search daemon. This task must be execut
 if you alter the structure of your indexes.
     DESC
     task :rebuild do
-      rake 'thinking_sphinx:stop thinking_sphinx:reindex'
+      rake 'ts:rebuild'
     end
     after 'thinking_sphinx:rebuild', 'thinking_sphinx:symlink_indexes'
-    after 'thinking_sphinx:rebuild', 'thinking_sphinx:start'
 
     desc 'Create the shared folder for sphinx indexes.'
     task :shared_sphinx_folder do

data/lib/thinking_sphinx/configuration.rb

@@ -1,42 +1,14 @@
 class ThinkingSphinx::Configuration < Riddle::Configuration
   attr_accessor :configuration_file, :indices_location, :version
   attr_reader :index_paths
-  attr_writer :controller, :framework
+  attr_writer :controller
+
+  delegate :environment, :to => :framework
 
   def initialize
     super
 
-    @configuration_file = File.join framework.root, 'config',
-      "#{framework.environment}.sphinx.conf"
-    @index_paths        = [File.join(framework.root, 'app', 'indices')]
-    @indices_location   = File.join framework.root, 'db', 'sphinx',
-      framework.environment
-    @version            = settings['version'] || '2.0.6'
-
-    searchd.pid_file    = File.join framework.root, 'log',
-      "#{framework.environment}.sphinx.pid"
-    searchd.log         = File.join framework.root, 'log',
-      "#{framework.environment}.searchd.log"
-    searchd.query_log   = File.join framework.root, 'log',
-      "#{framework.environment}.searchd.query.log"
-    searchd.binlog_path = File.join framework.root, 'tmp', 'binlog',
-      framework.environment
-
-    searchd.address   = settings['address']
-    searchd.address   = Defaults::ADDRESS unless searchd.address.present?
-    searchd.mysql41   = settings['mysql41'] || settings['port'] ||
-      Defaults::PORT
-    searchd.workers   = 'threads'
-
-   [indexer, searchd].each do |object|
-      settings.each do |key, value|
-        next unless object.class.settings.include?(key.to_sym)
-
-        object.send("#{key}=", value)
-      end
-    end
-
-    @offsets = {}
+    setup
   end
 
   def self.instance
@@ -61,6 +33,22 @@ class ThinkingSphinx::Configuration < Riddle::Configuration
     @framework ||= ThinkingSphinx::Frameworks.current
   end
 
+  def framework=(framework)
+    @framework = framework
+    setup
+    framework
+  end
+
+  def engine_index_paths
+    return [] unless defined?(Rails)
+
+    Rails::Engine::Railties.engines.select { |engine|
+      engine.paths['app/indices']
+    }.collect { |engine|
+      engine.paths['app/indices'].existent
+    }.flatten
+  end
+
   def indices_for_references(*references)
     preload_indices
     indices.select { |index| references.include?(index.reference) }
@@ -104,12 +92,47 @@ class ThinkingSphinx::Configuration < Riddle::Configuration
 
   def settings_to_hash
     contents = YAML.load(ERB.new(File.read(settings_file)).result)
-    contents && contents[framework.environment] || {}
+    contents && contents[environment] || {}
   end
 
   def settings_file
     File.join framework.root, 'config', 'thinking_sphinx.yml'
   end
+
+  def setup
+    @configuration_file = settings['configuration_file'] ||
+      File.join(framework.root, 'config', "#{environment}.sphinx.conf")
+    @index_paths        = engine_index_paths +
+      [File.join(framework.root, 'app', 'indices')]
+    @indices_location   = settings['indices_location'] ||
+      File.join(framework.root, 'db', 'sphinx', environment)
+    @version            = settings['version'] || '2.0.6'
+
+    searchd.pid_file    = File.join framework.root, 'log',
+      "#{environment}.sphinx.pid"
+    searchd.log         = File.join framework.root, 'log',
+      "#{environment}.searchd.log"
+    searchd.query_log   = File.join framework.root, 'log',
+      "#{environment}.searchd.query.log"
+    searchd.binlog_path = File.join framework.root, 'tmp', 'binlog',
+      environment
+
+    searchd.address   = settings['address']
+    searchd.address   = Defaults::ADDRESS unless searchd.address.present?
+    searchd.mysql41   = settings['mysql41'] || settings['port'] ||
+      Defaults::PORT
+    searchd.workers   = 'threads'
+
+   [indexer, searchd].each do |object|
+      settings.each do |key, value|
+        next unless object.class.settings.include?(key.to_sym)
+
+        object.send("#{key}=", value)
+      end
+    end
+
+    @offsets = {}
+  end
 end
 
 require 'thinking_sphinx/configuration/consistent_ids'