mwmitchell-rsolr 0.6.1 → 0.6.2

data/CHANGES.txt

@@ -1,3 +1,8 @@
+0.6.2 - January 14, 2009
+	Removed mapping and indexer modules -- seems to me that a general purpose mapping library
+	would be more valuable than an embedded module in RSolr ( RMapper ?)
+	This helps lighten RSolr a bit too
+	
 0.6.1 - January 13, 2009
 	Removed SearchExt and mapping until this library gets some real use
 	The only param mapping now is for :page and :per_page via the #search method

data/README.rdoc

@@ -59,9 +59,9 @@ If you use WillPaginate, just pass-in the response to the #will_paginate view he
   
   <%= will_paginate(@response) %>
 
-The #search method automatically figure out the :start and :rows value, based on the values of :page and :per_page. The will_paginate view helper just needs the right methods (#current_page, #previous_page, #next_page and #total_pages) to create the pagination view widget.
+The #search method automatically figures out the :start and :rows values, based on the values of :page and :per_page. The will_paginate view helper uses the methods: #current_page, #previous_page, #next_page and #total_pages to create the pagination view widget.
 
-The #search method will be providing more param mapping, but not until RSolr gets more use. If you have ideas for a param mapping interface, let me know!
+The #search method will be providing more param mapping, but not until RSolr gets more use. If you have ideas for a param mapping interface, let me know! I'll be throwing some stuff together as well.
 
 
 === Updating Solr

data/examples/direct.rb

@@ -9,7 +9,7 @@ solr = RSolr.connect(:direct, :home_dir=>home, :dist_dir=>dist)
 
 `cd ../apache-solr/example/exampledocs && ./post.sh ./*.xml`
 
-response = solr.search 'ipod', :filters=>{:price=>(0..50)}, :per_page=>2, :page=>1
+response = solr.search :q=>'ipod', :fq=>'price:[0 TO 50]', :per_page=>2, :page=>1
 
 solr.delete_by_query('*:*')
 

data/examples/http.rb

@@ -5,7 +5,7 @@ solr = RSolr.connect(:http)
 
 `cd ../apache-solr/example/exampledocs && ./post.sh ./*.xml`
 
-response = solr.search 'ipod', :filters=>{:price=>(0..50)}, :per_page=>2, :page=>1
+response = solr.search :q=>'ipod', :fq=>'price:[0 TO 50]', :per_page=>2, :page=>1
 
 solr.delete_by_query('*:*')
 

data/lib/rsolr.rb

@@ -7,12 +7,11 @@ proc {|base, files|
 
 module RSolr
   
-  VERSION = '0.6.0'
+  VERSION = '0.6.2'
   
   autoload :Message, 'rsolr/message'
   autoload :Response, 'rsolr/response'
   autoload :Connection, 'rsolr/connection'
-  autoload :Mapper, 'rsolr/mapper'
   autoload :Indexer, 'rsolr/indexer'
   autoload :HTTPClient, 'rsolr/http_client'
   

data/lib/rsolr/connection/adapter/http.rb

@@ -21,7 +21,7 @@ class RSolr::Connection::Adapter::HTTP
   #
   def initialize(opts={}, &block)
     opts[:url]||='http://127.0.0.1:8983/solr'
-    @opts = default_options.merge(opts)
+    @opts = default_options.merge(opts) # default_options are coming from RSolr::Connection::Adapter::CommonMethods
   end
   
   def connection

data/lib/rsolr/connection/base.rb

@@ -41,6 +41,8 @@ class RSolr::Connection::Base
   
   # same as the #query method, but with additional param mapping
   # currently only :page and :per_page
+  # TODO: need to get some nice and friendly param mapping here:
+  # search(:fields=>'', :facet_fields=>[], :filters=>{})
   def search(params)
     self.query(modify_params_for_pagination(params))
   end
@@ -108,9 +110,18 @@ class RSolr::Connection::Base
     RSolr::Message
   end
   
+  # given a hash, this method will attempt to produce the
+  # correct :start and :rows values for Solr
+  # -- if the hash contains a :per_page value, it's used for the rows
+  # if the :per_page value doesn't exist (nil), the :rows value is
+  # used, and if :rows is not set, the default value is 10
+  # -- if the hash contains a :page value (the current page)
+  # it is used to calculate the :start value
+  # returns a hash with the :rows and :start values
+  # :per_page and :page are deleted
   def modify_params_for_pagination(p)
     per_page = p.delete(:per_page).to_s.to_i
-    p[:rows] = per_page==0 ? 10 : per_page
+    p[:rows] = per_page==0 ? (p[:rows] || 10) : per_page
     page = p.delete(:page).to_s.to_i
     page = page > 0 ? page : 1
     p[:start] = (page - 1) * (p[:rows] || 0)

data/lib/rsolr/http_client.rb

@@ -1,11 +1,9 @@
-#require 'uri'
-
 # A simple wrapper for different http client implementations.
 # Supports #get and #post
 # This was motivated by: http://apocryph.org/2008/11/09/more_indepth_analysis_ruby_http_client_performance/
 # Net::HTTP is the default adapter
 
-# Each adapter response should be a hash with the following keys:
+# Each adapters response should be a hash with the following keys:
 #   :status_code
 #   :url
 #   :body

data/lib/rsolr/http_client/adapter/curb.rb

@@ -6,24 +6,24 @@ class RSolr::HTTPClient::Adapter::Curb
   include RSolr::HTTPClient::Util
   
   attr :uri
-  attr :c
+  attr :connection
   
   def initialize(url)
     @uri = URI.parse(url)
-    @c = ::Curl::Easy.new
+    @connection = ::Curl::Easy.new
   end
   
   def get(path, params={})
-    @c.url = _build_url(path, params)
-    @c.multipart_form_post = false
-    @c.perform
+    @connection.url = _build_url(path, params)
+    @connection.multipart_form_post = false
+    @connection.perform
     create_http_context(path, params)
   end
   
   def post(path, data, params={}, headers={})
-    @c.url = _build_url(path, params)
-    @c.headers = headers
-    @c.http_post(data)
+    @connection.url = _build_url(path, params)
+    @connection.headers = headers
+    @connection.http_post(data)
     create_http_context(path, params, data, headers)
   end
   
@@ -31,9 +31,9 @@ class RSolr::HTTPClient::Adapter::Curb
   
   def create_http_context(path, params, data=nil, headers={})
     {
-      :status_code=>@c.response_code.to_i,
-      :url=>@c.url,
-      :body=>@c.body_str,
+      :status_code=>@connection.response_code.to_i,
+      :url=>@connection.url,
+      :body=>@connection.body_str,
       :path=>path,
       :params=>params,
       :data=>data,
@@ -45,7 +45,7 @@ class RSolr::HTTPClient::Adapter::Curb
     url = @uri.scheme + '://' + @uri.host
     url += ':' + @uri.port.to_s if @uri.port
     url += @uri.path + path
-    build_url(url, params, @uri.query)
+    build_url(url, params, @uri.query) # build_url is coming from RSolr::HTTPClient::Util
   end
   
 end

data/lib/rsolr/http_client/adapter/net_http.rb

@@ -5,22 +5,22 @@ class RSolr::HTTPClient::Adapter::NetHTTP
   include RSolr::HTTPClient::Util
   
   attr :uri
-  attr :c
+  attr :connection
   
   def initialize(url)
     @uri = URI.parse(url)
-    @c = Net::HTTP.new(@uri.host, @uri.port)
+    @connection = Net::HTTP.new(@uri.host, @uri.port)
   end
   
   def get(path, params={})
     url = _build_url(path, params)
-    net_http_response = @c.get(url)
+    net_http_response = @connection.get(url)
     create_http_context(net_http_response, url, path, params)
   end
   
   def post(path, data, params={}, headers={})
     url = _build_url(path, params)
-    net_http_response = @c.post(url, data, headers)
+    net_http_response = @connection.post(url, data, headers)
     create_http_context(net_http_response, url, path, params, data, headers)
   end
   
@@ -42,7 +42,7 @@ class RSolr::HTTPClient::Adapter::NetHTTP
   end
   
   def _build_url(path, params={})
-    build_url(@uri.path + path, params, @uri.query)
+    build_url(@uri.path + path, params, @uri.query) # build_url is coming from RSolr::HTTPClient::Util
   end
   
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mwmitchell-rsolr
 version: !ruby/object:Gem::Version 
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors: 
 - Matt Mitchell
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-07 00:00:00 -08:00
+date: 2009-01-14 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -49,8 +49,6 @@ files:
 - lib/rsolr/http_client/adapter.rb
 - lib/rsolr/http_client.rb
 - lib/rsolr/indexer.rb
-- lib/rsolr/mapper/rss.rb
-- lib/rsolr/mapper.rb
 - lib/rsolr/message.rb
 - lib/rsolr/response/base.rb
 - lib/rsolr/response/index_info.rb
@@ -98,7 +96,6 @@ test_files:
 - test/http_client/test_methods.rb
 - test/http_client/util_test.rb
 - test/indexer.rb
-- test/mapper_test.rb
 - test/message_test.rb
 - test/response/base_test.rb
 - test/response/pagination_test.rb

data/lib/rsolr/indexer.rb

@@ -1,23 +0,0 @@
-class RSolr::Indexer
-  
-  attr_reader :solr, :mapper, :opts
-  
-  def initialize(solr, mapping_or_mapper, opts={})
-    @solr = solr
-    @mapper = mapping_or_mapper.is_a?(Hash) ? RSolr::Mapper::Base.new(mapping_or_mapper) : mapping_or_mapper
-    @opts = opts
-  end
-  
-  # data - the raw data to send into the mapper
-  # params - url query params for solr /update handler
-  # commit - boolean; true==commit after adding, false==no commit after adding
-  # block can be used for modifying the "add", "doc" and "field" xml elements (for boosting etc.)
-  def index(data, params={}, &block)
-    docs = data.collect {|d| @mapper.map(d)}
-    @solr.add(docs, params) do |add, doc, field|
-      # check opts for :debug etc.?
-      yield add, doc, field if block_given?
-    end
-  end
-  
-end

data/lib/rsolr/mapper.rb

@@ -1,62 +0,0 @@
-module RSolr::Mapper
-  
-  autoload :RSS, 'rsolr/mapper/rss'
-  
-  class UnkownMappingValue < RuntimeError; end
-  
-  class Base
-    
-    attr_reader :mapping, :opts
-  
-    def initialize(mapping={}, opts={}, &block)
-      @mapping = mapping
-      @opts = opts
-      yield @mapping if block_given?
-    end
-    
-    # source - a hash or array of source data
-    # override_mapping - an alternate mapper
-    # returns an array with one or more mapped hashes
-    def map(source, override_mapping=nil, &block)
-      source = [source] if source.is_a?(Hash)
-      mapping = override_mapping || @mapping
-      index = -1
-      # collect a bunch of hashes...
-      source.collect do |src|
-        index += 1
-        # for each mapping item, inject data into a new hash
-        final_hash = mapping.inject({}) do |a_new_hash, (map_key, map_value)|
-          value = mapped_field_value(src, map_value, index)
-          value.to_s.empty? ? a_new_hash : a_new_hash.merge!({map_key=>value})
-        end
-        yield final_hash if block_given?
-        final_hash
-      end
-    end
-  
-    protected
-  
-    # This is a hook method useful for subclassing
-    def source_field_value(source, field_name, index)
-      source[field_name]
-    end
-  
-    def mapped_field_value(source, mapped_value, index)
-      case mapped_value
-        when String
-          mapped_value
-        when Symbol
-          source_field_value(source, mapped_value, index)
-        when Proc
-          mapped_value.call(source, index)
-        when Enumerable
-          mapped_value.collect {|key| source_field_value(source, key, index)}.flatten
-        else
-          # try to turn it into a string, else raise UnkownMappingValue
-          mapped_value.respond_to?(:to_s) ? mapped_value.to_s : raise(UnkownMappingValue.new(mapped_value))
-      end
-    end
-    
-  end
-  
-end

data/lib/rsolr/mapper/rss.rb

@@ -1,29 +0,0 @@
-#TODO - this could use the http wrapper stuff instead of open-uri/net::http
-
-require 'rss'
-require 'open-uri'
-
-class RSolr::Mapper::RSS < RSolr::Mapper::Base
-  
-  attr_reader :rss
-  
-  # rss_file_or_url is file path or url (see open-uri)
-  # override_mapping is an alternate mapping (see Solr::Mapper::Base)
-  # returns array of mapped hashes
-  def map(rss_file_or_url, override_mapping=nil)
-    open(rss_file_or_url) do |feed|
-       @rss = RSS::Parser.parse(feed.read, false)
-       super(rss.items.collect, override_mapping)
-    end
-  end
-  
-  # sends methods chain down into the @rss object
-  # example: :'channel.title' == @rss.channel.title
-  # if the method chain doesn't exist, the super #source_field_value method is called
-  def source_field_value(source, method_path, index)
-    method_path.to_s.split('.').inject(@rss) do |rss, m|
-      rss.respond_to?(m) ? rss.send(m.to_sym) : super(source, method_path, index)
-    end
-  end
-  
-end

data/test/mapper_test.rb

@@ -1,123 +0,0 @@
-require File.join(File.dirname(__FILE__), 'test_helpers')
-
-require 'rss'
-
-class MapperTest < RSolrBaseTest
-  
-  # simple replacement
-  def test_string_map
-    data = {
-      :skip_this=>'!'
-    }
-    mapping = {
-      :id=>'one',
-      :name=>'foo'
-    }
-    mapper = RSolr::Mapper::Base.new(mapping)
-    expected = [mapping]
-    assert_equal expected, mapper.map(data)
-  end
-  
-  def test_map_yields_if_block_given
-    data = {
-      :NUMID=>100,
-      :type=>:type_val,
-      :code=>:code_val
-    }
-    mapping = {
-      :id=>:NUMID,
-      :name=>'foo',
-      :category=>[:type, :code]
-    }
-    mapper = RSolr::Mapper::Base.new(mapping)
-    expected = [{:name=>"foo", :category=>[:type_val, :code_val], :id=>100}]
-    result = mapper.map(data) do |doc|
-      assert expected, doc
-    end
-  end
-  
-  # test enumerable/array mappings
-  def test_array_multi_value
-    data = {
-      :NUMID=>100,
-      :type=>:type_val,
-      :code=>:code_val
-    }
-    mapping = {
-      :id=>:NUMID,
-      :name=>'foo',
-      :category=>[:type, :code]
-    }
-    mapper = RSolr::Mapper::Base.new(mapping)
-    expected = [{:name=>"foo", :category=>[:type_val, :code_val], :id=>100}]
-    assert_equal expected, mapper.map(data)
-  end
-  
-  # test the proc mapping type
-  # test that the second arg in the block is a Solr::Mapper
-  def test_proc
-    data = [{:name=>'-bach;'}]
-    mapping = {
-      :name=>proc{|d,index|
-        assert_equal Fixnum, index.class
-        d[:name].gsub(/\W+/, '')
-      }
-    }
-    mapper = RSolr::Mapper::Base.new(mapping)
-    expected = [{:name=>"bach"}]
-    assert_equal expected, mapper.map(data)
-  end
-  
-  def rss_file
-    @rss_file ||= File.join(File.dirname(__FILE__), 'ruby-lang.org.rss.xml')
-  end
-  
-  # load an rss feed
-  # create a mapping
-  # map it and test the fields
-  def raw_mapping_rss_docs
-    rss = RSS::Parser.parse(File.read(rss_file), false)
-    mapping = {
-      :channel=>rss.channel.title,
-      :url=>rss.channel.link,
-      :total=>rss.items.size,
-      :title=>proc {|item,index| item.title },
-      :link=>proc{|item,index| item.link },
-      :published=>proc{|item,index| item.date },
-      :description=>proc{|item,index| item.description }
-    }
-    mapper = RSolr::Mapper::Base.new(mapping)
-    mapper.map(rss.items)
-  end
-  
-  # load an rss feed
-  # create a mapping
-  # map it and test the fields
-  def rss_mapper_docs
-    m = RSolr::Mapper::RSS.new
-    mapping = {
-      :channel=>:'channel.title',
-      :url=>:'channel.link',
-      :total=>:'items.size',
-      :title=>proc {|item,index| item.title },
-      :link=>proc {|item,index| item.link },
-      :published=>proc {|item,index| item.date },
-      :description=>proc {|item,index| item.description }
-    }
-    m.map(rss_file, mapping)
-  end
-  
-  def test_rss
-    [rss_mapper_docs, raw_mapping_rss_docs].each do |docs|
-      assert_equal 10, docs.size
-      first = docs.first
-      # make sure the mapped solr docs have all of the keys from the mapping
-      #assert mapping.keys.all?{|mapping_key| first.keys.include?(mapping_key) }
-      assert_equal docs.size, docs.first[:total].to_i
-      assert_equal Time.parse('Mon Nov 10 09:55:53 -0500 2008'), first[:published]
-      assert_equal 'http://www.ruby-lang.org/en/feeds/news.rss/', first[:url]
-      assert_equal 'Scotland on Rails 2009', first[:title]
-    end
-  end
-  
-end