thebes 0.0.3

data/.gitignore

@@ -0,0 +1,6 @@
+pkg/*
+*.gem
+.bundle
+spec/support/database.yml
+spec/support/test.sphinx.conf
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in thebes.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,84 @@
+PATH
+  remote: .
+  specs:
+    thebes (0.0.3)
+      actionpack (>= 3.0.3)
+      activerecord (>= 3.0.3)
+      mysql2
+      riddle
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionpack (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.13)
+      rack-test (~> 0.5.6)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.3)
+    arel (2.0.8)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    genspec (0.1.1)
+      rspec
+      sc-core-ext (>= 1.2.0)
+    i18n (0.5.0)
+    mocha (0.9.10)
+      rake
+    mysql2 (0.2.6)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    railties (3.0.3)
+      actionpack (= 3.0.3)
+      activesupport (= 3.0.3)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
+    rake (0.8.7)
+    riddle (1.2.2)
+    rspec (2.4.0)
+      rspec-core (~> 2.4.0)
+      rspec-expectations (~> 2.4.0)
+      rspec-mocks (~> 2.4.0)
+    rspec-core (2.4.0)
+    rspec-expectations (2.4.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.4.0)
+    rspec-rails (2.4.1)
+      actionpack (~> 3.0)
+      activesupport (~> 3.0)
+      railties (~> 3.0)
+      rspec (~> 2.4.0)
+    sc-core-ext (1.2.1)
+      activesupport (>= 2.3.5)
+    thor (0.14.6)
+    tzinfo (0.3.24)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  genspec
+  mocha
+  rspec
+  rspec-rails
+  thebes!

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2011 Iridesco LLC (support@harvestapp.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/Readme.mkd

@@ -0,0 +1,140 @@
+Thebes
+======
+
+Thebes is a thin binding layer for [Rails](http://rubyonrails.org/) and
+[Sphinx](http://sphinxsearch.com/) via [Riddle](https://github.com/freelancing-god/riddle)
+and [Mysql2](https://github.com/brianmario/mysql2). Thebes expects you to write
+Sphinx configuration files by hand and have a rich understanding of Sphinx, but
+provides configuration files and templates to ease the process.
+
+Installation
+------------
+
+To use Thebes, just add it to your `Gemfile`:
+
+    gem 'thebes'
+    
+    # Or pin Thebes to git
+    # gem 'thebes',
+    #   :git => 'git@github.com:harvesthq/thebes.git'
+
+Then use `bundle install` to update your `Gemfile.lock`.  If your project is using
+Rails, you can take advantage of the generator to create your starting config files:
+
+    script/rails g sphinx_config
+
+This will create the three config files that Thebes requires for easy setup:
+
+* `sphinx.yml` - Configuration values for your sphinx.conf files.
+* `sphinx.conf.erb` - The template for your sphinx.conf files.
+* `sphinx_servers.yml` - Configuration of Rails, which Sphinx servers to connect to.
+
+Flavor to taste, and run `rake thebes:build` to generate your sphinx configuation.
+
+Querying via Sphinx's custom protocol
+-------------------------------------
+
+Generate a query against Sphinx via Riddle:
+
+    result = Thebes::Query.run do |a|
+      # a here is an instance of Riddle::Client:
+      # http://rdoc.info/github/freelancing-god/riddle/master/Riddle/Client
+      a.apply_filter_like_in_riddle
+    end 
+
+`result` will be an instance of [Riddle::Response](http://rdoc.info/github/freelancing-god/riddle/master/Riddle/Client/Response).
+Usually you will want to call `.next` on it to get your returned values from
+Sphinx. A more complex usage example:
+
+    # sphinx_res is a raw result from Riddle.
+    #
+    sphinx_res = Thebes::Query.run do |q|
+      
+      # In Riddle, filters need to be added to a query before the
+      # actual query.
+      #
+      q.filters << Riddle::Client::Filter.new('active', [1])
+      
+      # Pull search terms of a query.
+      #
+      query = params[:search_terms].split(' ').collect {|word|
+        "( =#{word} | #{word} | #{word}* )"
+      }.join(' ')
+      
+      q.append_query query, 'documents' # Search index 'documents'.
+
+      # You can change the match_mode or alter the query in other
+      # ways.
+      #
+      # q.match_mode = :expr2
+    end
+
+    ids, weights = [], []
+    sphinx_res[0][:matches].each do |match|
+      ids << match[:attributes]['_id']
+      weights << match[:weight]
+    end
+
+    # Fetch documents from the database.
+    #
+    @documents = Document.find(ids)
+
+    # Sort documents by weight.
+    #
+    @documents.sort! {|a,b| weights[ids.index(b.id)] <=> weights[ids.index(a.id)] }
+
+Additionally, you can set procs to be run before the query block or right
+before the query is run:
+
+    # Usually found in config/initializers/thebes.rb
+    #
+    
+    # Before the Thebes::Query.run block.
+    #
+    Thebes::Query.before_query = Proc.new do |q|
+      q.match_mode = :any
+      q.max_matches = 10
+    end
+
+    # Just before the query is run.
+    #
+    Thebes::Query.before_running = Proc.new do |q|
+    end
+
+Querying via Sphinxql
+---------------------
+
+Thebes has minimal support for querying Sphinx via the new [Sphinxql syntax](http://sphinxsearch.com/docs/manual-0.9.9.html#sphinxql). 
+Running a query returns a [Mysql2::Result](http://rdoc.info/github/brianmario/mysql2/master/Mysql2/Result)
+object.
+
+    # Do a search with SphinxQL.
+    #
+    @results = Thebes::Sphinxql::Query.run "SELECT * FROM items WHERE MATCH('Horwitz')"
+
+    @ids = @results.collect {|r| r['_id'] }
+
+Deployment Strategy
+-------------------
+
+Always check `config/sphinx.conf.erb` into your SCM. The `config/sphinx.yml` and
+`config/sphinx_servers.yml` files probably should not be checked in, and any generated
+`config/sphinx.conf` files should likely not be checked in.
+
+Steps in a capistrano-style deployment:
+
+* Copy server-side `config/sphinx_servers.yml` and `config/sphinx.yml` files into place.
+* Run `rake thebes:build` to generate `config/sphinx.conf` or any other sphinx configuration files.
+* Restart searchd, run the indexer.
+
+If you want to use a cluster of Sphinx servers, several configuration files can
+be generated by modifying `config/sphinx.conf` to generate the proper configurations.
+Then update `config/sphinx_servers.yml` to tell your running Rails app where to
+find any new servers.
+
+Contributing
+------------
+
+Fork, clone, write a test, write some code, commit, push, send a pull request.  Github FTW!
+
+This project was open-sourced by [Harvest](http://getharvest.com/).  [We're hiring!](http://www.getharvest.com/careers)

data/lib/thebes.rb

@@ -0,0 +1,19 @@
+require 'active_record'
+require File.dirname(__FILE__)+'/thebes/config_writer'
+require File.dirname(__FILE__)+'/thebes/query'
+require File.dirname(__FILE__)+'/thebes/sphinx_search'
+require File.dirname(__FILE__)+'/thebes/sphinxql/client'
+require File.dirname(__FILE__)+'/thebes/sphinxql/query'
+require File.dirname(__FILE__)+'/thebes/railtie' if defined?(Rails::Railtie)
+
+module Thebes
+end
+
+require 'zlib'
+ActiveRecord::Base.class_eval do
+
+  def self.to_crc32
+    Zlib.crc32(self.name)
+  end
+
+end

data/lib/thebes/config_writer.rb

@@ -0,0 +1,29 @@
+require 'action_view'
+
+module Thebes
+
+  class ConfigWriter
+
+    def initialize template_path=nil, template_file=nil
+      @template_path = template_path || File.join(File.dirname(__FILE__), '..', '..', 'templates')
+      @template_file = template_file || 'sphinx.conf'
+    end
+    
+    def default_config_file
+      "./#{@@config_template}"
+    end
+
+    def build(outfile=nil, locals={})
+      outfile ||= default_config_file
+      view = ActionView::Base.new(
+        @template_path,
+        locals
+      )
+      File.open(outfile, 'w') do |file|
+        file.write view.render(:file => @template_file)
+      end
+    end
+
+  end
+
+end

data/lib/thebes/query.rb

@@ -0,0 +1,32 @@
+require 'riddle'
+
+module Thebes
+
+  class Query < Riddle::Client
+    cattr_accessor :before_query,
+                   :before_running,
+                   :servers
+
+    def initialize *args
+      if !args.empty? || self.class.servers.empty?
+        super *args
+      else
+        super *self.class.servers[rand(self.class.servers.size)]
+      end
+    end
+
+    class << self
+
+      def run &block
+        client = new # would take server and port
+        before_query.call(client) if before_query
+        block.call client
+        before_running.call(client) if before_running
+        client.run
+      end
+
+    end
+
+  end
+
+end

data/lib/thebes/railtie.rb

@@ -0,0 +1,33 @@
+require 'thebes'
+require 'rails'
+
+module Thebes
+
+  class Railtie < Rails::Railtie
+    
+    rake_tasks do
+      load "#{File.dirname(__FILE__)}/../../railties/thebes.rake"
+    end
+
+    generators do
+      load "#{File.dirname(__FILE__)}/../../railties/sphinx_config_generator.rb"
+    end
+
+    initializer "thebes.initialize" do |app|
+
+      config_file = File.join(Rails.root, 'config', 'sphinx_servers.yml')
+      if File.exists?(config_file)
+        config = YAML.load(ERB.new(IO.read(config_file)).result)[Rails.env.to_s]
+        if config['sphinx_api']
+          Thebes::Query.servers = config['sphinx_api']
+        end
+        if config['sphinxql']
+          Thebes::Sphinxql::Client.servers = config['sphinxql']
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/thebes/sphinx_search.rb

@@ -0,0 +1,152 @@
+#Due credit: large parts ripped out of thinking_sphinx - http://freelancing-god.github.com/ts/en/.
+
+module Thebes
+
+class SphinxSearch
+
+  attr_reader :results
+
+  def initialize options
+    @options = options
+    @client = Riddle::Client.new(*server)
+    @client.limit = options[:per_page] || 20
+    @client.offset = offset
+    @client.filters = filters
+    @client.field_weights = options[:field_weights] if options[:field_weights]
+    @client.index_weights = options[:index_weights] || {}
+    @client.sort_by = options[:sort_by] if options[:sort_by]
+    @client.match_mode = :extended
+  end
+
+  def search query
+    logger.info "Querying: '#{query}'"
+    @total_pages = nil
+    @results = { }
+    runtime = Benchmark.realtime {
+      @results = @client.query(format_query(query), indexes, '')
+    }
+    logger.error("Sphinx returned an error: #{@results[:error]}") if !@results[:error].blank?
+    logger.warn("Sphinx returned a warning: #{@results[:error]}") if !@results[:warning].blank?
+    logger.info "Found #{@results[:total_found]} results out of #{total_pages}"
+    logger.debug "Sphinx (#{sprintf("%f", runtime)}s)"
+    if @options[:ids_only]
+      @results[:matches].map{ |match|
+        match[:attributes]["sphinx_internal_id"]
+      }
+    else
+      instances_from_matches
+    end
+  end
+
+  def total_pages
+    return 0 if @results[:total].nil?
+    @total_pages ||= (@results[:total] / per_page.to_f).ceil
+  end
+
+  private
+
+  def server
+    Thebes::Query.servers[rand(Thebes::Query.servers.size)]
+  end
+
+  def format_query query
+    return query unless @options[:star]
+    @query ||= (@options[:star] ? star_query(query) : query).strip
+  end
+
+  def star_query(query)
+    token = @options[:star].is_a?(Regexp) ? @options[:star] : /\w+/u
+    query.gsub(/("#{token}(.*?#{token})?"|(?![!-])#{token})/u) do
+      pre, proper, post = $`, $&, $'
+      # E.g. "@foo", "/2", "~3", but not as part of a token
+      is_operator = pre.match(%r{(\W|^)[@~/]\Z})
+      # E.g. "foo bar", with quotes
+      is_quote    = proper.starts_with?('"') && proper.ends_with?('"')
+      has_star    = pre.ends_with?("*") || post.starts_with?("*")
+      if is_operator || is_quote || has_star
+        proper
+      else
+        "*#{proper}*"
+      end
+    end
+  end
+
+  def instances_from_matches
+    groups = results[:matches].group_by { |match| match[:attributes]["class_crc"] }
+    groups.each do |crc, group|
+      group.replace(instances_from_class(class_from_crc(crc), group))
+    end
+    results[:matches].collect do |match|
+      groups.detect { |crc, group|
+        crc == match[:attributes]["class_crc"]
+      }[1].compact.detect { |obj|
+        obj.id == match[:attributes]["sphinx_internal_id"]
+      }
+    end
+  end
+
+  def instances_from_class(klass, matches)
+    ids = matches.map { |match| match[:attributes]["sphinx_internal_id"] }
+    instances = ids.length > 0 ? klass.where(:id => ids) : []
+    ids.map { |obj_id| instances.detect { |obj| obj.id == obj_id } }
+  end
+
+
+  def indexes
+    if @options[:index]
+      return @options[:index]
+    end
+    @options[:classes].map { |t| ["_core", "_delta"].map { |sufix| "#{t.name.underscore}#{sufix}" }}.flatten.uniq.join(',')
+  end
+
+  def logger
+    Rails.logger
+  end
+
+  def current_page
+    @options[:page].blank? ? 1 : @options[:page].to_i
+  end
+
+  def offset
+    @options[:offset] || ((current_page - 1) * per_page)
+  end
+
+  def per_page
+    @options[:per_page] || 100
+  end
+
+  def filters
+    chain = [Riddle::Client::Filter.new('sphinx_deleted', [0])]
+    if @options[:with]
+      chain << @options[:with].map { |k, v| Riddle::Client::Filter.new(k, filter_value(v))}
+    end
+    unless @options[:classes]
+      raise "You'll need to explicitly pass in a list of AR classes to search as :classes"
+    end
+    chain << Riddle::Client::Filter.new('class_crc', @options[:classes].map(&:to_crc32))
+    chain.flatten
+  end
+
+  def class_from_crc(crc)
+    @options[:classes].detect { |klass| klass.to_crc32 == crc }
+  end
+
+  def filter_value(value)
+    case value
+    when Range
+      filter_value(value.first).first..filter_value(value.last).first
+    when Array
+      value.map { |v| filter_value(v) }.flatten
+    when Time
+      [value.to_i]
+    when NilClass
+      0
+    else
+      Array(value)
+    end
+  end
+
+
+end
+
+end

data/lib/thebes/sphinxql/client.rb

@@ -0,0 +1,19 @@
+require 'mysql2'
+
+module Thebes::Sphinxql
+  
+  class Client < ::Mysql2::Client
+
+    cattr_accessor :servers
+
+    def initialize *args
+      if !args.empty? || (!self.class.servers || self.class.servers.empty?)
+        super *args
+      else
+        super self.class.servers[rand(self.class.servers.size)]
+      end
+    end
+
+  end
+
+end

data/lib/thebes/sphinxql/query.rb

@@ -0,0 +1,35 @@
+module Thebes::Sphinxql
+  
+  class Query
+
+    def initialize query
+      @query = query
+      @client = Client.new
+    end
+
+    def run
+      @client.query self.to_sql
+    end
+
+    def to_sql
+      case @query
+      when String
+        @query
+      when Array
+        @query.shift % (@query.collect { |q|
+          @client.escape(q)
+        })
+      end
+    end
+
+    class << self
+
+      def run query
+        self.new(query).run
+      end
+
+    end
+
+  end
+
+end

data/lib/thebes/version.rb

@@ -0,0 +1,3 @@
+module Thebes
+  VERSION = "0.0.3"
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require 'thebes/railtie'

data/railties/sphinx_config_generator.rb

@@ -0,0 +1,13 @@
+require 'rails/generators'
+
+class SphinxConfigGenerator < Rails::Generators::Base
+
+  source_root "#{File.dirname(__FILE__)}/../templates/"
+  
+  def copy_config_defaults
+    copy_file 'sphinx.conf.erb', 'config/sphinx.conf.erb'
+    copy_file 'sphinx.yml', 'config/sphinx.yml'
+    copy_file 'sphinx_servers.yml', 'config/sphinx_servers.yml'
+  end
+
+end

data/railties/thebes.rake

@@ -0,0 +1,18 @@
+namespace :thebes do
+
+  desc "Build the sphinx config files"
+  task :build do
+    unless File.exists?(File.join(Rails.root, 'config', 'sphinx.yml'))
+      raise 'No config file present, please create a config/sphinx.yml'
+    end
+    config = YAML.load(ERB.new(IO.read(File.join(Rails.root, 'config', 'sphinx.yml'))).result)[Rails.env.to_s]
+    generator = Thebes::ConfigWriter.new(File.join(Rails.root, 'config'))
+    config.each do |file, conf|
+      if file[0].chr != '/'
+        file = File.join(Rails.root, 'config', file)
+      end
+      generator.build file, (conf || {})
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,83 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'thebes' # and any other gems you need
+
+FileUtils.mkdir_p 'tmp'
+
+Dir[File.join(File.dirname(__FILE__), 'support/**/*.rb')].each {|f| require f}
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+  config.use_transactional_fixtures = false
+  config.before :suite do
+
+    unless defined?(SPHINX)
+
+      # Fetch a database configuration.
+      #
+      db_config = YAML.load( ERB.new( IO.read(
+        File.join(File.dirname(__FILE__), 'support/database.yml')
+      ) ).result )['test']
+
+      # Write a sphinx configuation for test mode.
+      #
+      generator = Thebes::ConfigWriter.new \
+        File.join(File.dirname(__FILE__), 'support'),
+        'test.sphinx.conf'
+      generator.build \
+        File.join(File.dirname(__FILE__), 'support/test.sphinx.conf'),
+        db_config
+
+      # Give Riddle a dummy configuration so we can use it to
+      # control searchd.
+      #
+      r_config = Riddle::Configuration.new
+      r_config.searchd.pid_file = 'tmp/searchd.pid'
+      r_config.searchd.log = 'tmp/searchd.log'
+
+      # Create a Riddle controller.
+      #
+      SPHINX = Riddle::Controller.new \
+        r_config,
+        File.join(File.dirname(__FILE__), 'support/test.sphinx.conf')
+
+    end
+
+    # Build an initial index.
+    #
+    SPHINX.index
+
+    # Start searchd.
+    #
+    SPHINX.start
+
+    until SPHINX.running? do
+      sleep 0.1
+    end
+
+  end
+  config.after :each do
+    ActiveRecord::Base.connection.execute('SHOW TABLES;').each do |table|
+      # Or whatever you think is appropriate.
+      next if table.index('schema_migrations') or table.index('roles')
+      ActiveRecord::Base.connection.execute("TRUNCATE #{table}")
+    end
+  end
+  config.after :suite do
+
+    # Stop searchd after specs run.
+    #
+    SPHINX.stop
+
+    while SPHINX.running? do
+      sleep 0.1
+      SPHINX.stop
+    end
+
+  end
+end
+
+RSpec::Matchers.define :define_constant do |expected|
+  match { |actual| actual.const_defined?(expected) }
+end

data/spec/support/active_record.rb

@@ -0,0 +1,22 @@
+require 'active_record'
+require 'mysql2'
+require 'logger'
+require 'rspec/rails/adapters'
+require 'rspec/rails/fixture_support'
+
+ROOT = File.join(File.dirname(__FILE__), '..')
+
+ActiveRecord::Base.logger = Logger.new('tmp/ar_debug.log')
+ActiveRecord::Base.configurations = YAML::load(IO.read('spec/support/database.yml'))
+ActiveRecord::Base.establish_connection('test')
+
+ActiveRecord::Schema.define :version => 0 do
+  create_table :items, :force => true do |t|
+    t.string  :name
+    t.boolean :active
+    t.string  :body
+  end
+end
+
+class Item < ActiveRecord::Base
+end

data/spec/support/database.yml.example

@@ -0,0 +1,9 @@
+development:
+  adapter: mysql2
+  pool: 5
+  timeout: 5000
+  encoding: utf8
+  database: thebes_test
+  username: root
+  socket: /tmp/mysql.sock
+  password:

data/spec/support/test.sphinx.conf.erb

@@ -0,0 +1,70 @@
+indexer
+{
+  mem_limit = 32M
+}
+
+searchd
+{
+  listen = 0.0.0.0:9333
+  listen = 0.0.0.0:9334:mysql41
+  log = tmp/searchd.log
+  query_log = tmp/searchd.query.log
+  pid_file = tmp/searchd.pid
+}
+
+source items_core_0
+{
+  type = mysql
+  sql_host = <%= @host %>
+  sql_user = <%= @username %>
+  sql_pass = <%= @password %>
+  sql_db = <%= @database %>
+  sql_sock = <%= @socket %>
+  sql_query_pre = SET NAMES utf8
+  sql_query_pre = SET TIME_ZONE = '+0:00'
+  sql_query = SELECT SQL_NO_CACHE \
+      ( `items`.`id` * 66 + 0 ) AS `id`, \
+      `items`.`id` AS `_id`, \
+      `items`.`name` as `name`, \
+      `items`.`active` AS `active`, \
+      `items`.`body` AS `body` \
+    FROM `items` \
+    WHERE \
+      `items`.`id` >= $start AND \
+      `items`.`id` <= $end \
+    ORDER BY NULL
+  sql_query_range = SELECT IFNULL(MIN(`id`), 1), IFNULL(MAX(`id`), 1) FROM `items` 
+
+  sql_attr_uint = _id
+  sql_attr_uint = active
+
+  sql_query_info = SELECT * FROM `items` WHERE `id` = (($id - 0) / 66)
+}
+
+index items_core
+{
+  source = items_core_0
+  path = tmp/items_core
+  charset_type = utf-8
+
+  enable_star = 1
+  
+  min_prefix_len = 3
+  index_exact_words = 1
+
+  morphology = stem_en
+  # , libstemmer_sv
+  
+  min_stemming_len = 3
+  min_word_len = 2
+
+  # This expand_keywords declaration is not working.
+  #
+  # expand_keywords = 1
+}
+
+index items
+{
+  type = distributed
+  local = items_core
+}

data/spec/thebes/query_spec.rb

@@ -0,0 +1,98 @@
+require 'spec_helper'
+
+describe Thebes::Query, "after configuration" do
+
+  before(:all) {
+    Thebes::Query.servers = [['127.0.0.2', 111]]
+  }
+
+  subject { Thebes::Query.new }
+
+  its(:servers) { should == [['127.0.0.2', 111]] }
+
+  context "running query" do
+    
+    before(:each) {
+      Thebes::Query.any_instance.stubs(:run)
+    }
+
+    after(:each) {
+      Thebes::Query.run {|q| }
+    }
+
+    it "should run the query on an instance" do
+      Thebes::Query.any_instance.expects(:run)
+    end
+
+    it "should call the before_query callback" do
+      Thebes::Query.before_query = Proc.new {|q| }
+      Thebes::Query.before_query.expects(:call)
+    end
+
+    it "should call the before_running callback" do
+      Thebes::Query.before_running = Proc.new {|q| }
+      Thebes::Query.before_running.expects(:call)
+    end
+
+  end
+
+end
+
+describe Thebes::Query, "against live data" do
+
+  before {
+    Thebes::Query.servers = [['127.0.0.1', 9333]]
+    Item.create \
+      :name => "Larry",
+      :active => true,
+      :body => "Fine was born to a Jewish family as Louis Feinberg[1] in Philadelphia, Pennsylvania, at the corner of 3rd and South Streets. The building there is now a restaurant which is called Jon's Bar & Grill."
+    Item.create \
+      :name => "Moe",
+      :active => true,
+      :body => "Moses Horwitz was born in Brooklyn, New York, neighborhood of Brownsville, to Solomon Horwitz and Jennie Gorovitz. He was the fourth of the five Horwitz brothers and of Levite and Lithuanian Jewish ancestry."
+    Item.create \
+      :name => "Curly",
+      :active => false,
+      :body => "Curly Howard was born Jerome Lester Horwitz in Brownsville, a section of Brooklyn, New York. He was the fifth of the five Horwitz brothers and of Lithuanian Jewish ancestry."
+    Item.create \
+      :name => "Shemp",
+      :active => true,
+      :body => "Shemp, like his brothers Moe and Curly, was born in Brownsville, Brooklyn. He was the third of the five Horwitz brothers and of Levite[citation needed] and Lithuanian Jewish ancestry."
+    SPHINX.index # :verbose => true
+  }
+
+  context "searching for 'Horwitz'" do
+
+    before {
+      @result = Thebes::Query.run do |q|
+        q.append_query 'Horwitz', 'items'
+      end
+    }
+
+    subject { @result.first[:matches] }
+
+    its(:length) { should == 3 }
+    its(:first) { subject[:attributes]['_id'] == 2 }
+    its(:last) { subject[:attributes]['_id'] == 4 }
+
+  end
+
+  context "searching for 'Horwitz' with filter" do
+
+    before {
+      @result = Thebes::Query.run do |q|
+        q.filters << Riddle::Client::Filter.new('active', [1])
+        q.append_query 'Horwitz', 'items'
+      end
+    }
+
+    subject { @result.first[:matches] }
+
+    its(:length) { should == 2 }
+    its(:first) { subject[:attributes]['_id'] == 2 }
+    its(:last) { subject[:attributes]['_id'] == 4 }
+
+  end
+
+
+end

data/spec/thebes/sphinxql/client_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Thebes::Sphinxql::Client, "after configuration" do
+
+  before(:all) {
+    Thebes::Sphinxql::Client.servers = [
+      { :host => 'localhost', :port => 9009 }
+    ]
+  }
+
+  subject { Thebes::Sphinxql::Client.new }
+
+  its(:servers) { should == [{ :host => "localhost", :port => 9009 }] }
+
+end

data/spec/thebes/sphinxql/query_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe Thebes::Query, "against live data" do
+
+  before {
+    Thebes::Sphinxql::Client.servers = [
+      { :host => '127.0.0.1', :port => 9334 }
+    ]
+    Item.create \
+      :name => "Larry",
+      :active => true,
+      :body => "Fine was born to a Jewish family as Louis Feinberg[1] in Philadelphia, Pennsylvania, at the corner of 3rd and South Streets. The building there is now a restaurant which is called Jon's Bar & Grill."
+    Item.create \
+      :name => "Moe",
+      :active => true,
+      :body => "Moses Horwitz was born in Brooklyn, New York, neighborhood of Brownsville, to Solomon Horwitz and Jennie Gorovitz. He was the fourth of the five Horwitz brothers and of Levite and Lithuanian Jewish ancestry."
+    Item.create \
+      :name => "Curly",
+      :active => false,
+      :body => "Curly Howard was born Jerome Lester Horwitz in Brownsville, a section of Brooklyn, New York. He was the fifth of the five Horwitz brothers and of Lithuanian Jewish ancestry."
+    Item.create \
+      :name => "Shemp",
+      :active => true,
+      :body => "Shemp, like his brothers Moe and Curly, was born in Brownsville, Brooklyn. He was the third of the five Horwitz brothers and of Levite[citation needed] and Lithuanian Jewish ancestry."
+    SPHINX.index # :verbose => true
+  }
+
+  context "searching for 'Horwitz'" do
+
+    before {
+      @result = Thebes::Sphinxql::Query.run "SELECT * FROM items WHERE MATCH('Horwitz')"
+    }
+
+    subject { @result.collect {|r| r } }
+
+    its(:length) { should == 3 }
+    its(:first) { subject['_id'] == 2 }
+    its(:last) { subject['_id'] == 4 }
+
+  end
+
+  context "searching for 'Horwitz' with filter" do
+
+    before {
+      @result = Thebes::Sphinxql::Query.run "SELECT * FROM items WHERE MATCH('Horwitz') AND active = 1"
+    }
+
+    subject { @result.collect {|r| r } }
+
+    its(:length) { should == 2 }
+    its(:first) { subject['_id'] == 2 }
+    its(:last) { subject['_id'] == 4 }
+
+  end
+
+
+end

data/spec/thebes/version_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Thebes do
+
+  it { should define_constant(:VERSION) }
+
+end

data/templates/sphinx.conf.erb

@@ -0,0 +1,12 @@
+indexer
+{
+  mem_limit = <%= @mem_limit %>
+}
+
+searchd
+{
+  listen = 127.0.0.1:9312
+  log = <%= Rails.root %>/log/searchd.log
+  query_log = <%= Rails.root %>/searchd.query.log
+  pid_file = <%= Rails.root %>/searchd.<%= Rails.env.to_s %>.pid
+}

data/templates/sphinx.yml

@@ -0,0 +1,16 @@
+development: &defaults
+  'sphinx.conf':
+    mem_limit: '96M'
+
+production:
+  'sphinx.server1.conf':
+    mem_limit: '96M'
+  'sphinx.server2.conf':
+    mem_limit: '128M'
+
+staging:
+  <<: *defaults
+
+test:
+  <<: *defaults
+    

data/templates/sphinx_servers.yml

@@ -0,0 +1,16 @@
+development: &defaults
+  sphinx_api:
+    - [ localhost, 3312 ]
+  # sphinxql:
+  #   - 
+  #     :host: localhost
+  #     :port: 3313
+
+production:
+  <<: *defaults
+
+staging:
+  <<: *defaults
+
+test:
+  <<: *defaults

data/thebes.gemspec

@@ -0,0 +1,30 @@
+# -*- Mode:Ruby; encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "thebes/version"
+
+Gem::Specification.new do |s|
+  s.name        = "thebes"
+  s.version     = Thebes::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Matthew Beale"]
+  s.email       = ["matt.beale@madhatted.com"]
+  s.homepage    = "https://github.com/harvesthq/thebes"
+  s.summary     = %q{Thebes is a thin binding layer for Rails and Sphinx via Riddle and Mysql2.}
+  s.description = %q{Thebes is a thin binding layer for Rails and Sphinx via Riddle and Mysql2. Thebes expects you to write Sphinx configuration files by hand and have a rich understanding of Sphinx, but provides configuration files and templates to ease the process.}
+
+  s.add_dependency "riddle"
+  s.add_dependency "mysql2"
+  s.add_dependency "actionpack", ">= 3.0.3"
+  s.add_dependency "activerecord", ">= 3.0.3"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rspec-rails"
+  s.add_development_dependency "genspec"
+  s.add_development_dependency "mocha"
+
+  # s.rubyforge_project = "thebes"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,219 @@
+--- !ruby/object:Gem::Specification 
+name: thebes
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 3
+  version: 0.0.3
+platform: ruby
+authors: 
+- Matthew Beale
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-07 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: riddle
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mysql2
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 3
+        - 0
+        - 3
+        version: 3.0.3
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 3
+        - 0
+        - 3
+        version: 3.0.3
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rspec-rails
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: genspec
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id008
+description: Thebes is a thin binding layer for Rails and Sphinx via Riddle and Mysql2. Thebes expects you to write Sphinx configuration files by hand and have a rich understanding of Sphinx, but provides configuration files and templates to ease the process.
+email: 
+- matt.beale@madhatted.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- Rakefile
+- Readme.mkd
+- lib/thebes.rb
+- lib/thebes/config_writer.rb
+- lib/thebes/query.rb
+- lib/thebes/railtie.rb
+- lib/thebes/sphinx_search.rb
+- lib/thebes/sphinxql/client.rb
+- lib/thebes/sphinxql/query.rb
+- lib/thebes/version.rb
+- rails/init.rb
+- railties/sphinx_config_generator.rb
+- railties/thebes.rake
+- spec/spec_helper.rb
+- spec/support/active_record.rb
+- spec/support/database.yml.example
+- spec/support/test.sphinx.conf.erb
+- spec/thebes/query_spec.rb
+- spec/thebes/sphinxql/client_spec.rb
+- spec/thebes/sphinxql/query_spec.rb
+- spec/thebes/version_spec.rb
+- templates/sphinx.conf.erb
+- templates/sphinx.yml
+- templates/sphinx_servers.yml
+- thebes.gemspec
+has_rdoc: true
+homepage: https://github.com/harvesthq/thebes
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: Thebes is a thin binding layer for Rails and Sphinx via Riddle and Mysql2.
+test_files: 
+- spec/spec_helper.rb
+- spec/support/active_record.rb
+- spec/support/database.yml.example
+- spec/support/test.sphinx.conf.erb
+- spec/thebes/query_spec.rb
+- spec/thebes/sphinxql/client_spec.rb
+- spec/thebes/sphinxql/query_spec.rb
+- spec/thebes/version_spec.rb