thinking-sphinx 1.3.3 → 1.3.4

data/README.textile

@@ -142,3 +142,6 @@ Since I first released this library, there's been quite a few people who have su
 * Christian Aust
 * Martin Sarasale
 * Édouard Brière
+* Steve Madsen
+* Justin DeWind
+* Chris Z

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
-:patch: 3
+:patch: 4
 :major: 1
 :build: 
 :minor: 3

data/lib/thinking_sphinx.rb

@@ -1,7 +1,3 @@
-Dir[File.join(File.dirname(__FILE__), '../vendor/*/lib')].each do |path|
-  $LOAD_PATH.unshift path
-end
-
 require 'active_record'
 require 'after_commit'
 require 'yaml'

data/lib/thinking_sphinx/active_record/scopes.rb

@@ -8,6 +8,40 @@ module ThinkingSphinx
       end
     
       module ClassMethods
+        
+        # Similar to ActiveRecord's default_scope method Thinking Sphinx supports
+        # a default_sphinx_scope. For example:
+        #
+        #    default_sphinx_scope :some_sphinx_named_scope
+        #
+        # The scope is automatically applied when the search method is called. It
+        # will only be applied if it is an existing sphinx_scope.
+        def default_sphinx_scope(sphinx_scope_name)
+          @default_sphinx_scope = sphinx_scope_name
+        end
+
+        # Returns the default_sphinx_scope or nil if none is set.
+        def get_default_sphinx_scope
+          @default_sphinx_scope
+        end
+
+        # Returns true if the current Model has a default_sphinx_scope. Also checks if
+        # the default_sphinx_scope actually is a scope.
+        def has_default_sphinx_scope?
+          !@default_sphinx_scope.nil? && sphinx_scopes.include?(@default_sphinx_scope)
+        end
+
+        # Similar to ActiveRecord's named_scope method Thinking Sphinx supports
+        # scopes. For example:
+        #
+        #   sphinx_scope(:latest_first) { 
+        #       {:order => 'created_at DESC, @relevance DESC'}
+        #     }
+        #
+        # Usage:
+        #
+        #   @articles =  Article.latest_first.search 'pancakes'
+        #
         def sphinx_scope(method, &block)
           @sphinx_scopes ||= []
           @sphinx_scopes << method
@@ -21,7 +55,9 @@ module ThinkingSphinx
             end
           end
         end
-        
+
+        # This returns an Array of all defined scopes. The default
+        # scope shows as :default.
         def sphinx_scopes
           @sphinx_scopes || []
         end

data/lib/thinking_sphinx/configuration.rb

@@ -49,14 +49,18 @@ module ThinkingSphinx
   class Configuration
     include Singleton
     
-    SourceOptions = %w( mysql_connect_flags sql_range_step sql_query_pre
-      sql_query_post sql_ranged_throttle sql_query_post_index )
+    SourceOptions = %w( mysql_connect_flags mysql_ssl_cert mysql_ssl_key
+      mysql_ssl_ca sql_range_step sql_query_pre sql_query_post 
+      sql_query_killlist sql_ranged_throttle sql_query_post_index unpack_zlib
+      unpack_mysqlcompress unpack_mysqlcompress_maxsize )
     
     IndexOptions  = %w( charset_table charset_type docinfo enable_star
-      exceptions html_index_attrs html_remove_elements html_strip ignore_chars
-      min_infix_len min_prefix_len min_word_len mlock morphology ngram_chars
-      ngram_len phrase_boundary phrase_boundary_step preopen stopwords
-      wordforms )
+      exceptions html_index_attrs html_remove_elements html_strip
+      index_exact_words ignore_chars inplace_docinfo_gap inplace_enable
+      inplace_hit_gap inplace_reloc_factor inplace_write_factor min_infix_len
+      min_prefix_len min_stemming_len min_word_len mlock morphology ngram_chars
+      ngram_len ondisk_dict overshort_step phrase_boundary phrase_boundary_step
+      preopen stopwords stopwords_step wordforms )
     
     CustomOptions = %w( disable_range )
         

data/lib/thinking_sphinx/deploy/capistrano.rb

@@ -93,7 +93,7 @@ DESC
       rails_env = fetch(:rails_env, "production")
       rake = fetch(:rake, "rake")
       tasks.each do |t|
-        run "cd #{current_path}; #{rake} RAILS_ENV=#{rails_env} #{t}"
+        run "if [ -d #{release_path} ]; then cd #{release_path}; else cd #{current_path}; fi; #{rake} RAILS_ENV=#{rails_env} #{t}"
       end
     end
   end

data/lib/thinking_sphinx/search.rb

@@ -14,7 +14,7 @@ module ThinkingSphinx
       kind_of? member? method methods nil? object_id respond_to? send should
       type )
     SafeMethods = %w( partition private_methods protected_methods
-      public_methods send )
+      public_methods send class )
     
     instance_methods.select { |method|
       method.to_s[/^__/].nil? && !CoreMethods.include?(method.to_s)
@@ -215,6 +215,7 @@ module ThinkingSphinx
     end
     
     def search(*args)
+      add_default_scope
       merge_search ThinkingSphinx::Search.new(*args)
       self
     end
@@ -231,8 +232,12 @@ module ThinkingSphinx
       
       retry_on_stale_index do
         begin
-          log "Querying Sphinx: #{query}"
-          @results = client.query query, indexes, comment
+          log "Querying: '#{query}'"
+          runtime = Benchmark.realtime {
+            @results = client.query query, indexes, comment
+          }
+          log "Found #{@results[:total_found]} results", :debug,
+            "Sphinx (#{sprintf("%f", runtime)}s)"
         rescue Errno::ECONNREFUSED => err
           raise ThinkingSphinx::ConnectionError,
             'Connection to Sphinx Daemon (searchd) failed.'
@@ -280,13 +285,16 @@ module ThinkingSphinx
       end
     end
     
-    def self.log(message, method = :debug)
+    def self.log(message, method = :debug, identifier = 'Sphinx')
       return if ::ActiveRecord::Base.logger.nil?
-      ::ActiveRecord::Base.logger.send method, message
+      identifier_color, message_color = "4;32;1", "0" # 0;1 = Bold
+      info = "  \e[#{identifier_color}m#{identifier}\e[0m   "
+      info << "\e[#{message_color}m#{message}\e[0m"
+      ::ActiveRecord::Base.logger.send method, info
     end
     
-    def log(message, method = :debug)
-      self.class.log(message, method)
+    def log(*args)
+      self.class.log(*args)
     end
     
     def client
@@ -684,6 +692,11 @@ MSG
       one_class && one_class.sphinx_scopes.include?(method)
     end
     
+    # Adds the default_sphinx_scope if set.
+    def add_default_scope
+      add_scope(one_class.get_default_sphinx_scope) if one_class && one_class.has_default_sphinx_scope?
+    end
+    
     def add_scope(method, *args, &block)
       merge_search one_class.send(method, *args, &block)
     end

data/lib/thinking_sphinx/source.rb

@@ -43,8 +43,8 @@ module ThinkingSphinx
       
       set_source_database_settings  source
       set_source_attributes         source, offset
-      set_source_sql                source, offset
       set_source_settings           source
+      set_source_sql                source, offset
       
       source
     end
@@ -57,6 +57,7 @@ module ThinkingSphinx
       
       set_source_database_settings  source
       set_source_attributes         source, offset, true
+      set_source_settings           source
       set_source_sql                source, offset, true
       
       source

data/rails/init.rb

@@ -1,3 +1,7 @@
+Dir[File.join(File.dirname(__FILE__), '../vendor/*/lib')].each do |path|
+  $LOAD_PATH.unshift path
+end
+
 require 'thinking_sphinx/0.9.8'
 require 'action_controller/dispatcher'
 

data/spec/lib/thinking_sphinx/active_record/scopes_spec.rb

@@ -34,7 +34,22 @@ describe ThinkingSphinx::ActiveRecord::Scopes do
       Alpha.sphinx_scopes.should == [:by_name]
     end
   end
-  
+
+  describe '.default_sphinx_scope' do
+    before :each do
+      Alpha.sphinx_scope(:scope_used_as_default_scope) { {:conditions => {:name => 'name'}} }
+      Alpha.default_sphinx_scope :scope_used_as_default_scope
+    end
+    
+    it "should return an array of defined scope names as symbols" do
+      Alpha.sphinx_scopes.should == [:scope_used_as_default_scope]
+    end
+    
+    it "should have a default_sphinx_scope" do
+      Alpha.has_default_sphinx_scope?.should be_true
+    end
+  end
+
   describe '.remove_sphinx_scopes' do
     before :each do
       Alpha.sphinx_scope(:by_name) { |name| {:conditions => {:name => name}} }
@@ -49,7 +64,36 @@ describe ThinkingSphinx::ActiveRecord::Scopes do
       Alpha.sphinx_scopes.should be_empty
     end
   end
-  
+
+  describe '.example_default_scope' do
+    before :each do
+      Alpha.sphinx_scope(:foo_scope){ {:conditions => {:name => 'foo'}} }
+      Alpha.default_sphinx_scope :foo_scope
+      Alpha.sphinx_scope(:by_name) { |name| {:conditions => {:name => name}} }
+      Alpha.sphinx_scope(:by_foo)  { |foo|  {:conditions => {:foo  => foo}}  }
+    end
+
+    it "should return a ThinkingSphinx::Search object" do
+      Alpha.search.should be_a(ThinkingSphinx::Search)
+    end
+
+    it "should apply the default scope options to the underlying search object" do
+      search = ThinkingSphinx::Search.new(:classes => [Alpha])
+      search.search.options[:conditions].should == {:name => 'foo'}
+    end
+
+    it "should apply the default scope options and scope options to the underlying search object" do
+      search = ThinkingSphinx::Search.new(:classes => [Alpha])
+      search.by_foo('foo').search.options[:conditions].should == {:foo => 'foo', :name => 'foo'}
+    end
+
+    # FIXME: Probably the other way around is more logical? How to do this?
+    it "should apply the default scope options after other scope options to the underlying search object" do
+      search = ThinkingSphinx::Search.new(:classes => [Alpha])
+      search.by_name('bar').search.options[:conditions].should == {:name => 'foo'}
+    end
+  end
+
   describe '.example_scope' do
     before :each do
       Alpha.sphinx_scope(:by_name) { |name| {:conditions => {:name => name}} }

data/spec/lib/thinking_sphinx/configuration_spec.rb

@@ -50,7 +50,8 @@ describe ThinkingSphinx::Configuration do
           "charset_table"     => "table",
           "ignore_chars"      => "e",
           "searchd_binary_name" => "sphinx-searchd",
-          "indexer_binary_name" => "sphinx-indexer"
+          "indexer_binary_name" => "sphinx-indexer",
+          "index_exact_words" => true
         }
       }
 
@@ -187,7 +188,9 @@ describe ThinkingSphinx::Configuration do
 
   it "should insert set index options into the configuration file" do
     config = ThinkingSphinx::Configuration.instance
+    
     ThinkingSphinx::Configuration::IndexOptions.each do |option|
+      config.reset
       config.index_options[option.to_sym] = "something"
       config.build
 
@@ -200,15 +203,34 @@ describe ThinkingSphinx::Configuration do
 
   it "should insert set source options into the configuration file" do
     config = ThinkingSphinx::Configuration.instance
+    config.reset
+    
+    config.source_options[:sql_query_pre] = ["something"]
     ThinkingSphinx::Configuration::SourceOptions.each do |option|
-      config.source_options[option.to_sym] = "something"
+      config.source_options[option.to_sym] ||= "something"
       config.build
 
       file = open(config.config_file) { |f| f.read }
       file.should match(/#{option}\s+= something/)
 
-      config.source_options[option.to_sym] = nil
+      config.source_options.delete option.to_sym
     end
+    
+    config.source_options[:sql_query_pre] = nil  
+  end
+  
+  it "should not blow away delta or utf options if sql pre is specified in config" do
+    config = ThinkingSphinx::Configuration.instance
+    config.reset
+    
+    config.source_options[:sql_query_pre] = ["a pre query"]
+    config.build
+    file = open(config.config_file) { |f| f.read }
+    
+    file.should match(/sql_query_pre = a pre query\n\s*sql_query_pre = UPDATE `\w+` SET `delta` = 0 WHERE `delta` = 1/im)
+    file.should match(/sql_query_pre = a pre query\n\s*sql_query_pre = \n/im)
+    
+    config.source_options[:sql_query_pre] = nil
   end
 
   it "should set any explicit prefixed or infixed fields" do

data/spec/lib/thinking_sphinx/index/builder_spec.rb

@@ -452,4 +452,18 @@ describe ThinkingSphinx::Index::Builder do
       @index.delta_object.should be_a_kind_of(ThinkingSphinx::Deltas::DefaultDelta)
     end
   end
+  
+  context 'index options' do
+    before :each do
+      @index = ThinkingSphinx::Index::Builder.generate(Person) do
+        indexes first_name
+        
+        set_property :index_exact_words => true
+      end
+    end
+    
+    it "should track the index_exact_words option to the index" do
+      @index.local_options[:index_exact_words].should be_true
+    end
+  end
 end

data/tasks/distribution.rb

@@ -28,7 +28,7 @@ Jeweler::Tasks.new do |gem|
   ]
   
   gem.add_dependency 'activerecord', '>= 1.15.6'
-  gem.add_dependency 'riddle',       '>= 1.0.0'
+  gem.add_dependency 'riddle',       '>= 1.0.1'
   gem.add_dependency 'after_commit', '>= 1.0.2'
   
   gem.post_install_message = <<-MESSAGE

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: thinking-sphinx
 version: !ruby/object:Gem::Version 
-  version: 1.3.3
+  version: 1.3.4
 platform: ruby
 authors: 
 - Pat Allan
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-11 00:00:00 +11:00
+date: 2009-11-16 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,7 +30,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.0.0
+        version: 1.0.1
     version: 
 - !ruby/object:Gem::Dependency 
   name: after_commit