picky 2.7.0 → 3.0.0.pre1

data/lib/picky/backend/base.rb

@@ -1,123 +1,119 @@
-module Backend
-
-  class Base
-
-    attr_reader :bundle_name,
-                :prepared,
-                :inverted,
-                :weights,
-                :similarity,
-                :configuration,
-                :category,
-                :identifier
-
-    delegate :index_name, :category_name, :to => :@category
-
-    def initialize bundle_name, category
-      @identifier  = "#{category.identifier}:#{bundle_name}"
-      @bundle_name = bundle_name
-      @category    = category
-      @prepared    = File::Text.new category.prepared_index_path
-    end
-
-    # Delegators.
-    #
-
-    # Retrieving data.
-    #
-    def retrieve &block
-      prepared.retrieve &block
-    end
-
-    # Dumping.
-    #
-    def dump_inverted inverted_hash
-      timed_exclaim %Q{"#{identifier}":   => #{inverted}.}
-      inverted.dump inverted_hash
-    end
-    def dump_weights weights_hash
-      timed_exclaim %Q{"#{identifier}":   => #{weights}.}
-      weights.dump weights_hash
-    end
-    def dump_similarity similarity_hash
-      timed_exclaim %Q{"#{identifier}":   => #{similarity}.}
-      similarity.dump similarity_hash
-    end
-    def dump_configuration configuration_hash
-      timed_exclaim %Q{"#{identifier}":   => #{configuration}.}
-      configuration.dump configuration_hash
-    end
-
-    # Loading.
-    #
-    def load_inverted
-      inverted.load
-    end
-    def load_similarity
-      similarity.load
-    end
-    def load_weights
-      weights.load
-    end
-    def load_configuration
-      configuration.load
-    end
-
-    # Cache ok?
-    #
-    def inverted_cache_ok?
-      inverted.cache_ok?
-    end
-    def similarity_cache_ok?
-      similarity.cache_ok?
-    end
-    def weights_cache_ok?
-      weights.cache_ok?
-    end
-
-    # Cache small?
-    #
-    def inverted_cache_small?
-      inverted.cache_small?
-    end
-    def similarity_cache_small?
-      similarity.cache_small?
-    end
-    def weights_cache_small?
-      weights.cache_small?
-    end
-
-    # Copies the indexes to the "backup" directory.
-    #
-    def backup
-      inverted.backup
-      weights.backup
-      similarity.backup
-      configuration.backup
-    end
-
-    # Restores the indexes from the "backup" directory.
-    #
-    def restore
-      inverted.restore
-      weights.restore
-      similarity.restore
-      configuration.restore
-    end
-
-    # Delete all index files.
-    #
-    def delete
-      inverted.delete
-      weights.delete
-      similarity.delete
-      configuration.delete
-    end
+module Picky
+
+  module Backend
+
+    class Base
+
+      attr_reader :bundle,
+                  :inverted,
+                  :weights,
+                  :similarity,
+                  :configuration
+
+      delegate :identifier,
+               :to => :bundle
+
+      def initialize bundle
+        @bundle = bundle
+      end
+      def identifier
+        bundle.identifier
+      end
+
+      # Delegators.
+      #
+
+      # Dumping.
+      #
+      def dump_inverted inverted_hash
+        timed_exclaim %Q{"#{identifier}":   => #{inverted}.}
+        inverted.dump inverted_hash
+      end
+      def dump_weights weights_hash
+        timed_exclaim %Q{"#{identifier}":   => #{weights}.}
+        weights.dump weights_hash
+      end
+      def dump_similarity similarity_hash
+        timed_exclaim %Q{"#{identifier}":   => #{similarity}.}
+        similarity.dump similarity_hash
+      end
+      def dump_configuration configuration_hash
+        timed_exclaim %Q{"#{identifier}":   => #{configuration}.}
+        configuration.dump configuration_hash
+      end
+
+      # Loading.
+      #
+      def load_inverted
+        inverted.load
+      end
+      def load_similarity
+        similarity.load
+      end
+      def load_weights
+        weights.load
+      end
+      def load_configuration
+        configuration.load
+      end
+
+      # Cache ok?
+      #
+      def inverted_cache_ok?
+        inverted.cache_ok?
+      end
+      def similarity_cache_ok?
+        similarity.cache_ok?
+      end
+      def weights_cache_ok?
+        weights.cache_ok?
+      end
+
+      # Cache small?
+      #
+      def inverted_cache_small?
+        inverted.cache_small?
+      end
+      def similarity_cache_small?
+        similarity.cache_small?
+      end
+      def weights_cache_small?
+        weights.cache_small?
+      end
+
+      # Copies the indexes to the "backup" directory.
+      #
+      def backup
+        inverted.backup
+        weights.backup
+        similarity.backup
+        configuration.backup
+      end
+
+      # Restores the indexes from the "backup" directory.
+      #
+      def restore
+        inverted.restore
+        weights.restore
+        similarity.restore
+        configuration.restore
+      end
+
+      # Delete all index files.
+      #
+      def delete
+        inverted.delete
+        weights.delete
+        similarity.delete
+        configuration.delete
+      end
+
+      #
+      #
+      def to_s
+        "#{self.class}(#{bundle.identifier})"
+      end
 
-    #
-    #
-    def to_s
-      "#{self.class}(#{prepared}, #{bundle_name}, #{category.identifier})"
     end
 
   end

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

@@ -1,105 +1,109 @@
-module Backend
+module Picky
 
-  # Handles all aspects of index files, such as dumping/loading.
-  #
-  module File
+  module Backend
 
-    # Base class for all index files.
+    # Handles all aspects of index files, such as dumping/loading.
     #
-    # Provides necessary helper methods for its
-    # subclasses.
-    # Not directly useable, as it does not provide
-    # dump/load methods.
-    #
-    class Basic
-
-      # This file's location.
-      #
-      attr_reader :cache_path
-
-      # An index cache takes a path, without file extension,
-      # which will be provided by the subclasses.
-      #
-      def initialize cache_path
-        @cache_path = "#{cache_path}.#{extension}"
-      end
-
-      # The default extension for index files is "index".
-      #
-      def extension
-        :index
-      end
-
-      # Will copy the index file to a location that
-      # is in a directory named "backup" right under
-      # the directory the index file is in.
-      #
-      def backup
-        prepare_backup backup_directory
-        FileUtils.cp cache_path, target, verbose: true
-      end
-
-      # The backup directory of this file.
-      # Equal to the file's dirname plus /backup
-      #
-
-      def backup_directory
-        ::File.join ::File.dirname(cache_path), 'backup'
-      end
-
-      # Prepares the backup directory for the file.
-      #
-      def prepare_backup target
-        FileUtils.mkdir target unless Dir.exists?(target)
-      end
-
-      # Copies the file from its backup location back
-      # to the original location.
-      #
-      def restore
-        FileUtils.cp backup_file_path_of(cache_path), cache_path, verbose: true
-      end
-
-      # The backup filename.
-      #
-      def backup_file_path_of path
-        dir, name = ::File.split path
-        ::File.join dir, 'backup', name
-      end
-
-      # Deletes the file.
-      #
-      def delete
-        `rm -Rf #{cache_path}`
-      end
-
-      # Checks.
-      #
+    module File
+
+      # Base class for all index files.
+      #
+      # Provides necessary helper methods for its
+      # subclasses.
+      # Not directly useable, as it does not provide
+      # dump/load methods.
+      #
+      class Basic
+
+        # This file's location.
+        #
+        attr_reader :cache_path
+
+        # An index cache takes a path, without file extension,
+        # which will be provided by the subclasses.
+        #
+        def initialize cache_path
+          @cache_path = "#{cache_path}.#{extension}"
+        end
+
+        # The default extension for index files is "index".
+        #
+        def extension
+          :index
+        end
+
+        # Will copy the index file to a location that
+        # is in a directory named "backup" right under
+        # the directory the index file is in.
+        #
+        def backup
+          prepare_backup backup_directory
+          FileUtils.cp cache_path, target, verbose: true
+        end
+
+        # The backup directory of this file.
+        # Equal to the file's dirname plus /backup
+        #
+
+        def backup_directory
+          ::File.join ::File.dirname(cache_path), 'backup'
+        end
+
+        # Prepares the backup directory for the file.
+        #
+        def prepare_backup target
+          FileUtils.mkdir target unless Dir.exists?(target)
+        end
+
+        # Copies the file from its backup location back
+        # to the original location.
+        #
+        def restore
+          FileUtils.cp backup_file_path_of(cache_path), cache_path, verbose: true
+        end
+
+        # The backup filename.
+        #
+        def backup_file_path_of path
+          dir, name = ::File.split path
+          ::File.join dir, 'backup', name
+        end
+
+        # Deletes the file.
+        #
+        def delete
+          `rm -Rf #{cache_path}`
+        end
+
+        # Checks.
+        #
+
+        # Is this cache file suspiciously small?
+        # (less than 8 Bytes of size)
+        #
+        def cache_small?
+          size_of(cache_path) < 8
+        end
+        # Is the cache ok? (existing and larger than
+        # zero Bytes in size)
+        #
+        # A small cache is still ok.
+        #
+        def cache_ok?
+          size_of(cache_path) > 0
+        end
+        # Extracts the size of the file in Bytes.
+        #
+        def size_of path
+          `ls -l #{path} | awk '{print $5}'`.to_i
+        end
+
+        #
+        #
+        def to_s
+          "#{self.class}(#{cache_path})"
+        end
 
-      # Is this cache file suspiciously small?
-      # (less than 8 Bytes of size)
-      #
-      def cache_small?
-        size_of(cache_path) < 8
-      end
-      # Is the cache ok? (existing and larger than
-      # zero Bytes in size)
-      #
-      # A small cache is still ok.
-      #
-      def cache_ok?
-        size_of(cache_path) > 0
-      end
-      # Extracts the size of the file in Bytes.
-      #
-      def size_of path
-        `ls -l #{path} | awk '{print $5}'`.to_i
-      end
-
-      #
-      #
-      def to_s
-        "#{self.class}(#{cache_path})"
       end
 
     end

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

@@ -1,30 +1,34 @@
-module Backend
+module Picky
 
-  module File
+  module Backend
 
-    # Index files dumped in the JSON format.
-    #
-    class JSON < Basic
+    module File
 
-      # Uses the extension "json".
+      # Index files dumped in the JSON format.
       #
-      def extension
-        :json
-      end
-      # Loads the index hash from json format.
-      #
-      def load
-        Yajl::Parser.parse ::File.open(cache_path, 'r'), symbolize_keys: true
-      end
-      # Dumps the index hash in json format.
-      #
-      def dump hash
-        hash.dump_json cache_path
-      end
-      # A json file does not provide retrieve functionality.
-      #
-      def retrieve
-        raise "Can't retrieve from JSON file. Use text file."
+      class JSON < Basic
+
+        # Uses the extension "json".
+        #
+        def extension
+          :json
+        end
+        # Loads the index hash from json format.
+        #
+        def load
+          Yajl::Parser.parse ::File.open(cache_path, 'r'), symbolize_keys: true
+        end
+        # Dumps the index hash in json format.
+        #
+        def dump hash
+          hash.dump_json cache_path
+        end
+        # A json file does not provide retrieve functionality.
+        #
+        def retrieve
+          raise "Can't retrieve from JSON file. Use text file."
+        end
+
       end
 
     end

data/lib/picky/backend/file/marshal.rb

@@ -1,34 +1,38 @@
-module Backend
-  
-  module File
-  
-    # Index data in the Ruby Marshal format.
-    #
-    class Marshal < Basic
-    
-      # Uses the extension "dump".
-      #
-      def extension
-        :dump
-      end
-      # Loads the index hash from marshal format.
-      #
-      def load
-        ::Marshal.load ::File.open(cache_path, 'r:binary')
-      end
-      # Dumps the index hash in marshal format.
-      #
-      def dump hash
-        hash.dump_marshalled cache_path
-      end
-      # A marshal file does not provide retrieve functionality.
+module Picky
+
+  module Backend
+
+    module File
+
+      # Index data in the Ruby Marshal format.
       #
-      def retrieve
-        raise "Can't retrieve from marshalled file. Use text file."
+      class Marshal < Basic
+
+        # Uses the extension "dump".
+        #
+        def extension
+          :dump
+        end
+        # Loads the index hash from marshal format.
+        #
+        def load
+          ::Marshal.load ::File.open(cache_path, 'r:binary')
+        end
+        # Dumps the index hash in marshal format.
+        #
+        def dump hash
+          hash.dump_marshalled cache_path
+        end
+        # A marshal file does not provide retrieve functionality.
+        #
+        def retrieve
+          raise "Can't retrieve from marshalled file. Use text file."
+        end
+
       end
-    
+
     end
-  
+
   end
 
 end

data/lib/picky/backend/file/text.rb

@@ -1,54 +1,58 @@
-module Backend
+module Picky
 
-  module File
+  module Backend
 
-    # Index data dumped in the text format.
-    #
-    class Text < Basic
+    module File
 
-      # Uses the extension "txt".
+      # Index data dumped in the text format.
       #
-      def extension
-        :txt
-      end
-      # Text files are used exclusively for
-      # prepared data files.
-      #
-      def load
-        raise "Can't load from text file. Use JSON or Marshal."
-      end
-      # Text files are used exclusively for
-      # prepared data files.
-      #
-      def dump hash
-        raise "Can't dump to text file. Use JSON or Marshal."
-      end
+      class Text < Basic
 
-      # Retrieves prepared index data in the form
-      # * id,data\n
-      # * id,data\n
-      # * id,data\n
-      #
-      # Yields an id string and a symbol token.
-      #
-      def retrieve
-        id    = nil
-        token = nil
-        ::File.open(cache_path, 'r:binary') do |file|
-          file.each_line do |line|
-            id, token = line.split ?,, 2
-            yield id, (token.chomp! || token).to_sym
+        # Uses the extension "txt".
+        #
+        def extension
+          :txt
+        end
+        # Text files are used exclusively for
+        # prepared data files.
+        #
+        def load
+          raise "Can't load from text file. Use JSON or Marshal."
+        end
+        # Text files are used exclusively for
+        # prepared data files.
+        #
+        def dump hash
+          raise "Can't dump to text file. Use JSON or Marshal."
+        end
+
+        # Retrieves prepared index data in the form
+        # * id,data\n
+        # * id,data\n
+        # * id,data\n
+        #
+        # Yields an id string and a symbol token.
+        #
+        def retrieve
+          id    = nil
+          token = nil
+          ::File.open(cache_path, 'r:binary') do |file|
+            file.each_line do |line|
+              id, token = line.split ?,, 2
+              yield id, (token.chomp! || token).to_sym
+            end
           end
         end
-      end
 
-      #
-      #
-      def open &block
-        ::File.open cache_path, 'w:binary', &block
-      end
+        #
+        #
+        def open &block
+          ::File.open cache_path, 'w:binary', &block
+        end
 
 
+      end
+
     end
 
   end