shanna-dm-sphinx-adapter 0.5 → 0.6

data/test/files/mysql5.sphinx.conf

@@ -0,0 +1,97 @@
+# 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

@@ -0,0 +1,26 @@
+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());

data/test/helper.rb

@@ -0,0 +1,51 @@
+$VERBOSE = false # Shitloads of warnings in dm :(
+require 'rubygems'
+require 'extlib'
+require 'extlib/hook'
+require 'pathname'
+require 'shoulda'
+require 'test/unit'
+
+base = Pathname.new(__FILE__).dirname + '..'
+%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('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 + 'mysql5.sphinx.conf'} --all --rotate`
+    raise %{Re-create index failed:\n #{indexer}} if indexer =~ /error|fatal/i
+
+    DataMapper.setup(:default, :adapter => 'mysql', :database => 'dm_sphinx_adapter_test')
+    sleep 1; # Give sphinx a chance to catch up before test runs.
+  end
+
+  # after :teardown do
+  def teardown
+    descendants = DataMapper::Resource.descendants.dup.to_a
+    while model = descendants.shift
+      descendants.concat(model.descendants) if model.respond_to?(:descendants)
+      Object.send(:remove_const, model.name.to_sym)
+      DataMapper::Resource.descendants.delete(model)
+    end
+  end
+end
+

data/test/test_adapter.rb

@@ -1,38 +1,84 @@
-require 'dm-sphinx-adapter'
-require 'test/unit'
-
-# DataMapper::Logger.new(STDOUT, :debug)
+require File.join(File.dirname(__FILE__), 'helper')
 
 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.}
+  context 'DM::A::Sphinx::Adapter class' do
+    setup do
+      DataMapper.setup(:adapter, :adapter => 'sphinx')
+      load File.join(File.dirname(__FILE__), 'files', 'model.rb')
+      @it       = repository(:adapter)
+      @resource = Item
     end
 
-    DataMapper.setup(:default, 'mysql://localhost/dm_sphinx_adapter_test')
+    context '#create' do
+      should 'should return zero records created' do
+        assert_equal 0, @it.create(create_resource)
+      end
+    end
 
-    @config = Pathname.new(__FILE__).dirname.expand_path / 'files' / 'sphinx.conf'
-    @client = DataMapper::Adapters::Sphinx::ManagedClient.new(:config => @config)
-    @client.index
-    sleep 1
-  end
+    context '#delete' do
+      should 'should return zero records deleted' do
+        assert_equal 0, @it.delete(create_resource)
+      end
+    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
+    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)
+        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
+        should 'return subset of objects for conditions' do
+          assert_equal [{:id => 2}], @it.read_many(query(:t_string => 'two'))
+        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 [], @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))
+        end
+      end
+    end
 
-  def teardown
-    @client.stop
-    sleep 1
+    context '#read_one' do
+      should 'return the first object of a #read_many' do
+        assert_equal @it.read_many(query).first, @it.read_one(query)
+
+        query = query(:t_string => 'two')
+        assert_equal @it.read_many(query).first, @it.read_one(query)
+      end
+    end
   end
+
+  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
+    end
 end

data/test/test_attribute.rb

@@ -0,0 +1,36 @@
+require File.join(File.dirname(__FILE__), 'helper')
+
+class TestAttribute < Test::Unit::TestCase
+  context 'DM::A::Sphinx::Attribute instance' do
+    should 'typecast DateTime to Integer'
+    should 'typecast Date to Integer'
+    should 'typecast Time to Integer'
+    should 'typecast BigDecimal to Float'
+  end
+
+  context 'DM::A::Sphinx::Resource#attribute class method' do
+    setup do
+      class ::Resource
+        include DataMapper::SphinxResource
+      end
+    end
+
+    DataMapper::Adapters::Sphinx::Attribute::TYPES.each do |type|
+      should "accept a #{type} type" do
+        assert_nothing_raised do
+          Resource.class_eval do
+            attribute :name, type
+          end
+        end
+      end
+    end
+
+    should 'raise ArgumentError for unsupported type' do
+      assert_raise(ArgumentError) do
+        Resource.class_eval do
+          attribute :name, Test::Unit::TestCase
+        end
+      end
+    end
+  end
+end

data/test/test_index.rb

@@ -0,0 +1,30 @@
+require File.join(File.dirname(__FILE__), 'helper')
+
+class TestIndex < Test::Unit::TestCase
+  context 'DM::A::Sphinx::Index instance' do
+    should 'respond to delta?'
+  end
+
+  context 'DM::A::Sphinx::Resource class' do
+    setup do
+      class ::Resource
+        include DataMapper::SphinxResource
+      end
+    end
+
+    context '#index method' do
+      should 'append an index' do
+        assert_nothing_raised do
+          Resource.class_eval do
+            index :name
+          end
+        end
+      end
+    end
+
+    context '#sphinx_indexes method' do
+      should 'return DM::A::Sphinx::Index objects'
+      should 'return delta indexes at the end of the list'
+    end
+  end
+end

data/test/test_query.rb

@@ -1,47 +1,62 @@
-require 'test/unit'
-require 'dm-sphinx-adapter'
-require 'files/resource_explicit'
+require File.join(File.dirname(__FILE__), 'helper')
 
 class TestQuery < Test::Unit::TestCase
-  def setup
-    DataMapper.setup(:default, :adapter => 'sphinx')
-    @repository = repository(:default)
-  end
+  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)
+      @resource = Item
+    end
 
-  def test_initialize
-    assert_nothing_raised{ query }
-    assert_equal '', query.to_s
-  end
+    should 'treat nil operator as extended field match' do
+      assert_equal '@t_string "foo"', query_string(:t_string => 'foo')
+    end
 
-  def test_eql
-    assert_equal '@name "foo"',     query(:name => 'foo').to_s
-    assert_equal '@name "foo"',     query(:name.eql => 'foo').to_s
-    assert_equal '@name "foo"',     query(:name.like => 'foo').to_s
-    assert_equal '@name "foo bar"', query(:name => %w(foo bar)).to_s
-  end
+    should 'treat .eql operator as extended field match' do
+      assert_equal '@t_string "foo"', query_string(:t_string.eql => 'foo')
+    end
 
-  def test_not
-    assert_equal '@name -"foo"',     query(:name.not => 'foo').to_s
-    assert_equal '@name -"foo bar"', query(:name.not => %w(foo bar)).to_s
-  end
+    should 'treat .like operator as extended field match' do
+      assert_equal '@t_string "foo"', query_string(:t_string.like => 'foo')
+    end
 
-  def test_in
-    assert_equal '@name ("foo" | "bar")', query(:name.in => %w{foo bar}).to_s
-  end
+    should 'treat Array as extended field AND match' do
+      assert_equal '@t_string "foo bar"', query_string(:t_string => %w{foo bar})
+    end
 
-  def test_and
-    # When is DM going to switch conditions to an array? :(
-    assert /(?:@name "b" )?@name "a"(?: @name "b")?/.match(query(:name.eql => 'a', :name.eql => 'b').to_s)
-  end
+    should 'treat .not opeartor as extended field NOT match' do
+      assert_equal '@t_string -"foo"', query_string(:t_string.not => 'foo')
+    end
+
+    should 'treat Array .not operator as extended field NOT match' do
+      assert_equal '@t_string -"foo bar"', query_string(:t_string.not => %w{foo bar})
+    end
 
-  def test_raw
-    assert_equal '"foo bar"~10', query(:conditions => ['"foo bar"~10']).to_s
+    should 'treat .in operator as extended OR match' do
+      assert_equal '@t_string ("foo" | "bar")', query_string(:t_string.in => %w{foo bar})
+    end
+
+    should 'treat multiple .eql operators as AND search' do
+      # When is DM going to switch conditions to an array? :(
+      assert /(?:@t_string "b" )?@t_string "a"(?: @t_string "b")?/.match(
+        query_string(:t_string.eql => 'a', :t_string.eql => 'b')
+      )
+    end
+
+    should 'leave raw conditions as they are' do
+      assert_equal '"foo bar"~10', query_string(:conditions => ['"foo bar"~10'])
+    end
   end
 
   protected
     def query(conditions = {})
       DataMapper::Adapters::Sphinx::Query.new(
-        DataMapper::Query.new(@repository, Explicit, conditions)
+        DataMapper::Query.new(@adapter, @resource, conditions)
       )
     end
-end # TestQuery
+
+    def query_string(conditions = {})
+      query(conditions).to_s
+    end
+end

data/test/test_resource.rb

@@ -0,0 +1,17 @@
+require File.join(File.dirname(__FILE__), 'helper')
+
+class TestResource < Test::Unit::TestCase
+  context 'DM::A::Sphinx::Resource module' do
+    setup do
+      class ::Resource
+        include DataMapper::SphinxResource
+      end
+    end
+
+    [:index, :sphinx_indexes, :attribute, :sphinx_attributes].each do |method|
+      should "respond to #{method}" do
+        assert_respond_to Resource, method
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: shanna-dm-sphinx-adapter
 version: !ruby/object:Gem::Version 
-  version: "0.5"
+  version: "0.6"
 platform: ruby
 authors: 
 - Shane Hanna
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-01 00:00:00 -08:00
+date: 2008-12-13 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -21,15 +21,6 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.9.7
     version: 
-- !ruby/object:Gem::Dependency 
-  name: riddle
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: "0.9"
-    version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
   version_requirement: 
@@ -61,32 +52,25 @@ files:
 - lib/dm-sphinx-adapter.rb
 - lib/dm-sphinx-adapter/adapter.rb
 - lib/dm-sphinx-adapter/attribute.rb
-- lib/dm-sphinx-adapter/client.rb
-- lib/dm-sphinx-adapter/config.rb
-- lib/dm-sphinx-adapter/config_parser.rb
 - lib/dm-sphinx-adapter/index.rb
 - lib/dm-sphinx-adapter/query.rb
 - lib/dm-sphinx-adapter/resource.rb
-- test/files/dm_sphinx_adapter_test.sql
-- test/files/resource_explicit.rb
-- test/files/resource_resource.rb
-- test/files/resource_searchable.rb
-- test/files/resource_storage_name.rb
-- test/files/resource_vanilla.rb
-- test/files/sphinx.conf
+- 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_adapter_explicit.rb
-- test/test_adapter_resource.rb
-- test/test_adapter_searchable.rb
-- test/test_adapter_vanilla.rb
-- test/test_client.rb
-- test/test_config.rb
-- test/test_config_parser.rb
+- test/test_attribute.rb
+- test/test_index.rb
 - test/test_query.rb
-- test/test_type_attribute.rb
-- test/test_type_index.rb
+- test/test_resource.rb
 has_rdoc: true
-homepage: http://rubyforge.org/projects/dm-sphinx/
+homepage: http://dm-sphinx.rubyforge.org
 post_install_message: 
 rdoc_options: 
 - --main
@@ -114,13 +98,7 @@ specification_version: 2
 summary: A DataMapper Sphinx adapter.
 test_files: 
 - test/test_adapter.rb
-- test/test_adapter_explicit.rb
-- test/test_adapter_resource.rb
-- test/test_adapter_searchable.rb
-- test/test_adapter_vanilla.rb
-- test/test_client.rb
-- test/test_config.rb
-- test/test_config_parser.rb
+- test/test_attribute.rb
+- test/test_index.rb
 - test/test_query.rb
-- test/test_type_attribute.rb
-- test/test_type_index.rb
+- test/test_resource.rb

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

@@ -1,84 +0,0 @@
-require 'rubygems'
-
-gem 'riddle', '~> 0.9'
-require 'riddle'
-
-module DataMapper
-  module Adapters
-    module Sphinx
-      class Client
-        def initialize(uri_or_options = {})
-          @config = Sphinx::Config.new(uri_or_options)
-        end
-
-        ##
-        # 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)
-
-          client = Riddle::Client.new(@config.address, @config.port)
-          options.each{|k, v| client.method("#{k}=".to_sym).call(v) if client.respond_to?("#{k}=".to_sym)}
-          client.query(query, indexes.to_s)
-        end
-
-        ##
-        # Index one or more indexes.
-        #
-        # @param [Array, String] indexes Defaults to --all if indexes is nil or '*'.
-        def index(indexes = nil, options = {})
-          indexes = indexes.join(' ') if indexes.kind_of?(Array)
-
-          command = @config.indexer_bin
-          command << " --rotate" if running?
-          command << ((indexes.nil? || indexes == '*') ? ' --all' : " #{indexes.to_s}")
-          warn "Sphinx: Indexer #{$1}" if `#{command}` =~ /(?:error|fatal|warning):?\s*([^\n]+)/i
-        end
-
-        protected
-
-          ##
-          # Is the client running.
-          #
-          # Tests the address and port set in the configuration file.
-          def running?
-            !!TCPSocket.new(@config.address, @config.port) rescue nil
-          end
-      end # Client
-
-      ##
-      # Managed searchd if you don't already have god/monit doing the job for you.
-      #
-      # Requires you have daemon_controller installed.
-      # @see http://github.com/FooBarWidget/daemon_controller/tree/master
-      class ManagedClient < Client
-        def initialize(url_or_options = {})
-          super
-
-          # Fire up searchd.
-          require 'daemon_controller'
-          @client = DaemonController.new(
-            :identifier    => 'Sphinx searchd',
-            :start_command => @config.searchd_bin,
-            :stop_command  => "#{@config.searchd_bin} --stop",
-            :ping_command  => method(:running?),
-            :pid_file      => @config.pid_file,
-            :log_file      => @config.log
-          )
-        end
-
-        def search(*args)
-          @client.connect{super}
-        end
-
-        def stop
-          @client.stop if @client.running?
-        end
-      end # ManagedClient
-    end # Sphinx
-  end # Adapters
-end # DataMapper