Sphincter 1.0.0 → 1.1.0

data/History.txt

@@ -1,5 +1,15 @@
+== 1.1.0 / 2007-08-13
+
+* 2 major enhancements:
+  * Fields across relationships may be included via add_index.
+  * Sphincter now automatically configures Dmytro Shteflyuk's sphinx API.  Run
+    `rake sphincter:setup_sphinx` and check in vendor/plugins/sphinx.
+* 1 bug fix:
+  * `rake sphincter:index` task didn't correctly run reindex.  Bug submitted
+    by Lee O'Mara.
+
 == 1.0.0 / 2007-07-26
 
-* 1 major enhancement
+* 1 major enhancement:
   * Birthday!
 

data/README.txt

@@ -4,6 +4,10 @@ Eric Hodel <drbrain@segment7.net>
 
 http://seattlerb.org/Sphincter
 
+File bugs:
+
+http://rubyforge.org/tracker/?func=add&group_id=1513&atid=5921
+
 Sphincter was named by David Yeu.
 
 == DESCRIPTION:
@@ -41,22 +45,24 @@ For complete documentation:
 
 Download and install Sphinx from http://www.sphinxsearch.com/downloads.html
 
-Download Sphinx Ruby API from http://rubyforge.org/frs/?group_id=2604&release_id=11049
-
-Unpack Sphinx Ruby API into vendor/plugins/.
-
 Install Sphincter:
 
   $ gem install Sphincter
 
+Load Sphincter tasks in Rakefile:
+
+  require 'sphincter/tasks'
+
+Setup the Dmytro Shteflyuk's Sphinx client:
+
+  $ rake sphincter:setup_sphinx
+
+Add vendor/plugins/sphinx to your SCM system.
+
 Load Sphincter in config/environment.rb:
 
   require 'sphincter'
 
-By default, Sphincter will run searchd on the same port for all
-environments.  See Sphincter::Configure for how to configure different
-environments to use different ports.
-
 Add indexes to models:
 
   class Post < ActiveRecord::Base
@@ -74,12 +80,25 @@ Add searching UI:
     end
   end
 
+  <ol>
+  <% @results.records.each do |post| -%>
+    <li>
+      <div><%= link_to post.title, post_path(post) %></div>
+      <div><%= truncate post.body, 250 %></div>
+    </li>
+  <% end -%>
+  </ol>
+
 Start searchd:
 
   $ rake sphincter:start_searchd
 
 Then test it out in your browser.
 
+NOTE:  By default, Sphincter will run searchd on the same port for all
+environments.  See Sphincter::Configure for how to configure different
+environments to use different ports.
+
 == TESTING QUICK-START:
 
 See Sphinx::SearchStub.
@@ -92,33 +111,35 @@ Example ActiveRecord model:
 
   class Post < ActiveRecord::Base
     belongs_to :blog
+    belongs_to :user
   
     # published is a boolean and title and body are string or text fields
+    # user.name is automatically fetched via the user association
     add_index :fields => %w[title body published]
   end
-  
+
 Simple search:
 
   Post.search 'words'
-  
+
 Only search published posts:
 
   Post.search 'words', :conditions => { :published => 1 }
-  
+
 Only search posts created in the last week:
 
   now = Time.now
   ago = now - 1.weeks
   Post.search 'words', :between => { :created_on => [ago, now] }
-  
+
 Pagination (defaults to ten records/page):
 
   Post.search 'words', :page => 2
-  
+
 Pagination with custom page size:
 
   Post.search 'words', :page => 2, :per_page => 20
-  
+
 Pagination with custom page size (better):
 
 Add to config/sphincter.yml:

data/Rakefile

@@ -9,8 +9,8 @@ Hoe.new('Sphincter', Sphincter::VERSION) do |p|
   p.rubyforge_name = 'seattlerb'
   p.author = 'Eric Hodel'
   p.email = 'drbrain@segment7.net'
-  p.summary = p.paragraphs_of('README.txt', 5).first
-  p.description = p.paragraphs_of('README.txt', 6).first
+  p.summary = p.paragraphs_of('README.txt', 7).first
+  p.description = p.paragraphs_of('README.txt', 8).first
   p.url = p.paragraphs_of('README.txt', 2).first
   p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
 

data/lib/sphincter.rb

@@ -92,7 +92,12 @@ module Sphincter
   ##
   # This is the version of Sphincter you are using.
 
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
+
+  ##
+  # Sphincter error base class.
+
+  class Error < RuntimeError; end
 
 end
 

data/lib/sphincter/configure.rb

@@ -50,6 +50,175 @@ require 'sphincter'
 
 module Sphincter::Configure
 
+  ##
+  # A class for building sphinx.conf source/index sections.
+
+  class Index
+
+    attr_reader :source_conf
+
+    attr_reader :name
+
+    ##
+    # Creates a new Index for +klass+ and +options+.
+
+    def initialize(klass, options)
+      @fields = []
+      @where = []
+      @group = false
+
+      @source_conf = {}
+      @source_conf['sql_date_column'] = []
+      @source_conf['sql_group_column'] = %w[sphincter_index_id]
+
+      @klass = klass
+      @table = @klass.table_name
+      @conn = @klass.connection
+      @tables = @table.dup
+
+      defaults = {
+        :conditions => [],
+        :fields => [],
+        :name => @table,
+      }
+
+      @options = defaults.merge options
+
+      @name = @options[:name] || @table
+    end
+
+    ##
+    # Adds plain field +field+ to the index from class +klass+ using
+    # +as_table+ as the table name.
+
+    def add_field(field, klass = @klass, as_table = nil)
+      table = klass.table_name
+      quoted_field = @conn.quote_column_name field
+
+      column_type = klass.columns_hash[field].type
+      expr = case column_type
+             when :date, :datetime, :time, :timestamp then
+               @source_conf['sql_date_column'] << field
+               "UNIX_TIMESTAMP(#{table}.#{quoted_field})"
+             when :boolean, :integer then
+               @source_conf['sql_group_column'] << field
+               "#{table}.#{quoted_field}"
+             when :string, :text then
+               "#{table}.#{quoted_field}"
+             else
+               raise Sphincter::Error, "unknown column type #{column_type}"
+             end
+
+      as_name = [as_table, field].compact.join '_'
+      as_name = @conn.quote_column_name as_name
+
+    "#{expr} AS #{as_name}"
+    end
+
+    ##
+    # Includes field +as_field+ from association +as_name+ in the index.
+
+    def add_include(as_name, as_field)
+      as_assoc = @klass.reflect_on_all_associations.find do |assoc|
+        assoc.name == as_name.intern
+      end
+
+      if as_assoc.nil? then
+        raise Sphincter::Error,
+            "could not find association \"#{as_name}\" in #{@klass.name}"
+      end
+
+      as_klass = as_assoc.class_name.constantize
+      as_table = as_klass.table_name
+
+      as_klass_key = @conn.quote_column_name as_klass.primary_key.to_s
+      as_assoc_key = @conn.quote_column_name as_assoc.primary_key_name.to_s
+
+      case as_assoc.macro
+      when :belongs_to then
+        @fields << add_field(as_field, as_klass, as_table)
+        @tables << " LEFT JOIN #{as_table} ON" \
+                   " #{@table}.#{as_assoc_key} = #{as_table}.#{as_klass_key}"
+
+      when :has_many then
+        if as_assoc.options.include? :through then
+          raise Sphincter::Error,
+                "unsupported macro has_many :through for \"#{as_name}\" " \
+                "in #{klass.name}.add_index"
+        end
+
+        as_pkey = @conn.quote_column_name as_klass.primary_key.to_s
+        as_fkey = @conn.quote_column_name as_assoc.primary_key_name.to_s
+
+        as_name = [as_table, as_field].compact.join '_'
+        as_name = @conn.quote_column_name as_name
+
+        field = @conn.quote_column_name as_field
+
+        @fields << "GROUP_CONCAT(#{as_table}.#{field} SEPARATOR ' ') AS #{as_name}"
+
+        if as_assoc.options.include? :as then
+          poly_name = as_assoc.options[:as]
+          id_col = @conn.quote_column_name "#{poly_name}_id"
+          type_col = @conn.quote_column_name "#{poly_name}_type"
+
+          @tables << " LEFT JOIN #{as_table} ON"\
+                     " #{@table}.#{as_klass_key} = #{as_table}.#{id_col} AND" \
+                     " #{@conn.quote @klass.name} = #{as_table}.#{type_col}"
+        else
+          @tables << " LEFT JOIN #{as_table} ON" \
+                     " #{@table}.#{as_klass_key} = #{as_table}.#{as_assoc_key}"
+        end
+
+        @group = true
+      else
+        raise Sphincter::Error,
+              "unsupported macro #{as_assoc.macro} for \"#{as_name}\" " \
+              "in #{klass.name}.add_index"
+      end
+    end
+
+    def configure
+      conn = @klass.connection
+      pk = conn.quote_column_name @klass.primary_key
+      index_id = @options[:index_id]
+
+      index_count = Sphincter::Configure.index_count
+
+      @fields << "(#{@table}.#{pk} * #{index_count} + #{index_id}) AS #{pk}"
+      @fields << "#{index_id} AS sphincter_index_id"
+      @fields << "'#{@klass.name}' AS sphincter_klass"
+
+      @options[:fields].each do |field|
+        case field
+        when /\./ then add_include(*field.split('.', 2))
+        else           @fields << add_field(field)
+        end
+      end
+
+      @fields = @fields.join ', '
+
+      @where << "#{@table}.#{pk} >= $start"
+      @where << "#{@table}.#{pk} <= $end"
+      @where.push(*@options[:conditions])
+      @where = @where.compact.join ' AND '
+
+      query = "SELECT #{@fields} FROM #{@tables} WHERE #{@where}"
+      query << " GROUP BY #{@table}.#{pk}" if @group
+
+      @source_conf['sql_query'] = query
+      @source_conf['sql_query_info'] =
+        "SELECT * FROM #{@table} " \
+          "WHERE #{@table}.#{pk} = (($id - #{index_id}) / #{index_count})"
+      @source_conf['sql_query_range'] =
+        "SELECT MIN(#{pk}), MAX(#{pk}) FROM #{@table}"
+      @source_conf['strip_html'] = @options[:strip_html] ? 1 : 0
+
+      @source_conf
+    end
+
+  end
+
   @env_conf = nil
   @index_count = nil
 
@@ -80,7 +249,6 @@ module Sphincter::Configure
 
     'mysql' => {
       'sql_query_pre' => [
-        'SET SESSION group_concat_max_len = 65535',
         'SET NAMES utf8',
       ],
     },
@@ -179,42 +347,10 @@ module Sphincter::Configure
 
     indexes.each do |klass, model_indexes|
       model_indexes.each do |options|
-        conn = klass.connection
-        table = klass.table_name
-        pk = conn.quote_column_name klass.primary_key
-        index_id = options[:index_id]
-
-        source_conf = {}
-        source_conf['sql_date_column'] = []
-        source_conf['sql_group_column'] = %w[sphincter_index_id]
-
-        fields = []
-        fields << "(#{table}.#{pk} * #{index_count} + #{index_id}) AS #{pk}"
-        fields << "#{index_id} AS sphincter_index_id"
-        fields << "#{conn.quote table} AS klass"
-
-        options[:fields].each do |field|
-          fields << get_sources_field(source_conf, klass, field)
-        end
-
-        fields = fields.join ', '
-
-        where = []
-        where << "#{table}.#{pk} >= $start AND #{table}.#{pk} <= $end"
-        where << options[:conditions]
-        where = where.compact.join ' AND '
-
-        source_conf['sql_query'] =
-          "SELECT #{fields} FROM #{table} WHERE #{where}"
-        source_conf['sql_query_info'] =
-          "SELECT * FROM #{table} " \
-            "WHERE #{table}.#{pk} = (($id - #{index_id}) / #{index_count})"
-        source_conf['sql_query_range'] =
-          "SELECT MIN(#{pk}), MAX(#{pk}) FROM #{table}"
-        source_conf['strip_html'] = options[:strip_html] ? 1 : 0
+        index = Index.new klass, options
+        index.configure
 
-        name = options[:name] || table
-        sources[name] = source_conf
+        sources[index.name] = index.source_conf
       end
     end
 
@@ -227,23 +363,6 @@ module Sphincter::Configure
   # get_sources_field only understands :datetime, :boolean, :integer, :string
   # and :text column types.
 
-  def self.get_sources_field(source_conf, klass, field)
-    conn = klass.connection
-    table = klass.table_name
-
-    quoted_field = conn.quote_column_name field
-    case klass.columns_hash[field].type
-    when :date, :datetime, :time, :timestamp then
-      source_conf['sql_date_column'] << field
-      "UNIX_TIMESTAMP(#{table}.#{quoted_field}) AS #{quoted_field}"
-    when :boolean, :integer then
-      source_conf['sql_group_column'] << field
-      "#{table}.#{quoted_field} AS #{quoted_field}"
-    when :string, :text then
-      "#{table}.#{quoted_field} AS #{quoted_field}"
-    end
-  end
-
   ##
   # Retrieves the database configuration for ActiveRecord::Base and adapts it
   # for a sphinx.conf file.

data/lib/sphincter/search.rb

@@ -44,10 +44,33 @@ module Sphincter::Search
   # Options are:
   #
   # :name:: Name of index.  Defaults to ActiveRecord::Base::table_name.
-  # :fields:: Fields to index.  Columns from belongs_to associations are
-  #           automatically added.
-  # :conditions:: Hash of SQL conditions that predicate inclusion in the
-  #               search index.
+  # :fields:: Array of fields to index.  Foreign key columns for belongs_to
+  #           associations are automatically added.  Fields from associations
+  #           may be included by using "association.field".
+  # :conditions:: Array of SQL conditions that will be ANDed together to
+  #               predicate inclusion in the search index.
+  #
+  # Example:
+  #
+  #   class Post < ActiveRecord::Base
+  #     belongs_to :user
+  #     belongs_to :blog
+  #     has_many :comments
+  #   
+  #     add_index :fields => %w[title body user.name, comments.body],
+  #               :conditions => ['published = 1']
+  #   end
+  #
+  # When including fields from associations, MySQL's GROUP_CONCAT() function
+  # is used.  By default this will create a string up to 1024 characters long.
+  # A larger string can be used by changing the value of MySQL's
+  # group_concat_max_len variable.  To do this, add the following to your
+  # sphincter.RAILS_ENV.yml files:
+  #
+  #   mysql:
+  #     sql_query_pre:
+  #       - SET NAMES utf8
+  #       - SET SESSION group_concat_max_len = VALUE
 
   def add_index(options = {})
     options[:fields] ||= []

data/lib/sphincter/tasks.rb

@@ -21,7 +21,7 @@ namespace :sphincter do
 
     indexes_found = Dir[File.join(sphinx_dir, '*.spd')].length
 
-    Rake::Task['sphincter::reindex'].invoke if indexes_found > indexes_defined
+    Rake::Task['sphincter:reindex'].invoke if indexes_found > indexes_defined
   end
 
   desc 'Runs the sphinx indexer'
@@ -45,6 +45,56 @@ namespace :sphincter do
   desc 'Restarts the searchd sphinx daemon'
   task :restart_searchd => %w[sphincter:stop_searchd sphincter:start_searchd]
 
+  desc 'Sets up the sphinx client'
+  task :setup_sphinx do
+    require 'fileutils'
+    require 'tmpdir'
+    require 'open-uri'
+
+    verbose = Rake.application.options.trace
+
+    begin
+      tmpdir = File.join Dir.tmpdir, "Sphincter_setup_#{$$}"
+
+      mkdir tmpdir, :verbose => true
+
+      chdir tmpdir
+
+      src = open "http://rubyforge.org/frs/download.php/19571/sphinx-0.3.0.zip"
+      File.open('sphinx-0.3.0.zip', 'wb') { |dst| dst.write src.read }
+
+      quiet = verbose ? '' : ' -q'
+      sh "unzip#{quiet} sphinx-0.3.0.zip" or
+        raise "couldn't unzip sphinx-0.3.0.zip"
+
+      File.open 'sphinx.patch', 'wb' do |patch|
+        patch.puts <<-EOF
+--- sphinx/lib/client.rb.orig	2007-04-05 06:38:14.000000000 -0700
++++ sphinx/lib/client.rb	2007-07-29 20:23:18.000000000 -0700
+@@ -398,6 +398,7 @@
+   \r
+         result['matches'][doc] ||= {}\r
+         result['matches'][doc]['weight'] = weight\r
++        result['matches'][doc]['index'] = count\r
+         attrs_names_in_order.each do |attr|\r
+           val = response[p, 4].unpack('N*').first; p += 4\r
+           result['matches'][doc]['attrs'] ||= {}\r
+        EOF
+      end
+
+      quiet = verbose ? ' --verbose' : ''
+      sh "patch#{quiet} -p0 sphinx/lib/client.rb sphinx.patch" or
+        raise "couldn't patch sphinx"
+
+      sphinx_plugin_dir = File.join RAILS_ROOT, 'vendor', 'plugins', 'sphinx'
+      rm_rf sphinx_plugin_dir, :verbose => true
+
+      mv 'sphinx', sphinx_plugin_dir, :verbose => true
+    ensure
+      rm_rf tmpdir, :verbose => true
+    end
+  end
+
   desc 'Starts the searchd sphinx daemon'
   task :start_searchd => :index do
     unless Sphincter::Configure.searchd_running? then

data/test/sphincter_test_case.rb

@@ -5,7 +5,14 @@ require 'tmpdir'
 $TESTING = true
 
 class String
-  def constantize() SphincterTestCase::Other end
+  def constantize
+    case self
+    when /belongs_to/i then SphincterTestCase::BelongsTo
+    when /many/i       then SphincterTestCase::HasMany
+    when /poly/i       then SphincterTestCase::Poly
+    else raise "missing klass for #{self} in #constantize"
+    end
+  end
 end
 
 require 'sphincter'
@@ -87,29 +94,30 @@ class SphincterTestCase < Test::Unit::TestCase
   end
 
   class Connection
-    def quote(name) "`#{name}`" end
+    def quote(name) "'#{name}'" end
     def quote_column_name(name) "`#{name}`" end
   end
 
   class Reflection
     attr_accessor :klass
-    attr_reader :macro, :options
+    attr_reader :macro, :options, :name
 
-    def initialize(macro, name)
+    def initialize(macro, name, options = {})
       @klass = Model
       @macro = macro
-      @name = name
-      @options = {}
+      @name = name.intern
+      @options = options
     end
 
-    def class_name() "SphincterTestCase::#{@name.capitalize}" end
+    def class_name() @name.to_s.sub(/s$/, '').capitalize end
     def primary_key_name() "#{@name}_id" end
   end
 
   class Model
 
-    @reflections = [Reflection.new(:belongs_to, 'other'),
-                    Reflection.new(:has_many, 'other')]
+    @reflections = [Reflection.new(:belongs_to, 'belongs_to'),
+                    Reflection.new(:has_many, 'manys'),
+                    Reflection.new(:has_many, 'polys', :as => :polyable)]
 
     class << self; attr_accessor :reflections; end
 
@@ -120,6 +128,7 @@ class SphincterTestCase < Test::Unit::TestCase
         'boolean' => Column.new(:boolean),
         'date' => Column.new(:date),
         'datetime' => Column.new(:datetime),
+        'float' => Column.new(:float),
         'integer' => Column.new(:integer),
         'string' => Column.new(:string),
         'text' => Column.new(:text),
@@ -130,6 +139,8 @@ class SphincterTestCase < Test::Unit::TestCase
 
     def self.find(ids) ids end
 
+    def self.name() 'Model' end
+
     def self.primary_key() 'id' end
 
     def self.reflect_on_all_associations
@@ -140,13 +151,32 @@ class SphincterTestCase < Test::Unit::TestCase
 
   end
 
-  class Other < Model
-    @reflections = [Reflection.new(:belongs_to, 'model'),
-                    Reflection.new(:has_many, 'model')]
+  class BelongsTo < Model
+    @reflections = [Reflection.new(:belongs_to, 'something'),
+                    Reflection.new(:has_many, 'models')]
+
+    def self.table_name() 'belongs_tos' end
 
     def id() 42 end
   end
 
+  class HasMany < Model
+    @reflections = [Reflection.new(:belongs_to, 'models')]
+
+    def self.table_name() 'has_manys' end
+
+    def id() 84 end
+  end
+
+  class Poly < Model
+    @reflections = [Reflection.new(:belongs_to, 'polyable',
+                                   :polymorphic => true)]
+
+    def self.table_name() 'polys' end
+
+    def id() 126 end
+  end
+
   class Model
     extend Sphincter::Search
   end
@@ -172,7 +202,7 @@ class SphincterTestCase < Test::Unit::TestCase
     Sphincter::Configure.instance_variable_set '@index_count', nil if
       Sphincter::Configure.instance_variables.include? '@index_count'
 
-    Other.reflections.last.options.delete :extend
+    BelongsTo.reflections.last.options.delete :extend
   end
 
   def teardown

data/test/test_sphincter_association_searcher.rb

@@ -9,7 +9,7 @@ class TestSphincterAssociationSearcher < SphincterTestCase
     attr_accessor :reflection
 
     def initialize
-      @reflection = SphincterTestCase::Reflection.new :has_many, 'other'
+      @reflection = SphincterTestCase::BelongsTo.reflections.last
       klass = Object.new
       def klass.search_args() @search_args end
       def klass.search(*args) @search_args = args; :searched end
@@ -21,7 +21,7 @@ class TestSphincterAssociationSearcher < SphincterTestCase
     end
 
     def proxy_owner()
-      SphincterTestCase::Other.new
+      SphincterTestCase::BelongsTo.new
     end
   end
 
@@ -31,7 +31,7 @@ class TestSphincterAssociationSearcher < SphincterTestCase
     results = proxy.search 'words'
 
     assert_equal :searched, results
-    assert_equal ['words', { :conditions => { 'other_id' => 42 } } ],
+    assert_equal ['words', { :conditions => { 'models_id' => 42 } } ],
                  proxy.proxy_reflection.klass.search_args
   end
 

data/test/test_sphincter_configure.rb

@@ -6,7 +6,6 @@ class TestSphincterConfigure < SphincterTestCase
   DEFAULT_GET_CONF_EXPECTED = {
     "mysql" =>  {
       "sql_query_pre" => [
-        "SET SESSION group_concat_max_len = 65535",
         "SET NAMES utf8",
       ]
     },
@@ -129,7 +128,9 @@ searchd
   end
 
   def test_self_get_sources
-    Sphincter::Search.indexes[Model] << { :fields => %w[text] }
+    Sphincter::Search.indexes[Model] << {
+      :fields => %w[text belongs_to.string]
+    }
 
     expected = {
       "models" => {
@@ -142,56 +143,18 @@ searchd
         "sql_query" =>
           "SELECT (models.`id` * 1 + 0) AS `id`, " \
                  "0 AS sphincter_index_id, " \
-                 "`models` AS klass, "\
-                 "models.`text` AS `text` " \
-            "FROM models WHERE models.`id` >= $start AND " \
-                              "models.`id` <= $end"
+                 "'Model' AS sphincter_klass, "\
+                 "models.`text` AS `text`, " \
+                 "belongs_tos.`string` AS `belongs_tos_string` "\
+            "FROM models LEFT JOIN belongs_tos ON " \
+                 "models.`belongs_to_id` = belongs_tos.`id` " \
+            "WHERE models.`id` >= $start AND models.`id` <= $end"
       }
     }
 
     assert_equal expected, Sphincter::Configure.get_sources
   end
 
-  def test_self_get_sources_field
-    source_conf = { 'sql_group_column' => [], 'sql_date_column' => [] }
-    klass = Model
-
-    fields = []
-    fields << Sphincter::Configure.get_sources_field(source_conf, klass,
-                                                    'date')
-    fields << Sphincter::Configure.get_sources_field(source_conf, klass,
-                                                    'datetime')
-    fields << Sphincter::Configure.get_sources_field(source_conf, klass,
-                                                    'boolean')
-    fields << Sphincter::Configure.get_sources_field(source_conf, klass,
-                                                    'integer')
-    fields << Sphincter::Configure.get_sources_field(source_conf, klass,
-                                                    'string')
-    fields << Sphincter::Configure.get_sources_field(source_conf, klass,
-                                                    'time')
-    fields << Sphincter::Configure.get_sources_field(source_conf, klass,
-                                                    'timestamp')
-    fields << Sphincter::Configure.get_sources_field(source_conf, klass,
-                                                    'text')
-
-    expected_fields = [
-      "UNIX_TIMESTAMP(models.`date`) AS `date`",
-      "UNIX_TIMESTAMP(models.`datetime`) AS `datetime`",
-      "models.`boolean` AS `boolean`",
-      "models.`integer` AS `integer`",
-      "models.`string` AS `string`",
-      "UNIX_TIMESTAMP(models.`time`) AS `time`",
-      "UNIX_TIMESTAMP(models.`timestamp`) AS `timestamp`",
-      "models.`text` AS `text`"
-    ]
-
-    assert_equal expected_fields,  fields
-
-    assert_equal %w[boolean integer], source_conf['sql_group_column']
-    assert_equal %w[date datetime time timestamp],
-                 source_conf['sql_date_column']
-  end
-
   def test_self_get_db_conf
     expected = {
       'type' => 'mysql',
@@ -316,3 +279,108 @@ index source_2
 
 end
 
+class Sphincter::Configure::Index
+  attr_reader :fields, :where, :tables, :group
+end
+
+class TestSphincterConfigureIndex < SphincterTestCase
+
+  def setup
+    super
+
+    @index = Sphincter::Configure::Index.new Model, {}
+  end
+
+  def test_self_add_field
+    fields = []
+    fields << @index.add_field('date')
+    fields << @index.add_field('datetime')
+    fields << @index.add_field('boolean')
+    fields << @index.add_field('integer')
+    fields << @index.add_field('string')
+    fields << @index.add_field('time')
+    fields << @index.add_field('timestamp')
+    fields << @index.add_field('text')
+
+    expected_fields = [
+      "UNIX_TIMESTAMP(models.`date`) AS `date`",
+      "UNIX_TIMESTAMP(models.`datetime`) AS `datetime`",
+      "models.`boolean` AS `boolean`",
+      "models.`integer` AS `integer`",
+      "models.`string` AS `string`",
+      "UNIX_TIMESTAMP(models.`time`) AS `time`",
+      "UNIX_TIMESTAMP(models.`timestamp`) AS `timestamp`",
+      "models.`text` AS `text`"
+    ]
+
+    assert_equal expected_fields,  fields
+
+    assert_equal %w[sphincter_index_id boolean integer],
+                 @index.source_conf['sql_group_column']
+    assert_equal %w[date datetime time timestamp],
+                 @index.source_conf['sql_date_column']
+  end
+
+  def test_self_add_field_unknown
+    e = assert_raise Sphincter::Error do
+      @index.add_field 'float'
+    end
+
+    assert_equal 'unknown column type float', e.message
+  end
+
+  def test_add_include_belongs_to
+    @index.add_include 'belongs_to', 'string'
+
+    assert_equal ["belongs_tos.`string` AS `belongs_tos_string`"], @index.fields
+
+    tables = "models LEFT JOIN belongs_tos ON " \
+               "models.`belongs_to_id` = belongs_tos.`id`"
+    assert_equal tables, @index.tables
+
+    assert_equal [], @index.where
+
+    assert_equal false, @index.group
+  end
+
+  def test_add_include_has_many
+    @index.add_include 'manys', 'string'
+
+    fields = [
+      "GROUP_CONCAT(has_manys.`string` SEPARATOR ' ') AS `has_manys_string`"
+    ]
+    assert_equal fields, @index.fields
+
+    tables = "models LEFT JOIN has_manys ON models.`id` = has_manys.`manys_id`"
+    assert_equal tables, @index.tables
+
+    assert_equal [], @index.where
+    assert_equal true, @index.group
+  end
+
+  def test_add_include_has_many_polymorphic
+    @index.add_include 'polys', 'string'
+
+    fields = ["GROUP_CONCAT(polys.`string` SEPARATOR ' ') AS `polys_string`"]
+    assert_equal fields, @index.fields
+
+    tables = "models LEFT JOIN polys ON " \
+               "models.`id` = polys.`polyable_id` AND " \
+               "'Model' = polys.`polyable_type`"
+    assert_equal tables, @index.tables
+
+    assert_equal [], @index.where
+    assert_equal true, @index.group
+  end
+
+  def test_add_include_nonexistent_association
+    e = assert_raise Sphincter::Error do
+      @index.add_include 'nonexistent', 'string'
+    end
+
+    assert_equal "could not find association \"nonexistent\" in Model",
+                 e.message
+  end
+
+end
+

data/test/test_sphincter_search.rb

@@ -12,15 +12,15 @@ class TestSphincterSearch < SphincterTestCase
   def test_add_index
     Model.add_index :fields => %w[text]
 
-    assert_equal [{ :fields => %w[text other_id] }],
+    assert_equal [{ :fields => %w[text belongs_to_id] }],
                  Sphincter::Search.indexes[Model]
 
-    other_belongs_to = Other.reflections.first
-    other_has_many = Other.reflections.last
+    belongs_to_belongs_to = BelongsTo.reflections.first
+    belongs_to_has_many = BelongsTo.reflections.last
 
-    assert_equal({}, other_belongs_to.options, 'Other belongs_to')
+    assert_equal({}, belongs_to_belongs_to.options, 'BelongsTo belongs_to')
     assert_equal({ :extend => [Sphincter::AssociationSearcher] },
-                 other_has_many.options, 'Other has_many')
+                 belongs_to_has_many.options, 'BelongsTo has_many')
   end
 
   def test_sphincter_convert_values

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.4.3
 specification_version: 1
 name: Sphincter
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
-date: 2007-07-30 00:00:00 -07:00
+  version: 1.1.0
+date: 2007-08-13 00:00:00 -07:00
 summary: Sphincter is an ActiveRecord extension for full-text searching with Sphinx.
 require_paths: 
 - lib
@@ -31,6 +31,28 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 platform: ruby
 signing_key: 
 cert_chain: 
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDNjCCAh6gAwIBAgIBADANBgkqhkiG9w0BAQUFADBBMRAwDgYDVQQDDAdkcmJy
+  YWluMRgwFgYKCZImiZPyLGQBGRYIc2VnbWVudDcxEzARBgoJkiaJk/IsZAEZFgNu
+  ZXQwHhcNMDcwODE0MDAwMjIzWhcNMDgwODEzMDAwMjIzWjBBMRAwDgYDVQQDDAdk
+  cmJyYWluMRgwFgYKCZImiZPyLGQBGRYIc2VnbWVudDcxEzARBgoJkiaJk/IsZAEZ
+  FgNuZXQwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDVZUNKmnp8LrkM
+  bQd5ZrcTV1R7woai4clBLUjH3DL47r+f6d5dz+gJUegZ3RKWdSvOfaRmXFkr2+nv
+  vc6uzcxk9w1uN5Z3w+BCeKtsUR8EtUhH8b26HDNGDeuoTX1gEgm4DacBh1/Ib+SQ
+  PxLVkFnWiCekGvL7jzecw6UwADn49Ag4NxIvpN0ttsYCQFMDuqzdISjurbb3dZ2z
+  OsaDqdW29c3Jed816kVhOzRZ2EC4BExPtEN6xZCwab6f9tzJT+Atea7PRFLm/T7t
+  QFBPGC2XjPUXJxTyz+8PEDDb2PXeZwPSDIysq1tzB55A3rE1a5pLvnBfek5KjC25
+  0wuuKuxlAgMBAAGjOTA3MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQW
+  BBStuxfp/gfzqL+3k7tFe8gVU9zpvDANBgkqhkiG9w0BAQUFAAOCAQEAvnmUelUN
+  s9f/VasT9mZV4tIP3sKi0uqyq9i7vtDgCNFw0BAKNxa6ybO1CrBBnjDMa4hvhrW8
+  qCLkx7BFHGV/eWR3pdwcLAS8cLuEib75nuG1lbG2yIvGSYTyQ/oxbmuUAZxpavK2
+  101OludXvBC9hpA4Qz3UhJYBdtT8TuztiFGLzhCJusjUD7I6Y+TrrTPkBGceVVyY
+  hx8aJk+44+jvzgsTi4MyrRo4lAGsQxFa1f1IBuEgqNPdML31yGO0QKof+IqPiVNo
+  HsCQoSWkgfQE0DHTgx+hWkF2d10+54I4aM9tIROeGACQemcj0IRf3v7Au8I+6PWl
+  3E1oHz01aNcUFA==
+  -----END CERTIFICATE-----
+
 post_install_message: 
 authors: 
 - Eric Hodel
@@ -96,5 +118,5 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.2.2
+        version: 1.3.0
     version: 

metadata.gz.sig

@@ -0,0 +1,3 @@
+�eg�>Mu�nUEo�p�����.ɵ(_>��:���;qe����������
Pm
+A�a���=m�mǨ��F�՗|��7��i˜Kg�a�
z	��ߩ�#'R�qF~�bA��4���_��+҉PS��G^
+�ڝ���	���j!��zƠ��/�Y^��O�aTI������