picky 1.5.2 → 1.5.3

data/lib/picky/internals/indexed/bundle/base.rb

@@ -1,7 +1,7 @@
 module Internals
 
   module Indexed # :nodoc:all
-    
+
     # TODO Rewrite.
     #
     # A Bundle is a number of indexes
@@ -11,7 +11,7 @@ module Internals
     # * *core* index (always used)
     # * *weights* index (always used)
     # * *similarity* index (used with similarity)
-    # 
+    #
     # In Picky, indexing is separated from the index
     # handling itself through a parallel structure.
     #
@@ -25,24 +25,26 @@ module Internals
     #   memory and looking up search data as fast as possible.
     #
     module Bundle
-    
+
       class Base
-    
+
         attr_reader   :identifier, :configuration
         attr_accessor :similarity_strategy
-      
+        attr_accessor :index, :weights, :similarity, :configuration
+
         delegate :[], :to => :configuration
-    
+        delegate :size, :to => :index
+
         def initialize name, configuration, similarity_strategy
           @identifier = "#{configuration.identifier}:#{name}"
-      
+
           @index         = {}
           @weights       = {}
           @similarity    = {}
-      
+
           @similarity_strategy = similarity_strategy
         end
-    
+
         # Get a list of similar texts.
         #
         # Note: Does not return itself.
@@ -53,7 +55,7 @@ module Internals
           similar_codes.delete text if similar_codes
           similar_codes || []
         end
-      
+
         # Loads all indexes.
         #
         def load
@@ -62,11 +64,53 @@ module Internals
           load_similarity
           load_configuration
         end
-      
+
+        # Loads the core index.
+        #
+        def load_index
+          # No loading needed.
+        end
+        # Loads the weights index.
+        #
+        def load_weights
+          # No loading needed.
+        end
+        # Loads the similarity index.
+        #
+        def load_similarity
+          # No loading needed.
+        end
+        # Loads the configuration.
+        #
+        def load_configuration
+          # No loading needed.
+        end
+
+        # Loads the core index.
+        #
+        def clear_index
+          # No loading needed.
+        end
+        # Loads the weights index.
+        #
+        def clear_weights
+          # No loading needed.
+        end
+        # Loads the similarity index.
+        #
+        def clear_similarity
+          # No loading needed.
+        end
+        # Loads the configuration.
+        #
+        def clear_configuration
+          # No loading needed.
+        end
+
       end
-    
+
     end
-    
+
   end
-  
+
 end

data/lib/picky/internals/indexed/bundle/memory.rb

@@ -3,11 +3,11 @@ module Internals
   # encoding: utf-8
   #
   module Indexed # :nodoc:all
-  
+
     #
     #
     module Bundle
-    
+
       # This is the _actual_ index (based on memory).
       #
       # Handles exact/partial index, weights index, and similarity index.
@@ -15,19 +15,24 @@ module Internals
       # Delegates file handling and checking to an *Indexed*::*Files* object.
       #
       class Memory < Base
-      
-        attr_accessor :index, :weights, :similarity, :configuration
-      
+
         delegate :[], :to => :configuration
-      
+
         def initialize name, configuration, *args
           super name, configuration, *args
-        
+
           @configuration = {} # A hash with config options.
-        
+
           @backend = Internals::Index::Files.new name, configuration
         end
-      
+
+        def to_s
+          <<-MEMORY
+Memory
+#{@backend.indented_to_s}
+MEMORY
+        end
+
         # Get the ids for the given symbol.
         #
         def ids sym
@@ -38,7 +43,7 @@ module Internals
         def weight sym
           @weights[sym]
         end
-      
+
         # Loads the core index.
         #
         def load_index
@@ -59,11 +64,32 @@ module Internals
         def load_configuration
           self.configuration = @backend.load_configuration
         end
-      
+
+        # Loads the core index.
+        #
+        def clear_index
+          self.index = {}
+        end
+        # Loads the weights index.
+        #
+        def clear_weights
+          self.weights = {}
+        end
+        # Loads the similarity index.
+        #
+        def clear_similarity
+          self.similarity = {}
+        end
+        # Loads the configuration.
+        #
+        def clear_configuration
+          self.configuration = {}
+        end
+
       end
-    
+
     end
-  
+
   end
-  
+
 end

data/lib/picky/internals/indexed/bundle/redis.rb

@@ -3,23 +3,23 @@ module Internals
   # encoding: utf-8
   #
   module Indexed # :nodoc:all
-  
+
     #
     #
     module Bundle
-    
+
       # This is the _actual_ index (based on Redis).
       #
       # Handles exact/partial index, weights index, and similarity index.
       #
       class Redis < Base
-      
+
         def initialize name, configuration, *args
           super name, configuration, *args
-        
+
           @backend = Internals::Index::Redis.new name, configuration
         end
-      
+
         # Get the ids for the given symbol.
         #
         # Ids are an array of string values in Redis.
@@ -39,32 +39,11 @@ module Internals
         def [] sym
           @backend.setting sym
         end
-      
-        # Loads the core index.
-        #
-        def load_index
-          # TODO check if it is there.
-        end
-        # Loads the weights index.
-        #
-        def load_weights
-          # TODO check if it is there.
-        end
-        # Loads the similarity index.
-        #
-        def load_similarity
-          # TODO check if it is there.
-        end
-        # Loads the configuration.
-        #
-        def load_configuration
-          # TODO check if it is there.
-        end
-      
+
       end
-    
+
     end
-  
+
   end
-  
+
 end

data/lib/picky/internals/indexed/categories.rb

@@ -1,14 +1,15 @@
 module Internals
 
   module Indexed
-  
+
     class Categories
-    
+
       attr_reader :categories, :category_hash, :ignore_unassigned_tokens
-    
+
       each_delegate :load_from_cache,
+                    :analyze,
                     :to => :categories
-    
+
       # A list of indexed categories.
       #
       # Options:
@@ -26,17 +27,21 @@ module Internals
       #
       def initialize options = {}
         clear
-      
+
         @ignore_unassigned_tokens = options[:ignore_unassigned_tokens] || false
       end
-    
+
+      def to_s
+        categories.indented_to_s
+      end
+
       # Clears both the array of categories and the hash of categories.
       #
       def clear
         @categories    = []
         @category_hash = {}
       end
-    
+
       # Add the given category to the list of categories.
       #
       def << category
@@ -48,7 +53,7 @@ module Internals
         #
         category_hash[category.name] = [category]
       end
-    
+
       # Return all possible combinations for the given token.
       #
       # This checks if it needs to also search through similar
@@ -60,7 +65,7 @@ module Internals
       end
       # Gets all similar tokens and puts together the possible combinations
       # for each found similar token.
-      # 
+      #
       def similar_possible_for token
         # Get as many similar tokens as necessary
         #
@@ -90,7 +95,7 @@ module Internals
           result + possible_for(token, possible)
         end
       end
-    
+
       # Returns possible Combinations for the token.
       #
       # Note: The preselected_categories param is an optimization.
@@ -122,14 +127,14 @@ module Internals
       # an existing category.
       #
       # Note: Returns nil if the user did not define one
-      #       or if he/she has defined a non-existing one. 
+      #       or if he/she has defined a non-existing one.
       #
       def user_defined_categories token
         category_hash[token.user_defined_category_name]
       end
-    
+
     end
-  
+
   end
-  
+
 end

data/lib/picky/internals/indexed/category.rb

@@ -1,90 +1,114 @@
 module Internals
 
   module Indexed
-  
+
     # An index category holds a exact and a partial index for a given category.
     #
     # For example an index category for names holds a exact and
     # a partial index bundle for names.
     #
     class Category
-    
+
       attr_accessor :exact
       attr_reader   :identifier, :name
       attr_writer   :partial
-    
+
       #
       #
       def initialize name, index, options = {}
         @name = name
-      
+
         configuration = Configuration::Index.new index, self
-      
+
         @identifier    = configuration.identifier
-      
+
         # TODO Push the defaults out into the index.
         #
         @partial_strategy = options[:partial] || Internals::Generators::Partial::Default
         similarity = options[:similarity] || Internals::Generators::Similarity::Default
-      
+
         bundle_class = options[:indexed_bundle_class] || Bundle::Memory
         @exact   = bundle_class.new :exact,   configuration, similarity
         @partial = bundle_class.new :partial, configuration, similarity
-      
+
         # @exact   = exact_lambda.call(@exact, @partial)   if exact_lambda   = options[:exact_lambda]
         # @partial = partial_lambda.call(@exact, @partial) if partial_lambda = options[:partial_lambda]
-      
+
         # TODO Extract?
         #
         Query::Qualifiers.add(configuration.category_name, generate_qualifiers_from(options) || [name])
       end
-    
+
+      def to_s
+<<-CATEGORY
+Category(#{name}):
+  Exact:
+#{exact.indented_to_s(4)}
+  Partial:
+#{partial.indented_to_s(4)}
+CATEGORY
+      end
+
       # TODO Move to Index.
       #
       def generate_qualifiers_from options
         options[:qualifiers] || options[:qualifier] && [options[:qualifier]]
       end
-    
+
       # Loads the index from cache.
       #
       def load_from_cache
-        timed_exclaim "Loading index #{identifier}."
+        timed_exclaim %Q{"#{identifier}": Loading index.}
         exact.load
         partial.load
       end
-    
+
+      # Loads, analyzes, and clears the index.
+      #
+      # Note: The idea is not to run this while the search engine is running.
+      #
+      # TODO Spec. Identifier is ok?
+      #
+      def analyze collector
+        collector[identifier] = {
+          :exact   => Analyzer.new.analyze(exact),
+          :partial => Analyzer.new.analyze(partial)
+        }
+        collector
+      end
+
       # Gets the weight for this token's text.
       #
       def weight token
         bundle_for(token).weight token.text
       end
-    
+
       # Gets the ids for this token's text.
       #
       def ids token
         bundle_for(token).ids token.text
       end
-    
+
       # Returns the right index bundle for this token.
       #
       def bundle_for token
         token.partial?? partial : exact
       end
-    
+
       # The partial strategy defines whether to really use the partial index.
       #
       def partial
         @partial_strategy.use_exact_for_partial?? @exact : @partial
       end
-    
+
       #
       #
       def combination_for token
         weight(token) && Internals::Query::Combination.new(token, self)
       end
-    
+
     end
-  
+
   end
-  
+
 end

data/lib/picky/internals/indexed/index.rb

@@ -1,38 +1,39 @@
 module Internals
 
   module Indexed
-  
+
     #
     #
     class Index
-    
+
       attr_reader :name, :result_identifier, :combinator, :categories
-    
+
       delegate :load_from_cache,
+               :analyze,
                :to => :categories
-    
+
       # TODO Externalize?
       #
       def initialize name, options = {}
         @name                     = name
-      
+
         @result_identifier        = options[:result_identifier] || name
         @bundle_class             = options[:indexed_bundle_class] # TODO This should actually be a fixed parameter.
         ignore_unassigned_tokens  = options[:ignore_unassigned_tokens] || false # TODO Move to query, somehow.
-      
+
         @categories = Categories.new ignore_unassigned_tokens: ignore_unassigned_tokens
       end
-    
+
       # TODO Doc. Externalize?
       #
       def define_category category_name, options = {}
         options = default_category_options.merge options
-      
+
         new_category = Category.new category_name, self, options
         categories << new_category
         new_category
       end
-    
+
       # By default, the category uses
       # * the index's bundle type.
       #
@@ -41,7 +42,7 @@ module Internals
           :indexed_bundle_class => @bundle_class
         }
       end
-    
+
       # Return the possible combinations for this token.
       #
       # A combination is a tuple <token, index_bundle>.
@@ -49,9 +50,18 @@ module Internals
       def possible_combinations token
         categories.possible_combinations_for token
       end
-    
+
+      def to_s
+        <<-INDEX
+Indexed(#{name}):
+  Result identifier: "#{result_identifier}"
+  Categories:
+  #{categories.indented_to_s}
+INDEX
+      end
+
     end
-  
+
   end
-  
+
 end

data/lib/picky/internals/indexed/wrappers/bundle/wrapper.rb

@@ -1,25 +1,43 @@
 module Indexed
   module Wrappers
-    
+
     # Per Bundle wrappers.
     #
     module Bundle
-      
+
       # Base wrapper. Just delegates all methods to the bundle.
       #
       class Wrapper
-        
+
         attr_reader :bundle
-        
+
         def initialize bundle
           @bundle = bundle
         end
-        
-        delegate :load, :ids, :weight, :identifier, :to => :@bundle
-        
+
+        delegate :load,
+                 :load_index,
+                 :load_weights,
+                 :load_similarity,
+                 :load_configuration,
+                 :clear_index,
+                 :clear_weights,
+                 :clear_similarity,
+                 :clear_configuration,
+                 :ids,
+                 :weight,
+                 :identifier,
+                 :analyze,
+                 :size,
+                 :index,
+                 :weights,
+                 :similarity,
+                 :configuration,
+                 :to => :@bundle
+
       end
-      
+
     end
-    
+
   end
 end

data/lib/picky/internals/indexers/serial.rb

@@ -65,7 +65,7 @@ module Indexers
       end
     end
     def indexing_message
-      timed_exclaim "INDEX #{@configuration}" # TODO from ...
+      timed_exclaim %Q{"#{@configuration.identifier}": Starting indexing.}
     end
     
   end