lunar 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Cyril David
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,17 @@
+= 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/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "lunar"
+    gem.summary = %Q{a minimalistic full text search implementation in redis}
+    gem.description = %Q{uses sorted sets and sets, sorting by score}
+    gem.email = "cyx.ucron@gmail.com"
+    gem.homepage = "http://github.com/cyx/lunar"
+    gem.authors = ["Cyril David"]
+    gem.add_development_dependency "contest"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "lunar #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/examples/ohm.rb

@@ -0,0 +1,23 @@
+class Item < Ohm::Model
+  attribute :name
+  attribute :description
+
+  def index
+    Lunar::Index.create(
+      self.class.name, 
+      self.id,
+      :name => name,
+      :description => description
+    )
+
+    index = Lunar::Index.new('Item')
+    index.attrs = { :name => name, :description => description }
+    index.create
+
+    Luner::Index.create 'Item' do |i|
+      i.key  id
+      i.attr :name, name
+      i.attr :description, description
+    end
+  end
+end

data/lib/lunar.rb

@@ -0,0 +1,12 @@
+require 'base64'
+require File.join(File.dirname(__FILE__), '..', 'vendor', 'nest', 'nest')
+
+module Lunar
+  autoload :Scoring, 'lunar/scoring'
+  autoload :Doc,     'lunar/doc'
+  autoload :Index,   'lunar/index'
+
+  def self.redis(connection = defined?(Ohm) ? Ohm.redis : nil)
+    @connection ||= connection 
+  end
+end

data/lib/lunar/doc.rb

@@ -0,0 +1,13 @@
+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/lib/lunar/index.rb

@@ -0,0 +1,70 @@
+module Lunar
+  class Index
+    attr :ns
+  
+    def self.create(prefix)
+      new(prefix).tap { |i| yield i }.index
+    end
+
+    def self.delete(prefix, key)
+      new(prefix).tap { |i| i.key key }.delete 
+    end
+
+    def initialize(prefix, redis = nil)
+      @ns    = Nest.new(:Lunar)[prefix]
+      @attrs = {}
+      @redis = (redis || Lunar.redis)
+    end
+
+    def key(key = nil)
+      @key = key if key
+      @key
+    end
+
+    def attrs=(attrs)
+      attrs.each { |k, v| attr k, v } 
+    end
+
+    def attr(field, value = nil)
+      @attrs[field.to_sym] = value if value
+      @attrs[field.to_sym]
+    end
+
+    def index
+      @attrs.each do |field, value|
+        scoring = Scoring.new(value)
+        words   = []
+        scoring.scores.each do |word, score|
+          words << word
+          @redis.zadd @ns[field][encode(word)], score, key
+          @redis.sadd @ns[key][field], word
+        end
+
+        unused_words = @redis.smembers(@ns[key][field]) - words
+        unused_words.each do |word|
+          @redis.zrem @ns[field][encode(word)], key
+          @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][encode(w)], key
+        end
+        @redis.del k 
+      end
+    end
+
+  private
+    def encode(str)
+      Base64.encode64(str).strip
+    end
+  end
+end

data/lib/lunar/scoring.rb

@@ -0,0 +1,11 @@
+module Lunar
+  class Scoring
+    def initialize(words)
+      @words = words.split(/\s+/).reject { |w| w.to_s.strip.empty? }
+    end
+
+    def scores
+      @words.inject(Hash.new(0)) { |a, w| a[w.downcase] += 1; a }
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'test/unit'
+require 'contest'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'lunar'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../vendor/redis/lib')
+require 'redis'
+
+class Test::Unit::TestCase
+end

data/test/test_lunar.rb

@@ -0,0 +1,4 @@
+require 'helper'
+
+class TestLunar < Test::Unit::TestCase
+end

data/test/test_lunar_document.rb

@@ -0,0 +1,20 @@
+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

data/test/test_lunar_index.rb

@@ -0,0 +1,174 @@
+require "helper"
+
+class LunarIndexTest < Test::Unit::TestCase
+  context "given Item" do
+    setup do
+      @index = Lunar::Index.new('Item')
+    end
+
+    should "have a Lunar:Item ns" do
+      assert_equal 'Lunar:Item', @index.ns
+    end
+
+    context "when setting attr :name, 'iphone'" do
+      should "have attr(:name) iphone" do
+        @index.attr :name, 'iphone'
+
+        assert_equal 'iphone', @index.attr(:name)
+      end
+    end
+
+    context "when setting attrs name iphone desc cellular mobile" do
+      setup do
+        @index.attrs = { :name => 'iphone', :desc => 'cellular mobile' }
+      end
+
+      should "be able to retrieve them via symbol or string" do
+        assert_equal 'iphone', @index.attr(:name)
+        assert_equal 'cellular mobile', @index.attr('desc')
+      end
+    end
+  end
+
+  context "on create" 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.attr :name, 'iphone 3G'
+        i.attr :description, 'the cellular mobile is the shiznit'
+      end
+    end
+
+    should "store Lunar:Item:name:iphone 1001 1" do
+      assert_equal "1",
+        zscore("Lunar:Item:name:#{ encode('iphone') }", 1001)
+    end
+
+    should "store Lunar:Item:name:3g 1001 1" do
+      assert_equal "1",
+        zscore("Lunar:Item:name:#{ encode('3g') }", 1001)
+    end
+
+    should "store Lunar:Item:description:cellular 1001 1" do
+      assert_equal "1",
+        zscore("Lunar:Item:description:#{ encode('cellular') }", 1001)
+    end
+
+    should "store Lunar:Item:description:the 1001 2" do
+      assert_equal "2",
+        zscore("Lunar:Item:description:#{ encode('the') }", 1001)
+    end
+
+    should "store Lunar:Item:1001:name <iphone 3g> set" do
+      set = Lunar.redis.smembers("Lunar:Item:1001:name")
+
+      assert set.include?('iphone')
+      assert set.include?('3g')
+    end
+
+    should "store Lunar:Item:1001:description of all words" do
+      set = Lunar.redis.smembers("Lunar:Item:1001:description")
+
+      assert set.include?('the')
+      assert set.include?('cellular')
+      assert set.include?('mobile')
+      assert set.include?('is')
+      assert set.include?('shiznit')
+    end
+  end
+
+  context "when creating an index that already exists" 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.attr :name, 'iphone 3G'
+        i.attr :description, 'the cellular mobile is the shiznit'
+      end
+
+      @index = Lunar::Index.create 'Item' do |i|
+        i.key  1001
+        i.attr :name, 'iphone 3GS'
+        i.attr :description, 'kickass'
+      end
+    end
+    
+    should "update the references for Item:name" do
+      set = Lunar.redis.smembers("Lunar:Item:1001:name")
+
+      assert ! set.include?('3g'), "should not include 3G"
+      assert set.include?('3gs'), "should include 3GS"
+    end
+
+    should "also remove the scores for the non-existent references for name" do
+      assert_nil zscore("Lunar:Item:name:#{ encode('3g') }", 1001)
+    end
+
+    should "update the references for Item:description" do
+      set = Lunar.redis.smembers("Lunar:Item:1001:description")
+
+      assert ! set.include?('the')
+      assert ! set.include?('cellular')
+      assert ! set.include?('mobile')
+      assert ! set.include?('is')
+      assert ! set.include?('shiznit')
+
+      assert set.include?('kickass')
+    end
+
+    should "also remove the scores for the non-existent references for desc" do
+      assert_nil zscore("Lunar:Item:description:#{ encode('the') }", 1001)
+      assert_nil zscore("Lunar:Item:description:#{ encode('cellular') }", 1001)
+      assert_nil zscore("Lunar:Item:description:#{ encode('mobile') }", 1001)
+      assert_nil zscore("Lunar:Item:description:#{ encode('is') }", 1001)
+      assert_nil zscore("Lunar:Item:description:#{ encode('shiznit') }", 1001)
+
+      assert_equal "1", 
+        zscore("Lunar:Item:description:#{ encode('kickass') }", 1001)
+    end
+  end
+  
+  context "on delete" 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.attr :name, 'iphone 3G'
+        i.attr :description, 'the cellular mobile is the shiznit'
+      end
+
+      Lunar::Index.delete('Item', 1001)
+    end
+    
+    should "remove all references of the document words from the scores" do
+      assert_nil zscore("Lunar:Item:name:#{ encode('iphone') }", 1001)
+      assert_nil zscore("Lunar:Item:name:#{ encode('3g') }", 1001)
+
+      assert_nil zscore("Lunar:Item:description:#{ encode('the') }", 1001)
+      assert_nil zscore("Lunar:Item:description:#{ encode('cellular') }", 1001)
+      assert_nil zscore("Lunar:Item:description:#{ encode('mobile') }", 1001)
+      assert_nil zscore("Lunar:Item:description:#{ encode('is') }", 1001)
+      assert_nil zscore("Lunar:Item:description:#{ encode('shiznit') }", 1001)
+    end
+
+    should "remove all Lunar:Item:* references" do
+      assert ! Lunar.redis.exists("Lunar:Item:1001:name")      
+      assert ! Lunar.redis.exists("Lunar:Item:1001:description")      
+    end
+  end
+protected
+  def encode(str)
+    Base64.encode64(str).strip    
+  end
+
+  def zscore(key, value)
+    Lunar.redis.zscore(key, value) 
+  end
+end