mwmitchell-rsolr 0.7.0 → 0.7.1

data/CHANGES.txt

@@ -1,3 +1,8 @@
+0.7.1 - February 27, 2009
+  Added simple query helper module -> RSolr::Query
+  Added tests for RSolr::Query
+  Modified Test::Unit::TestCase in test/test_helpers.rb
+
 0.7.0 - February 20, 2009
   Removed all param mapping behavior, code and tests
    - this stuff just gunks up rsolr and should be in an extension of some sort
@@ -17,7 +22,7 @@
 	  updated comments for #search method
 	Updated tests
 	Bumped up version
- 
+
 0.6.8 - January 28, 2009
 	New method added to RSolr::Connection::Base - #find_values_for_facet
 	This method searches for facet values only, and sets the :rows param to 0

data/README.rdoc

@@ -55,7 +55,7 @@ Use the #query method to send requests to the /select handler:
   response = solr.find_by_id(1)
 
 ==== Pagination
-Pagination is simplified from having a few helpful response methods:
+Pagination is simplified by having a few helpful response methods:
   
   response = solr.query(:start=>0, :rows=>10, :q=>'*:*')
   response.per_page

data/lib/rsolr/query.rb

@@ -0,0 +1,58 @@
+module RSolr::Query
+  
+  module HelperMethods
+    
+    # returns a quoted or non-quoted string
+    # "value" should be a string
+    # "quote" should be true/false
+    def prep_value(value, quote)
+      quote ? %("#{value}") : value
+    end
+    
+    # value can be a string, array, hash or symbol
+    # symbols are treated as strings
+    # arrays are recursed through #build_query
+    # keys for hashes are fields for fielded queries, the values are recused through #build_query
+    # strings/symbols are sent to #prep_value for possible quoting
+    #
+    # opts can have:
+    #   :quote=>bool - default false
+    #   :join=>string - default ' '
+    def build_query(value, opts={})
+      opts[:join]||=' '
+      opts[:quote]||=false
+      result = (
+        case value
+        when Array
+          value.collect do |item|
+            build_query item, opts
+          end.flatten
+        when String,Symbol
+          [prep_value(value.to_s, opts[:quote])]
+        when Hash
+          value.collect do |(k,v)|
+            "#{k}:#{build_query(v, opts)}"
+          end.flatten
+        else
+          [prep_value(value.to_s, opts[:quote])]
+        end
+      )
+      opts[:join] ? result.join(opts[:join]) : result
+    end
+  
+    # start_for(2, 10)
+    # calculates the :start value for pagination etc..
+    def start_for(current_page, per_page)
+      page = current_page.to_s.to_i
+      page = page > 0 ? page : 1
+      ((page - 1) * (per_page || 0))
+    end
+  
+  end # end HelperMethods
+  
+  # Easy access: RSolr::Query::Helper.start_for(page=1, per_page=10)
+  class Helper
+    extend HelperMethods
+  end
+  
+end

data/lib/rsolr.rb

@@ -7,13 +7,14 @@ proc {|base, files|
 
 module RSolr
   
-  VERSION = '0.7.0'
+  VERSION = '0.7.1'
   
   autoload :Message, 'rsolr/message'
   autoload :Response, 'rsolr/response'
   autoload :Connection, 'rsolr/connection'
   autoload :Indexer, 'rsolr/indexer'
   autoload :HTTPClient, 'rsolr/http_client'
+  autoload :Query, 'rsolr/query'
   
   # factory for creating connections
   # opts[:adapter] is either :http or :direct

data/test/query_helper_test.rb

@@ -0,0 +1,30 @@
+require File.join(File.dirname(__FILE__), 'test_helpers.rb')
+
+class RSolrQueryHelperTest < RSolrBaseTest
+  
+  H = RSolr::Query::Helper
+  
+  test 'pre_value' do
+    value = 'the man'
+    assert_equal 'the man', H.prep_value(value, false)
+    assert_equal "\"the man\"", H.prep_value(value, :quote=>true)
+  end
+  
+  test 'build_query' do
+    assert_equal 'testing', H.build_query('testing')
+    assert_equal '"testing"', H.build_query('testing', :quote=>true)
+    assert_equal 'testing again', H.build_query(['testing', 'again'])
+    assert_equal '"testing" "again"', H.build_query(['testing', 'again'], :quote=>true)
+    assert_equal 'name:whatever', H.build_query({:name=>'whatever'})
+    assert_equal 'name:"whatever"', H.build_query({:name=>'whatever'}, :quote=>true)
+    assert_equal 'sam name:whatever i am', H.build_query(['sam', {:name=>'whatever'}, 'i', 'am'])
+    assert_equal 'testing AND blah', H.build_query(['testing', 'blah'], :join=>' AND ')
+  end
+  
+  test 'start_for' do
+    per_page = 8
+    current_page = 2
+    assert_equal 8, H.start_for(current_page, per_page)
+  end
+  
+end

data/test/test_helpers.rb

@@ -2,6 +2,24 @@ $: << File.dirname(__FILE__)
 require File.join(File.dirname(__FILE__), '..', 'lib', 'rsolr')
 require 'test/unit'
 
+# 
+class Test::Unit::TestCase
+  
+  def self.test(name, &block)
+    test_name = "test_#{name.gsub(/\s+/,'_')}".to_sym
+    defined = instance_method(test_name) rescue false
+    raise "#{test_name} is already defined in #{self}" if defined
+    if block_given?
+      define_method(test_name, &block)
+    else
+      define_method(test_name) do
+        flunk "No implementation provided for #{name}"
+      end
+    end
+  end
+  
+end
+
 class RSolrBaseTest < Test::Unit::TestCase
   
   def assert_class(expected, instance)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mwmitchell-rsolr
 version: !ruby/object:Gem::Version 
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors: 
 - Matt Mitchell
@@ -56,6 +56,7 @@ files:
 - lib/rsolr/response/query.rb
 - lib/rsolr/response/update.rb
 - lib/rsolr/response.rb
+- lib/rsolr/query.rb
 - LICENSE
 - Rakefile
 - README.rdoc
@@ -97,6 +98,7 @@ test_files:
 - test/http_client/util_test.rb
 - test/indexer.rb
 - test/message_test.rb
+- test/query_helper_test.rb
 - test/response/base_test.rb
 - test/response/pagination_test.rb
 - test/response/query_test.rb