redis-autosuggest 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in redis-autosuggest.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Adam Phan
+
+MIT License
+
+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.md

@@ -0,0 +1,29 @@
+# Redis::Autosuggest
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'redis-autosuggest'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redis-autosuggest
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/redis/autosuggest/config.rb

@@ -0,0 +1,44 @@
+class Redis
+  module Autosuggest
+
+    # Default Redis server at localhost:6379
+    @redis = Redis.new
+
+    @db = Redis::Namespace.new("autosuggest", :redis => @redis)
+
+    # Key for a Redis hash mapping ids to items we want to use for autosuggest responses
+    @items = "items"
+
+    # If we want to autosuggest for partial matchings of the word: 'ruby', we would
+    # have four sorted sets: 'autosuggest:substring:r', 'autosuggest:substring:ru',
+    # 'autosuggest:substring:rub', and 'autosuggest:substring:ruby'.
+    # Each sorted set would the id to the word 'ruby'
+    @substrings =  Redis::Namespace.new("autosuggest:substring", :redis => @redis)
+
+    # max number of ids to store per substring.
+    @max_per_substring = Float::INFINITY
+
+    # max number of results to return for an autosuggest query
+    @max_results = 5 
+
+    # Key to a sorted set holding all id of items in the autosuggest database sorted 
+    # by their score
+    @leaderboard = "leaderboard"
+
+    # Leaderboard off by default
+    @use_leaderboard = false
+
+    class << self
+      attr_reader :redis
+      attr_accessor :db, :items, :substrings, :max_per_substring, :max_results,
+        :leaderboard, :use_leaderboard
+
+      def redis=(redis)
+        @redis = redis
+        @db = Redis::Namespace.new("autosuggest", :redis => redis)
+        @substrings =  Redis::Namespace.new("autosuggest:substring", :redis => redis)
+      end
+    end
+  end
+end
+

data/lib/redis/autosuggest/version.rb

@@ -0,0 +1,5 @@
+class Redis
+  module Autosuggest
+    VERSION = "0.0.1"
+  end
+end

data/lib/redis/autosuggest.rb

@@ -0,0 +1,88 @@
+class Redis
+  module Autosuggest
+
+    class << self
+
+      # Add item(s) to the pool of items to autosuggest from.  Each item's initial
+      # rank is 0
+      def add(*items)
+        item_pool = @db.hgetall(@items).values
+        items.each do |i|
+          next if item_pool.include?(i.downcase)
+          add_item(i.downcase)
+        end
+      end
+      
+      # Add item(s) along with their scores.
+      # add_with_score("item1", 4, "item2", 1, "item3", 0)
+      def add_with_score(*fields)
+        item_pool = @db.hgetall(@items).values
+        fields.each_slice(2) do |f|
+          next if item_pool.include?(f[0].downcase)
+          add_item(f[0].downcase, f[1])
+        end
+      end
+
+      # Remove an item from the pool of items to autosuggest from
+      def remove(item)
+        item = item.downcase
+        id = get_id(item)
+        return if id.nil?
+        @db.hdel(@items, id)
+        remove_substrings(item, id)
+        @redis.zrem(@leaderboard, id) if @use_leaderboard
+      end
+
+      # Increment the score (by 1 by default) of an item.  Pass in a negative value
+      # to decrement the score
+      def increment(item, inc=1)
+        item = item.downcase
+        id = get_id(item)
+        each_substring(item) { |sub| @substrings.zincrby(sub, inc, id) }
+        @db.zincrby(@leaderboard, inc, id) if @use_leaderboard
+      end
+
+      # Suggest items from the database that most closely match the queried string.
+      # Returns an array of suggestion items (an empty array if nothing found)
+      def suggest(str, results=@max_results)
+        suggestion_ids = @substrings.zrevrange(str.downcase, 0, results - 1)
+        suggestion_ids.empty? ? [] : @db.hmget(@items, suggestion_ids)
+      end
+
+      # Gets the items with the highest scores from the autosuggest db
+      def get_leaderboard(results=@max_results)
+        top_ids = @db.zrevrange(@leaderboard, 0, results - 1)
+        top_ids.empty? ? [] : @db.hmget(@items, top_ids)  
+      end
+
+      private
+      def add_item(item, score=0)
+        id = self.db.hlen(self.items)
+        self.db.hset(self.items, id, item)
+        add_substrings(item, score, id)
+        self.db.zadd(self.leaderboard, score, id) if self.use_leaderboard
+      end
+
+      # Yield each substring of a complete string 
+      def each_substring(str)
+        (0..str.length - 1).each { |i| yield str[0..i] }
+      end
+
+      # Add all substrings of a string to redis
+      def add_substrings(str, score, id)
+        each_substring(str) { |sub| @substrings.zadd(sub, score, id) }
+      end
+
+      # Remove all substrings of a string from the db
+      def remove_substrings(str, id)
+        each_substring(str) { |sub| @substrings.zrem(sub, id) }
+      end
+
+      # Get the id associated with an item in the db 
+      def get_id(item)
+        kv_pair = @db.hgetall(@items).find { |_, v| v == item}
+        kv_pair.first unless kv_pair.nil?
+      end
+    end
+  end
+end

data/lib/redis-autosuggest.rb

@@ -0,0 +1,5 @@
+require 'redis'
+require 'redis-namespace'
+require 'redis/autosuggest'
+require 'redis/autosuggest/version'
+require 'redis/autosuggest/config'

data/redis-autosuggest.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redis/autosuggest/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "redis-autosuggest"
+  gem.version       = Redis::Autosuggest::VERSION
+  gem.authors       = ["Adam Phan"]
+  gem.email         = ["aphansh@gmail.com"]
+  gem.description   = %q{Provides autocompletions through Redis, with the ability to rank
+  results and integrate with Rails}
+  gem.summary       = %q{Suggestions/autocompletions with Redis and Ruby}
+  gem.homepage      = "https://github.com/aphan/redis-autosuggest"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency("redis", "~> 3.0.1")
+  gem.add_dependency("redis-namespace", "~> 1.2.1")
+
+  gem.add_development_dependency("debugger", "~> 1.2.0")
+  gem.add_development_dependency("minitest", "~> 3.5.0")
+end

data/test/autosuggest_test.rb

@@ -0,0 +1,113 @@
+require 'test_helper'
+
+class TestAutosuggest < MiniTest::Unit::TestCase
+
+  def self.unused_db
+    @unused_db ||= Redis.new(:db => db_picker)
+  end
+
+  # get an unused db so that we can safely clear all keys 
+  def self.db_picker
+    redis = Redis.new
+    (0..15).each do |i|
+      redis.select(i)
+      return i if redis.keys.empty?
+    end
+  end
+
+  def setup
+    self.class.unused_db.flushdb
+    Redis::Autosuggest.redis = self.class.unused_db 
+    @db = Redis::Autosuggest.db
+    @subs = Redis::Autosuggest.substrings
+    @str1 = "Test String"
+  end
+
+  def test_adding_an_item
+    Redis::Autosuggest.add(@str1)
+    assert @db.hgetall(Redis::Autosuggest.items)["0"] == @str1.downcase
+    assert @subs.keys.size == @str1.size 
+    assert_equal ["0"], @subs.zrevrange("t", 0, -1)
+    assert_equal ["0"], @subs.zrevrange("te", 0, -1)
+    assert_equal ["0"], @subs.zrevrange("tes", 0, -1)
+    assert_equal ["0"], @subs.zrevrange("test", 0, -1)
+    assert_equal ["0"], @subs.zrevrange("test ", 0, -1)
+    assert_equal ["0"], @subs.zrevrange("test s", 0, -1)
+    assert_equal ["0"], @subs.zrevrange("test st", 0, -1)
+    assert_equal ["0"], @subs.zrevrange("test str", 0, -1)
+    assert_equal ["0"], @subs.zrevrange("test stri", 0, -1)
+    assert_equal ["0"], @subs.zrevrange("test strin", 0, -1)
+    assert_equal ["0"], @subs.zrevrange("test string", 0, -1)
+  end
+
+  def test_adding_duplicate_item
+    Redis::Autosuggest.add(@str1)
+    Redis::Autosuggest.add(@str1)
+    assert @db.hgetall(Redis::Autosuggest.items).size == 1
+    assert @subs.keys.size == @str1.size
+  end
+
+  def test_adding_multiple_items
+    Redis::Autosuggest.add("one", "two", "three")
+    assert @db.hgetall(Redis::Autosuggest.items).size == 3
+    assert @subs.keys.size == 10
+  end
+
+    def test_adding_multiple_items_with_scores
+    Redis::Autosuggest.add_with_score("one", 1, "two", 2, "three", 3)
+    assert @db.hgetall(Redis::Autosuggest.items).size == 3
+    assert @subs.keys.size == 10
+    assert_equal 1, @subs.zscore("one", 0)
+    assert_equal 2, @subs.zscore("two", 1)
+    assert_equal 3, @subs.zscore("three", 2)
+  end
+
+  def test_removing_an_item
+    Redis::Autosuggest.add(@str1)
+    Redis::Autosuggest.remove(@str1)
+    assert @db.hgetall(Redis::Autosuggest.items).empty?
+    assert @subs.keys.size == 0
+  end
+
+  def test_removing_a_nonexistent_item
+    Redis::Autosuggest.add(@str1)
+    Redis::Autosuggest.remove("Second test string")
+    assert @db.hgetall(Redis::Autosuggest.items).size == 1
+    assert @db.hgetall(Redis::Autosuggest.items)["0"] == @str1.downcase
+    assert @subs.keys.size == @str1.size
+  end
+
+  def test_incrementing_an_items_score
+    Redis::Autosuggest.add_with_score(@str1, 5)
+    Redis::Autosuggest.increment(@str1)
+    @subs.keys.each { |k| assert @subs.zscore(k, 0) == 6 }
+    Redis::Autosuggest.increment(@str1, 8)
+    @subs.keys.each { |k| assert @subs.zscore(k, 0) == 14 }
+    Redis::Autosuggest.increment(@str1, -8)
+    @subs.keys.each { |k| assert @subs.zscore(k, 0) == 6 }
+  end
+
+  def test_suggesting_items
+    Redis::Autosuggest.add_with_score(@str1, 5)
+    Redis::Autosuggest.add_with_score("#{@str1} longer", 2)
+    suggestions =  Redis::Autosuggest.suggest(@str1[0..4])
+    assert_equal [@str1.downcase, "#{@str1} longer".downcase], suggestions
+  end
+
+  def test_no_suggestions_found
+    Redis::Autosuggest.add(@str1)
+    assert Redis::Autosuggest.suggest("nothing here").empty?
+  end
+
+  def test_leaderboard_items
+    Redis::Autosuggest.use_leaderboard = true
+    Redis::Autosuggest.add_with_score(@str1, 3)
+    Redis::Autosuggest.add_with_score("Another item", 5)
+    Redis::Autosuggest.add_with_score("Third item", 1)
+    top_items = Redis::Autosuggest.get_leaderboard
+    assert_equal ["another item", @str1.downcase, "third item"], top_items 
+    Redis::Autosuggest.use_leaderboard = false 
+  end
+
+  MiniTest::Unit.after_tests { self.unused_db.flushdb }
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+$LOAD_PATH.unshift 'lib'
+require 'minitest/autorun'
+require 'debugger'
+require 'redis'
+require 'redis-namespace'
+require 'redis-autosuggest'

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: redis-autosuggest
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Adam Phan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+- !ruby/object:Gem::Dependency
+  name: redis-namespace
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+description: ! "Provides autocompletions through Redis, with the ability to rank\n
+  \ results and integrate with Rails"
+email:
+- aphansh@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/redis-autosuggest.rb
+- lib/redis/autosuggest.rb
+- lib/redis/autosuggest/config.rb
+- lib/redis/autosuggest/version.rb
+- redis-autosuggest.gemspec
+- test/autosuggest_test.rb
+- test/test_helper.rb
+homepage: https://github.com/aphan/redis-autosuggest
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Suggestions/autocompletions with Redis and Ruby
+test_files:
+- test/autosuggest_test.rb
+- test/test_helper.rb