picky 4.0.0pre1 → 4.0.0pre2

data/lib/picky/category/location.rb

@@ -0,0 +1,25 @@
+module Picky
+  class Category
+
+    module Location
+
+      def self.install_on category, grid, precision, anchor
+        category.extend self
+
+        exact_bundle = category.exact
+        category.exact   = Wrappers::Bundle::Location.new(exact_bundle, grid, precision: precision, anchor: anchor)
+        category.partial = Wrappers::Bundle::Location.new(exact_bundle, grid, precision: precision, anchor: anchor)
+
+        category
+      end
+
+      # Only uses a basic tokenizer that's already geared towards numbers.
+      #
+      def tokenizer
+        @tokenizer ||= Tokenizer.new
+      end
+
+    end
+
+  end
+end

data/lib/picky/category_realtime.rb

@@ -43,16 +43,17 @@ module Picky
     # strings to the index for the given id.
     #
     def add_tokenized id, tokens, where = :unshift
-      tokens.each { |text| add_tokenized_token id, text, where }
+      tokens.each { |text| add_tokenized_token id.send(key_format), text, where, false }
     end
 
     #
     #
-    def add_tokenized_token id, text, where = :unshift
+    def add_tokenized_token id, text, where = :unshift, format = true
       return unless text
-      id = id.send key_format # TODO Speed this up!
 
+      id = id.send key_format if format
       # text = text.to_sym if @symbols # TODO Symbols.
+
       exact.add id, text, where
       partial.add_partialized id, text, where
     end

data/lib/picky/console.rb

@@ -3,7 +3,7 @@
 #
 module Picky
 
-  # TODO Improve.
+  # Handles the IRB console for Picky.
   #
   class Console
 

data/lib/picky/constants.rb

@@ -8,4 +8,4 @@ ENV['PICKY_ENV'] ||= ENV['RACK_ENV']
 PICKY_ENVIRONMENT = ENV['PICKY_ENV'] || 'development' unless defined? PICKY_ENVIRONMENT
 PICKY_ROOT        = Dir.pwd unless defined? PICKY_ROOT
 
-EMPTY_STRING = ''.freeze
+EMPTY_STRING = ''.freeze unless defined? EMPTY_STRING

data/lib/picky/ext/maybe_compile.rb

@@ -1,7 +1,7 @@
 begin
-  require File.expand_path '../ruby19/performant', __FILE__
+  require_relative 'ruby19/performant'
 rescue LoadError
-  require File.expand_path '../ruby19/extconf.rb', __FILE__
+  require_relative 'ruby19/extconf'
   Dir.chdir File.expand_path('../ruby19', __FILE__) do
     %x{ ruby extconf.rb && make }
   end

data/lib/picky/extensions/object.rb

@@ -10,13 +10,14 @@ class Object # :nodoc:all
   # Just puts the given text.
   #
   def exclaim text
-    puts text
+    STDOUT.puts text
+    STDOUT.flush
   end
 
   # Puts a text that informs the user of a missing gem.
   #
   def warn_gem_missing gem_name, message
-    warn "#{gem_name} gem missing!\nTo use #{message}, you need to:\n  1. Add the following line to Gemfile:\n     gem '#{gem_name}'\n     or\n     require '#{gem_name}'\n     for example on top of your app.rb/application.rb\n  2. Then, run:\n     bundle update\n"
+    warn "#{gem_name} gem missing!\nTo use #{message}, you need to:\n  1. Add the following line to Gemfile:\n     gem '#{gem_name}'\n     or\n     require '#{gem_name}'\n     for example at the top of your app.rb file.\n  2. Then, run:\n     bundle update\n"
   end
 
   # Indents each line by <tt>amount=2</tt> spaces.

data/lib/picky/generators/aliases.rb

@@ -1,5 +1,10 @@
 module Picky
-  Partial    = Generators::Partial
+  remove_const :Partial if defined? Partial
+  Partial = Generators::Partial
+
+  remove_const :Similarity if defined? Similarity
   Similarity = Generators::Similarity
-  Weights    = Generators::Weights
+
+  remove_const :Weights if defined? Weights
+  Weights = Generators::Weights
 end

data/lib/picky/generators/partial/default.rb

@@ -2,6 +2,7 @@ module Picky
 
   module Generators
     module Partial
+      remove_const :Default if defined? Default
       Default = Postfix.new from: -3
     end
   end

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

@@ -4,6 +4,7 @@ module Picky
     module Similarity
       # Default is no similarity.
       #
+      remove_const :Default if defined? Default
       Default = None.new
     end
   end

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

@@ -19,15 +19,26 @@ module Picky
         #
         #
         def initialize amount = 10
+          check_gem
+
           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
 
+        # Tries to require the text gem.
+        #
+        def check_gem # :nodoc:
+          require 'text'
+        rescue LoadError
+          warn_gem_missing 'text', 'a phonetic Similarity'
+          exit 1
+        end
+
         # Sorts the index values in place.
         #
         def sort ary, code
-            ary.sort_by_levenshtein! code
-            ary.slice! amount, ary.size # THINK size is not perfectly correct, but anyway
+          ary.sort_by_levenshtein! code
+          ary.slice! amount, ary.size # THINK size is not perfectly correct, but anyway
         end
 
       end

data/lib/picky/generators/strategy.rb

@@ -7,8 +7,6 @@ module Picky
       # By default, all caches are saved in a
       # storage (like a file).
       #
-      # TODO Move to the backends? Rename to backend?
-      #
       def saved?
         true
       end

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

@@ -13,7 +13,7 @@ module Picky
       #   * Picky::Weights::Constant.new       # Uses 0.0 as a constant weight.
       #   * Picky::Weights::Constant.new(3.14) # Uses 3.14 as a constant weight.
       #
-      class Constant < Runtime
+      class Constant < Stub
 
         def initialize weight = 0.0
           @weight = weight
@@ -23,7 +23,6 @@ module Picky
         # except if there are no ids.
         #
         def [] _
-
           @weight
         end
 

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

@@ -4,6 +4,7 @@ module Picky
     module Weights
       # Default is Logarithmic.
       #
+      remove_const :Default if defined? Default
       Default = Logarithmic.new
     end
   end

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

@@ -13,7 +13,7 @@ module Picky
       #       sym_or_str * length
       #     end
       #
-      class Dynamic < Runtime
+      class Dynamic < Stub
 
         # Give it a block that takes a string/symbol
         # and returns a weight.

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

@@ -16,7 +16,7 @@ module Picky
         # 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!
+        # BUT: We need the value, even if 0. To designate that there IS a weight!
         #
         def weight_for amount
           return 0 if amount < 1

data/lib/picky/generators/weights/{runtime.rb → stub.rb}

@@ -12,9 +12,7 @@ module Picky
       #   * [symbol_or_string] # During runtime.
       #   * weight_for(size)   # During indextime. # Probably never used.
       #
-      # TODO Find a better name.
-      #
-      class Runtime < Strategy
+      class Stub < Strategy
 
         # It is not saved, by default.
         #

data/lib/picky/index.rb

@@ -251,7 +251,7 @@ module Picky
       options = { partial: Partial::None.new }.merge options
 
       category category_name, options do |cat|
-        Wrappers::Category::Location.wrap cat, range, precision, anchor
+        Category::Location.install_on cat, range, precision, anchor
       end
     end
 
@@ -285,8 +285,8 @@ module Picky
     # * lat_from: The data category to take the data for the latitude from.
     # * lng_from: The data category to take the data for the longitude from.
     #
-    # TODO Will have to write a wrapper that combines two categories that are
-    #      indexed simultaneously, since lat/lng are correlated.
+    # THINK Will have to write a wrapper that combines two categories that are
+    # indexed simultaneously, since lat/lng are correlated.
     #
     def geo_categories lat_name, lng_name, radius, options = {} # :nodoc:
 

data/lib/picky/index_indexing.rb

@@ -104,8 +104,6 @@ module Picky
     # Extract the actual source if it is wrapped in a time
     # capsule, i.e. a block/lambda.
     #
-    # TODO Extract into module.
-    #
     def extract_source
       @source = @source.respond_to?(:call) ? @source.call : @source
     end

data/lib/picky/index_realtime.rb

@@ -6,7 +6,7 @@ module Picky
 
     delegate :remove,  # aka "delete".
              :add,     # aka "insert".
-             :replace, # aka "insert or update".
+             :replace, # aka "insert or update". Thus, not called update.
              :clear_realtime,
              :build_realtime_mapping,
              :to => :categories

data/lib/picky/indexers/base.rb

@@ -27,6 +27,13 @@ module Picky
         end
       end
 
+      # Explicitly reset the source to avoid caching trouble.
+      #
+      def reset_source
+        source.reset      if source.respond_to?(:reset)
+        source.reconnect! if source.respond_to?(:reconnect!)
+      end
+
       def check_source # :nodoc:
         raise "Trying to index without a source for #{@index_or_category.name}." unless source
       end

data/lib/picky/indexers/parallel.rb

@@ -22,14 +22,12 @@ module Picky
           [category, category.prepared_index_file, [], (category.tokenizer || tokenizer)]
         end
 
-        # Explicitly reset the source to avoid caching trouble.
-        #
-        source.reset if source.respond_to?(:reset)
-
         # Go through each object in the source.
         #
         objects = []
 
+        reset_source
+
         source.each do |object|
 
           # Accumulate objects.

data/lib/picky/indexers/serial.rb

@@ -25,6 +25,8 @@ module Picky
             result = []
             tokenizer = category.tokenizer
 
+            reset_source
+
             source.harvest(category) do |*data|
 
               # Accumulate data.

data/lib/picky/indexes_indexing.rb

@@ -35,7 +35,7 @@ module Picky
     #
     #
     def tokenizer
-      Tokenizer.index_default
+      Tokenizer.indexing
     end
 
   end

data/lib/picky/interfaces/live_parameters/master_child.rb

@@ -0,0 +1,175 @@
+module Picky
+
+  # This is very optional.
+  # Only load if the user wants it.
+  #
+  module Interfaces
+
+    module LiveParameters
+
+      # This is an interface that provides the user of
+      # Picky with the possibility to change parameters
+      # while the Application is running.
+      #
+      class MasterChild
+
+        def initialize
+          @child, @parent = IO.pipe
+          start_master_process_thread
+        end
+
+        # This runs a thread that listens to child processes.
+        #
+        def start_master_process_thread
+          # This thread is stopped in the children.
+          #
+          Thread.new do
+            loop do
+              IO.select([@child], nil, nil, 2) or next
+              result = @child.gets ';;;'
+              pid, configuration_hash = eval result
+              next unless Hash === configuration_hash
+              next if configuration_hash.empty?
+              exclaim "Trying to update MASTER configuration."
+              try_updating_configuration_with configuration_hash
+              kill_each_worker_except pid
+
+              # Fails hard on an error.
+              #
+            end
+          end
+        end
+
+        # Taken from Unicorn.
+        #
+        def kill_each_worker_except pid
+          worker_pids.each do |wpid|
+            next if wpid == pid
+            kill_worker :KILL, wpid
+          end
+        end
+        def kill_worker signal, wpid
+          Process.kill signal, wpid
+          exclaim "Killing worker ##{wpid} with signal #{signal}."
+        rescue Errno::ESRCH
+          remove_worker wpid
+        end
+
+        # Updates any parameters with the ones given and
+        # returns the updated params.
+        #
+        # The params are a strictly defined hash of:
+        #   * querying_removes_characters: Regexp
+        #   * querying_stopwords:          Regexp
+        #   * querying_splits_text_on:     Regexp
+        #
+        # This first tries to update in the child process,
+        # and if successful, in the parent process
+        #
+        def parameters configuration_hash
+          close_child
+          exclaim "Trying to update worker child configuration." unless configuration_hash.empty?
+          try_updating_configuration_with configuration_hash
+          write_parent configuration_hash
+          extract_configuration
+        rescue CouldNotUpdateConfigurationError => e
+          # I need to die such that my broken config is never used.
+          #
+          exclaim "Child process #{Process.pid} performs harakiri because of broken config."
+          harakiri
+          { e.config_key => :ERROR }
+        end
+        # Kills itself, but still answering the request honorably.
+        #
+        def harakiri
+          Process.kill :QUIT, Process.pid
+        end
+        # Write the parent.
+        #
+        # Note: The ;;; is the end marker for the message.
+        #
+        def write_parent configuration_hash
+          @parent.write "#{[Process.pid, configuration_hash]};;;"
+        end
+        # Close the child if it isn't yet closed.
+        #
+        def close_child
+          @child.close unless @child.closed?
+        end
+
+        class CouldNotUpdateConfigurationError < StandardError
+          attr_reader :config_key
+          def initialize config_key, message
+            super message
+            @config_key = config_key
+          end
+        end
+
+        # Tries updating the configuration in the child process or parent process.
+        #
+        def try_updating_configuration_with configuration_hash
+          current_key = nil
+          begin
+            configuration_hash.each_pair do |key, new_value|
+              exclaim "  Setting #{key} with #{new_value}."
+              current_key = key
+              send :"#{key}=", new_value
+            end
+          rescue StandardError => e
+            # Catch any error and reraise as config error.
+            #
+            raise CouldNotUpdateConfigurationError.new current_key, e.message
+          end
+        end
+
+        def extract_configuration
+          {
+            querying_removes_characters: querying_removes_characters,
+            querying_stopwords:          querying_stopwords,
+            querying_splits_text_on:     querying_splits_text_on
+          }
+        end
+
+        # TODO Move to Interface object.
+        #
+        def querying_removes_characters
+          regexp = Tokenizer.searching.instance_variable_get :@removes_characters_regexp
+          regexp && regexp.source
+        end
+        def querying_removes_characters= new_value
+          Tokenizer.searching.removes_characters %r{#{new_value}}
+          # Tokenizer.searching.instance_variable_set(:@removes_characters_regexp, %r{#{new_value}})
+        end
+        def querying_stopwords
+          regexp = Tokenizer.searching.instance_variable_get :@remove_stopwords_regexp
+          regexp && regexp.source
+        end
+        def querying_stopwords= new_value
+          Tokenizer.searching.instance_variable_set(:@remove_stopwords_regexp, %r{#{new_value}})
+        end
+        def querying_splits_text_on
+          splits = Tokenizer.searching.instance_variable_get :@splits_text_on
+          splits && splits.respond_to?(:source) ? splits.source : splits
+        end
+        def querying_splits_text_on= new_value
+          splits = Tokenizer.searching.instance_variable_get :@splits_text_on
+          if splits.respond_to?(:source)
+            Tokenizer.searching.instance_variable_set(:@splits_text_on, %r{#{new_value}})
+          else
+            Tokenizer.searching.instance_variable_set(:@splits_text_on, new_value)
+          end
+        end
+
+        #
+        #
+        def to_s
+          "Suckerfish Live Interface (Use the picky-live gem to introspect)"
+        end
+
+      end
+
+    end
+
+  end
+
+end