picky 2.7.0 → 3.0.0.pre1

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

@@ -1,24 +1,28 @@
-# encoding: utf-8
-#
-module Generators
+module Picky
 
-  module Similarity
+  # encoding: utf-8
+  #
+  module Generators
 
-    # 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
+    module Similarity
 
-      # Encodes the given symbol.
+      # It's actually a combination of double metaphone
+      # and Levenshtein.
       #
-      # Returns a symbol.
+      # It uses the double metaphone to get similar words
+      # and ranks them using the levenshtein.
       #
-      def encoded sym
-        codes = Text::Metaphone.double_metaphone sym.to_s
-        codes.first.to_sym unless codes.empty?
+      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

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

@@ -1,24 +1,28 @@
-# encoding: utf-8
-#
-module Generators
+module Picky
 
-  module Similarity
+  # encoding: utf-8
+  #
+  module Generators
 
-    # 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
+    module Similarity
 
-      # Encodes the given symbol.
+      # It's actually a combination of metaphone
+      # and Levenshtein.
       #
-      # Returns a symbol.
+      # It uses the metaphone to get similar words
+      # and ranks them using the levenshtein.
       #
-      def encoded sym
-        code = Text::Metaphone.metaphone sym.to_s
-        code.to_sym if code
+      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

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

@@ -1,27 +1,31 @@
-module Generators
+module Picky
 
-  module Similarity
+  module Generators
 
-    # Similarity strategy that does nothing.
-    #
-    class None < Strategy
+    module Similarity
 
-      # Does not encode text. Just returns nil.
+      # Similarity strategy that does nothing.
       #
-      def encoded text
-        nil
-      end
+      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
 
-      # Returns an empty index.
-      #
-      def generate_from index
-        {}
-      end
-    
-      # Returns if this strategy's generated file is saved.
-      #
-      def saved?
-        false
       end
 
     end

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

@@ -1,62 +1,66 @@
-# encoding: utf-8
-#
-module Generators
+module Picky
 
-  module Similarity
+  # encoding: utf-8
+  #
+  module Generators
 
-    # 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
+    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.
       #
-      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
+      class Phonetic < Strategy
 
-      # 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 inverted
-        hash = hashify inverted.keys
-        sort hash
-      end
+        attr_reader :amount
 
-      protected
-
-        # Sorts the index values in place.
         #
-        def sort hash
-          hash.each_pair.each do |code, ary|
-            ary.sort_by_levenshtein! code
-            ary.slice! amount, ary.size # size is not perfectly correct, but anyway
-          end
-          hash
+        #
+        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
 
-        # Hashifies a list of symbols.
+        # Generates an index for the given index (in exact index style).
         #
-        # Where:
-        # { encoded_sym => [syms] }
+        # In the following form:
+        # [:meier, :mueller, :peter, :pater] => { MR: [:meier], MLR: [:mueller], PTR: [:peter, :pater] }
         #
-        def hashify list
-          list.inject({}) do |total, element|
-            if code = encoded(element)
-              total[code] ||= []
-              total[code] << element
+        def generate_from inverted
+          hash = hashify inverted.keys
+          sort hash
+        end
+
+        protected
+
+          # Sorts the index values in place.
+          #
+          def sort hash
+            hash.each_pair.each do |code, ary|
+              ary.sort_by_levenshtein! code
+              ary.slice! amount, ary.size # size is not perfectly correct, but anyway
             end
-            total
+            hash
           end
-        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
 

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

@@ -1,24 +1,28 @@
-# encoding: utf-8
-#
-module Generators
+module Picky
 
-  module Similarity
+  # encoding: utf-8
+  #
+  module Generators
 
-    # 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
+    module Similarity
 
-      # Encodes the given symbol.
+      # It's actually a combination of soundex
+      # and Levenshtein.
       #
-      # Returns a symbol.
+      # It uses the soundex to get similar words
+      # and ranks them using the levenshtein.
       #
-      def encoded sym
-        code = Text::Soundex.soundex sym.to_s
-        code.to_sym if code
+      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

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

@@ -1,9 +1,13 @@
-module Generators
-  module Similarity
-    # Base class for all similarity strategies.
-    #
-    class Strategy < Generators::Strategy
-    
+module Picky
+
+  module Generators
+    module Similarity
+      # Base class for all similarity strategies.
+      #
+      class Strategy < Generators::Strategy
+
+      end
     end
   end
+
 end

data/lib/picky/generators/similarity_generator.rb

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

data/lib/picky/generators/strategy.rb

@@ -1,14 +1,18 @@
-module Generators
-
-  class Strategy
-  
-    # By default, all caches are saved in a
-    # storage (like a file).
-    #
-    def saved?
-      true
+module Picky
+
+  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/generators/weights/default.rb

@@ -1,7 +1,11 @@
-module Generators
-  module Weights
-    # Default is Logarithmic.
-    #
-    Default = Logarithmic.new
+module Picky
+
+  module Generators
+    module Weights
+      # Default is Logarithmic.
+      #
+      Default = Logarithmic.new
+    end
   end
+
 end

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

@@ -1,35 +1,39 @@
-module Generators
+module Picky
 
-  module Weights
+  module Generators
 
-    # 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
+    module Weights
 
-      # Generates a partial index from the given inverted index.
+      # 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.
       #
-      def generate_from inverted
-        inverted.inject({}) do |hash, text_ids|
-          text, ids = *text_ids
-          weight = weight_for ids.size
-          hash[text] ||= weight.round(2) if weight
-          hash
+      class Logarithmic < Strategy
+
+        # Generates a partial index from the given inverted index.
+        #
+        def generate_from inverted
+          inverted.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
 
-      # 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

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

@@ -1,9 +1,13 @@
-module Generators
-  module Weights
-    # Superclass for weighing strategies.
-    #
-    class Strategy < Generators::Strategy
-    
+module Picky
+
+  module Generators
+    module Weights
+      # Superclass for weighing strategies.
+      #
+      class Strategy < Generators::Strategy
+
+      end
     end
   end
+
 end

data/lib/picky/generators/weights_generator.rb

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

data/lib/picky/helpers/measuring.rb

@@ -1,19 +1,23 @@
-# Helper methods for measuring, benchmarking, logging.
-#
-module Helpers
-  module Measuring
-    
-    # Returns a duration in seconds.
-    #
-    def timed *args, &block
-      block_to_be_measured = lambda &block
-      
-      time_begin = Time.now.to_f
-      
-      block_to_be_measured.call *args
-      
-      Time.now.to_f - time_begin
+module Picky
+
+  # Helper methods for measuring, benchmarking, logging.
+  #
+  module Helpers
+    module Measuring
+
+      # Returns a duration in seconds.
+      #
+      def timed *args, &block
+        block_to_be_measured = lambda &block
+
+        time_begin = Time.now.to_f
+
+        block_to_be_measured.call *args
+
+        Time.now.to_f - time_begin
+      end
+
     end
-    
   end
+
 end

data/lib/picky/indexed/bundle/base.rb

@@ -1,41 +1,43 @@
-# TODO Extract duplicate code from base bundle classes.
-#
-module Indexed # :nodoc:all
-
-  # 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.
-  #
-  module Bundle
-
-    class Base < ::Bundle
-
-      # Loads all indexes.
-      #
-      def load
-        load_inverted
-        load_weights
-        load_similarity
-        load_configuration
-      end
+module Picky
+
+  module Indexed # :nodoc:all
+
+    # 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.
+    #
+    module Bundle
+
+      class Base < Picky::Bundle
+
+        # Loads all indexes.
+        #
+        def load
+          load_inverted
+          load_weights
+          load_similarity
+          load_configuration
+        end
+
+        # Clears all indexes.
+        #
+        def clear
+          clear_inverted
+          clear_weights
+          clear_similarity
+          clear_configuration
+        end
 
-      # Clears all indexes.
-      #
-      def clear
-        clear_inverted
-        clear_weights
-        clear_similarity
-        clear_configuration
       end
 
     end