sunspot 0.10.8 → 0.10.9

data/README.rdoc

@@ -107,13 +107,24 @@ to define your own. See Sunspot::Adapters for more information.
 
 See Sunspot.search for more information.
 
-=== Get data from search:
-
-  search.results
-  search.total
-  search.page
-  search.per_page
-  search.facet(:blog_id)
+=== Work with search results (Haml for readability):
+
+  .facets
+    ul.blog_facet
+      - @search.facet(:blog_id).rows.each do |row|
+        li.facet_row
+          = link_to(row.instance.name, params.merge(:blog_id => row.value))
+          %span.count== (#{row.count})
+  .page_info== Displaying page #{@search.page} of #{@search.per_page} out of #{@search.total} results
+  - @search.hits.each do |hit|
+    - post = hit.result
+    .search_result
+      %h3.title
+        = link_to(h(hit.stored(:title)), post_url(post))
+      - if hit.score
+        %span.relevance== (#{hit.score})
+      %p= hit.highlight(:description).format { |word| "<span class=\"highlight\">#{word}</span>" }
+  .pagination= will_paginate(search.hits)
 
 == About the API documentation
 

data/TODO

@@ -1,7 +1,15 @@
+<<<<<<< HEAD:TODO
 === 0.10.x ===
 * Can retrieve facets from search via string
 * Allow #latitude and #longitude as coordinate attributes
 * Allow use of #text_fields from inside disjunction
+=======
+=== 1.0 ===
+* Built-in session proxies; #thread_local_sessions! method
+* Support 1.4, retaining 1.3 support if/as much as possible
+* Working local + keyword search
+* Facet filter exclusion
+>>>>>>> d8e4337... Minor API & documentation improvements:TODO
 
 * Assumed inconsistency
 * Support all operations in batches. Make it smart.

data/VERSION.yml

@@ -1,4 +1,5 @@
 --- 
-:minor: 10
-:patch: 8
 :major: 0
+:minor: 10
+:patch: 9
+:build: 

data/lib/sunspot/search/hit.rb

@@ -52,6 +52,14 @@ module Sunspot
         end || []
       end
 
+      #
+      # Return the first highlight found for a given field, or nil if there is
+      # none.
+      #
+      def highlight(field_name)
+        highlights(field_name).first
+      end
+
       # 
       # Retrieve stored field value. For any attribute field configured with
       # :stored => true, the Hit object will contain the stored value for
@@ -78,6 +86,7 @@ module Sunspot
         end
         @instance
       end
+      alias_method :result, :instance
 
       def inspect #:nodoc:
         "#<Sunspot::Search::Hit:#{@class_name} #{@primary_key}>"

data/lib/sunspot/search.rb

@@ -48,13 +48,7 @@ module Sunspot
     # WillPaginate::Collection or Array:: Instantiated result objects
     #
     def results
-      @results ||= if @query.page && defined?(WillPaginate::Collection)
-        WillPaginate::Collection.create(@query.page, @query.per_page, total) do |pager|
-          pager.replace(hits.map { |hit| hit.instance })
-        end
-      else
-        hits.map { |hit| hit.instance }
-      end
+      @results ||= maybe_will_paginate(hits.map { |hit| hit.instance })
     end
 
     # 
@@ -67,7 +61,12 @@ module Sunspot
     # Array:: Ordered collection of Hit objects
     #
     def hits
-      @hits ||= solr_response['docs'].map { |doc| Hit.new(doc, highlights_for(doc), self) }
+      @hits ||=
+        maybe_will_paginate(
+          solr_response['docs'].map do |doc|
+            Hit.new(doc, highlights_for(doc), self)
+          end
+        )
     end
     alias_method :raw_results, :hits
 
@@ -165,9 +164,9 @@ module Sunspot
       end
       id_hit_hash.each_pair do |class_name, hits|
         ids = hits.map { |id, hit| hit.primary_key }
-        data_accessor_for(Util.full_const_get(class_name)).load_all(ids).each do |instance|
-          hit = id_hit_hash[class_name][Adapters::InstanceAdapter.adapt(instance).id.to_s]
-          hit.instance = instance
+        data_accessor_for(Util.full_const_get(class_name)).load_all(ids).each do |result|
+          hit = id_hit_hash[class_name][Adapters::InstanceAdapter.adapt(result).id.to_s]
+          hit.instance = result
         end
       end
     end
@@ -207,6 +206,16 @@ module Sunspot
         @solr_result['highlighting'][doc['id']]
       end
     end
+
+    def maybe_will_paginate(collection)
+      if defined?(WillPaginate::Collection)
+        WillPaginate::Collection.create(@query.page, @query.per_page, total) do |pager|
+          pager.replace(collection)
+        end
+      else
+        collection
+      end
+    end
     
     # Clear out all the cached ivars so the search can be called again.
     def reset

data/spec/api/search/highlighting_spec.rb

@@ -21,23 +21,27 @@ describe 'search with highlighting results', :type => :search do
     @search.hits.last.should have(2).highlights(:body)
   end
 
+  it 'returns first highlight for a specified field' do
+    @search.hits.first.highlight(:title).format.should == 'one <em>two</em> three'
+  end
+
   it 'returns an empty array if a given field does not have a highlight' do
     @search.hits.first.highlights(:body).should == []
   end
 
-  it 'should format hits with <em> by default' do
+  it 'formats hits with <em> by default' do
     highlight = @search.hits.first.highlights(:title).first.formatted
     highlight.should == 'one <em>two</em> three'
   end
 
-  it 'should format hits with provided block' do
+  it 'formats hits with provided block' do
     highlight = @search.hits.first.highlights(:title).first.format do |word|
       "<i>#{word}</i>"
     end
     highlight.should == 'one <i>two</i> three'
   end
 
-  it 'should handle multiple highlighted words' do
+  it 'handles multiple highlighted words' do
     highlight = @search.hits.last.highlights(:body).last.format do |word|
       "<b>#{word}</b>"
     end

data/spec/api/search/hits_spec.rb

@@ -12,6 +12,24 @@ describe 'hits', :type => :search do
     end.should == [['Post', post_1.id.to_s], ['Post', post_2.id.to_s]]
   end
 
+  if ENV['USE_WILL_PAGINATE']
+
+    it 'returns search total as attribute of hits' do
+      stub_results(Post.new, 4)
+      session.search(Post) do
+        paginate(:page => 1)
+      end.hits.total_entries.should == 4
+    end
+  else
+
+    it 'returns vanilla array of hits if WillPaginate is not available' do
+      stub_results(Post.new)
+      session.search(Post) do
+        paginate(:page => 1)
+      end.hits.should_not respond_to(:total_entries)
+    end
+  end
+
   it 'should return instance from hit' do
     posts = Array.new(2) { Post.new }
     stub_results(*posts)

data/tasks/gemspec.rake

@@ -38,5 +38,5 @@ namespace :release do
   end
 
   desc "Release gem to RubyForge and GitHub"
-  task :all => [:gemspec, :tag, :"rubyforge:release:gem", :"gemcutter:release"]
+  task :all => [:gemspec, :tag, :"gemcutter:release"]
 end

data/tasks/rdoc.rake

@@ -1,4 +1,4 @@
-gem 'mislav-hanna'
+gem 'hanna'
 require 'hanna/rdoctask'
 require 'jeweler'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sunspot
 version: !ruby/object:Gem::Version 
-  version: 0.10.8
+  version: 0.10.9
 platform: ruby
 authors: 
 - Mat Brown
@@ -18,7 +18,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-24 00:00:00 -05:00
+date: 2010-01-10 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -258,59 +258,59 @@ signing_key:
 specification_version: 3
 summary: Library for expressive, powerful interaction with the Solr search engine
 test_files: 
-- spec/spec_helper.rb
-- spec/helpers/indexer_helper.rb
-- spec/helpers/search_helper.rb
 - spec/helpers/query_helper.rb
-- spec/integration/spec_helper.rb
-- spec/integration/local_search_spec.rb
-- spec/integration/faceting_spec.rb
-- spec/integration/scoped_search_spec.rb
-- spec/integration/highlighting_spec.rb
-- spec/integration/keyword_search_spec.rb
-- spec/integration/indexing_spec.rb
-- spec/integration/dynamic_fields_spec.rb
-- spec/integration/stored_fields_spec.rb
-- spec/integration/test_pagination.rb
-- spec/mocks/mock_record.rb
-- spec/mocks/blog.rb
-- spec/mocks/adapters.rb
-- spec/mocks/mock_adapter.rb
-- spec/mocks/user.rb
-- spec/mocks/photo.rb
-- spec/mocks/post.rb
-- spec/mocks/comment.rb
-- spec/mocks/super_class.rb
-- spec/mocks/connection.rb
-- spec/api/spec_helper.rb
+- spec/helpers/search_helper.rb
+- spec/helpers/indexer_helper.rb
+- spec/api/adapters_spec.rb
+- spec/api/query/text_field_scoping_spec.rb
+- spec/api/query/fulltext_spec.rb
+- spec/api/query/adjust_params_spec.rb
+- spec/api/query/dynamic_fields_spec.rb
+- spec/api/query/highlighting_spec.rb
+- spec/api/query/ordering_pagination_spec.rb
+- spec/api/query/spec_helper.rb
+- spec/api/query/local_spec.rb
+- spec/api/query/types_spec.rb
+- spec/api/query/scope_spec.rb
+- spec/api/query/faceting_spec.rb
+- spec/api/query/dsl_spec.rb
+- spec/api/query/connectives_spec.rb
 - spec/api/session_spec.rb
-- spec/api/indexer/spec_helper.rb
-- spec/api/indexer/fixed_fields_spec.rb
-- spec/api/indexer/attributes_spec.rb
-- spec/api/indexer/dynamic_fields_spec.rb
+- spec/api/spec_helper.rb
 - spec/api/indexer/fulltext_spec.rb
+- spec/api/indexer/dynamic_fields_spec.rb
 - spec/api/indexer/removal_spec.rb
+- spec/api/indexer/spec_helper.rb
+- spec/api/indexer/fixed_fields_spec.rb
 - spec/api/indexer/batch_spec.rb
-- spec/api/search/spec_helper.rb
+- spec/api/indexer/attributes_spec.rb
+- spec/api/indexer_spec.rb
 - spec/api/search/hits_spec.rb
-- spec/api/search/faceting_spec.rb
-- spec/api/search/highlighting_spec.rb
 - spec/api/search/dynamic_fields_spec.rb
 - spec/api/search/search_spec.rb
 - spec/api/search/results_spec.rb
-- spec/api/adapters_spec.rb
-- spec/api/query/dsl_spec.rb
-- spec/api/query/spec_helper.rb
-- spec/api/query/faceting_spec.rb
-- spec/api/query/connectives_spec.rb
-- spec/api/query/adjust_params_spec.rb
-- spec/api/query/local_spec.rb
-- spec/api/query/highlighting_spec.rb
-- spec/api/query/ordering_pagination_spec.rb
-- spec/api/query/dynamic_fields_spec.rb
-- spec/api/query/types_spec.rb
-- spec/api/query/scope_spec.rb
-- spec/api/query/text_field_scoping_spec.rb
-- spec/api/query/fulltext_spec.rb
+- spec/api/search/highlighting_spec.rb
+- spec/api/search/spec_helper.rb
+- spec/api/search/faceting_spec.rb
 - spec/api/sunspot_spec.rb
-- spec/api/indexer_spec.rb
+- spec/mocks/connection.rb
+- spec/mocks/comment.rb
+- spec/mocks/photo.rb
+- spec/mocks/post.rb
+- spec/mocks/super_class.rb
+- spec/mocks/blog.rb
+- spec/mocks/adapters.rb
+- spec/mocks/mock_adapter.rb
+- spec/mocks/mock_record.rb
+- spec/mocks/user.rb
+- spec/integration/dynamic_fields_spec.rb
+- spec/integration/stored_fields_spec.rb
+- spec/integration/highlighting_spec.rb
+- spec/integration/local_search_spec.rb
+- spec/integration/spec_helper.rb
+- spec/integration/indexing_spec.rb
+- spec/integration/keyword_search_spec.rb
+- spec/integration/test_pagination.rb
+- spec/integration/faceting_spec.rb
+- spec/integration/scoped_search_spec.rb
+- spec/spec_helper.rb