solr-ruby 0.0.4 → 0.0.5

data/lib/solr/connection.rb

@@ -28,7 +28,7 @@ class Solr::Connection
   #   conn = Solr::Connection.new('http://example.com:8080/solr', 
   #     :autocommit => :on)
 
-  def initialize(url, opts={})
+  def initialize(url="http://localhost:8983/solr", opts={})
     @url = URI.parse(url)
     unless @url.kind_of? URI::HTTP
       raise "invalid http url: #{url}"

data/lib/solr/importer/solr_source.rb

@@ -13,7 +13,7 @@
 require 'solr'
 
 class Solr::Importer::SolrSource
-  def initialize(solr_url, query, filter_queries, options={})
+  def initialize(solr_url, query, filter_queries=nil, options={})
     @connection = Solr::Connection.new(solr_url)
     @query = query
     @filter_queries = filter_queries

data/lib/solr/request.rb

@@ -12,6 +12,7 @@
 
 module Solr; module Request; end; end
 require 'solr/request/add_document'
+require 'solr/request/modify_document'
 require 'solr/request/base'
 require 'solr/request/commit'
 require 'solr/request/delete'

data/lib/solr/request/add_document.rb

@@ -23,7 +23,7 @@ class Solr::Request::AddDocument < Solr::Request::Update
   #
   # as a short cut you can pass in a Hash instead:
   #
-  #   request = Solr::Request.new :creator => 'Jorge Luis Borges'
+  #   request = Solr::Request::AddDocument.new :creator => 'Jorge Luis Borges'
   # 
   # or an array, to add multiple documents at the same time:
   # 

data/lib/solr/request/base.rb

@@ -30,7 +30,7 @@ class Solr::Request::Base
   # respond to this type of request
   
   def handler
-    raise "unkown request type: #{self.class}"
+    raise "unknown request type: #{self.class}"
   end
 
 end

data/lib/solr/request/modify_document.rb

@@ -0,0 +1,51 @@
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'solr/xml'
+require 'solr/request/base'
+require 'solr/document'
+require 'solr/request/update'
+
+class Solr::Request::ModifyDocument < Solr::Request::Update
+
+  # Example: ModifyDocument.new(:id => 10, :overwrite => {:field_name => "new value"})
+  def initialize(update_data)
+    modes = []
+    @doc = {}
+    [:overwrite, :append, :distinct, :increment, :delete].each do |mode|
+      field_data = update_data[mode]
+      if field_data
+        field_data.each do |field_name, field_value|
+          modes << "#{field_name}:#{mode.to_s.upcase}"
+          @doc[field_name] = field_value if field_value  # if value is nil, omit so it can be removed
+        end
+        update_data.delete mode
+      end
+    end
+    @mode = modes.join(",")
+    
+    # only one key should be left over, the id
+    @doc[update_data.keys[0].to_s] = update_data.values[0]
+  end
+
+  # returns the request as a string suitable for posting
+  def to_s
+    e = Solr::XML::Element.new 'add'
+    e.add_element(Solr::Document.new(@doc).to_xml)
+    return e.to_s
+  end
+  
+  def handler
+    "update?mode=#{@mode}"
+  end
+  
+end

data/lib/solr/request/standard.rb

@@ -13,7 +13,7 @@
 class Solr::Request::Standard < Solr::Request::Select
 
   VALID_PARAMS = [:query, :sort, :default_field, :operator, :start, :rows,
-    :filter_queries, :field_list, :debug_query, :explain_other, :facets, :highlighting]
+    :filter_queries, :field_list, :debug_query, :explain_other, :facets, :highlighting, :mlt]
   
   def initialize(params)
     super('standard')
@@ -98,8 +98,21 @@ class Solr::Request::Standard < Solr::Request::Select
       hash["hl.requireFieldMatch"] = @params[:highlighting][:require_field_match]
       hash["hl.simple.pre"] = @params[:highlighting][:prefix]
       hash["hl.simple.post"] = @params[:highlighting][:suffix]
+      hash["hl.fragsize"] = @params[:highlighting][:fragment_size]
     end
     
+    if @params[:mlt]
+      hash[:mlt] = true
+      hash["mlt.count"] = @params[:mlt][:count]
+      hash["mlt.fl"] = @params[:mlt][:field_list].join(',')
+      hash["mlt.mintf"] = @params[:mlt][:min_term_freq]
+      hash["mlt.mindf"] = @params[:mlt][:min_doc_freq]
+      hash["mlt.minwl"] = @params[:mlt][:min_word_length]
+      hash["mlt.maxwl"] = @params[:mlt][:max_word_length]
+      hash["mlt.maxqt"] = @params[:mlt][:max_query_terms]
+      hash["mlt.maxntp"] = @params[:mlt][:max_tokens_parsed]
+      hash["mlt.boost"] = @params[:mlt][:boost]
+    end
     
     hash.merge(super.to_hash)
   end

data/lib/solr/response.rb

@@ -16,6 +16,7 @@ require 'solr/response/xml'
 require 'solr/response/ruby'
 require 'solr/response/ping'
 require 'solr/response/add_document'
+require 'solr/response/modify_document'
 require 'solr/response/standard'
 require 'solr/response/dismax'
 require 'solr/response/commit'

data/lib/solr/response/modify_document.rb

@@ -0,0 +1,17 @@
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+class Solr::Response::ModifyDocument < Solr::Response::Xml
+  def initialize(xml)
+    super
+  end
+end

data/lib/solr/response/standard.rb

@@ -36,6 +36,7 @@ class Solr::Response::Standard < Solr::Response::Ruby
     @response['maxScore']
   end
   
+  # TODO: consider the use of json.nl parameter
   def field_facets(field)
     facets = []
     values = @data['facet_counts']['facet_fields'][field]

data/lib/solr/util.rb

@@ -25,4 +25,8 @@ class Solr::Util
     Hash[*a]
   end
   
+  def self.query_parser_escape(string)
+    # backslash prefix everything that isn't a word character
+    string.gsub(/(\W)/,'\\\\\1')
+  end
 end

data/test/unit/modify_document_test.rb

@@ -0,0 +1,25 @@
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'test/unit'
+require 'solr'
+
+class ModifyDocumentTest < Test::Unit::TestCase
+
+  def test_update_formatting
+    request = Solr::Request::ModifyDocument.new(:id => 10, :overwrite => {:name => ['val1', 'val2'], :copyfield => nil})
+    assert_equal :xml, request.response_format
+    assert_equal 'update?mode=copyfield:OVERWRITE,name:OVERWRITE', request.handler
+    
+    assert_match(/<add>[\s]*<doc>[\s]*<field name=["']id['"]>10<\/field>[\s]*<field name=['"]name['"]>val1<\/field>[\s]*<field name=['"]name['"]>val2<\/field>[\s]*<\/doc>[\s]*<\/add>/, request.to_s)
+  end
+end

data/test/unit/standard_request_test.rb

@@ -104,7 +104,8 @@ class StandardRequestTest < Test::Unit::TestCase
         :max_snippets => 3,
         :require_field_match => true,
         :prefix => "<blink>",
-        :suffix => "</blink>"
+        :suffix => "</blink>",
+        :fragment_size => 300
       }
     )
     
@@ -114,6 +115,31 @@ class StandardRequestTest < Test::Unit::TestCase
     assert_equal true, hash["hl.requireFieldMatch"]
     assert_equal "<blink>", hash["hl.simple.pre"]
     assert_equal "</blink>", hash["hl.simple.post"]
+    assert_equal 300, hash["hl.fragsize"]
+  end
+  
+  def test_mlt
+    request = Solr::Request::Standard.new(:query => 'query',
+      :mlt => {
+        :count => 5, :field_list => ['field1', 'field2'],
+        :min_term_freq => 3, :min_doc_freq => 10,
+        :min_word_length => 4, :max_word_length => 17,
+        :max_query_terms => 20, :max_tokens_parsed => 100,
+        :boost => true
+      }
+    )
+    
+    hash = request.to_hash
+    assert_equal true, hash[:mlt]
+    assert_equal 5, hash["mlt.count"]
+    assert_equal 'field1,field2', hash["mlt.fl"]
+    assert_equal 3, hash["mlt.mintf"]
+    assert_equal 10, hash["mlt.mindf"]
+    assert_equal 4, hash["mlt.minwl"]
+    assert_equal 17, hash["mlt.maxwl"]
+    assert_equal 20, hash["mlt.maxqt"]
+    assert_equal 100, hash["mlt.maxntp"]
+    assert_equal true, hash["mlt.boost"]
   end
 
 end

data/test/unit/util_test.rb

@@ -14,9 +14,11 @@ require 'solr'
 require 'test/unit'
 
 class UtilTest < Test::Unit::TestCase
-
   def test_paired_array_to_hash
     assert_equal({:key1 => :value1, :key2 => :value2}, Solr::Util.paired_array_to_hash([:key1, :value1, :key2, :value2]))
   end
 
+  def test_query_parser_escape
+    assert_equal %q(http\:\/\/lucene\.apache\.org\/solr), Solr::Util.query_parser_escape("http://lucene.apache.org/solr")
+  end
 end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: solr-ruby
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
-date: 2007-08-16 00:00:00 -04:00
+  version: 0.0.5
+date: 2007-08-27 00:00:00 -04:00
 summary: Ruby library for working with Apache Solr
 require_paths: 
 - lib
@@ -57,6 +57,7 @@ files:
 - lib/solr/request/delete.rb
 - lib/solr/request/dismax.rb
 - lib/solr/request/index_info.rb
+- lib/solr/request/modify_document.rb
 - lib/solr/request/optimize.rb
 - lib/solr/request/ping.rb
 - lib/solr/request/select.rb
@@ -68,6 +69,7 @@ files:
 - lib/solr/response/delete.rb
 - lib/solr/response/dismax.rb
 - lib/solr/response/index_info.rb
+- lib/solr/response/modify_document.rb
 - lib/solr/response/optimize.rb
 - lib/solr/response/ping.rb
 - lib/solr/response/ruby.rb
@@ -86,6 +88,7 @@ files:
 - test/unit/hpricot_mapper_test.rb
 - test/unit/hpricot_test_file.xml
 - test/unit/indexer_test.rb
+- test/unit/modify_document_test.rb
 - test/unit/ping_test.rb
 - test/unit/request_test.rb
 - test/unit/response_test.rb