Initial commit & license

.gitignore

@@ -0,0 +1,8 @@
+.DS_Store
+pkg/
+server/lib/picky/ext/ruby19/Makefile
+server/lib/picky/ext/ruby19/mkmf.log
+server/lib/picky/ext/ruby19/performant.bundle
+
+server/.yardoc
+server/doc

README.textile

@@ -0,0 +1,7 @@
+Note: In development. Expect release version in September 2010.
+
+h1. Picky
+
+h2. The combinatorial small-text search engine.
+
+The search enine is split into a server and a client which is to be used in e.g. Rails.

client/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

client/README.textile

@@ -0,0 +1,3 @@
+h1. Search engine client.
+
+# TODO Usage etc.

client/Rakefile

@@ -0,0 +1,55 @@
+require 'rake'
+require 'rake/gempackagetask'
+
+task :default => :spec
+
+# Gemming
+#
+desc "Create the picky search engine client"
+spec = Gem::Specification.new do |s|
+  s.name = 'picky-client'
+  s.version = '0.0.0'
+  s.author = 'Florian Hanke'
+  s.email = 'florian.hanke+picky-client@gmail.com'
+  s.homepage = 'http://floere.github.com/picky'
+  s.platform = Gem::Platform::RUBY
+  s.summary = 'picky Search Engine Client'
+  s.files = Dir["lib/**/*.rb"]
+  s.test_files = Dir["spec/**/*_spec.rb"]
+  s.has_rdoc = false
+  s.extra_rdoc_files = ['README.textile']
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_tar = true
+end
+
+require 'spec'
+require 'spec/rake/spectask'
+
+spec_root = File.join(File.dirname(__FILE__), 'spec')
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts = ['--options', "\"#{File.join(spec_root, 'spec.opts')}\""]
+  t.spec_files = FileList[File.join(spec_root, '**', '*_spec.rb')]
+end
+namespace :spec do
+
+  desc "Run all specs in spec directory with RCov (excluding plugin specs)"
+  Spec::Rake::SpecTask.new(:rcov) do |t|
+    t.spec_opts = ['--options', "\"spec/spec.opts\""]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.rcov = true
+    t.rcov_opts = lambda do
+      IO.readlines("#{SEARCH_ROOT}/spec/rcov.opts").map {|l| l.chomp.split " "}.flatten
+    end
+  end
+
+  desc "Print Specdoc for all specs (excluding plugin specs)"
+  Spec::Rake::SpecTask.new(:doc) do |t|
+    t.spec_opts = ["--format", "specdoc", "--dry-run"]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+  end
+
+end

client/lib/search-engine.rb

@@ -0,0 +1,10 @@
+$KCODE = 'UTF-8' unless RUBY_VERSION > '1.8.7'
+
+require 'rubygems'
+
+require 'active_support'
+
+this = File.dirname __FILE__
+require File.join(this, '/search/engine')
+require File.join(this, '/search/serializer')
+require File.join(this, '/search/convenience')

client/lib/search/convenience.rb

@@ -0,0 +1,37 @@
+module Search
+  # Use this class to extend the hash the serializer returns.
+  #
+  module Convenience
+
+    # Are there any allocations?
+    #
+    def empty?
+      allocations.empty?
+    end
+    # Returns the topmost limit results.
+    #
+    def ids limit = 20
+      ids = []
+      allocations.each { |allocation| allocation[4].each { |id| break if ids.size > limit; ids << id } }
+      ids
+    end
+    # Removes the ids from each allocation.
+    #
+    def clear_ids
+      allocations.each { |allocation| allocation[4].clear }
+    end
+
+    # Caching readers.
+    #
+    def allocations
+      @allocations || @allocations = self[:allocations]
+    end
+    def allocations_size
+      @allocations_size || @allocations_size = allocations.size
+    end
+    def total
+      @total || @total = self[:total]
+    end
+
+  end
+end

client/lib/search/engine.rb

@@ -0,0 +1,96 @@
+require 'net/http'
+
+module Search
+  # Frontend for the search client.
+  #
+  # Configure a search by passing the options in the initializer:
+  #   * host
+  #   * port
+  #   * path
+  #
+  # TODO Rewrite such that instead of an http request we connect through tcp.
+  # Or use EventMachine.
+  #
+  module Engine
+
+    class Base
+
+      attr_accessor :host, :port, :path
+
+      def initialize options = {}
+        options = default_configuration.merge options
+
+        @host = options[:host]
+        @port = options[:port]
+        @path = options[:path]
+      end
+      def default_configuration
+        {}
+      end
+      def self.default_configuration options = {}
+        define_method :default_configuration do
+          options
+        end
+      end
+      def default_params
+        {}
+      end
+      def self.default_params options = {}
+        options.stringify_keys! if options.respond_to?(:stringify_keys!)
+        define_method :default_params do
+          options
+        end
+      end
+
+      # Merges the given params, overriding the defaults.
+      #
+      def defaultize params = {}
+        default_params.merge params
+      end
+
+      # Searches the index. Use this method.
+      #
+      # Returns a hash. Extend with Convenience.
+      #
+      def search params = {}
+        return {} if params[:query].blank?
+
+        send_search params
+      end
+
+      # Sends a search to the configured address.
+      #
+      def send_search params = {}
+        params = defaultize params
+        Net::HTTP.get self.host, "#{self.path}?#{params.to_query}", self.port
+      end
+
+    end
+
+    class Full < Base
+      default_configuration :host => 'localhost', :port => 4000, :path => '/searches/full'
+
+      # Full needs to deserialize the results.
+      #
+      def send_search params = {}
+        Serializer.deserialize super(params)
+      end
+
+    end
+
+    class Live < Base
+      default_configuration :host => 'localhost', :port => 4000, :path => '/searches/live'
+    end
+
+  end
+end
+
+# Extend hash with to_query method.
+#
+class Hash
+  def to_query namespace = nil
+    collect do |key, value|
+      value.to_query(namespace ? "#{namespace}[#{key}]" : key)
+    end.sort * '&'
+  end
+end