delsolr 0.0.6 → 0.1.0

data/README.txt

@@ -30,10 +30,10 @@ Example:
 
     c = DelSolr::Client.new(:server => 'solr1', :port => 8983)
     rsp = c.query('dismax', :query => 'mp3 player',
-                            :filters => {:cost => (50..100)},
+                            :filters => {:cost => (50..100), :localparams => {:tag => 'cost_filter'}},
                             :facets => [{:field => 'brand', :limit => 10},
                                         {:query => {:onsale => true, :brand => 'Apple'},
-                                         :name => 'cheap_apple'}])
+                                         :localparams => {:key => 'cheap_apple', :ex => 'cost_filter'}}])
 
     # output total matches
     puts rsp.total
@@ -47,7 +47,7 @@ Example:
     end
 
     # output a query facet
-    puts "Cheap Apple stuff: #{rsp.facet_query_count_by_name('cheap_apple')}"
+    puts "Cheap Apple stuff: #{rsp.facet_query_count_by_key('cheap_apple')}"
 
     # adding things
     doc = DelSolr::Document.new
@@ -60,10 +60,13 @@ Example:
     rsp = c.query('dismax', :query => 'shuffle mp3 player')
     puts rsp.ids[0]
 
+	# using local params for filters / facets
+	Use :localparams => {} syntax to add local params to filters and facets
+
 
 == REQUIREMENTS:
 
-You need Solr installed somewhere so you can query it ;)
+You need Solr(1.4 or higher) installed somewhere so you can query it ;)
 
 == INSTALL:
 

data/lib/delsolr/query_builder.rb

@@ -1,13 +1,13 @@
 require 'cgi'
 
 module DelSolr
-  
+
   class Client
-    
+
     class QueryBuilder
-      
+
       FL_DEFAULTS = 'id,unique_id,score' # redefine if you really want to change this.
-      
+
       attr_accessor :query_name, :options
 
       # ops can basically be straight solr URL params, but it also supports some other formats
@@ -21,22 +21,17 @@ module DelSolr
       def request_string
         @request_string ||= build_request_string
       end
-      
-      # returns the query string of the facet query for the given query name (used for resolving counts for given queries)
-      def facet_query_by_name(query_name)
-        name_to_facet_query[query_name]
-      end
-      
-    private
-      
+
+      private
+
       def build_request_string()
         raise "query_name must be set" if query_name.blank?
-        
+
         opts = self.options.dup
-        
+
         # cleanup the nils
         opts.delete_if {|k,v| v.nil?}
-        
+
         # resolve "rubyish" names to solr names
         opts[:q] ||= opts[:query]
         opts[:rows] ||= opts[:limit] || 10
@@ -46,9 +41,9 @@ module DelSolr
         opts[:bq] ||= opts[:boost]
         opts[:suggestionCount] ||= opts[:suggestion_count]
         opts[:onlyMorePopular] ||= opts[:only_more_popular]
-        
+
         raise ":query or :q must be set" if opts[:q].nil? || opts[:q].empty?
-        
+
         # clear out the "rubyish" versions, what's left will go straight to solr
         opts.delete(:query)
         opts.delete(:limit)
@@ -57,7 +52,7 @@ module DelSolr
         opts.delete(:boost)
         opts.delete(:suggestion_count)
         opts.delete(:only_more_popular)
-        
+
         # needs to be an array of hashs because it's acceptable to have the same key present > once.
         params = []
 
@@ -88,7 +83,7 @@ module DelSolr
             raise 'facets must either be a Hash or an Array'
           end
         end
-        
+
         # handle friendly highlight name
         if opts.delete(:highlight)
           params << {:hl => 'true'}
@@ -109,12 +104,12 @@ module DelSolr
             raise "All params should be a Hash or String"
           end
         end
-        
+
         "/select?#{param_strings.join('&')}"
       end
-      
+
       # returns the query param
-      def build_query(key, queries)
+      def build_query(key, queries, localparams = "")
         query_string = ''
         case queries
         when String
@@ -128,7 +123,9 @@ module DelSolr
           end
           query_string = query_string_array.join(' ')
         end
-        
+
+        query_string = localparams + query_string
+
         {key => query_string}
       end
 
@@ -144,7 +141,7 @@ module DelSolr
           str = "#{k}:[#{v.begin} TO #{v.end}]"
         elsif v.is_a?(String)
           if v =~ /\s/ && # if it contains a space, we may need to quote it
-             !(v =~ /^\[.+ TO .+\]$/) # HACK: if the string is a range query, do not wrap it in quotes
+            !(v =~ /^\[.+ TO .+\]$/) # HACK: if the string is a range query, do not wrap it in quotes
             str = "#{k}:\"#{v}\""
           else
             str = "#{k}:#{v}"
@@ -154,10 +151,10 @@ module DelSolr
         end
         str
       end
-      
+
       def build_filters(key, filters)
         params = []
-        
+
         # handle "ruby-ish" filters
         case filters
         when String
@@ -167,13 +164,15 @@ module DelSolr
             params += build_filters(key, f) # recusively add all the filters in the array
           end
         when Hash
+          filters_local_params = build_local_params(filters['localparams'] || filters[:localparams])
           filters.each do |k,v|
-            params << {key => key_value_pair_string(k, v)} unless v.nil?
+            next if ['localparams', :localparams].include?(k.to_s)
+            params << {key => filters_local_params + key_value_pair_string(k, v)} unless v.nil?
           end
         end
         params
       end
-      
+
       def build_facets(facet_array)
         params = []
         facet_array.each do |facet_hash|
@@ -181,34 +180,53 @@ module DelSolr
         end
         params
       end
-      
+
       def build_facet(facet_hash)
         params = []
         facet_name = facet_hash['name'] || facet_hash[:name]
+        unless facet_name.blank?
+          facet_hash[:localparams] ||= {}
+          facet_hash[:localparams][:key] ||= facet_name
+        end
+        facet_local_params = build_local_params(facet_hash['localparams'] || facet_hash[:localparams])
         facet_hash.each do |k,v|
           # handle some cases specially
           if 'field' == k.to_s
-            params << {"facet.field" => v}
+            params << {"facet.field" => "#{facet_local_params}#{v}"}
           elsif 'query' == k.to_s
-            q = build_query("facet.query", v)
-            params << q
-            if facet_name
-              # keep track of names => facet_queries
-              name_to_facet_query[facet_name] = q['facet.query']
-            end
-          elsif ['name', :name].include?(k.to_s)
+            params << build_query("facet.query", v, facet_local_params)
+          elsif ['localparams', :localparams, 'name', :name].include?(k.to_s)
             # do nothing
           else
-            params << {"f.#{facet_hash[:field]}.facet.#{k}" => v}
+            params << {"f.#{facet_hash[:field]}.facet.#{k}" => "#{facet_local_params}#{v}"}
           end
         end
         params
       end
-      
-      def name_to_facet_query
-        @name_to_facet_query ||= {}
+
+      def build_local_params_array(local_params)
+        local_params_array = []
+        case local_params
+        when String
+          local_params_array << local_params
+        when Array
+          local_params.each do |p|
+            local_params_array << build_local_params_array(p)
+          end
+        when Hash
+          local_params.each do |k,v|
+            local_params_array << "#{k}=#{v}"
+          end
+        end
+        local_params_array
       end
-      
+
+      def build_local_params(local_params)
+        local_params_array = build_local_params_array(local_params)
+
+        local_params_array.empty? ? "" : "{!#{local_params_array.join(" ")}}"
+      end
+
     end
   end
 end

data/lib/delsolr/response.rb

@@ -174,10 +174,10 @@ module DelSolr
       end
       
       # Returns the counts for a given facet_query_name
-      def facet_query_count_by_name(facet_query_name)
-        query_string = query_builder.facet_query_by_name(facet_query_name)
-        facet_queries[query_string] if query_string
+      def facet_query_count_by_key(facet_query_key)
+        facet_queries[facet_query_key.to_s]
       end
+      alias :facet_query_count_by_name :facet_query_count_by_key
       
       # Returns the url sent to solr
       def request_url

data/lib/delsolr.rb

@@ -100,7 +100,7 @@ module DelSolr
     #   
     #          c.query('standard', :query => 'abc',
     #                              :facets => [:query => {:city => 'seattle', :instock => true},
-    #                                          :name => 'seattle_instock'}])
+    #                                          :prefix => {:key => 'seattle_instock'}}])
     #          
     #   ...will request counts for the number of documents where "seattle" matches on the "city" field and "instock" is set to true.
     #   Faceting by query requires you to assign a name to the facet so the counts can easily be fetched from the response.  Solr 
@@ -109,7 +109,7 @@ module DelSolr
     #    
     #   The count for this facet query can be pulled like so:
     #   
-    #          rsp.facet_query_count_by_name('seattle_instock').
+    #          rsp.facet_query_count_by_key('seattle_instock').
     # 
     # [<b><tt>:sorts</tt></b>]
     #   (optional) array or string of sorts in Lucene syntax (<fieldname> <asc/desc>)

data/test/test_query_builder.rb

@@ -18,10 +18,10 @@ class QueryBuilderTest < Test::Unit::TestCase
     assert(qb)
     
     p = get_params(qb.request_string)
-    assert_equal(p['start'], '3')
-    assert_equal(p['rows'], '13')
-    assert_equal(p['fl'], 'id')
-    assert_equal(p['q'], 'good book')
+    assert_equal('3', p['start'])
+    assert_equal('13', p['rows'])
+    assert_equal('id', p['fl'])
+    assert_equal('good book', p['q'])
   end
   
   def test_002
@@ -36,8 +36,8 @@ class QueryBuilderTest < Test::Unit::TestCase
     assert(qb)
     
     p = get_params(qb.request_string)
-    assert_equal(p['fl'], 'id,unique_id,score')
-    assert_equal(p['q'], 'blahblah')
+    assert_equal('id,unique_id,score', p['fl'])
+    assert_equal('blahblah', p['q'])
   end
   
   def test_003
@@ -52,8 +52,8 @@ class QueryBuilderTest < Test::Unit::TestCase
     assert(qb)
     
     p = get_params(qb.request_string)
-    assert_equal(p['fl'], 'id,unique_id,score')
-    assert_equal(p['q'], 'index_type:books')
+    assert_equal('id,unique_id,score', p['fl'])
+    assert_equal('index_type:books', p['q'])
   end
   
   def test_004
@@ -68,8 +68,8 @@ class QueryBuilderTest < Test::Unit::TestCase
     assert(qb)
     
     p = get_params(qb.request_string)
-    assert_equal(p['fq'], 'location:seattle')
-    assert_equal(p['q'], 'index_type:books')
+    assert_equal('location:seattle', p['fq'])
+    assert_equal('index_type:books', p['q'])
   end
 
   def test_005
@@ -85,8 +85,8 @@ class QueryBuilderTest < Test::Unit::TestCase
 
     p = get_params(qb.request_string)
     
-    assert_equal(p['fq'], 'location:seattle')
-    assert_equal(p['q'], 'index_type:books')
+    assert_equal('location:seattle', p['fq'])
+    assert_equal('index_type:books', p['q'])
   end
   
   def test_facets_001
@@ -101,9 +101,9 @@ class QueryBuilderTest < Test::Unit::TestCase
     
     p = get_params(qb.request_string)
     
-    assert_equal(p['facet'], 'true')
-    assert_equal(p['facet.field'].sort, ['instock_b', 'on_sale_b'].sort)
-    assert_equal(p['f.on_sale_b.facet.limit'], '1')
+    assert_equal('true', p['facet'])
+    assert_equal(['instock_b', 'on_sale_b'].sort, p['facet.field'].sort)
+    assert_equal('1', p['f.on_sale_b.facet.limit'])
   end
   
   def test_facets_002
@@ -118,11 +118,28 @@ class QueryBuilderTest < Test::Unit::TestCase
     
     p = get_params(qb.request_string)
     
-    assert_equal(p['facet'], 'true')
-    assert_equal(p['facet.field'], 'language_idm')
-    assert_equal(p['facet.query'], 'city_idm:19596')
+    assert_equal('true', p['facet'])
+    assert_equal('language_idm', p['facet.field'])
+    assert_equal('{!key=seattle}city_idm:19596', p['facet.query'])
   end
-  
+
+  def test_facets_003
+    qb = nil
+    opts = {}
+    opts[:query] = "games"
+    opts[:facets] = [{:query => {:city_idm => 19596}, :localparams => {:key => 'seattle', :ex => 'exclusion'}}, {:field => 'language_idm'}]
+
+    assert_nothing_raised { qb = DelSolr::Client::QueryBuilder.new('onebox-books', opts) }
+
+    assert(qb)
+
+    p = get_params(qb.request_string)
+
+    assert_equal('true', p['facet'])
+    assert_equal('language_idm', p['facet.field'])
+    assert_equal('{!key=seattle ex=exclusion}city_idm:19596', p['facet.query'])
+  end
+
   def test_range
     qb = nil
     opts = {}
@@ -135,7 +152,7 @@ class QueryBuilderTest < Test::Unit::TestCase
     
     p = get_params(qb.request_string)
     
-    assert_equal('id:[1 TO 3]', p['fq'])
+    assert_equal(p['fq'], 'id:[1 TO 3]')
   end
 
   

data/test/test_response.rb

@@ -75,7 +75,7 @@ class ResponseTest < Test::Unit::TestCase
      },
      'facet_counts'=>{
       'facet_queries'=>{
-        'city_idm:19596' => 392},
+        '19596' => 392},
       'facet_fields'=>{
         'available_b'=>[
           'false',1328],
@@ -97,7 +97,7 @@ class ResponseTest < Test::Unit::TestCase
   
   def test_001
     r = nil
-    qb = DelSolr::Client::QueryBuilder.new('standard', :query => {:index_type => 'widget'}, :facets => {:query => 'city_idm:19596', :name => 19596} )
+    qb = DelSolr::Client::QueryBuilder.new('standard', :query => {:index_type => 'widget'}, :facets => {:query => 'city_idm:19596', :prefix => {:key => 19596}} )
     qb.request_string # need to generate this...
     assert_nothing_raised { r = DelSolr::Client::Response.new(@@test_001, qb) }
     
@@ -114,12 +114,12 @@ class ResponseTest < Test::Unit::TestCase
     assert_equal(1182, r.facet_field_count('onsale_b', false))
     assert_equal(174, r.facet_field_count('onsale_b', true))
     assert_equal(1328, r.facet_field_count('available_b', false))
-    assert_equal(392, r.facet_query_count_by_name(19596))
+    assert_equal(392, r.facet_query_count_by_key(19596))
   end
   
   def test_shortcuts
     r = nil
-    qb = DelSolr::Client::QueryBuilder.new('standard', :query => {:index_type => 'widget'}, :facets => {:query => 'city_idm:19596', :name => 19596} )
+    qb = DelSolr::Client::QueryBuilder.new('standard', :query => {:index_type => 'widget'}, :facets => {:query => 'city_idm:19596', :prefix => {:key => 19596}} )
     qb.request_string # need to generate this...
     assert_nothing_raised { r = DelSolr::Client::Response.new(@@test_001, qb, :shortcuts => [:index_type, :id]) }
     

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 6
-  version: 0.0.6
+  version: 0.1.0
 platform: ruby
 authors: 
 - Ben VandenBos