mwmitchell-rsolr 0.5.9 → 0.6.1

data/CHANGES.txt

@@ -1,3 +1,13 @@
+0.6.1 - January 13, 2009
+	Removed SearchExt and mapping until this library gets some real use
+	The only param mapping now is for :page and :per_page via the #search method
+	The Connection::Base #query method does NO mapping now
+	
+0.6.0 - January 9, 2009
+	Removed first argument from RSolr.connect, the "adapter_name"
+		The adapter is now set using the :adapter key when passing in options to RSolr.connect:
+		s = RSolr.connect(:adapter=>:direct)
+	
 0.5.9 - January 7, 2009
 	Finally brought in the ExtLib Mash classes for incoming params and response hashes from solr
 	  - this gives the ability to access/set values for hashes using strings OR symbols (HashWithIndifferentAccess)

data/README.rdoc

@@ -9,7 +9,7 @@ A Ruby client for Apache Solr. Has transparent JRuby support by using "org.apach
 Simple usage:
   require 'rubygems'
   require 'rsolr'
-  rsolr = RSolr.connect(:http)
+  rsolr = RSolr.connect
   response = rsolr.query(:q=>'*:*')
 
 
@@ -22,15 +22,15 @@ To run tests:
 
 To get a connection in MRI/standard Ruby:
   
-  solr = RSolr.connect(:http)
+  solr = RSolr.connect
 
 To get a direct connection (no http) in jRuby using DirectSolrConnection:
   
-  solr = RSolr.connect(:direct, :home_dir=>'/path/to/solr/home', :dist_dir=>'/path/to/solr/distribution')
+  solr = RSolr.connect(:adapter=>:direct, :home_dir=>'/path/to/solr/home', :dist_dir=>'/path/to/solr/distribution')
 
 You can set RSolr params that will be sent on every request:
   
-  solr = RSolr.connect(:http, :global_params=>{:wt=>:ruby, :echoParams=>'EXPLICIT'})
+  solr = RSolr.connect(:global_params=>{:wt=>:ruby, :echoParams=>'EXPLICIT'})
 
 
 == Requests
@@ -38,22 +38,17 @@ Once you have a connection, you can execute queries, updates etc..
 
 
 === Querying
+Use the #query method to send requests to Solr as-is (no param mapping)
+Use the #search method to take advantage of some of the param mapping (currently only :page and :per_page)
   response = solr.query(:q=>'washington', :facet=>true, :facet.limit=>-1, :facet.field=>'cat', :facet.field=>'inStock')
   response = solr.find_by_id(1)
 
 Thanks to a little Ruby magic, we can chain symbols to create Solr "dot" syntax: :facet.field=>'cat'
 
-Using the #search method makes building more complex Solr queries easier:
-  
-  response = solr.search 'my search', :filters=>{:price=>(0.00..10.00)}
-  response.docs.each do |doc|
-    doc[:price]
-  end
-
 ====Pagination
-Pagination is simplified by using the :page and :per_page params:
+Pagination is simplified by using the :page and :per_page params when using the #search method:
 
-  response = solr.query(:page=>1, :per_page=>10, :q=>'*:*')
+  response = solr.search(:page=>1, :per_page=>10, :q=>'*:*')
   response.per_page
   response.total_pages
   response.current_page
@@ -64,7 +59,9 @@ If you use WillPaginate, just pass-in the response to the #will_paginate view he
   
   <%= will_paginate(@response) %>
 
-The #query and #search methods automatically figure out the :start and :rows value, based on the values of :page and :per_page. The will_paginate view helper just needs the right methods (#current_page, #previous_page, #next_page and #total_pages) to create the pagination view widget.
+The #search method automatically figure out the :start and :rows value, based on the values of :page and :per_page. The will_paginate view helper just needs the right methods (#current_page, #previous_page, #next_page and #total_pages) to create the pagination view widget.
+
+The #search method will be providing more param mapping, but not until RSolr gets more use. If you have ideas for a param mapping interface, let me know!
 
 
 === Updating Solr

data/lib/rsolr/connection/base.rb

@@ -5,8 +5,6 @@ class RSolr::Connection::Base
   
   attr_reader :adapter, :opts
   
-  include RSolr::Connection::SearchExt
-  
   # "adapter" is instance of:
   #   RSolr::Adapter::HTTP
   #   RSolr::Adapter::Direct (jRuby only)
@@ -25,19 +23,26 @@ class RSolr::Connection::Base
   # sets default params etc.. - could be used as a mapping hook
   # type of request should be passed in here? -> map_params(:query, {})
   def map_params(params)
-    opts[:global_params].dup.merge(params).to_mash
+    {}.merge(@opts[:global_params]).merge(params).to_mash
   end
   
-  # send request to the select handler
+  # send request (no param mapping) to the select handler
   # params is hash with valid solr request params (:q, :fl, :qf etc..)
   #   if params[:wt] is not set, the default is :ruby (see opts[:global_params])
   #   if :wt is something other than :ruby, the raw response body is returned
   #   otherwise, an instance of RSolr::Response::Query is returned
   #   NOTE: to get raw ruby, use :wt=>'ruby'
+  # There is NO param mapping here, what you put it is what gets sent to Solr
   def query(params)
-    params = map_params(modify_params_for_pagination(params))
-    response = @adapter.query(params)
-    params[:wt]==:ruby ? RSolr::Response::Query::Base.new(response) : response
+    p = map_params(params)
+    response = @adapter.query(p)
+    p[:wt]==:ruby ? RSolr::Response::Query::Base.new(response) : response
+  end
+  
+  # same as the #query method, but with additional param mapping
+  # currently only :page and :per_page
+  def search(params)
+    self.query(modify_params_for_pagination(params))
   end
   
   # Finds a document by its id
@@ -103,19 +108,13 @@ class RSolr::Connection::Base
     RSolr::Message
   end
   
-  def modify_params_for_pagination(orig_params)
-    return orig_params unless orig_params[:page] || orig_params[:per_page]
-    params = orig_params.dup # be nice
-    params[:page] ||= 1
-    params[:per_page] ||= 10
-    params[:rows] = params.delete(:per_page).to_i
-    params[:start] = calculate_start(params.delete(:page).to_i, params[:rows])
-    params
-  end
-  
-  def calculate_start(current_page, per_page)
-    page = current_page > 0 ? current_page : 1
-    (page - 1) * per_page
+  def modify_params_for_pagination(p)
+    per_page = p.delete(:per_page).to_s.to_i
+    p[:rows] = per_page==0 ? 10 : per_page
+    page = p.delete(:page).to_s.to_i
+    page = page > 0 ? page : 1
+    p[:start] = (page - 1) * (p[:rows] || 0)
+    p
   end
   
 end

data/lib/rsolr/connection.rb

@@ -1,7 +1,6 @@
 module RSolr::Connection
   
   autoload :Base, 'rsolr/connection/base'
-  autoload :SearchExt, 'rsolr/connection/search_ext'
   autoload :Adapter, 'rsolr/connection/adapter'
   
 end

data/lib/rsolr.rb

@@ -7,7 +7,7 @@ proc {|base, files|
 
 module RSolr
   
-  VERSION = '0.5.9'
+  VERSION = '0.6.0'
   
   autoload :Message, 'rsolr/message'
   autoload :Response, 'rsolr/response'
@@ -17,10 +17,11 @@ module RSolr
   autoload :HTTPClient, 'rsolr/http_client'
   
   # factory for creating connections
-  # adapter name is either :http or :direct
+  # opts[:adapter] is either :http or :direct
   # opts are sent to the adapter instance (:url for http, :dist_dir for :direct etc.)
   # and to the connection instance
-  def self.connect(adapter_name, opts={})
+  def self.connect(opts={})
+    adapter_name = opts[:adapter] ||= :http
     types = {
       :http=>'HTTP',
       :direct=>'Direct'

data/test/connection/direct_test.rb

@@ -12,7 +12,7 @@ class ConnectionDirectTest < RSolrBaseTest
     base = File.expand_path( File.dirname(__FILE__) )
     dist = File.join(base, '..', '..', 'apache-solr')
     home = File.join(dist, 'example', 'solr')
-    @solr = RSolr.connect(:direct, :home_dir=>home, :dist_dir=>dist)
+    @solr = RSolr.connect(:adapter=>:direct, :home_dir=>home, :dist_dir=>dist)
     @solr.delete_by_query('*:*')
     @solr.commit
   end

data/test/connection/http_test.rb

@@ -9,7 +9,7 @@ unless defined?(JRUBY_VERSION)
     include ConnectionTestMethods
   
     def setup
-      @solr = RSolr.connect :http
+      @solr = RSolr.connect
       @solr.delete_by_query('*:*')
       @solr.commit
     end

data/test/connection/test_methods.rb

@@ -22,13 +22,13 @@ module ConnectionTestMethods
   
   # setting adapter options in Solr.connect method should set them in the adapter
   def test_set_adapter_options
-    solr = RSolr.connect(:http, :select_path=>'/select2')
+    solr = RSolr.connect(:select_path=>'/select2')
     assert_equal '/select2', solr.adapter.opts[:select_path]
   end
   
   # setting connection options in Solr.connect method should set them in the connection
   def test_set_connection_options
-    solr = RSolr.connect(:http, :default_wt=>:json)
+    solr = RSolr.connect(:default_wt=>:json)
     assert_equal :json, solr.opts[:default_wt]
   end
   

data/test/response/pagination_test.rb

@@ -11,9 +11,9 @@ class ResponsePaginationTest < RSolrBaseTest
   # test the Solr::Connection pagination methods
   def test_connection_calculate_start
     dummy_connection = RSolr::Connection::Base.new(nil)
-    assert_equal 15, dummy_connection.send(:calculate_start, 2, 15)
-    assert_equal 450, dummy_connection.send(:calculate_start, 10, 50)
-    assert_equal 0, dummy_connection.send(:calculate_start, 0, 50)
+    #assert_equal 15, dummy_connection.send(:calculate_start, 2, 15)
+    #assert_equal 450, dummy_connection.send(:calculate_start, 10, 50)
+    #assert_equal 0, dummy_connection.send(:calculate_start, 0, 50)
   end
   
   def test_connection_modify_params_for_pagination

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mwmitchell-rsolr
 version: !ruby/object:Gem::Version 
-  version: 0.5.9
+  version: 0.6.1
 platform: ruby
 authors: 
 - Matt Mitchell
@@ -43,7 +43,6 @@ files:
 - lib/rsolr/connection/adapter/http.rb
 - lib/rsolr/connection/adapter.rb
 - lib/rsolr/connection/base.rb
-- lib/rsolr/connection/search_ext.rb
 - lib/rsolr/connection.rb
 - lib/rsolr/http_client/adapter/curb.rb
 - lib/rsolr/http_client/adapter/net_http.rb
@@ -104,7 +103,6 @@ test_files:
 - test/response/base_test.rb
 - test/response/pagination_test.rb
 - test/response/query_test.rb
-- test/response/search_ext_test.rb
 - test/rsolr_test
 - test/ruby-lang.org.rss.xml
 - test/test_helpers.rb

data/lib/rsolr/connection/search_ext.rb

@@ -1,134 +0,0 @@
-module RSolr::Connection::SearchExt
-  
-  # TODO : clean this thing up dude
-  
-  def search(params={})
-    params = params.to_mash
-    if params[:fields]
-      fields = params.delete :fields
-      params[:fl] = fields.is_a?(Array) ? fields.join(' ') : fields
-    end
-    
-    # adds quoted values to the :filters hash
-    if params[:phrase_filters]
-      phrase_filters = params.delete(:phrase_filters)
-      params[:filters] ||= {}
-      phrase_filters.each do |filter,values|
-        values = [values] unless values.is_a?(Array)
-        params[:filters][filter] ||= []
-        params[:filters][filter] = [params[:filters][filter]] unless params[:filters][filter].is_a?(Array)
-        values.each do |v|
-          params[:filters][filter] << %(\"#{v}\")
-        end
-      end
-    end
-    
-    if params[:filters]
-      filter_params = params.delete(:filters)
-      params[:fq] = build_filters(filter_params)
-    end 
-    facets = params.delete(:facets) if params[:facets]
-    
-    if facets
-      if facets.is_a?(Array)
-        params.merge!({:facet => true})
-        params.merge! build_facets(facets)          
-      elsif facets.is_a?(Hash)
-        params.merge!({:facet => true})
-        #params += build_facet(facets)
-      elsif facets.is_a?(String)
-        #params += facets
-      else
-        raise 'facets must either be a Hash or an Array'
-      end
-    end
-    #params[:qt] ||= :dismax
-    params[:q] = build_query(params[:q])
-    self.query params
-  end
-  
-  protected
-  
-  # returns the query param
-  def build_query(queries)
-    query_string = ''
-    case queries
-    when String
-      query_string = queries
-    when Array
-      query_string = queries.join(' ')
-    when Hash
-      query_string_array = []
-      queries.each do |k,v|
-        if v.is_a?(Array) # add a filter for each value
-          v.each do |val|
-            query_string_array << "#{k}:#{val}"
-          end
-        elsif v.is_a?(Range)
-          query_string_array << "#{k}:[#{v.min} TO #{v.max}]"
-        else
-          query_string_array << "#{k}:#{v}"
-        end
-      end
-      query_string = query_string_array.join(' ')
-    end
-    query_string
-  end
-
-  def build_filters(filters)
-    params = []
-    # handle "ruby-ish" filters
-    case filters
-    when String
-      params << filters
-    when Array
-      filters.each { |f| params << f }
-    when Hash
-      filters.each do |k,v|
-        if v.is_a?(Array) # add a filter for each value
-          v.each do |val|
-            params << "#{k}:#{val}"
-          end
-        elsif v.is_a?(Range)
-          params << "#{k}:[#{v.min} TO #{v.max}]"
-        else
-          params << "#{k}:#{v}"
-        end
-      end
-    end
-    params
-  end
-  
-  def build_facets(facet_array)
-    facet_array.inject({}) do |p, facet_hash|
-      build_facet(facet_hash).each {|k| p.merge!(k) }
-      p
-    end
-  end
-
-  def build_facet(facet_hash)
-    params = []
-    facet_name = facet_hash['name'] || facet_hash[:name]
-    facet_hash.each do |k,v|
-      # handle some cases specially
-      if 'field' == k.to_s
-        params << {"facet.field" => v}
-      elsif 'query' == k.to_s
-        q = build_query(v)
-        params << {"facet.query"=>q}
-        if facet_name
-          # keep track of names => facet_queries
-          name_to_facet_query[facet_name] = q['facet.query']
-        end
-      else
-        params << {"f.#{facet_hash[:field]}.facet.#{k}" => v}
-      end
-    end
-    params
-  end
-  
-  def name_to_facet_query
-    @name_to_facet_query ||= {}
-  end
-
-end

data/test/response/search_ext_test.rb

@@ -1,19 +0,0 @@
-require File.join(File.dirname(__FILE__), '..', 'test_helpers')
-
-class ResponseSearchExtTest < RSolrBaseTest
-  
-  def test_facet_response_methods
-=begin
-    @response.facets
-    @response.facet_fields
-    @response.facet_queries
-    @response.facet_fields_by_hash
-    @response.facet_field(:feed_language_facet)
-    @response.facet_field_values(:feed_language_facet)
-    @response.facet_field_by_hash(:feed_language_facet)
-    @response.facet_field_by_hash(:feed_language_facet)
-    @response.facet_field_count(:feed_title_facet, 'ScienceDaily: Latest Science News')
-=end
-  end
-  
-end