freelancing-god-thinking-sphinx 1.2.4 → 1.2.5

data/README.textile

@@ -146,3 +146,4 @@ Since I first released this library, there's been quite a few people who have su
 * Josh Kalderimis
 * J.D. Hollis
 * Jeffrey Chupp
+* Rob Anderton

data/lib/thinking_sphinx.rb

@@ -38,16 +38,16 @@ module ThinkingSphinx
   module Version #:nodoc:
     Major = 1
     Minor = 2
-    Tiny  = 4
+    Tiny  = 5
     
     String = [Major, Minor, Tiny].join('.')
   end
-  
+
   # A ConnectionError will get thrown when a connection to Sphinx can't be
   # made.
   class ConnectionError < StandardError
   end
-  
+
   # A StaleIdsException is thrown by Collection.instances_from_matches if there
   # are records in Sphinx but not in the database, so the search can be retried.
   class StaleIdsException < StandardError
@@ -56,42 +56,42 @@ module ThinkingSphinx
       self.ids = ids
     end
   end
-  
+
   # The collection of indexed models. Keep in mind that Rails lazily loads
   # its classes, so this may not actually be populated with _all_ the models
   # that have Sphinx indexes.
   def self.indexed_models
     @@indexed_models ||= []
   end
-  
+
   def self.unique_id_expression(offset = nil)
     "* #{ThinkingSphinx.indexed_models.size} + #{offset || 0}"
   end
-  
+
   # Check if index definition is disabled.
-  # 
+  #
   def self.define_indexes?
     @@define_indexes =  true unless defined?(@@define_indexes)
     @@define_indexes == true
   end
-  
+
   # Enable/disable indexes - you may want to do this while migrating data.
-  # 
+  #
   #   ThinkingSphinx.define_indexes = false
-  # 
+  #
   def self.define_indexes=(value)
     @@define_indexes = value
   end
-  
+
   @@deltas_enabled = nil
 
   # Check if delta indexing is enabled.
-  # 
+  #
   def self.deltas_enabled?
     @@deltas_enabled  = (ThinkingSphinx::Configuration.environment != 'test') if @@deltas_enabled.nil?
     @@deltas_enabled
   end
-  
+
   # Enable/disable all delta indexing.
   #
   #   ThinkingSphinx.deltas_enabled = false
@@ -99,38 +99,38 @@ module ThinkingSphinx
   def self.deltas_enabled=(value)
     @@deltas_enabled = value
   end
-  
+
   @@updates_enabled = nil
-  
+
   # Check if updates are enabled. True by default, unless within the test
   # environment.
-  # 
+  #
   def self.updates_enabled?
     @@updates_enabled  = (ThinkingSphinx::Configuration.environment != 'test') if @@updates_enabled.nil?
     @@updates_enabled
   end
-  
+
   # Enable/disable updates to Sphinx
-  # 
+  #
   #   ThinkingSphinx.updates_enabled = false
   #
   def self.updates_enabled=(value)
     @@updates_enabled = value
   end
-  
+
   @@suppress_delta_output = false
-  
+
   def self.suppress_delta_output?
     @@suppress_delta_output
   end
-  
+
   def self.suppress_delta_output=(value)
     @@suppress_delta_output = value
   end
-  
+
   # Checks to see if MySQL will allow simplistic GROUP BY statements. If not,
   # or if not using MySQL, this will return false.
-  # 
+  #
   def self.use_group_by_shortcut?
     !!(
       mysql? && ::ActiveRecord::Base.connection.select_all(
@@ -138,75 +138,65 @@ module ThinkingSphinx
       ).all? { |key,value| value.nil? || value[/ONLY_FULL_GROUP_BY/].nil? }
     )
   end
-  
+
   @@remote_sphinx = false
-  
+
   # An indication of whether Sphinx is running on a remote machine instead of
   # the same machine.
-  # 
+  #
   def self.remote_sphinx?
     @@remote_sphinx
   end
-  
+
   # Tells Thinking Sphinx that Sphinx is running on a different machine, and
-  # thus it can't reliably guess whether it is running or not (ie: the 
+  # thus it can't reliably guess whether it is running or not (ie: the
   # #sphinx_running? method), and so just assumes it is.
-  # 
+  #
   # Useful for multi-machine deployments. Set it in your production.rb file.
-  # 
+  #
   #   ThinkingSphinx.remote_sphinx = true
-  # 
+  #
   def self.remote_sphinx=(value)
     @@remote_sphinx = value
   end
-  
+
   # Check if Sphinx is running. If remote_sphinx is set to true (indicating
   # Sphinx is on a different machine), this will always return true, and you
   # will have to handle any connection errors yourself.
-  # 
+  #
   def self.sphinx_running?
     remote_sphinx? || sphinx_running_by_pid?
   end
-  
+
   # Check if Sphinx is actually running, provided the pid is on the same
   # machine as this code.
-  # 
+  #
   def self.sphinx_running_by_pid?
     !!sphinx_pid && pid_active?(sphinx_pid)
   end
-  
+
   def self.sphinx_pid
-    pid_file    = ThinkingSphinx::Configuration.instance.pid_file
-    cat_command = 'cat'
-    return nil unless File.exists?(pid_file)
-    
-    if microsoft?
-      pid_file.gsub!('/', '\\')
-      cat_command = 'type'
+    if File.exists?(ThinkingSphinx::Configuration.instance.pid_file)
+      File.read(ThinkingSphinx::Configuration.instance.pid_file)[/\d+/]
+    else
+      nil
     end
-    
-    `#{cat_command} \"#{pid_file}\"`[/\d+/]
   end
-  
+
   def self.pid_active?(pid)
-    return true if microsoft?
-    
-    begin
-      # In JRuby this returns -1 if the process doesn't exist
-      Process.getpgid(pid.to_i) != -1
-    rescue Exception => e
-      false
-    end
+    !!Process.kill(0, pid.to_i)
+  rescue Exception => e
+    false
   end
-  
+
   def self.microsoft?
     RUBY_PLATFORM =~ /mswin/
   end
-  
+
   def self.jruby?
     defined?(JRUBY_VERSION)
   end
-  
+
   def self.mysql?
     ::ActiveRecord::Base.connection.class.name.demodulize == "MysqlAdapter" ||
     ::ActiveRecord::Base.connection.class.name.demodulize == "MysqlplusAdapter" || (

data/lib/thinking_sphinx/active_record.rb

@@ -274,13 +274,18 @@ module ThinkingSphinx
       # nothing
     end
     
+    # Returns the unique integer id for the object. This method uses the
+    # attribute hash to get around ActiveRecord always mapping the #id method
+    # to whatever the real primary key is (which may be a unique string hash).
+    # 
+    # @return [Integer] Unique record id for the purposes of Sphinx.
+    # 
     def primary_key_for_sphinx
-      self.send(self.class.primary_key_for_sphinx)
+      attributes[self.class.primary_key_for_sphinx.to_s]
     end
-
+    
     def sphinx_document_id
-      key = self.class.primary_key_for_sphinx
-      self.attributes[key] * ThinkingSphinx.indexed_models.size +
+      primary_key_for_sphinx * ThinkingSphinx.indexed_models.size +
         ThinkingSphinx.indexed_models.index(self.class.source_of_sphinx_index.name)
     end
 

data/lib/thinking_sphinx/active_record/scopes.rb

@@ -14,7 +14,9 @@ module ThinkingSphinx
           
           metaclass.instance_eval do
             define_method(method) do |*args|
-              options = block.call(*args)
+              options = {:classes => classes_option}
+              options.merge! block.call(*args)
+              
               ThinkingSphinx::Search.new(options)
             end
           end

data/lib/thinking_sphinx/rails_additions.rb

@@ -134,3 +134,17 @@ end
 Class.extend(
   ThinkingSphinx::ClassAttributeMethods
 ) unless Class.respond_to?(:cattr_reader)
+
+module ThinkingSphinx
+  module MetaClass
+    def metaclass
+      class << self
+        self
+      end
+    end
+  end
+end
+
+unless Object.new.respond_to?(:metaclass)
+  Object.send(:include, ThinkingSphinx::MetaClass)
+end

data/lib/thinking_sphinx/search.rb

@@ -187,6 +187,11 @@ module ThinkingSphinx
       ).first
     end
     
+    def search(*args)
+      merge_search ThinkingSphinx::Search.new(*args)
+      self
+    end
+    
     private
     
     def config
@@ -444,6 +449,11 @@ module ThinkingSphinx
     def condition_filters
       (options[:conditions] || {}).collect { |attrib, value|
         if attributes.include?(attrib)
+          puts <<-MSG
+Deprecation Warning: filters on attributes should be done using the :with
+option, not :conditions. For example:
+  :with => {:#{attrib} => #{value.inspect}}
+MSG
           Riddle::Client::Filter.new attrib.to_s, filter_value(value)
         else
           nil
@@ -619,7 +629,11 @@ module ThinkingSphinx
     end
     
     def add_scope(method, *args, &block)
-      search = options[:classes].first.send(method, *args, &block)
+      merge_search options[:classes].first.send(method, *args, &block)
+    end
+    
+    def merge_search(search)
+      search.args.each { |arg| args << arg }
       
       search.options.keys.each do |key|
         if HashOptions.include?(key)
@@ -628,6 +642,7 @@ module ThinkingSphinx
         elsif ArrayOptions.include?(key)
           options[key] ||= []
           options[key] += search.options[key]
+          options[key].uniq!
         else
           options[key] = search.options[key]
         end

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

@@ -57,10 +57,14 @@ describe ThinkingSphinx::ActiveRecord::Scopes do
       Alpha.sphinx_scope(:with_betas) { {:classes => [Beta]} }
     end
     
-    it "should return a ThinkingSphinx object" do
+    it "should return a ThinkingSphinx::Search object" do
       Alpha.by_name('foo').should be_a(ThinkingSphinx::Search)
     end
     
+    it "should set the classes option" do
+      Alpha.by_name('foo').options[:classes].should == [Alpha]
+    end
+    
     it "should be able to be called on a ThinkingSphinx::Search object" do
       search = ThinkingSphinx::Search.new(:classes => [Alpha])
       lambda {

data/spec/lib/thinking_sphinx/active_record_spec.rb

@@ -326,4 +326,29 @@ describe "ThinkingSphinx::ActiveRecord" do
     
     (beta.id * model_count + offset).should == beta.sphinx_document_id
   end
+  
+  describe '#primary_key_for_sphinx' do
+    before :each do
+      @person = Person.find(:first)
+    end
+    
+    after :each do
+      Person.set_sphinx_primary_key nil
+    end
+    
+    it "should return the id by default" do
+      @person.primary_key_for_sphinx.should == @person.id
+    end
+    
+    it "should use the sphinx primary key to determine the value" do
+      Person.set_sphinx_primary_key :first_name
+      @person.primary_key_for_sphinx.should == @person.first_name
+    end
+    
+    it "should not use accessor methods but the attributes hash" do
+      id = @person.id
+      @person.stub!(:id => 'unique_hash')
+      @person.primary_key_for_sphinx.should == id
+    end
+  end
 end

data/spec/lib/thinking_sphinx/configuration_spec.rb

@@ -4,32 +4,32 @@ describe ThinkingSphinx::Configuration do
   describe "environment class method" do
     before :each do
       ThinkingSphinx::Configuration.send(:class_variable_set, :@@environment, nil)
-      
+
       ENV["RAILS_ENV"] = nil
     end
-    
+
     it "should use the Merb environment value if set" do
       unless defined?(Merb)
         module ::Merb; end
       end
-      
+
       ThinkingSphinx::Configuration.stub_method(:defined? => true)
       Merb.stub!(:environment => "merb_production")
       ThinkingSphinx::Configuration.environment.should == "merb_production"
-      
+
       Object.send(:remove_const, :Merb)
     end
-    
+
     it "should use the Rails environment value if set" do
       ENV["RAILS_ENV"] = "rails_production"
       ThinkingSphinx::Configuration.environment.should == "rails_production"
     end
-    
+
     it "should default to development" do
       ThinkingSphinx::Configuration.environment.should == "development"
     end
   end
-  
+
   describe "parse_config method" do
     before :each do
       @settings = {
@@ -53,22 +53,22 @@ describe ThinkingSphinx::Configuration do
           "indexer_binary_name" => "sphinx-indexer"
         }
       }
-      
+
       open("#{RAILS_ROOT}/config/sphinx.yml", "w") do |f|
         f.write  YAML.dump(@settings)
       end
     end
-    
+
     it "should use the accessors to set the configuration values" do
       config = ThinkingSphinx::Configuration.instance
       config.send(:parse_config)
-      
+
       %w(config_file searchd_log_file query_log_file pid_file searchd_file_path
         address port searchd_binary_name indexer_binary_name).each do |key|
         config.send(key).should == @settings["development"][key]
       end
     end
-    
+
     after :each do
       FileUtils.rm "#{RAILS_ROOT}/config/sphinx.yml"
     end
@@ -82,137 +82,143 @@ describe ThinkingSphinx::Configuration do
       ThinkingSphinx::Configuration.instance.app_root.should == "/here/somewhere"
     end
   end
-  
+
   describe "initialisation" do
     it "should have a default bin_path of nothing" do
       ThinkingSphinx::Configuration.instance.bin_path.should == ""
     end
-    
+
     it "should append a / to bin_path if one is supplied" do
       @settings = {
         "development" => {
           "bin_path" => "path/to/somewhere"
         }
       }
-      
+
       open("#{RAILS_ROOT}/config/sphinx.yml", "w") do |f|
         f.write  YAML.dump(@settings)
       end
-      
+
       ThinkingSphinx::Configuration.instance.send(:parse_config)
       ThinkingSphinx::Configuration.instance.bin_path.should match(/\/$/)
+
+      FileUtils.rm "#{RAILS_ROOT}/config/sphinx.yml"
     end
   end
-  
+
   describe "index options" do
     before :each do
       @settings = {
         "development" => {"disable_range" => true}
       }
-      
+
       open("#{RAILS_ROOT}/config/sphinx.yml", "w") do |f|
         f.write  YAML.dump(@settings)
       end
-      
+
       @config = ThinkingSphinx::Configuration.instance
       @config.send(:parse_config)
     end
-    
+
     it "should collect disable_range" do
       @config.index_options[:disable_range].should be_true
     end
+
+    after :each do
+      FileUtils.rm "#{RAILS_ROOT}/config/sphinx.yml"
+    end
   end
-  
+
   describe "#load_models" do
     before :each do
       @config = ThinkingSphinx::Configuration.instance
       @config.model_directories = ['']
-      
+
       @file_name        = 'a.rb'
       @model_name_lower = 'a'
       @class_name       = 'A'
-      
+
       @file_name.stub!(:gsub).and_return(@model_name_lower)
       @model_name_lower.stub!(:camelize).and_return(@class_name)
       Dir.stub(:[]).and_return([@file_name])
     end
-    
+
     it "should load the files by guessing the file name" do
       @class_name.should_receive(:constantize).and_return(true)
-      
+
       @config.load_models
     end
-    
+
     it "should not raise errors if the model name is nil" do
       @file_name.stub!(:gsub).and_return(nil)
-      
+
       lambda {
         @config.load_models
       }.should_not raise_error
     end
-    
+
     it "should not raise errors if the file name does not represent a class name" do
       @class_name.should_receive(:constantize).and_raise(NameError)
-      
+
       lambda {
         @config.load_models
       }.should_not raise_error
     end
-    
+
     it "should retry if the first pass fails and contains a directory" do
       @model_name_lower.stub!(:gsub!).and_return(true, nil)
       @class_name.stub(:constantize).and_raise(LoadError)
       @model_name_lower.should_receive(:camelize).twice
-      
+
       lambda {
         @config.load_models
       }.should_not raise_error
     end
-    
+
     it "should catch database errors with a warning" do
       @class_name.should_receive(:constantize).and_raise(Mysql::Error)
       @config.should_receive(:puts).with('Warning: Error loading a.rb')
-      
+
       lambda {
         @config.load_models
       }.should_not raise_error
     end
   end
-  
+
   it "should insert set index options into the configuration file" do
     config = ThinkingSphinx::Configuration.instance
     ThinkingSphinx::Configuration::IndexOptions.each do |option|
       config.index_options[option.to_sym] = "something"
       config.build
-      
+
       file = open(config.config_file) { |f| f.read }
       file.should match(/#{option}\s+= something/)
-      
+
       config.index_options[option.to_sym] = nil
     end
   end
-  
+
   it "should insert set source options into the configuration file" do
     config = ThinkingSphinx::Configuration.instance
     ThinkingSphinx::Configuration::SourceOptions.each do |option|
       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
     end
   end
-  
+
   it "should set any explicit prefixed or infixed fields" do
     file = open(ThinkingSphinx::Configuration.instance.config_file) { |f|
       f.read
     }
     file.should match(/prefix_fields\s+= city/)
-    file.should match(/infix_fields\s+= state/)    
+    file.should match(/infix_fields\s+= state/)
   end
-  
+
   it "should not have prefix fields in indexes where nothing is set" do
     file = open(ThinkingSphinx::Configuration.instance.config_file) { |f|
       f.read

data/spec/lib/thinking_sphinx/rails_additions_spec.rb

@@ -118,6 +118,18 @@ describe ThinkingSphinx::ActiveRecordStoreFullSTIClass do
   end
 end
 
+describe ThinkingSphinx::MetaClass do
+  describe 'metaclass' do
+    it "should exist as an instance method in Object" do
+      Object.new.should respond_to('metaclass')
+    end
+    
+    it "should return the meta/eigen/singleton class" do
+      Object.new.metaclass.should be_a(Class)
+    end
+  end
+end
+
 class TestModel
   @@squares = 89
   @@circles = 43

data/spec/lib/thinking_sphinx/search_spec.rb

@@ -50,6 +50,24 @@ describe ThinkingSphinx::Search do
         ThinkingSphinx::Search.new.foo
       }.should raise_error(NoMethodError)
     end
+    
+    it "should accept sphinx scopes" do
+      search = ThinkingSphinx::Search.new(:classes => [Alpha])
+      
+      lambda {
+        search.by_name('Pat')
+      }.should_not raise_error(NoMethodError)
+    end
+    
+    it "should return itself when using a sphinx scope" do
+      search = ThinkingSphinx::Search.new(:classes => [Alpha])
+      search.by_name('Pat').object_id.should == search.object_id
+    end
+    
+    it "should keep the same search object when chaining multiple scopes" do
+      search = ThinkingSphinx::Search.new(:classes => [Alpha])
+      search.by_name('Pat').ids_only.object_id.should == search.object_id
+    end
   end
   
   describe '.search' do
@@ -104,13 +122,16 @@ describe ThinkingSphinx::Search do
       @alpha_a, @alpha_b  = Alpha.new,  Alpha.new
       @beta_a, @beta_b    = Beta.new,   Beta.new
       
-      @alpha_a.stub!(:id => 1); @alpha_b.stub!(:id => 2)
-      @beta_a.stub!(:id => 1);  @beta_b.stub!(:id => 2)
+      @alpha_a.stub! :id => 1, :attributes => {'id' => 1}
+      @alpha_b.stub! :id => 2, :attributes => {'id' => 2}
+      @beta_a.stub!  :id => 1, :attributes => {'id' => 1}
+      @beta_b.stub!  :id => 2, :attributes => {'id' => 2}
+      
       @client.stub! :query => {
         :matches => minimal_result_hashes(@alpha_a, @beta_b, @alpha_b, @beta_a)
       }
-      Alpha.stub!(:find => [@alpha_a, @alpha_b])
-      Beta.stub!(:find => [@beta_a, @beta_b])
+      Alpha.stub! :find => [@alpha_a, @alpha_b]
+      Beta.stub!  :find => [@beta_a, @beta_b]
     end
     
     it "should issue only one select per model" do
@@ -740,7 +761,7 @@ describe ThinkingSphinx::Search do
   describe '.each_with_groupby_and_count' do
     before :each do
       @alpha = Alpha.new
-      @alpha.stub!(:id => 1)
+      @alpha.stub!(:id => 1, :attributes => {'id' => 1})
       
       @client.stub! :query => {
         :matches => [{
@@ -768,7 +789,7 @@ describe ThinkingSphinx::Search do
   describe '.each_with_weighting' do
     before :each do
       @alpha = Alpha.new
-      @alpha.stub!(:id => 1)
+      @alpha.stub!(:id => 1, :attributes => {'id' => 1})
       
       @client.stub! :query => {
         :matches => [{
@@ -793,7 +814,7 @@ describe ThinkingSphinx::Search do
   describe '.each_with_*' do
     before :each do
       @alpha = Alpha.new
-      @alpha.stub!(:id => 1)
+      @alpha.stub!(:id => 1, :attributes => {'id' => 1})
       
       @client.stub! :query => {
         :matches => [{
@@ -878,6 +899,47 @@ describe ThinkingSphinx::Search do
       @search.excerpt_for('string', Beta)
     end
   end
+  
+  describe '#search' do
+    before :each do
+      @search = ThinkingSphinx::Search.new('word',
+        :conditions => {:field  => 'field'},
+        :with       => {:int    => 5}
+      )
+    end
+    
+    it "should return itself" do
+      @search.search.object_id.should == @search.object_id
+    end
+    
+    it "should merge in arguments" do
+      @client.should_receive(:query) do |query, index, comments|
+        query.should == 'word more @field field'
+      end
+      
+      @search.search('more').first
+    end
+    
+    it "should merge conditions" do
+      @client.should_receive(:query) do |query, index, comments|
+        query.should match(/@name plato/)
+        query.should match(/@field field/)
+      end
+      
+      @search.search(:conditions => {:name => 'plato'}).first
+    end
+    
+    it "should merge filters" do
+      @search.search(:with => {:float => 1.5}).first
+      
+      @client.filters.detect { |filter|
+        filter.attribute == 'float'
+      }.should_not be_nil
+      @client.filters.detect { |filter|
+        filter.attribute == 'int'
+      }.should_not be_nil
+    end
+  end
 end
 
 describe ThinkingSphinx::Search, "playing nice with Search model" do

data/vendor/riddle/lib/riddle/controller.rb

@@ -4,7 +4,7 @@ module Riddle
       @configuration  = configuration
       @path           = path
     end
-    
+
     def index
       cmd = "indexer --config #{@path} --all"
       cmd << " --rotate" if running?
@@ -15,7 +15,8 @@ module Riddle
       return if running?
 
       cmd = "searchd --pidfile --config #{@path}"
-      `#{cmd}`    
+      cmd = "start /B #{cmd}" if RUBY_PLATFORM =~ /mswin/
+      `#{cmd}`
 
       sleep(1)
 
@@ -26,19 +27,24 @@ module Riddle
 
     def stop
       return unless running?
-      `kill #{pid}`
+      Process.kill('SIGTERM', pid.to_i)
+    rescue Errno::EINVAL
+      Process.kill('SIGKILL', pid.to_i)
     end
 
     def pid
-      if File.exists?("#{@configuration.searchd.pid_file}")
-        `cat #{@configuration.searchd.pid_file}`[/\d+/]
+      if File.exists?(@configuration.searchd.pid_file)
+        File.read(@configuration.searchd.pid_file)[/\d+/]
       else
         nil
       end
     end
 
     def running?
-      pid && `ps #{pid} | wc -l`.to_i > 1
+      !!pid && !!Process.kill(0, pid.to_i)
+    rescue
+      false
     end
+
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: freelancing-god-thinking-sphinx
 version: !ruby/object:Gem::Version 
-  version: 1.2.4
+  version: 1.2.5
 platform: ruby
 authors: 
 - Pat Allan
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-30 00:00:00 -07:00
+date: 2009-08-02 00:00:00 -07:00
 default_executable: 
 dependencies: []