mwmitchell-rsolr-ext 0.7.1 → 0.7.2

data/README.rdoc

@@ -59,4 +59,20 @@ The #find method provides a convenient way to search solr. Here are some example
   books_about_jefferson = solr.find 'jefferson', :phrase_filters=>{:type=>'book'}
   
   # q=something -- the entire response
-  solr_response = solr.find {:q=>'something'}, :include_response=>true
+  solr_response = solr.find {:q=>'something'}, :include_response=>true
+
+===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})
+    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

@@ -0,0 +1,93 @@
+# include this module into a plain ruby class:
+# class Book
+#   include RSolr::Ext::Doc
+#   connection = RSolr::Ext.connect
+#   default_params = {:phrase_filters=>'type:book'}
+# end
+# 
+# Then:
+# number_10 = Book.find_by_id(10)
+#
+module RSolr::Ext::Doc
+  
+  # Class level methods for altering object instances
+  module Callbacks
+    
+    # creates the @hooks container ("hooks" are blocks or procs).
+    # returns an array
+    def hooks
+      @hooks ||= []
+    end
+    
+    # method that only accepts a block
+    # The block is executed when an object is created via #new -> SolrDoc.new
+    # The blocks scope is the instance of the object.
+    def after_initialize(&blk)
+      hooks << blk
+    end
+    
+    # Removes the current set of after_initialize blocks.
+    # You would use this if you wanted to open a class back up,
+    # but clear out the previously defined blocks.
+    def clear_after_initialize_blocks!
+      @hooks = []
+    end
+    
+  end
+  
+  #
+  # Findable is a module that gets mixed into the SolrDocument class object.
+  # These methods will be available through the class like: SolrDocument.find and SolrDocument.find_by_id
+  #
+  module Findable
+    
+    attr_accessor :connection
+    
+    def connection
+      @connection ||= RSolr::Ext.connect
+    end
+    
+    def find(*args)
+      mode, solr_params, opts = connection.send(:extract_find_opts!, *args)
+      connection.find(*[mode, solr_params, opts]) { |doc| self.new(doc) }
+    end
+    
+    def find_by_id(id, solr_params={}, opts={})
+      connection.find_by_id(id, solr_params, opts) { |doc| self.new(doc) }
+    end
+    
+  end
+  
+  # Called by Ruby Module API
+  # extends this *class* object
+  def self.included(base)
+    base.extend Callbacks
+    base.extend Findable
+  end
+  
+  # The original object passed in to the #new method
+  attr :_source_hash
+  
+  # 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
+    self.class.hooks.each do |h|
+      instance_eval &h
+    end
+  end
+  
+  # for easy access to the solr id (route helpers etc..)
+  def 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_hash.send(m, *args, &b)
+  end
+  
+end

data/lib/rsolr-ext/findable.rb

@@ -34,11 +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)
-    
-    if solr_params.is_a?(String)
-      solr_params = {:q=>solr_params}
-    end
+    opts[:include_response] ||= true
     
     solr_params[:rows] = 1 if mode == :first
     valid_solr_params = RSolr::Ext.map_params(solr_params)
@@ -68,9 +64,14 @@ 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)
-    solr_params[:phrases] ||= {}
-    solr_params[:phrases][:id] = id
+    if id.respond_to?(:each_pair)
+      solr_params = id
+    else
+      solr_params[:phrases] ||= {}
+      solr_params[:phrases][:id] = id.to_s
+    end
     self.find(:first, solr_params, opts, &blk)
   end
   
@@ -78,13 +79,15 @@ 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
+    unless solr_params.respond_to?(:each_pair)
+      solr_params = {:q=>solr_params.to_s}
+    end
     # extract options
     opts = args.shift || {}
     [mode, solr_params, opts]

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

@@ -32,6 +32,11 @@ 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/docs.rb

@@ -84,9 +84,9 @@ module RSolr::Ext::Response::Docs
     d = base['response']['docs']
     d.extend Pageable
     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.total = base['responseHeader']['numFound'].to_s.to_i
+    d.start = base['response']['start'].to_s.to_i
+    d.total = base['response']['numFound'].to_s.to_i
   end
   
   def docs

data/lib/rsolr-ext/response.rb

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

data/lib/rsolr-ext.rb

@@ -23,12 +23,13 @@ module RSolr
   
   module Ext
     
-    VERSION = '0.7.1'
+    VERSION = '0.7.2'
     
     autoload :Request, 'rsolr-ext/request.rb'
     autoload :Response, 'rsolr-ext/response.rb'
     autoload :Mapable, 'rsolr-ext/mapable.rb'
     autoload :Findable, 'rsolr-ext/findable.rb'
+    autoload :Doc, 'rsolr-ext/doc.rb'
     
     # RSolr::Ext.map_params({})
     def self.map_params(r)

data/rsolr-ext.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 	s.name = "rsolr-ext"
-	s.version = "0.7.1"
-	s.date = "2009-05-04"
+	s.version = "0.7.2"
+	s.date = "2009-05-17"
 	s.summary = "An extension lib for RSolr"
 	s.email = "goodieboy@gmail.com"
 	s.homepage = "http://github.com/mwmitchell/rsolr_ext"
@@ -12,6 +12,8 @@ Gem::Specification.new do |s|
     
     "lib/mash.rb",
     
+    "lib/rsolr-ext/doc.rb",
+    
     "lib/rsolr-ext/findable.rb",
     
     "lib/rsolr-ext/mapable.rb",

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'}, {:color=>'red'}]
+      :phrase_filters=>{:manu=>['Apple', 'ASG'], :color=>['red', 'blue']}
     )
-    assert solr_params[:fq].is_a?(Array)
-    assert solr_params[:fq].first.is_a?(String)
+    expected = {:fq=>["color:\"red\"", "color:\"blue\"", "manu:\"Apple\"", "manu:\"ASG\""]}
+    assert expected, solr_params
   end
   
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mwmitchell-rsolr-ext
 version: !ruby/object:Gem::Version 
-  version: 0.7.1
+  version: 0.7.2
 platform: ruby
 authors: 
 - Matt Mitchell
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-04 00:00:00 -07:00
+date: 2009-05-17 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -24,6 +24,7 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - lib/mash.rb
+- lib/rsolr-ext/doc.rb
 - lib/rsolr-ext/findable.rb
 - lib/rsolr-ext/mapable.rb
 - lib/rsolr-ext/request/queryable.rb