shanna-dm-sphinx-adapter 0.4 → 0.5

data/History.txt

@@ -1,3 +1,10 @@
+=== 0.5 / 2008-12-01
+
+  * Moved sphinx extended query string generator into a class of its own.
+  * Improved generated extended query syntax and added tests.
+  * Support for sphinx "" phrase search operator (dm conditions as array).
+  * Support for sphinx | OR operator (dm conditions using {:field.in => %w{}}).
+
 === 0.4 / 2008-11-21
 
   * Fixed broken dm-is-searchable support.

data/Manifest.txt

@@ -11,6 +11,7 @@ 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
@@ -27,5 +28,6 @@ test/test_adapter_vanilla.rb
 test/test_client.rb
 test/test_config.rb
 test/test_config_parser.rb
+test/test_query.rb
 test/test_type_attribute.rb
 test/test_type_index.rb

data/Rakefile

@@ -3,7 +3,7 @@
 require 'rubygems'
 require 'hoe'
 
-Hoe.new('dm-sphinx-adapter', '0.4') do |p|
+Hoe.new('dm-sphinx-adapter', '0.5') 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.4"
+  s.version = "0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Shane Hanna"]
-  s.date = %q{2008-11-24}
+  s.date = %q{2008-12-01}
   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/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/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", "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_type_attribute.rb", "test/test_type_index.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/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", "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_query.rb", "test/test_type_attribute.rb", "test/test_type_index.rb"]
   s.has_rdoc = true
   s.homepage = %q{http://rubyforge.org/projects/dm-sphinx/}
   s.rdoc_options = ["--main", "README.txt"]
@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
   s.rubyforge_project = %q{dm-sphinx-adapter}
   s.rubygems_version = %q{1.3.0}
   s.summary = %q{A DataMapper Sphinx adapter.}
-  s.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_type_attribute.rb", "test/test_type_index.rb"]
+  s.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_query.rb", "test/test_type_attribute.rb", "test/test_type_index.rb"]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

data/lib/dm-sphinx-adapter.rb

@@ -11,6 +11,7 @@ dir = Pathname(__FILE__).dirname.expand_path / 'dm-sphinx-adapter'
 require dir / 'config'
 require dir / 'config_parser'
 require dir / 'client'
+require dir / 'query'
 require dir / 'adapter'
 require dir / 'index'
 require dir / 'attribute'

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

@@ -100,7 +100,7 @@ module DataMapper
           # @param [DataMapper::Query]
           def read(query)
             from    = indexes(query.model).map{|index| index.name}.join(', ')
-            search  = search_query(query)
+            search  = Sphinx::Query.new(query).to_s
             options = {
               :match_mode => :extended, # TODO: Modes!
               :filters    => search_filters(query) # By attribute.
@@ -124,41 +124,6 @@ module DataMapper
             res[:matches].map{|doc| {:id => doc[:doc]}}
           end
 
-          ##
-          # Sphinx search query string from properties (fields).
-          #
-          # If the query has no conditions an '' empty string will be generated possibly triggering Sphinx's full scan
-          # mode.
-          #
-          # @see    http://www.sphinxsearch.com/doc.html#searching
-          # @see    http://www.sphinxsearch.com/doc.html#conf-docinfo
-          # @param  [DataMapper::Query]
-          # @return [String]
-          def search_query(query)
-            match  = []
-
-            if query.conditions.empty?
-              match << ''
-            else
-              # TODO: This needs to be altered by match mode since not everything is supported in different match modes.
-              query.conditions.each do |operator, property, value|
-                next if property.kind_of? Sphinx::Attribute # Filters are added elsewhere.
-                # TODO: Why does my gem riddle differ from the vendor riddle that comes with ts?
-                # escaped_value = Riddle.escape(value)
-                escaped_value = value.to_s.gsub(/[\(\)\|\-!@~"&\/]/){|char| "\\#{char}"}
-                match << case operator
-                  when :eql, :like then "@#{property.field} #{escaped_value}"
-                  when :not        then "@#{property.field} -#{escaped_value}"
-                  when :lt, :gt, :lte, :gte
-                    DataMapper.logger.warn('Sphinx: Query properties with lt, gt, lte, gte are treated as .eql')
-                    "@#{name} #{escaped_value}"
-                  when :raw
-                    "#{property}"
-                end
-              end
-            end
-            match.join(' ')
-          end
 
           ##
           # Sphinx search query filters from attributes.
@@ -172,10 +137,7 @@ module DataMapper
               filters << case operator
                 when :eql, :like then Riddle::Client::Filter.new(attribute.name.to_s, filter_value(value))
                 when :not        then Riddle::Client::Filter.new(attribute.name.to_s, filter_value(value), true)
-                else
-                  error = "Sphinx: Query attributes do not support the #{operator} operator"
-                  DataMapper.logger.error(error)
-                  raise error # TODO: RuntimeError subclass and more information about the actual query.
+                else raise NotImplementedError.new("Sphinx: Query attributes do not support the #{operator} operator")
               end
             end
             filters

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

@@ -7,8 +7,6 @@ module DataMapper
   module Adapters
     module Sphinx
       class Client
-        include Extlib::Assertions
-
         def initialize(uri_or_options = {})
           @config = Sphinx::Config.new(uri_or_options)
         end

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

@@ -0,0 +1,61 @@
+module DataMapper
+  module Adapters
+    module Sphinx
+
+      ##
+      # Sphinx extended search query string from DataMapper query.
+      class Query
+        include Extlib::Assertions
+
+        ##
+        # Sphinx extended search query string from DataMapper query.
+        #
+        # If the query has no conditions an '' empty string will be generated possibly triggering Sphinx's full scan
+        # mode.
+        #
+        # @see    http://www.sphinxsearch.com/doc.html#extended-syntax
+        # @see    http://www.sphinxsearch.com/doc.html#searching
+        # @see    http://www.sphinxsearch.com/doc.html#conf-docinfo
+        # @param  [DataMapper::Query]
+        def initialize(query)
+          assert_kind_of 'query', query, DataMapper::Query
+          @query  = []
+
+          if query.conditions.empty?
+            @query << ''
+          else
+            query.conditions.each do |operator, property, value|
+              next if property.kind_of? Sphinx::Attribute # Filters are added elsewhere.
+              normalized = normalize_value(value)
+              @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 :raw        then "#{property}"
+                else raise NotImplementedError.new("Sphinx: Query fields do not support the #{operator} operator")
+              end
+            end
+          end
+        end
+
+        ##
+        # The extended sphinx query string.
+        # @return [String]
+        def to_s
+          @query.join(' ')
+        end
+
+        protected
+          ##
+          # Normalize and escape DataMapper query value(s) to escaped sphinx query values.
+          # @param [String, Array] value The query value.
+          # @return [Array]
+          def normalize_value(value)
+            [value].flatten.map do |v|
+              v.to_s.gsub(/[\(\)\|\-!@~"&\/]/){|char| "\\#{char}"}
+            end
+          end
+      end # Query
+    end # Sphinx
+  end # Adapters
+end # DataMapper

data/test/test_query.rb

@@ -0,0 +1,47 @@
+require 'test/unit'
+require 'dm-sphinx-adapter'
+require 'files/resource_explicit'
+
+class TestQuery < Test::Unit::TestCase
+  def setup
+    DataMapper.setup(:default, :adapter => 'sphinx')
+    @repository = repository(:default)
+  end
+
+  def test_initialize
+    assert_nothing_raised{ query }
+    assert_equal '', query.to_s
+  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
+
+  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
+
+  def test_in
+    assert_equal '@name ("foo" | "bar")', query(:name.in => %w{foo bar}).to_s
+  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
+
+  def test_raw
+    assert_equal '"foo bar"~10', query(:conditions => ['"foo bar"~10']).to_s
+  end
+
+  protected
+    def query(conditions = {})
+      DataMapper::Adapters::Sphinx::Query.new(
+        DataMapper::Query.new(@repository, Explicit, conditions)
+      )
+    end
+end # TestQuery

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: shanna-dm-sphinx-adapter
 version: !ruby/object:Gem::Version 
-  version: "0.4"
+  version: "0.5"
 platform: ruby
 authors: 
 - Shane Hanna
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-24 00:00:00 -08:00
+date: 2008-12-01 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -65,6 +65,7 @@ files:
 - 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
@@ -81,6 +82,7 @@ files:
 - test/test_client.rb
 - test/test_config.rb
 - test/test_config_parser.rb
+- test/test_query.rb
 - test/test_type_attribute.rb
 - test/test_type_index.rb
 has_rdoc: true
@@ -119,5 +121,6 @@ test_files:
 - test/test_client.rb
 - test/test_config.rb
 - test/test_config_parser.rb
+- test/test_query.rb
 - test/test_type_attribute.rb
 - test/test_type_index.rb