solr-ruby 0.0.5 → 0.0.6

data/lib/solr/connection.rb

@@ -78,12 +78,29 @@ class Solr::Connection
   #   conn.query('borges') do |hit|
   #     puts hit
   #   end
+  #
+  # options include:
+  # 
+  #   :sort, :default_field, :rows, :filter_queries, :debug_query,
+  #   :explain_other, :facets, :highlighting, :mlt,
+  #   :operator         => :or / :and
+  #   :start            => defaults to 0
+  #   :field_list       => array, defaults to ["*", "score"]
 
   def query(query, options={}, &action)
     # TODO: Shouldn't this return an exception if the Solr status is not ok?  (rather than true/false).
     create_and_send_query(Solr::Request::Standard, options.update(:query => query), &action)
   end
   
+  # performs a dismax search and returns a Solr::Response::Standard
+  #
+  #   response = conn.search('borges')
+  # 
+  # options are same as query, but also include:
+  # 
+  #   :tie_breaker, :query_fields, :minimum_match, :phrase_fields,
+  #   :phrase_slop, :boost_query, :boost_functions
+
   def search(query, options={}, &action)
     create_and_send_query(Solr::Request::Dismax, options.update(:query => query), &action)
   end

data/lib/solr/request.rb

@@ -19,6 +19,7 @@ require 'solr/request/delete'
 require 'solr/request/ping'
 require 'solr/request/select'
 require 'solr/request/standard'
+require 'solr/request/spellcheck'
 require 'solr/request/dismax'
 require 'solr/request/update'
 require 'solr/request/index_info'

data/lib/solr/request/select.rb

@@ -15,13 +15,11 @@ require 'erb'
 # "Abstract" base class, only useful with subclasses that add parameters
 class Solr::Request::Select < Solr::Request::Base
       
-  # TODO add a constant for the all-docs query, which currently is [* TO *]
-  #      (caveat, that is all docs that have a value in the default field)
-  #      When the Lucene JAR is upgraded in Solr, the all-docs query becomes simply *
   attr_reader :query_type
   
-  def initialize(qt=nil)
+  def initialize(qt=nil, params={})
     @query_type = qt
+    @select_params = params
   end
   
   def response_format
@@ -37,7 +35,7 @@ class Solr::Request::Select < Solr::Request::Base
   end
 
   def to_hash
-    return {:qt => query_type, :wt => 'ruby'}
+    return {:qt => query_type, :wt => 'ruby'}.merge(@select_params)
   end
   
   def to_s

data/lib/solr/request/spellcheck.rb

@@ -0,0 +1,30 @@
+# 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::Request::Spellcheck < Solr::Request::Select
+
+  def initialize(params)
+    super('spellchecker')
+    @params = params
+  end
+  
+  def to_hash
+    hash = super
+    hash[:q] = @params[:query]
+    hash[:suggestionCount] = @params[:suggestion_count]
+    hash[:accuracy] = @params[:accuracy]
+    hash[:onlyMorePopular] = @params[:only_more_popular]
+    hash[:cmd] = @params[:command]
+    return hash
+  end
+
+end

data/lib/solr/request/standard.rb

@@ -12,7 +12,7 @@
 
 class Solr::Request::Standard < Solr::Request::Select
 
-  VALID_PARAMS = [:query, :sort, :default_field, :operator, :start, :rows,
+  VALID_PARAMS = [:query, :sort, :default_field, :operator, :start, :rows, :shards,
     :filter_queries, :field_list, :debug_query, :explain_other, :facets, :highlighting, :mlt]
   
   def initialize(params)
@@ -38,6 +38,8 @@ class Solr::Request::Standard < Solr::Request::Select
     @params[:rows] = params[:rows].to_i if params[:rows]
     
     @params[:field_list] ||= ["*","score"]
+    
+    @params[:shards] ||= []
   end
   
   def to_hash
@@ -59,6 +61,7 @@ class Solr::Request::Standard < Solr::Request::Select
     hash[:fl] = @params[:field_list].join(',')
     hash[:debugQuery] = @params[:debug_query]
     hash[:explainOther] = @params[:explain_other]
+    hash[:shards] = @params[:shards].join(',') unless @params[:shards].empty?
     
     # facet parameter processing
     if @params[:facets]
@@ -71,6 +74,7 @@ class Solr::Request::Standard < Solr::Request::Select
       hash["facet.missing"] = @params[:facets][:missing]
       hash["facet.mincount"] = @params[:facets][:mincount]
       hash["facet.prefix"] = @params[:facets][:prefix]
+      hash["facet.offset"] = @params[:facets][:offset]
       if @params[:facets][:fields]  # facet fields are optional (could be facet.query only)
         @params[:facets][:fields].each do |f|
           if f.kind_of? Hash
@@ -82,6 +86,7 @@ class Solr::Request::Standard < Solr::Request::Select
             hash["f.#{key}.facet.missing"] = value[:missing]
             hash["f.#{key}.facet.mincount"] = value[:mincount]
             hash["f.#{key}.facet.prefix"] = value[:prefix]
+            hash["f.#{key}.facet.offset"] = value[:offset]
           else
             hash["facet.field"] << f
           end
@@ -99,6 +104,16 @@ class Solr::Request::Standard < Solr::Request::Select
       hash["hl.simple.pre"] = @params[:highlighting][:prefix]
       hash["hl.simple.post"] = @params[:highlighting][:suffix]
       hash["hl.fragsize"] = @params[:highlighting][:fragment_size]
+      if @params[:highlighting][:alternate_fields]
+        @params[:highlighting][:alternate_fields].each do |k,v|
+          hash["f.#{k}.hl.alternateField"] = v
+        end
+      end
+      if @params[:highlighting][:max_alternate_field_length]
+        @params[:highlighting][:max_alternate_field_length].each do |k,v|
+          hash["f.#{k}.hl.maxAlternateFieldLength"] = v
+        end
+      end
     end
     
     if @params[:mlt]

data/lib/solr/response.rb

@@ -18,8 +18,10 @@ require 'solr/response/ping'
 require 'solr/response/add_document'
 require 'solr/response/modify_document'
 require 'solr/response/standard'
+require 'solr/response/spellcheck'
 require 'solr/response/dismax'
 require 'solr/response/commit'
 require 'solr/response/delete'
 require 'solr/response/index_info'
-require 'solr/response/optimize'
+require 'solr/response/optimize'
+require 'solr/response/select'

data/lib/solr/response/ruby.rb

@@ -11,7 +11,7 @@
 # limitations under the License.
 
 class Solr::Response::Ruby < Solr::Response::Base
-  attr_reader :data
+  attr_reader :data, :header
 
   def initialize(ruby_code)
     super
@@ -38,5 +38,5 @@ class Solr::Response::Ruby < Solr::Response::Base
   def query_time
     @header['QTime']
   end
-
+  
 end

data/lib/solr/response/select.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::Select < Solr::Response::Ruby
+  def initialize(ruby_code)
+    super
+  end
+end

data/lib/solr/response/spellcheck.rb

@@ -0,0 +1,20 @@
+# 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::Spellcheck < Solr::Response::Ruby
+  attr_reader :suggestions
+  
+  def initialize(ruby_code)
+    super
+    @suggestions = @data['suggestions']
+  end
+end

data/test/unit/changes_yaml_test.rb

@@ -0,0 +1,21 @@
+# 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'
+
+class ChangesYamlTest < Test::Unit::TestCase
+  def test_parse
+    change_log = YAML.load_file(File.expand_path(File.dirname(__FILE__)) + "/../../CHANGES.yml")
+    assert_equal Date.parse("2007-02-15"), change_log["v0.0.1"]["release_date"]
+    assert_equal ["initial release"], change_log["v0.0.1"]["changes"]
+  end
+end

data/test/unit/modify_document_test.rb

@@ -18,8 +18,7 @@ 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)
+    assert_match /copyfield\:OVERWRITE/, request.handler
+    assert_match /name\:OVERWRITE/, request.handler
   end
 end

data/test/unit/response_test.rb

@@ -32,11 +32,12 @@ class ResponseTest < SolrMockBaseTestCase
       Solr::Response::Ruby.new(' {...')
     end
   end
-  
-  def test_bogus_request_handling
-    assert_raise(Solr::Exception) do
-      Solr::Response::Base.make_response(Solr::Request::Select.new, "response data")
-    end
-  end
+
+  # This is now an acceptable use of Select, for the default request handler with no parameters (other than &wt=ruby)  
+  # def test_bogus_request_handling
+  #   assert_raise(Solr::Exception) do
+  #     Solr::Response::Base.make_response(Solr::Request::Select.new, "response data")
+  #   end
+  # end
 
 end

data/test/unit/select_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 SelectTest < Test::Unit::TestCase
+
+  def test_basic_query
+    request = Solr::Request::Select.new('custom', :q => 'query')
+    assert_equal :ruby, request.response_format
+    assert_equal 'select', request.handler
+    assert_equal 'query', request.to_hash[:q]
+  end
+  
+end

data/test/unit/spellcheck_response_test.rb

@@ -0,0 +1,26 @@
+# 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_mock_base'
+
+class SpellcheckResponseTest <  SolrMockBaseTestCase
+  def test_basic
+    ruby_code = "{'responseHeader'=>{'status'=>0,'QTime'=>5},'suggestions'=>['whately','whatcha','whatever']}"
+    conn = Solr::Connection.new 'http://localhost:9999'
+    set_post_return(ruby_code)
+    response = conn.send(Solr::Request::Spellcheck.new(:query => 'whateva'))
+    assert_equal true, response.ok?
+    assert_equal 3, response.suggestions.size
+    assert_equal ['whately','whatcha','whatever'], response.suggestions
+  end
+end
+

data/test/unit/spellchecker_request_test.rb

@@ -0,0 +1,27 @@
+# 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 SpellcheckRequestTest < Test::Unit::TestCase
+  def test_spellcheck_request
+    request = Solr::Request::Spellcheck.new(:query => 'whateva', :suggestion_count => 5, :accuracy => 0.7, :only_more_popular => true)
+    assert_equal :ruby, request.response_format
+    assert_equal 'select', request.handler
+    hash = request.to_hash
+    assert_equal 'whateva', hash[:q]
+    assert_equal 5, hash[:suggestionCount]
+    assert_equal 0.7, hash[:accuracy]
+    assert_equal true, hash[:onlyMorePopular]
+  end
+end

data/test/unit/standard_request_test.rb

@@ -71,10 +71,10 @@ class StandardRequestTest < Test::Unit::TestCase
        :facets => {
          :fields => [:genre,           
                      # field that overrides the global facet parameters
-                     {:year => {:limit => 50, :mincount => 0, :missing => false, :sort => :term, :prefix=>"199"}}], 
+                     {:year => {:limit => 50, :mincount => 0, :missing => false, :sort => :term, :prefix=>"199", :offset => 7}}], 
          :queries => ["q1", "q2"],
          :prefix => "cat",
-         :limit => 5, :zeros => true, :mincount => 20, :sort => :count  # global facet parameters
+         :offset => 3, :limit => 5, :zeros => true, :mincount => 20, :sort => :count  # global facet parameters
         }
     )
     
@@ -90,6 +90,8 @@ class StandardRequestTest < Test::Unit::TestCase
     assert_equal 0, hash["f.year.facet.mincount"]
     assert_equal false, hash["f.year.facet.sort"]
     assert_equal "199", hash["f.year.facet.prefix"]
+    assert_equal 3, hash["facet.offset"]
+    assert_equal 7, hash["f.year.facet.offset"]
   end
 
   def test_basic_sort
@@ -101,6 +103,8 @@ class StandardRequestTest < Test::Unit::TestCase
     request = Solr::Request::Standard.new(:query => 'query',
       :highlighting => {
         :field_list => ['title', 'author'],
+        :alternate_fields => {'title'=>'title', 'author'=>'author'},
+        :max_alternate_field_length => {'title'=>30, 'author'=>20},
         :max_snippets => 3,
         :require_field_match => true,
         :prefix => "<blink>",
@@ -112,6 +116,10 @@ class StandardRequestTest < Test::Unit::TestCase
     hash = request.to_hash
     assert_equal true, hash[:hl]
     assert_equal "title,author", hash["hl.fl"]
+    assert_equal "title", hash["f.title.hl.alternateField"]
+    assert_equal "author", hash["f.author.hl.alternateField"]
+    assert_equal 30, hash["f.title.hl.maxAlternateFieldLength"]
+    assert_equal 20, hash["f.author.hl.maxAlternateFieldLength"]
     assert_equal true, hash["hl.requireFieldMatch"]
     assert_equal "<blink>", hash["hl.simple.pre"]
     assert_equal "</blink>", hash["hl.simple.post"]

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: solr-ruby
 version: !ruby/object:Gem::Version 
-  version: 0.0.5
-date: 2007-08-27 00:00:00 -04:00
+  version: 0.0.6
+date: 2008-07-14 00:00:00 -04:00
 summary: Ruby library for working with Apache Solr
 require_paths: 
 - lib
@@ -30,27 +30,20 @@ authors:
 - Apache Solr
 files: 
 - lib/solr
-- lib/solr.rb
 - lib/solr/connection.rb
 - lib/solr/document.rb
 - lib/solr/exception.rb
 - lib/solr/field.rb
 - lib/solr/importer
-- lib/solr/importer.rb
-- lib/solr/indexer.rb
-- lib/solr/request
-- lib/solr/request.rb
-- lib/solr/response
-- lib/solr/response.rb
-- lib/solr/solrtasks.rb
-- lib/solr/util.rb
-- lib/solr/xml.rb
 - lib/solr/importer/array_mapper.rb
 - lib/solr/importer/delimited_file_source.rb
 - lib/solr/importer/hpricot_mapper.rb
 - lib/solr/importer/mapper.rb
 - lib/solr/importer/solr_source.rb
 - lib/solr/importer/xpath_mapper.rb
+- lib/solr/importer.rb
+- lib/solr/indexer.rb
+- lib/solr/request
 - lib/solr/request/add_document.rb
 - lib/solr/request/base.rb
 - lib/solr/request/commit.rb
@@ -61,8 +54,11 @@ files:
 - lib/solr/request/optimize.rb
 - lib/solr/request/ping.rb
 - lib/solr/request/select.rb
+- lib/solr/request/spellcheck.rb
 - lib/solr/request/standard.rb
 - lib/solr/request/update.rb
+- lib/solr/request.rb
+- lib/solr/response
 - lib/solr/response/add_document.rb
 - lib/solr/response/base.rb
 - lib/solr/response/commit.rb
@@ -73,10 +69,18 @@ files:
 - lib/solr/response/optimize.rb
 - lib/solr/response/ping.rb
 - lib/solr/response/ruby.rb
+- lib/solr/response/select.rb
+- lib/solr/response/spellcheck.rb
 - lib/solr/response/standard.rb
 - lib/solr/response/xml.rb
+- lib/solr/response.rb
+- lib/solr/solrtasks.rb
+- lib/solr/util.rb
+- lib/solr/xml.rb
+- lib/solr.rb
 - test/unit/add_document_test.rb
 - test/unit/array_mapper_test.rb
+- test/unit/changes_yaml_test.rb
 - test/unit/commit_test.rb
 - test/unit/connection_test.rb
 - test/unit/data_mapper_test.rb
@@ -92,7 +96,10 @@ files:
 - test/unit/ping_test.rb
 - test/unit/request_test.rb
 - test/unit/response_test.rb
+- test/unit/select_test.rb
 - test/unit/solr_mock_base.rb
+- test/unit/spellcheck_response_test.rb
+- test/unit/spellchecker_request_test.rb
 - test/unit/standard_request_test.rb
 - test/unit/standard_response_test.rb
 - test/unit/suite.rb