picky 2.7.0 → 3.0.0.pre1

data/lib/picky/rack/harakiri.rb

@@ -1,55 +1,59 @@
-module Rack # :nodoc:
-  
-  # Simple Rack Middleware to kill Unicorns after X requests.
-  #
-  # Use as follows in e.g. your rackup File:
-  #
-  #   Rack::Harakiri.after = 100
-  #   use Rack::Harakiri
-  #
-  # Then the Unicorn will commit suicide after 100 requests (50 is the default).
-  #
-  # The Master Unicorn process forks a new child Unicorn to replace the old one.
-  #
-  class Harakiri
-    
-    # Set the amount of requests before the Unicorn commits Harakiri.
+module Picky
+
+  module Rack # :nodoc:
+
+    # Simple Rack Middleware to kill Unicorns after X requests.
     #
-    cattr_accessor :after
-    
-    def initialize app
-      @app = app
-      
-      @requests            = 0
-      @quit_after_requests = self.class.after || 50
-    end
-    
-    # #call interface method.
-    #
-    # Harakiri is a middleware, so it delegates the the app or
-    # the next middleware after checking if it is time to honorably retire.
+    # Use as follows in e.g. your rackup File:
     #
-    def call env
-      harakiri
-      @app.call env
-    end
-    
-    # Checks to see if it is time to honorably retire.
+    #   Rack::Harakiri.after = 100
+    #   use Rack::Harakiri
     #
-    # If yes, kills itself (Unicorn will answer the request, honorably).
+    # Then the Unicorn will commit suicide after 100 requests (50 is the default).
     #
-    # Note: Sends its process a QUIT signal if it is time.
-    #
-    def harakiri
-      @requests = @requests + 1
-      Process.kill(:QUIT, Process.pid) if harakiri?
-    end
-    
-    # Is it time to honorably retire?
+    # The Master Unicorn process forks a new child Unicorn to replace the old one.
     #
-    def harakiri?
-      @requests >= @quit_after_requests
+    class Harakiri
+
+      # Set the amount of requests before the Unicorn commits Harakiri.
+      #
+      cattr_accessor :after
+
+      def initialize app
+        @app = app
+
+        @requests            = 0
+        @quit_after_requests = self.class.after || 50
+      end
+
+      # #call interface method.
+      #
+      # Harakiri is a middleware, so it delegates the the app or
+      # the next middleware after checking if it is time to honorably retire.
+      #
+      def call env
+        harakiri
+        @app.call env
+      end
+
+      # Checks to see if it is time to honorably retire.
+      #
+      # If yes, kills itself (Unicorn will answer the request, honorably).
+      #
+      # Note: Sends its process a QUIT signal if it is time.
+      #
+      def harakiri
+        @requests = @requests + 1
+        Process.kill(:QUIT, Process.pid) if harakiri?
+      end
+
+      # Is it time to honorably retire?
+      #
+      def harakiri?
+        @requests >= @quit_after_requests
+      end
+
     end
-    
   end
+
 end

data/lib/picky/results.rb

@@ -1,89 +1,93 @@
-# This is the internal results object. Usually, to_marshal, or to_json
-# is called on it to get a string for the answer.
-#
-class Results
+module Picky
 
-  # Duration is set externally by the query.
+  # This is the internal results object. Usually, to_marshal, or to_json
+  # is called on it to get a string for the answer.
   #
-  attr_writer :duration
-  attr_reader :allocations, :offset, :amount
+  class Results
 
-  # Takes instances of Query::Allocations as param.
-  #
-  def initialize amount = 0, offset = 0, allocations = Query::Allocations.new
-    @offset      = offset
-    @amount      = amount
-    @allocations = allocations
-  end
-  # Create new results and calculate the ids.
-  #
-  def self.from amount, offset, allocations
-    results = new amount, offset, allocations
-    results.prepare!
-    results
-  end
+    # Duration is set externally by the query.
+    #
+    attr_writer :duration
+    attr_reader :allocations, :offset, :amount
 
-  # Returns a hash with the allocations, offset, duration and total.
-  #
-  def serialize
-    { allocations: allocations.to_result,
-      offset:      offset,
-      duration:    duration,
-      total:       total }
-  end
-  # The default format is json.
-  #
-  def to_response options = {}
-    to_json options
-  end
-  # Convert to json format.
-  #
-  def to_json options = {}
-    serialize.to_json options
-  end
+    # Takes instances of Query::Allocations as param.
+    #
+    def initialize amount = 0, offset = 0, allocations = Query::Allocations.new
+      @offset      = offset
+      @amount      = amount
+      @allocations = allocations
+    end
+    # Create new results and calculate the ids.
+    #
+    def self.from amount, offset, allocations
+      results = new amount, offset, allocations
+      results.prepare!
+      results
+    end
 
-  # This starts the actual processing.
-  #
-  # Without this, the allocations are not processed,
-  # and no ids are calculated.
-  #
-  def prepare!
-    allocations.process! amount, offset
-  end
+    # Returns a hash with the allocations, offset, duration and total.
+    #
+    def serialize
+      { allocations: allocations.to_result,
+        offset:      offset,
+        duration:    duration,
+        total:       total }
+    end
+    # Convert to json format.
+    #
+    def to_json options = {}
+      serialize.to_json options
+    end
+    # The default format is json.
+    #
+    alias to_response to_json
 
-  # Duration default is 0.
-  #
-  def duration
-    @duration || 0
-  end
-  # The total results. Delegates to the allocations.
-  #
-  # Caches.
-  #
-  def total
-    @total || @total = allocations.total || 0
-  end
+    # This starts the actual processing.
+    #
+    # Without this, the allocations are not processed,
+    # and no ids are calculated.
+    #
+    def prepare!
+      allocations.process! amount, offset
+    end
 
-  # Convenience methods.
-  #
+    # Duration default is 0.
+    #
+    def duration
+      @duration || 0
+    end
+    # The total results. Delegates to the allocations.
+    #
+    # Caches.
+    #
+    def total
+      @total || @total = allocations.total || 0
+    end
 
-  # Delegates to allocations.
-  #
-  def ids amount = 20
-    allocations.ids amount
-  end
+    # Convenience methods.
+    #
+
+    # Delegates to allocations.
+    #
+    def ids amount = 20
+      allocations.ids amount
+    end
+
+    # Human readable log.
+    #
+    # TODO Should this be to_s? (And it should also hold the original query?)
+    #
+    def to_log query
+      "#{log_type}|#{Time.now.to_s(:db)}|#{'%8f' % duration}|#{'%-50s' % query}|#{'%8d' % total}|#{'%4d' % offset}|#{'%2d' % allocations.size}|"
+    end
+    # The first character in the blog designates what type of query it is.
+    #
+    # No calculated ids means: No results.
+    #
+    def log_type
+      amount.zero?? :'.' : :'>'
+    end
 
-  # Human readable log.
-  #
-  def to_log query
-    "#{log_type}|#{Time.now.to_s(:db)}|#{'%8f' % duration}|#{'%-50s' % query}|#{'%8d' % total}|#{'%4d' % offset}|#{'%2d' % allocations.size}|"
-  end
-  # The first character in the blog designates what type of query it is.
-  #
-  # No calculated ids means: No results.
-  #
-  def log_type
-    amount.zero?? :'.' : :'>'
   end
 
 end

data/lib/picky/search.rb

@@ -1,176 +1,187 @@
-# = Picky Queries
-#
-# A Picky Search is an object which:
-# * holds one or more indexes
-# * offers an interface to query these indexes.
-#
-# You connect URL paths to indexes via a Query.
-#
-# We recommend not to use this directly, but connect it to an URL and query through one of these
-# (Protip: Use "curl 'localhost:8080/query/path?query=exampletext')" in a Terminal.
-#
-class Search
-
-  include Helpers::Measuring
-
-  attr_reader   :indexes
-  attr_writer   :tokenizer
-  attr_accessor :weights
-
-  # Takes:
-  # * A number of indexes
-  # * Options hash (optional) with:
-  #   * tokenizer: Tokenizers::Query.default by default.
-  #   * weights:   A hash of weights, or a Query::Weights object.
-  #
-  # TODO Add identifiers_to_remove (rename) and reduce_allocations_to_amount (rename).
-  # TODO categories_to_remove ?
-  #
-  # It is also possible to define the tokenizer and weights like so.
-  # Example:
-  #   Search.new(index1, index2, index3) do
-  #     searching removes_characters: /[^a-z]/, etc.
-  #     weights [:author, :title] => +3, [:title, :isbn] => +1
-  #   end
-  #
-  def initialize *index_definitions
-    options      = Hash === index_definitions.last ? index_definitions.pop : {}
-
-    @indexes  = Query::Indexes.new *index_definitions, combinations_type_for(index_definitions)
-    searching options[:tokenizer]
-    boost     options[:weights]
-
-    instance_eval(&Proc.new) if block_given?
-  end
+module Picky
+
+  # = Picky Queries
+  #
+  # A Picky Search is an object which:
+  # * holds one or more indexes
+  # * offers an interface to query these indexes.
+  #
+  # You connect URL paths to indexes via a Query.
+  #
+  # We recommend not to use this directly, but connect it to an URL and query through one of these
+  # (Protip: Use "curl 'localhost:8080/query/path?query=exampletext')" in a Terminal.
+  #
+  class Search
+
+    include Helpers::Measuring
+
+    attr_reader   :indexes
+    attr_writer   :tokenizer
+    attr_accessor :weights
+
+    # Takes:
+    # * A number of indexes
+    # * Options hash (optional) with:
+    #   * tokenizer: Tokenizers::Query.default by default.
+    #   * weights:   A hash of weights, or a Query::Weights object.
+    #
+    # TODO Add identifiers_to_remove (rename) and reduce_allocations_to_amount (rename).
+    # TODO categories_to_remove ?
+    #
+    # It is also possible to define the tokenizer and weights like so.
+    # Example:
+    #   Search.new(index1, index2, index3) do
+    #     searching removes_characters: /[^a-z]/, etc.
+    #     weights [:author, :title] => +3, [:title, :isbn] => +1
+    #   end
+    #
+    def initialize *index_definitions
+      options = Hash === index_definitions.last ? index_definitions.pop : {}
+
+      @indexes = Query::Indexes.new *index_definitions, combinations_type_for(index_definitions)
+      searching options[:tokenizer]
+      boost     options[:weights]
+
+      instance_eval(&Proc.new) if block_given?
+    end
 
-  # TODO Doc. Spec.
-  #
-  # Example:
-  #   Search.new(index1, index2, index3) do
-  #     searching removes_characters: /[^a-z]/, etc.
-  #     weights [:author, :title] => +3, [:title, :isbn] => +1
-  #   end
-  #
-  def searching options
-    @tokenizer = if options.respond_to?(:tokenize)
-      options
-    else
-      options && Tokenizers::Query.new(options)
+    # Example:
+    #   Search.new(index1, index2, index3) do
+    #     searching removes_characters: /[^a-z]/, etc.
+    #     weights [:author, :title] => +3, [:title, :isbn] => +1
+    #   end
+    #
+    def searching options
+      @tokenizer = if options.respond_to?(:tokenize)
+        options
+      else
+        options && Tokenizers::Query.new(options)
+      end
     end
-  end
 
-  # Returns the tokenizer if set or if not, the query tokenizer.
-  #
-  def tokenizer
-    @tokenizer || Tokenizers::Query.default
-  end
+    # Returns the tokenizer if set or if not, the query tokenizer.
+    #
+    def tokenizer
+      @tokenizer || Tokenizers::Query.default
+    end
 
-  # TODO Doc. Spec.
-  #
-  # Example:
-  #   Search.new(index1, index2, index3) do
-  #     searching removes_characters: /[^a-z]/, etc.
-  #     boost [:author, :title] => +3, [:title, :isbn] => +1
-  #   end
-  #
-  def boost options
-    weights  = options || Query::Weights.new
-    @weights = Hash === weights ? Query::Weights.new(weights) : weights
-  end
+    # Example:
+    #   Search.new(index1, index2, index3) do
+    #     searching removes_characters: /[^a-z]/, etc.
+    #     boost [:author, :title] => +3, [:title, :isbn] => +1
+    #   end
+    #
+    def boost options
+      weights  = options || Query::Weights.new
+      @weights = Hash === weights ? Query::Weights.new(weights) : weights
+    end
 
-  # Returns the right combinations strategy for
-  # a number of query indexes.
-  #
-  # Currently it isn't possible using Memory and Redis etc.
-  # indexes in the same query index group.
-  #
-  # Picky will raise a Query::Indexes::DifferentTypesError.
-  #
-  @@mapping = {
-    Index::Memory => Query::Combinations::Memory,
-    Index::Redis  => Query::Combinations::Redis
-  }
-  def combinations_type_for index_definitions_ary
-    index_types = index_definitions_ary.map(&:class)
-    index_types.uniq!
-    raise_different(index_types) if index_types.size > 1
-    !index_types.empty? && @@mapping[*index_types] || Query::Combinations::Memory
-  end
-  # Currently it isn't possible using Memory and Redis etc.
-  # indexes in the same query index group.
-  #
-  class DifferentTypesError < StandardError
-    def initialize types
-      @types = types
+    # Returns the right combinations strategy for
+    # a number of query indexes.
+    #
+    # Currently it isn't possible using Memory and Redis etc.
+    # indexes in the same query index group.
+    #
+    # Picky will raise a Query::Indexes::DifferentTypesError.
+    #
+    @@mapping = {
+      Indexes::Memory => Query::Combinations::Memory,
+      Indexes::Redis  => Query::Combinations::Redis
+    }
+    def combinations_type_for index_definitions_ary
+      index_types = extract_index_types index_definitions_ary
+      !index_types.empty? && @@mapping[*index_types] || Query::Combinations::Memory
     end
-    def to_s
-      "Currently it isn't possible to mix #{@types.join(" and ")} Indexes in the same Search instance."
+    def extract_index_types index_definitions_ary
+      index_types = index_definitions_ary.map(&:class)
+      index_types.uniq!
+      check_index_types index_types
+      index_types
+    end
+    def check_index_types index_types
+      raise_different index_types if index_types.size > 1
+    end
+    # Currently it isn't possible using Memory and Redis etc.
+    # indexes in the same query index group.
+    #
+    class DifferentTypesError < StandardError
+      def initialize types
+        @types = types
+      end
+      def to_s
+        "Currently it isn't possible to mix #{@types.join(" and ")} Indexes in the same Search instance."
+      end
+    end
+    def raise_different index_types
+      raise DifferentTypesError.new(index_types)
     end
-  end
-  def raise_different index_types
-    raise DifferentTypesError.new(index_types)
-  end
-
-  # This is the main entry point for a query.
-  # Use this in specs and also for running queries.
-  #
-  # Parameters:
-  # * text: The search text.
-  # * ids = 20: _optional_ The amount of ids to calculate (with offset).
-  # * offset = 0: _optional_ The offset from which position to return the ids. Useful for pagination.
-  #
-  # Note: The Rack adapter calls this method after unravelling the HTTP request.
-  #
-  def search_with_text text, ids = 20, offset = 0
-    search tokenized(text), ids, offset
-  end
 
-  # Runs the actual search using Query::Tokens.
-  #
-  # Note: Internal method, use #search_with_text.
-  #
-  def search tokens, ids = 20, offset = 0
-    results = nil
+    # This is the main entry point for a query.
+    # Use this in specs and also for running queries.
+    #
+    # Parameters:
+    # * text: The search text.
+    # * ids = 20: _optional_ The amount of ids to calculate (with offset).
+    # * offset = 0: _optional_ The offset from which position to return the ids. Useful for pagination.
+    #
+    # Note: The Rack adapter calls this method after unravelling the HTTP request.
+    #
+    # TODO Rename to search.
+    #
+    def search_with_text text, ids = 20, offset = 0
+      search tokenized(text), ids.to_i, offset.to_i
+    end
 
-    duration = timed do
-      results = execute tokens, ids, offset
+    # Runs the actual search using Query::Tokens.
+    #
+    # Note: Internal method, use #search_with_text.
+    #
+    # TODO Rename to search_with.
+    #
+    def search tokens, ids = 20, offset = 0
+      results = nil
+
+      duration = timed do
+        results = execute tokens, ids, offset
+      end
+      results.duration = duration.round 6
+
+      results
     end
-    results.duration = duration.round 6
 
-    results
-  end
+    # Execute a search using Query::Tokens.
+    #
+    # Note: Internal method, use #search_with_text.
+    #
+    def execute tokens, ids, offset
+      Results.from ids, offset, sorted_allocations(tokens)
+    end
 
-  # Execute a search using Query::Tokens.
-  #
-  # Note: Internal method, use #search_with_text.
-  #
-  def execute tokens, ids, offset
-    Results.from ids, offset, sorted_allocations(tokens)
-  end
+    # Delegates the tokenizing to the query tokenizer.
+    #
+    # Parameters:
+    # * text: The text to tokenize.
+    #
+    def tokenized text
+      tokenizer.tokenize text
+    end
 
-  # Delegates the tokenizing to the query tokenizer.
-  #
-  # Parameters:
-  # * text: The text to tokenize.
-  #
-  def tokenized text
-    tokenizer.tokenize text
-  end
+    # Gets sorted allocations for the tokens.
+    #
+    def sorted_allocations tokens # :nodoc:
+      indexes.prepared_allocations_for tokens, weights
+    end
 
-  # Gets sorted allocations for the tokens.
-  #
-  def sorted_allocations tokens # :nodoc:
-    @indexes.prepared_allocations_for tokens, weights
-  end
+    # Display some nice information for the user.
+    #
+    def to_s
+      s = "#{self.class}("
+      s << @indexes.indexes.map(&:name).join(', ')
+      s << ", weights: #{@weights}" unless @weights.empty?
+      s << ")"
+      s
+    end
 
-  # Display some nice information for the user.
-  #
-  def to_s
-    s = "#{self.class}("
-    s << @indexes.indexes.map(&:name).join(', ')
-    s << ", weights: #{@weights}" unless @weights.empty?
-    s << ")"
-    s
   end
 
 end

data/lib/picky/sinatra.rb

@@ -0,0 +1,34 @@
+module Picky
+
+  # This Module is used to install delegator methods
+  # into the class for use with Sinatra.
+  #
+  module Sinatra
+
+    # Privatizes app file methods.
+    #
+    def self.extended into
+      private :indexing, :searching
+    end
+
+    # Delegates to Application.
+    #
+    def indexing options
+      Application.indexing options
+    end
+
+    # Delegates to Application.
+    #
+    def searching options
+      Application.searching options
+    end
+
+  end
+
+end
+
+# Check if toplevel Sinatra picky methods need to be installed.
+#
+if private_methods.include? :get
+  extend Picky::Sinatra
+end