sphinx 0.9.9.2117 → 0.9.10

data/.gitignore

@@ -1,4 +1,2 @@
-rdoc
 doc
-.yardoc
-pkg
+pkg

data/README.rdoc

@@ -1,10 +1,10 @@
-= Sphinx Client API
+=Sphinx Client API 0.9.10
 
-This document gives an overview of what is Sphinx itself and how to use it 
-from your Ruby on Rails application. For more information or documentation, 
+This document gives an overview of what is Sphinx itself and how to use in 
+within Ruby on Rails. For more information or documentation, 
 please go to http://www.sphinxsearch.com
 
-== Sphinx
+==Sphinx
 
 Sphinx is a standalone full-text search engine, meant to provide fast, 
 size-efficient and relevant fulltext search functions to other applications. 
@@ -12,232 +12,37 @@ Sphinx was specially designed to integrate well with SQL databases and
 scripting languages. Currently built-in data sources support fetching data 
 either via direct connection to MySQL, or from an XML pipe.
  
-Simplest way to communicate with Sphinx is to use <tt>searchd</tt> —
-a daemon to search through full text indexes from external software.
+Simplest way to communicate with Sphinx is to use <tt>searchd</tt> -
+a daemon to search through fulltext indices from external software.
 
-== Installation
+==Compatibility
 
-There are two options when approaching sphinx plugin installation:
+This version supports all API features of Sphinx 0.9.10-r2043. Full compatibility list:
 
-* using the gem (recommended)
-* install as a Rails plugin
+* <tt>0.9.10</tt> — Sphinx 0.9.10-r2043
+* <tt>0.9.9</tt> — Sphinx 0.9.9-r1299
 
-To install as a gem, add this to your environment.rb:
+==Documentation
 
-  config.gem 'sphinx', :source => 'http://gemcutter.org'
+You can create the documentation by running:
 
-And then run the command:
+	rake rdoc
 
-  sudo rake gems:install
+==Latest version
 
-To install Sphinx as a Rails plugin use this:
-
-  script/plugin install git://github.com/kpumuk/sphinx.git
-
-== Documentation
-
-Complete Sphinx plugin documentation could be found here:
-http://kpumuk.github.com/sphinx
-
-Also you can find documentation on rdoc.info:
-http://rdoc.info/projects/kpumuk/sphinx
-
-You can build the documentation locally by running:
-
-  rake yard
-
-Please note: you should have yard gem installed on your system:
-
-  sudo gem install yard --source http://gemcutter.org
-
-Complete Sphinx API documentation could be found on Sphinx Search Engine
-site: http://www.sphinxsearch.com/docs/current.html
-This plugin is fully compatible with original PHP API implementation.
-
-== Ruby naming conventions
-
-Sphinx Client API supports Ruby naming conventions, so every API
-method name is in underscored, lowercase form:
-
-  SetServer    -> set_server
-  RunQueries   -> run_queries
-  SetMatchMode -> set_match_mode
-
-Every method is aliased to a corresponding one from standard Sphinx
-API, so you can use both <tt>SetServer</tt> and <tt>set_server</tt>
-with no differrence.
-
-There are three exceptions to this naming rule:
-
-  GetLastError   -> last_error
-  GetLastWarning -> last_warning
-  IsConnectError -> connect_error?
-
-Of course, all of them are aliased to the original method names.
-
-== Using multiple Sphinx servers
-
-Since we actively use this plugin in our Scribd development workflow,
-there are several methods have been added to accommodate our needs.
-You can find documentation on Ruby-specific methods in documentation:
-http://rdoc.info/projects/kpumuk/sphinx
-
-First of all, we added support of multiple Sphinx servers to balance
-load between them. Also it means that in case of any problems with one
-of servers, library will try to fetch the results from another one.
-Every consequence request will be executed on the next server in list
-(round-robin technique).
-
-  sphinx.set_servers([
-    { :host => 'browse01.local', :port => 3312 },
-    { :host => 'browse02.local', :port => 3312 },
-    { :host => 'browse03.local', :port => 3312 }
-  ])
-
-By default library will try to fetch results from a single server, and
-fail if it does not respond. To setup number of retries being performed,
-you can use second (additional) parameter of the <tt>set_connect_timeout</tt>
-and <tt>set_request_timeout</tt> methods:
-
-  sphinx.set_connect_timeout(1, 3)
-  sphinx.set_request_timeout(1, 3)
-
-There is a big difference between these two methods. First will affect
-only on requests experiencing problems with connection (socket error,
-pipe error, etc), second will be used when request is broken somehow
-(temporary searchd error, incomplete reply, etc). The workflow looks like
-this:
-
-1. Increase retries number. If is less or equal to configured value,
-   try to connect to the next server. Otherwise, raise an error.
-2. In case of connection problem go to 1.
-3. Increase request retries number. If it less or equal to configured
-   value, try to perform request. Otherwise, raise an error.
-4. In case of connection problem go to 1.
-5. In case of request problem, go to 3.
-6. Parse and return response.
-
-Withdrawals:
-
-1. Request could be performed <tt>connect_retries</tt> * <tt>request_retries</tt>
-   times. E.g., it could be tried <tt>request_retries</tt> times on each
-   of <tt>connect_retries</tt> servers (when you have 1 server configured,
-   but <tt>connect_retries</tt> is 5, library will try to connect to this
-   server 5 times).
-2. Request could be tried to execute on each server <tt>1..request_retries</tt>
-   times. In case of connection problem, request will be moved to another
-   server immediately.
-
-Usually you will set <tt>connect_retries</tt> equal to servers number,
-so you will be sure each failing request will be performed on all servers.
-This means that if one of servers is live, but others are dead, you request
-will be finally executed successfully.
-
-== Sphinx constants
-
-Most Sphinx API methods expecting for special constants will be passed.
-For example:
-
-  sphinx.set_match_mode(Sphinx::SPH_MATCH_ANY)
-
-Please note that these constants defined in a <tt>Sphinx</tt>
-module. You can use symbols or strings instead of these awful
-constants:
-
-  sphinx.set_match_mode(:any)
-  sphinx.set_match_mode('any')
-
-== Setting query filters
-
-Every <tt>set_</tt> method returns <tt>Sphinx::Client</tt> object itself.
-It means that you can chain filtering methods:
-
-  results = Sphinx::Client.new.
-              set_match_mode(:any).
-              set_ranking_mode(:bm25).
-              set_id_range(10, 1000).
-              query('test')
-
-There is a handful ability to set query parameters directly in <tt>query</tt>
-call. If block does not accept any parameters, it will be eval'ed inside
-Sphinx::Client instance:
-
-  results = Sphinx::Client.new.query('test') do
-    match_mode :any
-    ranking_mode :bm25
-    id_range 10, 1000
-  end
-
-As you can see, in this case you can omit the <tt>set_</tt> prefix for
-this methods. If block accepts a parameter, sphinx instance will be
-passed into the block. In this case you should you full method names
-including the <tt>set_</tt> prefix:
-
-  results = Sphinx::Client.new.query('test') do |sphinx|
-    sphinx.set_match_mode :any
-    sphinx.set_ranking_mode :bm25
-    sphinx.set_id_range 10, 1000
-  end
-
-== Example
-
-This simple example illustrates base connection establishing,
-search results retrieving, and excerpts building. Please note
-how does it perform database select using ActiveRecord to
-save the order of records established by Sphinx.
-
-  sphinx = Sphinx::Client.new
-  result = sphinx.query('test')
-  ids = result['matches'].map { |match| match['id'] }
-  posts = Post.all :conditions => { :id => ids },
-                   :order => "FIELD(id,#{ids.join(',')})"
-
-  docs = posts.map(&:body)
-  excerpts = sphinx.build_excerpts(docs, 'index', 'test')
-
-== Logging
-
-You can ask Sphinx client API to log it's activity to some log. In
-order to do that you can pass a logger object into the <tt>Sphinx::Client</tt>
-constructor:
-
-  require 'logger'
-  Sphinx::Client.new(Logger.new(STDOUT)).query('test')
-
-Logger object should respond to methods :debug, :info, and :warn, and
-accept blocks (this is what standard Ruby <tt>Logger</tt> class does).
-Here is what you will see in your log:
-
-* <tt>DEBUG</tt> -- <tt>query</tt>, <tt>add_query</tt>, <tt>run_queries</tt>
-  method calls with configured filters.
-* <tt>INFO</tt> -- initialization with Sphinx version, servers change,
-  attempts to re-connect, and all attempts to do an API call with server
-  where request being performed.
-* <tt>WARN</tt> -- various connection and socket errors.
-
-== Support
-
-Source code:
-http://github.com/kpumuk/sphinx
-
-To suggest a feature or report a bug:
-http://github.com/kpumuk/sphinx/issues
-
-Project home page:
+You can always get latest version from
 http://kpumuk.info/projects/ror-plugins/sphinx
 
-== Credits
+==Credits
 
 Dmytro Shteflyuk <kpumuk@kpumuk.info> http://kpumuk.info
 
-Andrew Aksyonoff http://sphinxsearch.com
+Andrew Aksyonoff http://sphinxsearch.com/
 
 Special thanks to Alexey Kovyrin <alexey@kovyrin.net> http://blog.kovyrin.net
 
-Special thanks to Mike Perham http://www.mikeperham.com for his awesome
-memcache-client gem, where latest Sphinx gem got new sockets handling from.
-
 ==License
 
 This library is distributed under the terms of the Ruby license.
 You can freely distribute/modify this library.
+

data/Rakefile

@@ -1,4 +1,6 @@
 require 'rake'
+require 'spec/rake/spectask'
+require 'rake/rdoctask'
 
 begin
   require 'jeweler'
@@ -15,31 +17,20 @@ rescue LoadError
   puts 'Jeweler not available. Install it with: sudo gem install jeweler'
 end
 
-begin
-  require 'spec/rake/spectask'
-
-  desc 'Default: run specs'
-  task :default => :spec
+desc 'Default: run specs'
+task :default => :spec
 
-  desc 'Test the sphinx plugin'
-  Spec::Rake::SpecTask.new do |t|
-    t.libs << 'lib'
-    t.pattern = 'spec/*_spec.rb'
-  end
-rescue LoadError
-  puts 'RSpec not available. Install it with: sudo gem install rspec'
+desc 'Test the sphinx plugin'
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.libs << 'lib'
+  t.pattern = 'spec/*_spec.rb'
 end
 
-begin
-  require 'yard'
-  YARD::Rake::YardocTask.new(:yard) do |t|
-    t.options = ['--title', 'Sphinx Client API Documentation']
-    if ENV['PRIVATE']
-      t.options.concat ['--protected', '--private']
-    else
-      t.options << '--no-private' 
-    end
-  end
-rescue LoadError
-  puts 'Yard not available. Install it with: sudo gem install yard'
+desc 'Generate documentation for the sphinx plugin'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Sphinx Client API'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
 end

data/VERSION.yml

@@ -1,5 +1,4 @@
 --- 
 :major: 0
 :minor: 9
-:patch: 9
-:build: 2117
+:patch: 10

data/install.rb

@@ -0,0 +1,5 @@
+require 'fileutils'
+
+sphinx_config = File.dirname(__FILE__) + '/../../../config/sphinx.yml'
+FileUtils.cp File.dirname(__FILE__) + '/sphinx.yml.tpl', sphinx_config unless File.exist?(sphinx_config)
+puts IO.read(File.join(File.dirname(__FILE__), 'README'))