lunar 0.5.0 → 0.5.1

data/README.markdown

@@ -1,6 +1,8 @@
 Lunar: full text searching on top of Redis
 ==========================================
 
+Read the documentation at http://sinefunc.github.com/lunar/doc
+
 But why?
 --------
 We have been using Redis as our datastore exclusively for a lot of projects.
@@ -113,4 +115,4 @@ Note on Patches/Pull Requests
 
 ### Copyright
 
-Copyright (c) 2010 Cyril David. See LICENSE for details.
+Copyright (c) 2010 Cyril David. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.5.0
+0.5.1

data/lib/lunar.rb

@@ -4,7 +4,7 @@ require 'nest'
 require 'text'
 
 module Lunar
-  VERSION = '0.5.0'
+  VERSION = '0.5.1'
 
   autoload :Connection,     "lunar/connection"
   autoload :LunarNest,      "lunar/lunar_nest"
@@ -23,7 +23,7 @@ module Lunar
   # Index any document using a namespace. The namespace can
   # be a class, or a plain Symbol/String.
   #
-  # @example:
+  # @example
   #
   #   Lunar.index Gadget do |i|
   #     i.text  :name, 'iphone 3gs'
@@ -54,7 +54,7 @@ module Lunar
 
   # Search for a document, scoped under a namespace.
   #
-  # @example:
+  # @example
   #
   #   Lunar.search Gadget, :q => "apple"
   #   # returns all gadgets with `text` apple.
@@ -82,32 +82,10 @@ module Lunar
   #
   # @return Lunar::ResultSet an Enumerable object.
   def self.search(namespace, options, finder = lambda { |id| namespace[id] })
-    ns = nest[namespace]
+    sets = find_and_combine_sorted_sets_for(namespace, options)
+    key  = try_intersection_of_sorted_sets(namespace, sets)
 
-    sets =
-      options.map do |key, value|
-        if value.is_a?(Range)
-          RangeMatches.new(nest[namespace], key, value).distkey
-        elsif key == :fuzzy
-          value.map do |fuzzy_key, fuzzy_value|
-            FuzzyMatches.new(nest[namespace], fuzzy_key, fuzzy_value).distkey
-          end
-        else
-          KeywordMatches.new(nest[namespace], key, value).distkey
-        end
-      end
-
-    sets = sets.flatten
-
-    key =
-      if sets.size == 1
-        sets.first
-      else
-        ns[options.hash].zinterstore sets
-        ns[options.hash]
-      end
-
-    ResultSet.new(key, ns, finder)
+    ResultSet.new(key, nest[namespace], finder)
   end
 
   # @private internally used for determining the metaphone of a word.
@@ -124,4 +102,31 @@ module Lunar
   def self.nest
     LunarNest.new(:Lunar, redis)
   end
-end
+
+private
+  def self.find_and_combine_sorted_sets_for(namespace, options)
+    options.inject([]) do |sets, (key, value)|
+      if value.is_a?(Range)
+        sets << RangeMatches.new(nest[namespace], key, value).distkey
+      elsif key == :fuzzy
+        fuzzy_matches = value.map { |fuzzy_key, fuzzy_value|
+          FuzzyMatches.new(nest[namespace], fuzzy_key, fuzzy_value).distkey
+        }
+        sets.push(*fuzzy_matches)
+      else
+        sets << KeywordMatches.new(nest[namespace], key, value).distkey
+      end
+
+      sets
+    end
+  end
+
+  def self.try_intersection_of_sorted_sets(namespace, sets)
+    if sets.size == 1
+      sets.first
+    else
+      nest[namespace][options.hash].zinterstore sets
+      nest[namespace][options.hash]
+    end
+  end
+end

data/lib/lunar/connection.rb

@@ -1,4 +1,15 @@
 module Lunar
+  # This is actually taken from Ohm (http://ohm.keyvalue.org). The Lunar module 
+  # extends this to make the API easier to use.
+  #
+  #   Lunar.connect(:host => "127.0.0.1", :port => "6380")
+  #   Lunar.redis
+  #   # basically returns Redis.new(:host => "127.0.0.1", :port => "6380")
+  #
+  #   # If you don't provide any connection, it assumes you are referring
+  #   # to the default redis host / port (127.0.0.1 on port 6379)
+  #   Lunar.redis
+  #
   module Connection
     # Connect to a redis database.
     #
@@ -48,4 +59,4 @@ module Lunar
       @options || []
     end
   end
-end
+end

data/lib/lunar/fuzzy_word.rb

@@ -1,7 +1,15 @@
 module Lunar
+  # @private A helper for producing all the characters of a word.
+  #
+  # @example
+  #   
+  #   expected = %w(a ab abr abra abrah abraha abraham)
+  #   FuzzyWord.new("Abraham").partials == expected
+  #   # => true
+  #
   class FuzzyWord < String
     def partials
       (1..length).map { |i| self[0, i].downcase }
     end
   end
-end
+end

data/lib/lunar/index.rb

@@ -31,7 +31,7 @@ module Lunar
     end
 
     # Get / Set the id of the document
-    # @example:
+    # @example
     #
     #   # Wrong usage:
     #   Lunar.index :Gadget do |i|
@@ -239,4 +239,4 @@ module Lunar
       end
     end
   end
-end
+end

data/lib/lunar/result_set.rb

@@ -2,8 +2,6 @@ module Lunar
   # This wraps a Lunar search result set. You can do all the
   # expected operations with an Enumerable.
   #
-  # @example:
-  #
   #   results = Lunar.search(Gadget, :q => "Apple Macbook Pro")
   #   results.class == Lunar::ResultSet
   #   # => true
@@ -11,8 +9,8 @@ module Lunar
   #   results.kind_of?(Enumerable)
   #   # => true
   #
-  # `sort` and `sort_by` commands are available and directly calls
-  # the Redis SORT command.
+  # {Lunar::ResultSet#sort} and {Lunar::ResultSet#sort_by} commands are 
+  # available and directly calls the Redis SORT command.
   #
   #   results = Lunar.search(Gadget, :q => "Apple Macbook Pro")
   #   results.sort(:by => :name, :order => "ALPHA")
@@ -40,7 +38,7 @@ module Lunar
 
     # Provides syntatic sugar for `sort`.
     #
-    # @example:
+    # @example
     #
     #   results = Lunar.search(Gadget, :q => "apple")
     #   results.sort(:by => :votes)
@@ -60,7 +58,7 @@ module Lunar
     # Gives the ability to sort the search results via a `sortable` field
     # in your index.
     #
-    # @example:
+    # @example
     #
     #   Lunar.index Gadget do |i|
     #     i.id 1001
@@ -97,4 +95,4 @@ module Lunar
       ids.map(&@finder)
     end
   end
-end
+end

data/lib/lunar/stopwords.rb

@@ -1,4 +1,6 @@
 module Lunar
+  # @private Internally used by {Lunar::Words} to filter out
+  # common words like an, the, etc.
   module Stopwords
     def include?(word)
       stopwords.include?(word)

data/lunar.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{lunar}
-  s.version = "0.5.0"
+  s.version = "0.5.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Cyril David"]

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 5
-  - 0
-  version: 0.5.0
+  - 1
+  version: 0.5.1
 platform: ruby
 authors: 
 - Cyril David