picky 4.12.4 → 4.12.5

data/lib/picky/loader.rb

@@ -173,7 +173,7 @@ module Picky
         load_relative 'query/boosts'
 
         load_relative 'query/indexes',
-                      'query/indexes_check'
+                      'query/indexes/check'
       end
       
       # Loads the internal parts of the framework.

data/lib/picky/query/allocation.rb

@@ -37,10 +37,10 @@ module Picky
       # ignored (ie. removed).
       #
       def calculate_score weights
-        @score ||= if @combinations.empty?                                                                                                     
+        @score ||= if @combinations.empty?
           0 # Optimization.
-        else                                                                                                                                   
-          @backend.weight(@combinations) + @combinations.boost_for(weights)                                                                                                   
+        else
+          @backend.weight(@combinations) + @combinations.boost_for(weights)
         end 
       end
 
@@ -113,6 +113,12 @@ module Picky
       def to_json options = {}
         MultiJson.encode to_result, options
       end
+      
+      #
+      #
+      def to_qualifiers
+        @combinations.to_qualifiers
+      end
 
       #
       #

data/lib/picky/query/allocations.rb

@@ -46,13 +46,46 @@ module Picky
         @allocations = @allocations.shift amount
       end
 
-      # Removes combinations.
+      # Removes categories from allocations.
       #
       # Only those passed in are removed.
       #
-      def remove categories = []
+      def remove_categories categories = []
         @allocations.each { |allocation| allocation.remove categories } unless categories.empty?
       end
+      
+      # Removes allocations.
+      #
+      # Only those passed in are removed.
+      #
+      # TODO Rewrite, speed up.
+      #
+      def remove_allocations qualifiers_array = []
+        return if qualifiers_array.empty?
+        @allocations.select! do |allocation|
+          allocation_qualifiers = allocation.combinations.to_qualifiers
+          next(false) if qualifiers_array.any? do |qualifiers|
+            allocation_qualifiers == qualifiers
+          end
+          allocation
+        end
+      end
+      
+      # Keeps allocations.
+      #
+      # Only those passed in are kept.
+      #
+      # TODO Rewrite, speed up.
+      #
+      def keep_allocations qualifiers_array = []
+        return if qualifiers_array.empty?
+        @allocations.select! do |allocation|
+          allocation_qualifiers = allocation.combinations.to_qualifiers
+          next(true) if qualifiers_array.any? do |qualifiers|
+            allocation_qualifiers == qualifiers
+          end
+        end
+      end
 
       # Returns the top amount ids.
       #

data/lib/picky/query/combinations.rb

@@ -49,6 +49,10 @@ module Picky
       def to_result
         @combinations.map &:to_result
       end
+      
+      def to_qualifiers
+        @combinations.map &:category_name
+      end
 
       #
       #

data/lib/picky/query/indexes/check.rb

@@ -0,0 +1,51 @@
+module Picky
+
+  module Query
+
+    class Indexes
+      
+      #
+      #
+      class Check
+
+        class << self
+
+          # 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::DifferentBackendsError.
+          #
+          def check_backends indexes
+            backends = indexes.map &:backend
+            backends.uniq! &:class
+            raise_different backends if backends.size > 1
+            backends
+          end
+          def raise_different backends
+            raise DifferentBackendsError.new(backends)
+          end
+
+        end
+        
+      end
+      
+      # Currently it isn't possible using Memory and Redis etc.
+      # indexes in the same query index group.
+      #
+      class DifferentBackendsError < StandardError
+        def initialize backends
+          @backends = backends
+        end
+        def to_s
+          "Currently it isn't possible to mix Indexes with backends #{@backends.join(" and ")} in the same Search instance."
+        end
+      end
+      
+    end
+
+  end
+
+end

data/lib/picky/query/indexes.rb

@@ -16,7 +16,9 @@ module Picky
       forward :size, :first, :to => :@indexes
       
       attr_reader :indexes,
-                  :ignored_categories
+                  :ignored_categories,
+                  :ignored_allocations,
+                  :exclusive_allocations
 
       # Creates a new Query::Indexes.
       #
@@ -24,27 +26,39 @@ module Picky
       # Note: We cannot mix memory and redis indexes just yet.
       #
       def initialize *indexes
-        IndexesCheck.check_backends indexes
+        Check.check_backends indexes
 
         @indexes = indexes
       end
       
-      # TODO Reinstate.
-      #
-      # # Ignore the categories with these qualifiers.
-      # #
-      # # Example:
-      # #   search = Search.new(index1, index2, index3) do
-      # #     ignore :name, :first_name
-      # #   end
-      # #
-      # # Note: Cleans up / optimizes after being called.
-      # #
-      # def ignore *qualifiers
-      #   @ignored_categories ||= []
-      #   @ignored_categories += qualifiers.map { |qualifier| @qualifier_mapper.map qualifier }.compact
-      #   @ignored_categories.uniq!
-      # end
+      # Ignore the categories with the given qualifiers.
+      #
+      def ignore_categories *qualifiers
+        @ignored_categories ||= []
+        # @ignored_categories += qualifiers.map { |qualifier| @qualifier_mapper.map qualifier }.compact
+        @ignored_categories += qualifiers
+        @ignored_categories.uniq!
+      end
+      
+      # Ignore the allocations with the given qualifiers.
+      #
+      def ignore_allocations *qualifier_arrays
+        @ignored_allocations ||= []
+        @ignored_allocations += qualifier_arrays #.map do |qualifier_array|
+          # qualifier_array.map { |qualifier| @qualifier_mapper.map qualifier }
+        # end.compact
+        @ignored_allocations.uniq!
+      end
+      
+      # Exclusively keep the allocations with the given qualifiers.
+      #
+      def keep_allocations *qualifier_arrays
+        @exclusive_allocations ||= []
+        @exclusive_allocations += qualifier_arrays #.map do |qualifier_array|
+          # qualifier_array.map { |qualifier| @qualifier_mapper.map qualifier }
+        # end.compact
+        @exclusive_allocations.uniq!
+      end
 
       # Returns a number of prepared (sorted, reduced etc.) allocations for the given tokens.
       #
@@ -57,13 +71,20 @@ module Picky
         #
         allocations.calculate_score weights
 
+        # Filter the allocations – ignore/only.
+        #
+        allocations.keep_allocations exclusive_allocations if exclusive_allocations
+        allocations.remove_allocations ignored_allocations if ignored_allocations
+
         # Sort the allocations.
         # (allocations are sorted according to score, highest to lowest)
         #
         # Before we can chop off unimportant allocations, we need to sort them.
         #
         allocations.sort!
-
+        
+        # allocations.remove_allocations ignored_allocations if ignored_allocations
+        
         # Reduce the amount of allocations.
         #
         # Before we remove categories, we should reduce the amount of allocations.
@@ -72,7 +93,7 @@ module Picky
 
         # Remove categories from allocations.
         #
-        allocations.remove ignored_categories if ignored_categories
+        allocations.remove_categories ignored_categories if ignored_categories
 
         allocations
       end

data/lib/picky/search.rb

@@ -23,9 +23,7 @@ module Picky
     attr_accessor :tokenizer,
                   :boosts
 
-    forward :ignore,
-            :only,
-            :remap_qualifiers,
+    forward :remap_qualifiers,
             :to => :indexes
 
     # Takes:
@@ -140,7 +138,40 @@ module Picky
     def boost boosts
       @boosts = extract_boosts boosts
     end
-
+    
+    # Ignore given categories and/or combinations of
+    # categories.
+    #
+    # Example:
+    #   search = Search.new(people) do
+    #     ignore :name,
+    #            :first_name
+    #            [:last_name, :street]
+    #   end
+    #
+    def ignore *allocations_and_categories
+      allocations_and_categories.each do |allocation_or_category|
+        if allocation_or_category.respond_to? :to_sym
+          indexes.ignore_categories allocation_or_category
+        else
+          indexes.ignore_allocations allocation_or_category
+        end
+      end
+    end
+    
+    # Exclusively keep combinations of
+    # categories.
+    #
+    # Example:
+    #   search = Search.new(people) do
+    #     only [:last_name, :street],
+    #          [:last_name, :first_name]
+    #   end
+    #
+    def only *allocations_and_categories
+      indexes.keep_allocations *allocations_and_categories
+    end
+    
     # Ignore the given token if it cannot be matched to a category.
     # The default behaviour is that if a token does not match to
     # any category, the query will not return anything (since a

data/spec/functional/ignore_spec.rb

@@ -0,0 +1,70 @@
+# encoding: utf-8
+#
+require 'spec_helper'
+
+# Shows that lists of categories can be ignored.
+#
+describe 'ignoring allocations/categories' do
+
+  it 'ignores allocations correctly' do
+    index = Picky::Index.new :books do
+      category :author
+      category :title
+      category :text
+    end
+
+    thing = Struct.new :id, :author, :title, :text
+    index.add thing.new(1, 'peter', 'some title', 'some text')
+    index.add thing.new(2, 'some name', 'some title', 'some text')
+    
+    try = Picky::Search.new index do
+      ignore [:author, :text],
+             [:text, :text]
+    end
+    
+    # These allocations are now removed.
+    #
+    try.search('some some').allocations.to_result.should == [
+      # [:books, 1.386, 2, [[:text, "some", "some"],   [:text, "some", "some"]],   [2, 1]],
+      [:books, 1.386, 2, [[:text, "some", "some"],   [:title, "some", "some"]],  [2, 1]],
+      [:books, 1.386, 2, [[:title, "some", "some"],  [:text, "some", "some"]],   [2, 1]],
+      [:books, 1.386, 2, [[:title, "some", "some"],  [:title, "some", "some"]],  [2, 1]],
+      [:books, 0.693, 1, [[:title, "some", "some"],  [:author, "some", "some"]], [2]],
+      # [:books, 0.693, 1, [[:author, "some", "some"], [:text, "some", "some"]],   [2]],
+      [:books, 0.693, 1, [[:author, "some", "some"], [:title, "some", "some"]],  [2]],
+      [:books, 0.693, 1, [[:text, "some", "some"],   [:author, "some", "some"]], [2]],
+      [:books, 0.0,   1, [[:author, "some", "some"], [:author, "some", "some"]], [2]]
+    ]
+  end
+  
+  it 'keeps allocations correctly' do
+    index = Picky::Index.new :books do
+      category :author
+      category :title
+      category :text
+    end
+
+    thing = Struct.new :id, :author, :title, :text
+    index.add thing.new(1, 'peter', 'some title', 'some text')
+    index.add thing.new(2, 'some name', 'some title', 'some text')
+    
+    try = Picky::Search.new index do
+      only [:author, :text],
+           [:text, :text]
+    end
+    
+    # These allocations are now exclusively kept.
+    #
+    try.search('some some').allocations.to_result.should == [
+      [:books, 1.386, 2, [[:text, "some", "some"],   [:text, "some", "some"]],   [2, 1]],
+      # [:books, 1.386, 2, [[:text, "some", "some"],   [:title, "some", "some"]],  [2, 1]],
+      # [:books, 1.386, 2, [[:title, "some", "some"],  [:text, "some", "some"]],   [2, 1]],
+      # [:books, 1.386, 2, [[:title, "some", "some"],  [:title, "some", "some"]],  [2, 1]],
+      # [:books, 0.693, 1, [[:title, "some", "some"],  [:author, "some", "some"]], [2]],
+      [:books, 0.693, 1, [[:author, "some", "some"], [:text, "some", "some"]],   [2]],
+      # [:books, 0.693, 1, [[:author, "some", "some"], [:title, "some", "some"]],  [2]],
+      # [:books, 0.693, 1, [[:text, "some", "some"],   [:author, "some", "some"]], [2]],
+      # [:books, 0.0,   1, [[:author, "some", "some"], [:author, "some", "some"]], [2]]
+    ]
+  end
+end

data/spec/functional/only_allocations_spec.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+#
+require 'spec_helper'
+
+# Shows that lists of categories can be ignored.
+#
+describe 'ignoring allocations' do
+
+  it 'works' do
+    index = Picky::Index.new :books do
+      category :author
+      category :title
+      category :text
+    end
+
+    thing = Struct.new :id, :author, :title, :text
+    index.add thing.new(1, 'peter', 'some title', 'some text')
+    index.add thing.new(2, 'some name', 'some title', 'some text')
+    
+    try = Picky::Search.new index do
+      ignore [:author, :text],
+             [:text, :text]
+    end
+    
+    # These allocations are now removed.
+    #
+    try.search('some some').allocations.to_result.should == [
+      # [:books, 1.386, 2, [[:text, "some", "some"],   [:text, "some", "some"]],   [2, 1]],
+      [:books, 1.386, 2, [[:text, "some", "some"],   [:title, "some", "some"]],  [2, 1]],
+      [:books, 1.386, 2, [[:title, "some", "some"],  [:text, "some", "some"]],   [2, 1]],
+      [:books, 1.386, 2, [[:title, "some", "some"],  [:title, "some", "some"]],  [2, 1]],
+      [:books, 0.693, 1, [[:title, "some", "some"],  [:author, "some", "some"]], [2]],
+      # [:books, 0.693, 1, [[:author, "some", "some"], [:text, "some", "some"]],   [2]],
+      [:books, 0.693, 1, [[:author, "some", "some"], [:title, "some", "some"]],  [2]],
+      [:books, 0.693, 1, [[:text, "some", "some"],   [:author, "some", "some"]], [2]],
+      [:books, 0.0,   1, [[:author, "some", "some"], [:author, "some", "some"]], [2]]
+    ]
+  end
+end

data/spec/lib/query/allocations_spec.rb

@@ -28,7 +28,7 @@ describe Picky::Query::Allocations do
         @allocation1.should_receive(:remove).never
         @allocation2.should_receive(:remove).never
 
-        @allocations.remove
+        @allocations.remove_categories
       end
     end
     context 'categories not empty' do
@@ -37,7 +37,7 @@ describe Picky::Query::Allocations do
         @allocation2.should_receive(:remove).once.with :some_category
         @allocation3.should_receive(:remove).once.with :some_category
 
-        @allocations.remove :some_category
+        @allocations.remove_categories :some_category
       end
     end
   end

data/spec/lib/query/indexes_check_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Picky::Query::IndexesCheck do
+describe Picky::Query::Indexes::Check do
 
   describe 'check_backend_types' do
     backends = [
@@ -25,7 +25,7 @@ describe Picky::Query::IndexesCheck do
       it 'raises on multiple types' do
         expect do
           described_class.check_backends [index1, index2]
-        end.to raise_error(Picky::Query::DifferentBackendsError)
+        end.to raise_error(Picky::Query::Indexes::DifferentBackendsError)
       end
       it 'raises with the right message on multiple types' do
         expect do
@@ -41,7 +41,7 @@ describe Picky::Query::IndexesCheck do
       it 'raises on multiple types' do
         expect do
           described_class.check_backends [index1, index2, index3]
-        end.to raise_error(Picky::Query::DifferentBackendsError)
+        end.to raise_error(Picky::Query::Indexes::DifferentBackendsError)
       end
       it 'raises with the right message on multiple types' do
         expect do

data/spec/lib/query/indexes_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe Picky::Query::Indexes do
 
   before(:each) do
-    Picky::Query::IndexesCheck.stub! :check_backends
+    Picky::Query::Indexes::Check.stub! :check_backends
   end
 
   3.times do |i|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: picky
 version: !ruby/object:Gem::Version
-  version: 4.12.4
+  version: 4.12.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-06 00:00:00.000000000 Z
+date: 2012-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 4.12.4
+        version: 4.12.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +42,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 4.12.4
+        version: 4.12.5
 - !ruby/object:Gem::Dependency
   name: text
   requirement: !ruby/object:Gem::Requirement
@@ -231,8 +231,8 @@ files:
 - lib/picky/query/boosts.rb
 - lib/picky/query/combination.rb
 - lib/picky/query/combinations.rb
+- lib/picky/query/indexes/check.rb
 - lib/picky/query/indexes.rb
-- lib/picky/query/indexes_check.rb
 - lib/picky/query/token.rb
 - lib/picky/query/tokens.rb
 - lib/picky/rack/harakiri.rb
@@ -280,9 +280,11 @@ files:
 - spec/functional/dynamic_weights_spec.rb
 - spec/functional/exact_first_spec.rb
 - spec/functional/facets_spec.rb
+- spec/functional/ignore_spec.rb
 - spec/functional/max_allocations_spec.rb
 - spec/functional/multi_index_qualifier_spec.rb
 - spec/functional/non_specific_ids_larger_than_20_spec.rb
+- spec/functional/only_allocations_spec.rb
 - spec/functional/only_spec.rb
 - spec/functional/pool_spec.rb
 - spec/functional/range_queries_spec.rb
@@ -446,9 +448,11 @@ test_files:
 - spec/functional/dynamic_weights_spec.rb
 - spec/functional/exact_first_spec.rb
 - spec/functional/facets_spec.rb
+- spec/functional/ignore_spec.rb
 - spec/functional/max_allocations_spec.rb
 - spec/functional/multi_index_qualifier_spec.rb
 - spec/functional/non_specific_ids_larger_than_20_spec.rb
+- spec/functional/only_allocations_spec.rb
 - spec/functional/only_spec.rb
 - spec/functional/pool_spec.rb
 - spec/functional/range_queries_spec.rb

data/lib/picky/query/indexes_check.rb

@@ -1,45 +0,0 @@
-module Picky
-
-  module Query
-
-    class IndexesCheck
-
-      class << self
-
-        # 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::DifferentBackendsError.
-        #
-        def check_backends indexes
-          backends = indexes.map &:backend
-          backends.uniq! &:class
-          raise_different backends if backends.size > 1
-          backends
-        end
-        def raise_different backends
-          raise DifferentBackendsError.new(backends)
-        end
-
-      end
-
-    end
-
-    # Currently it isn't possible using Memory and Redis etc.
-    # indexes in the same query index group.
-    #
-    class DifferentBackendsError < StandardError
-      def initialize backends
-        @backends = backends
-      end
-      def to_s
-        "Currently it isn't possible to mix Indexes with backends #{@backends.join(" and ")} in the same Search instance."
-      end
-    end
-
-  end
-
-end