dm-sphinx-adapter 0.6 → 0.7

data/History.txt

@@ -1,3 +1,16 @@
+=== 0.7 / 2009-02-21
+
+  * Explicit repository names everywhere I can. DM ~> 0.9.10 and dm-sphinx-adapter 0.6.2 couldn't guess the default repository name.
+
+=== 0.6.2 / 2008-12-16
+
+  * Fixed shallow .dup of riddle client errors. You need to upgrade if you are running 0.6.1.
+
+=== 0.6.1 / 2008-12-16
+
+  * The adapter returns the entire Riddle::Client#query response so document :weight and :attributes are usable.
+  * Fixed broken naming convention bug. The AbstractAdapter constructor was not being called.
+
 === 0.6 / 2008-12-13
 
   * Removed managed client and all related libs.

data/Manifest.txt

@@ -16,8 +16,8 @@ lib/riddle/client/filter.rb
 lib/riddle/client/message.rb
 lib/riddle/client/response.rb
 test/files/model.rb
-test/files/mysql5.sphinx.conf
-test/files/mysql5.sql
+test/files/source.xml
+test/files/sphinx.conf
 test/helper.rb
 test/test_adapter.rb
 test/test_attribute.rb

data/README.txt

@@ -10,11 +10,24 @@ A DataMapper Sphinx adapter.
 
 == Dependencies
 
+Ruby::
 * dm-core           ~> 0.9.7
 * dm-is-searchable  ~> 0.9.7 (optional)
 
 I'd recommend using the dm-more plugin dm-is-searchable instead of fetching the document id's yourself.
 
+Sphinx::
+* 0.9.8-r871
+* 0.9.8-r909
+* 0.9.8-r985
+* 0.9.8-r1065
+* 0.9.8-r1112
+* 0.9.8-rc1 (gem version: 0.9.8.1198)
+* 0.9.8-rc2 (gem version: 0.9.8.1231)
+* 0.9.8 (gem version: 0.9.8.1371)
+
+Internally the Riddle client library is used.
+
 == Install
 
 * Via git: git clone git://github.com/shanna/dm-sphinx-adapter.git

data/Rakefile

@@ -3,7 +3,7 @@
 require 'rubygems'
 require 'hoe'
 
-Hoe.new('dm-sphinx-adapter', '0.6') do |p|
+Hoe.new('dm-sphinx-adapter', '0.7') do |p|
   p.developer('Shane Hanna', 'shane.hanna@gmail.com')
   p.extra_deps = [
     ['dm-core', '~> 0.9.7']

data/dm-sphinx-adapter.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{dm-sphinx-adapter}
-  s.version = "0.6"
+  s.version = "0.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Shane Hanna"]
-  s.date = %q{2008-12-13}
+  s.date = %q{2009-02-21}
   s.description = %q{A DataMapper Sphinx adapter.}
   s.email = ["shane.hanna@gmail.com"]
   s.extra_rdoc_files = ["History.txt", "LICENCE.txt", "Manifest.txt", "README.txt"]
-  s.files = ["History.txt", "LICENCE.txt", "Manifest.txt", "README.txt", "Rakefile", "dm-sphinx-adapter.gemspec", "lib/dm-sphinx-adapter.rb", "lib/dm-sphinx-adapter/adapter.rb", "lib/dm-sphinx-adapter/attribute.rb", "lib/dm-sphinx-adapter/index.rb", "lib/dm-sphinx-adapter/query.rb", "lib/dm-sphinx-adapter/resource.rb", "lib/riddle.rb", "lib/riddle/client.rb", "lib/riddle/client/filter.rb", "lib/riddle/client/message.rb", "lib/riddle/client/response.rb", "test/files/model.rb", "test/files/mysql5.sphinx.conf", "test/files/mysql5.sql", "test/helper.rb", "test/test_adapter.rb", "test/test_attribute.rb", "test/test_index.rb", "test/test_query.rb", "test/test_resource.rb"]
+  s.files = ["History.txt", "LICENCE.txt", "Manifest.txt", "README.txt", "Rakefile", "dm-sphinx-adapter.gemspec", "lib/dm-sphinx-adapter.rb", "lib/dm-sphinx-adapter/adapter.rb", "lib/dm-sphinx-adapter/attribute.rb", "lib/dm-sphinx-adapter/index.rb", "lib/dm-sphinx-adapter/query.rb", "lib/dm-sphinx-adapter/resource.rb", "lib/riddle.rb", "lib/riddle/client.rb", "lib/riddle/client/filter.rb", "lib/riddle/client/message.rb", "lib/riddle/client/response.rb", "test/files/model.rb", "test/files/source.xml", "test/files/sphinx.conf", "test/helper.rb", "test/test_adapter.rb", "test/test_attribute.rb", "test/test_index.rb", "test/test_query.rb", "test/test_resource.rb"]
   s.has_rdoc = true
   s.homepage = %q{http://dm-sphinx.rubyforge.org}
   s.rdoc_options = ["--main", "README.txt"]
@@ -26,13 +26,13 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<dm-core>, ["~> 0.9.7"])
-      s.add_development_dependency(%q<hoe>, [">= 1.8.2"])
+      s.add_development_dependency(%q<hoe>, [">= 1.8.3"])
     else
       s.add_dependency(%q<dm-core>, ["~> 0.9.7"])
-      s.add_dependency(%q<hoe>, [">= 1.8.2"])
+      s.add_dependency(%q<hoe>, [">= 1.8.3"])
     end
   else
     s.add_dependency(%q<dm-core>, ["~> 0.9.7"])
-    s.add_dependency(%q<hoe>, [">= 1.8.2"])
+    s.add_dependency(%q<hoe>, [">= 1.8.3"])
   end
 end

data/lib/dm-sphinx-adapter.rb

@@ -2,7 +2,7 @@ require 'rubygems'
 
 # TODO: Hide the shitload of dm-core warnings or at least try to?
 old_verbose, $VERBOSE = $VERBOSE, nil
-  gem 'dm-core', '~> 0.9.7'
+  gem 'dm-core', '~> 0.9.8'
   require 'dm-core'
 $VERBOSE = old_verbose
 

data/lib/dm-sphinx-adapter/adapter.rb

@@ -36,9 +36,8 @@ module DataMapper
         # uri_or_options<URI, DataObject::URI, Addressable::URI, String, Hash, Pathname>::
         #   DataMapper uri or options hash.
         def initialize(name, uri_or_options)
-          options = normalize_options(uri_or_options)
-          @client = Riddle::Client.new(options.delete(:host), options.delete(:port))
-          options.each{|k, v| @client.method("#{k}=".to_sym).call(v) if @client.respond_to?("#{k}=".to_sym)}
+          super # Set up defaults.
+          @options = normalize_options(uri_or_options)
         end
 
         def create(resources) #:nodoc:
@@ -56,11 +55,13 @@ module DataMapper
         # These methods are public but normally called indirectly through DataMapper::Resource#get,
         # DataMapper::Resource#first or DataMapper::Resource#all.
         #
+        # The document hashes returned are those from Riddle::Client.
+        #
         # ==== Parameters
         # query<DataMapper::Query>:: The query object.
         #
         # ==== Returns
-        # Array<Hash>:: An array of document hashes. <tt>[{:id => 1}, {:id => 2}]</tt>
+        # Array<Hash>:: An array of document hashes. <tt>[{:id => 1, ...}, {:id => 2, ...}]</tt>
         # Array<>::     An empty array if no documents match.
         def read_many(query)
           read(query)
@@ -77,7 +78,7 @@ module DataMapper
         # query<DataMapper::Query>:: The query object.
         #
         # ==== Returns
-        # Hash:: An document hash of the first document matched. <tt>{:id => 1}</tt>
+        # Hash:: An document hash of the first document matched. <tt>{:id => 1, ...}</tt>
         # Nil::  If no documents match.
         def read_one(query)
           read(query).first
@@ -97,10 +98,10 @@ module DataMapper
           #
           # ==== Returns
           # Array<DataMapper::Adapters::Sphinx::Index>:: Index objects from the model.
-          def indexes(model)
-            indexes = model.sphinx_indexes(repository(self.name).name) if model.respond_to?(:sphinx_indexes)
+          def indexes(query)
+            indexes = query.model.sphinx_indexes(name) if query.model.respond_to?(:sphinx_indexes)
             if indexes.nil? or indexes.empty?
-              indexes = [Index.new(model, model.storage_name)]
+              indexes = [Index.new(query.model, query.model.storage_name(name))]
             end
             indexes
           end
@@ -111,13 +112,18 @@ module DataMapper
           # query<DataMapper::Query>:: The query object.
           #
           # ==== Returns
-          # Array<Hash>:: An array of document hashes. <tt>[{:id => 1}, {:id => 2}]</tt>
+          # Array<Hash>:: An array of document hashes. <tt>[{:id => 1, ...}, {:id => 2, ...}]</tt>
           # Array<>::     An empty array if no documents match.
           def read(query)
-            from    = indexes(query.model).map{|index| index.name}.join(', ')
-            search  = Sphinx::Query.new(query).to_s
+            from   = indexes(query).map{|index| index.name}.join(', ')
+            search = Sphinx::Query.new(query).to_s
+            client = Riddle::Client.new(@options[:host], @options[:port])
+
+            # You can set some options that aren't set by the adapter.
+            @options.except(:host, :port, :match_mode, :limit, :offset, :sort_mode, :sort_by).each do |k, v|
+              client.method("#{k}=".to_sym).call(v) if client.respond_to?("#{k}=".to_sym)
+            end
 
-            client            = @client.dup
             client.match_mode = :extended
             client.filters    = search_filters(query) # By attribute.
             client.limit      = query.limit.to_i  if query.limit
@@ -134,7 +140,7 @@ module DataMapper
             DataMapper.logger.info(
               %q{Sphinx (%.3f): search '%s' in '%s' found %d documents} % [result[:time], search, from, result[:total]]
             )
-            result[:matches].map{|doc| {:id => doc[:doc]}}
+            result[:matches].map{|doc| doc[:id] = doc[:doc]; doc}
           end
 
 

data/lib/dm-sphinx-adapter/query.rb

@@ -31,10 +31,11 @@ module DataMapper
             query.conditions.each do |operator, property, value|
               next if property.kind_of? Sphinx::Attribute # Filters are added elsewhere.
               normalized = normalize_value(value)
+              field      = property.field(query.repository.name) unless operator == :raw
               @query << case operator
-                when :eql, :like then '@%s "%s"'  % [property.field.to_s, normalized.join(' ')]
-                when :not        then '@%s -"%s"' % [property.field.to_s, normalized.join(' ')]
-                when :in         then '@%s (%s)'  % [property.field.to_s, normalized.map{|v| %{"#{v}"}}.join(' | ')]
+                when :eql, :like then '@%s "%s"'  % [field.to_s, normalized.join(' ')]
+                when :not        then '@%s -"%s"' % [field.to_s, normalized.join(' ')]
+                when :in         then '@%s (%s)'  % [field.to_s, normalized.map{|v| %{"#{v}"}}.join(' | ')]
                 when :raw        then "#{property}"
                 else raise NotImplementedError.new("Sphinx: Query fields do not support the #{operator} operator")
               end

data/test/files/model.rb

@@ -1,4 +1,5 @@
 class Item
+  include DataMapper::Resource
   include DataMapper::SphinxResource
   property :id,         Serial
   property :t_string,   String

data/test/files/source.xml

@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="utf-8"?>
+<sphinx:docset xmlns:sphinx="sphinx">
+  <sphinx:schema>
+    <sphinx:field name="t_string"/>
+    <sphinx:field name="t_text"/>
+    <sphinx:attr name="t_decimal"  type="float"/>
+    <sphinx:attr name="t_float"    type="float"/>
+    <sphinx:attr name="t_integer"  type="int"/>
+    <sphinx:attr name="t_datetime" type="timestamp"/>
+  </sphinx:schema>
+
+  <sphinx:document id="1">
+    <t_string>one</t_string>
+    <t_text>text one!</t_text>
+    <t_decimal>10.5</t_decimal>
+    <t_float>100.5</t_float>
+    <t_integer>1000</t_integer>
+    <t_datetime>1235183682</t_datetime>
+  </sphinx:document>
+
+  <sphinx:document id="2">
+    <t_string>two</t_string>
+    <t_text>text two!</t_text>
+    <t_decimal>20.5</t_decimal>
+    <t_float>200.5</t_float>
+    <t_integer>2000</t_integer>
+    <t_datetime>1235183682</t_datetime>
+  </sphinx:document>
+
+  <sphinx:document id="3">
+    <t_string>three</t_string>
+    <t_text>text three!</t_text>
+    <t_decimal>30.5</t_decimal>
+    <t_float>300.5</t_float>
+    <t_integer>3000</t_integer>
+    <t_datetime>1235183682</t_datetime>
+  </sphinx:document>
+</sphinx:docset>
+

data/test/files/sphinx.conf

@@ -0,0 +1,36 @@
+# searchd and indexer must be run from the root directory of this lib.
+
+indexer
+{
+  mem_limit = 64M
+}
+
+searchd
+{
+  address      = localhost
+  port         = 3312
+  log          = test/files/tmp/sphinx.log
+  query_log    = test/files/tmp/sphinx.query.log
+  read_timeout = 5
+  pid_file     = test/files/tmp/sphinx.pid
+  max_matches  = 1000
+}
+
+source items
+{
+  type            = xmlpipe2
+  xmlpipe_command = cat test/files/source.xml
+}
+
+index items_main
+{
+  source       = items
+  charset_type = utf-8
+  path         = test/files/tmp/items
+}
+
+index items
+{
+  type  = distributed
+  local = items_main
+}

data/test/helper.rb

@@ -6,37 +6,32 @@ require 'pathname'
 require 'shoulda'
 require 'test/unit'
 
-base = Pathname.new(__FILE__).dirname + '..'
+base  = Pathname.new(__FILE__).dirname + '..'
+files = base + 'test' + 'files'
 %w{lib test}.each{|p| $:.unshift base + p}
 
 require 'dm-sphinx-adapter'
 
 # Sphinx runner.
 Dir.chdir(base)
-config = base + 'test' + 'files' + 'mysql5.sphinx.conf'
 begin
   TCPSocket.new('localhost', '3312')
 rescue
   puts 'Starting Sphinx...'
-  system("searchd --config #{config}") || exit
+  system("searchd --config #{files + 'sphinx.conf'}") || exit
   system('ps aux | grep searchd')
 end
 
-class Test::Unit::TestCase
-  include Extlib::Hook
-
-  before :setup do
-    files = Pathname.new(__FILE__).dirname + 'files'
-
-    mysql = `mysql5 dm_sphinx_adapter_test < #{files + 'mysql5.sql'} 2>&1`
-    raise %{Re-create database failed:\n #{mysql}} unless mysql.blank?
+indexer = `indexer --config #{files + 'sphinx.conf'} --all --rotate`
+raise %{Re-create index failed:\n #{indexer}} if indexer =~ /error|fatal/i
+sleep 1
 
-    indexer = `indexer --config #{files + 'mysql5.sphinx.conf'} --all --rotate`
-    raise %{Re-create index failed:\n #{indexer}} if indexer =~ /error|fatal/i
+# :default is unused at the moment.
+DataMapper.setup(:default, :adapter => 'in_memory', :database => 'dm_sphinx_adapter_test')
+DataMapper.setup(:search,  :adapter => 'sphinx')
 
-    DataMapper.setup(:default, :adapter => 'mysql', :database => 'dm_sphinx_adapter_test')
-    sleep 1; # Give sphinx a chance to catch up before test runs.
-  end
+class Test::Unit::TestCase
+  include Extlib::Hook
 
   # after :teardown do
   def teardown

data/test/test_adapter.rb

@@ -1,49 +1,52 @@
 require File.join(File.dirname(__FILE__), 'helper')
 
 class TestAdapter < Test::Unit::TestCase
-  context 'DM::A::Sphinx::Adapter class' do
+  context 'DM::A::Sphinx::Adapter' do
     setup do
-      DataMapper.setup(:adapter, :adapter => 'sphinx')
       load File.join(File.dirname(__FILE__), 'files', 'model.rb')
-      @it       = repository(:adapter)
+      @it       = repository(:search)
       @resource = Item
     end
 
-    context '#create' do
-      should 'should return zero records created' do
-        assert_equal 0, @it.create(create_resource)
+    context 'class' do
+      should 'use default field naming convention' do
+        assert_equal(
+          DataMapper::NamingConventions::Field::Underscored,
+          @it.adapter.field_naming_convention
+        )
       end
-    end
 
-    context '#delete' do
-      should 'should return zero records deleted' do
-        assert_equal 0, @it.delete(create_resource)
+      should 'use default resource naming convention' do
+        assert_equal(
+          DataMapper::NamingConventions::Resource::UnderscoredAndPluralized,
+          @it.adapter.resource_naming_convention
+        )
       end
     end
 
     context '#read_many' do
       context 'conditions' do
         should 'return all objects when nil' do
-          assert_equal [{:id => 1}, {:id => 2}, {:id => 3}], @it.read_many(query)
+          assert_equal [1, 2, 3], @it.read_many(query).map{|d| d[:id]}
         end
 
         should 'return subset of objects for conditions' do
-          assert_equal [{:id => 2}], @it.read_many(query(:t_string => 'two'))
+          assert_equal [2], @it.read_many(query(:t_string => 'two')).map{|d| d[:id]}
         end
       end
 
       context 'offsets' do
         should 'be able to offset the objects' do
-          assert_equal [{:id => 1}, {:id => 2}, {:id => 3}], @it.read_many(query(:offset => 0))
-          assert_equal [{:id => 2}, {:id => 3}], @it.read_many(query(:offset => 1))
+          assert_equal [1, 2, 3], @it.read_many(query(:offset => 0)).map{|d| d[:id]}
+          assert_equal [2, 3], @it.read_many(query(:offset => 1)).map{|d| d[:id]}
           assert_equal [], @it.read_many(query(:offset => 3))
         end
       end
 
       context 'limits' do
         should 'be able to limit the objects' do
-          assert_equal [{:id => 1}], @it.read_many(query(:limit => 1))
-          assert_equal [{:id => 1}, {:id => 2}], @it.read_many(query(:limit => 2))
+          assert_equal [1], @it.read_many(query(:limit => 1)).map{|d| d[:id]}
+          assert_equal [1, 2], @it.read_many(query(:limit => 2)).map{|d| d[:id]}
         end
       end
     end
@@ -60,25 +63,6 @@ class TestAdapter < Test::Unit::TestCase
 
   protected
     def query(conditions = {})
-      DataMapper::Query.new(repository(:adapter), @resource, conditions)
-    end
-
-    def resource(options = {})
-      now = Time.now
-      attributes = {
-        :t_string   => now.to_s,
-        :t_text     => "text #{now.to_s}!",
-        :t_decimal  => now.to_i * 0.001,
-        :t_float    => now.to_i * 0.0001,
-        :t_integer  => now.to_i,
-        :t_datetime => now
-      }.update(options)
-      @resource.new(attributes)
-    end
-
-    def create_resource(options = {})
-      repository(:adapter) do
-        @resource.create(resource(options).attributes.except(:id))
-      end
+      DataMapper::Query.new(repository(:search), @resource, conditions)
     end
 end

data/test/test_query.rb

@@ -3,9 +3,8 @@ require File.join(File.dirname(__FILE__), 'helper')
 class TestQuery < Test::Unit::TestCase
   context 'DM::A::Sphinx::Query conditions' do
     setup do
-      DataMapper.setup(:adapter, :adapter => 'sphinx')
       load File.join(File.dirname(__FILE__), 'files', 'model.rb')
-      @adapter  = repository(:adapter)
+      @adapter  = repository(:search)
       @resource = Item
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dm-sphinx-adapter
 version: !ruby/object:Gem::Version 
-  version: "0.6"
+  version: "0.7"
 platform: ruby
 authors: 
 - Shane Hanna
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-13 00:00:00 +11:00
+date: 2009-02-22 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,7 +30,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.8.2
+        version: 1.8.3
     version: 
 description: A DataMapper Sphinx adapter.
 email: 
@@ -63,8 +63,8 @@ files:
 - lib/riddle/client/message.rb
 - lib/riddle/client/response.rb
 - test/files/model.rb
-- test/files/mysql5.sphinx.conf
-- test/files/mysql5.sql
+- test/files/source.xml
+- test/files/sphinx.conf
 - test/helper.rb
 - test/test_adapter.rb
 - test/test_attribute.rb

data/test/files/mysql5.sphinx.conf

@@ -1,97 +0,0 @@
-# searchd and indexer must be run from the root directory of this lib.
-
-indexer
-{
-  mem_limit = 64M
-}
-
-searchd
-{
-  address      = localhost
-  port         = 3312
-  log          = test/files/tmp/sphinx.log
-  query_log    = test/files/tmp/sphinx.query.log
-  read_timeout = 5
-  pid_file     = test/files/tmp/sphinx.pid
-  max_matches  = 1000
-}
-
-source items
-{
-  type     = mysql
-  sql_host = localhost
-  sql_user = root
-  sql_pass =
-  sql_db   = dm_sphinx_adapter_test
-
-  sql_query_pre = set names utf8
-  sql_query_pre = \
-    replace into delta (name, updated_on) ( \
-      select 'items', t_datetime \
-      from items \
-      order by t_datetime desc \
-      limit 1\
-    )
-  sql_query_info = select * from items where id = $id
-
-  sql_query_pre = set names utf8
-  sql_query = \
-    select \
-      id, \
-      t_string, \
-      t_text, \
-      t_decimal, \
-      t_float, \
-      t_integer, \
-      unix_timestamp(t_datetime) as t_datetime \
-    from items \
-    where t_datetime <= ( \
-      select updated_on \
-      from delta \
-      where name = 'items' \
-    )
-
-  sql_attr_float     = t_decimal
-  sql_attr_float     = t_float
-  sql_attr_uint      = t_integer
-  sql_attr_timestamp = t_datetime
-}
-
-source items_delta : items {
-  sql_query_pre = set names utf8
-  sql_query_pre =
-  sql_query     = \
-    select \
-      id, \
-      t_string, \
-      t_text, \
-      t_decimal, \
-      t_float, \
-      t_integer, \
-      unix_timestamp(t_datetime) as t_datetime \
-    from items \
-    where t_datetime > ( \
-      select updated_on \
-      from delta \
-      where name = 'items' \
-    )
-}
-
-index items_main
-{
-  source = items
-  path   = test/files/tmp/items_main
-}
-
-index items_delta : items_main
-{
-  source = items_delta
-  path   = test/files/tmp/items_delta
-}
-
-index items
-{
-  type  = distributed
-  local = items_main
-  local = items_delta
-}

data/test/files/mysql5.sql

@@ -1,26 +0,0 @@
-drop table if exists delta;
-create table delta (
-  name varchar(50) not null,
-  updated_on datetime,
-  primary key (name)
-) engine=innodb default charset=utf8;
-
-insert into delta (name, updated_on) values
-  ('items', now());
-
-drop table if exists items;
-create table items (
-  id int(11) not null auto_increment,
-  t_string   varchar(50),
-  t_text     text,
-  t_decimal  decimal(30,10),
-  t_float    float,
-  t_integer  int,
-  t_datetime datetime,
-  primary key (id)
-) engine=innodb default charset=utf8;
-
-insert into items (t_string, t_text, t_decimal, t_float, t_integer, t_datetime) values
-  ('one',   'text one!',   '10.50', '100.50', '1000', now()),
-  ('two',   'text two!',   '20.50', '200.50', '2000', now()),
-  ('three', 'text three!', '30.50', '300.50', '3000', now());