picky 1.5.4 → 2.0.0.pre1

data/lib/picky/query/base.rb

@@ -1,190 +0,0 @@
-# = Picky Queries
-#
-# A Picky Query is an object which:
-# * holds one or more indexes
-# * offers an interface to query these indexes.
-#
-# You connect URL paths to indexes via a Query.
-#
-# We recommend not to use this directly, but connect it to an URL and query through one of these
-# (Protip: Use "curl 'localhost:8080/query/path?query=exampletext')" in a Terminal.
-#
-# There are two flavors of queries:
-# * Query::Full (Full results with all infos)
-# * Query::Live (Same as the Full results without result ids. Useful for query result counters.)
-#
-module Query
-
-  # The base query class.
-  #
-  # Not directly instantiated. However, its methods are used by its subclasses, Full and Live.
-  #
-  class Base
-
-    include Helpers::Measuring
-
-    attr_reader   :indexes
-    attr_writer   :tokenizer, :identifiers_to_remove
-    attr_accessor :reduce_to_amount, :weights
-
-    # Takes:
-    # * A number of indexes
-    # * Options hash (optional) with:
-    #   * tokenizer: Tokenizers::Query.default by default.
-    #   * weights:   A hash of weights, or a Query::Weights object.
-    #
-    def initialize *index_definitions
-      options      = Hash === index_definitions.last ? index_definitions.pop : {}
-
-      @indexes     = Internals::Query::Indexes.new *index_definitions, combinations_type_for(index_definitions)
-      @tokenizer   = options[:tokenizer] || Internals::Tokenizers::Query.default
-      weights      = options[:weights] || Weights.new
-      @weights     = Hash === weights ? Weights.new(weights) : weights
-    end
-
-    # Returns the right combinations strategy for
-    # a number of query indexes.
-    #
-    # Currently it isn't possible using Memory and Redis etc.
-    # indexes in the same query index group.
-    #
-    # Picky will raise a Query::Indexes::DifferentTypesError.
-    #
-    @@mapping = {
-      Index::Memory => Internals::Query::Combinations::Memory,
-      Index::Redis  => Internals::Query::Combinations::Redis
-    }
-    def combinations_type_for index_definitions_ary
-      index_types = index_definitions_ary.map(&:class)
-      index_types.uniq!
-      raise_different(index_types) if index_types.size > 1
-      !index_types.empty? && @@mapping[*index_types] || Internals::Query::Combinations::Memory
-    end
-    # Currently it isn't possible using Memory and Redis etc.
-    # indexes in the same query index group.
-    #
-    class DifferentTypesError < StandardError
-      def initialize types
-        @types = types
-      end
-      def to_s
-        "Currently it isn't possible to mix #{@types.join(" and ")} Indexes in the same Query."
-      end
-    end
-    def raise_different index_types
-      raise DifferentTypesError.new(index_types)
-    end
-
-    # This is the main entry point for a query.
-    # Use this in specs and also for running queries.
-    #
-    # Parameters:
-    # * text: The search text.
-    # * offset = 0: _optional_ The offset from which position to return the ids. Useful for pagination.
-    #
-    # Note: The Rack adapter calls this method after unravelling the HTTP request.
-    #
-    def search_with_text text, offset = 0
-      search tokenized(text), offset
-    end
-
-    # Runs the actual search using Query::Tokens.
-    #
-    # Note: Internal method, use #search_with_text.
-    #
-    def search tokens, offset = 0
-      results = nil
-
-      duration = timed do
-        results = execute tokens, offset
-      end
-      results.duration = duration.round 6
-
-      results
-    end
-
-    # Execute a search using Query::Tokens.
-    #
-    # Note: Internal method, use #search_with_text.
-    #
-    def execute tokens, offset
-      result_type.from offset, sorted_allocations(tokens)
-    end
-
-    # Delegates the tokenizing to the query tokenizer.
-    #
-    # Parameters:
-    # * text: The text to tokenize.
-    #
-    def tokenized text
-      @tokenizer.tokenize text
-    end
-
-    # Gets sorted allocations for the tokens.
-    #
-    # This generates the possible allocations, sorted.
-    #
-    # TODO Smallify.
-    #
-    # TODO Rename: allocations
-    #
-    def sorted_allocations tokens # :nodoc:
-      # Get the allocations.
-      #
-      # TODO Pass in reduce_to_amount (aka max_allocations)
-      #
-      # TODO uniq, score, sort in there
-      #
-      allocations = @indexes.allocations_for tokens
-
-      # Callbacks.
-      #
-      # TODO Reduce before sort?
-      #
-      reduce allocations
-      remove_from allocations
-
-      # Remove double allocations.
-      #
-      allocations.uniq
-
-      # Score the allocations using weights as bias.
-      #
-      allocations.calculate_score weights
-
-      # Sort the allocations.
-      # (allocations are sorted according to score, highest to lowest)
-      #
-      allocations.sort
-
-      # Return the allocations.
-      #
-      allocations
-    end
-    def reduce allocations # :nodoc:
-      allocations.reduce_to reduce_to_amount if reduce_to_amount
-    end
-
-    #
-    #
-    def remove_from allocations # :nodoc:
-      allocations.remove identifiers_to_remove
-    end
-    #
-    #
-    def identifiers_to_remove # :nodoc:
-      @identifiers_to_remove ||= []
-    end
-
-    # Display some nice information for the user.
-    #
-    def to_s
-      s = "#{self.class}("
-      s << @indexes.indexes.map(&:name).join(', ')
-      s << ", weights: #{@weights}" unless @weights.empty?
-      s << ")"
-      s
-    end
-
-  end
-end

data/lib/picky/query/full.rb

@@ -1,20 +0,0 @@
-module Query
-
-  # This Query class performs full queries.
-  #
-  # It includes in its results:
-  # * A count of results.
-  # * All possible combinations with its weights.
-  # * The top X result ids.
-  #
-  class Full < Base
-
-    # Returns Results::Full as its result type.
-    #
-    def result_type
-      Internals::Results::Full
-    end
-
-  end
-
-end

data/lib/picky/query/live.rb

@@ -1,24 +0,0 @@
-module Query
-
-  # This Query class performs live queries.
-  #
-  # It is useful for updating counters, or any job where you don't need the result ids.
-  #
-  # It includes in its results:
-  # * A count of results.
-  # * All possible combinations with its weights.
-  #
-  # But not:
-  # * The top X result ids.
-  #
-  class Live < Base
-
-    # Returns Results::Live as its result type.
-    #
-    def result_type
-      Internals::Results::Live
-    end
-
-  end
-
-end

data/spec/lib/internals/results/full_spec.rb

@@ -1,78 +0,0 @@
-require 'spec_helper'
-
-describe Internals::Results::Full do
-  
-  describe "class accessors" do
-    it "should have accessors for max_results" do
-      max_results = stub :max_results
-      old_results = described_class.max_results
-      described_class.max_results = max_results
-
-      described_class.max_results.should == max_results
-
-      described_class.max_results = old_results
-    end
-  end
-  
-  describe 'initialize' do
-    context 'without allocations' do
-      it 'should not fail' do
-        lambda {
-          described_class.new
-        }.should_not raise_error
-      end
-      it 'should set the allocations to allocations that are empty' do
-        described_class.new.instance_variable_get(:@allocations).should be_empty
-      end
-    end
-    context 'with allocations' do
-      it 'should not fail' do
-        lambda {
-          described_class.new :some_allocations
-        }.should_not raise_error
-      end
-      it 'should set the allocations to an empty array' do
-        described_class.new(:unimportant, :some_allocations).instance_variable_get(:@allocations).should == :some_allocations
-      end
-    end
-  end
-  
-  describe 'duration' do
-    before(:each) do
-      @results = described_class.new
-    end
-    it 'should return the set duration' do
-      @results.duration = :some_duration
-
-      @results.duration.should == :some_duration
-    end
-    it 'should return 0 as a default' do
-      @results.duration.should == 0
-    end
-  end
-  
-  describe 'total' do
-    it 'should delegate to allocations.total' do
-      allocations = stub :allocations
-      results = described_class.new nil, allocations
-
-      allocations.should_receive(:total).once
-
-      results.total
-    end
-  end
-  
-  describe 'prepare!' do
-    before(:each) do
-      @results = described_class.new
-      @allocations = stub :allocations
-      @results.stub! :allocations => @allocations
-    end
-    it 'should process' do
-      @allocations.should_receive(:process!).once.with(20, 0).ordered
-      
-      @results.prepare!
-    end
-  end
-  
-end

data/spec/lib/internals/results/live_spec.rb

@@ -1,88 +0,0 @@
-require 'spec_helper'
-
-describe Internals::Results::Live do
-  
-  it "is the right subclass" do
-    described_class.should < Internals::Results::Base
-  end
-  
-  it "logs correctly" do
-    Time.stub! :now => Time.parse('2010-10-25 01:25:07')
-    
-    described_class.new.to_log('some query').should == '.|2010-10-25 01:25:07|0.000000|some query                                        |       0|   0| 0|'
-  end
-  
-  describe "class accessors" do
-    it "should have accessors for max_results" do
-      max_results = stub :max_results
-      old_results = described_class.max_results
-      described_class.max_results = max_results
-
-      described_class.max_results.should == max_results
-
-      described_class.max_results = old_results
-    end
-  end
-  
-  describe 'initialize' do
-    context 'without allocations' do
-      it 'should not fail' do
-        lambda {
-          described_class.new
-        }.should_not raise_error
-      end
-      it 'should set the allocations to allocations that are empty' do
-        described_class.new.instance_variable_get(:@allocations).should be_empty
-      end
-    end
-    context 'with allocations' do
-      it 'should not fail' do
-        lambda {
-          described_class.new :some_allocations
-        }.should_not raise_error
-      end
-      it 'should set the allocations to an empty array' do
-        described_class.new(:unimportant, :some_allocations).instance_variable_get(:@allocations).should == :some_allocations
-      end
-    end
-  end
-  
-  describe 'duration' do
-    before(:each) do
-      @results = described_class.new
-    end
-    it 'should return the set duration' do
-      @results.duration = :some_duration
-
-      @results.duration.should == :some_duration
-    end
-    it 'should return 0 as a default' do
-      @results.duration.should == 0
-    end
-  end
-  
-  describe 'total' do
-    it 'should delegate to allocations.total' do
-      allocations = stub :allocations
-      results = described_class.new nil, allocations
-
-      allocations.should_receive(:total).once
-
-      results.total
-    end
-  end
-  
-  describe 'prepare!' do
-    before(:each) do
-      @results = described_class.new
-      @allocations = stub :allocations
-      @results.stub! :allocations => @allocations
-    end
-    it 'should generate truncate the ids fully' do
-      @allocations.should_receive(:process!).once.with(0, 0).ordered
-
-      @results.prepare!
-    end
-  end
-  
-end

data/spec/lib/query/full_spec.rb

@@ -1,19 +0,0 @@
-require 'spec_helper'
-
-describe Query::Full do
-
-  before(:each) do
-    @type  = stub :type
-    @index = stub :index, :indexed => @type
-  end
-
-  describe 'result_type' do
-    before(:each) do
-      @query = described_class.new @index
-    end
-    it "should return a specific type" do
-      @query.result_type.should == Internals::Results::Full
-    end
-  end
-
-end

data/spec/lib/query/live_spec.rb

@@ -1,31 +0,0 @@
-require 'spec_helper'
-
-describe Query::Live do
-
-  before(:each) do
-    @indexed  = stub :indexed
-    @index = stub :index, :indexed => @indexed
-  end
-
-  describe 'result_type' do
-    before(:each) do
-      @query = described_class.new @index
-    end
-    it "should return a specific type" do
-      @query.result_type.should == Internals::Results::Live
-    end
-  end
-
-  describe "execute" do
-    before(:each) do
-      @query = described_class.new @index
-    end
-    it "should get allocations" do
-      @query.result_type.should_receive :from
-      @query.should_receive(:sorted_allocations).once
-
-      @query.execute 'some_query', 0
-    end
-  end
-
-end