ferret 0.9.6 → 0.10.0

data/lib/ferret/document.rb

@@ -1,2 +1,130 @@
-require 'ferret/document/field'
-require 'ferret/document/document'
+module Ferret
+  # Instead of using documents to add data to an index you can use Hashes and
+  # Arrays. The only real benefits of using a Document over a Hash are pretty
+  # printing and the boost attribute. You can add the boost attribute to
+  # Hashes and arrays using the BoostMixin. For example;
+  #
+  #    class Hash
+  #      include BoostMixin
+  #    end
+  #
+  #    class Array
+  #      include BoostMixin
+  #    end
+  #
+  #    class String
+  #      include BoostMixin
+  #    end
+  module BoostMixin
+    attr_accessor :boost
+  end
+
+  # Documents are the unit of indexing and search.
+  #
+  # A Document is a set of fields.  Each field has a name and an array of
+  # textual values. If you are coming from a Lucene background you should note
+  # that Fields don't have any properties except for the boost property. You
+  # should use the FieldInfos class to set field properties accross the whole
+  # index instead.
+  # 
+  # === Boost
+  #
+  # The boost attribute makes a Document more important in the index. That is,
+  # you can increase the score of a match for queries that match a particular
+  # document, making it more likely to appear at the top of search results.
+  # You may, for example, want to boost products that have a higher user
+  # rating so that they are more likely to appear in search results.
+  #
+  # Note: that fields which are _not_ stored (see FieldInfos) are _not_
+  # available in documents retrieved from the index, e.g. Searcher#doc or
+  # IndexReader#doc.
+  #
+  # Note: that modifying a Document retrieved from the index will not modify
+  # the document contained within the index. You need to delete the old
+  # version of the document and add the new version of the document.
+  class Document < Hash
+    include BoostMixin
+
+    # Create a new Document object with a boost. The boost defaults to 1.0.
+    def initialize(boost = 1.0)
+      @boost = boost
+    end
+
+    # Return true if the documents are equal, ie they have the same fields
+    def eql?(o)
+      return (o.is_a? Document and (o.boost == @boost) and
+              (self.keys == o.keys) and (self.values == o.values))
+    end
+    alias :== :eql?
+
+    # Create a string represention of the document
+    def to_s
+      buf = ["Document {"]
+      self.keys.sort_by {|key| key.to_s}.each do |key|
+        val = self[key]
+        val_str = if val.instance_of? Array then %{["#{val.join('", "')}"]}
+                  elsif val.is_a? Field then val.to_s
+                  else %{"#{val.to_s}"}
+                  end
+        buf << "  :#{key} => #{val_str}"
+      end
+      buf << ["}#{@boost == 1.0 ? "" : "^" + @boost.to_s}"]
+      return buf.join("\n")
+    end
+  end
+
+  # A Field is a section of a Document. A Field is basically an array with a
+  # boost attribute. It also provides pretty printing of the field with the
+  # #to_s method.
+  #
+  # === Boost
+  #
+  # The boost attribute makes a field more important in the index. That is,
+  # you can increase the score of a match for queries that match terms in a
+  # boosted field. You may, for example, want to boost a title field so that
+  # matches that match in the :title field score more highly than matches that
+  # match in the :contents field. 
+  #
+  # Note: If you'd like to use boosted fields without having to use
+  # the Field class you can just include the BoostMixin in the Array class.
+  # See BoostMixin.
+  class Field < Array
+    include BoostMixin
+
+    # Create a new Field object. You can pass data to the field as either a
+    # string;
+    #
+    #    f = Field.new("This is the fields data")
+    #
+    # or as an array of strings;
+    #
+    #    f = Field.new(["this", "is", "an", "array", "of", "field", "data"])
+    #
+    # Of course Fields can also be boosted;
+    #
+    #    f = Field.new("field data", 1000.0)
+    def initialize(data = [], boost = 1.0)
+      @boost = boost
+      if data.is_a? Array
+        data.each {|v| self << v}
+      else
+        self << data.to_s
+      end
+    end
+
+    def eql?(o)
+      return (o.is_a? Field and (o.boost == @boost) and super(o))
+    end
+    alias :== :eql?
+
+    def +(o)
+      return Field.new(super(o), self.boost)
+    end
+
+    def to_s
+      buf = %{["#{self.join('", "')}"]}
+      buf << "^#@boost" if @boost != 1.0
+      return buf
+    end
+  end
+end

data/lib/ferret/index.rb

@@ -1,26 +1,577 @@
-require 'ferret/index/index_file_names'
-require 'ferret/index/term'
-require 'ferret/index/term_buffer'
-require 'ferret/index/term_doc_enum'
-require 'ferret/index/multiple_term_doc_pos_enum'
-require 'ferret/index/term_enum'
-require 'ferret/index/term_info'
-require 'ferret/index/term_infos_io'
-require 'ferret/index/term_vector_offset_info'
-require 'ferret/index/term_vectors_io'
-require 'ferret/index/field_infos'
-require 'ferret/index/fields_io'
-require 'ferret/index/compound_file_io'
-require 'ferret/index/term_buffer'
-require 'ferret/index/segment_term_enum'
-require 'ferret/index/segment_term_vector'
-require 'ferret/index/segment_merge_info'
-require 'ferret/index/segment_merge_queue'
-require 'ferret/index/segment_infos'
-require 'ferret/index/document_writer'
-require 'ferret/index/index_reader'
-require 'ferret/index/index_writer'
-require 'ferret/index/multi_reader'
-require 'ferret/index/segment_merger'
-require 'ferret/index/segment_reader'
-require 'ferret/index/index'
+require 'monitor'
+
+module Ferret::Index
+  # This is a simplified interface to the index. See the TUTORIAL for more
+  # information on how to use this class.
+  class Index
+    include MonitorMixin
+
+    include Ferret::Store
+    include Ferret::Search
+
+    attr_reader :options
+    # If you create an Index without any options, it'll simply create an index
+    # in memory. But this class is highly configurable and every option that
+    # you can supply to IndexWriter and QueryParser, you can also set here.
+    # Please look at the options for the constructors to these classes.
+    #
+    # === Options
+    #
+    # See;
+    #
+    # * QueryParser
+    # * IndexWriter
+    #
+    # default_input_field::   Default: "id". This specifies the default field
+    #                         that will be used when you add a simple string
+    #                         to the index using #add_document or <<.
+    # id_field:               Default: "id". This field is as the field to
+    #                         search when doing searches on a term. For
+    #                         example, if you do a lookup by term "cat", ie
+    #                         index["cat"], this will be the field that is
+    #                         searched.
+    # key::                   Default: nil. Expert: This should only be used
+    #                         if you really know what you are doing. Basically
+    #                         you can set a field or an array of fields to be
+    #                         the key for the index. So if you add a document
+    #                         with a same key as an existing document, the
+    #                         existing document will be replaced by the new
+    #                         object.  Using a multiple field key will slow
+    #                         down indexing so it should not be done if
+    #                         performance is a concern. A single field key (or
+    #                         id) should be find however. Also, you must make
+    #                         sure that your key/keys are either untokenized
+    #                         or that they are not broken up by the analyzer.
+    # auto_flush::            Default: false. Set this option to true if you
+    #                         want the index automatically flushed every time
+    #                         you do a write (includes delete) to the index.
+    #                         This is useful if you have multiple processes
+    #                         accessing the index and you don't want lock
+    #                         errors. Setting :auto_flush to true has a huge
+    #                         performance impact so don't use it if you are
+    #                         concerned about performance. In that case you
+    #                         should think about setting up a DRb indexing
+    #                         service.
+    # 
+    # Some examples;
+    #
+    #   index = Index::Index.new(:analyzer => WhiteSpaceAnalyzer.new())
+    #
+    #   index = Index::Index.new(:path => '/path/to/index',
+    #                            :create_if_missing => false,
+    #                            :auto_flush => true)
+    #
+    #   index = Index::Index.new(:dir => directory,
+    #                            :default_slop => 2,
+    #                            :handle_parse_errors => false)
+    #   
+    def initialize(options = {})
+      super()
+
+      if options[:key]
+        @key = options[:key]
+        if @key.is_a?(Array)
+          @key.flatten.map {|k| k.to_s.intern}
+        end
+      end
+
+      if options[:dir].is_a?(String)
+        options[:path] = options[:dir]
+      end
+      if options[:path]
+        begin
+          @dir = FSDirectory.new(options[:path], options[:create])
+        rescue IOError => io
+          @dir = FSDirectory.new(options[:path], options[:create_if_missing])
+        end
+      elsif options[:dir]
+        @dir = options[:dir]
+      else
+        options[:create] = true # this should always be true for a new RAMDir
+        @dir = RAMDirectory.new
+      end
+
+      options[:dir] = @dir
+      @dir.extend(MonitorMixin)
+      @dir.synchronize do
+        @options = options
+        @writer = IndexWriter.new(options) # create the index if need be
+        options[:analyzer] = @analyzer = @writer.analyzer
+        @writer.close
+        @writer = nil
+        @reader = nil
+        @options.delete(:create) # only want to create the first time if at all
+        @auto_flush = @options[:auto_flush] || false
+        if (@options[:id_field].nil? and
+            @key.is_a?(Symbol))
+          @id_field = @key
+        else
+          @id_field = @options[:id_field] || :id
+        end
+        @default_field = (@options[:default_field]||= :*)
+        @default_input_field = options[:default_input_field] || @id_field
+
+        if @default_input_field.respond_to?(:intern)
+          @default_input_field = @default_input_field.intern
+        end
+        @open = true
+        @qp = nil
+      end
+    end
+
+    # Closes this index by closing its associated reader and writer objects.
+    def close
+      @dir.synchronize do
+        if not @open
+          raise "tried to close an already closed directory"
+        end
+        @searcher.close() if @searcher
+        @reader.close() if @reader
+        @writer.close() if @writer
+        @dir.close()
+
+        @open = false
+      end
+    end
+
+    # Get the reader for this index.
+    # NOTE:: This will close the writer from this index.
+    def reader
+      ensure_reader_open()
+      return @reader
+    end
+
+    # Get the searcher for this index.
+    # NOTE:: This will close the writer from this index.
+    def searcher
+      ensure_searcher_open()
+      return @searcher
+    end
+
+    # Get the writer for this index.
+    # NOTE:: This will close the reader from this index.
+    def writer
+      ensure_writer_open()
+      return @writer
+    end
+    protected :reader, :writer, :searcher
+
+    # Adds a document to this index, using the provided analyzer instead of
+    # the local analyzer if provided.  If the document contains more than
+    # IndexWriter::MAX_FIELD_LENGTH terms for a given field, the remainder are
+    # discarded.
+    #
+    # There are three ways to add a document to the index. 
+    # To add a document you can simply add a string or an array of strings.
+    # This will store all the strings in the "" (ie empty string) field
+    # (unless you specify the default_field when you create the index).
+    #
+    #   index << "This is a new document to be indexed"
+    #   index << ["And here", "is another", "new document", "to be indexed"]
+    # 
+    # But these are pretty simple documents. If this is all you want to index
+    # you could probably just use SimpleSearch. So let's give our documents
+    # some fields;
+    # 
+    #   index << {:title => "Programming Ruby", :content => "blah blah blah"}
+    #   index << {:title => "Programming Ruby", :content => "yada yada yada"}
+    # 
+    # Or if you are indexing data stored in a database, you'll probably want
+    # to store the id;
+    # 
+    #   index << {:id => row.id, :title => row.title, :date => row.date}
+    # 
+    # See FieldInfos for more information on how to set field properties.
+    def add_document(doc, analyzer = nil)
+      @dir.synchronize do
+        if doc.is_a?(String) or doc.is_a?(Array)
+          doc = {@default_input_field => doc}
+        end
+
+        # delete existing documents with the same key
+        if @key
+          if @key.is_a?(Array)
+            query = @key.inject(BooleanQuery.new()) do |bq, field|
+              bq.add_query(TermQuery.new(field, doc[field].to_s), :must)
+              bq
+            end
+            query_delete(query)
+          else
+            id = doc[@key].to_s
+            if id
+              delete(id)
+              @writer.commit
+            end
+          end
+        end
+        ensure_writer_open()
+
+        old_analyzer = @writer.analyzer if analyzer
+        @writer.add_document(doc)
+        @writer.analyzer = old_analyzer if analyzer
+
+        flush() if @auto_flush
+      end
+    end
+    alias :<< :add_document
+
+    # The main search method for the index. You need to create a query to
+    # pass to this method. You can also pass a hash with one or more of the
+    # following; {filter, num_docs, first_doc, sort}
+    #
+    # query::       The query to run on the index
+    # filter::      Filters docs from the search result
+    # first_doc::   The index in the results of the first doc retrieved.
+    #               Default is 0
+    # num_docs::    The number of results returned. Default is 10
+    # sort::        An array of SortFields describing how to sort the results.
+    # filter_proc:: A proc which takes |doc_id, score, searcher| as arguments
+    #               and returns true if the document passes the filter.
+    def search(query, options = {})
+      @dir.synchronize do
+        return do_search(query, options)
+      end
+    end
+
+    # See Index#search
+    #
+    # This method yields the doc and score for each hit.
+    # eg.
+    #   index.search_each() do |doc, score|
+    #     puts "hit document number #{doc} with a score of #{score}"
+    #   end
+    #
+    # returns:: The total number of hits.
+    def search_each(query, options = {}) # :yield: doc, score
+      @dir.synchronize do
+        ensure_searcher_open()
+        query = process_query(query)
+
+        @searcher.search_each(query) do |doc, score|
+          yield doc, score
+        end
+      end
+    end
+
+    # Retrieve the document referenced by the document number +id+, if id is
+    # an integer or the first document with term +id+ if +id+ is a term.
+    #
+    # id:: The number of the document to retrieve, or the term used as the :id
+    #      for the document we wish to retrieve
+    def doc(id)
+      @dir.synchronize do
+        ensure_reader_open()
+        if id.kind_of?(String) or id.kind_of?(Symbol)
+          term_doc_enum = @reader.term_docs_for(@id_field, id.to_s)
+          id = term_doc_enum.next? ? term_doc_enum.doc : nil
+        end
+        return @reader[id] if id.is_a? Integer
+        if id
+          raise(ArgumentError, "key to Index to access a document must be " +
+                "an Integer or a String")
+        end
+      end
+      return nil
+    end
+    alias :[] :doc
+
+    # Delete the document referenced by the document number +id+ if +id+ is an
+    # integer or all of the documents which have the term +id+ if +id+ is a
+    # term..
+    #
+    # id:: The number of the document to delete
+    def delete(id)
+      @dir.synchronize do
+        if id.is_a?(String) or id.is_a?(Symbol)
+          ensure_writer_open()
+          @writer.delete(@id_field, id.to_s)
+        elsif id.is_a?(Integer)
+          ensure_reader_open()
+          cnt = @reader.delete(id)
+        else
+          raise ArgumentError, "Cannot delete for id of type #{id.class}"
+        end
+        flush() if @auto_flush
+      end
+      return self
+    end
+
+    # Delete all documents returned by the query.
+    # 
+    # query:: The query to find documents you wish to delete. Can either be a
+    #         string (in which case it is parsed by the standard query parser)
+    #         or an actual query object.
+    def query_delete(query)
+      @dir.synchronize do
+        ensure_searcher_open()
+        query = process_query(query)
+        @searcher.search_each(query) do |doc, score|
+          @reader.delete(doc)
+        end
+        flush() if @auto_flush
+      end
+    end
+
+    # Returns true if document +n+ has been deleted 
+    def deleted?(n)
+      @dir.synchronize do 
+        ensure_reader_open()
+        return @reader.deleted?(n) 
+      end
+    end
+
+    # Update the document referenced by the document number +id+ if +id+ is an
+    # integer or all of the documents which have the term +id+ if +id+ is a
+    # term..
+    #
+    # id::      The number of the document to update. Can also be a string
+    #           representing the value in the +id+ field. Also consider using
+    #           the :key attribute.
+    # new_doc:: The document to replace the old document with
+    def update(id, new_doc)
+      @dir.synchronize do
+        delete(id)
+        if id.is_a?(String) or id.is_a?(Symbol)
+          @writer.commit
+        else
+          ensure_writer_open()
+        end
+        @writer << new_doc
+        flush() if @auto_flush
+      end
+    end
+
+    # Update all the documents returned by the query.
+    #
+    # query::   The query to find documents you wish to update. Can either be
+    #           a string (in which case it is parsed by the standard query
+    #           parser) or an actual query object.
+    # new_val:: The values we are updating. This can be a string in which case
+    #           the default field is updated, or it can be a hash, in which
+    #           case, all fields in the hash are merged into the old hash.
+    #           That is, the old fields are replaced by values in the new hash
+    #           if they exist.
+    #
+    # === Example
+    #
+    #   index << {:id => "26", :title => "Babylon", :artist => "David Grey"}
+    #   index << {:id => "29", :title => "My Oh My", :artist => "David Grey"}
+    #
+    #   # correct 
+    #   index.query_update('artist:"David Grey"', {:artist => "David Gray"})
+    #
+    #   index["26"]
+    #     #=> {:id => "26", :title => "Babylon", :artist => "David Gray"}
+    #   index["28"]
+    #     #=> {:id => "28", :title => "My Oh My", :artist => "David Gray"}
+    #
+    def query_update(query, new_val)
+      @dir.synchronize do
+        ensure_searcher_open()
+        docs_to_add = []
+        query = process_query(query)
+        @searcher.search_each(query) do |id, score|
+          document = @searcher[id].load
+          if new_val.is_a?(Hash)
+            document.merge!(new_val)
+          else new_val.is_a?(String) or new_val.is_a?(Symbol)
+            document[@default_input_field] = new_val.to_s
+          end
+          docs_to_add << document
+          @reader.delete(id)
+        end
+        ensure_writer_open()
+        docs_to_add.each {|doc| @writer << doc }
+        flush() if @auto_flush
+      end
+    end
+
+    # Returns true if any documents have been deleted since the index was last
+    # flushed.
+    def has_deletions?()
+      @dir.synchronize do
+        ensure_reader_open()
+        return @reader.has_deletions?
+      end
+    end
+    
+    # Flushes all writes to the index. This will not optimize the index but it
+    # will make sure that all writes are written to it.
+    #
+    # NOTE: this is not necessary if you are only using this class. All writes
+    # will automatically flush when you perform an operation that reads the
+    # index.
+    def flush()
+      @dir.synchronize do
+        @searcher.close if @searcher
+        @reader.close if @reader
+        @writer.close if @writer
+        @reader = nil
+        @writer = nil
+        @searcher = nil
+      end
+    end
+
+    # optimizes the index. This should only be called when the index will no
+    # longer be updated very often, but will be read a lot.
+    def optimize()
+      @dir.synchronize do
+        ensure_writer_open()
+        @writer.optimize()
+        @writer.close()
+        @writer = nil
+      end
+    end
+
+    # returns the number of documents in the index
+    def size()
+      @dir.synchronize do
+        ensure_reader_open()
+        return @reader.num_docs()
+      end
+    end
+
+    # Merges all segments from an index or an array of indexes into this
+    # index. You can pass a single Index::Index, Index::Reader,
+    # Store::Directory or an array of any single one of these.
+    #
+    # This may be used to parallelize batch indexing. A large document
+    # collection can be broken into sub-collections. Each sub-collection can
+    # be indexed in parallel, on a different thread, process or machine and
+    # perhaps all in memory. The complete index can then be created by
+    # merging sub-collection indexes with this method.
+    #
+    # After this completes, the index is optimized.
+    def add_indexes(indexes)
+      @dir.synchronize do
+        indexes = [indexes].flatten   # make sure we have an array
+        return if indexes.size == 0 # nothing to do
+        if indexes[0].is_a?(Index)
+          indexes.delete(self) # don't merge with self
+          indexes = indexes.map {|index| index.reader }
+        elsif indexes[0].is_a?(Ferret::Store::Directory)
+          indexes.delete(@dir) # don't merge with self
+          indexes = indexes.map {|dir| IndexReader.new(dir) }
+        elsif indexes[0].is_a?(IndexReader)
+          indexes.delete(@reader) # don't merge with self
+        else
+          raise ArgumentError, "Unknown index type when trying to merge indexes"
+        end
+        ensure_writer_open
+        @writer.add_readers(indexes)
+      end
+    end
+
+    # This is a simple utility method for saving an in memory or RAM index to
+    # the file system. The same thing can be achieved by using the
+    # Index::Index#add_indexes method and you will have more options when
+    # creating the new index, however this is a simple way to turn a RAM index
+    # into a file system index.
+    #
+    # directory:: This can either be a Store::Directory object or a String
+    #             representing the path to the directory where you would
+    #             like to store the the index.
+    #
+    # create::    True if you'd like to create the directory if it doesn't
+    #             exist or copy over an existing directory. False if you'd
+    #             like to merge with the existing directory. This defaults to
+    #             false.
+    def persist(directory, create = true)
+      synchronize do
+        flush()
+        old_dir = @dir
+        if directory.is_a?(String)
+          @dir = FSDirectory.new(directory, create)
+        elsif directory.is_a?(Ferret::Store::Directory)
+          @dir = directory
+        end
+        @dir.extend(MonitorMixin)
+        @options[:dir] = @dir
+        @options[:create_if_missing] = true
+        add_indexes([old_dir])
+      end
+    end
+
+    def to_s
+      buf = ""
+      (0...(size)).each do |i|
+        buf << self[i].to_s + "\n" if not deleted?(i)
+      end
+      buf
+    end
+
+    # Returns an Explanation that describes how +doc+ scored against
+    # +query+.
+    # 
+    # This is intended to be used in developing Similarity implementations,
+    # and, for good performance, should not be displayed with every hit.
+    # Computing an explanation is as expensive as executing the query over the
+    # entire index.
+    def explain(query, doc)
+      synchronize do
+        ensure_searcher_open()
+        query = process_query(query)
+
+        return @searcher.explain(query, doc)
+      end
+    end
+
+    protected
+      def ensure_writer_open()
+        raise "tried to use a closed index" if not @open
+        return if @writer
+        if @reader
+          @searcher.close if @searcher
+          @reader.close
+          @reader = nil
+          @searcher = nil
+        end
+        @writer = IndexWriter.new(@options)
+      end
+
+      # returns the new reader if one is opened
+      def ensure_reader_open()
+        raise "tried to use a closed index" if not @open
+        if @reader
+          if not @reader.latest?
+            return @reader = IndexReader.new(@dir)
+          end
+        else
+          if @writer
+            @writer.close
+            @writer = nil
+          end
+          return @reader = IndexReader.new(@dir)
+        end
+        return false
+      end
+
+      def ensure_searcher_open()
+        raise "tried to use a closed index" if not @open
+        if ensure_reader_open() or not @searcher
+          @searcher = Searcher.new(@reader)
+        end
+      end
+
+    private
+      def do_search(query, options)
+        ensure_searcher_open()
+        query = process_query(query)
+
+        return @searcher.search(query, options)
+      end
+
+      def process_query(query)
+        if query.is_a?(String)
+          if @qp.nil?
+            @qp = Ferret::QueryParser.new(@options)
+          end
+          # we need to set this ever time, in case a new field has been added
+          @qp.fields = @reader.field_names
+          query = @qp.parse(query)
+        end
+        return query
+      end
+
+  end
+end