picky 4.5.6 → 4.5.7

data/lib/picky/api/category/weight.rb

@@ -9,6 +9,8 @@ module Picky
 
           if thing.respond_to? :weight_for
             thing
+          elsif thing.respond_to? :to_int
+            Generators::Weights::Logarithmic.new thing
           else
             raise <<-ERROR
 weight options for #{index_name}:#{name} should be either

data/lib/picky/category.rb

@@ -14,13 +14,15 @@ module Picky
                 :prepared,
                 :backend
 
-    # Mandatory params:
+    # Parameters:
     #  * name: Category name to use as identifier and file names.
     #  * index: Index to which this category is attached to.
     #
     # Options:
-    #  * partial: Partial::None.new, Partial::Substring.new(from:start_char, to:up_to_char) (defaults from:-3, to:-1)
-    #  * similarity: Similarity::None.new (default), Similarity::DoubleMetaphone.new(amount_of_similarly_linked_words)
+    #  * partial: Partial::None.new, Partial::Substring.new(from:start_char, to:up_to_char)
+    #  (defaults from:-3, to:-1)
+    #  * similarity: Similarity::None.new (default),
+    #  Similarity::DoubleMetaphone.new(amount_of_similarly_linked_words)
     #  * from: The source category identifier to take the data from.
     #  * key_format: What this category's keys are formatted with (default is :to_i)
     #  * backend: The backend to use. Default is Backends::Memory.new.
@@ -28,10 +30,11 @@ module Picky
     #  * qualifiers: Which qualifiers can be used to predefine the category. E.g. "title:bla".
     #
     # Advanced Options:
-    #  * weight: Query::Weights.new( [:category1, :category2] => +2, ... )
-    #  * tokenizer: Use a subclass of Tokenizers::Base that implements #tokens_for and #empty_tokens.
-    #  * use_symbols: Whether to use symbols internally instead of strings.
     #  * source: Use if the category should use a different source.
+    #  * tokenizer: Use a subclass of Tokenizers::Base that implements #tokens_for and #empty_tokens.
+    #  * weight: Weights::Logarithmic.new, Weights::Constant.new(int = 0),
+    #  Weights::Dynamic.new(&block) or an object that responds
+    #  to #weight_for(amount_of_ids_for_token) and returns a float.
     #
     def initialize name, index, options = {}
       @name  = name

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

@@ -3,24 +3,40 @@ module Picky
   module Generators
 
     module Weights
-
+      
       # Uses a logarithmic weight.
+      #
+      # If given a constant, this will be added to the weight.
+      #
       # If for a key k we have x ids, the weight is:
       # w(x): log(x)
       # Special case: If x < 1, then we use 0.
       #
       class Logarithmic < Strategy
-
-        # 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 0 if amount < 1
-          Math.log(amount).round 3
+        
+        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
         end
 
       end

data/spec/lib/api/category/weight_spec.rb

@@ -19,6 +19,14 @@ describe Picky::API::Category::Weight do
         object.extract_weight(nil).should == Picky::Weights::Default
       end
     end
+    context 'with a number' do
+      it 'returns a logarithmic weighter' do
+        object.extract_weight(7.3).should be_kind_of(Picky::Weights::Logarithmic)
+      end
+      it 'returns a logarithmic weighter' do
+        object.extract_weight(3.14).weight_for(10).should == 5.443 # ln(10) + 3.14 = 2.3025 + 3.14
+      end
+    end
     context 'with a weight object' do
       let(:weighter) do
         Class.new do

data/spec/lib/generators/weights/logarithmic_spec.rb

@@ -2,23 +2,47 @@ require 'spec_helper'
 
 describe Picky::Generators::Weights::Logarithmic do
 
-  let(:logarithmic) { described_class.new }
+  describe 'with defaults' do
+    let(:logarithmic) { described_class.new }
 
-  describe 'saved?' do
-    it 'is correct' do
-      logarithmic.saved?.should == true
+    describe 'saved?' do
+      it 'is correct' do
+        logarithmic.saved?.should == true
+      end
     end
-  end
 
-  describe 'weight_for' do
-    it 'is 0 for 0' do
-      logarithmic.weight_for(0).should == 0
+    describe 'weight_for' do
+      it 'is 0 for 0' do
+        logarithmic.weight_for(0).should == 0
+      end
+      it 'is 0 for 1' do
+        logarithmic.weight_for(1).should == 0
+      end
+      it 'is log(x) for x' do
+        logarithmic.weight_for(1234).should == Math.log(1234).round(3)
+      end
     end
-    it 'is 0 for 1' do
-      logarithmic.weight_for(1).should == 0
+  end
+  
+  describe 'with constant' do
+    let(:logarithmic) { described_class.new(3.5) }
+
+    describe 'saved?' do
+      it 'is correct' do
+        logarithmic.saved?.should == true
+      end
     end
-    it 'is log(x) for x' do
-      logarithmic.weight_for(1234).should == Math.log(1234).round(3)
+
+    describe 'weight_for' do
+      it 'is 0 for 0' do
+        logarithmic.weight_for(0).should == 3.5
+      end
+      it 'is 0 for 1' do
+        logarithmic.weight_for(1).should == 3.5
+      end
+      it 'is log(x) for x' do
+        logarithmic.weight_for(1234).should == Math.log(1234).round(3) + 3.5
+      end
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: picky
 version: !ruby/object:Gem::Version
-  version: 4.5.6
+  version: 4.5.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-18 00:00:00.000000000 Z
+date: 2012-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70251933705120 !ruby/object:Gem::Requirement
+  requirement: &70151588753500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,21 +21,21 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70251933705120
+  version_requirements: *70151588753500
 - !ruby/object:Gem::Dependency
   name: picky-client
-  requirement: &70251933703520 !ruby/object:Gem::Requirement
+  requirement: &70151588752540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 4.5.6
+        version: 4.5.7
   type: :development
   prerelease: false
-  version_requirements: *70251933703520
+  version_requirements: *70151588752540
 - !ruby/object:Gem::Dependency
   name: text
-  requirement: &70251933701920 !ruby/object:Gem::Requirement
+  requirement: &70151588750500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70251933701920
+  version_requirements: *70151588750500
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &70251933698920 !ruby/object:Gem::Requirement
+  requirement: &70151588748300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70251933698920
+  version_requirements: *70151588748300
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70251933714040 !ruby/object:Gem::Requirement
+  requirement: &70151588762580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70251933714040
+  version_requirements: *70151588762580
 - !ruby/object:Gem::Dependency
   name: procrastinate
-  requirement: &70251933712600 !ruby/object:Gem::Requirement
+  requirement: &70151588760860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: '0.4'
   type: :runtime
   prerelease: false
-  version_requirements: *70251933712600
+  version_requirements: *70151588760860
 - !ruby/object:Gem::Dependency
   name: rack_fast_escape
-  requirement: &70251933711460 !ruby/object:Gem::Requirement
+  requirement: &70151588759980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70251933711460
+  version_requirements: *70151588759980
 description: Fast Ruby semantic text search engine with comfortable single field interface.
 email: florian.hanke+picky@gmail.com
 executables: