picky 0.9.3 → 0.9.4

data/lib/picky/application.rb

@@ -3,6 +3,8 @@
 class Application
   class << self
     
+    attr_reader :apps
+    
     # Finalize the subclass as soon as it
     # has finished loading.
     #
@@ -50,5 +52,11 @@ class Application
       @queries ||= Configuration::Queries.new
     end
     
+    # TODO Add more info.
+    #
+    def to_s
+      "#{self.name}:\n#{routing}"
+    end
+    
   end
 end

data/lib/picky/extensions/array.rb

@@ -12,6 +12,21 @@ class Array
       result
     end
   end
+  # Around 10% faster than the above.
+  #
+  # Returns a copy.
+  #
+  def clustered_uniq_fast
+    result = []
+    self.inject(nil) do |last, element|
+      if last == element
+        last
+      else
+        result << element && element
+      end
+    end
+    result
+  end
 
   # Accesses a random element of this array.
   #

data/lib/picky/index/bundle.rb

@@ -174,15 +174,12 @@ module Index
       load_weights
     end
     def load_index
-      timed_exclaim "Loading the index for #{identifier} from the cache."
       self.index = files.load_index
     end
     def load_similarity
-      timed_exclaim "Loading the similarity for #{identifier} from the cache."
       self.similarity = files.load_similarity
     end
     def load_weights
-      timed_exclaim "Loading the weights for #{identifier} from the cache."
       self.weights = files.load_weights
     end
     

data/lib/picky/index/category.rb

@@ -29,12 +29,15 @@ module Index
     # Loads the index from cache.
     #
     def load_from_cache
+      timed_exclaim "Loading index #{identifier}."
       exact.load
       partial.load
     end
     
+    # TODO Move to initializer?
+    #
     def identifier
-      "#{type.name} #{name}"
+      @identifier ||= "#{type.name} #{name}"
     end
     
     # Generates all caches for this category.

data/lib/picky/loader.rb

@@ -44,10 +44,6 @@ module Loader
   # Load the user's application.
   #
   def self.load_application
-    # Load the user's application.
-    #
-    exclaim 'Loading Application.'
-    
     # Add lib dir to load path.
     #
     # add_lib_dir
@@ -72,13 +68,15 @@ module Loader
     
     # Finalize the applications.
     #
+    # TODO Problem: Reload Routes.
+    #
     Application.finalize_apps
     
     # TODO Rewrite
     #
     Query::Qualifiers.instance.prepare
     
-    exclaim "Application loaded."
+    exclaim "Application #{Application.apps.map(&:name).join(', ')} loaded."
   end
   
   # Loads the framework.

data/lib/picky/query/allocation.rb

@@ -4,13 +4,13 @@ module Query
   #
   class Allocation
 
-    attr_reader   :count, :ids, :score, :combinations
-    attr_accessor :result_type
-
+    attr_reader :count, :ids, :score, :combinations, :result_type
+    
     #
     #
-    def initialize combinations
+    def initialize combinations, result_type
       @combinations = combinations
+      @result_type  = result_type
     end
 
     def hash
@@ -24,7 +24,7 @@ module Query
     # Scores its combinations and caches the result.
     #
     def calculate_score weights
-      @score || @score = @combinations.calculate_score(weights)
+      @score ||= @combinations.calculate_score(weights)
     end
 
     # Asks the combinations for the (intersected) ids.
@@ -61,7 +61,7 @@ module Query
     # Transform the allocation into result form.
     #
     def to_result
-      [self.result_type, self.score, self.count, @combinations.to_result, self.ids] if count = self.count > 0
+      [self.result_type, self.score, self.count, @combinations.to_result, self.ids] if self.count > 0
     end
 
     # Json representation of this allocation.

data/lib/picky/query/base.rb

@@ -15,9 +15,9 @@ module Query
     def initialize *index_types
       options      = Hash === index_types.last ? index_types.pop : {}
       @index_types = index_types
-      @weigher     = Weigher.new index_types
-      @tokenizer   = (options[:tokenizer]  || Tokenizers::Default::Query)
-      @weights     = (options[:weights] || Weights.new)
+      @weigher     = options[:weigher]   || Weigher.new(index_types)
+      @tokenizer   = options[:tokenizer] || Tokenizers::Default::Query
+      @weights     = options[:weights]   || Weights.new
     end
     
     # Convenience method.
@@ -63,13 +63,21 @@ module Query
     #
     # TODO Smallify.
     #
+    # TODO Rename: allocations
+    #
     def sorted_allocations tokens
       # Get the allocations.
       #
+      # TODO Pass in reduce_to_amount (aka max_allocations)
+      #
+      # TODO uniq, score, sort in there
+      #
       allocations = @weigher.allocations_for tokens
       
       # Callbacks.
       #
+      # TODO Reduce before sort?
+      #
       reduce allocations
       remove_from allocations
       
@@ -99,12 +107,12 @@ module Query
     def remove_from allocations
       allocations.remove(identifiers_to_remove) if remove_identifiers?
     end
-    # Override.
+    # Override. TODO No, redesign.
     #
     def identifiers_to_remove
-      @identifiers_to_remove || @identifiers_to_remove = []
+      @identifiers_to_remove ||= []
     end
-
+    
     # Packs the sorted allocations into results.
     #
     # This generates the id intersections. Lots of work going on.

data/lib/picky/query/combination.rb

@@ -9,13 +9,13 @@ module Query
   #
   class Combination
 
-    attr_reader :token, :bundle
+    attr_reader :token, :bundle, :category_name
 
     def initialize token, category
-      @token    = token
-      @category = category
-      @bundle   = category.bundle_for token
-      @text     = @token.text # don't want to use reset_similar already
+      @token         = token
+      @category_name = category.name
+      @bundle        = category.bundle_for token
+      @text          = @token.text # don't want to use reset_similar already
     end
     
     # Note: Required for uniq!
@@ -26,20 +26,24 @@ module Query
     
     # Returns the weight of this combination.
     #
+    # TODO Really cache?
+    #
     def weight
-      @weight || @weight = @bundle.weight(@text)
+      @weight ||= @bundle.weight(@text)
     end
     
     # Returns an array of ids for the given text.
     #
+    # TODO Really cache?
+    #
     def ids
-      @ids || @ids = @bundle.ids(@text)
+      @ids ||= @bundle.ids(@text)
     end
     
     # The identifier for this combination.
     #
     def identifier
-      @category.name
+      @category_name
     end
     
     # Is the identifier in the given identifiers?
@@ -62,7 +66,7 @@ module Query
     #  "exact title:Peter*:peter"
     #
     def to_s
-      "#{bundle.name} #{to_result.join(':')}"
+      "#{bundle.identifier} #{to_result.join(':')}"
     end
     
   end

data/lib/picky/query/combinations.rb

@@ -2,16 +2,15 @@ module Query
 
   # Combinations are a number of Combination-s.
   #
-  # They are, in effect, the core of an allocation.
+  # They are the core of an allocation.
   #
   class Combinations
 
-    attr_reader :type, :combinations
+    attr_reader :combinations
 
     delegate :empty?, :to => :@combinations
 
-    def initialize type, combinations = []
-      @type         = type # TODO Remove.
+    def initialize combinations = []
       @combinations = combinations
     end
 
@@ -22,13 +21,12 @@ module Query
     # Uses user specific weights to calculate a score for the combinations.
     #
     def calculate_score weights
-      @score ||= sum_score
-      @score + add_score(weights) # TODO Ok to just cache the weights?
+      total_score + weighted_score(weights)
     end
-    def sum_score
+    def total_score
       @combinations.sum &:weight
     end
-    def add_score weights
+    def weighted_score weights
       weights.score @combinations
     end
 
@@ -58,20 +56,18 @@ module Query
       #      this precondition for a fast algorithm is always given.
       #
       id_arrays.sort! { |this_array, that_array| this_array.size <=> that_array.size }
-
+      
       # Call the optimized C algorithm.
       #
       Performant::Array.memory_efficient_intersect id_arrays
     end
-
+    
+    # Wrap the combinations into an allocation with the result_type
     #
-    #
-    def pack_into_allocation
-      allocation = Allocation.new self
-      allocation.result_type = @type.result_type # TODO Rewrite.
-      allocation
+    def pack_into_allocation result_type
+      Allocation.new self, result_type
     end
-
+    
     # Filters the tokens and identifiers such that only identifiers
     # that are passed in, remain, including their tokens.
     #

data/lib/picky/query/weigher.rb

@@ -22,16 +22,12 @@ module Query
         
         # Optimization for ignoring tokens that allocate to nothing and
         # can be ignored.
-        # For example in a context search, where "florian" is not
+        # For example in a special search, where "florian" is not
         # mapped to city, zip, or category.
         #
         possible_combinations.compact!
         expanded_combinations = expand_combinations_from possible_combinations
         
-        # TODO Rewrite.
-        #
-        # expanded_combinations.map! { |expanded_combination| Combinations.new(index, expanded_combination) }
-        
         #
         #
         next previous_allocations if expanded_combinations.empty?
@@ -51,15 +47,22 @@ module Query
         #  [c,e]
         # ]
         #
-        expanded_combinations = expanded_combinations.shift.zip(*expanded_combinations)
+        expanded_combinations = expanded_combinations.shift.zip *expanded_combinations
         
         # Wrap into a real combination.
         #
-        expanded_combinations.map! { |expanded_combination| Combinations.new(index, expanded_combination) }
+        # expanded_combinations.map! { |expanded_combination| Combinations.new(expanded_combination).pack_into_allocation(index.result_type) }
         
         # Add the possible allocations to the ones we already have.
         #
-        previous_allocations + expanded_combinations.map(&:pack_into_allocation)
+        # previous_allocations + expanded_combinations.map(&:pack_into_allocation)
+        
+        
+        # Add the wrapped possible allocations to the ones we already have.
+        #
+        previous_allocations + expanded_combinations.map! do |expanded_combination|
+          Combinations.new(expanded_combination).pack_into_allocation(index.result_type) # TODO Do not extract result_type. Remove pack_into_allocation.
+        end
       end)
     end
     

data/lib/picky/query/weights.rb

@@ -35,20 +35,17 @@ module Query
     #
     # Just kidding. It's far more complicated than that. Ha ha ha ha ;)
     #
-    include Helpers::Cache
+    # Note: Cache this if more complicated weighings become necessary.
+    #
     def score combinations
-      # TODO Rewrite to use the category
+      # TODO Beautify?
       #
-      categories = combinations.map { |combination| combination.bundle.category }.clustered_uniq
+      # weight_for combinations.map(&:category).clustered_uniq_fast.map!(&:name)
       
-      # Note: Caching will not be necessary anymore if the
-      #       mapping is not necessary anymore.
+      # TODO combinations could cluster uniq as combinations are added (since combinations don't change).
       #
-      cached @weights_cache, categories do
-        categories.map! &:name
-        weight_for categories
-      end
+      weight_for combinations.map(&:category_name).clustered_uniq_fast
     end
-
+    
   end
 end

data/lib/picky/routing.rb

@@ -142,4 +142,15 @@ class Routing
     String === url ? %r{#{url}} : url
   end
   
+  # TODO Beautify.
+  #
+  def to_s
+    routes.instance_variable_get(:@routes).map do |route|
+      path_info = route.conditions[:path_info]
+      anchored = Rack::Mount::Utils.regexp_anchored?(path_info)
+      anchored_ok = anchored ? "\u2713" : " "
+      "#{anchored_ok}  #{path_info.source}"
+    end.join "\n"
+  end
+  
 end

data/lib/tasks/application.rake

@@ -1,5 +1,4 @@
 # desc "Loads the application, including its configuration."
 task :application => :framework do
-  puts "Running rake task 'application'."
   Loader.load_application
 end

data/lib/tasks/routes.rake

@@ -0,0 +1,7 @@
+desc "Shows the available URL paths"
+task :routes => :application do
+  puts "Note: Anchored (\u2713) regexps are faster, e.g. /\\A.*\\Z/ or /^.*$/.\n\n"
+  Application.apps.each do |app|
+    p app
+  end
+end

data/spec/lib/extensions/array_spec.rb

@@ -17,7 +17,25 @@ describe Array do
       left.should be_empty
     end
   end
-
+  
+  describe "clustered_uniq_fast" do
+    it "should generate a new array" do
+      ary = [:test1, :test2, :test1]
+      ary.clustered_uniq_fast.object_id.should_not == ary.object_id
+    end
+    it "should not change clusteredly unique arrays" do
+      [:test1, :test2, :test1].clustered_uniq_fast.should == [:test1, :test2, :test1]
+    end
+    it "should not skip interspersed elements" do
+      [:test1, :test1, :test2, :test1].clustered_uniq_fast.should == [:test1, :test2, :test1]
+    end
+    it "should work like uniq if no interspersed elements exist" do
+      [:test1, :test1, :test2, :test2, :test3].clustered_uniq_fast.should == [:test1, :test2, :test3]
+    end
+    it "is fast" do
+      performance_of { [:test1, :test1, :test2, :test2, :test3].clustered_uniq_fast }.should < 0.00001
+    end
+  end
   describe "clustered_uniq" do
     it "should generate a new array" do
       ary = [:test1, :test2, :test1]
@@ -32,6 +50,9 @@ describe Array do
     it "should work like uniq if no interspersed elements exist" do
       [:test1, :test1, :test2, :test2, :test3].clustered_uniq.should == [:test1, :test2, :test3]
     end
+    it "is fast" do
+      performance_of { [:test1, :test1, :test2, :test2, :test3].clustered_uniq }.should < 0.00001
+    end
   end
 
 end

data/spec/lib/index/category_spec.rb

@@ -15,6 +15,7 @@ describe Index::Category do
 
     @partial = stub :partial, :dump => nil
     @category.stub! :partial => @partial
+    @category.stub! :exclaim
   end
 
   describe 'dump_caches' do
@@ -179,9 +180,6 @@ describe Index::Category do
   end
 
   describe 'generate_caches' do
-    before(:each) do
-      @category.stub! :exclaim
-    end
     it 'should call three method in order' do
       @category.should_receive(:generate_caches_from_source).once.with().ordered
       @category.should_receive(:generate_partial).once.with().ordered

data/spec/lib/query/allocation_spec.rb

@@ -4,7 +4,7 @@ describe Query::Allocation do
   
   before(:each) do
     @combinations = stub :combinations
-    @allocation = Query::Allocation.new @combinations
+    @allocation = Query::Allocation.new @combinations, :some_result_type
   end
   
   describe "eql?" do
@@ -30,12 +30,11 @@ describe Query::Allocation do
     context "allocation.count > 0" do
       before(:each) do
         @allocation.stub! :count => 10
-        @allocation.stub! :result_type => :result_type
         @allocation.stub! :score => :score
         @allocation.stub! :ids => :ids
       end
       it "represents correctly" do
-        @allocation.to_s.should == "Allocation: result_type, score, 10, combinations_result, ids"
+        @allocation.to_s.should == "Allocation: some_result_type, score, 10, combinations_result, ids"
       end
     end
   end
@@ -105,9 +104,8 @@ describe Query::Allocation do
   describe 'to_result' do
     context 'with few combinations' do
       before(:each) do
-        @allocation = Query::Allocation.new stub(:combinations, :ids => [1,2,3], :to_result => [:some_result])
+        @allocation = Query::Allocation.new stub(:combinations, :ids => [1,2,3], :to_result => [:some_result]), :some_result_type
         @allocation.instance_variable_set :@score, :some_score
-        @allocation.result_type = :some_result_type
       end
       context 'with ids' do
         it 'should output an array of information' do
@@ -120,9 +118,8 @@ describe Query::Allocation do
     context 'with results' do
       before(:each) do
         combinations = stub :combinations, :ids => [1,2,3], :to_result => [:some_result1, :some_result2]
-        @allocation = Query::Allocation.new combinations
+        @allocation = Query::Allocation.new combinations, :some_result_type
         @allocation.instance_variable_set :@score, :some_score
-        @allocation.result_type = :some_result_type
       end
       context 'with ids' do
         it 'should output an array of information' do
@@ -134,7 +131,7 @@ describe Query::Allocation do
     end
     context 'without results' do
       before(:each) do
-        @allocation = Query::Allocation.new stub(:combinations, :ids => [], :to_result => [])
+        @allocation = Query::Allocation.new stub(:combinations, :ids => [], :to_result => []), :some_result_type
         @allocation.instance_variable_set :@score, :some_score
       end
       it 'should return nil' do
@@ -147,9 +144,8 @@ describe Query::Allocation do
 
   describe 'to_json' do
     before(:each) do
-      @allocation = Query::Allocation.new stub(:combination, :ids => [1,2,3,4,5,6,7], :to_result => [:some_result1, :some_result2])
+      @allocation = Query::Allocation.new stub(:combination, :ids => [1,2,3,4,5,6,7], :to_result => [:some_result1, :some_result2]), :some_result_type
       @allocation.instance_variable_set :@score, :some_score
-      @allocation.result_type = :some_result_type
     end
     it 'should output the correct json string' do
       @allocation.process! 20, 0
@@ -168,9 +164,9 @@ describe Query::Allocation do
 
   describe "<=>" do
     it "should sort higher first" do
-      first = Query::Allocation.new []
+      first = Query::Allocation.new [], :some_result_type
       first.instance_variable_set :@score, 20
-      second = Query::Allocation.new []
+      second = Query::Allocation.new [], :some_result_type
       second.instance_variable_set :@score, 10
 
       first.<=>(second).should == -1
@@ -179,11 +175,11 @@ describe Query::Allocation do
 
   describe "sort!" do
     it "should sort correctly" do
-      first = Query::Allocation.new :whatever
+      first = Query::Allocation.new :whatever, :some_result_type
       first.instance_variable_set :@score, 20
-      second = Query::Allocation.new :whatever
+      second = Query::Allocation.new :whatever, :some_result_type
       second.instance_variable_set :@score, 10
-      third = Query::Allocation.new :whatever
+      third = Query::Allocation.new :whatever, :some_result_type
       third.instance_variable_set :@score, 5
 
       allocations = [second, third, first]

data/spec/lib/query/combination_spec.rb

@@ -5,7 +5,7 @@ require 'spec_helper'
 describe 'Query::Combination' do
 
   before(:each) do
-    @bundle      = stub :bundle
+    @bundle      = stub :bundle, :identifier => :bundle_name
     @token       = stub :token, :text => :some_text, :partial => false, :similar? => true
     @category    = stub :category, :bundle_for => @bundle, :name => :some_category_name
 
@@ -14,7 +14,6 @@ describe 'Query::Combination' do
   
   describe "to_s" do
     it "shows the combination's info" do
-      @bundle.stub! :name => :bundle_name
       @token.stub! :to_result => :token_result
       
       @combination.to_s.should == 'bundle_name some_category_name:token_result'

data/spec/lib/query/combinations_spec.rb

@@ -7,17 +7,15 @@ describe 'Query::Combinations' do
   before(:each) do
     @combinations_ary = stub :combinations_ary
     
-    type = stub :type, :result_type => :some_type
-    
-    @combinations = Query::Combinations.new type, @combinations_ary
+    @combinations = Query::Combinations.new @combinations_ary
   end
   
   describe "pack_into_allocation" do
     it "return an Allocation" do
-      @combinations.pack_into_allocation.should be_kind_of(Query::Allocation)
+      @combinations.pack_into_allocation(:some_result_type).should be_kind_of(Query::Allocation)
     end
     it "returns an Allocation with specific result_type" do
-      @combinations.pack_into_allocation.result_type.should == :some_type
+      @combinations.pack_into_allocation(:some_result_type).result_type.should == :some_result_type
     end
   end
   
@@ -28,54 +26,54 @@ describe 'Query::Combinations' do
       
       @combinations_ary = [@combination1, @combination2]
       
-      @combinations = Query::Combinations.new :some_type, @combinations_ary
+      @combinations = Query::Combinations.new @combinations_ary
     end
     it "resultifies the combinations" do
       @combinations.to_result.should == [:result1, :result2]
     end
   end
   
-  describe "add_score" do
+  describe "weighted_score" do
     it "uses the weights' score method" do
       weights = stub :weights
       weights.should_receive(:score).once.with @combinations_ary
       
-      @combinations.add_score weights
+      @combinations.weighted_score weights
     end
   end
   
-  describe "sum_score" do
+  describe "total_score" do
     before(:each) do
       @combination1 = stub :combination1, :weight => 3.14
       @combination2 = stub :combination2, :weight => 2.76
       
       @combinations_ary = [@combination1, @combination2]
       
-      @combinations = Query::Combinations.new :some_type, @combinations_ary
+      @combinations = Query::Combinations.new @combinations_ary
     end
     it "sums the scores" do
-      @combinations.sum_score.should == 5.90
+      @combinations.total_score.should == 5.90
     end
   end
   
   describe "calculate_score" do
     before(:each) do
-      @combinations.stub! :sum_score => 0
-      @combinations.stub! :add_score => 0
+      @combinations.stub! :total_score => 0
+      @combinations.stub! :weighted_score => 0
     end
     it "first sums, then weighs" do
-      @combinations.should_receive(:sum_score).once.ordered.and_return 0
-      @combinations.should_receive(:add_score).once.ordered.and_return 0
+      @combinations.should_receive(:total_score).once.ordered.and_return 0
+      @combinations.should_receive(:weighted_score).once.ordered.and_return 0
       
       @combinations.calculate_score :anything
     end
     it "calls sum_score" do
-      @combinations.should_receive(:sum_score).once.with.and_return 0
+      @combinations.should_receive(:total_score).once.with.and_return 0
       
       @combinations.calculate_score :anything
     end
     it "calls sum_score" do
-      @combinations.should_receive(:add_score).once.with(:weights).and_return 0
+      @combinations.should_receive(:weighted_score).once.with(:weights).and_return 0
       
       @combinations.calculate_score :weights
     end
@@ -95,7 +93,7 @@ describe 'Query::Combinations' do
       @combination2 = stub :combination2, :in? => true
       @combination3 = stub :combination3, :in? => true
 
-      @combinations = Query::Combinations.new :some_type, [@combination1, @combination2, @combination3]
+      @combinations = Query::Combinations.new [@combination1, @combination2, @combination3]
     end
     it 'should remove the combinations' do
       @combinations.remove([:any]).should == [@combination1]
@@ -108,7 +106,7 @@ describe 'Query::Combinations' do
       @combination2 = stub :combination2, :in? => true
       @combination3 = stub :combination3, :in? => true
 
-      @combinations = Query::Combinations.new :some_type, [@combination1, @combination2, @combination3]
+      @combinations = Query::Combinations.new [@combination1, @combination2, @combination3]
     end
     it 'should filter the combinations' do
       @combinations.keep([:any]).should == [@combination2, @combination3]
@@ -120,7 +118,7 @@ describe 'Query::Combinations' do
       @combination1 = stub :combination1
       @combination2 = stub :combination2
       @combination3 = stub :combination3
-      @combinations = Query::Combinations.new :some_type, [@combination1, @combination2, @combination3]
+      @combinations = Query::Combinations.new [@combination1, @combination2, @combination3]
     end
     it "should intersect correctly" do
       @combination1.should_receive(:ids).once.with.and_return (1..100_000).to_a

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 9
-  - 3
-  version: 0.9.3
+  - 4
+  version: 0.9.4
 platform: ruby
 authors: 
 - Florian Hanke
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-29 00:00:00 +02:00
+date: 2010-10-30 00:00:00 +02:00
 default_executable: picky
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -129,6 +129,7 @@ files:
 - lib/tasks/cache.rake
 - lib/tasks/framework.rake
 - lib/tasks/index.rake
+- lib/tasks/routes.rake
 - lib/tasks/server.rake
 - lib/tasks/shortcuts.rake
 - lib/tasks/solr.rake