picky 4.16.0 → 4.17.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NjVkMTA4OTYyYzkyZTMzZjAxYjM3YWRlMGQwMGE2MDc4Zjc3NDA4Nw==
+    NWY4NDk4ZTVlNThhMDQwZDk5OGJmZTk4MmQ0OGJjNDBmNDQzNDIzMA==
   data.tar.gz: !binary |-
-    NDBiYmEzNWJlNDE3OTNkMmVhODU3NWYyY2QyZTQ4ZTdiN2RmZTA5Mg==
+    NDFhZmZkYmYzYWZiMWZiNjY4OTViNWU4NzZmNDAxZjcxMDY3Y2MwMQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    YmQ3MzczYTdmZjFlOTMwYmQ3ZjY3ZTkwMzBiMjU2MTUzMGQyZmM1ZjNkODg2
-    NGFjMTc0NzQ3MDRiZGQ3ZjY1ZGY3MzNlYjMyY2FkNTJmZWNlMzg2YWE0NWEx
-    Njk5NWQzYmI2OWVmMWM0NTMyZTliZGUwMTE2NDdmZWI4NzVlMGQ=
+    ZGFhMjViOGEzNDE1Y2FlYzRmNWE1ZTBjYTk5ZmI4NDY4Njg5MTE1MjFhZWRl
+    MGUyODdkMTljZTIzNjg1MThmMGJkOTMwZWJiYWJiZWQzMGJlNjc3ZDNmMTM5
+    ZDNmOWQ4ZjQyYWQ1ZDA1MjQ1NzEwMDJlYzcyYWM3YjkzOTIxYTc=
   data.tar.gz: !binary |-
-    NGRmYmE3OTMxOTE0NmY3OTY2NThhMTdhNDI1YzQ5OTQ3ZDhlZjhmNjEzMmEw
-    NjcyNGIyYTVjYjdkNzU3NTFhNTZkN2M1YzdiMDBiOWNlMmQ5YTBmZDFiMjRk
-    MTFkZGIwOThmNmEzOTRjODRlMDVlMzYyMTEyYjI5ZTcwOTkwYTA=
+    N2Y1MWRkNmZiNWZiNzYzYjU2YWM5ZjI5ZWQzYTIwOGQ2MGM1ZTg2ZjU4ZWQ5
+    OWQ0N2IyMzM4YjRmNTk2ZjY3NTJmMzM0ZTQzOGUwMjRiODI5NmFlMjIzMzUx
+    M2I3MDZjODUxYWQyODBjNTU2YTNhYTdjNTE3YmVlZGU3MWI1MjQ=

data/lib/picky/bundle.rb

@@ -54,7 +54,6 @@ module Picky
       @partial_strategy    = partial_strategy
       @similarity_strategy = similarity_strategy
 
-      @key_format = options.delete :key_format
       @backend    = options.delete :backend
 
       reset_backend
@@ -146,10 +145,10 @@ module Picky
 
     # If a key format is set, use it, else forward to the category.
     #
-    # TODO What about setting the key_format per category?
+    # TODO Removed optimisation: @key_format ||= @category.key_format
     #
     def key_format
-      @key_format || @category.key_format
+      @category.key_format
     end
 
     # Path and partial filename of a specific subindex.

data/lib/picky/categories_indexed.rb

@@ -2,17 +2,9 @@ module Picky
 
   class Categories
 
-    each_forward :load, :analyze, :to => :categories
-
-    # Return all possible combinations for the given token.
-    #
-    # This checks if it needs to also search through similar
-    # tokens, if for example, the token is one with ~.
-    # If yes, it puts together all solutions.
-    #
-    def possible_combinations token
-      token.similar? ? similar_possible_for(token) : possible_for(token)
-    end
+    each_forward :load,
+                 :analyze,
+                 :to => :categories
 
     # Gets all similar tokens and puts together the possible combinations
     # for each found similar token.
@@ -46,7 +38,7 @@ module Picky
     #
     def possible_for token, preselected_categories = nil
       (preselected_categories || possible_categories(token)).inject([]) do |combinations, category|
-        combination = category.combination_for token
+        combination = token.combination_for category
         combination ? combinations << combination : combinations
       end
     end

data/lib/picky/category.rb

@@ -85,7 +85,7 @@ module Picky
       warn <<-WARNING if options && (options.keys - @@known_keys).size > 0
 
 Warning: Category options #{options} for category #{name} contain an unknown option.
-         Working options are: #{@@known_keys}.
+         Working options are: #@@known_keys.
 WARNING
     end
     def weights_from options

data/lib/picky/category_indexed.rb

@@ -21,7 +21,7 @@ module Picky
         # TODO We might be able to return early?
         #
         @ranger.new(*range).inject(nil) do |sum, text|
-          weight = bundle.weight(text)
+          weight = bundle.weight text
           weight && (weight + (sum || 0)) || sum
         end
       else
@@ -55,15 +55,6 @@ module Picky
       token.partial? ? partial : exact
     end
 
-    # Returns a combination for the token,
-    # or nil, if there is none.
-    #
-    # TODO Don't throw away the weight, instead store it in the combination?
-    #
-    def combination_for token
-      weight(token) && Query::Combination.new(token, self)
-    end
-
   end
 
 end

data/lib/picky/category_indexing.rb

@@ -56,7 +56,8 @@ module Picky
     # generates the necessary derived indexes.
     #
     def retrieve
-      prepared.retrieve { |id, token| add_tokenized_token id, token, :<< }
+      format = key_format?
+      prepared.retrieve { |id, token| add_tokenized_token id, token, :<<, format }
     end
 
     # Return the key format.
@@ -65,10 +66,11 @@ module Picky
     # and the source has no key format, ask
     # the index for one.
     #
-    # Default is to_i.
-    #
     def key_format
-      @key_format ||= @index.key_format || :to_i
+      @key_format ||= @index.key_format
+    end
+    def key_format?
+      key_format
     end
 
     # Where the data is taken from.

data/lib/picky/category_realtime.rb

@@ -8,7 +8,7 @@ module Picky
     # given id.
     #
     def remove id
-      id = id.send key_format
+      id = id.send key_format if key_format?
       exact.remove id
       partial.remove id
     end
@@ -42,7 +42,7 @@ module Picky
       return unless text = hash[from] || hash[from.to_s]
       
       raise IdNotGivenException.new unless id = hash[:id] || hash['id']
-      id = id.send key_format
+      id = id.send key_format if key_format?
       
       remove id
       add_text id, text
@@ -72,11 +72,9 @@ module Picky
         tokens = text_or_tokens
       end
       
-      # TODO Have an "as is" key_format?
-      #
-      tokens.each { |text| add_tokenized_token id.send(key_format), text, where, false }
+      format = self.key_format?
+      tokens.each { |text| add_tokenized_token id, text, where, format }
     rescue NoMethodError
-      # TODO This also is raised on a wrong key_format.
       # TODO Improve error message by pointing out what exactly goes wrong: thing xy does not have an #each method.
       raise %Q{You probably set tokenize: false on category "#{name}". It will need an Enumerator of previously tokenized tokens.}
     end
@@ -85,12 +83,15 @@ module Picky
     #
     def add_tokenized_token id, text, where = :unshift, format = true
       return unless text
-
+      
       id = id.send key_format if format
       # text = text.to_sym if @symbols # SYMBOLS.
 
       exact.add id, text, where
       partial.add_partialized id, text, where
+    rescue NoMethodError => e
+      puts e.message
+      raise %Q{The object id with text "#{text}" does not respond to method #{key_format}.}
     end
 
     # Clears the realtime mapping.

data/lib/picky/index.rb

@@ -378,7 +378,7 @@ INDEX
     #
     #
     def to_s
-      "#{self.class}(#{name}, result_id: #{result_identifier}, source: #{@source}, categories: #{categories})"
+      "#{self.class}(#{name}, result_id: #{result_identifier}, source: #@source, categories: #{categories})"
     end
 
   end

data/lib/picky/index_indexed.rb

@@ -7,7 +7,6 @@ module Picky
     forward :load,
             :analyze,
             :reindex,
-            :possible_combinations,
             :to => :categories
 
     # Define how the results of this index are identified.

data/lib/picky/loader.rb

@@ -164,7 +164,8 @@ module Picky
       #
       def load_query
         load_relative 'query/combination',
-                      'query/combinations'
+                      'query/combinations',
+                      'query/combination/or'
 
         load_relative 'query/allocation',
                       'query/allocations'
@@ -190,6 +191,7 @@ module Picky
         load_wrappers
         load_relative 'query/token' # Token related.
         load_relative 'query/tokens'
+        load_relative 'query/or'
         load_query
       end
       

data/lib/picky/query/boosts.rb

@@ -74,7 +74,7 @@ module Picky
       # configured weights.
       #
       def to_s
-        "#{self.class}(#{@boosts})"
+        "#{self.class}(#@boosts)"
       end
 
     end

data/lib/picky/query/combination.rb

@@ -2,22 +2,27 @@ module Picky
 
   module Query
 
-    # Describes the Combination of a Token (the text) and
-    # the index (the bundle): [text, index_bundle].
+    # Describes the Combination of:
+    #  * a token
+    #  * a category
+    #  * the weight of the token in the category (cached)
     #
     # An Allocation consists of an ordered number of Combinations.
     #
     class Combination
 
       attr_reader :token,
-                  :category
+                  :category,
+                  :weight
 
-      def initialize token, category
+      def initialize token, category, weight
         @token    = token
         @category = category
+        @weight   = weight
       end
 
       # Returns the category's name.
+      # Used in boosting.
       #
       def category_name
         @category_name ||= category.name
@@ -31,10 +36,8 @@ module Picky
 
       # Returns the weight of this combination.
       #
-      # Note: Caching is most of the time useful.
-      #
       def weight
-        @weight ||= category.weight(token)
+        @weight
       end
 
       # Returns an array of ids for the given text.
@@ -65,7 +68,7 @@ module Picky
       #   "exact title:Peter*:peter"
       #
       def to_s
-        "#{category.bundle_for(token).identifier}(#{to_result.join(':')})"
+        "(#{category.bundle_for(token).identifier},#{to_result.join(':')})"
       end
 
     end

data/lib/picky/query/combination/or.rb

@@ -0,0 +1,59 @@
+module Picky
+
+  module Query
+
+    class Combination
+      
+      # Pretends to be a combination.
+      #
+      # TODO Rework completely and document.
+      #
+      class Or < Combination
+        
+        def initialize combinations
+          @combinations = combinations
+        end
+        
+        # Returns the combination's category name.
+        # Used in boosting.
+        #
+        def category_name
+          @category_name ||= @combinations.map(&:category_name).join('|').intern
+        end
+
+        # Returns the total (?) weight of its combinations.
+        #
+        # Note: Caching is most of the time useful.
+        #
+        def weight
+          @weight ||= @combinations.inject(0) do |sum, combination|
+            sum + combination.weight
+          end
+        end
+
+        # Returns an array of ids from its combinations.
+        #
+        # Note: Caching is most of the time useful.
+        #
+        def ids
+          @ids ||= @combinations.inject([]) do |total, combination|
+            total + combination.ids
+          end.uniq
+        end
+        
+        def identifier
+          @identifier ||= "#{@combinations.map(&:bundle).map(&:identifier).join('|')}:inverted:#{token.text}"
+        end
+        
+        def to_result
+          results = @combinations.map &:to_result
+          [*@combinations.map(&:to_result).transpose.map! { |thing| thing.join('|') }]
+        end
+        
+      end
+      
+    end
+    
+  end
+  
+end

data/lib/picky/query/indexes.rb

@@ -110,7 +110,7 @@ module Picky
       def allocation_for tokens, index
         # Expand the combinations.
         #
-        possible_combinations = tokens.possible_combinations_in index
+        possible_combinations = tokens.possible_combinations_in index.categories
 
         # Generate all possible combinations.
         #

data/lib/picky/query/or.rb

@@ -0,0 +1,47 @@
+module Picky
+
+  module Query
+    
+    class Tokens
+
+      # This is a combination of multiple (already processed) tokens, combined using
+      # the OR character, usually | (pipe).
+      #
+      # It pretends to be a single token and answers to all messages
+      # a token would answer to.
+      #
+      class Or < Tokens
+      
+        def initialize processed_tokens
+          @tokens = processed_tokens
+        end
+        
+        # TODO
+        #
+        def possible_combinations categories
+          combinations = @tokens.inject([]) do |result, token|
+            result + token.possible_combinations(categories)
+          end
+          combinations.empty? && combinations || [Query::Combination::Or.new(combinations)]
+        end
+        
+        # # Returns the token in the form
+        # #   ['original:Text', 'processedtext']
+        # #
+        # def to_result
+        #   [originals.join('|'), texts.join('|')]
+        # end
+        
+        # # Just join the token original texts.
+        # #
+        # def to_s
+        #   "#{self.class}(#{originals.join '|'})"
+        # end
+      
+      end
+      
+    end
+    
+  end
+  
+end

data/lib/picky/query/token.rb

@@ -148,8 +148,8 @@ module Picky
       #
       @@no_similar_character = '"'
       @@similar_character = '~'
-      @@no_similar = %r{#{@@no_similar_character}\z}
-      @@similar    = %r{#{@@similar_character}\z}
+      @@no_similar = %r{#@@no_similar_character\z}
+      @@similar    = %r{#@@similar_character\z}
       def similarize
         self.similar = false or return unless @text !~ @@no_similar
         self.similar = true unless @text !~ @@similar
@@ -222,14 +222,25 @@ module Picky
         @text.gsub! @@illegals, EMPTY_STRING unless @text == EMPTY_STRING
       end
       def self.redefine_illegals
-        @@illegals = %r{[#{@@no_similar_character}#{@@partial_character}#{@@similar_character}]}
+        @@illegals = %r{[#@@no_similar_character#@@partial_character#@@similar_character]}
       end
       redefine_illegals
-
-      # Returns an array of possible combinations.
+      
+      # Return all possible combinations.
+      #
+      # This checks if it needs to also search through similar
+      # tokens, if for example, the token is one with ~.
+      # If yes, it puts together all solutions.
+      #
+      def possible_combinations categories
+        similar? ? categories.similar_possible_for(self) : categories.possible_for(self)
+      end
+      
+      # TODO
       #
-      def possible_combinations_in index
-        index.possible_combinations self
+      def combination_for category
+        weight = category.weight self
+        weight && Query::Combination.new(self, category, weight)
       end
 
       # Returns all similar tokens for the token.
@@ -310,7 +321,7 @@ module Picky
       # Note: Used in many backends.
       #
       def identifier
-        "#{similar?? :similarity : :inverted}:#{@text}"
+        "#{similar?? :similarity : :inverted}:#@text"
       end
 
       # If the originals & the text are the same, they are the same.

data/lib/picky/query/tokens.rb

@@ -13,6 +13,8 @@ module Picky
       # Basically forwards to its internal tokens array.
       #
       forward *[Enumerable.instance_methods, :slice!, :[], :uniq!, :last, :reject!, :length, :size, :empty?, :each, :exit, :to => :@tokens].flatten
+      each_forward :partial=,
+                   :to => :@tokens
 
       # Create a new Tokens object with the array of tokens passed in.
       #
@@ -24,7 +26,14 @@ module Picky
       # Creates a new Tokens object from a number of Strings.
       #
       def self.processed words, originals, ignore_unassigned = false
-        new words.zip(originals).collect! { |word, original| Token.processed word, original }, ignore_unassigned
+        new(words.zip(originals).collect! do |word, original|
+          w, *middle, rest  = word.split(/\|/)
+          if rest
+            Or.new processed [w, *middle, rest], original.split(/\|/)
+          else
+            Token.processed w, original
+          end
+        end, ignore_unassigned)
       end
 
       # Generates an array in the form of
@@ -34,10 +43,10 @@ module Picky
       #  [combination, combination]               # of token 3
       # ]
       #
-      def possible_combinations_in index
+      def possible_combinations_in categories
         @tokens.inject([]) do |combinations, token|
-          possible_combinations = token.possible_combinations_in index
-
+          possible_combinations = token.possible_combinations categories
+          
           # Note: Optimization for ignoring tokens that allocate to nothing and
           # can be ignored.
           # For example in a special search, where "florian" is not
@@ -63,11 +72,19 @@ module Picky
         @tokens.last.partial = true unless empty?
       end
 
-      #
+      # TODO
       #
       def originals
         @tokens.map(&:original)
       end
+      def original
+        @tokens.map(&:original)
+      end
+      # TODO
+      #
+      def texts
+        @tokens.map(&:text)
+      end
       
       #
       #

data/lib/picky/search.rb

@@ -275,7 +275,7 @@ module Picky
       s = "#{self.class}("
       ary = []
       ary << @indexes.indexes.map(&:name).join(', ') unless @indexes.indexes.empty?
-      ary << "boosts: #{@boosts}" if @boosts
+      ary << "boosts: #@boosts" if @boosts
       s << ary.join(', ')
       s << ")"
       s

data/spec/functional/arrays_as_ids_spec.rb

@@ -8,8 +8,6 @@ describe "Array IDs" do
   #
   it 'can use Arrays as IDs' do
     index = Picky::Index.new :arrays do
-      key_format :to_a
-      
       category :text1
     end
 
@@ -26,7 +24,7 @@ describe "Array IDs" do
     try.search("text1:ohai").ids.should == [
       ["id2", "thing2"],
       ["id1", "thing1"]
-    ] # WAT
+    ]
   end
 
   # This tests the weights option.
@@ -51,7 +49,7 @@ describe "Array IDs" do
     try.search("text1:ohai").ids.should == [
       ["id2", "thing2"],
       ["id1", "thing1"]
-    ] # WAT
+    ]
   end
 
 end

data/spec/functional/custom_delimiters_spec.rb

@@ -73,9 +73,9 @@ describe 'custom delimiters' do
     Picky::Query::Token.qualifier_text_delimiter = '?'
     try.search("text1?hello text2?world").ids.should == [1]
     
-    try.search("text1|text2?hello text2?world").ids.should == []
-    Picky::Query::Token.qualifiers_delimiter = '|'
-    try.search("text1|text2?hello text2?world").ids.should == [1]
+    try.search("text1!text2?hello text2?world").ids.should == []
+    Picky::Query::Token.qualifiers_delimiter = '!'
+    try.search("text1!text2?hello text2?world").ids.should == [1]
   end
   
   it 'offers custom range characters to be set' do

data/spec/functional/exact_first_spec.rb

@@ -54,6 +54,8 @@ describe "exact first" do
     require 'ostruct'
 
     data = Picky::Index.new :exact_first do
+      key_format :to_i
+      
       source { [
         OpenStruct.new(id: 1, text: "discofox"),
         OpenStruct.new(id: 2, text: "disco")

data/spec/functional/or_spec.rb

@@ -0,0 +1,104 @@
+# encoding: utf-8
+#
+require 'spec_helper'
+require 'ostruct'
+
+describe "OR token" do
+
+  it 'handles simple cases' do
+    index = Picky::Index.new :or do
+      category :text
+    end
+
+    thing = OpenStruct.new id: 1, text: "hello ohai"
+    other = OpenStruct.new id: 2, text: "hello kthxbye"
+
+    index.add thing
+    index.add other
+
+    try = Picky::Search.new index
+    
+    # With or, or |.
+    #
+    try.search("hello text:ohai|text:kthxbye").ids.should == [1, 2]
+    try.search("hello text:ohai|kthxbye").ids.should == [1, 2]
+    try.search("hello ohai|text:kthxbye").ids.should == [1, 2]
+    try.search("hello ohai|kthxbye").ids.should == [1, 2]
+    
+    # Still works.
+    #
+    try.search("hello text:ohai").ids.should == [1]
+  end
+  
+  it 'handles more complex cases' do
+    index = Picky::Index.new :or do
+      category :text1
+      category :text2
+    end
+
+    thing = OpenStruct.new id: 1, text1: "hello world", text2: "ohai kthxbye"
+    other = OpenStruct.new id: 2, text1: "hello something else", text2: "to be or not to be"
+
+    index.add thing
+    index.add other
+
+    try = Picky::Search.new index
+    
+    # With or, or |.
+    #
+    # Note that the order is changed.
+    #
+    try.search("hello ohai|not").ids.should == [1, 2]
+    try.search("hello not|ohai").ids.should == [2, 1]
+    try.search("hello ohai|kthxbye").ids.should == [1]
+    try.search("hello nonexisting|not").ids.should == [2]
+    try.search("hello nonexisting|alsononexisting").ids.should == []
+    try.search("hello text1:world|text2:not|text2:kthxbye").ids.should == [1, 2]
+  end
+  
+  it 'handles even more complex cases' do
+    index = Picky::Index.new :or do
+      category :text, similarity: Picky::Similarity::DoubleMetaphone.new(3)
+    end
+
+    thing = OpenStruct.new id: 1, text: "hello ohai tester 13"
+    other = OpenStruct.new id: 2, text: "hello kthxbye"
+
+    index.add thing
+    index.add other
+
+    try = Picky::Search.new index
+    
+    # With or, or |.
+    #
+    try.search("something,other:ohai").ids.should == []
+    try.search("text:taster~|text:kthxbye hello").ids.should == [2, 1]
+    try.search("text:test*|kthxbye hello").ids.should == [2, 1]
+    try.search("text:11-15|kthxbye hello").ids.should == [2, 1]
+    try.search("hello text,other:ohai|text:kthxbye").ids.should == [1, 2]
+    try.search("hello something,other:ohai|kthxbye").ids.should == [2]
+    try.search("hello text:oh*|text:kthxbya~").ids.should == [1, 2]
+  end
+  
+  it 'handles multi-ORs' do
+    index = Picky::Index.new :or do
+      category :text, similarity: Picky::Similarity::DoubleMetaphone.new(3)
+    end
+
+    thing     = OpenStruct.new id: 1, text: "that thing"
+    something = OpenStruct.new id: 2, text: "and something"
+    other     = OpenStruct.new id: 3, text: "or other"
+
+    index.add thing
+    index.add something
+    index.add other
+
+    try = Picky::Search.new index
+    
+    # With or, or |.
+    #
+    try.search("thing|something|other").ids.should == [1, 2, 3]
+    try.search("something|other").ids.should == [2, 3]
+  end
+
+end

data/spec/functional/pool_spec.rb

@@ -31,17 +31,19 @@ describe 'GC stats: searching' do
   # TODO Why are both versions almost equally fast?
   #
   context 'without pool' do
-    it 'runs the GC more' do
-      # Quickly check if the pool is removed.
-      #
-      fail 'object pool still installed' if Picky::Query::Token.respond_to? :release_all
-      
-      try = search
-      query = 'abracadabra mirgel'
-      gc_runs_of do
-        amount.times { try.search query }
-      end.should >= 10
-    end
+    # TODO Reinstate after checking assumption about Ruby 2.
+    #
+    # it 'runs the GC more' do
+    #   # Quickly check if the pool is removed.
+    #   #
+    #   fail 'object pool still installed' if Picky::Query::Token.respond_to? :release_all
+    #   
+    #   try = search
+    #   query = 'abracadabra mirgel'
+    #   gc_runs_of do
+    #     amount.times { try.search query }
+    #   end.should >= 10
+    # end
     it 'is less (?) performant' do
       try = search
       query = 'abracadabra mirgel'

data/spec/functional/sorting_spec.rb

@@ -12,6 +12,8 @@ describe "special sorting" do
 
   it 'returns exact results first' do
     data = Picky::Index.new :sorted do
+      key_format :to_i
+      
       category :first, partial: Picky::Partial::Substring.new(from: 1)
       category :last, partial: Picky::Partial::Substring.new(from: 1)
     end

data/spec/lib/categories_indexed_spec.rb

@@ -77,64 +77,64 @@ describe Picky::Categories do
       @categories << @category3
     end
 
-    describe "possible_combinations" do
-      before(:each) do
-        @token = stub :token
-      end
-      context "with similar token" do
-        before(:each) do
-          @token.stub :similar? => true, :categorize => nil
-        end
-        it "calls the right method" do
-          @categories.should_receive(:similar_possible_for).once.with @token
-
-          @categories.possible_combinations @token
-        end
-      end
-      context "with non-similar token" do
-        before(:each) do
-          @token.stub :similar? => false, :categorize => nil
-        end
-        it "calls the right method" do
-          @categories.should_receive(:possible_for).once.with @token
-
-          @categories.possible_combinations @token
-        end
-      end
-    end
-
-    describe 'possible_for' do
-      context 'without preselected categories' do
-        context 'user defined exists' do
-          before(:each) do
-            @token = stub :token, :predefined_categories => [@category2]
-          end
-          context 'combination exists' do
-            before(:each) do
-              @combination = stub :combination
-              @category2.stub! :combination_for => @combination
-            end
-            it 'should return the right combinations' do
-              @categories.possible_for(@token).should == [@combination]
-            end
-          end
-          context 'combination does not exist' do
-            before(:each) do
-              @category2.stub! :combination_for => nil
-            end
-            it 'should return the right combinations' do
-              @categories.possible_for(@token).should == []
-            end
-          end
-        end
-        context 'user defined does not exist' do
-
-        end
-      end
-      context 'with preselected categories' do
-
-      end
-    end
+    # describe "possible_combinations" do
+    #   before(:each) do
+    #     @token = stub :token
+    #   end
+    #   context "with similar token" do
+    #     before(:each) do
+    #       @token.stub :similar? => true, :categorize => nil
+    #     end
+    #     it "calls the right method" do
+    #       @categories.should_receive(:similar_possible_for).once.with @token
+    # 
+    #       @categories.possible_combinations @token
+    #     end
+    #   end
+    #   context "with non-similar token" do
+    #     before(:each) do
+    #       @token.stub :similar? => false, :categorize => nil
+    #     end
+    #     it "calls the right method" do
+    #       @categories.should_receive(:possible_for).once.with @token
+    # 
+    #       @categories.possible_combinations @token
+    #     end
+    #   end
+    # end
+
+    # describe 'possible_for' do
+    #   context 'without preselected categories' do
+    #     context 'user defined exists' do
+    #       before(:each) do
+    #         @token = Picky::Query::Token.processed 'hello'
+    #       end
+    #       context 'combination exists' do
+    #         before(:each) do
+    #           @combination = stub :combination
+    #           @category2.stub! :combination_for => @combination
+    #         end
+    #         it 'should return the right combinations' do
+    #           @categories.possible_for(@token).should == [@combination]
+    #         end
+    #       end
+    #       context 'combination does not exist' do
+    #         before(:each) do
+    #           @category2.stub! :combination_for => nil
+    #         end
+    #         it 'should return the right combinations' do
+    #           @categories.possible_for(@token).should == []
+    #         end
+    #       end
+    #     end
+    #     context 'user defined does not exist' do
+    # 
+    #     end
+    #   end
+    #   context 'with preselected categories' do
+    # 
+    #   end
+    # end
 
     describe 'possible_categories' do
       context 'user defined exists' do

data/spec/lib/category_indexed_spec.rb

@@ -182,30 +182,30 @@ describe Picky::Category do
     end
   end
 
-  describe 'combination_for' do
-    context 'no weight for token' do
-      before(:each) do
-        @category.stub! :weight => nil
-      end
-      it 'should return nil' do
-        @category.combination_for(:anything).should == nil
-      end
-    end
-    context 'weight for token' do
-      before(:each) do
-        @token = stub :token, :text => :some_text
-        @category.stub! :weight => :some_weight, :bundle_for => :bundle
-      end
-      it 'should return a new combination' do
-        @category.combination_for(@token).should be_kind_of(Picky::Query::Combination)
-      end
-      it 'should create the combination correctly' do
-        Picky::Query::Combination.should_receive(:new).once.with @token, @category
-
-        @category.combination_for @token
-      end
-    end
-  end
+  # describe 'combination_for' do
+  #   context 'no weight for token' do
+  #     before(:each) do
+  #       @category.stub! :weight => nil
+  #     end
+  #     it 'should return nil' do
+  #       @category.combination_for(:anything).should == nil
+  #     end
+  #   end
+  #   context 'weight for token' do
+  #     before(:each) do
+  #       @token = stub :token, :text => :some_text
+  #       @category.stub! :weight => :some_weight, :bundle_for => :bundle
+  #     end
+  #     it 'should return a new combination' do
+  #       @category.combination_for(@token).should be_kind_of(Picky::Query::Combination)
+  #     end
+  #     it 'should create the combination correctly' do
+  #       Picky::Query::Combination.should_receive(:new).once.with @token, @category
+  # 
+  #       @category.combination_for @token
+  #     end
+  #   end
+  # end
 
   context 'stubbed exact/partial' do
     before(:each) do

data/spec/lib/category_indexing_spec.rb

@@ -59,11 +59,11 @@ describe Picky::Category do
                                           .and_yield(5, :some_token)
         category.stub! :prepared => prepared
 
-        category.should_receive(:add_tokenized_token).once.with(1, :some_token, :<<)
-        category.should_receive(:add_tokenized_token).once.with(2, :some_token, :<<)
-        category.should_receive(:add_tokenized_token).once.with(3, :some_token, :<<)
-        category.should_receive(:add_tokenized_token).once.with(4, :some_token, :<<)
-        category.should_receive(:add_tokenized_token).once.with(5, :some_token, :<<)
+        category.should_receive(:add_tokenized_token).once.with(1, :some_token, :<<, nil)
+        category.should_receive(:add_tokenized_token).once.with(2, :some_token, :<<, nil)
+        category.should_receive(:add_tokenized_token).once.with(3, :some_token, :<<, nil)
+        category.should_receive(:add_tokenized_token).once.with(4, :some_token, :<<, nil)
+        category.should_receive(:add_tokenized_token).once.with(5, :some_token, :<<, nil)
 
         category.retrieve
       end

data/spec/lib/index_indexed_spec.rb

@@ -37,13 +37,6 @@ describe Picky::Index do
         @index.load
       end
     end
-    describe "possible_combinations" do
-      it "forwards to the combinator" do
-        @categories.should_receive(:possible_combinations).once.with :some_token
-
-        @index.possible_combinations :some_token
-      end
-    end
   end
 
   context 'result_identifier' do

data/spec/lib/query/combination_spec.rb

@@ -12,41 +12,23 @@ describe Picky::Query::Combination do
                         :name => :some_category_name,
                         :identifier => 'some_category_identifier'
 
-    @combination = described_class.new @token, @category
+    @combination = described_class.new @token, @category, 3.14
   end
 
   describe "to_s" do
     it "shows the combination's info" do
       @token.stub! :to_result => :token_result
 
-      @combination.to_s.should == 'bundle_name(some_category_name:token_result)'
+      @combination.to_s.should == '(bundle_name,some_category_name:token_result)'
     end
   end
 
-  # describe 'hash' 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
     context 'functional with qualifier' do
       before(:each) do
         token = Picky::Query::Token.processed 'name:blä~', 'Blä~'
 
-        @combination = Picky::Query::Combination.new token, @category
+        @combination = Picky::Query::Combination.new token, @category, 3.14
       end
       it 'should return a correct result' do
         @combination.to_result.should == [:some_category_name, 'Blä~', 'blä'] # Note: Characters not substituted. That's ok.
@@ -82,18 +64,8 @@ describe Picky::Query::Combination do
   end
 
   describe 'weight' do
-    it 'should call weight with the text on bundle' do
-      @category.should_receive(:weight).once.with @token
-
-      @combination.weight
-    end
-    it 'should not call it twice, but cache' do
-      @category.stub! :weight => :some_weight
-      @combination.weight
-
-      @category.should_receive(:weight).never
-
-      @combination.weight.should == :some_weight
+    it 'should return the weight' do
+      @combination.weight.should == 3.14
     end
   end
 

data/spec/lib/query/tokens_spec.rb

@@ -26,9 +26,9 @@ describe Picky::Query::Tokens do
         @tokens = described_class.new [@token1, @token2, @token3], true
       end
       it 'should work correctly' do
-        @token1.should_receive(:possible_combinations_in).once.with(:some_index).and_return [:combination11, :combination12]
-        @token2.should_receive(:possible_combinations_in).once.with(:some_index).and_return [:combination21]
-        @token3.should_receive(:possible_combinations_in).once.with(:some_index).and_return [:combination31, :combination32, :combination33]
+        @token1.should_receive(:possible_combinations).once.with(:some_index).and_return [:combination11, :combination12]
+        @token2.should_receive(:possible_combinations).once.with(:some_index).and_return [:combination21]
+        @token3.should_receive(:possible_combinations).once.with(:some_index).and_return [:combination31, :combination32, :combination33]
 
         @tokens.possible_combinations_in(:some_index).should == [
           [:combination11, :combination12],
@@ -37,9 +37,9 @@ describe Picky::Query::Tokens do
         ]
       end
       it 'should work correctly' do
-        @token1.should_receive(:possible_combinations_in).once.with(:some_index).and_return [:combination11, :combination12]
-        @token2.should_receive(:possible_combinations_in).once.with(:some_index).and_return []
-        @token3.should_receive(:possible_combinations_in).once.with(:some_index).and_return [:combination31, :combination32, :combination33]
+        @token1.should_receive(:possible_combinations).once.with(:some_index).and_return [:combination11, :combination12]
+        @token2.should_receive(:possible_combinations).once.with(:some_index).and_return []
+        @token3.should_receive(:possible_combinations).once.with(:some_index).and_return [:combination31, :combination32, :combination33]
 
         @tokens.possible_combinations_in(:some_index).should == [
           [:combination11, :combination12],
@@ -171,9 +171,9 @@ describe Picky::Query::Tokens do
       @tokens = described_class.new [@token1, @token2, @token3]
     end
     it 'should work correctly' do
-      @token1.should_receive(:possible_combinations_in).once.with(:some_index).and_return [:combination11, :combination12]
-      @token2.should_receive(:possible_combinations_in).once.with(:some_index).and_return [:combination21]
-      @token3.should_receive(:possible_combinations_in).once.with(:some_index).and_return [:combination31, :combination32, :combination33]
+      @token1.should_receive(:possible_combinations).once.with(:some_index).and_return [:combination11, :combination12]
+      @token2.should_receive(:possible_combinations).once.with(:some_index).and_return [:combination21]
+      @token3.should_receive(:possible_combinations).once.with(:some_index).and_return [:combination31, :combination32, :combination33]
 
       @tokens.possible_combinations_in(:some_index).should == [
         [:combination11, :combination12],
@@ -182,9 +182,9 @@ describe Picky::Query::Tokens do
       ]
     end
     it 'should work correctly' do
-      @token1.should_receive(:possible_combinations_in).once.with(:some_index).and_return [:combination11, :combination12]
-      @token2.should_receive(:possible_combinations_in).once.with(:some_index).and_return nil
-      @token3.should_receive(:possible_combinations_in).once.with(:some_index).and_return [:combination31, :combination32, :combination33]
+      @token1.should_receive(:possible_combinations).once.with(:some_index).and_return [:combination11, :combination12]
+      @token2.should_receive(:possible_combinations).once.with(:some_index).and_return nil
+      @token3.should_receive(:possible_combinations).once.with(:some_index).and_return [:combination31, :combination32, :combination33]
 
       @tokens.possible_combinations_in(:some_index).should == [
         [:combination11, :combination12],

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: picky
 version: !ruby/object:Gem::Version
-  version: 4.16.0
+  version: 4.17.0
 platform: ruby
 authors:
 - Florian Hanke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-12 00:00:00.000000000 Z
+date: 2013-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 4.16.0
+        version: 4.17.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 4.16.0
+        version: 4.17.0
 - !ruby/object:Gem::Dependency
   name: text
   requirement: !ruby/object:Gem::Requirement
@@ -226,10 +226,12 @@ files:
 - lib/picky/query/allocation.rb
 - lib/picky/query/allocations.rb
 - lib/picky/query/boosts.rb
+- lib/picky/query/combination/or.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/or.rb
 - lib/picky/query/token.rb
 - lib/picky/query/tokens.rb
 - lib/picky/rack/harakiri.rb
@@ -288,6 +290,7 @@ files:
 - spec/functional/no_tokenize_spec.rb
 - spec/functional/non_specific_ids_larger_than_20_spec.rb
 - spec/functional/only_spec.rb
+- spec/functional/or_spec.rb
 - spec/functional/pool_spec.rb
 - spec/functional/range_queries_spec.rb
 - spec/functional/realtime_spec.rb
@@ -411,7 +414,9 @@ files:
   YmluL3BpY2t5
 - ext/picky/extconf.rb
 homepage: http://florianhanke.com/picky
-licenses: []
+licenses:
+- MIT
+- LGPL
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -460,6 +465,7 @@ test_files:
 - spec/functional/no_tokenize_spec.rb
 - spec/functional/non_specific_ids_larger_than_20_spec.rb
 - spec/functional/only_spec.rb
+- spec/functional/or_spec.rb
 - spec/functional/pool_spec.rb
 - spec/functional/range_queries_spec.rb
 - spec/functional/realtime_spec.rb