picky 3.6.11 → 3.6.12

data/lib/picky/query/allocation.rb

@@ -8,7 +8,6 @@ module Picky
     class Allocation # :nodoc:all
 
       attr_reader :count,
-                  :ids,
                   :score,
                   :combinations,
                   :result_identifier
@@ -42,6 +41,12 @@ module Picky
         @backend.ids combinations, amount, offset
       end
 
+      # Ids return by default [].
+      #
+      def ids
+        @ids ||= []
+      end
+
       # This starts the searching process.
       #
       def process! amount, offset

data/lib/picky/query/allocations.rb

@@ -6,8 +6,6 @@ module Picky
     #
     class Allocations # :nodoc:all
 
-      attr_reader :total
-
       delegate :each,
                :empty?,
                :first,
@@ -63,6 +61,7 @@ module Picky
       # Parameters:
       #  * amount: the amount of ids to calculate
       #  * offset: the offset from where in the result set to take the ids
+      #  * terminate_early: Whether to calculate all allocations.
       #
       # Note: With an amount of 0, an offset > 0 doesn't make much
       #       sense, as seen in the live search.
@@ -72,18 +71,28 @@ module Picky
       #
       # Note: It's possible that no ids are returned by an allocation, but a count. (In case of an offset)
       #
-      def process! amount, offset = 0
-        @total = 0
+      def process! amount, offset = 0, terminate_early = nil
         current_offset = 0
-        @allocations.each do |allocation|
+        each do |allocation|
           ids = allocation.process! amount, offset
-          @total = @total + allocation.count # the total mixed in
           if ids.empty?
             offset = offset - allocation.count unless offset.zero?
           else
             amount = amount - ids.size # we need less results from the following allocation
             offset = 0                 # we have already passed the offset
           end
+          if terminate_early
+            break if terminate_early < 0 && offset <= 0
+            terminate_early -= 1
+          end
+        end
+      end
+
+      # The total is simply the sum of the counts of all allocations.
+      #
+      def total
+        @total ||= inject(0) do |total, allocation|
+          total + (allocation.count || break)
         end
       end
 

data/lib/picky/results.rb

@@ -24,9 +24,9 @@ module Picky
 
     # Create new results and calculate the ids.
     #
-    def self.from query, amount, offset, allocations
+    def self.from query, amount, offset, allocations, extra_allocations = nil
       results = new query, amount, offset, allocations
-      results.prepare!
+      results.prepare! extra_allocations
       results
     end
 
@@ -53,8 +53,8 @@ module Picky
     # Without this, the allocations are not processed,
     # and no ids are calculated.
     #
-    def prepare!
-      allocations.process! amount, offset
+    def prepare! extra_allocations = nil
+      allocations.process! amount, offset, extra_allocations
     end
 
     # Returns a hash with the allocations, offset, duration and total.

data/lib/picky/search.rb

@@ -80,6 +80,37 @@ module Picky
       amount ? @max_allocations = amount : @max_allocations
     end
 
+    # Tells Picky to terminate calculating ids if it has enough ids.
+    # (So, early)
+    #
+    # Important note: Do not use this for the live search!
+    #                 (As Picky needs to calculate the total)
+    #
+    # Note: When using the Picky interface, do not terminate too
+    #       early as this will kill off the allocation selections.
+    #       A value of
+    #         early_terminate 5
+    #       is probably a good idea to show the user 5 extra
+    #       beyond the needed ones.
+    #
+    # Examples:
+    #   # Terminate if you have enough ids.
+    #   #
+    #   search = Search.new(index1, index2, index3) do
+    #     terminate_early
+    #   end
+    #
+    #   # After calculating enough ids,
+    #   # calculate 5 extra allocations for the interface.
+    #   #
+    #   search = Search.new(index1, index2, index3) do
+    #     terminate_early 5
+    #   end
+    #
+    def terminate_early extra_allocations = 0
+      @extra_allocations = extra_allocations.respond_to?(:to_hash) ? extra_allocations[:with_extra_allocations] : extra_allocations
+    end
+
     # Examples:
     #   search = Search.new(books_index, dvd_index, mp3_index) do
     #     boost [:author, :title] => +3,
@@ -174,7 +205,7 @@ module Picky
     # Note: Internal method, use #search to search.
     #
     def execute tokens, ids, offset, original_text = nil
-      Results.from original_text, ids, offset, sorted_allocations(tokens, @max_allocations)
+      Results.from original_text, ids, offset, sorted_allocations(tokens, @max_allocations), @extra_allocations
     end
 
     # Delegates the tokenizing to the query tokenizer.

data/lib/picky/wrappers/category/exact_first.rb

@@ -25,6 +25,8 @@ module Picky
                  :dump,
                  :load,
 
+                 :empty,
+
                  :bundle_for,
                  :build_realtime_mapping,
 

data/spec/functional/max_allocations_spec.rb

@@ -38,7 +38,7 @@ describe 'Search#max_allocations' do
       category :text4
     end
 
-    thing = Struct.new(:id, :text1, :text2, :text3, :text4)
+    thing = Struct.new :id, :text1, :text2, :text3, :text4
     index.add thing.new(1, 'hello world', 'hello world', 'hello world', 'hello world')
     index.add thing.new(2, 'hello world', 'hello world', 'hello world', 'hello world')
     index.add thing.new(3, 'hello world', 'hello world', 'hello world', 'hello world')
@@ -49,7 +49,7 @@ describe 'Search#max_allocations' do
     try = Picky::Search.new index
 
     threshold = performance_of do
-      try.search('hello world')
+      try.search 'hello world'
     end
 
     try_again = Picky::Search.new index do
@@ -57,8 +57,8 @@ describe 'Search#max_allocations' do
     end
 
     performance_of do
-      try_again.search('hello world')
-    end.should < (threshold*7/9)
+      try_again.search 'hello world'
+    end.should < (threshold*2/3)
   end
 
 end

data/spec/functional/regression_spec.rb

@@ -4,6 +4,34 @@ require 'spec_helper'
 
 describe "Regression" do
 
+  it 'does not get confused' do
+    index = Picky::Index.new :dynamic_weights do
+      category :text1
+      category :text2
+      category :text3
+      category :text4
+    end
+    try = Picky::Search.new index
+
+    try.search('hello hello hello').allocations.size.should == 0
+
+    thing = Struct.new(:id, :text1, :text2, :text3, :text4)
+    index.add thing.new(1, 'hello', 'hello', 'hello', 'world')
+
+    try.search('hello hello hello').allocations.size.should == 27
+
+    index.add thing.new(2, 'hello', 'hello', 'hello', 'world')
+    index.add thing.new(3, 'hello', 'hello', 'hello', 'world')
+    index.add thing.new(4, 'hello', 'hello', 'hello', 'world')
+    index.add thing.new(5, 'hello', 'hello', 'hello', 'world')
+
+    try.search('hello hello hello').allocations.size.should == 27
+
+    index.add thing.new(6, 'world', 'world', 'world', 'hello')
+
+    try.search('hello hello world').allocations.size.should == 64
+  end
+
   # # This was described by Niko
   # # and references a case where
   # # an attribute and the id referenced

data/spec/functional/terminate_early_spec.rb

@@ -0,0 +1,80 @@
+# encoding: utf-8
+#
+require 'spec_helper'
+
+describe 'Search#terminate_early' do
+
+  it 'terminates early' do
+    index = Picky::Index.new :terminate_early do
+      category :text1
+      category :text2
+      category :text3
+      category :text4
+    end
+
+    thing = Struct.new :id, :text1, :text2, :text3, :text4
+    index.add thing.new(1, 'hello', 'hello', 'hello', 'hello')
+    index.add thing.new(2, 'hello', 'hello', 'hello', 'hello')
+    index.add thing.new(3, 'hello', 'hello', 'hello', 'hello')
+    index.add thing.new(4, 'hello', 'hello', 'hello', 'hello')
+    index.add thing.new(5, 'hello', 'hello', 'hello', 'hello')
+    index.add thing.new(6, 'hello', 'hello', 'hello', 'hello')
+
+    try = Picky::Search.new index
+    try.search('hello').ids.should == [6, 5, 4, 3, 2, 1, 6, 5, 4, 3, 2, 1, 6, 5, 4, 3, 2, 1, 6, 5]
+
+    try = Picky::Search.new index do
+      terminate_early
+    end
+    try.search('hello', 3).ids.should == [6, 5, 4]
+
+    try = Picky::Search.new index do
+      terminate_early
+    end
+    try.search('hello', 9).ids.should == [6, 5, 4, 3, 2, 1, 6, 5, 4]
+
+    try = Picky::Search.new index do
+      terminate_early with_extra_allocations: 0
+    end
+    try.search('hello', 9).ids.should == [6, 5, 4, 3, 2, 1, 6, 5, 4]
+
+    try = Picky::Search.new index do
+      terminate_early 0
+    end
+    try.search('hello').ids.should == [6, 5, 4, 3, 2, 1, 6, 5, 4, 3, 2, 1]
+
+    try = Picky::Search.new index do
+      terminate_early with_extra_allocations: 0
+    end
+    try.search('hello').ids.should == [6, 5, 4, 3, 2, 1, 6, 5, 4, 3, 2, 1]
+
+    try = Picky::Search.new index do
+      terminate_early 2
+    end
+    try.search('hello', 13).ids.should == [6, 5, 4, 3, 2, 1, 6, 5, 4, 3, 2, 1, 6]
+
+    try = Picky::Search.new index do
+      terminate_early with_extra_allocations: 2
+    end
+    try.search('hello').ids.should == [6, 5, 4, 3, 2, 1, 6, 5, 4, 3, 2, 1, 6, 5, 4, 3, 2, 1, 6, 5]
+
+    try = Picky::Search.new index do
+      terminate_early with_extra_allocations: 1234
+    end
+    try.search('hello').ids.should == [6, 5, 4, 3, 2, 1, 6, 5, 4, 3, 2, 1, 6, 5, 4, 3, 2, 1, 6, 5]
+
+    slow = performance_of do
+      try.search 'hello'
+    end
+
+    try = Picky::Search.new index do
+      terminate_early
+    end
+    fast = performance_of do
+      try.search 'hello'
+    end
+    
+    (slow/fast).should
+  end
+
+end

data/spec/lib/query/allocations_spec.rb

@@ -86,6 +86,34 @@ describe Picky::Query::Allocations do
       @allocation3 = stub :allocation3, :process! => [], :count => 2 #, ids: [8, 9]
       @allocations = described_class.new [@allocation1, @allocation2, @allocation3]
     end
+    describe 'lazy evaluation' do
+      context 'small amount' do
+        before(:each) do
+          @amount = 3
+          @offset = 1
+        end
+        it 'should call the process! method right' do
+          @allocation1.should_receive(:process!).once.with(3,1).and_return [1, 2, 3]
+          @allocation2.should_receive(:process!).once.with(0,0).and_return [] # TODO Actually ok?
+          @allocation3.should_receive(:process!).never
+
+          @allocations.process! @amount, @offset, 0
+        end
+      end
+      context 'larger amount' do
+        before(:each) do
+          @amount = 1
+          @offset = 0
+        end
+        it 'should call the process! method right' do
+          @allocation1.should_receive(:process!).once.with(1,0).and_return [1]
+          @allocation2.should_receive(:process!).once.with(0,0).and_return [] # TODO Actually ok?
+          @allocation3.should_receive(:process!).never
+
+          @allocations.process! @amount, @offset, 0
+        end
+      end
+    end
     describe 'amount spanning 3 allocations' do
       before(:each) do
         @amount = 6

data/spec/lib/query/combination_spec.rb

@@ -27,6 +27,18 @@ describe Picky::Query::Combination do
     it 'should hash the token and the bundle' do
       @combination.hash.should == [@token, @category].hash
     end
+    it 'should distinguish two combinations sufficiently' do
+      category1 = stub :category,
+                       :identifier => 'some_category_identifier1'
+
+      category2 = stub :category,
+                       :identifier => 'some_category_identifier2'
+
+      combination1 = described_class.new @token, category1
+      combination2 = described_class.new @token, category2
+
+      combination1.hash.should_not == combination2.hash
+    end
   end
 
   describe 'to_result' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: picky
 version: !ruby/object:Gem::Version
-  version: 3.6.11
+  version: 3.6.12
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-30 00:00:00.000000000 Z
+date: 2011-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70356380283200 !ruby/object:Gem::Requirement
+  requirement: &70344058312240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,21 +21,21 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70356380283200
+  version_requirements: *70344058312240
 - !ruby/object:Gem::Dependency
   name: picky-client
-  requirement: &70356380282520 !ruby/object:Gem::Requirement
+  requirement: &70344058311560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.6.11
+        version: 3.6.12
   type: :development
   prerelease: false
-  version_requirements: *70356380282520
+  version_requirements: *70344058311560
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &70356380282100 !ruby/object:Gem::Requirement
+  requirement: &70344058310640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70356380282100
+  version_requirements: *70344058310640
 - !ruby/object:Gem::Dependency
   name: rack_fast_escape
-  requirement: &70356380281640 !ruby/object:Gem::Requirement
+  requirement: &70344058309960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70356380281640
+  version_requirements: *70344058309960
 - !ruby/object:Gem::Dependency
   name: text
-  requirement: &70356380281200 !ruby/object:Gem::Requirement
+  requirement: &70344058309020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70356380281200
+  version_requirements: *70344058309020
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: &70356380280720 !ruby/object:Gem::Requirement
+  requirement: &70344058308480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70356380280720
+  version_requirements: *70344058308480
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70356380280220 !ruby/object:Gem::Requirement
+  requirement: &70344058307980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70356380280220
+  version_requirements: *70344058307980
 - !ruby/object:Gem::Dependency
   name: unicorn
-  requirement: &70356380279800 !ruby/object:Gem::Requirement
+  requirement: &70344058323920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70356380279800
+  version_requirements: *70344058323920
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &70356380279340 !ruby/object:Gem::Requirement
+  requirement: &70344058323380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,7 +109,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70356380279340
+  version_requirements: *70344058323380
 description: Fast Ruby semantic text search engine with comfortable single field interface.
 email: florian.hanke+picky@gmail.com
 executables:
@@ -276,6 +276,7 @@ files:
 - spec/functional/realtime_spec.rb
 - spec/functional/regression_spec.rb
 - spec/functional/speed_spec.rb
+- spec/functional/terminate_early_spec.rb
 - spec/lib/adapters/rack/base_spec.rb
 - spec/lib/adapters/rack/live_parameters_spec.rb
 - spec/lib/adapters/rack/query_spec.rb
@@ -419,6 +420,7 @@ test_files:
 - spec/functional/realtime_spec.rb
 - spec/functional/regression_spec.rb
 - spec/functional/speed_spec.rb
+- spec/functional/terminate_early_spec.rb
 - spec/lib/adapters/rack/base_spec.rb
 - spec/lib/adapters/rack/live_parameters_spec.rb
 - spec/lib/adapters/rack/query_spec.rb