redis_autocomplete 0.1.0

data/.document

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem 'redis'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development, :test do
+  gem "rspec", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,30 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rcov (0.9.9)
+    redis (2.1.1)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  rcov
+  redis
+  rspec (~> 2.3.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Joe Johnston
+
+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,24 @@
+= About
+
+RedisAutocomplete is a simple gem for extremely fast autocomplete suggestions. Just add words to it and ask 
+it to make suggestions given a search prefix.
+
+The algorithm used is orginally from Salvatore (antirez) Sanfilippo, the Redis author.
+http://antirez.com/post/autocomplete-with-redis.html
+
+RedisAutocomplete was written and maintained by simple10[http://github.com/simple10] and Empact[http://github.com/Empact] for http://connect.me.
+
+
+== Usage
+
+  # initialize with the name of the redis set you want to use
+  r = RedisAutocomplete.new(:tags)
+  r.add_words(%w[developer, designer, dude, architect, baker, banker])
+  r.suggest('de')
+  # ['developer', 'designer']
+
+== Copyright
+
+Copyright (c) 2011 Joe Johnston. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "redis_autocomplete"
+  gem.homepage = "http://github.com/connectme/redis_autocomplete"
+  gem.license = "MIT"
+  gem.summary = %Q{Use Redis for fast autocomplete suggestions}
+  gem.description = %Q{RedisAutocomplete is a simple gem for extremely fast autocomplete suggestions. Just add words to it and ask it to make suggestions given a search prefix.
+
+  The algorithm used is orginally from Salvatore (antirez) Sanfilippo, the Redis author. http://antirez.com/post/autocomplete-with-redis.html
+
+  RedisAutocomplete is maintained by simple10[http://github.com/simple10] and Empact[http://github.com/Empact] for http://connect.me.}
+  gem.email = "joe@simple10.com"
+  gem.authors = ["Joe Johnston (simple10)", "Ben Woosley (Empact)", "Salvatore Sanfilippo (antirez)"]
+  gem.add_runtime_dependency 'redis'
+  gem.add_development_dependency 'rspec'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "redis_autocomplete #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/lib/redis_autocomplete.rb

@@ -0,0 +1,45 @@
+require 'redis'
+
+class RedisAutocomplete
+  attr_reader :redis, :terminal
+
+  def initialize(set, disallowed_chars = /[^a-zA-Z0-9_-]/, terminal = '+')
+    @set = set
+    @redis = Redis.new
+    @disallowed_chars = disallowed_chars
+    @terminal = terminal
+  end
+
+  def add_word(word)
+    w = word.gsub(@disallowed_chars, '')
+    (1..(w.length)).each { |i| @redis.zadd(@set, 0, w.slice(0, i)) }
+    @redis.zadd(@set, 0, "#{w}#{@terminal}")
+  end
+
+  def add_words(*words)
+    words.flatten.compact.uniq.each { |word| add_word word }
+  end
+
+  def suggest(prefix, count = 10)
+    results = []
+    rangelen = 50 # This is not random, try to get replies < MTU size
+    start = @redis.zrank(@set, prefix)
+    return [] if !start
+    while results.length != count
+      range = @redis.zrange(@set, start, start+rangelen-1)
+      start += rangelen
+      break if !range || range.length == 0
+      range.each do |entry|
+        minlen = [entry.length, prefix.length].min
+        if entry.slice(0, minlen) != prefix.slice(0, minlen)
+          count = results.count
+          break
+        end
+        if entry[-1] == @terminal and results.length != count
+          results << entry.chomp(@terminal)
+        end
+      end
+    end
+    return results
+  end
+end

data/spec/redis_autocomplete_spec.rb

@@ -0,0 +1,70 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+#require 'redis_autocomplete'
+
+describe RedisAutocomplete do
+  before do
+    @names = %w[
+      ynes
+      ynez
+      yoko
+      yolanda
+      yolande
+      yolane
+      yolanthe
+      aaren
+      aarika
+      abagael
+      abagail
+      catherine
+      cathi
+      cathie
+      cathleen
+      cathlene
+      cathrin
+      cathrine
+      cathryn
+      cathy
+      cathyleen
+      cati
+      catie
+      catina
+      catlaina
+      catlee
+      catlin
+    ]
+    @set = :test_female_names
+    @r = RedisAutocomplete.new(@set)
+    #todo: drop female_names set
+    @r.add_words(@names)
+  end
+
+  describe "#suggest" do
+    it "should include words matching prefix" do
+      @r.suggest('c').should == %w[
+        catherine
+        cathi
+        cathie
+        cathleen
+        cathlene
+        cathrin
+        cathrine
+        cathryn
+        cathy
+        cathyleen
+      ]
+    end
+    it "should not include words not matching prefix" do
+      @r.suggest('cati').should_not include('cathy')
+    end
+
+    context "when a max count is supplied" do
+      it "should not include more than 10 matches" do
+        @r.suggest('c').length.should == 10
+      end
+      it "should not include more matches than the supplied count" do
+        @r.suggest('c', 4).length.should == 4
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'redis_autocomplete'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification 
+name: redis_autocomplete
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Joe Johnston (simple10)
+- Ben Woosley (Empact)
+- Salvatore Sanfilippo (antirez)
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-10 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: redis
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: redis
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id007
+description: |-
+  RedisAutocomplete is a simple gem for extremely fast autocomplete suggestions. Just add words to it and ask it to make suggestions given a search prefix.
+  
+    The algorithm used is orginally from Salvatore (antirez) Sanfilippo, the Redis author. http://antirez.com/post/autocomplete-with-redis.html
+  
+    RedisAutocomplete is maintained by simple10[http://github.com/simple10] and Empact[http://github.com/Empact] for http://connect.me.
+email: joe@simple10.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/redis_autocomplete.rb
+- spec/redis_autocomplete_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/connectme/redis_autocomplete
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 512640415964739179
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: Use Redis for fast autocomplete suggestions
+test_files: 
+- spec/redis_autocomplete_spec.rb
+- spec/spec_helper.rb