dm-sphinx-adapter 0.7 → 0.7.1

data/Rakefile

@@ -1,22 +1,49 @@
-# -*- ruby -*-
-
 require 'rubygems'
-require 'hoe'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name        = "dm-sphinx-adapter"
+    gem.summary     = %q{A DataMapper Sphinx adapter.}
+    gem.email       = "shane.hanna@gmail.com"
+    gem.homepage    = "http://github.com/shanna/dm-sphinx-adapter"
+    gem.authors     = ["Shane Hanna"]
+    gem.add_dependency 'dm-core', ['~> 0.9']
+    gem.files.reject!{|f| f=~ %r{test/files/tmp/.*}}
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
 
-Hoe.new('dm-sphinx-adapter', '0.7') do |p|
-  p.developer('Shane Hanna', 'shane.hanna@gmail.com')
-  p.extra_deps = [
-    ['dm-core', '~> 0.9.7']
-  ]
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = 'dm-sphinx-adapter'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-# http://blog.behindlogic.com/2008/10/auto-generate-your-manifest-and-gemspec.html
-desc 'Rebuild manifest and gemspec.'
-task :cultivate do
-  Dir.chdir(File.dirname(__FILE__)) do #TODO: Is this required?
-    system %q{git ls-files | grep -v "\.gitignore" > Manifest.txt}
-    system %q{rake debug_gem | grep -v "(in " > `basename \`pwd\``.gemspec}
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
   end
 end
 
-# vim: syntax=Ruby
+task :default => :test

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 7
+:patch: 1

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

@@ -21,11 +21,20 @@ module DataMapper
       #     end
       #   end
       module Resource
+
+        def self.append_inclusions(*inclusions)
+          extra_inclusions.concat inclusions
+          true
+        end
+
+        def self.extra_inclusions
+          @extra_inclusions ||= []
+        end
+
         def self.included(model) #:nodoc:
-          model.class_eval do
-            include DataMapper::Resource
-            extend ClassMethods
-          end
+          model.send(:include, DataMapper::Resource)
+          model.extend ClassMethods if defined?(ClassMethods)
+          extra_inclusions.each{|inclusion| model.send(:include, inclusion)}
         end
 
         module ClassMethods
@@ -89,7 +98,15 @@ module DataMapper
           # ==== Returns
           # Array<DataMapper::Adapters::Sphinx::Attribute>
           def sphinx_attributes(repository_name = default_repository_name)
-            properties(repository_name).grep{|p| p.kind_of? Sphinx::Attribute}
+            properties(repository_name).find_all{|p| p.kind_of? Sphinx::Attribute}
+          end
+
+          # List of properties (aka sphinx fields).
+          #
+          # This list will be the inverse of properties not declared as attributes.
+          # ==== Returns
+          def sphinx_fields(repository_name = default_repository_name)
+            properties(repository_name).reject{|p| p.kind_of? Sphinx::Attribute}
           end
 
         end # ClassMethods

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

@@ -0,0 +1,94 @@
+module DataMapper
+  module Adapters
+    module Sphinx
+      require 'builder'
+
+
+      # Sphinx xmlpipe2.
+      #
+      # Full text search data from any DM adapter without having to implement new Sphinx data sources drivers.
+      #
+      # ==== See
+      # * http://www.sphinxsearch.com/docs/current.html#xmlpipe2
+      #
+      #--
+      # TODO:
+      # * Synopsis.
+      module XmlPipe2
+        def self.included(model)
+          model.extend ClassMethods if defined?(ClassMethods)
+        end
+
+        module ClassMethods
+
+          # Write a Sphinx xmlpipe2 XML stream to $stdout.
+          #
+          # ==== Parameters
+          # source<String>::      The name of the repository to stream from.
+          # destination<String>:: The name of the repository to stream to (contains your sphinx definition).
+          # query<Hash>::         The conditions with which to find the records to stream.
+          #--
+          # TODO:
+          # * in_memory_adapter doesn't call the super constructor so there is no field_naming_convention set in
+          # DataMapper 0.9.10. Submit a patch or live with rescue and field.name clause?
+          # * Keys that aren't called .id?
+          # * Composite keys?
+          # * Method for schema and documents.
+          # * Less poking round in the internals of the :default adapter if I can?
+          # * Destination should always be a dm-sphinx-adapter adapter.
+          # * Optional schema since it overrides any schema you might define in the sphinx configuration.
+          # * Schema default values from DM property default values.
+          def xmlpipe2(source, destination = :default, query = {})
+            builder = Builder::XmlMarkup.new(:target => $stdout)
+            builder.instruct!
+            builder.sphinx(:docset, :'xmlns:sphinx' => 'sphinx') do
+
+              builder.sphinx(:schema) do
+                sphinx_fields(destination).each do |field|
+                  builder.sphinx(:field, :name => (field.field(destination) rescue field.name))
+                end
+                sphinx_attributes(destination).each do |attr|
+                  builder.sphinx(:attr, {
+                    :name => (attr.field(destination) rescue attr.name),
+                    :type => xmlpipe2_type(attr.primitive)
+                  })
+                end
+              end
+
+              all(query.merge(:repository => repository(source))).map do |resource|
+                builder.sphinx(:document, :id => resource.id) do |document|
+                  properties(destination).each do |property|
+                    # TODO: Pretty sure this isn't the correct way to get and typecast.
+                    builder.tag!((property.field(destination) rescue property.name)) do |field|
+                      field.cdata!(property.typecast(property.get(resource)))
+                    end
+                  end
+                end
+              end
+            end
+          end
+
+          private
+            def xmlpipe2_type(primitive) #:nodoc:
+              {
+                Integer                 => 'int',
+                Float                   => 'float',
+                BigDecimal              => 'float',
+                DateTime                => 'timestamp',
+                Date                    => 'timestamp',
+                Time                    => 'timestamp',
+                TrueClass               => 'bool',
+                String                  => 'str2ordinal',
+                DataMapper::Types::Text => 'str2ordinal'
+              }[primitive]
+            end
+
+        end # ClassMethods
+      end # XmlPipe2
+
+      # Include XmlPipe2 in all DM::A::SphinxResource models when you require this file.
+      Resource.append_inclusions XmlPipe2
+    end # Sphinx
+  end # Adapters
+end # DataMapper
+

data/test/files/source.xml

@@ -10,30 +10,30 @@
   </sphinx:schema>
 
   <sphinx:document id="1">
-    <t_string>one</t_string>
-    <t_text>text one!</t_text>
-    <t_decimal>10.5</t_decimal>
-    <t_float>100.5</t_float>
-    <t_integer>1000</t_integer>
-    <t_datetime>1235183682</t_datetime>
+    <t_string><![CDATA[one]]></t_string>
+    <t_text><![CDATA[text one!]]></t_text>
+    <t_decimal><![CDATA[10.5]]></t_decimal>
+    <t_float><![CDATA[100.5]]></t_float>
+    <t_integer><![CDATA[1000]]></t_integer>
+    <t_datetime><![CDATA[1235183682]]></t_datetime>
   </sphinx:document>
 
   <sphinx:document id="2">
-    <t_string>two</t_string>
-    <t_text>text two!</t_text>
-    <t_decimal>20.5</t_decimal>
-    <t_float>200.5</t_float>
-    <t_integer>2000</t_integer>
-    <t_datetime>1235183682</t_datetime>
+    <t_string><![CDATA[two]]></t_string>
+    <t_text><![CDATA[text two!]]></t_text>
+    <t_decimal><![CDATA[20.5]]></t_decimal>
+    <t_float><![CDATA[200.5]]></t_float>
+    <t_integer><![CDATA[2000]]></t_integer>
+    <t_datetime><![CDATA[1235183682]]></t_datetime>
   </sphinx:document>
 
   <sphinx:document id="3">
-    <t_string>three</t_string>
-    <t_text>text three!</t_text>
-    <t_decimal>30.5</t_decimal>
-    <t_float>300.5</t_float>
-    <t_integer>3000</t_integer>
-    <t_datetime>1235183682</t_datetime>
+    <t_string><![CDATA[three]]></t_string>
+    <t_text><![CDATA[text three!]]></t_text>
+    <t_decimal><![CDATA[30.5]]></t_decimal>
+    <t_float><![CDATA[300.5]]></t_float>
+    <t_integer><![CDATA[3000]]></t_integer>
+    <t_datetime><![CDATA[1235183682]]></t_datetime>
   </sphinx:document>
 </sphinx:docset>
 

data/test/files/test_xmlpipe2.xml

@@ -0,0 +1 @@
+<?xml version="1.0" encoding="UTF-8"?><sphinx:docset xmlns:sphinx="sphinx"><sphinx:schema><sphinx:field name="id"/><sphinx:field name="t_string"/><sphinx:attr type="str2ordinal" name="t_text"/><sphinx:attr type="float" name="t_decimal"/><sphinx:attr type="float" name="t_float"/><sphinx:attr type="int" name="t_integer"/><sphinx:attr type="timestamp" name="t_datetime"/></sphinx:schema><sphinx:document id="1"><id><![CDATA[1]]></id><t_string><![CDATA[one]]></t_string><t_text><![CDATA[text one!]]></t_text><t_decimal><![CDATA[0.01]]></t_decimal><t_float><![CDATA[0.0001]]></t_float><t_integer><![CDATA[1]]></t_integer><t_datetime><![CDATA[1235914716]]></t_datetime></sphinx:document></sphinx:docset>

data/test/helper.rb

@@ -3,8 +3,8 @@ require 'rubygems'
 require 'extlib'
 require 'extlib/hook'
 require 'pathname'
-require 'shoulda'
 require 'test/unit'
+require 'shoulda'
 
 base  = Pathname.new(__FILE__).dirname + '..'
 files = base + 'test' + 'files'

data/test/test_query.rb

@@ -38,9 +38,9 @@ class TestQuery < Test::Unit::TestCase
 
     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(
+      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

data/test/test_xmlpipe2.rb

@@ -0,0 +1,77 @@
+require File.join(File.dirname(__FILE__), 'helper')
+require 'dm-sphinx-adapter/xmlpipe2'
+
+class TestResource < Test::Unit::TestCase
+  context 'DM::A::Sphinx::Resource module' do
+    begin
+      require 'nokogiri'
+    rescue LoadError
+      warn '  * WARNING: Nokogiri not found, skipping xmlpipe2 tests.'
+      return nil
+    end
+
+    setup do
+      load File.join(File.dirname(__FILE__), 'files', 'model.rb')
+    end
+
+    should 'respond to #xmlpipe2' do
+      assert_respond_to Item, :xmlpipe2
+    end
+
+    context '#xmlpipe2' do
+      setup do
+        $stdout = StringIO.new
+        Item.create(
+          :id         => 1,
+          :t_string   => 'one',
+          :t_text     => "text one!",
+          :t_decimal  => BigDecimal.new('0.01'),
+          :t_float    => 0.0001,
+          :t_integer  => 1,
+          :t_datetime => Time.at(1235914716)
+        )
+        Item.xmlpipe2(:default, :search)
+        @xml = $stdout.rewind && $stdout.read
+        @doc = Nokogiri::XML.parse(@xml) rescue nil
+        @ns  = {'s' => 'sphinx'}
+        $stdout = STDOUT
+      end
+
+      should 'stream xml to stdout' do
+        assert_not_nil @xml
+        assert_not_nil @doc
+      end
+
+      context 'schema' do
+        should 'have id field' do
+          assert_not_nil @doc.xpath(%q{//s:field[@name='id']}, @ns).first
+        end
+
+        should 'have t_string field' do
+          assert_not_nil @doc.xpath(%q{//s:field[@name='t_string']}, @ns).first
+        end
+
+        should 'have text attribute' do
+          assert_not_nil @doc.xpath(%q{//s:attr[@name='t_text' and @type='str2ordinal']}, @ns).first
+        end
+
+        should 'have decimal attribute' do
+          assert_not_nil @doc.xpath(%q{//s:attr[@name='t_decimal' and @type='float']}, @ns).first
+        end
+
+        should 'have float attribute' do
+          assert_not_nil @doc.xpath(%q{//s:attr[@name='t_float' and @type='float']}, @ns).first
+        end
+
+        should 'have int attribute' do
+          assert_not_nil @doc.xpath(%q{//s:attr[@name='t_integer' and @type='int']}, @ns).first
+        end
+
+        should 'have timestamp attribute' do
+          assert_not_nil @doc.xpath(%q{//s:attr[@name='t_datetime' and @type='timestamp']}, @ns).first
+        end
+      end
+    end
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dm-sphinx-adapter
 version: !ruby/object:Gem::Version 
-  version: "0.7"
+  version: 0.7.1
 platform: ruby
 authors: 
 - Shane Hanna
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-22 00:00:00 +11:00
+date: 2009-04-12 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,43 +20,27 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 0.9.7
+        version: "0.9"
     version: 
-- !ruby/object:Gem::Dependency 
-  name: hoe
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.8.3
-    version: 
-description: A DataMapper Sphinx adapter.
-email: 
-- shane.hanna@gmail.com
+description: 
+email: shane.hanna@gmail.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- History.txt
-- LICENCE.txt
-- Manifest.txt
-- README.txt
+- README.rdoc
 files: 
-- History.txt
-- LICENCE.txt
-- Manifest.txt
-- README.txt
+- README.rdoc
 - Rakefile
-- dm-sphinx-adapter.gemspec
+- VERSION.yml
 - lib/dm-sphinx-adapter.rb
 - lib/dm-sphinx-adapter/adapter.rb
 - lib/dm-sphinx-adapter/attribute.rb
 - lib/dm-sphinx-adapter/index.rb
 - lib/dm-sphinx-adapter/query.rb
 - lib/dm-sphinx-adapter/resource.rb
+- lib/dm-sphinx-adapter/xmlpipe2.rb
 - lib/riddle.rb
 - lib/riddle/client.rb
 - lib/riddle/client/filter.rb
@@ -65,18 +49,19 @@ files:
 - test/files/model.rb
 - test/files/source.xml
 - test/files/sphinx.conf
+- test/files/test_xmlpipe2.xml
 - test/helper.rb
 - test/test_adapter.rb
 - test/test_attribute.rb
 - test/test_index.rb
 - test/test_query.rb
 - test/test_resource.rb
+- test/test_xmlpipe2.rb
 has_rdoc: true
-homepage: http://dm-sphinx.rubyforge.org
+homepage: http://github.com/shanna/dm-sphinx-adapter
 post_install_message: 
 rdoc_options: 
-- --main
-- README.txt
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -93,14 +78,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: dm-sphinx-adapter
+rubyforge_project: 
 rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
 summary: A DataMapper Sphinx adapter.
 test_files: 
+- test/files/model.rb
+- test/helper.rb
 - test/test_adapter.rb
 - test/test_attribute.rb
 - test/test_index.rb
 - test/test_query.rb
 - test/test_resource.rb
+- test/test_xmlpipe2.rb

data/History.txt

@@ -1,42 +0,0 @@
-=== 0.7 / 2009-02-21
-
-  * Explicit repository names everywhere I can. DM ~> 0.9.10 and dm-sphinx-adapter 0.6.2 couldn't guess the default repository name.
-
-=== 0.6.2 / 2008-12-16
-
-  * Fixed shallow .dup of riddle client errors. You need to upgrade if you are running 0.6.1.
-
-=== 0.6.1 / 2008-12-16
-
-  * The adapter returns the entire Riddle::Client#query response so document :weight and :attributes are usable.
-  * Fixed broken naming convention bug. The AbstractAdapter constructor was not being called.
-
-=== 0.6 / 2008-12-13
-
-  * Removed managed client and all related libs.
-  * Switched to Shoulda for tests in an effort to clean them up a bit.
-
-=== 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.
-  * Bumped version because the read_one/read_many result structure had to change to support dm-is-searchable.
-
-=== 0.3 / 2008-11-18
-
-  * Removed calls to indexer on create/update. See README.txt
-  * Made the client object available from the adapter.
-
-=== 0.2 / 2008-11-09
-
-  * Addributes.
-  * Self managed searchd daemon if you want it.
-
-=== 0.1 / 2008-10-24
-

data/LICENCE.txt

@@ -1,20 +0,0 @@
-Copyright (c) 2008 Shane Hanna
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -1,26 +0,0 @@
-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/index.rb
-lib/dm-sphinx-adapter/query.rb
-lib/dm-sphinx-adapter/resource.rb
-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/source.xml
-test/files/sphinx.conf
-test/helper.rb
-test/test_adapter.rb
-test/test_attribute.rb
-test/test_index.rb
-test/test_query.rb
-test/test_resource.rb

data/dm-sphinx-adapter.gemspec

@@ -1,38 +0,0 @@
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{dm-sphinx-adapter}
-  s.version = "0.7"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Shane Hanna"]
-  s.date = %q{2009-02-21}
-  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/index.rb", "lib/dm-sphinx-adapter/query.rb", "lib/dm-sphinx-adapter/resource.rb", "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/source.xml", "test/files/sphinx.conf", "test/helper.rb", "test/test_adapter.rb", "test/test_attribute.rb", "test/test_index.rb", "test/test_query.rb", "test/test_resource.rb"]
-  s.has_rdoc = true
-  s.homepage = %q{http://dm-sphinx.rubyforge.org}
-  s.rdoc_options = ["--main", "README.txt"]
-  s.require_paths = ["lib"]
-  s.rubyforge_project = %q{dm-sphinx-adapter}
-  s.rubygems_version = %q{1.3.1}
-  s.summary = %q{A DataMapper Sphinx adapter.}
-  s.test_files = ["test/test_adapter.rb", "test/test_attribute.rb", "test/test_index.rb", "test/test_query.rb", "test/test_resource.rb"]
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 2
-
-    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_development_dependency(%q<hoe>, [">= 1.8.3"])
-    else
-      s.add_dependency(%q<dm-core>, ["~> 0.9.7"])
-      s.add_dependency(%q<hoe>, [">= 1.8.3"])
-    end
-  else
-    s.add_dependency(%q<dm-core>, ["~> 0.9.7"])
-    s.add_dependency(%q<hoe>, [">= 1.8.3"])
-  end
-end