Class: PrettySearch::Collection Abstract

Inherits:

Object

• Object
• PrettySearch::Collection

Defined in:

lib/pretty_search/collection.rb

Overview

This class is abstract.

PrettySearch::Collection is the abstract class representing a searchable collection of records.

Implementations should include:

- #search(PrettySearch::Query) returning Array<PrettySearch::Document>

See implementations in lib/pretty_search/collection

Direct Known Subclasses

IndexedCollection, MemoryCollection

Class Method Summary

• .load(data_file, options = {}) ⇒ PrettySearch::Collection, #search

  TODO: return IndexedCollection when multiple searches is supported.

Class Method Details

.load(data_file, options = {}) ⇒ PrettySearch::Collection, #search

TODO: return IndexedCollection when multiple searches is supported

Returns:

• (PrettySearch::Collection, #search)

# File 'lib/pretty_search/collection.rb', line 15

def self.load(data_file, options = {})
  PrettySearch::MemoryCollection.new(data_file, first: options[:first])
end