picky 4.12.1 → 4.12.2

data/lib/picky/backends/backend.rb

@@ -9,6 +9,8 @@ module Picky
       # This is the default behaviour and should be overridden
       # for different backends.
       #
+      # TODO Push down.
+      #
       
       # Returns an object that on #initial, #load returns
       # an object that responds to:
@@ -21,9 +23,9 @@ module Picky
       # an object that responds to:
       #   [:token] # => 1.23 (a weight)
       #
-      def create_weights bundle
-        json bundle.index_path(:weights)
-      end
+      # def create_weights bundle
+      #   json bundle.index_path(:weights)
+      # end
       # # Returns an object that on #initial, #load returns
       # # an object that responds to:
       # #   [:encoded] # => [:original, :original] (an array of original symbols this similarity encoded thing maps to)

data/lib/picky/backends/file/basic.rb

@@ -27,7 +27,7 @@ module Picky
           # This is the mapping file with the in-memory hash for the
           # file position/offset mappings.
           #
-          @mapping_file = Memory::JSON.new "#{cache_path}.file_mapping.#{extension}"
+          @mapping_file = Memory::JSON.new "#{cache_path}.file_mapping"
 
           @empty   = options[:empty]
           @initial = options[:initial]

data/lib/picky/backends/file/json.rb

@@ -65,7 +65,7 @@ module Picky
         def dump hash
           offset = 0
           mapping = {}
-
+          
           create_directory cache_path
           ::File.open(cache_path, 'w:utf-8') do |out_file|
             hash.each do |(key, object)|

data/lib/picky/backends/file.rb

@@ -9,10 +9,11 @@ module Picky
     #   ...[1,2,3,21,7,4,13,15]...
     #
     class File < Backend
-
-      # Returns an object that on #initial, #load returns an object that responds to:
-      #   [:encoded] # => [:original, :original] (an array of original symbols this similarity encoded thing maps to)
-      #
+      
+      def create_weights bundle
+        Memory::JSON.new bundle.index_path(:weights)
+      end
+      
       def create_similarity bundle
         json bundle.index_path(:similarity)
       end

data/lib/picky/backends/memory.rb

@@ -4,10 +4,10 @@ module Picky
 
     class Memory < Backend
       
-      # Returns an object that on #initial, #load returns
-      # an object that responds to:
-      #   [:encoded] # => [:original, :original] (an array of original symbols this similarity encoded thing maps to)
-      #
+      def create_weights bundle
+        JSON.new bundle.index_path(:weights)
+      end
+      
       def create_similarity bundle
         Marshal.new bundle.index_path(:similarity)
       end

data/lib/picky/backends/prepared/text.rb

@@ -49,6 +49,8 @@ module Picky
         #
         # Yields an id string and a token.
         #
+        # TODO Think about the comma - what if you have commas in the id?
+        #
         def retrieve
           id    = nil
           token = nil

data/lib/picky/backends/redis.rb

@@ -14,7 +14,7 @@ module Picky
         check_hiredis_gem
         check_redis_gem
 
-        @client    = options[:client] || ::Redis.new(:db => (options[:db] || 15))
+        @client   = options[:client] || ::Redis.new(:db => (options[:db] || 15))
         @realtime = options[:realtime]
       end
       def maybe_load_hiredis

data/lib/picky/bundle.rb

@@ -41,8 +41,8 @@ module Picky
                   :partial_strategy,
                   :similarity_strategy
 
-    delegate :[], :[]=,        :to => :configuration
-    delegate :index_directory, :to => :category
+    forward :[], :[]=,        :to => :configuration
+    forward :index_directory, :to => :category
     
     # TODO Move the strategies into options.
     #
@@ -142,7 +142,7 @@ module Picky
       end
     end
 
-    # If a key format is set, use it, else delegate to the category.
+    # If a key format is set, use it, else forward to the category.
     #
     def key_format
       @key_format || @category.key_format

data/lib/picky/categories.rb

@@ -4,18 +4,18 @@ module Picky
 
     attr_reader :categories, :category_hash
 
-    delegate :each,
-             :first,
-             :map,
-             :to => :categories
+    forward :each,
+            :first,
+            :map,
+            :to => :categories
 
-    each_delegate :cache,
-                  :dump,
-                  :empty,
-                  :inject,
-                  :reindex,
-                  :reset_backend,
-                  :to => :categories
+    each_forward :cache,
+                 :dump,
+                 :empty,
+                 :inject,
+                 :reindex,
+                 :reset_backend,
+                 :to => :categories
 
     # A list of indexed categories.
     #
@@ -37,14 +37,20 @@ module Picky
     #   To add the qualifiers to a search, you call this
     #   method.
     #
-    def mapper
-      @mapper ||= QualifierMapper.new self
+    def qualifier_mapper
+      @qualifier_mapper ||= QualifierMapper.new self
+    end
+    
+    # Resets the qualifier mapper used.
+    #
+    def reset_qualifier_mapper
+      @qualifier_mapper = nil
     end
 
     # Add the given category to the list of categories.
     #
     def << category
-      @mapper = nil # TODO Move. (Resets category mapping)
+      reset_qualifier_mapper # TODO Have an add method on QualifierMapper?
       categories << category
       category_hash[category.name] = category
     end
@@ -58,6 +64,10 @@ module Picky
     def raise_not_found category_name
       raise %Q{Index category "#{category_name}" not found. Possible categories: "#{categories.map(&:name).join('", "')}".}
     end
+    
+    def to_stats
+      map(&:name).join(', ')
+    end
 
     def to_s
       "#{self.class}(#{categories.join(', ')})"

data/lib/picky/categories_convenience.rb

@@ -4,8 +4,7 @@ module Picky
   #
   class Categories
 
-    each_delegate :each_bundle,
-                  :to => :categories
+    each_forward :each_bundle, :to => :categories
 
     def each_category &block
       categories.each &block

data/lib/picky/categories_indexed.rb

@@ -2,9 +2,7 @@ module Picky
 
   class Categories
 
-    each_delegate :load,
-                  :analyze,
-                  :to => :categories
+    each_forward :load, :analyze, :to => :categories
 
     # Return all possible combinations for the given token.
     #
@@ -64,7 +62,7 @@ module Picky
     # TODO Called too often?
     #
     def possible_categories token
-      token.predefined_categories(mapper) || categories
+      token.predefined_categories(qualifier_mapper) || categories
     end
 
   end

data/lib/picky/categories_indexing.rb

@@ -4,10 +4,10 @@ module Picky
 
     include Helpers::Indexing
 
-    each_delegate :cache,
-                  :clear,
-                  :prepare,
-                  :to => :categories
+    each_forward :cache,
+                 :clear,
+                 :prepare,
+                 :to => :categories
   end
 
 end

data/lib/picky/categories_realtime.rb

@@ -2,13 +2,13 @@ module Picky
 
   class Categories
 
-    each_delegate :remove,
-                  :add,
-                  :replace,
-                  :replace_from,
-                  :clear_realtime,
-                  :build_realtime_mapping,
-                  :to => :categories
+    each_forward :remove,
+                 :add,
+                 :replace,
+                 :replace_from,
+                 :clear_realtime,
+                 :build_realtime_mapping,
+                 :to => :categories
 
   end
 

data/lib/picky/character_substituters/west_european.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 #
-# THINK Does it also remove diaritics, like べ to へ?
+# THINK Does it also remove diacritics, like べ to へ?
 #
 module Picky
 

data/lib/picky/extensions/class.rb

@@ -2,11 +2,11 @@
 #
 class Class
 
-  def instance_delegate *method_names
+  def instance_forward *method_names
     method_names.each do |method_name|
-      module_eval(<<-DELEGATION, "(__DELEGATION__)", 1)
-def self.#{method_name}(*args, &block)\n  self.instance.#{method_name}(*args, &block)\nend
-DELEGATION
+      module_eval(<<-FORWARDING, "(__INSTANCE_FORWARDING__)", 1)
+def self.#{method_name}(*args, &block)\n  self.instance.#{method_name}(*args, &block)\nend\n
+FORWARDING
     end
   end
 

data/lib/picky/extensions/module.rb

@@ -1,15 +1,37 @@
 # The original Module class.
 #
 class Module
-
-  def each_delegate *methods
-    options = methods.pop
-    unless options.is_a?(Hash) && to = options[:to]
-      raise ArgumentError, "Multi delegation needs a target. Supply an options hash with a :to key as the last argument (e.g. delegate :something, :to => :an_array_reader)."
+  
+  def forward *methods
+    to = extract_to_from_options methods,
+           "Forwarding needs a target. Supply an options hash with a :to key as the last argument (e.g. forward :something, :to => :an_array_reader)."
+    forwarding methods do |method|
+      "def #{method}(*args, &block)\n#{to}.__send__(#{method.inspect}, *args, &block)\nend\n"
     end
-    methods.each do |method|
-      module_eval("def #{method}(*args, &block)\n#{to}.each{ |t| t.__send__(#{method.inspect}, *args, &block) }\nend\n", "(__DELEGATION__)", 1)
+  end
+  
+  def each_forward *methods
+    to = extract_to_from_options methods,
+           "Multi forwarding needs a target. Supply an options hash with a :to key as the last argument (e.g. each_forward :something, :to => :an_array_reader)."
+    forwarding methods do |method|
+      "def #{method}(*args, &block)\n#{to}.each{ |t| t.__send__(#{method.inspect}, *args, &block) }\nend\n"
     end
   end
+  
+  private
+  
+    def extract_to_from_options args, error_string
+      options = args.pop
+      unless options.is_a?(Hash) && to = options[:to]
+        raise ArgumentError, "Multi forwarding needs a target. Supply an options hash with a :to key as the last argument (e.g. each_forward :something, :to => :an_array_reader)."
+      end
+      to
+    end
+  
+    def forwarding methods, &method_definition
+      methods.each do |method|
+        module_eval method_definition[method], "(__FORWARDING__)", 1
+      end
+    end
 
 end

data/lib/picky/index.rb

@@ -89,12 +89,12 @@ module Picky
     attr_reader :name,
                 :categories
 
-    delegate :[],
-             :dump,
-             :each,
-             :inject,
-             :reset_backend,
-             :to => :categories
+    forward :[],
+            :dump,
+            :each,
+            :inject,
+            :reset_backend,
+            :to => :categories
 
     # Create a new index with a given source.
     #
@@ -140,23 +140,23 @@ module Picky
         @backend ||= Backends::Memory.new
       end
     end
-    
-    # Ignore the categories with these qualifiers.
-    #
-    # Example:
-    #   search = Search.new(index1, index2, index3) do
-    #     ignore :name, :first_name
-    #   end
-    #
-    # Cleans up / optimizes after being called.
-    #
-    # TODO This needs to move to the index.
+
+    # TODO Reinstate.
     #
-    def ignore *qualifiers
-      @ignored_categories ||= []
-      @ignored_categories += qualifiers.map { |qualifier| @mapper.map qualifier }.compact
-      @ignored_categories.uniq!
-    end
+    # # Ignore the categories with these qualifiers.
+    # #
+    # # Example:
+    # #   search = Search.new(index1, index2, index3) do
+    # #     ignore :name, :first_name
+    # #   end
+    # #
+    # # Cleans up / optimizes after being called.
+    # #
+    # def ignore *qualifiers
+    #   @ignored_categories ||= []
+    #   @ignored_categories += qualifiers.map { |qualifier| @qualifier_mapper.map qualifier }.compact
+    #   @ignored_categories.uniq!
+    # end
 
     # SYMBOLS.
     #
@@ -209,7 +209,7 @@ module Picky
     #
     def only *qualifiers
       raise "Sorry, Picky::Search#only has been removed in version."
-      # @mapper.restrict_to *qualifiers
+      # @qualifier_mapper.restrict_to *qualifiers
     end
     
     # The directory used by this index.
@@ -362,9 +362,10 @@ module Picky
       stats = <<-INDEX
 #{name} (#{self.class}):
 #{"source:            #{source}".indented_to_s}
-#{"categories:        #{categories.map(&:name).join(', ')}".indented_to_s}
+#{"categories:        #{categories.to_stats}".indented_to_s}
 INDEX
-      stats << "  result identifier: \"#{result_identifier}\"".indented_to_s unless result_identifier.to_s == name.to_s
+      stats << "result identifier: \"#{result_identifier}\"".indented_to_s unless result_identifier.to_s == name.to_s
+      stats << "\n"
       stats
     end
 

data/lib/picky/index_convenience.rb

@@ -4,9 +4,7 @@ module Picky
   #
   class Index
 
-    delegate :each_bundle,
-             :each_category,
-             :to => :categories
+    forward :each_bundle, :each_category, :to => :categories
 
   end
 

data/lib/picky/index_indexed.rb

@@ -4,11 +4,11 @@ module Picky
   #
   class Index
 
-    delegate :load,
-             :analyze,
-             :reindex,
-             :possible_combinations,
-             :to => :categories
+    forward :load,
+            :analyze,
+            :reindex,
+            :possible_combinations,
+            :to => :categories
 
     # Define how the results of this index are identified.
     # (Shown in the client, for example)

data/lib/picky/index_indexing.rb

@@ -5,11 +5,7 @@ module Picky
   class Index
     include Helpers::Indexing
 
-    # Delegators for indexing.
-    #
-    delegate :cache,
-             :clear,
-             :to => :categories
+    forward :cache, :clear, :to => :categories
 
     # Define an index tokenizer on the index.
     #
@@ -23,7 +19,7 @@ module Picky
     # on every category.
     #
     # Decides whether to use a parallel indexer or whether to
-    # delegate to each category to prepare themselves.
+    # forward to each category to prepare themselves.
     #
     def prepare scheduler = Scheduler.new
       if source.respond_to?(:each)

data/lib/picky/index_realtime.rb

@@ -4,13 +4,13 @@ module Picky
   #
   class Index
 
-    delegate :remove,  # aka "delete".
-             :add,     # aka "insert".
-             :replace, # aka "insert or update". Thus, not called update.
-             :replace_from,
-             :clear_realtime,
-             :build_realtime_mapping,
-             :to => :categories
+    forward :remove,  # aka "delete".
+            :add,     # aka "insert".
+            :replace, # aka "insert or update". Thus, not called update.
+            :replace_from,
+            :clear_realtime,
+            :build_realtime_mapping,
+            :to => :categories
 
     # Add at the end.
     #

data/lib/picky/indexers/base.rb

@@ -10,8 +10,8 @@ module Picky
 
       attr_reader :index_or_category
 
-      delegate :source,
-               :to => :index_or_category
+      forward :source,
+              :to => :index_or_category
 
       def initialize index_or_category
         @index_or_category = index_or_category

data/lib/picky/indexes.rb

@@ -3,7 +3,7 @@ module Picky
   # Holds all indexes and provides operations
   # for extracting and working on them.
   #
-  # Delegates a number of operations to the
+  # Forwards a number of operations to the
   # indexes.
   #
   class Indexes
@@ -11,12 +11,17 @@ module Picky
     attr_reader :indexes,
                 :index_mapping
 
-    delegate :size,
-             :each,
-             :to => :indexes
-
-    each_delegate :reindex,
-                  :to => :indexes
+    forward :size, :each, :to => :indexes
+    each_forward :reindex, :to => :indexes
+    instance_forward :clear,
+                     :clear_indexes,
+                     :register,
+                     :reindex,
+                     :[],
+                     :to_s,
+                     :size,
+                     :each,
+                     :each_category
 
     def initialize *indexes
       clear_indexes
@@ -32,16 +37,6 @@ module Picky
       name
     end
 
-    instance_delegate :clear,
-                      :clear_indexes,
-                      :register,
-                      :reindex,
-                      :[],
-                      :to_s,
-                      :size,
-                      :each,
-                      :each_category
-
     # Clears the indexes and the mapping.
     #
     def clear_indexes

data/lib/picky/indexes_convenience.rb

@@ -2,9 +2,7 @@ module Picky
 
   class Indexes
 
-    each_delegate :each_bundle,
-                  :each_category,
-                  :to => :indexes
+    each_forward :each_bundle, :each_category, :to => :indexes
 
   end
 

data/lib/picky/indexes_indexed.rb

@@ -4,11 +4,8 @@ module Picky
   #
   class Indexes
 
-    instance_delegate :load,
-                      :analyze
-
-    each_delegate :load,
-                  :to => :indexes
+    instance_forward :load, :analyze
+    each_forward :load, :to => :indexes
 
   end
 

data/lib/picky/indexes_indexing.rb

@@ -7,13 +7,9 @@ module Picky
     extend Helpers::Indexing
     include Helpers::Indexing
 
-    instance_delegate :clear,
-                      :tokenizer
+    instance_forward :clear, :tokenizer
 
-    each_delegate :cache,
-                  :clear,
-                  :prepare,
-                  :to => :indexes
+    each_forward :cache, :clear, :prepare, :to => :indexes
 
     # Overrides index from the helper.
     #

data/lib/picky/loader.rb

@@ -265,6 +265,7 @@ module Picky
         load_api
         load_logging
         load_relative 'source'
+        load_relative 'tokenizer/regexp_wrapper'
         load_relative 'tokenizer'
         # load_relative 'rack/harakiri' # Needs to be explicitly loaded/required.
         load_relative 'character_substituters/west_european'

data/lib/picky/query/allocation.rb

@@ -108,7 +108,7 @@ module Picky
 
       # Json representation of this allocation.
       #
-      # Note: Delegates to to_result.
+      # Note: Forwards to to_result.
       #
       def to_json options = {}
         MultiJson.encode to_result, options

data/lib/picky/query/allocations.rb

@@ -14,13 +14,13 @@ module Picky
     #
     class Allocations
 
-      delegate :each,
-               :empty?,
-               :first,
-               :inject,
-               :size,
-               :map,
-               :to => :@allocations
+      forward :each,
+              :empty?,
+              :first,
+              :inject,
+              :size,
+              :map,
+              :to => :@allocations
 
       def initialize allocations = []
         @allocations = allocations

data/lib/picky/query/boosts.rb

@@ -25,8 +25,7 @@ module Picky
 
       attr_reader :boosts
 
-      delegate :empty?,
-               :to => :boosts
+      forward :empty?, :to => :boosts
 
       # Needs a Hash of
       #   [:category_name1, :category_name2] => +3

data/lib/picky/query/combinations.rb

@@ -14,9 +14,9 @@ module Picky
 
       attr_reader :combinations
 
-      delegate :empty?,
-               :inject,
-               :to => :@combinations
+      forward :empty?,
+              :inject,
+              :to => :@combinations
 
       def initialize combinations = []
         @combinations = combinations