redis-autosuggest 0.0.1 → 0.1.0

data/README.md

@@ -1,6 +1,7 @@
 # Redis::Autosuggest
 
-TODO: Write a gem description
+Provides autocompletions through Redis, with the ability to rank
+  results and integrate with Rails
 
 ## Installation
 
@@ -18,7 +19,56 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+By default Autosuggest creates a new Redis client on db 0 at localhost:6379.
+
+To change the server/port:
+```ruby
+r = Redis.new(:host => "my_host", :port => my_port)
+Redis::Autosuggest.redis = r
+```
+
+To add items to be use for autocompletions:
+```ruby
+Redis::Autosuggest.add("North By Northwest", "Northern Exposure")
+```
+
+To check for autocompletions for an item:
+```ruby
+Redis::Autosuggest.suggest("nor")
+# => ["north by northwest", "northern exposure"]
+```
+Autocompletions will be ordered their score value (descending).
+
+Some other usage examples:
+```ruby
+# Add items with initial scores 
+Redis::Autosuggest.suggest("North By Northwest", 9, Northern Exposure, 3)
+# Increment an item's score
+Redis::Autosuggest.suggest("North By Northwest", 1)
+```
+
+## Rails support
+
+Autosuggest can also be integrated with Rails.  Include it in a model:
+```ruby
+class Movie < ActiveRecord::Base
+  include Redis::Autosuggest
+  
+  attr_accessible :movie_title
+  autosuggest     :movie_title
+end
+```
+
+For first time usage, seed the Redis db with the autosuggest sources:
+```ruby
+Redis::Autosuggest.init_rails_sources
+```
+
+You can optionally specify a numeric field to be used as the initial score for an item
+when it is added:
+```ruby
+  autosuggest     :movie_title, :rank_by => imdb_rating
+```
 
 ## Contributing
 

data/lib/redis-autosuggest.rb

@@ -1,5 +1,11 @@
 require 'redis'
 require 'redis-namespace'
 require 'redis/autosuggest'
-require 'redis/autosuggest/version'
 require 'redis/autosuggest/config'
+require 'redis/autosuggest/file'
+require 'redis/autosuggest/init'
+require 'redis/autosuggest/version'
+
+if defined?(Rails)
+  require 'redis/autosuggest/rails'
+end

data/lib/redis/autosuggest.rb

@@ -12,7 +12,7 @@ class Redis
           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)
@@ -55,6 +55,11 @@ class Redis
         top_ids.empty? ? [] : @db.hmget(@items, top_ids)  
       end
 
+      # Get the score of an item
+      def get_score(item)
+        @substrings.zscore(item.downcase, get_id(item.downcase))
+      end
+
       private
       def add_item(item, score=0)
         id = self.db.hlen(self.items)

data/lib/redis/autosuggest/config.rb

@@ -23,15 +23,19 @@ class Redis
 
     # Key to a sorted set holding all id of items in the autosuggest database sorted 
     # by their score
-    @leaderboard = "leaderboard"
+    @leaderboard = "lead"
 
     # Leaderboard off by default
     @use_leaderboard = false
 
+    # Sources to be used for Autocomplete in rails.
+    # Example: { Movie => :movie_title }
+    @rails_sources = {}
+
     class << self
       attr_reader :redis
       attr_accessor :db, :items, :substrings, :max_per_substring, :max_results,
-        :leaderboard, :use_leaderboard
+        :leaderboard, :use_leaderboard, :rails_sources
 
       def redis=(redis)
         @redis = redis

data/lib/redis/autosuggest/file.rb

@@ -0,0 +1,23 @@
+class Redis
+  module Autosuggest
+
+    class << self
+
+      # Add items to the autosuggest database from a file.
+      # Each line be a string representing the item
+      def add_from_file(file)
+        add(*(File.open(file, "r").map { |l| l.strip }))
+      end
+      
+      # Add items and their to the autosuggest database from a file.
+      # Each line be a string representing the item followed by its score
+      # Example:
+      # item1 0.4
+      # item2 2.1
+      # item3 5.2
+      def add_with_score_from_file(file)
+        add_with_score(*(File.open(file, "r").map { |l| l.split(" ")}.flatten))
+      end
+    end
+  end
+end

data/lib/redis/autosuggest/init.rb

@@ -0,0 +1,17 @@
+class Redis
+  module Autosuggest
+
+    class << self
+
+      def init_rails_sources
+        self.rails_sources.each_key do |r|
+          r.all.each do |record|
+            record.add_to_autosuggest
+          end
+        end
+      end
+    end
+  end
+end
+
+

data/lib/redis/autosuggest/rails.rb

@@ -0,0 +1,49 @@
+class Redis
+  module Autosuggest
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+
+      def autosuggest(column, options={})
+        hash = Redis::Autosuggest.rails_sources[self]
+        if hash.nil?
+          Redis::Autosuggest.rails_sources[self] = { column => options }
+        else
+          hash[column] = options
+        end
+
+        # hook onto rails callbacks to update autosuggest db if a source is modified
+        class_eval <<-HERE
+          after_create :add_to_autosuggest
+          def add_to_autosuggest
+            Redis::Autosuggest.rails_sources[self.class].each do |column, options|
+              score = self.send(options[:rank_by]) if !options[:rank_by].nil?
+              score ||= 0
+              Redis::Autosuggest.add_with_score(self.send(column), score)
+            end
+          end
+
+          after_update :check_if_changed
+          def check_if_changed
+            Redis::Autosuggest.rails_sources[self.class].each_key do |column|
+              next if !self.send("#{column}_changed?")
+              old_item = self.send("#{column}_was")
+              score = Redis::Autosuggest.get_score(old_item)
+              Redis::Autosuggest.remove(old_item)
+              Redis::Autosuggest.add_with_score(self.send(column), score)
+            end
+          end
+
+          before_destroy :remove_from_autosuggest
+          def remove_from_autosuggest
+            Redis::Autosuggest.rails_sources[self.class].each_key do |column|
+              Redis::Autosuggest.remove(self.send(column))
+            end
+          end
+          HERE
+        end 
+      end
+    end
+  end
+
+

data/lib/redis/autosuggest/version.rb

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

data/redis-autosuggest.gemspec

@@ -21,6 +21,5 @@ Gem::Specification.new do |gem|
   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

@@ -1,18 +1,9 @@
 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
+    @unused_db ||= Redis.new(:db => TestHelper.db_picker)
   end
 
   def setup
@@ -109,5 +100,10 @@ class TestAutosuggest < MiniTest::Unit::TestCase
     Redis::Autosuggest.use_leaderboard = false 
   end
 
+  def test_getting_an_items_score
+     Redis::Autosuggest.add_with_score(@str1, 3)
+     assert_equal 3, Redis::Autosuggest.get_score(@str1)
+  end
+
   MiniTest::Unit.after_tests { self.unused_db.flushdb }
 end

data/test/file_test.rb

@@ -0,0 +1,33 @@
+require 'test_helper'
+
+class TestFile < MiniTest::Unit::TestCase
+
+  def self.unused_db
+    @unused_db ||= Redis.new(:db => TestHelper.db_picker)
+  end
+
+  def setup
+    self.class.unused_db.flushdb
+    Redis::Autosuggest.redis = self.class.unused_db 
+    @db = Redis::Autosuggest.db
+    @subs = Redis::Autosuggest.substrings
+  end
+
+  def test_adding_from_file
+    Redis::Autosuggest.add_from_file("test/text/example.txt")
+    assert @db.hgetall(Redis::Autosuggest.items).size == 3
+    assert @subs.keys.size == 10
+  end
+
+  def test_adding_with_score_from_file
+    Redis::Autosuggest.add_with_score_from_file("test/text/example_with_score.txt")
+    assert @db.hgetall(Redis::Autosuggest.items).size == 3
+    assert @subs.keys.size == 10
+    assert_equal 12, @subs.zscore("one", 0)
+    assert_equal 4, @subs.zscore("two", 1)
+    assert_equal 3, @subs.zscore("three", 2)
+  end
+
+  MiniTest::Unit.after_tests { self.unused_db.flushdb }
+end
+

data/test/test_helper.rb

@@ -4,3 +4,15 @@ require 'debugger'
 require 'redis'
 require 'redis-namespace'
 require 'redis-autosuggest'
+
+
+class TestHelper
+  # 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
+end

data/test/text/example.txt

@@ -0,0 +1,3 @@
+one
+two
+three

data/test/text/example_with_score.txt

@@ -0,0 +1,3 @@
+one 12
+two 4
+three 3

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis-autosuggest
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -43,22 +43,6 @@ dependencies:
     - - ~>
       - !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
@@ -91,10 +75,16 @@ files:
 - lib/redis-autosuggest.rb
 - lib/redis/autosuggest.rb
 - lib/redis/autosuggest/config.rb
+- lib/redis/autosuggest/file.rb
+- lib/redis/autosuggest/init.rb
+- lib/redis/autosuggest/rails.rb
 - lib/redis/autosuggest/version.rb
 - redis-autosuggest.gemspec
 - test/autosuggest_test.rb
+- test/file_test.rb
 - test/test_helper.rb
+- test/text/example.txt
+- test/text/example_with_score.txt
 homepage: https://github.com/aphan/redis-autosuggest
 licenses: []
 post_install_message: 
@@ -121,4 +111,7 @@ specification_version: 3
 summary: Suggestions/autocompletions with Redis and Ruby
 test_files:
 - test/autosuggest_test.rb
+- test/file_test.rb
 - test/test_helper.rb
+- test/text/example.txt
+- test/text/example_with_score.txt