picky 4.5.7 → 4.5.8

data/lib/maybe_compile.rb

@@ -1,3 +1,6 @@
+# TODO Decide what to do with this.
+#
+
 # Note: This is handled toplevel to not confuse compilers.
 #
 failed = 0

data/lib/picky/generators/weights/logarithmic.rb

@@ -15,30 +15,43 @@ module Picky
       class Logarithmic < Strategy
         
         def initialize constant = 0.0
-          # Note: Optimisation since it is called
-          # once per indexed object.
-          #
-          if constant == 0.0
-            def weight_for amount
-              return 0 if amount < 1
-              Math.log(amount).round 3
-            end
-          else
-            @constant = constant
-            # Sets the weight value.
-            #
-            # If the size is 0 or one, we would get -Infinity or 0.0.
-            # Thus we do not set a value if there is just one. The default, dynamically, is 0.
-            #
-            # BUT: We need the value, even if 0. To designate that there IS a weight!
-            #
-            def weight_for amount
-              return @constant if amount < 1
-              @constant + Math.log(amount).round(3)
-            end
-          end
+          @constant = constant
+          # # Note: Optimisation since it is called
+          # # once per indexed object.
+          # #
+          # if constant == 0.0
+          #   install_without_constant
+          # else
+          #   @constant = constant
+          #   install_with_constant
+          # end
         end
-
+        
+        def weight_for amount
+          return @constant if amount < 1
+          @constant + Math.log(amount).round(3)
+        end
+        
+        # def install_with_constant
+        #   # Sets the weight value.
+        #   #
+        #   # If the size is 0 or one, we would get -Infinity or 0.0.
+        #   # Thus we do not set a value if there is just one. The default, dynamically, is 0.
+        #   #
+        #   # BUT: We need the value, even if 0. To designate that there IS a weight!
+        #   #
+        #   def weight_for amount
+        #     return @constant if amount < 1
+        #     @constant + Math.log(amount).round(3)
+        #   end
+        # end
+        # def install_without_constant
+        #   def weight_for amount
+        #     return 0 if amount < 1
+        #     Math.log(amount).round 3
+        #   end
+        # end
+        
       end
 
     end

data/lib/picky/index.rb

@@ -162,6 +162,7 @@ module Picky
     # * category_name: This identifier is used in the front end, but also to categorize query text. For example, “title:hobbit” will narrow the hobbit query on categories with the identifier :title.
     #
     # === Options
+    # * indexing: Pass in either a tokenizer or tokenizer options.
     # * partial: Partial::None.new or Partial::Substring.new(from: starting_char, to: ending_char). Default is Partial::Substring.new(from: -3, to: -1).
     # * similarity: Similarity::None.new or Similarity::DoubleMetaphone.new(similar_words_searched). Default is Similarity::None.new.
     # * qualifiers: An array of qualifiers with which you can define which category you’d like to search, for example “title:hobbit” will search for hobbit in just title categories. Example: qualifiers: [:t, :titre, :title] (use it for example with multiple languages). Default is the name of the category.

data/lib/picky/index_facets.rb

@@ -0,0 +1,19 @@
+module Picky
+
+  class Index
+    
+    # Return facets for a category in the form:
+    #   { text => weight } # or ids.size?
+    #
+    def facets category_identifier, options = {}
+      weights = self[category_identifier].exact.weights
+      if minimal_weight = options[:more_than]
+        weights.select { |_, weight| weight > minimal_weight }
+      else
+        weights
+      end
+    end
+
+  end
+
+end

data/lib/picky/loader.rb

@@ -243,6 +243,7 @@ module Picky
         load_relative 'index_indexed'
         load_relative 'index_indexing'
         load_relative 'index_realtime'
+        load_relative 'index_facets'
         load_relative 'index_convenience'
 
         # Results.
@@ -253,6 +254,7 @@ module Picky
         # Search.
         #
         load_relative 'search'
+        load_relative 'search_facets'
 
         # Interfaces
         #

data/lib/picky/query/indexes.rb

@@ -12,7 +12,13 @@ module Picky
     #   # bundle them in an index bundle.
     #
     class Indexes
-
+      
+      # TODO Only needed for .
+      #
+      delegate :size,
+               :first,
+               :to => :@indexes
+      
       attr_reader :indexes,
                   :ignored_categories
 

data/lib/picky/query/token.rb

@@ -25,10 +25,10 @@ module Picky
       # Note:
       # Use this if you do not want a normalized token.
       #
-      def initialize text, original = nil, category = nil
+      def initialize text, original = nil, categories = nil
         @text     = text
         @original = original
-        @user_defined_categories = [category] if category
+        @user_defined_categories = categories
       end
 
       # Returns a qualified and normalized token.
@@ -214,7 +214,9 @@ module Picky
       def similar_tokens_for category
         similars = category.bundle_for(self).similar @text
         similars.map do |similar|
-          self.class.new similar, similar, category
+          # The array describes all possible categories. There is only one here.
+          #
+          self.class.new similar, similar, [category]
         end
       end
 

data/lib/picky/search_facets.rb

@@ -0,0 +1,29 @@
+module Picky
+
+  class Search
+
+    # Returns a list of filtered facets.
+    # 
+    # Params
+    #   category: The category whose facets to return.
+    # 
+    # Options
+    #   more_than: A minimum weight a facet needs to have (exclusive). 
+    #   filter: A query to filter the facets with.
+    #
+    # Usage:
+    #   search.facets :name, filter: 'surname:peter', more_than: 0
+    #
+    def facets category_identifier, options = {}
+      raise "#{__method__} cannot be used on searches with more than 1 index yet. Sorry!" if indexes.size > 1
+      index = indexes.first
+      weights = index.facets category_identifier, options
+      return weights unless filter_query = options[:filter]
+      weights.select do |key, weight|
+        search("#{filter_query} #{category_identifier}:#{key}", 0, 0).total > 0
+      end
+    end
+
+  end
+
+end

data/spec/functional/facets_spec.rb

@@ -0,0 +1,143 @@
+# encoding: utf-8
+#
+require 'spec_helper'
+
+# This spec describes
+#
+describe 'facets' do
+
+  describe 'simple example' do
+    let(:index) {
+      index = Picky::Index.new :facets do
+        category :name
+        category :surname
+      end
+
+      thing = Struct.new :id, :name, :surname
+      index.add thing.new(1, 'fritz', 'hanke')
+      index.add thing.new(2, 'kaspar', 'schiess')
+      index.add thing.new(3, 'florian', 'hanke')
+    
+      index
+    }
+    let(:finder) { Picky::Search.new index }
+    
+    describe 'facets' do
+      it 'is correct' do
+        # Picky has 2 facets with different weights for surname.
+        #
+        index.facets(:surname).should == {
+          'hanke' => 0.693,
+          'schiess' => 0
+        }
+    
+        # It has 3 facets with the same weight for name.
+        #
+        index.facets(:name).should == {
+          'fritz' => 0,
+          'kaspar' => 0,
+          'florian' => 0
+        }
+        
+        # Picky only selects facets with a weight >= the given one.
+        #
+        index.facets(:surname, more_than: 0.5).should == {
+          'hanke' => 0.693
+        }
+      end
+    end
+  
+    describe 'facets' do
+      it 'filters them correctly' do
+        # Passing in no filter query just returns the facets
+        #
+        finder.facets(:surname).should == {
+          'hanke' => 0.693,
+          'schiess' => 0.0
+        }
+        
+        # It has two facets.
+        #
+        # TODO Rewrite API.
+        #
+        finder.facets(:name, filter: 'surname:hanke').should == {
+          'fritz' => 0,
+          'florian' => 0
+        }
+      end
+    end
+  end
+  
+  describe 'complex example' do
+    let(:index) {
+      index = Picky::Index.new :facets do
+        category :name
+        category :surname
+        category :age_category
+      end
+
+      thing = Struct.new :id, :name, :surname, :age_category
+      index.add thing.new(1, 'ursula', 'meier', 40)
+      index.add thing.new(2, 'peter', 'meier', 45)
+      index.add thing.new(3, 'peter', 'kunz', 40)
+      index.add thing.new(4, 'peter', 'hanke', 40)
+      index.add thing.new(5, 'annabelle', 'hanke', 35)
+      index.add thing.new(5, 'hans', 'meier', 35)
+    
+      index
+    }
+    let(:finder) { Picky::Search.new index }
+  
+    describe 'facets' do
+      it 'is correct' do
+        # Picky has 2 facets with different weights for surname.
+        #
+        index.facets(:surname).should == {
+          'hanke' => 0.693,
+          'kunz' => 0.0,
+          'meier' => 1.099
+        }
+    
+        # It has 3 facets with the same weight for name.
+        #
+        index.facets(:name).should == {
+          'annabelle' => 0.0,
+          'hans' => 0.0,
+          'peter' => 1.099,
+          'ursula' => 0.0
+        }
+        
+        # It has 1 facet with weight > 0.
+        #
+        index.facets(:name, more_than: 0).should == {
+          'peter' => 1.099
+        }
+      end
+    end
+  
+    describe 'facets' do
+      it 'filters them correctly' do
+        # It has one facet.
+        #
+        # TODO Fix problems with alternative qualifiers (like :age).
+        #
+        finder.facets(:age_category, filter: 'surname:meier name:peter').should == {
+          '45' => 0
+        }
+        
+        # It has two facets.
+        #
+        finder.facets(:surname, filter: 'age_category:40 name:peter').should == {
+          'kunz' => 0.0,
+          'hanke' => 0.693
+        }
+        
+        # It has 1 facet > weight 0.
+        #
+        finder.facets(:surname, filter: 'age_category:40 name:peter', more_than: 0).should == {
+          'hanke' => 0.693
+        }
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: picky
 version: !ruby/object:Gem::Version
-  version: 4.5.7
+  version: 4.5.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-20 00:00:00.000000000 Z
+date: 2012-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70151588753500 !ruby/object:Gem::Requirement
+  requirement: &70220459152600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,21 +21,21 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70151588753500
+  version_requirements: *70220459152600
 - !ruby/object:Gem::Dependency
   name: picky-client
-  requirement: &70151588752540 !ruby/object:Gem::Requirement
+  requirement: &70220459151560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 4.5.7
+        version: 4.5.8
   type: :development
   prerelease: false
-  version_requirements: *70151588752540
+  version_requirements: *70220459151560
 - !ruby/object:Gem::Dependency
   name: text
-  requirement: &70151588750500 !ruby/object:Gem::Requirement
+  requirement: &70220450665880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70151588750500
+  version_requirements: *70220450665880
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &70151588748300 !ruby/object:Gem::Requirement
+  requirement: &70220450662740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70151588748300
+  version_requirements: *70220450662740
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70151588762580 !ruby/object:Gem::Requirement
+  requirement: &70220450660780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70151588762580
+  version_requirements: *70220450660780
 - !ruby/object:Gem::Dependency
   name: procrastinate
-  requirement: &70151588760860 !ruby/object:Gem::Requirement
+  requirement: &70220450680620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: '0.4'
   type: :runtime
   prerelease: false
-  version_requirements: *70151588760860
+  version_requirements: *70220450680620
 - !ruby/object:Gem::Dependency
   name: rack_fast_escape
-  requirement: &70151588759980 !ruby/object:Gem::Requirement
+  requirement: &70220450679340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70151588759980
+  version_requirements: *70220450679340
 description: Fast Ruby semantic text search engine with comfortable single field interface.
 email: florian.hanke+picky@gmail.com
 executables:
@@ -184,6 +184,7 @@ files:
 - lib/picky/helpers/measuring.rb
 - lib/picky/index.rb
 - lib/picky/index_convenience.rb
+- lib/picky/index_facets.rb
 - lib/picky/index_indexed.rb
 - lib/picky/index_indexing.rb
 - lib/picky/index_realtime.rb
@@ -220,6 +221,7 @@ files:
 - lib/picky/results.rb
 - lib/picky/scheduler.rb
 - lib/picky/search.rb
+- lib/picky/search_facets.rb
 - lib/picky/sinatra/index_actions.rb
 - lib/picky/sinatra.rb
 - lib/picky/statistics.rb
@@ -256,6 +258,7 @@ files:
 - spec/functional/custom_delimiters_spec.rb
 - spec/functional/dynamic_weights_spec.rb
 - spec/functional/exact_first_spec.rb
+- spec/functional/facets_spec.rb
 - spec/functional/max_allocations_spec.rb
 - spec/functional/non_specific_ids_larger_than_20_spec.rb
 - spec/functional/only_spec.rb
@@ -412,6 +415,7 @@ test_files:
 - spec/functional/custom_delimiters_spec.rb
 - spec/functional/dynamic_weights_spec.rb
 - spec/functional/exact_first_spec.rb
+- spec/functional/facets_spec.rb
 - spec/functional/max_allocations_spec.rb
 - spec/functional/non_specific_ids_larger_than_20_spec.rb
 - spec/functional/only_spec.rb