dm-sphinx-adapter 0.3 → 0.4

data/Manifest.txt

@@ -14,6 +14,8 @@ lib/dm-sphinx-adapter/sphinx_resource.rb
 test/data/sphinx.conf
 test/fixtures/item.rb
 test/fixtures/item.sql
+test/fixtures/item_resource_explicit.rb
+test/fixtures/item_resource_only.rb
 test/helper.rb
 test/test_client.rb
 test/test_config.rb

data/Rakefile

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

data/dm-sphinx-adapter.gemspec

@@ -1,20 +1,22 @@
+# -*- encoding: utf-8 -*-
+
 Gem::Specification.new do |s|
   s.name = %q{dm-sphinx-adapter}
-  s.version = "0.3"
+  s.version = "0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Shane Hanna"]
-  s.date = %q{2008-11-18}
+  s.date = %q{2008-11-20}
   s.description = %q{}
   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/sphinx_adapter.rb", "lib/dm-sphinx-adapter/sphinx_attribute.rb", "lib/dm-sphinx-adapter/sphinx_client.rb", "lib/dm-sphinx-adapter/sphinx_config.rb", "lib/dm-sphinx-adapter/sphinx_index.rb", "lib/dm-sphinx-adapter/sphinx_resource.rb", "test/data/sphinx.conf", "test/fixtures/item.rb", "test/fixtures/item.sql", "test/helper.rb", "test/test_client.rb", "test/test_config.rb", "test/test_search.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/sphinx_adapter.rb", "lib/dm-sphinx-adapter/sphinx_attribute.rb", "lib/dm-sphinx-adapter/sphinx_client.rb", "lib/dm-sphinx-adapter/sphinx_config.rb", "lib/dm-sphinx-adapter/sphinx_index.rb", "lib/dm-sphinx-adapter/sphinx_resource.rb", "test/data/sphinx.conf", "test/fixtures/item.rb", "test/fixtures/item.sql", "test/fixtures/item_resource_explicit.rb", "test/fixtures/item_resource_only.rb", "test/helper.rb", "test/test_client.rb", "test/test_config.rb", "test/test_search.rb"]
   s.has_rdoc = true
   s.homepage = %q{A Sphinx DataMapper adapter.}
   s.rdoc_options = ["--main", "README.txt"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{dm-sphinx-adapter}
-  s.rubygems_version = %q{1.2.0}
+  s.rubygems_version = %q{1.3.0}
   s.summary = %q{}
   s.test_files = ["test/test_client.rb", "test/test_config.rb", "test/test_search.rb"]
 
@@ -22,7 +24,7 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 2
 
-    if current_version >= 3 then
+    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_runtime_dependency(%q<riddle>, ["~> 0.9"])
       s.add_development_dependency(%q<hoe>, [">= 1.8.2"])

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

@@ -87,8 +87,7 @@ module DataMapper
         def indexes(model)
           indexes = model.sphinx_indexes(repository(self.name).name) if model.respond_to?(:sphinx_indexes)
           if indexes.nil? or indexes.empty?
-            # TODO: Is it resource_naming_convention.call(model.name) ?
-            indexes = [SphinxIndex.new(model, Extlib::Inflection.tableize(model.name))]
+            indexes = [SphinxIndex.new(model, model.storage_name)]
           end
           indexes
         end
@@ -110,10 +109,11 @@ module DataMapper
           search  = search_query(query)
           options = {
             :match_mode => :extended, # TODO: Modes!
-            :limit      => (query.limit  ? query.limit.to_i : 0),
-            :offset     => (query.offset ? query.offset.to_i : 0),
             :filters    => search_filters(query) # By attribute.
           }
+          options[:limit]  = query.limit.to_i  if query.limit
+          options[:offset] = query.offset.to_i if query.offset
+
           if order = search_order(query)
             options.update(
               :sort_mode => :extended,
@@ -127,7 +127,7 @@ module DataMapper
           DataMapper.logger.info(
             %q{Sphinx (%.3f): search '%s' in '%s' found %d documents} % [res[:time], search, from, res[:total]]
           )
-          res[:matches].map{|doc| doc[:doc]}
+          res[:matches].map{|doc| {:id => doc[:doc]}}
         end
 
         ##

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

@@ -6,10 +6,17 @@ require 'riddle'
 module DataMapper
   class SphinxClient
     def initialize(uri_or_options)
+      # TODO: Documentation.
       @config = SphinxConfig.new(uri_or_options)
     end
 
-    # TODO: What about filters?
+    ##
+    # Search one or more indexes.
+    #
+    # @param [String] query The sphinx query string.
+    # @param [Array, String] indexes A string or array of indexes to search. Default is '*' (all).
+    # @param [Hash] options Any options you'd like to pass through to Riddle::Client.
+    # @see   Riddle::Client
     def search(query, indexes = '*', options = {})
       indexes = indexes.join(' ') if indexes.kind_of?(Array)
 
@@ -64,9 +71,7 @@ module DataMapper
     end
 
     def search(*args)
-      @client.connect do
-        super *args
-      end
+      @client.connect{super}
     end
 
     def stop

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

@@ -13,7 +13,20 @@ module DataMapper
     # This class just gives you access to handy searchd {} configuration options. It does not validate your
     # configuration file beyond basic syntax checking.
     def initialize(uri_or_options = {})
-      @config = []
+      @config  = []
+      @searchd = {
+        'address'         => '0.0.0.0',
+        'log'             => 'searchd.log',
+        'max_children'    => 0,
+        'max_matches'     => 1000,
+        'pid_file'        => nil,
+        'port'            => 3312,
+        'preopen_indexes' => 0,
+        'query_log'       => '',
+        'read_timeout'    => 5,
+        'seamless_rotate' => 1,
+        'unlink_old'      => 1
+      }
 
       path = case uri_or_options
         when Addressable::URI, DataObjects::URI then uri_or_options.path
@@ -75,26 +88,8 @@ module DataMapper
     ##
     # Searchd configuration options.
     #
-    # Defaults will be applied but no validation is done.
-    #
     # @see http://www.sphinxsearch.com/doc.html#confgroup-searchd
     def searchd
-      unless @searchd
-        searchd = @blocks.find{|c| c['type'] =~ /searchd/i} || {}
-        @searchd = {
-          'address'         => '0.0.0.0',
-          'log'             => 'searchd.log',
-          'max_children'    => 0,
-          'max_matches'     => 1000,
-          'pid_file'        => nil,
-          'port'            => 3312,
-          'preopen_indexes' => 0,
-          'query_log'       => '',
-          'read_timeout'    => 5,
-          'seamless_rotate' => 1,
-          'unlink_old'      => 1
-        }.update(searchd)
-      end
       @searchd
     end
 
@@ -105,6 +100,7 @@ module DataMapper
       #
       # @param [String] path Searches path, ./path, /path, /usr/local/etc/sphinx.conf, ./sphinx.conf in that order.
       def parse(path = '')
+        # TODO: Three discrete things going on here, should be three subs.
         paths = [
           path,
           path.gsub(%r{^/}, './'),
@@ -121,7 +117,11 @@ module DataMapper
         source.gsub!(/\r\n|\r|\n/, "\n") # Everything in \n
         source.gsub!(/\s*\\\n\s*/, ' ')  # Remove unixy line wraps.
         @in = StringScanner.new(source)
-        blocks(@blocks = [])
+        blocks(blocks = [])
+        @in = nil
+
+        searchd = blocks.find{|c| c['type'] =~ /searchd/i} || {}
+        @searchd.update(searchd)
       end
 
     private

data/test/fixtures/item.rb

@@ -4,27 +4,10 @@ require 'zlib'
 
 class Item
   include DataMapper::Resource
-  include DataMapper::SphinxResource
-
-  property :id, Integer, :key => true, :writer => :private
-  property :name, String, :nullable => false, :length => 50
-  property :likes, Text
+  property :id,         Serial
+  property :name,       String, :nullable => false, :length => 50
+  property :likes,      Text
   property :updated_on, DateTime
 
   is :searchable
-  repository(:search) do
-    index :items
-    index :items_delta, :delta => true
-
-    # TODO: More attributes.
-    attribute :updated, DateTime
-  end
-
-  # I'm using my own (unreleased) Digest::CRC32 DataMapper::Type normally.
-  after :name, :set_id
-
-  protected
-    def set_id
-      attribute_set(:id, Zlib.crc32(name))
-    end
-end
+end # Item

data/test/fixtures/item.sql

@@ -1,5 +1,4 @@
 drop table if exists delta;
-
 create table delta (
   name varchar(50) not null,
   updated_on datetime,
@@ -7,9 +6,8 @@ create table delta (
 ) engine=innodb default charset=utf8;
 
 drop table if exists items;
-
 create table items (
-  id int(11) not null,
+  id int(11) not null auto_increment,
   name varchar(50) not null,
   likes text not null,
   updated_on datetime,
@@ -17,7 +15,7 @@ create table items (
   index (updated_on)
 ) engine=innodb default charset=utf8;
 
-insert into items (id, name, likes, updated_on) values
-  (CRC32('foo'), 'foo', 'I really like foo!', now()),
-  (CRC32('bar'), 'bar', 'I really like bar!', now()),
-  (CRC32('baz'), 'baz', 'I really like baz!', now());
+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());

data/test/fixtures/item_resource_explicit.rb

@@ -0,0 +1,26 @@
+require 'rubygems'
+require 'dm-is-searchable'
+require 'zlib'
+
+class ItemResourceExplicit
+  include DataMapper::Resource
+  include DataMapper::SphinxResource
+
+  property :id,         Serial
+  property :name,       String, :nullable => false, :length => 50
+  property :likes,      Text
+  property :updated_on, DateTime
+
+  is :searchable
+  repository(:search) do
+    properties(:search).clear
+    index     :items
+    index     :items_delta, :delta => true
+    property  :name,    String
+    attribute :updated, DateTime
+  end
+
+  def self.default_storage_name
+    'item'
+  end
+end # ItemResourceExplicit

data/test/fixtures/item_resource_only.rb

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

data/test/helper.rb

@@ -1,4 +1,7 @@
 require 'dm-sphinx-adapter'
 require 'test/fixtures/item'
+require 'test/fixtures/item_resource_only'
+require 'test/fixtures/item_resource_explicit'
 require 'test/unit'
 
+# DataMapper::Logger.new(STDOUT, :debug)

data/test/test_search.rb

@@ -1,5 +1,6 @@
 require 'helper'
 
+
 class TestSearch < Test::Unit::TestCase
   def setup
     # TODO: A little too brutal for me.
@@ -27,11 +28,25 @@ class TestSearch < Test::Unit::TestCase
   def test_search
     assert_nothing_raised{ Item.search }
     assert_nothing_raised{ Item.search(:name => 'foo') }
+    assert !Item.search(:name => 'foo').empty?
+  end
+
+  def test_search_resource_only
+    assert_nothing_raised{ ItemResourceOnly.search }
+    assert_nothing_raised{ ItemResourceOnly.search(:name => 'foo') }
+    assert !ItemResourceOnly.search(:name => 'foo').empty?
+  end
+
+  def test_search_resource_explicit
+    assert_nothing_raised{ ItemResourceExplicit.search }
+    assert_nothing_raised{ ItemResourceExplicit.search(:name => 'foo') }
+    assert !ItemResourceExplicit.search(:name => 'foo').empty?
   end
 
   def test_search_attributes
+    # Attributes that exist only in :search and the sphinx.
     assert_nothing_raised do
-      Item.search(:updated => (Time.now - 10 .. Time.now + 10))
+      ItemResourceExplicit.search(:updated => (Time.now - 10 .. Time.now + 10))
     end
   end
 end # TestSearch

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dm-sphinx-adapter
 version: !ruby/object:Gem::Version 
-  version: "0.3"
+  version: "0.4"
 platform: ruby
 authors: 
 - Shane Hanna
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-18 00:00:00 +11:00
+date: 2008-11-20 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -71,6 +71,8 @@ files:
 - test/data/sphinx.conf
 - test/fixtures/item.rb
 - test/fixtures/item.sql
+- test/fixtures/item_resource_explicit.rb
+- test/fixtures/item_resource_only.rb
 - test/helper.rb
 - test/test_client.rb
 - test/test_config.rb