lib/picky/bundle.rb in picky-2.7.0 vs lib/picky/bundle.rb in picky-3.0.0.pre1

@@ -1,62 +1,87 @@
-# A Bundle is a number of indexes
-# per [index, category] combination.
-#
-# At most, there are three indexes:
-# * *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.
-#
-# Both use methods provided by this base class, but
-# have very different goals:
-#
-# * *Indexing*::*Bundle*::*Base* is just concerned with creating index
-#   files / redis entries and providing helper functions to e.g. check
-#   the indexes.
-#
-# * *Index*::*Bundle*::*Base* is concerned with loading these index files into
-#   memory / redis and looking up search data as fast as possible.
-#
-class Bundle
+module Picky
+  # A Bundle is a number of indexes
+  # per [index, category] combination.
+  #
+  # At most, there are three indexes:
+  # * *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.
+  #
+  # Both use methods provided by this base class, but
+  # have very different goals:
+  #
+  # * *Indexing*::*Bundle*::*Base* is just concerned with creating index
+  #   files / redis entries and providing helper functions to e.g. check
+  #   the indexes.
+  #
+  # * *Index*::*Bundle*::*Base* is concerned with loading these index files into
+  #   memory / redis and looking up search data as fast as possible.
+  #
+  class Bundle
 
-  attr_reader   :identifier,
-                :files
-  attr_accessor :inverted,
-                :weights,
-                :similarity,
-                :configuration,
-                :similarity_strategy
+    attr_reader :name,
+                :category
 
-  delegate :clear,    :to => :inverted
-  delegate :[], :[]=, :to => :configuration
+    attr_accessor :inverted,
+                  :weights,
+                  :similarity,
+                  :configuration,
+                  :similarity_strategy
 
-  def initialize name, category, similarity_strategy
-    @identifier    = "#{category.identifier}:#{name}"
-    @files         = Backend::Files.new name, category
+    delegate :clear,           :to => :inverted
+    delegate :[], :[]=,        :to => :configuration
+    delegate :index_directory, :to => :category
 
-    @inverted      = {}
-    @weights       = {}
-    @similarity    = {}
-    @configuration = {} # A hash with config options.
+    def initialize name, category, similarity_strategy, options = {}
+      @name          = name
+      @category      = category
 
-    @similarity_strategy = similarity_strategy
-  end
+      @inverted      = {}
+      @weights       = {}
+      @similarity    = {}
+      @configuration = {} # A hash with config options.
 
-  # Get a list of similar texts.
-  #
-  # Note: Does not return itself.
-  #
-  def similar text
-    code = similarity_strategy.encoded text
-    similar_codes = code && @similarity[code]
-    similar_codes.delete text if similar_codes
-    similar_codes || []
-  end
+      @similarity_strategy = similarity_strategy
+    end
+    def identifier
+      "#{category.identifier}:#{name}"
+    end
 
-  def to_s
-    "#{self.class}(#{identifier}, #{files})"
-  end
+    # Get a list of similar texts.
+    #
+    # Note: Does not return itself.
+    #
+    def similar text
+      code = similarity_strategy.encoded text
+      similar_codes = code && @similarity[code]
+      similar_codes.delete text if similar_codes
+      similar_codes || []
+    end
 
+    # If a key format is set, use it, else delegate to the category.
+    #
+    def key_format
+      @key_format || @category.key_format
+    end
+
+    # Path and partial filename of a specific subindex.
+    #
+    # Subindexes are:
+    #  * inverted index
+    #  * weights index
+    #  * partial index
+    #  * similarity index
+    #
+    def index_path type
+      ::File.join index_directory, "#{category.name}_#{name}_#{type}"
+    end
+
+    def to_s
+      "#{self.class}(#{identifier})"
+    end
+
+  end
 end
\ No newline at end of file