dm-sphinx-adapter 0.4 → 0.5

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

@@ -0,0 +1,103 @@
+module DataMapper
+  module Adapters
+    module Sphinx
+
+      # Declare Sphinx indexes and attributes in your resource.
+      #
+      #   model Items
+      #     include DataMapper::SphinxResource
+      #
+      #     # .. normal properties and such for :default
+      #
+      #     repository(:search) do
+      #       # Query some_index, some_index_delta in that order.
+      #       index :some_index
+      #       index :some_index_delta, :delta => true
+      #
+      #       # Sortable by some attributes.
+      #       attribute :updated_at, DateTime  # sql_attr_timestamp
+      #       attribute :age, Integer          # sql_attr_uint
+      #       attribute :deleted, Boolean      # sql_attr_bool
+      #     end
+      #   end
+      module Resource
+        def self.included(model) #:nodoc:
+          model.class_eval do
+            include DataMapper::Resource
+            extend ClassMethods
+          end
+        end
+
+        module ClassMethods
+          def self.extended(model) #:nodoc:
+            model.instance_variable_set(:@sphinx_indexes, {})
+            model.instance_variable_set(:@sphinx_attributes, {})
+          end
+
+          # Defines a sphinx index on the resource.
+          #
+          # Indexes are naturally ordered, with delta indexes at the end of the list so that duplicate document IDs in
+          # delta indexes override your main indexes.
+          #
+          # ==== See
+          # * DataMapper::Adapters::Sphinx::Index
+          #
+          # ==== Parameters
+          # name<Symbol>:: The name of a sphinx index to search for this resource.
+          # options<Hash>:: A hash of available index options.
+          def index(name, options = {})
+            index   = Index.new(self, name, options)
+            indexes = sphinx_indexes(repository_name)
+            indexes << index
+
+            # TODO: I'm such a Ruby nub. In the meantime I've gone back to my Perl roots.
+            # This is a Schwartzian transform to sort delta indexes to the bottom and natural sort by name.
+            mapped  = indexes.map{|i| [(i.delta? ? 1 : 0), i.name, i]}
+            sorted  = mapped.sort{|a, b| a[0] <=> b[0] || a[1] <=> b[1]}
+            indexes.replace(sorted.map{|i| i[2]})
+
+            index
+          end
+
+          # List of declared sphinx indexes for this model.
+          #
+          # ==== Returns
+          # Array<DataMapper::Adapters::Sphinx::Index>
+          def sphinx_indexes(repository_name = default_repository_name)
+            @sphinx_indexes[repository_name] ||= []
+          end
+
+          # Defines a sphinx attribute on the resource.
+          #
+          # ==== See
+          # DataMapper::Adapters::Sphinx::Attribute
+          #
+          # ==== Parameters
+          # name<Symbol>:: The name of a sphinx attribute to order/restrict by for this resource.
+          # type<Class>:: The type to define this attribute as.
+          # options<Hash>:: An optional hash of attribute options.
+          def attribute(name, type, options = {})
+            # Attributes are just properties without a getter/setter in the model.
+            # This keeps DataMapper::Query happy when building queries.
+            attribute = Sphinx::Attribute.new(self, name, type, options)
+            properties(repository_name)[attribute.name] = attribute
+            attribute
+          end
+
+          # List of declared sphinx attributes for this model.
+          #
+          # ==== Returns
+          # Array<DataMapper::Adapters::Sphinx::Attribute>
+          def sphinx_attributes(repository_name = default_repository_name)
+            properties(repository_name).grep{|p| p.kind_of? Sphinx::Attribute}
+          end
+
+        end # ClassMethods
+      end # Resource
+    end # Sphinx
+  end # Adapters
+
+  # Follow DM naming convention.
+  SphinxResource = Adapters::Sphinx::Resource
+end # DataMapper
+

data/test/{fixtures/item.sql → files/dm_sphinx_adapter_test.sql}

@@ -16,6 +16,6 @@ create table items (
 ) engine=innodb default charset=utf8;
 
 insert into items (name, likes, updated_on) values
-  ('foo', 'I really like foo!', now()),
-  ('bar', 'I really like bar!', now()),
-  ('baz', 'I really like baz!', now());
+  ('one', 'I really like one!', now()),
+  ('two', 'I really like two!', now()),
+  ('three', 'I really like three!', now());

data/test/{fixtures/item_resource_explicit.rb → files/resource_explicit.rb}

@@ -1,14 +1,13 @@
 require 'rubygems'
 require 'dm-is-searchable'
-require 'zlib'
 
-class ItemResourceExplicit
+class Explicit
   include DataMapper::Resource
   include DataMapper::SphinxResource
 
   property :id,         Serial
-  property :name,       String, :nullable => false, :length => 50
-  property :likes,      Text
+  property :name,       String
+  property :likes,      Text, :lazy => false
   property :updated_on, DateTime
 
   is :searchable
@@ -17,10 +16,10 @@ class ItemResourceExplicit
     index     :items
     index     :items_delta, :delta => true
     property  :name,    String
-    attribute :updated, DateTime
+    attribute :updated_on, DateTime
   end
 
   def self.default_storage_name
     'item'
   end
-end # ItemResourceExplicit
+end # Explicit

data/test/{fixtures/item_resource_only.rb → files/resource_resource.rb}

@@ -1,14 +1,13 @@
 require 'rubygems'
 require 'dm-is-searchable'
-require 'zlib'
 
-class ItemResourceOnly
+class Resource
   include DataMapper::Resource
   include DataMapper::SphinxResource
 
   property :id,         Serial
-  property :name,       String, :nullable => false, :length => 50
-  property :likes,      Text
+  property :name,       String
+  property :likes,      Text, :lazy => false
   property :updated_on, DateTime
 
   is :searchable
@@ -16,5 +15,5 @@ class ItemResourceOnly
   def self.default_storage_name
     'item'
   end
-end # ItemResourceOnly
+end # Resource
 

data/test/{fixtures/item.rb → files/resource_searchable.rb}

@@ -1,13 +1,16 @@
 require 'rubygems'
 require 'dm-is-searchable'
-require 'zlib'
 
-class Item
+class Searchable
   include DataMapper::Resource
   property :id,         Serial
-  property :name,       String, :nullable => false, :length => 50
-  property :likes,      Text
+  property :name,       String
+  property :likes,      Text, :lazy => false
   property :updated_on, DateTime
 
   is :searchable
-end # Item
+
+  def self.default_storage_name
+    'item'
+  end
+end # Searchable

data/test/files/resource_storage_name.rb

@@ -0,0 +1,11 @@
+class StorageName
+  include DataMapper::Resource
+  property :id,         Serial
+  property :name,       String
+  property :likes,      Text, :lazy => false
+  property :updated_on, DateTime
+
+  def self.default_storage_name
+    'item'
+  end
+end # StorageName

data/test/files/resource_vanilla.rb

@@ -0,0 +1,7 @@
+class Vanilla
+  include DataMapper::Resource
+  property :id,         Serial
+  property :name,       String
+  property :likes,      Text, :lazy => false
+  property :updated_on, DateTime
+end # Vanilla

data/test/{data → files}/sphinx.conf

@@ -9,11 +9,10 @@ searchd
 {
   address      = localhost
   port         = 3312
-  log          = test/data/sphinx.log
-  query_log    = test/data/sphinx.query.log
+  log          = test/var/sphinx.log
+  query_log    = test/var/sphinx.query.log
   read_timeout = 5
-  max_children = 30
-  pid_file     = test/data/sphinx.pid
+  pid_file     = test/var/sphinx.pid
   max_matches  = 1000
 }
 
@@ -63,11 +62,17 @@ source items_delta : items
 index items
 {
   source = items
-  path   = test/data/sphinx/items
+  path   = test/var/sphinx/items
 }
 
 index items_delta : items
 {
   source = items_delta
-  path   = test/data/sphinx/items_delta
+  path   = test/var/sphinx/items_delta
+}
+
+index vanillas
+{
+  type  = distributed
+  local = items
 }

data/test/test_adapter.rb

@@ -0,0 +1,38 @@
+require 'dm-sphinx-adapter'
+require 'test/unit'
+
+# DataMapper::Logger.new(STDOUT, :debug)
+
+class TestAdapter < Test::Unit::TestCase
+  def setup
+    # TODO: A little too brutal even by my standards.
+    Dir.chdir(File.join(File.dirname(__FILE__), 'files')) do
+      system 'mysql -u root dm_sphinx_adapter_test < dm_sphinx_adapter_test.sql' \
+        or raise %q{Tests require the dm_sphinx_adapter_test database.}
+    end
+
+    DataMapper.setup(:default, 'mysql://localhost/dm_sphinx_adapter_test')
+
+    @config = Pathname.new(__FILE__).dirname.expand_path / 'files' / 'sphinx.conf'
+    @client = DataMapper::Adapters::Sphinx::ManagedClient.new(:config => @config)
+    @client.index
+    sleep 1
+  end
+
+  def test_unmanaged_setup
+    assert DataMapper.setup(:sphinx, :adapter => 'sphinx')
+    assert_kind_of DataMapper::Adapters::SphinxAdapter, repository(:sphinx).adapter
+    assert_kind_of DataMapper::Adapters::Sphinx::Client, repository(:sphinx).adapter.client
+  end
+
+  def test_managed_setup
+    assert DataMapper.setup(:sphinx, :adapter => 'sphinx', :config => @config, :managed => true)
+    assert_kind_of DataMapper::Adapters::SphinxAdapter, repository(:sphinx).adapter
+    assert_kind_of DataMapper::Adapters::Sphinx::ManagedClient, repository(:sphinx).adapter.client
+  end
+
+  def teardown
+    @client.stop
+    sleep 1
+  end
+end

data/test/test_adapter_explicit.rb

@@ -0,0 +1,48 @@
+require 'test_adapter'
+require 'files/resource_explicit'
+
+class TestAdapterExplicit < TestAdapter
+  def setup
+    super
+    DataMapper.setup(:search, :adapter => 'sphinx', :config => @config, :managed => true)
+  end
+
+  def teardown
+    DataMapper.repository(:search).adapter.client.stop
+    super
+  end
+
+  def test_initialize
+    assert_nothing_raised{ Explicit.new }
+  end
+
+  def test_search_properties
+    assert_equal Explicit.all, Explicit.search
+    assert_equal [Explicit.first(:id => 2)], Explicit.search(:name => 'two')
+  end
+
+  def test_search_delta
+    resource = Explicit.create(:name => 'four', :likes => 'chicken', :updated_on => Time.now)
+    DataMapper.repository(:search).adapter.client.index('items_delta')
+    assert_equal [resource], Explicit.search(:name => 'four')
+  end
+
+  def test_search_attribute_timestamp
+    time     = Time.now
+    resource = Explicit.create(:name => 'four', :likes => 'chicken', :updated_on => time)
+    DataMapper.repository(:search).adapter.client.index('items_delta')
+
+    assert_equal [resource], Explicit.search(:updated_on => time.to_i)
+    assert_equal [resource], Explicit.search(:updated_on => (time .. time + 1))
+    assert_equal [], Explicit.search(:updated_on => (time - 60 * 60))
+    assert_equal [], Explicit.search(:updated_on => (time + 60 * 60))
+  end
+
+  def test_search_attribute_boolean
+    # TODO:
+  end
+
+  def test_search_attribute_integer
+    # TODO
+  end
+end # TestAdapterExplicit

data/test/test_adapter_resource.rb

@@ -0,0 +1,25 @@
+require 'test_adapter'
+require 'files/resource_resource'
+
+class TestAdapterResource < TestAdapter
+  def setup
+    super
+    DataMapper.setup(:search, :adapter => 'sphinx', :config => @config, :managed => true)
+  end
+
+  def teardown
+    DataMapper.repository(:search).adapter.client.stop
+    super
+  end
+
+  def test_initialize
+    assert_nothing_raised{ Resource.new }
+  end
+
+  def test_search_properties
+    assert_equal Resource.all, Resource.search
+    assert_equal [Resource.first(:id => 2)], Resource.search(:name => 'two')
+    assert_equal [Resource.first(:id => 2)], Resource.search(:conditions => ['two'])
+  end
+end # TestAdapterResource
+

data/test/test_adapter_searchable.rb

@@ -0,0 +1,23 @@
+require 'test_adapter'
+require 'files/resource_searchable'
+
+class TestAdapterSearchable < TestAdapter
+  def setup
+    super
+    DataMapper.setup(:search, :adapter => 'sphinx', :config => @config, :managed => true)
+  end
+
+  def teardown
+    DataMapper.repository(:search).adapter.client.stop
+    super
+  end
+
+  def test_initialize
+    assert_nothing_raised{ Searchable.new }
+  end
+
+  def test_search
+    assert_equal Searchable.all, Searchable.search
+    assert_equal [Searchable.first(:id => 2)], Searchable.search(:name => 'two')
+  end
+end # TestAdapterSearchable

data/test/test_adapter_vanilla.rb

@@ -0,0 +1,46 @@
+require 'test_adapter'
+require 'files/resource_vanilla'
+require 'files/resource_storage_name'
+
+class TestAdapterVanilla < TestAdapter
+  def setup
+    super
+    DataMapper.setup(:default, :adapter => 'sphinx', :config => @config, :managed => true)
+  end
+
+  def teardown
+    DataMapper.repository(:default).adapter.client.stop
+    super
+  end
+
+  def test_initialize
+    assert_nothing_raised{ Vanilla.new }
+    assert_nothing_raised{ StorageName.new }
+  end
+
+  def test_all
+    assert_equal [{:id => 1}, {:id => 2}, {:id => 3}], Vanilla.all
+    assert_equal [{:id => 1}], Vanilla.all(:name => 'one')
+  end
+
+  def test_all_limit
+    assert_equal [{:id => 1}], Vanilla.all(:limit => 1)
+    assert_equal [{:id => 1}, {:id => 2}], Vanilla.all(:limit => 2)
+  end
+
+  def test_all_offset
+    assert_equal [{:id => 1}, {:id => 2}, {:id => 3}], Vanilla.all(:offset => 0)
+    assert_equal [{:id => 2}, {:id => 3}], Vanilla.all(:offset => 1)
+    assert_equal [], Vanilla.all(:offset => 3)
+  end
+
+  def test_first
+    assert_equal({:id => 1}, Vanilla.first(:name => 'one'))
+    assert_nil Vanilla.first(:name => 'missing')
+  end
+
+  def test_storage_name
+    assert_equal Vanilla.all, StorageName.all
+    assert_equal Vanilla.first, StorageName.first
+  end
+end

data/test/test_client.rb

@@ -1,24 +1,12 @@
-require 'helper'
-
-class TestClient < Test::Unit::TestCase
-  def setup
-    @config = Pathname.new(__FILE__).dirname.expand_path / 'data' / 'sphinx.conf'
-
-    # TODO: A little too brutal for me.
-    Dir.chdir(File.join(File.dirname(__FILE__), 'fixtures')) do
-      system 'mysql -u root dm_sphinx_adapter_test < item.sql' \
-        or raise %q{Tests require the dm_sphinx_adapter_test.items table.}
-    end
-  end
+require 'test_adapter'
 
+class TestClient < TestAdapter
   def test_initialize
-    assert_nothing_raised do
-      DataMapper::SphinxClient.new(@config)
-    end
+    assert_nothing_raised { DataMapper::Adapters::Sphinx::Client.new(@config) }
   end
 
   def test_index
-    client = DataMapper::SphinxClient.new(@config)
+    client = DataMapper::Adapters::Sphinx::Client.new(@config)
     assert_nothing_raised{ client.index }
     assert_nothing_raised{ client.index 'items' }
     assert_nothing_raised{ client.index '*' }
@@ -26,16 +14,16 @@ class TestClient < Test::Unit::TestCase
   end
 
   def test_managed_initialize
-    assert_nothing_raised do
-      DataMapper::SphinxManagedClient.new(@config)
-    end
+    assert_nothing_raised { DataMapper::Adapters::Sphinx::ManagedClient.new(@config) }
   end
 
   def test_search
     begin
-      client = DataMapper::SphinxManagedClient.new(@config)
+      client = DataMapper::Adapters::Sphinx::ManagedClient.new(@config)
       client.index
-      assert client.search('foo')
+      assert match = client.search('two')
+      assert_equal 1, match[:total]
+      assert_equal 2, match[:matches][0][:doc]
     ensure
       client.stop
     end