mwmitchell-rsolr 0.8.5 → 0.8.6

data/CHANGES.txt

@@ -1,3 +1,6 @@
+0.8.6 - April 25, 2009
+  Removed the Mash stuff -- which means the response keys from solr are only accessable using String based keys. Why? RSolr has an aim to be lean and mean. Solr::Ext will maybe provide the Symbol/Mash stuff.
+
 0.8.5 - April 7, 2009
   The RSolr::Message #add method now accepts a single Message::Document or an array of Message::Document objects
   The Message::Document class has a new method: #add_field

data/README.rdoc

@@ -7,7 +7,11 @@ A Ruby client for Apache Solr. Has transparent JRuby support by using "org.apach
   sudo gem install mwmitchell-rsolr
 
 ==Community
-http://groups.google.com/group/rsolr
+  http://groups.google.com/group/rsolr
+
+==Related Projects
+  http://github.com/mwmitchell/rsolr-ext
+  http://wiki.apache.org/solr/solr-ruby
 
 ==Simple usage:
   require 'rubygems'

data/Rakefile

@@ -59,7 +59,7 @@ end
 desc 'Generate documentation for the rsolr gem.'
 Rake::RDocTask.new(:doc) do |rdoc|
   rdoc.rdoc_dir = 'doc'
-  rdoc.title = 'Solr-Ruby'
+  rdoc.title = 'RSolr'
   rdoc.options << '--line-numbers' << '--inline-source'
   rdoc.rdoc_files.include('README.rdoc')
   rdoc.rdoc_files.include('lib/**/*.rb')

data/examples/direct.rb

@@ -16,10 +16,10 @@ puts
 
 response = solr.select :q=>'ipod', :fq=>'price:[0 TO 50]', :rows=>2, :start=>0
 
-docs = response[:response][:docs]
+docs = response['response']['docs']
 
 docs.each do |doc|
-  puts doc[:timestamp]
+  puts doc['timestamp']
 end
 
 solr.delete_by_query('*:*') and solr.commit

data/examples/http.rb

@@ -16,8 +16,8 @@ response = solr.select(:q=>'ipod', :fq=>'price:[0 TO 50]', :rows=>2, :start=>0)
 
 puts "URL : #{response.adapter_response[:url]} -> #{response.adapter_response[:status_code]}"
 
-solr_response[:response][:docs].each do |doc|
-  puts doc[:timestamp]
+solr_response['response']['docs'].each do |doc|
+  puts doc['timestamp']
 end
 
 solr.delete_by_query('*:*') and solr.commit

data/lib/core_ext.rb

@@ -8,13 +8,13 @@
   
 #end
 
-class Hash
-  
-  def to_mash
-    self.is_a?(Mash) ? self : Mash.new(self)
-  end
-  
-end
+#class Hash
+#  
+#  def to_mash
+#    self.is_a?(Mash) ? self : Mash.new(self)
+#  end
+#  
+#end
 
 unless Array.respond_to?(:extract_options!)
   class Array

data/lib/rsolr.rb

@@ -1,15 +1,12 @@
 # add this directory to the load path if it hasn't already been added
 
-if ! $:.include? File.dirname(__FILE__) or ! $:.include? File.expand_path(File.dirname(__FILE__))
-  $: << File.dirname(__FILE__)
-end
+$: << File.dirname(__FILE__) unless $:.include?(File.dirname(__FILE__))
 
 require 'core_ext'
-require 'mash'
 
 module RSolr
   
-  VERSION = '0.8.5'
+  VERSION = '0.8.6'
   
   autoload :Message, 'rsolr/message'
   autoload :Connection, 'rsolr/connection'

data/lib/rsolr/connection.rb

@@ -102,7 +102,7 @@ class RSolr::Connection
     data = adapter_response[:body]
     # if the wt is :ruby, evaluate the ruby string response
     if adapter_response[:params][:wt] == :ruby
-      data = Kernel.eval(data).to_mash
+      data = Kernel.eval(data)
     end
     # attach a method called #adapter_response that returns the original adapter response value
     def data.adapter_response

data/rsolr.gemspec

@@ -0,0 +1,46 @@
+Gem::Specification.new do |s|
+  s.name = "rsolr"
+  s.version = "0.8.6"
+  s.date = "2009-04-25"
+  s.summary = "A Ruby client for Apache Solr"
+  s.email = "goodieboy@gmail.com"
+  s.homepage = "http://github.com/mwmitchell/rsolr"
+  s.description = "RSolr is a Ruby gem for working with Apache Solr!"
+  s.has_rdoc = true
+  s.authors = ["Matt Mitchell"]
+  s.files = [
+    "examples/http.rb",
+    "examples/direct.rb",
+    "lib/core_ext.rb",
+    "lib/rsolr.rb",
+    "lib/rsolr/adapter/direct.rb",
+    "lib/rsolr/adapter/http.rb",
+    "lib/rsolr/adapter.rb",
+    "lib/rsolr/connection.rb",
+    "lib/rsolr/http_client/adapter/curb.rb",
+    "lib/rsolr/http_client/adapter/net_http.rb",
+    "lib/rsolr/http_client/adapter.rb",
+    "lib/rsolr/http_client.rb",
+    "lib/rsolr/message.rb",
+    "LICENSE",
+    "Rakefile",
+    "README.rdoc",
+    "rsolr.gemspec",
+    "CHANGES.txt"
+  ]
+  s.test_files = [
+    "test/connection/direct_test.rb",
+    "test/connection/http_test.rb",
+    "test/connection/test_methods.rb",
+    "test/helper.rb",
+    "test/http_client/curb_test.rb",
+    "test/http_client/net_http_test.rb",
+    "test/http_client/test_methods.rb",
+    "test/http_client/util_test.rb",
+    "test/message_test.rb",
+    "test/rsolr_test.rb"
+  ]
+  #s.rdoc_options = ["--main", "README.rdoc"]
+  s.extra_rdoc_files = %w(LICENSE Rakefile README.rdoc CHANGES.txt)
+  s.add_dependency("builder", [">= 2.1.2"])
+end

data/test/connection/test_methods.rb

@@ -9,7 +9,7 @@ module ConnectionTestMethods
   def teardown
     @solr.delete_by_query('id:[* TO *]')
     @solr.commit
-    assert_equal 0, @solr.select(:q=>'*:*')[:response][:docs].size
+    assert_equal 0, @solr.select(:q=>'*:*')['response']['docs'].size
   end
   
   # If :wt is NOT :ruby, the format doesn't get converted into a Mash (special Hash; see lib/mash.rb)
@@ -38,60 +38,60 @@ module ConnectionTestMethods
     @solr.add(:id=>1, :price=>1.00, :cat=>['electronics', 'something else'])
     @solr.commit
     r = @solr.select(:q=>'*:*')
-    assert r.is_a?(Mash)
+    assert r.is_a?(Hash)
     
-    docs = r[:response][:docs]
+    docs = r['response']['docs']
     assert_equal Array, docs.class
     first = docs.first
     
     # test the has? method
-    assert_equal 1.00, first[:price]
+    assert_equal 1.00, first['price']
     
-    assert_equal Array, first[:cat].class
-    assert first[:cat].include?('electronics')
-    assert first[:cat].include?('something else')
-    assert first[:cat].include?('something else')
+    assert_equal Array, first['cat'].class
+    assert first['cat'].include?('electronics')
+    assert first['cat'].include?('something else')
+    assert first['cat'].include?('something else')
     
   end
   
   def test_add
-    assert_equal 0, @solr.select(:q=>'*:*')[:response][:numFound]
+    assert_equal 0, @solr.select(:q=>'*:*')['response']['numFound']
     update_response = @solr.add({:id=>100})
-    assert update_response.is_a?(Mash)
+    assert update_response.is_a?(Hash)
     #
     @solr.commit
-    assert_equal 1, @solr.select(:q=>'*:*')[:response][:numFound]
+    assert_equal 1, @solr.select(:q=>'*:*')['response']['numFound']
   end
   
   def test_delete_by_id
     @solr.add(:id=>100)
     @solr.commit
-    total = @solr.select(:q=>'*:*')[:response][:numFound]
+    total = @solr.select(:q=>'*:*')['response']['numFound']
     assert_equal 1, total
     delete_response = @solr.delete_by_id(100)
     @solr.commit
-    assert delete_response.is_a?(Mash)
-    total = @solr.select(:q=>'*:*')[:response][:numFound]
+    assert delete_response.is_a?(Hash)
+    total = @solr.select(:q=>'*:*')['response']['numFound']
     assert_equal 0, total
   end
   
   def test_delete_by_query
     @solr.add(:id=>1, :name=>'BLAH BLAH BLAH')
     @solr.commit
-    assert_equal 1, @solr.select(:q=>'*:*')[:response][:numFound]
+    assert_equal 1, @solr.select(:q=>'*:*')['response']['numFound']
     response = @solr.delete_by_query('name:"BLAH BLAH BLAH"')
     @solr.commit
-    assert response.is_a?(Mash)
-    assert_equal 0, @solr.select(:q=>'*:*')[:response][:numFound]
+    assert response.is_a?(Hash)
+    assert_equal 0, @solr.select(:q=>'*:*')['response']['numFound']
   end
   
   def test_admin_luke_index_info
     response = @solr.send_request('/admin/luke', :numTerms=>0)
-    assert response.is_a?(Mash)
+    assert response.is_a?(Hash)
     # make sure the ? methods are true/false
-    assert [true, false].include?(response[:index][:current])
-    assert [true, false].include?(response[:index][:optimized])
-    assert [true, false].include?(response[:index][:hasDeletions])
+    assert [true, false].include?(response['index']['current'])
+    assert [true, false].include?(response['index']['optimized'])
+    assert [true, false].include?(response['index']['hasDeletions'])
   end
   
 end

data/test/helper.rb

@@ -0,0 +1,61 @@
+
+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)
+    assert_equal expected, instance.class
+  end
+  
+  def default_test
+    
+  end
+  
+end
+
+begin
+  require 'rubygems'
+  require 'redgreen'
+rescue LoadError
+end
+
+def mock_query_response
+  %({'responseHeader'=>{
+    'status'=>0,'QTime'=>43,'params'=>{
+      'q'=>'*:*','wt'=>'ruby','echoParams'=>'EXPLICIT'
+    }
+  },
+  'response'=>{
+    'numFound'=>26,'start'=>0,'docs'=>[
+      {'id'=>'SP2514N','inStock'=>true,'manu'=>'Samsung Electronics Co. Ltd.','name'=>'Samsung SpinPoint P120 SP2514N - hard drive - 250 GB - ATA-133','popularity'=>6,'price'=>92.0,'sku'=>'SP2514N','timestamp'=>'2008-11-21T17:21:55.601Z','cat'=>['electronics','hard drive'],'spell'=>['Samsung SpinPoint P120 SP2514N - hard drive - 250 GB - ATA-133'],'features'=>['7200RPM, 8MB cache, IDE Ultra ATA-133','NoiseGuard, SilentSeek technology, Fluid Dynamic Bearing (FDB) motor']},
+      {'id'=>'6H500F0','inStock'=>true,'manu'=>'Maxtor Corp.','name'=>'Maxtor DiamondMax 11 - hard drive - 500 GB - SATA-300','popularity'=>6,'price'=>350.0,'sku'=>'6H500F0','timestamp'=>'2008-11-21T17:21:55.617Z','cat'=>['electronics','hard drive'],'spell'=>['Maxtor DiamondMax 11 - hard drive - 500 GB - SATA-300'],'features'=>['SATA 3.0Gb/s, NCQ','8.5ms seek','16MB cache']},
+      {'id'=>'F8V7067-APL-KIT','inStock'=>false,'manu'=>'Belkin','name'=>'Belkin Mobile Power Cord for iPod w/ Dock','popularity'=>1,'price'=>19.95,'sku'=>'F8V7067-APL-KIT','timestamp'=>'2008-11-21T17:21:55.652Z','weight'=>4.0,'cat'=>['electronics','connector'],'spell'=>['Belkin Mobile Power Cord for iPod w/ Dock'],'features'=>['car power adapter, white']},
+      {'id'=>'IW-02','inStock'=>false,'manu'=>'Belkin','name'=>'iPod & iPod Mini USB 2.0 Cable','popularity'=>1,'price'=>11.5,'sku'=>'IW-02','timestamp'=>'2008-11-21T17:21:55.657Z','weight'=>2.0,'cat'=>['electronics','connector'],'spell'=>['iPod & iPod Mini USB 2.0 Cable'],'features'=>['car power adapter for iPod, white']},
+      {'id'=>'MA147LL/A','inStock'=>true,'includes'=>'earbud headphones, USB cable','manu'=>'Apple Computer Inc.','name'=>'Apple 60 GB iPod with Video Playback Black','popularity'=>10,'price'=>399.0,'sku'=>'MA147LL/A','timestamp'=>'2008-11-21T17:21:55.681Z','weight'=>5.5,'cat'=>['electronics','music'],'spell'=>['Apple 60 GB iPod with Video Playback Black'],'features'=>['iTunes, Podcasts, Audiobooks','Stores up to 15,000 songs, 25,000 photos, or 150 hours of video','2.5-inch, 320x240 color TFT LCD display with LED backlight','Up to 20 hours of battery life','Plays AAC, MP3, WAV, AIFF, Audible, Apple Lossless, H.264 video','Notes, Calendar, Phone book, Hold button, Date display, Photo wallet, Built-in games, JPEG photo playback, Upgradeable firmware, USB 2.0 compatibility, Playback speed control, Rechargeable capability, Battery level indication']},
+      {'id'=>'TWINX2048-3200PRO','inStock'=>true,'manu'=>'Corsair Microsystems Inc.','name'=>'CORSAIR  XMS 2GB (2 x 1GB) 184-Pin DDR SDRAM Unbuffered DDR 400 (PC 3200) Dual Channel Kit System Memory - Retail','popularity'=>5,'price'=>185.0,'sku'=>'TWINX2048-3200PRO','timestamp'=>'2008-11-21T17:21:55.706Z','cat'=>['electronics','memory'],'spell'=>['CORSAIR  XMS 2GB (2 x 1GB) 184-Pin DDR SDRAM Unbuffered DDR 400 (PC 3200) Dual Channel Kit System Memory - Retail'],'features'=>['CAS latency 2,	2-3-3-6 timing, 2.75v, unbuffered, heat-spreader']},
+      {'id'=>'VS1GB400C3','inStock'=>true,'manu'=>'Corsair Microsystems Inc.','name'=>'CORSAIR ValueSelect 1GB 184-Pin DDR SDRAM Unbuffered DDR 400 (PC 3200) System Memory - Retail','popularity'=>7,'price'=>74.99,'sku'=>'VS1GB400C3','timestamp'=>'2008-11-21T17:21:55.71Z','cat'=>['electronics','memory'],'spell'=>['CORSAIR ValueSelect 1GB 184-Pin DDR SDRAM Unbuffered DDR 400 (PC 3200) System Memory - Retail']},
+      {'id'=>'VDBDB1A16','inStock'=>true,'manu'=>'A-DATA Technology Inc.','name'=>'A-DATA V-Series 1GB 184-Pin DDR SDRAM Unbuffered DDR 400 (PC 3200) System Memory - OEM','popularity'=>5,'sku'=>'VDBDB1A16','timestamp'=>'2008-11-21T17:21:55.712Z','cat'=>['electronics','memory'],'spell'=>['A-DATA V-Series 1GB 184-Pin DDR SDRAM Unbuffered DDR 400 (PC 3200) System Memory - OEM'],'features'=>['CAS latency 3,	 2.7v']},
+      {'id'=>'3007WFP','inStock'=>true,'includes'=>'USB cable','manu'=>'Dell, Inc.','name'=>'Dell Widescreen UltraSharp 3007WFP','popularity'=>6,'price'=>2199.0,'sku'=>'3007WFP','timestamp'=>'2008-11-21T17:21:55.724Z','weight'=>401.6,'cat'=>['electronics','monitor'],'spell'=>['Dell Widescreen UltraSharp 3007WFP'],'features'=>['30" TFT active matrix LCD, 2560 x 1600, .25mm dot pitch, 700:1 contrast']},
+      {'id'=>'VA902B','inStock'=>true,'manu'=>'ViewSonic Corp.','name'=>'ViewSonic VA902B - flat panel display - TFT - 19"','popularity'=>6,'price'=>279.95,'sku'=>'VA902B','timestamp'=>'2008-11-21T17:21:55.734Z','weight'=>190.4,'cat'=>['electronics','monitor'],'spell'=>['ViewSonic VA902B - flat panel display - TFT - 19"'],'features'=>['19" TFT active matrix LCD, 8ms response time, 1280 x 1024 native resolution']}]
+    }
+  })
+end

data/test/rsolr_test.rb

@@ -0,0 +1,21 @@
+require 'helper'
+
+class SolrTest < RSolrBaseTest
+  
+  def setup
+    if defined?(JRUBY_VERSION)
+      @solr = RSolr.connect(:adapter=>:direct)
+    else
+      @solr = RSolr.connect
+    end
+  end
+  
+  def test_escape
+    expected = %q(http\:\/\/lucene\.apache\.org\/solr)
+    source = "http://lucene.apache.org/solr"
+    assert_equal expected, RSolr.escape(source)
+    assert @solr.respond_to?(:escape)
+    assert_equal expected, @solr.escape(source)
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mwmitchell-rsolr
 version: !ruby/object:Gem::Version 
-  version: 0.8.5
+  version: 0.8.6
 platform: ruby
 authors: 
 - Matt Mitchell
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-07 00:00:00 -07:00
+date: 2009-04-25 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -37,9 +37,7 @@ files:
 - examples/http.rb
 - examples/direct.rb
 - lib/core_ext.rb
-- lib/mash.rb
 - lib/rsolr.rb
-- lib/rsolr/adapter/common_methods.rb
 - lib/rsolr/adapter/direct.rb
 - lib/rsolr/adapter/http.rb
 - lib/rsolr/adapter.rb
@@ -52,7 +50,7 @@ files:
 - LICENSE
 - Rakefile
 - README.rdoc
-- rsolr-ruby.gemspec
+- rsolr.gemspec
 - CHANGES.txt
 has_rdoc: true
 homepage: http://github.com/mwmitchell/rsolr
@@ -84,10 +82,10 @@ test_files:
 - test/connection/direct_test.rb
 - test/connection/http_test.rb
 - test/connection/test_methods.rb
+- test/helper.rb
 - test/http_client/curb_test.rb
 - test/http_client/net_http_test.rb
 - test/http_client/test_methods.rb
 - test/http_client/util_test.rb
 - test/message_test.rb
-- test/rsolr_test
-- test/test_helpers.rb
+- test/rsolr_test.rb

data/lib/mash.rb

@@ -1,148 +0,0 @@
-# This class has dubious semantics and we only have it so that people can write
-# params[:key] instead of params['key'].
-class Mash < Hash
-
-  # @param constructor<Object>
-  #   The default value for the mash. Defaults to an empty hash.
-  #
-  # @details [Alternatives]
-  #   If constructor is a Hash, a new mash will be created based on the keys of
-  #   the hash and no default value will be set.
-  def initialize(constructor = {})
-    if constructor.is_a?(Hash)
-      super()
-      update(constructor)
-    else
-      super(constructor)
-    end
-  end
-
-  # @param key<Object> The default value for the mash. Defaults to nil.
-  #
-  # @details [Alternatives]
-  #   If key is a Symbol and it is a key in the mash, then the default value will
-  #   be set to the value matching the key.
-  def default(key = nil)
-    if key.is_a?(Symbol) && include?(key = key.to_s)
-      self[key]
-    else
-      super
-    end
-  end
-
-  alias_method :regular_writer, :[]= unless method_defined?(:regular_writer)
-  alias_method :regular_update, :update unless method_defined?(:regular_update)
-
-  # @param key<Object> The key to set.
-  # @param value<Object>
-  #   The value to set the key to.
-  #
-  # @see Mash#convert_key
-  # @see Mash#convert_value
-  def []=(key, value)
-    regular_writer(convert_key(key), convert_value(value))
-  end
-
-  # @param other_hash<Hash>
-  #   A hash to update values in the mash with. The keys and the values will be
-  #   converted to Mash format.
-  #
-  # @return <Mash> The updated mash.
-  def update(other_hash)
-    other_hash.each_pair { |key, value| regular_writer(convert_key(key), convert_value(value)) }
-    self
-  end
-
-  alias_method :merge!, :update
-
-  # @param key<Object> The key to check for. This will be run through convert_key.
-  #
-  # @return <TrueClass, FalseClass> True if the key exists in the mash.
-  def key?(key)
-    super(convert_key(key))
-  end
-
-  # def include? def has_key? def member?
-  alias_method :include?, :key?
-  alias_method :has_key?, :key?
-  alias_method :member?, :key?
-
-  # @param key<Object> The key to fetch. This will be run through convert_key.
-  # @param *extras<Array> Default value.
-  #
-  # @return <Object> The value at key or the default value.
-  def fetch(key, *extras)
-    super(convert_key(key), *extras)
-  end
-
-  # @param *indices<Array>
-  #   The keys to retrieve values for. These will be run through +convert_key+.
-  #
-  # @return <Array> The values at each of the provided keys
-  def values_at(*indices)
-    indices.collect {|key| self[convert_key(key)]}
-  end
-
-  # @param hash<Hash> The hash to merge with the mash.
-  #
-  # @return <Mash> A new mash with the hash values merged in.
-  def merge(hash)
-    self.dup.update(hash)
-  end
-
-  # @param key<Object>
-  #   The key to delete from the mash.\
-  def delete(key)
-    super(convert_key(key))
-  end
-
-  # @param *rejected<Array[(String, Symbol)] The mash keys to exclude.
-  #
-  # @return <Mash> A new mash without the selected keys.
-  #
-  # @example
-  #   { :one => 1, :two => 2, :three => 3 }.except(:one)
-  #     #=> { "two" => 2, "three" => 3 }
-  def except(*keys)
-    super(*keys.map {|k| convert_key(k)})
-  end
-
-  # Used to provide the same interface as Hash.
-  #
-  # @return <Mash> This mash unchanged.
-  def stringify_keys!; self end
-
-  # @return <Hash> The mash as a Hash with string keys.
-  def to_hash
-    Hash.new(default).merge(self)
-  end
-
-  protected
-  # @param key<Object> The key to convert.
-  #
-  # @param <Object>
-  #   The converted key. If the key was a symbol, it will be converted to a
-  #   string.
-  #
-  # @api private
-  def convert_key(key)
-    key.kind_of?(Symbol) ? key.to_s : key
-  end
-
-  # @param value<Object> The value to convert.
-  #
-  # @return <Object>
-  #   The converted value. A Hash or an Array of hashes, will be converted to
-  #   their Mash equivalents.
-  #
-  # @api private
-  def convert_value(value)
-    if value.class == Hash
-      value.to_mash
-    elsif value.is_a?(Array)
-      value.collect { |e| convert_value(e) }
-    else
-      value
-    end
-  end
-end