dm-sphinx-adapter 0.5 → 0.6

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: 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 +11:00
+date: 2008-12-13 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,16 +22,6 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.9.7
     version: 
-- !ruby/object:Gem::Dependency 
-  name: riddle
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: "0.9"
-    version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
   type: :development
@@ -64,30 +54,23 @@ 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://dm-sphinx.rubyforge.org
 post_install_message: 
@@ -111,19 +94,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: dm-sphinx-adapter
-rubygems_version: 1.3.0
+rubygems_version: 1.3.1
 signing_key: 
 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,109 +0,0 @@
-require 'rubygems'
-
-gem 'riddle', '~> 0.9'
-require 'riddle'
-
-module DataMapper
-  module Adapters
-    module Sphinx
-      # Client wrapper for Riddle::Client.
-      #
-      # * Simple interface to +searchd+ *and* +indexer+.
-      # * Can read +searchd+ configuration options from your sphinx configuration file.
-      # * Managed +searchd+ using +daemon_controller+ for on demand daemon control in development.
-      class Client
-
-        # ==== Parameters
-        # uri_or_options<URI, DataObject::URI, Addressable::URI, String, Hash, Pathname>::
-        #   DataMapper uri or options hash.
-        def initialize(uri_or_options = {})
-          @config = Sphinx::Config.new(uri_or_options)
-        end
-
-        # Search one or more indexes.
-        #
-        # ==== See
-        # * Riddle::Client
-        #
-        # ==== Parameters
-        # query<String>:: A sphinx query string.
-        # indexes<Array, String>:: Indexes to search. Default is '*' all.
-        # options<Hash>:: Any attributes supported by the Riddle::Client.
-        #
-        # ==== Returns
-        # Hash:: Riddle::Client#query response struct.
-        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.
-        #
-        # ==== Parameters
-        # indexes<Array, String>:: Indexes to index (and rotate). Defaults to --all if indexes is +nil+ or '*'.
-        def index(indexes = nil)
-          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 a +searchd+ daemon running on the configured address and port.
-          #
-          # ==== Notes
-          # This is a simple TCPSocket test. It may not be your +searchd+ deamon or even a +searchd+ daemon at all if
-          # your configuration is wrong or another +searchd+ daemon is listen on that port already.
-          #
-          # ==== Returns
-          # Boolean
-          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
-
-        # ==== See
-        # * DataMapper::Adapters::Sphinx::Client#new
-        def initialize(url_or_options = {})
-          super
-
-          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
-
-        # Start the +searchd+ daemon if it isn't already running then search.
-        #
-        # ==== See
-        # * DataMapper::Adapters::Sphinx::Client#search
-        def search(*args)
-          @client.connect{super}
-        end
-
-        # Stop the +searchd+ daemon if it's running.
-        def stop
-          @client.stop if @client.running?
-        end
-      end # ManagedClient
-    end # Sphinx
-  end # Adapters
-end # DataMapper

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

@@ -1,122 +0,0 @@
-require 'rubygems'
-
-gem 'extlib', '~> 0.9.7'
-require 'extlib'
-
-module DataMapper
-  module Adapters
-    module Sphinx
-      class Config
-        include Extlib::Assertions
-
-        # Configuration option.
-        attr_reader :config, :address, :log, :port
-
-        # Sphinx configuration options.
-        #
-        # This class just gives you access to handy searchd {} configuration options. If a sphinx configuration file
-        # is passed and can be parsed +searchd+ options will be set straight from the file.
-        #
-        # ==== Notes
-        # Option precedence is:
-        # * The options hash.
-        # * The configuration file.
-        # * Sphinx defaults.
-        #
-        # ==== See
-        # http://www.sphinxsearch.com/doc.html#confgroup-searchd
-        #
-        # ==== Parameters
-        # uri_or_options<URI, DataObject::URI, Addressable::URI, String, Hash, Pathname>::
-        #   DataMapper uri or options hash.
-        def initialize(uri_or_options = {})
-          assert_kind_of 'uri_or_options', uri_or_options, Addressable::URI, DataObjects::URI, Hash, String, Pathname
-
-          options   = normalize_options(uri_or_options)
-          config    = parse_config("#{options[:path]}") # Pathname#to_s is broken?
-          @address  = options[:host]     || config['address']  || '0.0.0.0'
-          @port     = options[:port]     || config['port']     || 3312
-          @log      = options[:log]      || config['log']      || 'searchd.log'
-          @pid_file = options[:pid_file] || config['pid_file']
-        end
-
-        # Indexer binary full path name and config argument.
-        #
-        # ==== Parameters
-        # use_config<Boolean>:: Return <tt>--config path/to/config.conf</tt> as part of string. Default +true+.
-        #
-        # ==== Returns
-        # String
-        def indexer_bin(use_config = true)
-          path = 'indexer' # TODO: Real.
-          path << " --config #{config}" if config
-          path
-        end
-
-        # Searchd binary full path name and config argument.
-        #
-        # ==== Parameters
-        # use_config<Boolean>:: Return <tt>--config path/to/config.conf</tt> as part of string. Default +true+.
-        #
-        # ==== Returns
-        # String
-        def searchd_bin(use_config = true)
-          path = 'searchd' # TODO: Real.
-          path << " --config #{config}" if config
-          path
-        end
-
-        # Full path to pid_file.
-        #
-        # ==== Raises
-        # RuntimeError:: If a pid file was not read or set. pid_file is a mandatory searchd option in a sphinx
-        #   configuration file.
-        def pid_file
-          @pid_file or raise "Mandatory pid_file option missing from searchd configuration."
-        end
-
-        protected
-          # Coerce +uri_or_options+ into a +Hash+ of options.
-          #
-          # ==== Parameters
-          # uri_or_options<URI, DataObject::URI, Addressable::URI, String, Hash, Pathname>::
-          #   DataMapper uri or options hash.
-          #
-          # ==== Returns
-          # Hash
-          def normalize_options(uri_or_options)
-            case uri_or_options
-              when String, Addressable::URI then DataObjects::URI.parse(uri_or_options).attributes
-              when DataObjects::URI         then uri_or_options.attributes
-              when Pathname                 then {:path => uri_or_options}
-              else
-                uri_or_options[:path] ||= uri_or_options.delete(:config) || uri_or_options.delete(:database)
-                uri_or_options
-            end
-          end
-
-          # Reads your sphinx configuration file if given.
-          #
-          # Also searches default sphinx configuration locations for a config file to parse.
-          #
-          # ==== See
-          # * DataMapper::Adapters::Sphinx::ConfigParser
-          #
-          # ==== Parameters
-          # path<String>:: Path to your configuration file.
-          #
-          # ==== Returns
-          # Hash
-          def parse_config(path)
-            paths = []
-            paths.push(path, path.gsub(%r{^/}, './'), path.gsub(%r{^\./}, '/')) unless path.blank?
-            paths.push('/usr/local/etc/sphinx.conf', './sphinx.conf')
-            paths.map!{|path| Pathname.new(path).expand_path}
-
-            @config = paths.find{|path| path.readable? && `#{indexer_bin} --config #{path}` !~ /fatal|error/i}
-            @config ? ConfigParser.parse(@config) : {}
-          end
-      end # Config
-    end # Sphinx
-  end # Adapters
-end # DataMapper