picky 2.5.2 → 2.6.0

data/lib/picky/internals/generators/similarity/default.rb

@@ -1,9 +0,0 @@
-module Internals
-  module Generators
-    module Similarity
-      # Default is no similarity.
-      #
-      Default = None.new
-    end
-  end
-end

data/lib/picky/internals/generators/similarity/double_metaphone.rb

@@ -1,32 +0,0 @@
-# encoding: utf-8
-#
-module Internals
-
-  module Generators
-
-    module Similarity
-
-      # It's actually a combination of double metaphone
-      # and Levenshtein.
-      #
-      # It uses the double metaphone to get similar words
-      # and ranks them using the levenshtein.
-      #
-      class DoubleMetaphone < Phonetic
-
-        # Encodes the given symbol.
-        #
-        # Returns a symbol.
-        #
-        def encoded sym
-          codes = Text::Metaphone.double_metaphone sym.to_s
-          codes.first.to_sym unless codes.empty?
-        end
-
-      end
-
-    end
-
-  end
-
-end

data/lib/picky/internals/generators/similarity/metaphone.rb

@@ -1,32 +0,0 @@
-# encoding: utf-8
-#
-module Internals
-
-  module Generators
-
-    module Similarity
-
-      # It's actually a combination of metaphone
-      # and Levenshtein.
-      #
-      # It uses the metaphone to get similar words
-      # and ranks them using the levenshtein.
-      #
-      class Metaphone < Phonetic
-
-        # Encodes the given symbol.
-        #
-        # Returns a symbol.
-        #
-        def encoded sym
-          code = Text::Metaphone.metaphone sym.to_s
-          code.to_sym if code
-        end
-
-      end
-
-    end
-
-  end
-
-end

data/lib/picky/internals/generators/similarity/none.rb

@@ -1,35 +0,0 @@
-module Internals
-
-  module Generators
-
-    module Similarity
-
-      # Similarity strategy that does nothing.
-      #
-      class None < Strategy
-
-        # Does not encode text. Just returns nil.
-        #
-        def encoded text
-          nil
-        end
-
-        # Returns an empty index.
-        #
-        def generate_from index
-          {}
-        end
-      
-        # Returns if this strategy's generated file is saved.
-        #
-        def saved?
-          false
-        end
-
-      end
-
-    end
-
-  end
-  
-end

data/lib/picky/internals/generators/similarity/phonetic.rb

@@ -1,69 +0,0 @@
-# encoding: utf-8
-#
-module Internals
-
-  module Generators
-
-    module Similarity
-
-      # It's actually a combination of double metaphone
-      # and Levenshtein.
-      #
-      # It uses the double metaphone to get similar words
-      # and ranks them using the levenshtein.
-      #
-      class Phonetic < Strategy
-
-        attr_reader :amount
-
-        #
-        #
-        def initialize amount = 10
-          raise "In Picky 2.0+, the Similarity::Phonetic has been renamed to Similarity::DoubleMetaphone. Please use that one. Thanks!" if self.class == Phonetic
-          @amount = amount
-        end
-
-        # Generates an index for the given index (in exact index style).
-        #
-        # In the following form:
-        # [:meier, :mueller, :peter, :pater] => { MR: [:meier], MLR: [:mueller], PTR: [:peter, :pater] }
-        #
-        def generate_from index
-          hash = hashify index.keys
-          sort hash
-        end
-
-        protected
-
-          # Sorts the index values in place.
-          #
-          def sort index
-            index.each_pair.each do |code, ary|
-              ary.sort_by_levenshtein! code
-              ary.slice! amount, ary.size # size is not perfectly correct, but anyway
-            end
-            index
-          end
-
-          # Hashifies a list of symbols.
-          #
-          # Where:
-          # { encoded_sym => [syms] }
-          #
-          def hashify list
-            list.inject({}) do |total, element|
-              if code = encoded(element)
-                total[code] ||= []
-                total[code] << element
-              end
-              total
-            end
-          end
-
-      end
-
-    end
-
-  end
-
-end

data/lib/picky/internals/generators/similarity/soundex.rb

@@ -1,32 +0,0 @@
-# encoding: utf-8
-#
-module Internals
-
-  module Generators
-
-    module Similarity
-
-      # It's actually a combination of soundex
-      # and Levenshtein.
-      #
-      # It uses the soundex to get similar words
-      # and ranks them using the levenshtein.
-      #
-      class Soundex < Phonetic
-
-        # Encodes the given symbol.
-        #
-        # Returns a symbol.
-        #
-        def encoded sym
-          code = Text::Soundex.soundex sym.to_s
-          code.to_sym if code
-        end
-
-      end
-
-    end
-
-  end
-
-end

data/lib/picky/internals/generators/similarity/strategy.rb

@@ -1,11 +0,0 @@
-module Internals
-  module Generators
-    module Similarity
-      # Base class for all similarity strategies.
-      #
-      class Strategy < Generators::Strategy
-      
-      end
-    end
-  end
-end

data/lib/picky/internals/generators/similarity_generator.rb

@@ -1,19 +0,0 @@
-module Internals
-
-  module Generators
-
-    # Uses no similarity as default.
-    #
-    class SimilarityGenerator < Base
-
-      # Generate a similarity index based on the given index.
-      #
-      def generate strategy = Similarity::None.new
-        strategy.generate_from self.index
-      end
-
-    end
-
-  end
-  
-end

data/lib/picky/internals/generators/strategy.rb

@@ -1,18 +0,0 @@
-module Internals
-
-  module Generators
-  
-    class Strategy
-    
-      # By default, all caches are saved in a
-      # storage (like a file).
-      #
-      def saved?
-        true
-      end
-    
-    end
-  
-  end
-  
-end

data/lib/picky/internals/generators/weights/default.rb

@@ -1,9 +0,0 @@
-module Internals
-  module Generators
-    module Weights
-      # Default is Logarithmic.
-      #
-      Default = Logarithmic.new
-    end
-  end
-end

data/lib/picky/internals/generators/weights/logarithmic.rb

@@ -1,43 +0,0 @@
-module Internals
-
-  module Generators
-
-    module Weights
-
-      # Uses a logarithmic weight.
-      # If for a key k we have x ids, the weight is:
-      # w(x): log(x)
-      # Special case: If x < 1, then we use 0.
-      #
-      class Logarithmic < Strategy
-
-        # Generates a partial index from the given index.
-        #
-        def generate_from index
-          index.inject({}) do |hash, text_ids|
-            text, ids = *text_ids
-            weight = weight_for ids.size
-            hash[text] ||= weight.round(2) if weight
-            hash
-          end
-        end
-
-        # Sets the weight value.
-        #
-        # If the size is 0 or one, we would get -Infinity or 0.0.
-        # Thus we do not set a value if there is just one. The default, dynamically, is 0.
-        #
-        # BUT: We need the value, even if 0. To designate that there is a weight!
-        #
-        def weight_for amount
-          return 0 if amount < 1
-          Math.log amount
-        end
-
-      end
-
-    end
-
-  end
-  
-end

data/lib/picky/internals/generators/weights/strategy.rb

@@ -1,11 +0,0 @@
-module Internals
-  module Generators
-    module Weights
-      # Superclass for weighing strategies.
-      #
-      class Strategy < Generators::Strategy
-      
-      end
-    end
-  end
-end

data/lib/picky/internals/generators/weights_generator.rb

@@ -1,19 +0,0 @@
-module Internals
-
-  module Generators
-
-    # Uses a logarithmic algorithm as default.
-    #
-    class WeightsGenerator < Base
-
-      # Generate a weights index based on the given index.
-      #
-      def generate strategy = Weights::Logarithmic.new
-        strategy.generate_from self.index
-      end
-
-    end
-
-  end
-  
-end

data/lib/picky/internals/index/backend.rb

@@ -1,112 +0,0 @@
-module Internals
-
-  module Index
-
-    class Backend
-
-      attr_reader :bundle_name
-      attr_reader :prepared, :index, :weights, :similarity, :configuration
-
-      delegate :index_name, :category_name, :to => :@category
-
-      def initialize bundle_name, category
-        @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_index index_hash
-        index.dump index_hash
-      end
-      def dump_weights weights_hash
-        weights.dump weights_hash
-      end
-      def dump_similarity similarity_hash
-        similarity.dump similarity_hash
-      end
-      def dump_configuration configuration_hash
-        configuration.dump configuration_hash
-      end
-
-      # Loading.
-      #
-      def load_index
-        index.load
-      end
-      def load_similarity
-        similarity.load
-      end
-      def load_weights
-        weights.load
-      end
-      def load_configuration
-        configuration.load
-      end
-
-      # Cache ok?
-      #
-      def index_cache_ok?
-        index.cache_ok?
-      end
-      def similarity_cache_ok?
-        similarity.cache_ok?
-      end
-      def weights_cache_ok?
-        weights.cache_ok?
-      end
-
-      # Cache small?
-      #
-      def index_cache_small?
-        index.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
-        index.backup
-        weights.backup
-        similarity.backup
-        configuration.backup
-      end
-
-      # Restores the indexes from the "backup" directory.
-      #
-      def restore
-        index.restore
-        weights.restore
-        similarity.restore
-        configuration.restore
-      end
-
-      # Delete all index files.
-      #
-      def delete
-        index.delete
-        weights.delete
-        similarity.delete
-        configuration.delete
-      end
-
-    end
-
-  end
-
-end

data/lib/picky/internals/index/file/basic.rb

@@ -1,105 +0,0 @@
-module Internals
-
-  module Index
-
-    # Handles all aspects of index files, such as dumping/loading.
-    #
-    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
-
-        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
-
-        def to_s
-          cache_path
-        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
-
-      end
-
-    end
-
-  end
-
-end

data/lib/picky/internals/index/file/json.rb

@@ -1,38 +0,0 @@
-module Internals
-
-  module Index
-  
-    module File
-    
-      # Index files dumped in the JSON format.
-      #
-      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
-  
-  end
-  
-end

data/lib/picky/internals/index/file/marshal.rb

@@ -1,38 +0,0 @@
-module Internals
-
-  module Index
-  
-    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.
-        #
-        def retrieve
-          raise "Can't retrieve from marshalled file. Use text file."
-        end
-      
-      end
-    
-    end
-  
-  end
-  
-end

data/lib/picky/internals/index/file/text.rb

@@ -1,60 +0,0 @@
-module Internals
-
-  module Index
-
-    module File
-
-      # Index data dumped in the text format.
-      #
-      class Text < Basic
-
-        # 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
-
-        #
-        #
-        def open_for_indexing &block
-          ::File.open cache_path, 'w:binary', &block
-        end
-
-
-      end
-
-    end
-
-  end
-
-end