muck-solr 0.4.0

data/lib/solr/importer/mapper.rb

@@ -0,0 +1,51 @@
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+class Solr::Importer::Mapper
+  def initialize(mapping, options={})
+    @mapping = mapping
+    @options = options
+  end
+  
+  def field_data(orig_data, field_name)
+    orig_data[field_name]
+  end
+  
+  def mapped_field_value(orig_data, field_mapping)
+    case field_mapping
+      when String
+        field_mapping
+      when Proc
+        field_mapping.call(orig_data)  # TODO pass in more context, like self or a function for field_data, etc
+      when Symbol
+        field_data(orig_data, @options[:stringify_symbols] ? field_mapping.to_s : field_mapping)
+      when Enumerable
+        field_mapping.collect {|orig_field_name| mapped_field_value(orig_data, orig_field_name)}.flatten
+      else
+        raise "Unknown mapping for #{field_mapping}"
+    end
+  end
+  
+  def map(orig_data)
+    mapped_data = {}
+    @mapping.each do |solr_name, field_mapping|
+      value = mapped_field_value(orig_data, field_mapping)
+      mapped_data[solr_name] = value if value
+    end
+    
+    mapped_data
+  end
+  
+  
+  
+  
+end

data/lib/solr/importer/solr_source.rb

@@ -0,0 +1,41 @@
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+class Solr::Importer::SolrSource
+  def initialize(solr_url, query, filter_queries=nil, options={})
+    @connection = Solr::Connection.new(solr_url)
+    @query = query
+    @filter_queries = filter_queries
+
+    @page_size = options[:page_size] || 1000
+    @field_list = options[:field_list] || ["*"]
+  end
+  
+  def each
+    done = false
+    start = 0
+    until done do
+      # request N documents from a starting point
+      request = Solr::Request::Standard.new(:query => @query,
+                                            :rows => @page_size,
+                                            :start => start,
+                                            :field_list => @field_list,
+                                            :filter_queries => @filter_queries)
+      response = @connection.send(request)
+      response.each do |doc|
+        yield doc  # TODO: perhaps convert to HashWithIndifferentAccess.new(doc), so stringify_keys isn't necessary
+      end
+      done = start + @page_size >= response.total_hits
+      start = start + @page_size
+    end
+  end
+end

data/lib/solr/importer/xpath_mapper.rb

@@ -0,0 +1,35 @@
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+begin
+  require 'xml/libxml'
+
+  # For files with the first line containing field names
+  class Solr::Importer::XPathMapper < Solr::Importer::Mapper
+    def field_data(doc, xpath)
+      doc.find(xpath.to_s).collect do |node|
+        case node
+          when XML::Attr
+            node.value
+          when XML::Node
+            node.content
+        end
+      end
+    end
+  end
+rescue LoadError => e # If we can't load libxml
+  class Solr::Importer::XPathMapper
+    def initialize(mapping, options={})
+      raise "libxml not installed"
+    end
+  end
+end

data/lib/solr/indexer.rb

@@ -0,0 +1,52 @@
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+class Solr::Indexer
+  attr_reader :solr
+  
+  # TODO: document options!
+  def initialize(data_source, mapper_or_mapping, options={})
+    solr_url = options[:solr_url] || ENV["SOLR_URL"] || "http://localhost:8983/solr"
+    @solr = Solr::Connection.new(solr_url, options) #TODO - these options contain the solr_url and debug keys also, so tidy up what gets passed
+
+    @data_source = data_source
+    @mapper = mapper_or_mapping.is_a?(Hash) ? Solr::Importer::Mapper.new(mapper_or_mapping) : mapper_or_mapping
+
+    @buffer_docs = options[:buffer_docs]
+    @debug = options[:debug]
+  end
+
+  def index
+    buffer = []
+    @data_source.each do |record|
+      document = @mapper.map(record)
+      
+      # TODO: check arrity of block, if 3, pass counter as 3rd argument
+      yield(record, document) if block_given? # TODO check return of block, if not true then don't index, or perhaps if document.empty?
+      
+      buffer << document
+      
+      if !@buffer_docs || buffer.size == @buffer_docs
+        add_docs(buffer)
+        buffer.clear
+      end
+    end
+    add_docs(buffer) if !buffer.empty?
+    
+    @solr.commit unless @debug
+  end
+  
+  def add_docs(documents)
+    @solr.add(documents) unless @debug
+    puts documents.inspect if @debug
+  end
+end

data/lib/solr/request.rb

@@ -0,0 +1,26 @@
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Solr; module Request; end; end
+require File.expand_path("#{File.dirname(__FILE__)}/request/base")
+require File.expand_path("#{File.dirname(__FILE__)}/request/update")
+require File.expand_path("#{File.dirname(__FILE__)}/request/add_document")
+require File.expand_path("#{File.dirname(__FILE__)}/request/modify_document")
+require File.expand_path("#{File.dirname(__FILE__)}/request/commit")
+require File.expand_path("#{File.dirname(__FILE__)}/request/delete")
+require File.expand_path("#{File.dirname(__FILE__)}/request/ping")
+require File.expand_path("#{File.dirname(__FILE__)}/request/select")
+require File.expand_path("#{File.dirname(__FILE__)}/request/standard")
+require File.expand_path("#{File.dirname(__FILE__)}/request/spellcheck")
+require File.expand_path("#{File.dirname(__FILE__)}/request/dismax")
+require File.expand_path("#{File.dirname(__FILE__)}/request/index_info")
+require File.expand_path("#{File.dirname(__FILE__)}/request/optimize")

data/lib/solr/request/add_document.rb

@@ -0,0 +1,58 @@
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+class Solr::Request::AddDocument < Solr::Request::Update
+
+  # create the request, optionally passing in a Solr::Document
+  #
+  #   request = Solr::Request::AddDocument.new doc
+  #
+  # as a short cut you can pass in a Hash instead:
+  #
+  #   request = Solr::Request::AddDocument.new :creator => 'Jorge Luis Borges'
+  # 
+  # or an array, to add multiple documents at the same time:
+  # 
+  #   request = Solr::Request::AddDocument.new([doc1, doc2, doc3])
+    
+  def initialize(doc={})
+    @docs = []
+    if doc.is_a?(Array)
+      doc.each { |d| add_doc(d) }
+    else
+      add_doc(doc)
+    end
+  end
+
+  # returns the request as a string suitable for posting
+  
+  def to_s
+    e = Solr::XML::Element.new 'add'
+    for doc in @docs
+      e.add_element doc.to_xml
+    end
+    return e.to_s
+  end
+  
+  private
+  def add_doc(doc)
+    case doc
+    when Hash
+      @docs << Solr::Document.new(doc)
+    when Solr::Document
+      @docs << doc
+    else
+      raise "must pass in Solr::Document or Hash"
+    end
+  end
+  
+end

data/lib/solr/request/base.rb

@@ -0,0 +1,36 @@
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+class Solr::Request::Base
+  
+  
+  #TODO : Add base support for the debugQuery flag, and such that the response provides debug output easily
+
+  # returns either :xml or :ruby depending on what the
+  # response type is for a given request
+  
+  def response_format
+    raise "unknown request type: #{self.class}"
+  end
+  
+  def content_type
+    'text/xml; charset=utf-8'
+  end
+
+  # returns the solr handler or url fragment that can 
+  # respond to this type of request
+  
+  def handler
+    raise "unknown request type: #{self.class}"
+  end
+
+end

data/lib/solr/request/commit.rb

@@ -0,0 +1,29 @@
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+class Solr::Request::Commit < Solr::Request::Update
+
+  def initialize(options={})
+    @wait_searcher = options[:wait_searcher] || true
+    @wait_flush = options[:wait_flush] || true
+  end
+
+
+  def to_s
+    e = Solr::XML::Element.new('commit')
+    e.attributes['waitSearcher'] = @wait_searcher ? 'true' : 'false'
+    e.attributes['waitFlush'] = @wait_flush ? 'true' : 'false'
+    
+    e.to_s
+  end
+
+end

data/lib/solr/request/delete.rb

@@ -0,0 +1,48 @@
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+class Solr::Request::Delete < Solr::Request::Update
+
+  # A delete request can be for a specific document id
+  #
+  #   request = Solr::Request::Delete.new(:id => 1234)
+  #
+  # or by query:
+  #
+  #   request = Solr::Request::Delete.new(:query =>
+  #
+  def initialize(options)
+    unless options.kind_of?(Hash) and (options[:id] or options[:query])
+      raise Solr::Exception.new("must pass in :id or :query")
+    end
+    if options[:id] and options[:query]
+      raise Solr::Exception.new("can't pass in both :id and :query")
+    end
+    @document_id = options[:id]
+    @query = options[:query]
+  end
+
+  def to_s
+    delete_element = Solr::XML::Element.new('delete')
+    if @document_id
+      id_element = Solr::XML::Element.new('id')
+      id_element.text = @document_id
+      delete_element.add_element(id_element)
+    elsif @query
+      query = Solr::XML::Element.new('query')
+      query.text = @query 
+      delete_element.add_element(query)
+    end
+    delete_element.to_s
+  end
+end
+

data/lib/solr/request/dismax.rb

@@ -0,0 +1,46 @@
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+class Solr::Request::Dismax < Solr::Request::Standard
+
+  VALID_PARAMS.replace(VALID_PARAMS + [:tie_breaker, :query_fields, :minimum_match, :phrase_fields, :phrase_slop,
+                                       :boost_query, :boost_functions])
+
+  def initialize(params)
+    @alternate_query = params.delete(:alternate_query)
+    @sort_values = params.delete(:sort)
+    
+    super
+    
+    @query_type = "dismax"
+  end
+  
+  def to_hash
+    hash = super
+    hash[:tie] = @params[:tie_breaker]
+    hash[:mm]  = @params[:minimum_match]
+    hash[:qf]  = @params[:query_fields]
+    hash[:pf]  = @params[:phrase_fields]
+    hash[:ps]  = @params[:phrase_slop]
+    hash[:bq]  = @params[:boost_query]
+    hash[:bf]  = @params[:boost_functions]
+    hash["q.alt"] = @alternate_query
+    # FIXME: 2007-02-13 <coda.hale@gmail.com> --  This code is duplicated in
+    # Solr::Request::Standard. It should be refactored into a single location.
+    hash[:sort] = @sort_values.collect do |sort|
+      key = sort.keys[0]
+      "#{key.to_s} #{sort[key] == :descending ? 'desc' : 'asc'}"
+    end.join(',') if @sort_values
+    return hash
+  end
+
+end

data/lib/solr/request/index_info.rb

@@ -0,0 +1,22 @@
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+class Solr::Request::IndexInfo < Solr::Request::Select
+  
+  def handler
+    'admin/luke'
+  end
+  
+  def to_hash
+    {:numTerms => 0}.merge(super.to_hash)
+  end
+end