lunar 0.1.1 → 0.2.0

data/README.md

@@ -0,0 +1,55 @@
+Lunar
+=====
+
+A minimalistic search index implemented using Redis, taking advantage of its 
+powerful `sorted sets` and the ability to do set intersection and union.
+
+Results are sorted by their word score, which is stored as the score in the
+Redis sorted set.
+
+Examples
+--------
+
+    class Item < Ohm::Model
+      attribute :name
+      attribute :description
+      
+    protected
+      def write
+        super
+        index
+      end
+
+      def index
+        Lunar::Index.create 'Item' do |i|
+          i.key  id
+          i.attr :name, name
+          i.attr :description, description
+        end
+        
+        # You can also do this, no problem
+        Lunar::Index.create Item do |i|
+          i.key  id
+          i.attr :name, name
+          i.attr :description, description
+        end
+
+        # Or to avoid name ties...
+        Lunar::Index.create self.class do |i|
+          i.key  id
+          i.attr :name, name
+          i.attr :description, description
+        end
+      end
+    end
+
+    # Searching...
+    # You can just straight out search keywords
+    Lunar.search(Item, "iphone")
+
+    # Or opt to filter by field
+    Lunar.search(Item, :name => "iphone", :description => "mobile")
+
+    # Or using the pagination gem with this:
+    @items = Lunar.search(Item, "iphone")
+    paginate @items, :per_page => 10, :page => 1

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/examples/ohm.rb

@@ -35,3 +35,5 @@ Lunar.search(Item, :name => "iphone", :description => "mobile")
 # Or using the pagination gem with this:
 @items = Lunar.search(Item, "iphone")
 paginate @items, :per_page => 10, :page => 1
+
+"Lunar:Item:cost:2300"

data/lib/lunar.rb

@@ -3,7 +3,6 @@ require File.join(File.dirname(__FILE__), '..', 'vendor', 'nest', 'nest')
 
 module Lunar
   autoload :Scoring,   'lunar/scoring'
-  autoload :Doc,       'lunar/doc'
   autoload :Index,     'lunar/index'
   autoload :Words,     'lunar/words'
   autoload :Search,    'lunar/search'

data/lib/lunar/index.rb

@@ -14,6 +14,7 @@ module Lunar
       @ns    = Lunar.nest[prefix]
       @attrs = {}
       @redis = (redis || Lunar.redis)
+      @numeric_attrs = {}
     end
 
     def key(key = nil)
@@ -30,7 +31,34 @@ module Lunar
       @attrs[field.to_sym]
     end
 
+    def numeric_attr(field, value = nil)
+      @numeric_attrs[field.to_sym] = value if value
+      @numeric_attrs[field.to_sym]
+    end
+    alias :integer :numeric_attr
+    alias :float   :numeric_attr
+
     def index
+      index_str_attrs
+      index_numeric_attrs
+
+      return self
+    end
+
+    def delete
+      keys = @redis.keys @ns[key]['*']
+      keys.each do |k|
+        field = k.gsub("#{ @ns[key] }:", '')
+        words = @redis.smembers(k)
+        words.each do |w|
+          @redis.zrem @ns[field][Lunar.encode(w)], key
+        end
+        @redis.del k 
+      end
+    end
+
+  protected
+    def index_str_attrs
       @attrs.each do |field, value|
         scoring = Scoring.new(value)
         words   = []
@@ -46,20 +74,13 @@ module Lunar
           @redis.srem @ns[key][field], word
         end
       end
-
-      return self
     end
 
-    def delete
-      keys = @redis.keys @ns[key]['*']
-      keys.each do |k|
-        field = k.gsub("#{ @ns[key] }:", '')
-        words = @redis.smembers(k)
-        words.each do |w|
-          @redis.zrem @ns[field][Lunar.encode(w)], key
-        end
-        @redis.del k 
+    def index_numeric_attrs
+      @numeric_attrs.each do |field, value|
+        @redis.zadd @ns[field], value, key
       end
     end
+
   end
 end

data/lib/lunar/search.rb

@@ -25,14 +25,6 @@ module Lunar
       else
         ResultSet.new(dist_key, &@finder)
       end
-
-      # ids = Lunar.redis.zrevrange dist_key, start, finish
-
-      # if block_given?
-      #   ids.map { |e| block.call(e) }
-      # else
-      #   ids.map { |e| @@finder.call(prefix, e) }
-      # end
     end
   
   protected

data/lib/lunar/sets.rb

@@ -1,11 +1,50 @@
 module Lunar
-  class Sets < Array
+  module Sets
+    def self.new(prefix, keywords, field = '*')
+      case keywords
+      when String
+        KeywordSets.new(prefix, keywords, field)
+      when Range
+        RangeSets.new(prefix, keywords, field)
+      else
+        raise TypeError, ":keywords should only be a String or Range"
+      end
+    end
+  end
+  
+  class RangeSets < Array
+    attr :prefix, :field, :range
+
+    def initialize(prefix, range, field)
+      @prefix = prefix
+      @field  = field
+      @range  = range
+    
+      super [write_and_retrieve_key]
+    end
+    
+    def write_and_retrieve_key
+      zrange = Lunar.redis.zrangebyscore(Lunar.nest[prefix][field], 
+                                         @range.first, @range.last)
+      zrange.each do |id|
+        Lunar.redis.zadd key, 1, id 
+      end
+      # TODO :expire the key in X seconds where X is customizable
+      key.to_s
+    end
+
+    def key
+      @key ||= Lunar.nest[prefix][field]["#{ range.first }_TO_#{ range.last }"]
+    end
+  end
+
+  class KeywordSets < Array
     attr :prefix, :words, :field
 
     def initialize(prefix, keywords, field = '*')
       @prefix = prefix
-      @words  = Words.new(keywords)
       @field  = field
+      @words = Words.new(keywords)
 
       super(redis_set_keys)
     end

data/lunar.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{lunar}
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Cyril David"]
@@ -14,18 +14,17 @@ Gem::Specification.new do |s|
   s.email = %q{cyx.ucron@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
+     "README.md"
   ]
   s.files = [
     ".document",
      ".gitignore",
      "LICENSE",
-     "README.rdoc",
+     "README.md",
      "Rakefile",
      "VERSION",
      "examples/ohm.rb",
      "lib/lunar.rb",
-     "lib/lunar/doc.rb",
      "lib/lunar/index.rb",
      "lib/lunar/result_set.rb",
      "lib/lunar/scoring.rb",
@@ -35,7 +34,6 @@ Gem::Specification.new do |s|
      "lunar.gemspec",
      "test/helper.rb",
      "test/test_lunar.rb",
-     "test/test_lunar_document.rb",
      "test/test_lunar_index.rb",
      "test/test_lunar_scoring.rb",
      "test/test_lunar_search.rb",
@@ -82,7 +80,6 @@ Gem::Specification.new do |s|
   s.test_files = [
     "test/helper.rb",
      "test/test_lunar.rb",
-     "test/test_lunar_document.rb",
      "test/test_lunar_index.rb",
      "test/test_lunar_scoring.rb",
      "test/test_lunar_search.rb",

data/test/test_lunar_index.rb

@@ -164,6 +164,29 @@ class LunarIndexTest < Test::Unit::TestCase
     end
   end
 
+  context "on create of an index with numeric scores" do
+    setup do
+      Lunar.redis(Redis.new(:host => '127.0.0.1', :port => '6380'))
+      Lunar.redis.flushdb
+
+      @index = Lunar::Index.create 'Item' do |i|
+        i.key  1001
+        i.integer :cost, 2700
+        i.float   :voting_quotient, 35.5
+      end
+    end
+
+    should "store Lunar:Item:cost 1001 2700" do
+      assert_equal "2700", zscore("Lunar:Item:cost", 1001)
+    end
+
+    should "store Lunar:Item:voting_quotient 1001 35.5" do
+      assert_equal "35.5", zscore("Lunar:Item:voting_quotient", 1001)
+    end
+   
+    
+  end
+
 protected
   def encode(str)
     Lunar.encode(str)

data/test/test_lunar_search.rb

@@ -19,6 +19,15 @@ class LunarSearchTest < Test::Unit::TestCase
         i.attr :name, 'apple macbook pro 17"'
         i.attr :desc, 'iphone'
       end
+
+      Lunar::Index.create "Item" do |i|
+        i.key 1003
+        i.attr    :name, 'apple macbook pro 17"'
+        i.attr    :desc, 'iphone'
+        i.integer :cost, '2300'
+        i.float   :voting_quotient, '35.5'
+      end
+
     end
 
     should "be able to search by keyword iphone" do
@@ -73,5 +82,29 @@ class LunarSearchTest < Test::Unit::TestCase
       assert items.map(&:id).include?('1002')
     end
 
+    should "be able to search by cost range: 2000..2700" do
+      items = Lunar.search(Item, :cost => 2000..2700)
+      assert items.map(&:id).include?('1003')
+    end
+
+    should "be able to exclude by cost range: 2000..2200" do
+      items = Lunar.search(Item, :cost => 2000..2200)
+      assert ! items.map(&:id).include?('1003')
+    end
+
+    should "be able to search by range of cost and name" do
+      items = Lunar.search(Item, :cost => 2000..2300, :name => 'apple')
+      assert items.map(&:id).include?('1003')
+    end
+
+    should "be able to search by range of cost and exclude by name" do
+      items = Lunar.search(Item, :cost => 2000..2200, :name => 'foobar')
+      assert ! items.map(&:id).include?('1003')
+    end
+
+    should "be able to search by voting_quotient" do
+      items = Lunar.search(Item, :voting_quotient => 35..40)
+      assert items.map(&:id).include?('1003')
+    end
   end
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Cyril David
@@ -37,17 +37,16 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.md
 files: 
 - .document
 - .gitignore
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - examples/ohm.rb
 - lib/lunar.rb
-- lib/lunar/doc.rb
 - lib/lunar/index.rb
 - lib/lunar/result_set.rb
 - lib/lunar/scoring.rb
@@ -57,7 +56,6 @@ files:
 - lunar.gemspec
 - test/helper.rb
 - test/test_lunar.rb
-- test/test_lunar_document.rb
 - test/test_lunar_index.rb
 - test/test_lunar_scoring.rb
 - test/test_lunar_search.rb
@@ -128,7 +126,6 @@ summary: a minimalistic full text search implementation in redis
 test_files: 
 - test/helper.rb
 - test/test_lunar.rb
-- test/test_lunar_document.rb
 - test/test_lunar_index.rb
 - test/test_lunar_scoring.rb
 - test/test_lunar_search.rb

data/README.rdoc

@@ -1,17 +0,0 @@
-= lunar
-
-Description goes here.
-
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-== Copyright
-
-Copyright (c) 2010 Cyril David. See LICENSE for details.

data/lib/lunar/doc.rb

@@ -1,13 +0,0 @@
-module Lunar
-  class Doc
-    def initialize(attrs)
-      @attrs       = attrs
-    end
-
-    def attr_scores
-      @attrs.inject(Hash.new([])) { |hash, (k, v)| 
-        (hash[k.to_sym] = Scoring.new(v).scores) && hash
-      }
-    end
-  end
-end

data/test/test_lunar_document.rb

@@ -1,20 +0,0 @@
-require "helper"
-
-class LunarDocTest < Test::Unit::TestCase
-  describe "given title => iPhone, description => apple Cellphone Mobile" do
-    setup do
-      @doc = Lunar::Doc.new(:title => 'iPhone', 
-                            :description => 'apple Cellphone Mobile')
-    end
-
-    should "return attr_scores with title iphone 1" do
-      assert_equal 1, @doc.attr_scores[:title]["iphone"]
-    end
-
-    should "return attr_scores with description apple cellphone mobile 1" do
-      assert_equal 1, @doc.attr_scores[:description]["apple"]
-      assert_equal 1, @doc.attr_scores[:description]["cellphone"]
-      assert_equal 1, @doc.attr_scores[:description]["mobile"]
-    end
-  end
-end