mwmitchell-rsolr 0.8.3 → 0.8.4

data/CHANGES.txt

@@ -1,3 +1,7 @@
+0.8.4 - April 3, 2009
+  New test suite using RSpec and mocks coming. Run "rake spec"
+    - added specs for RSolr and RSolr::Connection
+
 0.8.3 - April 3, 2009
   RSolr::Connection
     - removed the block functionality of send_request and related methods

data/README.rdoc

@@ -41,7 +41,7 @@ To get a direct connection (no http) in jRuby using DirectSolrConnection:
     :adapter=>:direct,
     :home_dir=>'/path/to/solr/home',
     :dist_dir=>'/path/to/solr/distribution'
-  )
+  })
 
 == Requests
 Once you have a connection, you can execute queries, updates etc..
@@ -50,29 +50,29 @@ Once you have a connection, you can execute queries, updates etc..
 Use the #select method to send requests to the /select handler:
   response = solr.select({
     :q=>'washington',
-    :facet=>true,
-    'facet.limit'=>-1,
-    'facet.field'=>'cat',
-    'facet.field'=>'inStock',
     :start=>0,
     :rows=>10
   })
+  
+Use the #send_request method to set a custom request handler path:
+  response = solr.send_request('/documents', {:q=>'test'})
 
 
 === Updating Solr
-Updating is done using native Ruby structures. Hashes are used for single documents and arrays are used for a collection of documents (hashes). These structures get turned into simple XML "messages".
+Updating can be done using native Ruby structures. Hashes are used for single documents and arrays are used for a collection of documents (hashes). These structures get turned into simple XML "messages". Raw XML can also be used of course.
 
-Raw XML
-  response = solr.update('</optimize>')
+Raw XML via  #update
+  solr.update('</commit>')
+  solr.update('</optimize>')
 
-Single document
-  response = solr.add(:id=>1, :price=>1.00)
+Single document via #add
+  solr.add(:id=>1, :price=>1.00)
 
-Multiple documents
+Multiple documents via #add
   documents = [{:id=>1, :price=>1.00}, {:id=>2, :price=>10.50}]
-  response = solr.add(documents)
+  solr.add(documents)
 
-When adding, you can also supply "add" xml element attributes and/or a block for manipulating other "add" related elements:
+When adding, you can also supply "add" xml element attributes and/or a block for manipulating other "add" related elements (docs and fields) when using the #add method:
   
   doc = {:id=>1, :price=>1.00}
   add_attributes = {:allowDups=>false, :commitWithin=>10.0}
@@ -84,14 +84,14 @@ When adding, you can also supply "add" xml element attributes and/or a block for
   end
 
 Delete by id
-  response = solr.delete_by_id(1)
+  solr.delete_by_id(1)
 or an array of ids
-  response = solr.delete_by_id([1, 2, 3, 4])
+  solr.delete_by_id([1, 2, 3, 4])
 
 Delete by query:
-  response = solr.delete_by_query('price:1.00')
+  solr.delete_by_query('price:1.00')
 Delete by array of queries
-  response = solr.delete_by_query(['price:1.00', 'price:10.00'])
+  solr.delete_by_query(['price:1.00', 'price:10.00'])
 
 
 Commit & optimize shortcuts

data/Rakefile

@@ -21,18 +21,25 @@ Rake::TestTask.new("test_units") { |t|
   t.libs << "test"
 }
 
+require 'spec/rake/spectask'
 
-desc 'Run specs' # this task runs each test in its own process
-task :specs do
-  require 'rubygems'
-  require 'facets/more/filelist' unless defined?(FileList)
-  files = FileList["**/*_spec.rb"]
-  p files.to_a
-  files.each do |filename|
-    system "cd #{File.dirname(filename)} && ruby #{File.basename(filename)}"
-  end
+desc "Run specs"
+Spec::Rake::SpecTask.new('spec') do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.libs += ["lib", "spec"]
 end
 
+#desc 'Run specs' # this task runs each test in its own process
+#task :specs do
+#  require 'rubygems'
+#  require 'facets/more/filelist' unless defined?(FileList)
+#  files = FileList["**/*_spec.rb"]
+#  p files.to_a
+#  files.each do |filename|
+#    system "cd #{File.dirname(filename)} && ruby #{File.basename(filename)}"
+#  end
+#end
+
 #desc "Run specs"
 #Rake::TestTask.new("specs") { |t|
 #  t.pattern = 'spec/**/*_spec.rb'

data/lib/rsolr.rb

@@ -9,7 +9,7 @@ require 'mash'
 
 module RSolr
   
-  VERSION = '0.8.3'
+  VERSION = '0.8.4'
   
   autoload :Message, 'rsolr/message'
   autoload :Connection, 'rsolr/connection'

data/spec/connection_spec.rb

@@ -0,0 +1,151 @@
+require 'helper'
+
+describe RSolr::Connection do
+  
+  context 'the initialize method' do
+    
+    it 'should require one argument' do
+      lambda{RSolr::Connection.new}.should raise_error(ArgumentError)
+    end
+    
+  end
+  
+  before(:each) do
+    @adapter = mock('RSolr::Adapter::HTTP')
+    @connection = RSolr::Connection.new(@adapter)
+  end
+  
+  context '#map_params method' do
+    it 'should merge :wt=>:ruby to the incoming params' do
+      result = @connection.send(:map_params, {})
+      result[:wt].should == :ruby
+    end
+    it 'should not overwrite an existing :wt param' do
+      result = @connection.send(:map_params, {:wt=>'xml'})
+      result[:wt].should == 'xml'
+    end
+  end
+  
+  context '#adapt_response method' do
+    it 'should evaluate the :body value if the :wt param IS :ruby' do
+      response_from_adapter = {:body=>'{}', :params=>{:wt=>:ruby}}
+      result = @connection.send(:adapt_response, response_from_adapter)
+      result.should be_a(Hash) 
+    end
+    it 'should not evaluate the :body value if the :wt is NOT :ruby' do
+      response_from_adapter = {:body=>'</xml>', :params=>{:wt=>:xml}}
+      result = @connection.send(:adapt_response, response_from_adapter)
+      result.should be_a(String)
+    end
+    it 'should return an object that will respond_to?(:adapter_response)' do
+      response_from_adapter = {:body=>'</xml>', :params=>{:wt=>:xml}}
+      result = @connection.send(:adapt_response, response_from_adapter)
+      result.should respond_to(:adapter_response)
+    end
+    it 'should return the original adapter response from #adapter_response method' do
+      response_from_adapter = {:body=>'</xml>', :params=>{:wt=>:xml}}
+      result = @connection.send(:adapt_response, response_from_adapter)
+      result.adapter_response.should == response_from_adapter
+    end
+  end
+  
+  it 'should have an adapter' do
+    @connection.adapter.should == @adapter
+  end
+  
+  it 'should send requests to the adapter' do
+    params = {:wt=>:ruby, :q=>'test'}
+    expected_return = {:params=>params, :body=>'{}'}
+    @adapter.should_receive(:send_request).with(
+      '/documents',
+      params,
+      nil
+    ).once.and_return(expected_return)
+    @connection.send_request('/documents', :q=>'test')
+  end
+  
+  context '#select method' do
+    
+    it 'should set the solr request path to /select' do
+      params = {:wt=>:ruby, :q=>'test'}
+      expected_return = {:params=>params, :body=>'{}'}
+      @adapter.should_receive(:send_request).with(
+        '/select',
+        params,
+        nil
+      ).once.and_return(expected_return)
+      @connection.select(:q=>'test')
+    end
+    
+    it 'should add a :qt=>:ruby to the params, then pass the params to the adapter' do
+      input_params = {:q=>'test', :fq=>'filter:one', :fq=>'documents'}
+      expected_modified_params = input_params.merge({:wt=>:ruby})
+      expected_return = {:body=>'{}', :params=>expected_modified_params}
+      @adapter.should_receive(:send_request).with(
+        '/select',
+        hash_including(expected_modified_params),
+        nil
+      ).once.and_return(expected_return)
+      @connection.select(input_params)
+    end
+    
+    it 'should return a hash' do
+      @adapter.should_receive(:send_request).and_return(
+        {:body=>'{}', :params=>{:wt=>:ruby}}
+      )
+      @connection.select(:q=>'test').should be_a(Hash)
+    end
+    
+  end
+  
+  context '#update method' do
+    
+    it 'should set the solr request path to /update' do
+      expected_params = {:name=>'test', :wt=>:ruby}
+      @adapter.should_receive(:send_request).with(
+        '/update',
+        hash_including(expected_params),
+        '</optimize>'
+      ).once.and_return(
+        {:body=>'{}', :params=>expected_params}
+      )
+      @connection.update('</optimize>', :name=>'test')
+    end
+    
+    it 'should accept a solr params hash' do
+      @adapter.should_receive(:send_request).with(
+        '/update',
+        hash_including(:xyz=>123, :wt=>:ruby),
+        '</optimize>'
+      ).once.and_return(
+        {:body=>'{}', :params=>{:xyz=>123, :wt=>:ruby}}
+      )
+      @connection.update('</optimize>', :xyz=>123)
+    end
+    
+  end
+  
+  context '#send_request method' do
+    
+    it 'should send the request path to the adapter' do
+      @adapter.should_receive(:send_request).with(
+        '/documents',
+        hash_including(:q=>'test', :wt=>:ruby),
+        nil
+      ).once.and_return({:body=>'{}', :params=>{:wt=>:ruby, :q=>'test'}})
+      @connection.send_request('/documents', :q=>'test')
+    end
+    
+    it 'should return an object will respond_to :adapter_response' do
+      @adapter.should_receive(:send_request).with(
+        '/select',
+        hash_including(:q=>'test', :wt=>:ruby),
+        nil
+      ).once.and_return({:body=>'{}', :params=>{:q=>'test', :wt=>:ruby}})
+      response = @connection.select(:q=>'test')
+      response.should respond_to(:adapter_response)
+    end
+    
+  end
+  
+end

data/spec/helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'spec'
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'rsolr')

data/spec/rsolr_spec.rb

@@ -0,0 +1,29 @@
+require 'helper'
+
+describe RSolr::Connection do
+  
+  context 'the #connect method' do
+    
+    it 'should exist' do
+      RSolr.should respond_to(:connect)
+    end
+    
+    it 'should return an RSolr::Connection object' do
+      RSolr.connect.should be_a(RSolr::Connection)
+    end
+    
+  end
+  
+  context "the #escape method" do
+    
+    it "should exist" do
+      RSolr.should respond_to(:escape)
+    end
+    
+    it "should escape properly" do
+      RSolr.escape('Trying & % different "characters" here!').should == "Trying\\ \\&\\ \\%\\ different\\ \\\"characters\\\"\\ here\\!"
+    end
+    
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mwmitchell-rsolr
 version: !ruby/object:Gem::Version 
-  version: 0.8.3
+  version: 0.8.4
 platform: ruby
 authors: 
 - Matt Mitchell
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-24 00:00:00 -07:00
+date: 2009-04-03 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -91,3 +91,6 @@ test_files:
 - test/message_test.rb
 - test/rsolr_test
 - test/test_helpers.rb
+- spec/connection_spec.rb
+- spec/helper.rb
+- spec/rsolr_spec.rb