jaikoo-thinking-sphinx 0.9.10

data/spec/unit/thinking_sphinx/search_spec.rb

@@ -0,0 +1,203 @@
+require 'spec/spec_helper'
+require 'will_paginate/collection'
+
+describe ThinkingSphinx::Search do
+  before :all do
+    @sphinx.setup_sphinx
+    @sphinx.start
+  end
+  
+  after :all do
+    @sphinx.stop
+  end
+  
+  describe "search_for_id method" do
+    before :each do
+      @client = Riddle::Client.stub_instance(
+        :filters    => [],
+        :filters=   => true,
+        :id_range=  => true,
+        :query      => {
+          :matches  => []
+        }
+      )
+      
+      ThinkingSphinx::Search.stub_methods(
+        :client_from_options => @client,
+        :search_conditions   => ["", []]
+      )
+    end
+    
+    it "should set the client id range to focus on the given id" do
+      ThinkingSphinx::Search.search_for_id 42, "an_index"
+      
+      @client.should have_received(:id_range=).with(42..42)
+    end
+    
+    it "should query on the given index" do
+      ThinkingSphinx::Search.search_for_id 42, "an_index"
+      
+      @client.should have_received(:query).with("", "an_index")
+    end
+    
+    it "should return true if a record is returned" do
+      @client.stub_method(:query => {
+        :matches => [24]
+      })
+      
+      ThinkingSphinx::Search.search_for_id(42, "an_index").should be_true
+    end
+    
+    it "should return false if no records are returned" do
+      ThinkingSphinx::Search.search_for_id(42, "an_index").should be_false
+    end
+  end
+  
+  describe "instance_from_result method" do
+    before :each do
+      Person.track_methods(:find)
+    end
+
+    it "should honour the :include option" do
+      ellie = ThinkingSphinx::Search.search("Ellie Ford", :include => :contacts).first
+      pending
+      Person.should have_received(:find).with(ellie.id, :include => :contacts, :select => nil)
+    end
+
+    it "should honour the :select option" do
+      ellie = ThinkingSphinx::Search.search("Ellie Ford", :select => "*").first
+      pending
+      Person.should have_received(:find).with(ellie.id, :include => nil, :select => "*")
+    end
+
+  end
+
+  describe "instances_from_results method" do
+    before :each do
+      Person.track_methods(:find)
+      
+      @ellie_ids = Person.search_for_ids "Ellie"
+    end
+    
+    it "should call a find on all ids for the class" do
+      Person.search "Ellie"
+      
+      Person.should have_received(:find).with(
+        :all,
+        :conditions => {:id => @ellie_ids},
+        :include    => nil,
+        :select     => nil
+      )
+    end
+
+    it "should honour the :include option" do
+      Person.search "Ellie", :include => :contacts
+      
+      Person.should have_received(:find).with(
+        :all,
+        :conditions => {:id => @ellie_ids},
+        :include    => :contacts,
+        :select     => nil
+      )
+    end
+
+    it "should honour the :select option" do
+      Person.search "Ellie", :select => "*"
+      
+      Person.should have_received(:find).with(
+        :all,
+        :conditions => {:id => @ellie_ids},
+        :include    => nil,
+        :select     => "*"
+      )
+    end
+  end
+  
+  describe "count method" do
+    before :each do
+      @client = Riddle::Client.stub_instance(
+        :filters    => [],
+        :filters=   => true,
+        :id_range=  => true,
+        :sort_mode  => :asc,
+        :limit      => 5,
+        :offset=    => 0,
+        :sort_mode= => true,
+        :query      => {
+          :matches  => [],
+          :total    => 50
+        }
+      )
+
+      ThinkingSphinx::Search.stub_methods(
+        :client_from_options => @client,
+        :search_conditions   => ["", []]
+      )
+    end
+
+    it "should return query total" do
+      ThinkingSphinx::Search.count(42, "an_index").should == 50
+    end
+  end
+  
+  describe "search result" do
+    before :each do
+      @results = ThinkingSphinx::Search.search "nothing will match this"
+    end
+    
+    it "should respond to previous_page" do
+      @results.should respond_to(:previous_page)
+    end
+    
+    it "should respond to next_page" do
+      @results.should respond_to(:next_page)
+    end
+    
+    it "should respond to current_page" do
+      @results.should respond_to(:current_page)
+    end
+    
+    it "should respond to total_pages" do
+      @results.should respond_to(:total_pages)
+    end
+    
+    it "should respond to total_entries" do
+      @results.should respond_to(:total_entries)
+    end
+    
+    it "should respond to offset" do
+      @results.should respond_to(:offset)
+    end
+        
+    it "should be a subclass of Array" do
+      @results.should be_kind_of(Array)
+    end
+  end
+  
+  it "should not return results that have been deleted" do
+    Alpha.search("one").should_not be_empty
+    
+    alpha = Alpha.find(:first, :conditions => {:name => "one"})
+    alpha.destroy
+    
+    Alpha.search("one").should be_empty
+  end
+  
+  it "should still return edited results using old data if there's no delta" do
+    Alpha.search("two").should_not be_empty
+    
+    alpha = Alpha.find(:first, :conditions => {:name => "two"})
+    alpha.update_attributes(:name => "twelve")
+    
+    Alpha.search("two").should_not be_empty
+  end
+  
+  it "should not return edited results using old data if there's a delta" do
+    Beta.search("two").should_not be_empty
+    
+    beta = Beta.find(:first, :conditions => {:name => "two"})
+    beta.update_attributes(:name => "twelve")
+    
+    Beta.search("two").should be_empty
+  end
+end

data/spec/unit/thinking_sphinx_spec.rb

@@ -0,0 +1,129 @@
+require 'spec/spec_helper'
+
+describe ThinkingSphinx do
+  describe "indexed_models methods" do
+    it "should contain all the names of models that have indexes" do
+      ThinkingSphinx.indexed_models.should include("Person")
+    end
+  end
+  
+  it "should define indexes by default" do
+    ThinkingSphinx.define_indexes?.should be_true
+  end
+  
+  it "should disable index definition" do
+    ThinkingSphinx.define_indexes = false
+    ThinkingSphinx.define_indexes?.should be_false
+  end
+  
+  it "should enable index definition" do
+    ThinkingSphinx.define_indexes = false
+    ThinkingSphinx.define_indexes?.should be_false
+    ThinkingSphinx.define_indexes = true
+    ThinkingSphinx.define_indexes?.should be_true
+  end
+  
+  it "should index deltas by default" do
+    ThinkingSphinx.deltas_enabled = nil
+    ThinkingSphinx.deltas_enabled?.should be_true
+  end
+  
+  it "should disable delta indexing" do
+    ThinkingSphinx.deltas_enabled = false
+    ThinkingSphinx.deltas_enabled?.should be_false
+  end
+  
+  it "should enable delta indexing" do
+    ThinkingSphinx.deltas_enabled = false
+    ThinkingSphinx.deltas_enabled?.should be_false
+    ThinkingSphinx.deltas_enabled = true
+    ThinkingSphinx.deltas_enabled?.should be_true
+  end
+  
+  it "should update indexes by default" do
+    ThinkingSphinx.updates_enabled = nil
+    ThinkingSphinx.updates_enabled?.should be_true
+  end
+  
+  it "should disable index updating" do
+    ThinkingSphinx.updates_enabled = false
+    ThinkingSphinx.updates_enabled?.should be_false
+  end
+  
+  it "should enable index updating" do
+    ThinkingSphinx.updates_enabled = false
+    ThinkingSphinx.updates_enabled?.should be_false
+    ThinkingSphinx.updates_enabled = true
+    ThinkingSphinx.updates_enabled?.should be_true
+  end
+  
+  describe "use_group_by_shortcut? method" do
+    after :each do
+      ::ActiveRecord::Base.connection.unstub_method(:select_all)
+    end
+    
+    it "should return true if no ONLY_FULL_GROUP_BY" do
+      ::ActiveRecord::Base.connection.stub_method(
+        :select_all => {:a => "OTHER SETTINGS"}
+      )
+      
+      ThinkingSphinx.use_group_by_shortcut?.should be_true
+    end
+  
+    it "should return true if NULL value" do
+      ::ActiveRecord::Base.connection.stub_method(
+        :select_all => {:a => nil}
+      )
+      
+      ThinkingSphinx.use_group_by_shortcut?.should be_true
+    end
+  
+    it "should return false if ONLY_FULL_GROUP_BY is set" do
+      ::ActiveRecord::Base.connection.stub_method(
+        :select_all => {:a => "OTHER SETTINGS,ONLY_FULL_GROUP_BY,blah"}
+      )
+      
+      ThinkingSphinx.use_group_by_shortcut?.should be_false
+    end
+    
+    it "should return false if ONLY_FULL_GROUP_BY is set in any of the values" do
+      ::ActiveRecord::Base.connection.stub_method(
+        :select_all => {
+          :a => "OTHER SETTINGS",
+          :b => "ONLY_FULL_GROUP_BY"
+        }
+      )
+      
+      ThinkingSphinx.use_group_by_shortcut?.should be_false
+    end
+    
+    describe "if not using MySQL" do
+      before :each do
+        unless ::ActiveRecord::ConnectionAdapters.const_defined?(:PostgreSQLAdapter)
+          pending "No PostgreSQL"
+          return
+        end
+        @connection = ::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.stub_instance(
+          :select_all => true
+        )
+        ::ActiveRecord::Base.stub_method(
+          :connection => @connection
+        )
+      end
+      
+      after :each do
+        ::ActiveRecord::Base.unstub_method(:connection)
+      end
+    
+      it "should return false" do
+        ThinkingSphinx.use_group_by_shortcut?.should be_false
+      end
+    
+      it "should not call select_all" do
+        ThinkingSphinx.use_group_by_shortcut?
+        
+        @connection.should_not have_received(:select_all)
+      end
+    end
+  end
+end

data/tasks/thinking_sphinx_tasks.rake

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), 'thinking_sphinx_tasks')

data/tasks/thinking_sphinx_tasks.rb

@@ -0,0 +1,100 @@
+require 'fileutils'
+
+namespace :thinking_sphinx do
+  task :app_env do
+    Rake::Task[:environment].invoke if defined?(RAILS_ROOT)
+    Rake::Task[:merb_env].invoke    if defined?(Merb)
+  end
+  
+  desc "Stop if running, then start a Sphinx searchd daemon using Thinking Sphinx's settings"
+  task :running_start => :app_env do
+   Rake::Task["thinking_sphinx:stop"].invoke if sphinx_running?
+   Rake::Task["thinking_sphinx:start"].invoke
+  end
+  
+  desc "Start a Sphinx searchd daemon using Thinking Sphinx's settings"
+  task :start => :app_env do
+    config = ThinkingSphinx::Configuration.instance
+    
+    FileUtils.mkdir_p config.searchd_file_path
+    raise RuntimeError, "searchd is already running." if sphinx_running?
+    
+    Dir["#{config.searchd_file_path}/*.spl"].each { |file| File.delete(file) }
+
+    cmd = "#{config.bin_path}searchd --config #{config.config_file}"
+    puts cmd
+    system cmd
+    
+    sleep(2)
+    
+    if sphinx_running?
+      puts "Started successfully (pid #{sphinx_pid})."
+    else
+      puts "Failed to start searchd daemon. Check #{config.searchd_log_file}."
+    end
+  end
+  
+  desc "Stop Sphinx using Thinking Sphinx's settings"
+  task :stop => :app_env do
+    raise RuntimeError, "searchd is not running." unless sphinx_running?
+    pid = sphinx_pid
+    system "kill #{pid}"
+    puts "Stopped search daemon (pid #{pid})."
+  end
+  
+  desc "Restart Sphinx"
+  task :restart => [:app_env, :stop, :start]
+  
+  desc "Generate the Sphinx configuration file using Thinking Sphinx's settings"
+  task :configure => :app_env do
+    config = ThinkingSphinx::Configuration.instance
+    puts "Generating Configuration to #{config.config_file}"
+    config.build
+  end
+  
+  desc "Index data for Sphinx using Thinking Sphinx's settings"
+  task :index => :app_env do
+    config = ThinkingSphinx::Configuration.instance
+    unless ENV["INDEX_ONLY"] == "true"
+      puts "Generating Configuration to #{config.config_file}"
+      config.build
+    end
+        
+    FileUtils.mkdir_p config.searchd_file_path
+    cmd = "#{config.bin_path}indexer --config #{config.config_file} --all"
+    cmd << " --rotate" if sphinx_running?
+    puts cmd
+    system cmd
+  end
+end
+
+namespace :ts do
+  desc "Stop if running, then start a Sphinx searchd daemon using Thinking Sphinx's settings"
+  task :run     => "thinking_sphinx:running_start"
+  desc "Start a Sphinx searchd daemon using Thinking Sphinx's settings"
+  task :start   => "thinking_sphinx:start"
+  desc "Stop Sphinx using Thinking Sphinx's settings"
+  task :stop    => "thinking_sphinx:stop"
+  desc "Index data for Sphinx using Thinking Sphinx's settings"
+  task :in      => "thinking_sphinx:index"
+  desc "Index data for Sphinx using Thinking Sphinx's settings"
+  task :index   => "thinking_sphinx:index"
+  desc "Restart Sphinx"
+  task :restart => "thinking_sphinx:restart"
+  desc "Generate the Sphinx configuration file using Thinking Sphinx's settings"
+  task :config  => "thinking_sphinx:configure"
+end
+
+def sphinx_pid
+  config = ThinkingSphinx::Configuration.instance
+  
+  if File.exists?(config.pid_file)
+    `cat #{config.pid_file}`[/\d+/]
+  else
+    nil
+  end
+end
+
+def sphinx_running?
+  sphinx_pid && `ps -p #{sphinx_pid} | wc -l`.to_i > 1
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification 
+name: jaikoo-thinking-sphinx
+version: !ruby/object:Gem::Version 
+  version: 0.9.10
+platform: ruby
+authors: 
+- Pat Allan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-10-18 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: A concise and easy-to-use Ruby library that connects ActiveRecord to the Sphinx search daemon, managing configuration, indexing and searching.
+email: pat@freelancing-gods.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/thinking_sphinx/active_record/delta.rb
+- lib/thinking_sphinx/active_record/has_many_association.rb
+- lib/thinking_sphinx/active_record/search.rb
+- lib/thinking_sphinx/active_record.rb
+- lib/thinking_sphinx/adapters/abstract_adapter.rb
+- lib/thinking_sphinx/adapters/mysql_adapter.rb
+- lib/thinking_sphinx/adapters/postgresql_adapter.rb
+- lib/thinking_sphinx/association.rb
+- lib/thinking_sphinx/attribute.rb
+- lib/thinking_sphinx/collection.rb
+- lib/thinking_sphinx/configuration.rb
+- lib/thinking_sphinx/field.rb
+- lib/thinking_sphinx/index/builder.rb
+- lib/thinking_sphinx/index/faux_column.rb
+- lib/thinking_sphinx/index.rb
+- lib/thinking_sphinx/rails_additions.rb
+- lib/thinking_sphinx/search.rb
+- lib/thinking_sphinx.rb
+- LICENCE
+- README
+- tasks/thinking_sphinx_tasks.rb
+- tasks/thinking_sphinx_tasks.rake
+- spec/unit/thinking_sphinx/active_record/delta_spec.rb
+- spec/unit/thinking_sphinx/active_record/has_many_association_spec.rb
+- spec/unit/thinking_sphinx/active_record/search_spec.rb
+- spec/unit/thinking_sphinx/active_record_spec.rb
+- spec/unit/thinking_sphinx/association_spec.rb
+- spec/unit/thinking_sphinx/attribute_spec.rb
+- spec/unit/thinking_sphinx/collection_spec.rb
+- spec/unit/thinking_sphinx/configuration_spec.rb
+- spec/unit/thinking_sphinx/field_spec.rb
+- spec/unit/thinking_sphinx/index/builder_spec.rb
+- spec/unit/thinking_sphinx/index/faux_column_spec.rb
+- spec/unit/thinking_sphinx/index_spec.rb
+- spec/unit/thinking_sphinx/search_spec.rb
+- spec/unit/thinking_sphinx_spec.rb
+has_rdoc: true
+homepage: http://ts.freelancing-gods.com
+post_install_message: 
+rdoc_options: 
+- --title
+- Thinking Sphinx -- Rails/Merb Sphinx Plugin
+- --line-numbers
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: thinking-sphinx
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A concise and easy-to-use Ruby library that connects ActiveRecord to the Sphinx search daemon, managing configuration, indexing and searching.
+test_files: 
+- spec/unit/thinking_sphinx/active_record/delta_spec.rb
+- spec/unit/thinking_sphinx/active_record/has_many_association_spec.rb
+- spec/unit/thinking_sphinx/active_record/search_spec.rb
+- spec/unit/thinking_sphinx/active_record_spec.rb
+- spec/unit/thinking_sphinx/association_spec.rb
+- spec/unit/thinking_sphinx/attribute_spec.rb
+- spec/unit/thinking_sphinx/collection_spec.rb
+- spec/unit/thinking_sphinx/configuration_spec.rb
+- spec/unit/thinking_sphinx/field_spec.rb
+- spec/unit/thinking_sphinx/index/builder_spec.rb
+- spec/unit/thinking_sphinx/index/faux_column_spec.rb
+- spec/unit/thinking_sphinx/index_spec.rb
+- spec/unit/thinking_sphinx/search_spec.rb
+- spec/unit/thinking_sphinx_spec.rb