mwmitchell-rsolr 0.9.0 → 0.9.1

data/CHANGES.txt

@@ -1,3 +1,6 @@
+0.9.1 - July 22, 2009
+  Added LibXml builder support (Thanks to Mat Brown - github.com/outoftime)
+
 0.9.0 - July 17, 2009
   Added ability to use DirectSolrConnection instance when connecting
   Loading Java classes using full package name

data/lib/rsolr/message/builders/builder.rb

@@ -0,0 +1,85 @@
+require 'builder'
+
+class RSolr::Message::Builders::Builder
+  
+  # shortcut method -> xml = RSolr::Message.xml
+  def xml
+    ::Builder::XmlMarkup.new
+  end
+
+  # generates "add" xml for updating solr
+  # "data" can be a hash or an array of hashes.
+  # - each hash should be a simple key=>value pair representing a solr doc.
+  # If a value is an array, multiple fields will be created.
+  #
+  # "add_attrs" can be a hash for setting the add xml element attributes.
+  # 
+  # This method can also accept a block.
+  # The value yielded to the block is a Message::Document; for each solr doc in "data".
+  # You can set xml element attributes for each "doc" element or individual "field" elements.
+  #
+  # For example:
+  #
+  # solr.add({:id=>1, :nickname=>'Tim'}, {:boost=>5.0, :commitWithin=>1.0}) do |doc_msg|
+  #   doc_msg.attrs[:boost] = 10.00 # boost the document
+  #   nickname = doc_msg.field_by_name(:nickname)
+  #   nickname.attrs[:boost] = 20 if nickname.value=='Tim' # boost a field
+  # end
+  #
+  # would result in an add element having the attributes boost="10.0"
+  # and a commitWithin="1.0".
+  # Each doc element would have a boost="10.0".
+  # The "nickname" field would have a boost="20.0"
+  # if the doc had a "nickname" field with the value of "Tim".
+  #
+  def add(documents, add_attrs={})
+    xml.add(add_attrs) do |add_node|
+      documents.each do |doc|
+        # create doc, passing in fields
+        add_node.doc(doc.attrs) do |doc_node|
+          doc.fields.each do |field_obj|
+            doc_node.field(field_obj.value, field_obj.attrs)
+          end
+        end
+      end
+    end
+  end
+
+  # generates a <commit/> message
+  def commit(opts={})
+    xml.commit(opts)
+  end
+
+  # generates a <optimize/> message
+  def optimize(opts={})
+    xml.optimize(opts)
+  end
+
+  # generates a <rollback/> message
+  def rollback
+    xml.rollback
+  end
+
+  # generates a <delete><id>ID</id></delete> message
+  # "ids" can be a single value or array of values
+  def delete_by_id(ids)
+    ids = [ids] unless ids.is_a?(Array)
+    xml.delete do |xml|
+      ids.each do |id|
+        xml.id(id)
+      end
+    end
+  end
+
+  # generates a <delete><query>ID</query></delete> message
+  # "queries" can be a single value or an array of values
+  def delete_by_query(queries)
+    queries = [queries] unless queries.is_a?(Array)
+    xml.delete do |xml|
+      queries.each do |query|
+        xml.query(query)
+      end
+    end
+  end
+
+end

data/lib/rsolr/message/builders/libxml.rb

@@ -0,0 +1,59 @@
+require 'libxml'
+
+class RSolr::Message::Builders::Libxml
+  
+  def add(documents, attributes = {})
+    add_node = new_node('add', attributes)
+    for document in documents
+      add_node << doc_node = new_node('doc', document.attrs)
+      for field in document.fields
+        doc_node << field_node = new_node('field', field.attrs)
+        field_node << field.value
+      end
+    end
+    add_node.to_s(:indent => false)
+  end
+
+  def delete_by_id(ids)
+    delete = new_node('delete')
+    for id in Array(ids)
+      id_node = new_node('id')
+      id_node << id
+      delete << id_node
+    end
+    delete.to_s(:indent => false)
+  end
+
+  def delete_by_query(queries)
+    delete = new_node('delete')
+    for query in Array(queries)
+      query_node = new_node('query')
+      query_node << query
+      delete << query_node
+    end
+    delete.to_s(:indent => false)
+  end
+
+  def optimize(opts)
+    new_node('optimize', opts).to_s
+  end
+
+  def rollback
+    new_node('rollback').to_s
+  end
+
+  def commit(opts = {})
+    new_node('commit', opts).to_s
+  end
+
+  private
+
+  def new_node(name, opts = {})
+    node = LibXML::XML::Node.new(name)
+    opts.each_pair do |attr, value|
+      node[attr.to_s] = value.to_s
+    end
+    node
+  end
+  
+end

data/lib/rsolr/message/builders.rb

@@ -0,0 +1,6 @@
+module RSolr::Message::Builders
+
+  autoload :Builder, 'rsolr/message/builders/builder'
+  autoload :Libxml, 'rsolr/message/builders/libxml'
+
+end

data/lib/rsolr/message.rb

@@ -1,11 +1,9 @@
-# http://builder.rubyforge.org/
-require 'rubygems'
-require 'builder'
-
 # The Solr::Message class is the XML generation module for sending updates to Solr.
 
 class RSolr::Message
   
+  autoload :Builders, 'rsolr/message/builders'
+  
   # A class that represents a "doc" xml element for a solr update
   class Document
     
@@ -77,10 +75,10 @@ class RSolr::Message
   end
   
   class << self
-    
-    # shortcut method -> xml = RSolr::Message.xml
-    def xml
-      ::Builder::XmlMarkup.new
+    attr_writer :builder
+
+    def builder
+      @builder ||= Builders::Builder.new
     end
     
     # generates "add" xml for updating solr
@@ -108,59 +106,41 @@ class RSolr::Message
     # The "nickname" field would have a boost="20.0"
     # if the doc had a "nickname" field with the value of "Tim".
     #
-    def add(data, add_attrs={}, &blk)
+    def add(data, add_attrs={})
       data = [data] unless data.is_a?(Array)
-      xml.add(add_attrs) do |add_node|
-        data.each do |doc|
-          # create doc, passing in fields
-          doc = Document.new(doc) if doc.respond_to?(:each_pair)
-          yield doc if block_given?
-          add_node.doc(doc.attrs) do |doc_node|
-            doc.fields.each do |field_obj|
-              doc_node.field(field_obj.value, field_obj.attrs)
-            end
-          end
-        end
+      documents = data.map do |doc|
+        doc = Document.new(doc) if doc.respond_to?(:each_pair)
+        yield doc if block_given?
+        doc
       end
+      builder.add(documents, add_attrs)
     end
     
     # generates a <commit/> message
     def commit(opts={})
-      xml.commit(opts)
+      builder.commit(opts)
     end
     
     # generates a <optimize/> message
     def optimize(opts={})
-      xml.optimize(opts)
+      builder.optimize(opts)
     end
     
     # generates a <rollback/> message
     def rollback
-      xml.rollback
+      builder.rollback
     end
     
     # generates a <delete><id>ID</id></delete> message
     # "ids" can be a single value or array of values
     def delete_by_id(ids)
-      ids = [ids] unless ids.is_a?(Array)
-      xml.delete do |xml|
-        ids.each do |id|
-          xml.id(id)
-        end
-      end
+      builder.delete_by_id(ids)
     end
     
     # generates a <delete><query>ID</query></delete> message
     # "queries" can be a single value or an array of values
     def delete_by_query(queries)
-      queries = [queries] unless queries.is_a?(Array)
-      xml.delete do |xml|
-        queries.each do |query|
-          xml.query(query)
-        end
-      end
+      builder.delete_by_query(queries)
     end
-    
   end
-  
 end

data/rsolr.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name = "rsolr"
-  s.version = "0.9.0"
-  s.date = "2009-07-17"
+  s.version = "0.9.1"
+  s.date = "2009-07-22"
   s.summary = "A Ruby client for Apache Solr"
   s.email = "goodieboy@gmail.com"
   s.homepage = "http://github.com/mwmitchell/rsolr"
@@ -20,6 +20,9 @@ Gem::Specification.new do |s|
     "lib/rsolr/http_client/adapter/net_http.rb",
     "lib/rsolr/http_client/adapter.rb",
     "lib/rsolr/http_client.rb",
+    "lib/rsolr/message/builders/builder.rb",
+    "lib/rsolr/message/builders/libxml.rb",
+    "lib/rsolr/message/builders.rb",
     "lib/rsolr/message.rb",
     "LICENSE",
     "Rakefile",

data/test/message_test.rb

@@ -1,7 +1,7 @@
 
 require 'helper'
 
-class MessageTest < RSolrBaseTest
+module MessageTestMethods
   
   # call all of the simple methods...
   # make sure the xml string is valid
@@ -13,7 +13,7 @@ class MessageTest < RSolrBaseTest
       assert_equal String, result.class
     end
   end
-  
+
   def test_add_yields_doc_objects_if_block_given
     documents = [{:id=>1, :name=>'sam', :cat=>['cat 1', 'cat 2']}]
     add_attrs = {:boost=>200.00}
@@ -36,31 +36,31 @@ class MessageTest < RSolrBaseTest
     assert result =~ %r(boost="10")
     assert result =~ %r(<field name="id">1</field>)
   end
-  
+
   def test_delete_by_id
     result = RSolr::Message.delete_by_id(10)
     assert_equal String, result.class
     assert_equal '<delete><id>10</id></delete>', result.to_s
   end
-  
+
   def test_delete_by_multiple_ids
     result = RSolr::Message.delete_by_id([1, 2, 3])
     assert_equal String, result.class
     assert_equal '<delete><id>1</id><id>2</id><id>3</id></delete>', result.to_s
   end
-  
+
   def test_delete_by_query
-    result = RSolr::Message.delete_by_id('status:"LOST"')
+    result = RSolr::Message.delete_by_query('status:"LOST"')
     assert_equal String, result.class
-    assert_equal '<delete><id>status:"LOST"</id></delete>', result.to_s
+    assert_equal '<delete><query>status:"LOST"</query></delete>', result.to_s
   end
-  
+
   def test_delete_by_multiple_queries
-    result = RSolr::Message.delete_by_id(['status:"LOST"', 'quantity:0'])
+    result = RSolr::Message.delete_by_query(['status:"LOST"', 'quantity:0'])
     assert_equal String, result.class
-    assert_equal '<delete><id>status:"LOST"</id><id>quantity:0</id></delete>', result.to_s
+    assert_equal '<delete><query>status:"LOST"</query><query>quantity:0</query></delete>', result.to_s
   end
-  
+
   # add a single hash ("doc")
   def test_add_hash
     data = {
@@ -70,7 +70,7 @@ class MessageTest < RSolrBaseTest
     assert RSolr::Message.add(data).to_s =~ /<field name="name">matt<\/field>/
     assert RSolr::Message.add(data).to_s =~ /<field name="id">1<\/field>/
   end
-  
+
   # add an array of hashes
   def test_add_array
     data = [
@@ -83,35 +83,35 @@ class MessageTest < RSolrBaseTest
         :name=>'sam'
       }
     ]
-    
+  
     message = RSolr::Message.add(data)
     expected = '<add><doc><field name="id">1</field><field name="name">matt</field></doc><doc><field name="id">2</field><field name="name">sam</field></doc></add>'
-    
+  
     assert message.to_s=~/<field name="name">matt<\/field>/
     assert message.to_s=~/<field name="name">sam<\/field>/
   end
-  
+
   # multiValue field support test, thanks to Fouad Mardini!
   def test_add_multi_valued_field
     data = {
       :id   => 1,
       :name => ['matt1', 'matt2']
     }
-    
+  
     result = RSolr::Message.add(data)
-    
+  
     assert result.to_s =~ /<field name="name">matt1<\/field>/
     assert result.to_s =~ /<field name="name">matt2<\/field>/
   end
-  
+
   def test_add_single_document
     document = RSolr::Message::Document.new
     document.add_field('id', 1)
     document.add_field('name', 'matt', :boost => 2.0)
     result = RSolr::Message.add(document)
-    
+  
     assert result.to_s =~ /<field name="id">1<\/field>/
-    
+  
     # depending on which ruby version, the attributes can be out of place
     # so we need to test both... there's gotta be a better way to do this?
     assert(
@@ -132,4 +132,33 @@ class MessageTest < RSolrBaseTest
     assert result.to_s =~ /<field name="name">matt1<\/field>/
     assert result.to_s =~ /<field name="name">matt2<\/field>/
   end
+  
+end
+
+#####
+
+unless defined?(JRUBY_VERSION)
+  class LibxmlMessageTest < RSolrBaseTest
+  
+    include MessageTestMethods
+  
+    def setup
+      RSolr::Message.builder = RSolr::Message::Builders::Libxml.new
+    end
+  
+  end
 end
+
+
+#####
+
+class BuilderMessageTest < RSolrBaseTest
+  
+  include MessageTestMethods
+  
+  def setup
+    # RSolr::Message::Builders::Libxml.new
+    RSolr::Message.builder = RSolr::Message::Builders::Builder.new
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mwmitchell-rsolr
 version: !ruby/object:Gem::Version 
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors: 
 - Matt Mitchell
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-17 00:00:00 -07:00
+date: 2009-07-22 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -45,6 +45,9 @@ files:
 - lib/rsolr/http_client/adapter/net_http.rb
 - lib/rsolr/http_client/adapter.rb
 - lib/rsolr/http_client.rb
+- lib/rsolr/message/builders/builder.rb
+- lib/rsolr/message/builders/libxml.rb
+- lib/rsolr/message/builders.rb
 - lib/rsolr/message.rb
 - LICENSE
 - Rakefile