picky 3.4.3 → 3.5.0

data/aux/picky/cli.rb

@@ -14,7 +14,7 @@ module Picky
       executor.execute selector, args, params
     end
     def executor_class_for selector = nil
-      selector && @@mapping[selector.to_sym] || [Help]
+      selector && @@mapping[selector.intern] || [Help]
     end
 
     class Base

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

@@ -17,7 +17,7 @@ module Picky
         # Loads the index hash from json format.
         #
         def load
-          Yajl::Parser.parse ::File.open(cache_path, 'r'), symbolize_keys: true # TODO to_sym
+          Yajl::Parser.parse ::File.open(cache_path, 'r') # , symbolize_keys: true # TODO Symbols.
         end
 
         # Dumps the index hash in json format.

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

@@ -41,7 +41,7 @@ module Picky
         # * id,data\n
         # * id,data\n
         #
-        # Yields an id string and a symbol token.
+        # Yields an id string and a token.
         #
         def retrieve
           id    = nil
@@ -49,7 +49,7 @@ module Picky
           ::File.open(cache_path, 'r:utf-8') do |file|
             file.each_line do |line|
               id, token = line.split ?,, 2
-              yield id, (token.chomp! || token).to_sym # TODO to_sym
+              yield id, (token.chomp! || token)
             end
           end
         end

data/lib/picky/backends/redis/string.rb

@@ -31,6 +31,12 @@ module Picky
           client.hget namespace, key
         end
 
+        # Set a single value
+        #
+        def []= key, value
+          client.hset namespace, key, value
+        end
+
       end
 
     end

data/lib/picky/bundle.rb

@@ -50,7 +50,6 @@ module Picky
       # TODO Tidy up a bit.
       #
       @key_format = options[:key_format]
-      @prepared   = Backends::Memory::Text.new category.prepared_index_path
 
       @weights_strategy    = weights_strategy
       @partial_strategy    = partial_strategy

data/lib/picky/bundle_indexing.rb

@@ -28,134 +28,38 @@ module Picky
   #
   class Bundle
 
-    attr_reader :backend,
-                :prepared
+    attr_reader :backend
 
     # When indexing, clear only clears the inverted index.
     #
-    delegate :clear, :to => :inverted
-
-    # Sets up a piece of the index for the given token.
-    #
-    def initialize_inverted_index_for token
-      self.inverted[token] ||= []
-    end
-
-    # Generation
-    #
-
-    # This method
-    # * Loads the base index from the "prepared..." file.
-    # * Generates derived indexes.
-    # * Dumps all the indexes into files.
-    #
-    def generate_caches_from_source
-      load_from_prepared_index_file
-      generate_caches_from_memory
-    end
-    # Generates derived indexes from the index and dumps.
-    #
-    # Note: assumes that there is something in the index
-    #
-    def generate_caches_from_memory
-      cache_from_memory_generation_message
-      generate_derived
-    end
-    def cache_from_memory_generation_message
-      timed_exclaim %Q{"#{identifier}": Caching from intermediate in-memory index.}
-    end
-
-    # Generates the weights and similarity from the main index.
-    #
-    def generate_derived
-      generate_weights
-      generate_similarity
-    end
+    delegate :clear,
+             :to => :inverted
 
     # "Empties" the index(es) by getting a new empty
     # internal backend instance.
     #
     def empty
       empty_inverted
+      empty_weights
+      empty_similarity
       empty_configuration
     end
     def empty_inverted
       @inverted = @backend_inverted.empty
     end
-    def empty_configuration
-      @configuration = @backend_configuration.empty
-    end
-
-    # Load the data from the db.
-    #
-    def load_from_prepared_index_file
-      load_from_prepared_index_generation_message
-      retrieve
-    end
-    def load_from_prepared_index_generation_message
-      timed_exclaim %Q{"#{identifier}": Loading prepared data into memory.}
+    def empty_weights
+      @weights = @backend_weights.empty
     end
-    # Retrieves the prepared index data into the index.
-    #
-    # This is in preparation for generating
-    # derived indexes (like weights, similarity)
-    # and later dumping the optimized index.
-    #
-    # TODO Move this out to the category?
-    #
-    # Note: The clean way to do this would be to
-    #       self.inverted.values.each &:uniq!
-    #
-    # Note 2:
-    #   initialize_inverted_index_for token
-    #   id = id.send(format)
-    #   next if last_id == id
-    #   self.inverted[token] << id
-    #   last_id = id
-    #
-    def retrieve
-      format = key_format || :to_i
-      empty_inverted
-      id, last_id = nil, nil
-      prepared.retrieve do |id, token|
-        initialize_inverted_index_for token
-        self.inverted[token] << id.send(format)
-      end
-      self.inverted.values.each &:uniq!
+    def empty_similarity
+      @similarity = @backend_similarity.empty
     end
-
-    # Generate a partial index from the given exact inverted index.
-    #
-    def generate_partial_from exact_inverted_index
-      timed_exclaim %Q{"#{identifier}": Generating partial index for index.}
-      self.inverted = exact_inverted_index
-      self.generate_partial
-      self
-    end
-
-    # Generates a new index (writes its index) using the
-    # partial caching strategy of this bundle.
-    #
-    def generate_partial
-      self.inverted = partial_strategy.generate_from self.inverted
-    end
-    # Generates a new weights index (writes its index) using the
-    # given weight caching strategy.
-    #
-    def generate_weights
-      self.weights = weights_strategy.generate_from self.inverted
-    end
-    # Generates a new similarity index (writes its index) using the
-    # given similarity caching strategy.
-    #
-    def generate_similarity
-      self.similarity = similarity_strategy.generate_from self.inverted
+    def empty_configuration
+      @configuration = @backend_configuration.empty
     end
 
     # Saves the indexes in a dump file.
     #
     def dump
-      timed_exclaim %Q{"#{identifier}": Dumping data.}
       dump_inverted
       dump_similarity
       dump_weights

data/lib/picky/bundle_realtime.rb

@@ -32,7 +32,9 @@ module Picky
 
     # Returns a reference to the array where the id has been added.
     #
-    def add id, sym
+    # TODO Rename sym.
+    #
+    def add id, sym, where = :unshift
       ary = @inverted[sym]
 
       syms = @realtime_mapping[id]
@@ -42,12 +44,12 @@ module Picky
       #
       ids = if syms.include? sym
         ids = @inverted[sym]
-        ids.delete  id # Move id
-        ids.unshift id # to front
+        ids.delete  id
+        ids.send where, id
       else
         syms << sym
         ids = @inverted[sym] ||= []
-        ids.unshift id
+        ids.send where, id
       end
 
       # Weights.
@@ -60,21 +62,27 @@ module Picky
         similarity = @similarity[encoded] ||= []
         if similarity.include? sym
           similarity.delete sym  # Not completely correct, as others will also be affected, but meh.
-          similarity.unshift sym #
+          similarity.send where, sym #
         else
-          similarity.unshift sym
+          similarity.send where, sym
         end
       end
     end
 
     # Partializes the text and then adds each.
     #
-    def add_partialized id, text
+    def add_partialized id, text, where = :unshift
       self.partial_strategy.each_partial text do |partial_text|
-        add id, partial_text
+        add id, partial_text, where
       end
     end
 
+    # Clears the realtime mapping.
+    #
+    def clear_realtime_mapping
+      @realtime_mapping.clear
+    end
+
   end
 
 end

data/lib/picky/calculations/location.rb

@@ -11,37 +11,41 @@ module Picky
     #
     class Location
 
-      attr_reader :minimum, :precision, :grid
+      attr_reader :anchor,
+                  :precision,
+                  :grid
 
-      def initialize user_grid, precision = nil
-        @user_grid = user_grid
-        @precision = precision || 1
-        @grid      = @user_grid / (@precision + 0.5)
+      def initialize user_grid, anchor = 0.0, precision = nil
+        @user_grid  = user_grid
+        @precision  = precision || 1
+        @grid       = @user_grid / (@precision + 0.5)
+
+        self.anchor = anchor
       end
 
-      def minimum= minimum
+      def anchor= value
         # Add a margin of 1 user grid.
         #
-        minimum -= @user_grid
+        value -= @user_grid
 
         # Add plus 1 grid so that the index key never falls on 0.
         # Why? to_i maps by default to 0.
         #
-        minimum -= @grid
+        value -= @grid
 
-        @minimum = minimum
+        @anchor = value
       end
 
       #
       #
       def add_margin length
-        @minimum -= length
+        @anchor -= length
       end
 
       #
       #
-      def recalculated_range location
-        range recalculate(location)
+      def calculated_range location
+        range calculate(location)
       end
       #
       #
@@ -50,8 +54,8 @@ module Picky
       end
       #
       #
-      def recalculate location
-        ((location - @minimum) / @grid).floor
+      def calculate location
+        ((location - @anchor) / @grid).floor
       end
 
     end

data/lib/picky/categories.rb

@@ -40,7 +40,7 @@ module Picky
     # Find a given category in the categories.
     #
     def [] category_name
-      category_name = category_name.to_sym
+      category_name = category_name.intern
       category_hash[category_name] || raise_not_found(category_name)
     end
     def raise_not_found category_name

data/lib/picky/category.rb

@@ -4,7 +4,8 @@ module Picky
 
     attr_reader :name,
                 :exact,
-                :partial
+                :partial,
+                :prepared
 
     # Mandatory params:
     #  * name: Category name to use as identifier and file names.
@@ -20,6 +21,7 @@ module Picky
     #  * weights: Query::Weights.new( [:category1, :category2] => +2, ... )
     #  * tokenizer: Use a subclass of Tokenizers::Base that implements #tokens_for and #empty_tokens.
     #  * key_format: What this category's keys are formatted with (default is :to_i)
+    #  * use_symbols: Whether to use symbols internally instead of strings.
     #
     def initialize name, index, options = {}
       @name  = name
@@ -31,6 +33,7 @@ module Picky
       @from       = options[:from]
       @tokenizer  = options[:tokenizer]
       @key_format = options[:key_format]
+      # @symbols    = options[:use_symbols] || index.use_symbols? # TODO Symbols.
       @qualifiers = extract_qualifiers_from options
 
       weights    = options[:weights]    || Generators::Weights::Default
@@ -46,6 +49,8 @@ module Picky
       else
         @partial = Bundle.new :partial, self, index.backend, weights, partial, no_similarity, options
       end
+
+      @prepared = Backends::Memory::Text.new prepared_index_path
     end
 
     # Indexes and reloads the category.
@@ -58,6 +63,7 @@ module Picky
     def dump
       exact.dump
       partial.dump
+      timed_exclaim %Q{"#{identifier}": Generated -> #{index_directory.gsub("#{PICKY_ROOT}/", '')}.}
     end
 
     # Index name.

data/lib/picky/category_indexed.rb

@@ -8,6 +8,7 @@ module Picky
     #
     def load_from_cache
       timed_exclaim %Q{"#{identifier}": Loading index from cache.}
+      clear_realtime_mapping
       exact.load
       partial.load
     end

data/lib/picky/category_indexing.rb

@@ -24,9 +24,12 @@ module Picky
         indexer.index [self]
       end
     end
+
+    # Empty all the indexes.
+    #
     def empty
       exact.empty
-      partial.empty_configuration
+      partial.empty
     end
 
     # Take a data snapshot if the source offers it.
@@ -44,22 +47,17 @@ module Picky
     # Generates all caches for this category.
     #
     def cache
-      generate_caches_from_source
-      generate_partial
-      generate_caches_from_memory
+      empty
+      retrieve
       dump
-      timed_exclaim %Q{"#{identifier}": Caching finished.}
+      clear_realtime_mapping # TODO To call or not to call, that is the question.
     end
-    # Generate the cache data.
+
+    # Retrieves the prepared index data into the indexes and
+    # generates the necessary derived indexes.
     #
-    def generate_caches_from_source
-      exact.generate_caches_from_source
-    end
-    def generate_partial
-      partial.generate_partial_from exact.inverted
-    end
-    def generate_caches_from_memory
-      partial.generate_caches_from_memory
+    def retrieve
+      prepared.retrieve { |id, token| add_tokenized_token id, token, :<< }
     end
 
     # Return an appropriate source.
@@ -80,12 +78,14 @@ module Picky
 
     # Return the key format.
     #
-    # If the source has no key format, and
-    # none is defined on this category, ask
+    # If no key_format is defined on the category
+    # and the source has no key format, ask
     # the index for one.
     #
+    # Default is to_i.
+    #
     def key_format
-      source.respond_to?(:key_format) && source.key_format || @key_format || @index.key_format
+      @key_format ||= source.respond_to?(:key_format) && source.key_format || @index.key_format || :to_i
     end
 
     # Where the data is taken from.

data/lib/picky/category_realtime.rb

@@ -13,29 +13,41 @@ module Picky
     # Adds and indexes this category of the
     # given object.
     #
-    def add object
+    def add object, where = :unshift
       tokens, _ = tokenizer.tokenize object.send(from)
-      add_tokenized object.id, tokens
+      add_tokenized object.id, tokens, where
     end
 
     # Removes the object's id, and then
     # adds it again.
     #
-    def replace object
+    def replace object, where = :unshift
       remove object.id
-      add object
+      add object, where
     end
 
     # For the given id, adds the list of
     # strings to the index for the given id.
     #
-    def add_tokenized id, tokens
-      tokens.each do |text|
-        next unless text
-        text = text.to_sym # TODO to_sym
-        exact.add id, text
-        partial.add_partialized id, text
-      end
+    def add_tokenized id, tokens, where = :unshift
+      tokens.each { |text| add_tokenized_token id, text, where }
+    end
+
+    #
+    #
+    def add_tokenized_token id, text, where = :unshift
+      return unless text
+      id   = id.send key_format # TODO Speed this up!
+      # text = text.to_sym if @symbols # TODO Symbols.
+      exact.add id, text, where
+      partial.add_partialized id, text, where
+    end
+
+    # Clears the realtime mapping.
+    #
+    def clear_realtime_mapping
+      exact.clear_realtime_mapping
+      partial.clear_realtime_mapping
     end
 
   end