mwmitchell-rsolr-ext 0.5.0 → 0.5.1

data/lib/rsolr-ext.rb

@@ -15,11 +15,12 @@ module RSolr
   
   module Ext
     
-    VERSION = '0.5.0'
+    VERSION = '0.5.1'
     
     autoload :Request, 'rsolr-ext/request.rb'
     autoload :Response, 'rsolr-ext/response.rb'
     autoload :HashMethodizer, 'rsolr-ext/hash_methodizer.rb'
+    autoload :Mapable, 'rsolr-ext/mapable.rb'
     
   end
   

data/lib/rsolr-ext/request.rb

@@ -1,91 +1,59 @@
 module RSolr::Ext::Request
   
-  # A module that provides method mapping capabilities.
-  # The basic idea is to pass in a hash to the #map method,
-  # the map method then goes through a list of keys to
-  # be processed. Each key name can match a key in the input hash.
-  # If there is a match, a method by the name of "map_#{key}" is
-  # called with the following args: input[key], output_hash
-  # The method is responsible for processing the value.
-  # The return value from the method does nothing.
-  #
-  # For example: if the mapped params list has a name, :query,
-  # there should be a method like: map_query(input_value, output_hash)
-  module Mapable
+  autoload :Queryable, 'rsolr-ext/request/queryable.rb'
+  
+  class Standard
     
-    # accepts an input hash.
-    # prepares a return hash by copying the input.
-    # runs through all of the keys in MAPPED_PARAMS.
-    # calls any mapper methods that match the current key in MAPPED_PARAMS.
-    # The mapped keys from the input hash are deleted.
-    # returns a new hash.
-    def map(input)
-      result = input.dup
-      self.class::MAPPED_PARAMS.each do |meth|
-        input_value = result.delete(meth)
-        next if input_value.to_s.empty?
-        send("map_#{meth}", input_value, result)
-      end
-      result
-    end
+    include RSolr::Ext::Mapable
+    include RSolr::Ext::Request::Queryable
     
-    # creates an array where the "existing_value" param is first
-    # and the "new_value" is the last.
-    # All empty/nil items are removed.
-    # the return result is either the result of the
-    # array being joined on a space, or the array itself.
-    # "auto_join" should be true or false.
-    def append_to_param(existing_value, new_value, auto_join=true)
-      values = [existing_value, new_value]
-      values.delete_if{|v|v.nil?}
-      auto_join ? values.join(' ') : values
+    MAPPED_PARAMS = [
+      :per_page,
+      :page,
+      :phrases, # quoted q param
+      :filters, # fq params
+      :phrase_filters, # quoted fq params,
+      :facets
+    ]
+
+    def map_per_page(value,output)
+      output[:rows] = value.to_i
     end
-    
-  end
-  
-  # a module to help the creation of solr queries.
-  module Queryable
-    
-    # Wraps a string around double quotes
-    def quote(value)
-      %("#{value}")
+
+    def map_page(value,output)
+      raise ':per_page must be set when using :page' unless output[:rows]
+      page = value.to_s.to_i-1
+      page = page < 1 ? 0 : page
+      output[:start] = page * output[:rows]
     end
-    
-    # builds a solr range query from a Range object
-    def build_range(r)
-      "[#{r.min} TO #{r.max}]"
+
+    def map_phrases(value,output)
+      output[:q] = append_to_param(output[:q], build_query(value, true))
+    end
+
+    def map_filters(value,output)
+      output[:fq] = append_to_param(output[:fq], build_query(value))
+    end
+
+    def map_phrase_filters(value,output)
+      output[:fq] = append_to_param(output[:fq], build_query(value, true))
     end
     
-    # builds a solr query fragment
-    # if "quote_string" is true, the values will be quoted.
-    # if "value" is a string/symbol, the #to_s method is called
-    # if the "value" is an array, each item in the array is 
-    # send to build_query (recursive)
-    # if the "value" is a Hash, a fielded query is built
-    # where the keys are used as the field names and
-    # the values are either processed as a Range or
-    # passed back into build_query (recursive)
-    def build_query(value, quote_string=false)
-      case value
-      when String,Symbol
-        return quote_string ? quote(value.to_s) : value.to_s
-      when Array
-        value.collect do |v|
-          build_query(v, quote_string)
-        end.flatten
-      when Hash
-        return value.collect do |(k,v)|
-          if v.is_a?(Range)
-            "#{k}:#{build_range(v)}"
-          else
-            "#{k}:#{build_query(v, quote_string)}"
-          end
-        end.flatten
+    def map_facets(value,output)
+      output[:facet] = true
+      if value[:fields]
+        fields = value[:fields].is_a?(Array) ? value[:fields] : [value[:fields]]
+        fields.each do |f|
+          output['facet.field'] ||= []
+          output['facet.field'] << f
+        end
       end
     end
+    
   end
   
-  autoload :Standard, 'rsolr-ext/request/standard.rb'
-  autoload :Dismax, 'rsolr-ext/request/dismax.rb'
+  class Dismax < Standard
+    
+  end
   
 end

data/rsolr-ext.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
 	s.name = "rsolr-ext"
-	s.version = "0.5.0"
+	s.version = "0.5.1"
 	s.date = "2009-03-17"
 	s.summary = "An extension lib for RSolr"
 	s.email = "goodieboy@gmail.com"

data/test/request_test.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mwmitchell-rsolr-ext
 version: !ruby/object:Gem::Version 
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors: 
 - Matt Mitchell

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

@@ -1,3 +0,0 @@
-class RSolr::Ext::Request::Dismax < RSolr::Ext::Request::Standard
-  
-end

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

@@ -1,38 +0,0 @@
-class RSolr::Ext::Request::Standard
-  
-  include RSolr::Ext::Request::Mapable
-  include RSolr::Ext::Request::Queryable
-  
-  MAPPED_PARAMS = [
-    :per_page,
-    :page,
-    :phrases, # quoted q param
-    :filters, # fq params
-    :phrase_filters # quoted fq params
-  ]
-  
-  def map_per_page(value,output)
-    output[:rows] = value.to_i
-  end
-  
-  def map_page(value,output)
-    raise ':per_page must be set when using :page' unless output[:rows]
-    page = value.to_s.to_i-1
-    page = page < 1 ? 0 : page
-    output[:start] = page * output[:rows]
-  end
-  
-  def map_phrases(value,output)
-    output[:q] = append_to_param(output[:q], build_query(value, true))
-  end
-  
-  def map_filters(value,output)
-    output[:fq] = append_to_param(output[:fq], build_query(value))
-  end
-  
-  def map_phrase_filters(value,output)
-    output[:fq] = append_to_param(output[:fq], build_query(value, true))
-  end
-    
-  
-end