mwmitchell-rsolr-ext 0.7.4 → 0.7.5

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 = {
+  solr_params = RSolr::Ext.map_params(
     :page=>2,
     :per_page=>10,
     :phrases=>{:name=>'This is a phrase'},
@@ -10,39 +10,53 @@ 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::Ext.connect
+  rsolr = RSolr.connect
   
   response = rsolr.select(solr_params)
 
 ==Response Example
-  rsolr = RSolr::Ext.connect
+  rsolr = RSolr.connect
   
-  response = rsolr.select(:q=>'*:*)
+  raw_response = rsolr.select(:q=>'*:*)
+  r = RSolr::Ext::wrap_response(raw_response)
   
-  response.ok?
-  response.params
-  response.docs
-  response.docs.previous_page
-  response.docs.next_page
-  response.facets
+  r.ok?
+  r.params
+  r.docs
+  r.docs.previous_page
+  r.docs.next_page
+  r.facets
 
 You can access values in the response hash using symbols or strings.
 
 ===Doc Pagination
-If you wanna paginate, just throw the collection into the WillPaginate view helper.
-  <%= will_paginate response.docs %>
+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 Doc Module
-You can create your own "models" using RSolr::Ext::Doc
+==The Findable Module
 
-  class Book
-    include RSolr::Ext::Doc
-    def self.find_by_author(author)
-        find(:fq=>'object_type:"book"', :rows=>10, :phrase_filters=>{:author=>author})
-    end
-  end
+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'}
   
-  all_books = Book.find('*:*')
-  hawk_books = Book.find_by_author('hawk')
+  # q=something -- the entire response
+  solr_response = solr.find {:q=>'something'}, :include_response=>true

data/lib/rsolr-ext.rb

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

data/lib/rsolr-ext/doc.rb

@@ -41,19 +41,30 @@ module RSolr::Ext::Doc
   #
   module Findable
     
-    attr_accessor :connection
+    attr_accessor :default_params, :connection
     
     def connection
       @connection ||= RSolr::Ext.connect
     end
     
+    def default_params
+      @default_params ||= {:qt=>:standard, :rows=>10}
+    end
+    
     def find(*args)
-      mode, solr_params, opts = connection.send(:extract_find_opts!, *args)
-      connection.find(*[mode, solr_params, opts]) { |doc| self.new(doc) }
+      call_finder_method(:find, *args)
+    end
+    
+    def find_by_id(*args)
+      call_finder_method(:find_by_id, *args)
     end
     
-    def find_by_id(id, solr_params={}, opts={})
-      connection.find_by_id(id, solr_params, opts) { |doc| self.new(doc) }
+    protected
+    
+    def call_finder_method(method_name, *args)
+      mode, params, opts = connection.send(:extract_find_opts!, *args)
+      params.merge!(default_params)
+      connection.send(method_name, *[mode, params, opts]) { |doc| self.new(doc) }
     end
     
   end
@@ -63,21 +74,16 @@ module RSolr::Ext::Doc
   def self.included(base)
     base.extend Callbacks
     base.extend Findable
-    base.send :include, RSolr::Ext::Response::Docs::Accessible
   end
   
   # The original object passed in to the #new method
   attr :_source_hash
   
-  # The original object passed, converted to a mash
-  attr :_source_mash
-  
   # Constructor **for the class that is getting this module included**
   # source_doc should be a hash or something similar
   # calls each of after_initialize blocks
   def initialize(source_doc={})
     @_source_hash = source_doc
-    @_source_mash = source_doc.to_mash
     self.class.hooks.each do |h|
       instance_eval &h
     end
@@ -85,14 +91,14 @@ module RSolr::Ext::Doc
   
   # for easy access to the solr id (route helpers etc..)
   def id
-    @_source_mash['id']
+    @_source_hash['id']
   end
   
   # the wrapper method to the @_source_hash object.
   # If a method is missing, it gets sent to @_source_hash
   # with all of the original params and block
   def method_missing(m, *args, &b)
-    @_source_mash.send(m, *args, &b)
+    @_source_hash.send(m, *args, &b)
   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] ||= true
+    opts[:include_response] = false unless opts.key?(:include_response)
     
     solr_params[:rows] = 1 if mode == :first
     valid_solr_params = RSolr::Ext.map_params(solr_params)
@@ -64,14 +64,9 @@ module RSolr::Ext::Findable
   end
   
   # find_by_id(10, :handler=>'catalog')
-  # find_by_id(:id=>10)
   def find_by_id(id, solr_params={}, opts={}, &blk)
-    if id.respond_to?(:each_pair)
-      solr_params = id
-    else
-      solr_params[:phrases] ||= {}
-      solr_params[:phrases][:id] = id.to_s
-    end
+    solr_params[:phrases] ||= {}
+    solr_params[:phrases][:id] = id
     self.find(:first, solr_params, opts, &blk)
   end
   
@@ -79,14 +74,16 @@ module RSolr::Ext::Findable
   
   def extract_find_opts!(*args)
     mode = :all
+    # extract the mode (:all or :first)
     valid_modes = [:all, :first]
     if args[0].is_a?(Symbol)
       mode = valid_modes.include?(args[0]) ? args.shift : raise("Invalid find mode; should be :first or :all")
     end
     # extract solr params
-    solr_params = args.shift
+    solr_params = args.shift || {}
+    # create a hash if a string was passed in...
     unless solr_params.respond_to?(:each_pair)
-      solr_params = {:q=>solr_params.to_s}
+      solr_params = {:q=>solr_params}
     end
     # extract options
     opts = args.shift || {}

data/lib/rsolr-ext/request/queryable.rb

@@ -32,11 +32,6 @@ module RSolr::Ext::Request::Queryable
       return value.collect do |(k,v)|
         if v.is_a?(Range)
           "#{k}:#{build_range(v)}"
-        # If the value is an array, we want the same param, multiple times (not a query join)
-        elsif v.is_a?(Array)
-          v.collect do |vv|
-            "#{k}:#{build_query(vv, quote_string)}"
-          end
         else
           "#{k}:#{build_query(v, quote_string)}"
         end

data/lib/rsolr-ext/response.rb

@@ -2,7 +2,6 @@ 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
     
@@ -25,18 +24,12 @@ module RSolr::Ext::Response
     
     def initialize(*args)
       super(*args)
-      extend Docs
-      extend Facets
-      extend Spelling
+      extend Docs if self['response']['docs']
+      extend Facets if key?('facet_counts')
     end
     
     def response
-      self[:response]
-    end
-    
-    # short cut to response['numFound']
-    def total
-      response[:numFound]
+      self['response']
     end
     
   end

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

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

data/rsolr-ext.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 	s.name = "rsolr-ext"
-	s.version = "0.7.4"
-	s.date = "2009-07-31"
+	s.version = "0.7.5"
+	s.date = "2009-05-04"
 	s.summary = "An extension lib for RSolr"
 	s.email = "goodieboy@gmail.com"
 	s.homepage = "http://github.com/mwmitchell/rsolr_ext"
@@ -23,8 +23,6 @@ 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",
@@ -40,7 +38,5 @@ Gem::Specification.new do |s|
 	  'test/test_unit_test_case.rb',
 	  'test/helper.rb'
 	]
-	
 	s.extra_rdoc_files = %w(LICENSE README.rdoc)
-	
 end

data/test/request_test.rb

@@ -25,10 +25,10 @@ class RSolrExtRequestTest < Test::Unit::TestCase
   test 'fq param using the phrase_filters mapping' do
     std = RSolr::Ext::Request::Standard.new
     solr_params = std.map(
-      :phrase_filters=>{:manu=>['Apple', 'ASG'], :color=>['red', 'blue']}
+      :phrase_filters=>[{:manu=>'Apple'}, {:color=>'red'}]
     )
-    expected = {:fq=>["color:\"red\"", "color:\"blue\"", "manu:\"Apple\"", "manu:\"ASG\""]}
-    assert expected, solr_params
+    assert solr_params[:fq].is_a?(Array)
+    assert solr_params[:fq].first.is_a?(String)
   end
   
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mwmitchell-rsolr-ext
 version: !ruby/object:Gem::Version 
-  version: 0.7.4
+  version: 0.7.5
 platform: ruby
 authors: 
 - Matt Mitchell
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-31 00:00:00 -07:00
+date: 2009-05-04 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -31,7 +31,6 @@ 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
@@ -39,7 +38,6 @@ files:
 - rsolr-ext.gemspec
 has_rdoc: true
 homepage: http://github.com/mwmitchell/rsolr_ext
-licenses: 
 post_install_message: 
 rdoc_options: []
 
@@ -60,7 +58,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: An extension lib for RSolr

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

@@ -1,65 +0,0 @@
-# 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 ||= (
-        word_suggestions = []
-        spellcheck = self.response[:spellcheck]
-        if spellcheck && spellcheck[:suggestions]
-          suggestions = spellcheck[:suggestions]
-          unless 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'] 
-              word_suggestions << term_info['suggestion']['word'] if suggFreq > origFreq
-            end
-          end
-        end
-        word_suggestions.uniq
-      )
-    end
-    
-  end
-  
-end