mwmitchell-rsolr-ext 0.7.12 → 0.7.31

data/README.rdoc

@@ -2,7 +2,7 @@
 A set of helper methods/modules to assist in building Solr queries and handling responses when using the RSolr library.
 
 ==Request Example
-  solr_params = RSolr::Ext.map_params(
+  solr_params = {
     :page=>2,
     :per_page=>10,
     :phrases=>{:name=>'This is a phrase'},
@@ -10,69 +10,39 @@ A set of helper methods/modules to assist in building Solr queries and handling
     :phrase_filters=>{:manu=>['Apple']},
     :queries=>'ipod',
     :facets=>{:fields=>['cat', 'blah']}
-  )
+  }
   
-  rsolr = RSolr.connect
+  rsolr = RSolr::Ext.connect
   
   response = rsolr.select(solr_params)
 
 ==Response Example
-  rsolr = RSolr.connect
+  rsolr = RSolr::Ext.connect
   
-  raw_response = rsolr.select(:q=>'*:*)
-  r = RSolr::Ext::wrap_response(raw_response)
+  response = rsolr.select(:q=>'*:*)
   
-  r.ok?
-  r.params
-  r.docs
-  r.docs.previous_page
-  r.docs.next_page
-  r.facets
+  response.ok?
+  response.params
+  response.docs
+  response.docs.previous_page
+  response.docs.next_page
+  response.facets
 
 You can access values in the response hash using symbols or strings.
 
 ===Doc Pagination
-After creating a RSolr::Ext::Response object, pass-in the response.docs to the will_paginate view helper:
-  rsolr = RSolr.connect
-  raw_response = rsolr.select(:q=>'*:*)
-  @response = RSolr::Ext.wrap_response(raw_response)
-  # in view:
-  <%= will_paginate @response.docs %>
-
-==The Findable Module
-
-You can get a modified RSolr.connect object by calling RSolr::Ext.connect.
-
-The object returned is an RSolr::Connection::Adapter (Direct or HTTP) with additional methods attached, most notably #find, which comes from the RSolr::Ext::Findable module.
-
-The #find method provides a convenient way to search solr. Here are some examples:
-  
-  solr = RSolr::Ext.connect
-  
-  # q=jefferson - returns all docs
-  all_jefferson_docs = solr.find 'jefferson'
-  
-  # q=jefferson&rows=1 -- first doc only
-  a_single_jefferson_doc = solr.find :first, 'jefferson'
-  
-  # q=jefferson&fq=type:"book" - all docs
-  books_about_jefferson = solr.find 'jefferson', :phrase_filters=>{:type=>'book'}
-  
-  # q=something -- the entire response
-  solr_response = solr.find {:q=>'something'}, :include_response=>true
+If you wanna paginate, just throw the collection into the WillPaginate view helper.
+  <%= will_paginate response.docs %>
 
 ===The Doc Module
 You can create your own "models" using RSolr::Ext::Doc
+
   class Book
     include RSolr::Ext::Doc
-    @default_params = {:fq=>'object_type:"book"', :rows=>10}
-    
     def self.find_by_author(author)
-        find(:phrase_filters=>{:author=>author})
+        find(:fq=>'object_type:"book"', :rows=>10, :phrase_filters=>{:author=>author})
     end
   end
   
   all_books = Book.find('*:*')
   hawk_books = Book.find_by_author('hawk')
-
-If you wanna paginate, just throw the collection into the WillPaginate view helper.

data/lib/rsolr-ext/doc.rb

@@ -41,27 +41,19 @@ module RSolr::Ext::Doc
   #
   module Findable
     
-    attr_accessor :default_params, :connection
+    attr_accessor :connection
     
     def connection
       @connection ||= RSolr::Ext.connect
     end
     
-    def default_params
-      @default_params ||= {}
-      # don't allow nil values to pass!
-      @default_params.delete_if {|k,v| v.to_s.empty?}
-      @default_params
-    end
-    
     def find(*args)
       mode, solr_params, opts = connection.send(:extract_find_opts!, *args)
-      final_params = default_params.merge(solr_params)
-      connection.find(*[mode, final_params, opts]) { |doc| self.new(doc) }
+      connection.find(*[mode, solr_params, opts]) { |doc| self.new(doc) }
     end
     
     def find_by_id(id, solr_params={}, opts={})
-      connection.find_by_id(id, default_params.merge(solr_params), opts) { |doc| self.new(doc) }
+      connection.find_by_id(id, solr_params, opts) { |doc| self.new(doc) }
     end
     
   end

data/lib/rsolr-ext/findable.rb

@@ -34,7 +34,7 @@ module RSolr::Ext::Findable
   def find(*args, &blk)
     mode, solr_params, opts = extract_find_opts!(*args)
     
-    opts[:include_response] = false unless opts.key?(:include_response)
+    opts[:include_response] ||= true
     
     solr_params[:rows] = 1 if mode == :first
     valid_solr_params = RSolr::Ext.map_params(solr_params)

data/lib/rsolr-ext/response/docs.rb

@@ -1,6 +1,6 @@
 module RSolr::Ext::Response::Docs
   
-  module Accessable
+  module Accessible
     
     # Helper method to check if value/multi-values exist for a given key.
     # The value can be a string, or a RegExp
@@ -83,7 +83,9 @@ module RSolr::Ext::Response::Docs
   def self.extended(base)
     d = base['response']['docs']
     d.extend Pageable
-    d.each{|item|item.extend Accessable}
+    d.each do |item|
+      item.extend Accessible
+    end
     d.per_page = base['responseHeader']['params']['rows'].to_s.to_i
     d.start = base['response']['start'].to_s.to_i
     d.total = base['response']['numFound'].to_s.to_i

data/lib/rsolr-ext/response/spelling.rb

@@ -0,0 +1,68 @@
+# A mixin for making access to the spellcheck component data easy.
+#
+# response.spelling.words
+#
+module RSolr::Ext::Response::Spelling
+  
+  def spelling
+    @spelling ||= Base.new(self)
+  end
+  
+  class Base
+    
+    attr :response
+    
+    def initialize(response)
+      @response = response
+    end
+    
+    # returns an array of spelling suggestion for specific query words, 
+    # as provided in the solr response.  Only includes words with higher
+    # frequency of occurrence than word in original query.
+    # can't do a full query suggestion because we only get info for each word;  
+    # combination of words may not have results.
+    # Thanks to Naomi Dushay!
+    def words
+      @words ||= (
+        spellcheck = self[:spellcheck]
+        if spellcheck && spellcheck[:suggestions]
+          suggestions = spellcheck[:suggestions]
+          result = Array.new
+          if (!suggestions.nil?)
+            # suggestions is an array: 
+            #    (query term)
+            #    (hash of term info and term suggestion) 
+            #    ...
+            #    (query term)
+            #    (hash of term info and term suggestion) 
+            #    'correctlySpelled'
+            #    true/false
+            #    collation
+            #    (suggestion for collation)
+            i_stop = suggestions.index("correctlySpelled")
+            # step through array in 2s to get info for each term
+            0.step(i_stop-1, 2) do |i| 
+              term = suggestions[i]
+              term_info = suggestions[i+1]
+              # term_info is a hash:
+              #   numFound =>
+              #   startOffset =>
+              #   endOffset =>
+              #   origFreq =>
+              #   suggestion =>  { frequency =>, word => }
+              origFreq = term_info['origFreq']
+              suggFreq = term_info['suggestion']['frequency'] 
+              if suggFreq > origFreq
+                result.push(term_info['suggestion']['word'])
+              end
+            end
+            result.uniq!
+            result.empty? ? nil : result
+          end
+        end
+      )
+    end
+    
+  end
+  
+end

data/lib/rsolr-ext/response.rb

@@ -2,6 +2,7 @@ module RSolr::Ext::Response
   
   autoload :Facets, 'rsolr-ext/response/facets'
   autoload :Docs, 'rsolr-ext/response/docs'
+  autoload :Spelling, 'rsolr-ext/response/spelling'
   
   class Base < Mash
     
@@ -26,10 +27,16 @@ module RSolr::Ext::Response
       super(*args)
       extend Docs
       extend Facets
+      extend Spelling
     end
     
     def response
-      self['response']
+      self[:response]
+    end
+    
+    # short cut to response['numFound']
+    def total
+      response[:numFound]
     end
     
   end

data/lib/rsolr-ext.rb

@@ -23,7 +23,7 @@ module RSolr
   
   module Ext
     
-    VERSION = '0.7.12'
+    VERSION = '0.7.3'
     
     autoload :Request, 'rsolr-ext/request.rb'
     autoload :Response, 'rsolr-ext/response.rb'

data/rsolr-ext.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 	s.name = "rsolr-ext"
-	s.version = "0.7.12"
-	s.date = "2009-05-11"
+	s.version = "0.7.31"
+	s.date = "2009-05-27"
 	s.summary = "An extension lib for RSolr"
 	s.email = "goodieboy@gmail.com"
 	s.homepage = "http://github.com/mwmitchell/rsolr_ext"
@@ -23,6 +23,7 @@ Gem::Specification.new do |s|
     
     "lib/rsolr-ext/response/docs.rb",
     "lib/rsolr-ext/response/facets.rb",
+    "lib/rsolr-ext/response/spelling.rb",
     "lib/rsolr-ext/response.rb",
     
     "lib/rsolr-ext.rb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mwmitchell-rsolr-ext
 version: !ruby/object:Gem::Version 
-  version: 0.7.12
+  version: 0.7.31
 platform: ruby
 authors: 
 - Matt Mitchell
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-11 00:00:00 -07:00
+date: 2009-05-27 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -31,6 +31,7 @@ files:
 - lib/rsolr-ext/request.rb
 - lib/rsolr-ext/response/docs.rb
 - lib/rsolr-ext/response/facets.rb
+- lib/rsolr-ext/response/spelling.rb
 - lib/rsolr-ext/response.rb
 - lib/rsolr-ext.rb
 - LICENSE