mwmitchell-rsolr-ext 0.6.1 → 0.7.0

data/README.rdoc

@@ -1,18 +1,14 @@
 =RSolr::Ext
 A set of helper methods/modules to assist in building Solr queries and handling responses when using the RSolr library.
 
-NOTE: The API for RSolr::Ext is pre 1.0. Things are changing quickly...
-
 ==Request Example
-  std = RSolr::Ext::Request::Standard.new
-  
-  solr_params = std.map(
+  solr_params = RSolr::Ext.map_params(
     :page=>2,
     :per_page=>10,
     :phrases=>{:name=>'This is a phrase'},
     :filters=>['test', {:price=>(1..10)}],
     :phrase_filters=>{:manu=>['Apple']},
-    :q=>'ipod',
+    :queries=>'ipod',
     :facets=>{:fields=>['cat', 'blah']}
   )
   
@@ -24,7 +20,7 @@ NOTE: The API for RSolr::Ext is pre 1.0. Things are changing quickly...
   rsolr = RSolr.connect
   
   raw_response = rsolr.select(:q=>'*:*)
-  r = RSolr::Ext::Response::Standard.new(raw_response)
+  r = RSolr::Ext::wrap_response(raw_response)
   
   r.ok?
   r.params
@@ -32,11 +28,33 @@ NOTE: The API for RSolr::Ext is pre 1.0. Things are changing quickly...
   r.docs.previous_page
   r.docs.next_page
   r.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::Response::Standard.new(raw_response)
+  @response = RSolr::Ext.wrap_response(raw_response)
   # in view:
-  <%= will_paginate @response.docs %>
+  <%= 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:
+  
+  # q=jefferson - returns all docs
+  all_jefferson_docs = find 'jefferson'
+  
+  # q=jefferson&rows=1 -- first doc only
+  a_single_jefferson_doc = find :first, 'jefferson'
+  
+  # q=jefferson&fq=type:"book" - all docs
+  books_about_jefferson = find 'jefferson', :phrase_filters=>{:type=>'book'}
+  
+  # q=something -- the entire response
+  solr_response = find {:q=>'something'}, :include_response=>true

data/lib/rsolr-ext/findable.rb

@@ -0,0 +1,92 @@
+# Findable can be mixed into whatever RSolr.connect returns.
+# RSolr::Ext.connect() does this for you.
+# Findable makes querying solr easier by providing a simple #find method.
+#
+# The #find method behaves differently depending on what you send in.
+#
+# The first argument can be either a symbol (:all, :first)
+# OR
+# a solr params hash
+# OR
+# a string that will be used for the query.
+#
+# If the first argument is a symbol, the second is used for solr params or the query.
+# 
+# If the first argument is :first, then only a single document is returns (:rows=>0)
+# If the first argument is :all, then all documents are returned
+# 
+# If a hash is used for solr params, all of the normal RSolr::Ext::Request::Standard
+# mappings are available (everything else gets passed to solr).
+# 
+# If a string is used, it's set to the :q param.
+#
+# The last argument (after the query or solr params) is used for finding options.
+# The following opts are allowed:
+# :include_response - false is default - whether or not to return the whole solr response or just the doc(s)
+# :handler  - nil is default - the request path (/select or /search etc.)
+module RSolr::Ext::Findable
+  
+  # Examples:
+  # find 'jefferson' # q=jefferson - all docs
+  # find :first, 'jefferson' # q=jefferson&rows=1 - first doc only
+  # find 'jefferson', :phrase_filters=>{:type=>'book'} # q=jefferson&fq=type:"book" - all docs
+  # find {:q=>'something'}, :include_response=>true # q=something -- the entire response
+  def find(*args, &blk)
+    mode, solr_params, opts = extract_find_opts!(*args)
+    
+    opts[:include_response] = false unless opts.key?(:include_response)
+    
+    if solr_params.is_a?(String)
+      solr_params = {:q=>solr_params}
+    end
+    
+    solr_params[:rows] = 1 if mode == :first
+    valid_solr_params = RSolr::Ext.map_params(solr_params)
+    
+    response = opts[:handler] ? send_request(opts[:handler], valid_solr_params) : select(valid_solr_params)
+    return response if response.is_a?(String)
+    
+    response = RSolr::Ext::wrap_response(response)
+    
+    if block_given? and response['response']['docs']
+      # yield each doc if a block is given
+      response['response']['docs'].each_with_index do |doc,i|
+        response['response']['docs'][i] = yield(doc)
+      end
+    end
+    if mode == :first
+      # return only one doc
+      response['response']['docs'].first
+    elsif opts[:include_response] == false
+      # return all docs
+      response['response']['docs']
+    else
+      # return the entire response
+      response
+    end
+  end
+  
+  # find_by_id(10, :handler=>'catalog')
+  def find_by_id(id, solr_params={}, opts={}, &blk)
+    solr_params[:phrases] ||= {}
+    solr_params[:phrases][:id] = id
+    self.find(:first, solr_params, opts, &blk)
+  end
+  
+  protected
+  
+  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 || {}
+    # extract options
+    opts = args.shift || {}
+    [mode, solr_params, opts]
+  end
+  
+end

data/lib/rsolr-ext/request.rb

@@ -10,6 +10,7 @@ module RSolr::Ext::Request
     MAPPED_PARAMS = [
       :per_page,
       :page,
+      :queries, # fielded queries
       :phrases, # quoted q param
       :filters, # fq params
       :phrase_filters, # quoted fq params,
@@ -26,7 +27,11 @@ module RSolr::Ext::Request
       page = page < 1 ? 0 : page
       output[:start] = page * output[:rows]
     end
-
+    
+    def map_queries(value,output)
+      output[:q] = append_to_param(output[:q], build_query(value, false))
+    end
+    
     def map_phrases(value,output)
       output[:q] = append_to_param(output[:q], build_query(value, true))
     end

data/lib/rsolr-ext/response.rb

@@ -24,8 +24,8 @@ module RSolr::Ext::Response
     
     def initialize(*args)
       super(*args)
-      extend Docs
-      extend Facets
+      extend Docs if self['response']['docs']
+      extend Facets if key?('facet_counts')
     end
     
     def response

data/lib/rsolr-ext.rb

@@ -16,16 +16,37 @@ unless Hash.respond_to?(:to_mash)
   end
 end
 
+require 'rubygems'
+require 'rsolr'
+
 module RSolr
   
   module Ext
     
-    VERSION = '0.6.1'
+    VERSION = '0.7.0'
     
     autoload :Request, 'rsolr-ext/request.rb'
     autoload :Response, 'rsolr-ext/response.rb'
     autoload :Mapable, 'rsolr-ext/mapable.rb'
-    autoload :Access, 'rsolr-ext/access.rb'
+    autoload :Findable, 'rsolr-ext/findable.rb'
+    
+    # RSolr::Ext.map_params({})
+    def self.map_params(r)
+      RSolr::Ext::Request::Standard.new.map(r)
+    end
+    
+    # RSolr::Ext.wrap_response({})
+    def self.wrap_response(r)
+      RSolr::Ext::Response::Standard.new(r)
+    end
+    
+    # c = RSolr::Ext.connect
+    # c.find(:q=>'*:*').docs.size
+    def self.connect(*args)
+      connection = RSolr.connect(*args)
+      connection.extend RSolr::Ext::Findable
+      connection
+    end
     
   end
   

data/rsolr-ext.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
 	s.name = "rsolr-ext"
-	s.version = "0.6.1"
+	s.version = "0.7.0"
 	s.date = "2009-05-04"
 	s.summary = "An extension lib for RSolr"
 	s.email = "goodieboy@gmail.com"
@@ -12,6 +12,8 @@ Gem::Specification.new do |s|
     
     "lib/mash.rb",
     
+    "lib/rsolr-ext/findable.rb",
+    
     "lib/rsolr-ext/mapable.rb",
     
     "lib/rsolr-ext/request/queryable.rb",
@@ -28,6 +30,7 @@ Gem::Specification.new do |s|
     "rsolr-ext.gemspec"
 	]
 	s.test_files = [
+	  'test/findable_test.rb',
 	  'test/request_test.rb',
 	  'test/response_test.rb',
 	  'test/test_unit_test_case.rb',

data/test/findable_test.rb

@@ -0,0 +1,12 @@
+require 'test_unit_test_case'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'rsolr-ext')
+require 'helper'
+
+class RSolrExtFindableTest < Test::Unit::TestCase
+  
+  test 'RSolr::connect' do
+    connection = RSolr::Ext.connect
+    assert connection.respond_to?(:find)
+  end
+  
+end

data/test/request_test.rb

@@ -11,7 +11,7 @@ class RSolrExtRequestTest < Test::Unit::TestCase
       :phrases=>{:name=>'This is a phrase'},
       :filters=>['test', {:price=>(1..10)}],
       :phrase_filters=>{:manu=>['Apple']},
-      :q=>'ipod',
+      :queries=>'ipod',
       :facets=>{:fields=>['cat', 'blah']}
     )
     assert_equal ["test", "price:[1 TO 10]", "manu:\"Apple\""], solr_params[:fq]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mwmitchell-rsolr-ext
 version: !ruby/object:Gem::Version 
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors: 
 - Matt Mitchell
@@ -24,6 +24,7 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - lib/mash.rb
+- lib/rsolr-ext/findable.rb
 - lib/rsolr-ext/mapable.rb
 - lib/rsolr-ext/request/queryable.rb
 - lib/rsolr-ext/request.rb
@@ -61,6 +62,7 @@ signing_key:
 specification_version: 2
 summary: An extension lib for RSolr
 test_files: 
+- test/findable_test.rb
 - test/request_test.rb
 - test/response_test.rb
 - test/test_unit_test_case.rb