picky 1.2.4 → 1.3.0

data/lib/picky/interfaces/live_parameters.rb

@@ -0,0 +1,165 @@
+# This is very optional.
+# Only load if the user wants it.
+#
+module Interfaces
+  # This is an interface that provides the user of
+  # Picky with the possibility to change parameters
+  # while the Application is running.
+  #
+  # Important Note: This will only work in Master/Child configurations.
+  #
+  class LiveParameters
+    
+    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
+          sleep 1 # TODO select
+          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
+        # TODO rescue on error.
+          
+        end
+      end
+    end
+    
+    # TODO This needs to be webserver agnostic.
+    #
+    def worker_pids
+      Unicorn::HttpServer::WORKERS.keys
+    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
+    # TODO This needs to be Webserver agnostic.
+    #
+    def remove_worker wpid
+      worker = Unicorn::HttpServer::WORKERS.delete(wpid) and worker.tmp.close rescue nil
+    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
+    #   TODO etc.
+    #
+    # 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
+        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
+      Tokenizers::Query.default.instance_variable_get(:@removes_characters_regexp).source
+    end
+    def querying_removes_characters= new_value
+      Tokenizers::Query.default.instance_variable_set(:@removes_characters_regexp, %r{#{new_value}})
+    end
+    def querying_stopwords
+      Tokenizers::Query.default.instance_variable_get(:@remove_stopwords_regexp).source
+    end
+    def querying_stopwords= new_value
+      Tokenizers::Query.default.instance_variable_set(:@remove_stopwords_regexp, %r{#{new_value}})
+    end
+    def querying_splits_text_on
+      Tokenizers::Query.default.instance_variable_get(:@splits_text_on_regexp).source
+    end
+    def querying_splits_text_on= new_value
+      Tokenizers::Query.default.instance_variable_set(:@splits_text_on_regexp, %r{#{new_value}})
+    end
+    
+  end
+  
+  # Aka.
+  #
+  ::LiveParameters = LiveParameters
+  
+end

data/lib/picky/loader.rb

@@ -68,7 +68,7 @@ module Loader # :nodoc:all
     
     # Finalize the applications.
     #
-    # TODO Problem: Reload Routes.
+    # TODO Problem: Reload Routes. Throw them all away and do them again?
     #
     Application.finalize_apps
     
@@ -249,9 +249,20 @@ module Loader # :nodoc:all
     #
     load_relative 'configuration/index'
     
+    # Interfaces
+    #
+    load_relative 'interfaces/live_parameters'
+    
+    # Adapters.
+    #
+    load_relative 'adapters/rack/base'
+    load_relative 'adapters/rack/query'
+    load_relative 'adapters/rack/live_parameters'
+    load_relative 'adapters/rack'
+    
     # Application and routing.
     #
-    load_relative 'routing'
+    load_relative 'frontend_adapters/rack'
     load_relative 'application'
     
     # Load tools.

data/lib/picky/query/base.rb

@@ -23,7 +23,7 @@ module Query
     
     include Helpers::Measuring
     
-    attr_writer   :tokenizer
+    attr_writer   :tokenizer, :identifiers_to_remove
     attr_accessor :reduce_to_amount, :weights
     
     # Takes:
@@ -43,13 +43,14 @@ module Query
       @weights     = Hash === weights ? Weights.new(weights) : weights
     end
     
-    # Search through this method.
+    # This is the main entry point for a query.
+    # Use this in specs and also for running queries.
     #
     # Parameters:
     # * text: The search text.
     # * offset = 0: _optional_ The offset from which position to return the ids. Useful for pagination.
     #
-    # Note: The Routing uses this method after unravelling the HTTP request.
+    # Note: The Rack adapter calls this method after unravelling the HTTP request.
     #
     def search_with_text text, offset = 0
       search tokenized(text), offset
@@ -75,7 +76,7 @@ module Query
     # Note: Internal method, use #search_with_text.
     #
     def execute tokens, offset
-      results_from offset, sorted_allocations(tokens)
+      result_type.from offset, sorted_allocations(tokens)
     end
     
     # Returns an empty result with default values.
@@ -140,28 +141,24 @@ module Query
     def reduce allocations # :nodoc:
       allocations.reduce_to reduce_to_amount if reduce_to_amount
     end
-    def remove_identifiers? # :nodoc:
-      identifiers_to_remove.present?
-    end
+    
+    #
+    #
     def remove_from allocations # :nodoc:
-      allocations.remove(identifiers_to_remove) if remove_identifiers?
+      allocations.remove identifiers_to_remove
     end
-    # Override. TODO No, redesign.
+    #
     #
     def identifiers_to_remove # :nodoc:
       @identifiers_to_remove ||= []
     end
     
-    # Packs the sorted allocations into results.
-    #
-    # This generates the id intersections. Lots of work going on.
+    # Display some nice information for the user.
     #
-    # TODO Move to results. result_type.from allocations, offset
-    #
-    def results_from offset = 0, allocations = nil # :nodoc:
-      results = result_type.new offset, allocations
-      results.prepare!
-      results
+    def to_s
+      s = "#{self.class}"
+      s << ", weights: #{@weights}" unless @weights.empty?
+      s
     end
 
   end

data/lib/picky/query/combination.rb

@@ -26,7 +26,7 @@ module Query
     
     # Returns the weight of this combination.
     #
-    # TODO Really cache?
+    # Note: Caching is most oft the time useful.
     #
     def weight
       @weight ||= @bundle.weight(@text)
@@ -34,7 +34,7 @@ module Query
     
     # Returns an array of ids for the given text.
     #
-    # TODO Really cache?
+    # Note: Caching is most oft the time useful.
     #
     def ids
       @ids ||= @bundle.ids(@text)

data/lib/picky/query/solr.rb

@@ -13,21 +13,6 @@ module Query
       super *index_types
     end
 
-    # # This runs the actual search.
-    # #
-    # # TODO Remove!
-    # #
-    # def search tokens, offset = 0
-    #   results = nil
-    #
-    #   duration = timed do
-    #     results = execute(tokens, offset) || empty_results # TODO Does not work yet
-    #   end
-    #   results.duration = duration
-    #
-    #   results
-    # end
-
     #
     #
     def execute tokens, offset = 0
@@ -61,8 +46,6 @@ module Query
         results.add similar: similar
       end
 
-      # TODO
-      #
       class << results
         def to_log query
           ?* + super

data/lib/picky/query/token.rb

@@ -69,8 +69,8 @@ module Query
 
     # If the text ends with *, partialize it. If with ", don't.
     #
-    @@no_partial = /\"$/
-    @@partial    = /\*$/
+    @@no_partial = /\"\Z/
+    @@partial    = /\*\Z/
     def partialize
       self.partial = false and return if @text =~ @@no_partial
       self.partial = true if @text =~ @@partial
@@ -78,8 +78,8 @@ module Query
 
     # If the text ends with ~ similarize it. If with ", don't.
     #
-    @@no_similar = /\"$/
-    @@similar    = /\~$/
+    @@no_similar = /\"\Z/
+    @@similar    = /\~\Z/
     def similarize
       self.similar = false and return if @text =~ @@no_similar
       self.similar = true if @text =~ @@similar
@@ -118,35 +118,19 @@ module Query
     def possible_combinations_in type
       type.possible_combinations self
     end
-
-    #
+    
+    # Returns a token with the next similar text.
     #
-    def from token
-      new_token = token.dup
-      new_token.instance_variable_set :@text, @text
-      new_token.instance_variable_set :@partial, @partial
-      new_token.instance_variable_set :@original, @original
-      new_token.instance_variable_set :@qualifier, @qualifier
-      # TODO
-      #
-      # token.instance_variable_set :@similarity, @similarity
-      new_token
-    end
-
-    # TODO Rewrite, also next_similar.
+    # TODO Rewrite this. It is hard to understand. Also spec performance.
     #
-    def next category
-      token = from self
+    def next_similar_token category
+      token = self.dup
       token if token.next_similar category.bundle_for(token)
     end
-
     # Sets and returns the next similar word.
     #
     def next_similar bundle
-      @text = similarity(bundle).next if similar?
-    rescue StopIteration => stop_iteration
-      # reset_similar # TODO
-      nil # TODO
+      @text = (similarity(bundle).shift || return) if similar?
     end
     # Lazy similar reader.
     #
@@ -155,8 +139,11 @@ module Query
     end
     # Returns an enumerator that traverses over the similar.
     #
+    # Note: The dup isn't too nice – since it is needed on account of the shift, above.
+    #       (We avoid a StopIteration exception. Which of both is less evil?)
+    #
     def generate_similarity_for bundle
-      (bundle.similar(@text) || []).each
+      bundle.similar(@text).dup || []
     end
 
     # Generates a solr term from this token.

data/lib/picky/query/weights.rb

@@ -7,7 +7,7 @@ module Query
     #
     #
     def initialize weights = {}
-      @weights_cache = {}
+      # @weights_cache = {} # TODO
       @weights = prepare weights
     end
     
@@ -47,5 +47,17 @@ module Query
       weight_for combinations.map(&:category_name).clustered_uniq_fast
     end
     
+    # Are there any weights defined?
+    #
+    def empty?
+      @weights.empty?
+    end
+    
+    # Prints out a nice representation of the configured weights.
+    #
+    def to_s
+      @weights.to_s
+    end
+    
   end
 end

data/lib/picky/results/base.rb

@@ -12,9 +12,16 @@ module Results # :nodoc:all
 
     # Takes instances of Query::Allocations as param.
     #
-    def initialize offset = 0, allocations = nil
+    def initialize offset = 0, allocations = Query::Allocations.new
       @offset = offset
-      @allocations = allocations || Query::Allocations.new
+      @allocations = allocations # || Query::Allocations.new
+    end
+    # Create new results and calculate the ids.
+    #
+    def self.from offset, allocations
+      results = new offset, allocations
+      results.prepare!
+      results
     end
 
     #

data/spec/lib/adapters/rack/base_spec.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+#
+require 'spec_helper'
+
+describe Adapters::Rack::Base do
+  
+  before(:each) do
+    @adapter = Adapters::Rack::Base.new
+  end
+  
+  describe 'respond_with' do
+    describe 'by default' do
+      it 'uses json' do
+        @adapter.respond_with('response').should ==
+          [200, { 'Content-Type' => 'application/json', 'Content-Length' => '8' }, ['response']]
+      end
+    end
+    it 'adapts the content length' do
+      @adapter.respond_with('123').should ==
+        [200, { 'Content-Type' => 'application/json', 'Content-Length' => '3' }, ['123']]
+    end
+  end
+  
+end

data/spec/lib/adapters/rack/live_parameters_spec.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+#
+require 'spec_helper'
+
+describe Adapters::Rack::LiveParameters do
+  
+  before(:each) do
+    @live_parameters = stub :live_parameters
+    @adapter         = Adapters::Rack::LiveParameters.new @live_parameters
+  end
+  
+  describe 'to_app' do
+    it 'works' do
+      lambda { @adapter.to_app }.should_not raise_error
+    end
+    it 'returns the right thing' do
+      @adapter.to_app.should respond_to(:call)
+    end
+  end
+  
+end

data/spec/lib/adapters/rack/query_spec.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+#
+require 'spec_helper'
+
+describe Adapters::Rack::Query do
+  
+  before(:each) do
+    @query   = stub :query
+    @adapter = Adapters::Rack::Query.new @query
+  end
+  
+  describe 'to_app' do
+    it 'works' do
+      lambda { @adapter.to_app }.should_not raise_error
+    end
+    it 'returns the right thing' do
+      @adapter.to_app.should respond_to(:call)
+    end
+  end
+  
+  describe 'extracted' do
+    it 'extracts the query' do
+      @adapter.extracted('query' => 'some_query')[0].should == 'some_query'
+    end
+    it 'extracts the default offset' do
+      @adapter.extracted('query' => 'some_query')[1].should == 0
+    end
+    it 'extracts a given offset' do
+      @adapter.extracted('query' => 'some_query', 'offset' => '123')[1].should == 123
+    end
+  end
+  
+end

data/spec/lib/application_spec.rb

@@ -10,11 +10,12 @@ describe Application do
         class MinimalTestApplication < Application
           books = index :books, Sources::DB.new('SELECT id, title FROM books', :file => 'app/db.yml')
           books.define_category :title
-                              
           
           full = Query::Full.new books
           live = Query::Live.new books
           
+          rack_adapter.stub! :exclaim # Stopping it from exclaiming.
+          
           route %r{^/books/full} => full
           route %r{^/books/live} => live
         end
@@ -58,6 +59,8 @@ describe Application do
           full = Query::Full.new books_index
           live = Query::Live.new books_index
           
+          rack_adapter.stub! :exclaim # Stopping it from exclaiming.
+          
           route %r{^/books/full} => full
           route %r{^/books/live} => live
         end
@@ -65,30 +68,46 @@ describe Application do
     end
   end
   
+  describe 'finalize' do
+    before(:each) do
+      Application.stub! :check
+    end
+    it 'checks if all is ok' do
+      Application.should_receive(:check).once.with
+      
+      Application.finalize
+    end
+    it 'tells the rack adapter to finalize' do
+      Application.rack_adapter.should_receive(:finalize).once.with
+      
+      Application.finalize
+    end
+  end
+  
   describe 'delegation' do
     it "should delegate route" do
-      Application.routing.should_receive(:route).once.with :path => :query
+      Application.rack_adapter.should_receive(:route).once.with :path => :query
       
       Application.route :path => :query
     end
   end
   
-  describe 'routing' do
+  describe 'rack_adapter' do
     it 'should be there' do
-      lambda { Application.routing }.should_not raise_error
+      lambda { Application.rack_adapter }.should_not raise_error
     end
-    it "should return a new Routing instance" do
-      Application.routing.should be_kind_of(Routing)
+    it "should return a new FrontendAdapters::Rack instance" do
+      Application.rack_adapter.should be_kind_of(FrontendAdapters::Rack)
     end
     it "should cache the instance" do
-      Application.routing.should == Application.routing
+      Application.rack_adapter.should == Application.rack_adapter
     end
   end
   
   describe 'call' do
     before(:each) do
       @routes = stub :routes
-      Application.stub! :routing => @routes
+      Application.stub! :rack_adapter => @routes
     end
     it 'should delegate' do
       @routes.should_receive(:call).once.with :env

data/spec/lib/cli_spec.rb

@@ -27,6 +27,15 @@ describe Picky::CLI do
       it 'returns Statistics for stats' do
         @cli.executor_class_for(:stats).should == [Picky::CLI::Statistics, "logfile, e.g. log/search.log", "port (optional)"]
       end
+      it 'returns Live for live' do
+        @cli.executor_class_for(:live).should == [Picky::CLI::Live, "host:port/path (optional, default: localhost:8080/admin)", "port (optional)"]
+      end
+    end
+  end
+  
+  describe Picky::CLI::Live do
+    before(:each) do
+      @cli = Picky::CLI::Live.new
     end
   end
   

data/spec/lib/extensions/symbol_spec.rb

@@ -8,9 +8,7 @@ describe Symbol do
       @token = (((0..9).to_a)*10).to_s.to_sym
     end
     it "should be fast" do
-      timed do
-        @token.each_subtoken do |subtoken| end
-      end.should < 0.0006
+      performance_of { @token.each_subtoken { |subtoken| } }.should < 0.00065
     end
   end