bundle_indexed.rb

module Picky

  # An indexed bundle is a number of memory/redis
  # indexes that compose the indexes for a single category:
  #  * core (inverted) index
  #  * weights index
  #  * similarity index
  #  * index configuration
  #
  # Indexed refers to them being indexed.
  # This class notably offers the methods:
  #  * load
  #  * clear
  #
  # To (re)load or clear the current indexes.
  #
  class Bundle

    # Get the ids for the given symbol.
    #
    # Returns a (potentially empty) array of ids.
    #
    # Note: If the backend wants to return a special
    # enumerable, the backend should do so.
    #
    def ids sym_or_string
      @inverted[sym_or_string] || []
      # THINK Place the key_format conversion here – or move into the backend?
      #
      # if @key_format
      #   class << self
      #     def ids
      #       (@inverted[sym_or_string] || []).map &@key_format
      #     end
      #   end
      # else
      #   class << self
      #     def ids
      #       @inverted[sym_or_string] || []
      #     end
      #   end
      # end
    end

    # Get a weight for the given symbol.
    #
    # Returns a number, or nil.
    #
    def weight sym_or_string
      @weights[sym_or_string]
    end

    # Get settings for this bundle.
    #
    # Returns an object.
    #
    def [] sym_or_string
      @configuration[sym_or_string]
    end

    # Loads all indexes.
    #
    # Loading loads index objects from the backend.
    # They should each respond to [] and return something appropriate.
    #
    def load
      load_inverted
      load_weights
      load_similarity
      load_configuration
      load_realtime
    end

    # Loads the core index.
    #
    def load_inverted
      self.inverted = @backend_inverted.load
    end
    # Loads the weights index.
    #
    def load_weights
      self.weights = @backend_weights.load unless @weight_strategy.respond_to?(:saved?) && !@weight_strategy.saved?
    end
    # Loads the similarity index.
    #
    def load_similarity
      self.similarity = @backend_similarity.load unless @similarity_strategy.respond_to?(:saved?) && !@similarity_strategy.saved?
    end
    # Loads the configuration.
    #
    def load_configuration
      self.configuration = @backend_configuration.load
    end
    # Loads the realtime mapping.
    #
    def load_realtime
      self.realtime = @backend_realtime.load
    end

    # Clears all indexes.
    #
    def clear
      clear_inverted
      clear_weights
      clear_similarity
      clear_configuration
      clear_realtime
    end

    # Clears the core index.
    #
    def clear_inverted
      inverted.clear
    end
    # Clears the weights index.
    #
    def clear_weights
      weights.clear
    end
    # Clears the similarity index.
    #
    def clear_similarity
      similarity.clear
    end
    # Clears the configuration.
    #
    def clear_configuration
      configuration.clear
    end
    # Clears the realtime mapping.
    #
    def clear_realtime
      realtime.clear
    end

  end

end