xapit 0.2.7 → 0.3.0

data/Manifest

@@ -1,60 +0,0 @@
-CHANGELOG
-features/facets.feature
-features/finding.feature
-features/indexing.feature
-features/sorting.feature
-features/step_definitions/common_steps.rb
-features/step_definitions/xapit_steps.rb
-features/suggestions.feature
-features/support/env.rb
-features/support/xapit_helpers.rb
-init.rb
-install.rb
-lib/xapit/adapters/abstract_adapter.rb
-lib/xapit/adapters/active_record_adapter.rb
-lib/xapit/adapters/data_mapper_adapter.rb
-lib/xapit/collection.rb
-lib/xapit/config.rb
-lib/xapit/facet.rb
-lib/xapit/facet_blueprint.rb
-lib/xapit/facet_option.rb
-lib/xapit/index_blueprint.rb
-lib/xapit/indexers/abstract_indexer.rb
-lib/xapit/indexers/classic_indexer.rb
-lib/xapit/indexers/simple_indexer.rb
-lib/xapit/membership.rb
-lib/xapit/query.rb
-lib/xapit/query_parsers/abstract_query_parser.rb
-lib/xapit/query_parsers/classic_query_parser.rb
-lib/xapit/query_parsers/simple_query_parser.rb
-lib/xapit/rake_tasks.rb
-lib/xapit.rb
-LICENSE
-Manifest
-rails_generators/xapit/templates/setup_xapit.rb
-rails_generators/xapit/templates/xapit.rake
-rails_generators/xapit/USAGE
-rails_generators/xapit/xapit_generator.rb
-Rakefile
-README.rdoc
-spec/spec_helper.rb
-spec/xapit/adapters/active_record_adapter_spec.rb
-spec/xapit/adapters/data_mapper_adapter_spec.rb
-spec/xapit/collection_spec.rb
-spec/xapit/config_spec.rb
-spec/xapit/facet_blueprint_spec.rb
-spec/xapit/facet_option_spec.rb
-spec/xapit/facet_spec.rb
-spec/xapit/index_blueprint_spec.rb
-spec/xapit/indexers/abstract_indexer_spec.rb
-spec/xapit/indexers/classic_indexer_spec.rb
-spec/xapit/indexers/simple_indexer_spec.rb
-spec/xapit/membership_spec.rb
-spec/xapit/query_parsers/abstract_query_parser_spec.rb
-spec/xapit/query_parsers/classic_query_parser_spec.rb
-spec/xapit/query_parsers/simple_query_parser_spec.rb
-spec/xapit/query_spec.rb
-spec/xapit_member.rb
-tasks/spec.rb
-tasks/xapit.rake
-uninstall.rb

data/features/sorting.feature

@@ -1,29 +0,0 @@
-Background:
-  Given an empty database at "tmp/xapiandatabase"
-
-Scenario: Query for All Records Sorted by Name
-  Given indexed records named "Zebra, Apple, Banana"
-  When I query "" sorted by name
-  Then I should find records named "Apple, Banana, Zebra"
-
-Scenario: Query for All Records Sorted by Age then Name
-  Given the following indexed records
-    | name   | age |
-    | Banana | 23  |
-    | Zebra  | 17  |
-    | Apple  | 17  |
-  When I query "" sorted by age, name
-  Then I should find records named "Apple, Zebra, Banana"
-
-Scenario: Query for All Records Sorted by Name Descending
-  Given indexed records named "Zebra, Apple, Banana"
-  When I query "" sorted by name descending
-  Then I should find records named "Zebra, Banana, Apple"
-
-Scenario: Query for Records Sorted Numerically
-  Given the following indexed records
-    | name   | age |
-    | Banana | 9   |
-    | Zebra  | 10  |
-  When I query "" sorted by age, name
-  Then I should find records named "Banana, Zebra"

data/init.rb

@@ -1 +0,0 @@
-require 'xapit'

data/install.rb

@@ -1,8 +0,0 @@
-require 'ftools'
-
-source = File.join(File.dirname(__FILE__), '/rails_generators/xapit/templates/setup_xapit.rb')
-destination = "#{Rails.root}/config/initializers/setup_xapit.rb"
-unless File.exist? destination
-  puts "Adding config/initializers/setup_xapit.rb"
-  File.copy(source, destination)
-end

data/lib/xapit/adapters/abstract_adapter.rb

@@ -1,47 +0,0 @@
-module Xapit
-  # Adapters are used to support multiple ORMs (ActiveRecord, Datamapper, Sequel, etc.).
-  # It abstracts out all find calls so they can be handled differently for each ORM.
-  # To create your own adapter, subclass AbstractAdapter and override the placeholder methods.
-  # See ActiveRecordAdapter for an example.
-  class AbstractAdapter
-    def self.inherited(subclass)
-      @subclasses ||= []
-      @subclasses << subclass
-    end
-    
-    # Returns all adapter classes.
-    def self.subclasses
-      @subclasses
-    end
-    
-    # Sets the @target instance, this is the class the adapter needs to forward
-    # its messages to.
-    def initialize(target)
-      @target = target
-    end
-    
-    # Used to determine if the given adapter should be used for the passed in class.
-    # Usually one will see if it inherits from another class (ActiveRecord::Base)
-    def self.for_class?(member_class)
-      raise "To be implemented in subclass"
-    end
-    
-    # Fetch a single record by the given id.
-    # The args are the same as those passed from the XapitMember#xapit call.
-    def find_single(id, *args)
-      raise "To be implemented in subclass"
-    end
-    
-    # Fetch multiple records from the passed in array of ids.
-    def find_multiple(ids)
-      raise "To be implemented in subclass"
-    end
-    
-    # Iiterate through all records using the given parameters.
-    # It should yield to the block and pass in each record individually.
-    # The args are the same as those passed from the XapitMember#xapit call.
-    def find_each(*args, &block)
-      raise "To be implemented in subclass"
-    end
-  end
-end

data/lib/xapit/adapters/active_record_adapter.rb

@@ -1,20 +0,0 @@
-module Xapit
-  # This adapter is used for all ActiveRecord models. See AbstractAdapter for details.
-  class ActiveRecordAdapter < AbstractAdapter
-    def self.for_class?(member_class)
-      member_class.ancestors.map(&:to_s).include? "ActiveRecord::Base"
-    end
-    
-    def find_single(id, *args)
-      @target.find_by_id(id, *args)
-    end
-    
-    def find_multiple(ids)
-      @target.find(ids)
-    end
-    
-    def find_each(*args, &block)
-      @target.find_each(*args, &block)
-    end
-  end
-end

data/lib/xapit/adapters/data_mapper_adapter.rb

@@ -1,10 +0,0 @@
-module Xapit
-  # This adapter is used for all DataMapper models. See AbstractAdapter for details.
-  class DataMapperAdapter < AbstractAdapter
-    def self.for_class?(member_class)
-      member_class.ancestors.map(&:to_s).include? "DataMapper::Resource"
-    end
-    
-    # TODO override the rest of the methods here...
-  end
-end

data/lib/xapit/collection.rb

@@ -1,187 +0,0 @@
-module Xapit
-  # This is the object which is returned when performing a search. It behaves like an array, so you do not need
-  # to worry about fetching the results separately. Just loop through this collection.
-  # 
-  # The results are lazy loading, meaning it does not perform the query on the database until it has to.
-  # This allows you to string queries onto one another.
-  #
-  #   Article.search("kite").search("sky") # only performs one query
-  #
-  # This class is compatible with will_paginate; you can pass it to the will_paginate helper in the view.
-  class Collection
-    NON_DELEGATE_METHODS = %w(nil? send object_id class extend size paginate first last empty? respond_to?).to_set
-    [].methods.each do |m|
-      delegate m, :to => :results unless m =~ /^__/ || NON_DELEGATE_METHODS.include?(m.to_s)
-    end
-    delegate :query, :base_query, :base_query=, :extra_queries, :extra_queries=, :to => :@query_parser
-    
-    def self.search_similar(member, *args)
-      collection = new(member.class, *args)
-      indexer = SimpleIndexer.new(member.class.xapit_index_blueprint)
-      terms = indexer.text_terms(member) + indexer.field_terms(member)
-      query = collection.base_query.and_query(terms, :or).not_query("Q#{member.class}-#{member.id}")
-      collection.base_query = query
-      collection
-    end
-    
-    def initialize(*args)
-      @query_parser = Config.query_parser.new(*args)
-    end
-    
-    # Returns an array of results. You should not need to call this directly because most methods are 
-    # automatically delegated to this array.
-    def results
-      @results ||= fetch_results
-    end
-    
-    # The number of total records found despite any pagination settings.
-    def size
-      @query_parser.query.count
-    end
-    alias_method :total_entries, :size # alias to total_entries to support will_paginate
-    
-    # Returns true if no results are found.
-    def empty?
-      @results ? @results.empty? : size.zero?
-    end
-    
-    # The first record in the result set.
-    def first
-      fetch_results(:offset => 0, :limit => 1).first
-    end
-    
-    # The last record in the result set.
-    def last
-      fetch_results(:offset => size-1, :limit => 1).last
-    end
-    
-    # Perform another search on this one, inheriting all options already passed.
-    # See Xapit::Membership for search options.
-    #
-    #   Article.search("kite").search("sky") # only performs one query
-    # 
-    def search(*args)
-      options = args.extract_options!
-      collection = Collection.new(@query_parser.member_class, args[0].to_s, @query_parser.options.merge(options))
-      collection.base_query = @query_parser.query
-      collection
-    end
-    
-    # Chain another search returning all records matched by either this search or the previous search
-    # Inherits all options passed in earlier search (such as :page and :order)
-    # See Xapit::Membership for search options.
-    #
-    #   Article.search("kite").or_search(:conditions => { :priority => 1 })
-    # 
-    def or_search(*args)
-      options = args.extract_options!
-      collection = Collection.new(@query_parser.member_class, args[0].to_s, @query_parser.options.merge(options))
-      collection.base_query = @query_parser.base_query
-      collection.extra_queries = @query_parser.extra_queries
-      collection.extra_queries << @query_parser.primary_query
-      collection
-    end
-    
-    # The page number we are currently on.
-    def current_page
-      @query_parser.current_page
-    end
-    
-    # How many records to display on each page, defaults to 20. Sets with :per_page option when performing search.
-    def per_page
-      @query_parser.per_page
-    end
-    
-    # The offset for the current page
-    def offset
-      @query_parser.offset
-    end
-    
-    # Total number of pages with found results.
-    def total_pages
-      (size / per_page.to_f).ceil
-    end
-    
-    # The previous page number. Returns nil if on first page.
-    def previous_page
-      current_page > 1 ? (current_page - 1) : nil
-    end
-    
-    # The next page number. Returns nil if on last page.
-    def next_page
-      current_page < total_pages ? (current_page + 1): nil
-    end
-    
-    # Xapit::Facet objects matching this search query. See class for details.
-    def facets
-      all_facets.select do |facet|
-        facet.options.size > 0
-      end
-    end
-    
-    # Xapit::FacetOption objects which are currently applied to search (through :facets option). Use this to
-    # display the facets which are currently applied.
-    #
-    #   <% for option in @articles.applied_facet_options %>
-    #     <%=h option.name %>
-    #     <%= link_to "remove", :overwrite_params => { :facets => option } %>
-    #   <% end %>
-    #
-    # If you set :breadcrumb_facets option to true in Config#setup the link will drop leftover facets
-    # instead of removing the current one. This makes it easy to add a breadcrumb style interface.
-    #
-    #   Xapit.setup(:breadcrumb_facets => true)
-    #   <% for option in @articles.applied_facet_options %>
-    #     <%= link_to h(option.name), :overwrite_params => { :facets => option } %> &gt;
-    #   <% end %>
-    #
-    def applied_facet_options
-      @query_parser.facet_identifiers.map do |identifier|
-        option = FacetOption.find(identifier)
-        option.existing_facet_identifiers = @query_parser.facet_identifiers
-        option
-      end
-    end
-    
-    # Includes a suggested variation of a term which will get many more results. Returns nil if no suggestion.
-    # 
-    #   <% if @articles.spelling_suggestion %>
-    #     Did you mean <%= link_to h(@articles.spelling_suggestion), :overwrite_params => { :keywords => @articles.spelling_suggestion } %>?
-    #   <% end %>
-    # 
-    def spelling_suggestion
-      @query_parser.spelling_suggestion
-    end
-    
-    # All Xapit::Facet objects, even if they do not include options.
-    # Usually you'll want to call Collection#facets
-    def all_facets
-      @query_parser.member_class.xapit_index_blueprint.facets.map do |facet_blueprint|
-        Facet.new(facet_blueprint, @query_parser.query, @query_parser.facet_identifiers)
-      end
-    end
-    
-    private
-    
-    # TODO this could use some refactoring
-    # See issue #11 for why this is so complex.
-    def fetch_results(options = {})
-      matches = @query_parser.matchset(options).matches
-      records_by_class = {}
-      matches.each do |match|
-        class_name, id = match.document.data.split('-')
-        records_by_class[class_name] ||= []
-        records_by_class[class_name] << id
-      end
-      records_by_class.each do |class_name, ids|
-        records_by_class[class_name] = class_name.constantize.xapit_adapter.find_multiple(ids)
-      end
-      matches.map do |match|
-        class_name, id = match.document.data.split('-')
-        member = records_by_class[class_name].detect { |m| m.id == id.to_i }
-        member.xapit_relevance = match.percent
-        member
-      end
-    end
-  end
-end

data/lib/xapit/config.rb

@@ -1,84 +0,0 @@
-module Xapit
-  # Singleton class for storing Xapit configuration settings. Currently this only includes the database path.
-  class Config
-    class << self
-      attr_reader :options
-      
-      # See Xapit#setup
-      def setup(options = {})
-        if @options && options[:database_path] != @options[:database_path]
-          @database = nil
-          @writable_database = nil
-        end
-        @options = options.reverse_merge(default_options)
-      end
-      
-      def default_options
-        {
-          :indexer => SimpleIndexer,
-          :query_parser => ClassicQueryParser,
-          :spelling => true,
-          :stemming => "english"
-        }
-      end
-      
-      # See if setup options are already set.
-      def setup?
-        @options
-      end
-      
-      # The configured path to the database.
-      def path
-        @options[:database_path]
-      end
-      
-      def query_parser
-        @options[:query_parser]
-      end
-      
-      def indexer
-        @options[:indexer]
-      end
-      
-      def spelling?
-        @options[:spelling]
-      end
-      
-      def stemming
-        @options[:stemming]
-      end
-      
-      def breadcrumb_facets?
-        @options[:breadcrumb_facets]
-      end
-      
-      # Fetch Xapian::Database object at configured path. Database is stored in memory.
-      def database
-        @writable_database || (@database ||= Xapian::Database.new(path))
-      end
-      
-      # Fetch Xapian::WritableDatabase object at configured path. Database is stored in memory.
-      # Creates the database directory if needed.
-      def writable_database
-        FileUtils.mkdir_p(File.dirname(path)) unless File.exist?(File.dirname(path))
-        @writable_database ||= Xapian::WritableDatabase.new(path, Xapian::DB_CREATE_OR_OPEN)
-      end
-      
-      # Removes the configured database file and clears the stored one in memory.
-      def remove_database
-        FileUtils.rm_rf(path) if File.exist? File.join(path, "iamflint")
-        @database = nil
-        @writable_database = nil
-      end
-      
-      # Clear the current database from memory. Unfortunately this is a hack because
-      # Xapian doesn't provide a "close" method on the database. We just have to hope
-      # no other references are lying around.
-      def close_database
-        @database = nil
-        @writable_database = nil
-        GC.start
-      end
-    end
-  end
-end