soulmate_rails 0.2.0.alpha

data/.document

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

data/.gitignore

@@ -0,0 +1,19 @@
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+test/db/*.rdb
+
+Gemfile.lock

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.3@soulmate_rails --create

data/Gemfile

@@ -0,0 +1,2 @@
+source 'http://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Eric Waller
+
+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.markdown

@@ -0,0 +1,93 @@
+# Soulmate Rails
+
+Soulmate Rails is a rails plugin that helps to solve the common problem of
+auto-completion in rails intuitively. It extends the soulmate gem <a
+href="http://github.com/seatgeek/soulmate">Soulmate</a> to make it easily
+pluggable into a rails project.
+
+## Getting Started
+
+### Installation :
+
+```sh
+$ gem install soulmate_rails
+```
+
+### Usage :
+
+  Following is an example of how one can use Soulmate Rails for enabling backend
+  autocompletion using redis.
+
+```ruby
+class User < ActiveRecord::Base
+  autocomplete :first_name, :score => :calculate_score
+  autocomplete :last_name, :score => :id
+
+  def calculate_score
+    # Some magic calculation returning a number.
+  end
+end
+
+1.9.3p385 :001 > User.create(:first_name => 'First1', :last_name => 'Last1')
+1.9.3p385 :002 > User.create(:first_name => 'First2', :last_name => 'Last2')
+1.9.3p385 :003 > User.create(:first_name => 'First3', :last_name => 'Last3')
+1.9.3p385 :004 > User.search_by_first_name('firs')
+  => [#<User:0x000000014bb1e8 @new_record=false,
+  @attributes={"first_name"=>"First3", "last_name"=>"Last3" "id"=>3},
+  @changed_attributes={}>, #<User:0x000000014bb1e9 @new_record=false,
+  @attributes={"first_name"=>"First2", "last_name"=>"Last2" "id"=>2},
+  @changed_attributes={}>, #<User:0x000000014bb1ea @new_record=false,
+  @attributes={"first_name"=>"First1", "last_name"=>"Last1" "id"=>1},
+  @changed_attributes={}>]
+1.9.3p385 :005 > User.search_by_last_name('last1')
+  => [#<User:0x000000014bb1e8 @new_record=false,
+  @attributes={"first_name"=>"First3", "last_name"=>"Last3" "id"=>3},
+  @changed_attributes={}>]
+```
+
+The `autocomplete` method takes 2 arguments :
+
+* attribute name to use for autocompletion.
+* options that determine how autocompletion works for indexing.
+
+Methods added by autocomplete :
+
+* Class Methods
+  * `search_by(attribute, term, options={})` - Generic method to search by
+    an attribute for which an autocomplete was defined.
+  * `search_by_#{attribute}(term, options={})` - Specific methods for each
+    attribute autocomplete was defined for.
+* Instance Methods
+  * `update_index_for(attribute, options={})`
+  * `update_index_for_#{attribute}` - used in an `after_save` callback to
+    update index for searching.
+  * `remove_index_for(attribute)`
+  * `remove_index_for_#{attribute}` - used in a `before_destroy` callback to
+    remove index for searching. Hence you should use `destroy` as opposed to
+    `delete` to ensure the callbacks are invoked appropriately by rails and
+    soulmate updates the index.
+
+Options you can provide to `autocomplete` :
+
+  * `:score` : This is required. Soulmate uses it for sorting the results (in
+    reverse order, i.e. higher score first). This can be the name of a function
+    or can also be the name of another attribute with integer values.
+  * `:aliases` : This is optional. Soulmate uses this as aliases for the term
+    field and uses it for searching as well. This can be an array of values or
+    a method name which returns an array of values.
+
+## Contributing
+### Reporting an Issue :
+* Use <a href="http://github.com/dhruvasagar/soulmate_rails/issues">Github
+   Issue Tracker</a> to report issues.
+
+### Contributing to code :
+* Fork it.
+* Commit your changes ( git commit ).
+* Push to github ( git push ).
+* Open a Pull Request.
+
+## License
+Soulmate Rails is released under the MIT License
+
+<!-- vim: set tw=80 colorcolumn=80 -->

data/Rakefile

@@ -0,0 +1,24 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+require File.join(File.expand_path('../lib', __FILE__), 'soulmate_rails', 'version')
+
+RSpec::Core::RakeTask.new
+task :default => :spec
+
+desc 'Builds the gem'
+task :build do
+  sh 'gem build soulmate_rails.gemspec'
+  Dir.mkdir('pkg') unless File.directory?('pkg')
+  sh "mv soulmate_rails-#{SoulmateRails::VERSION}.gem pkg/"
+end
+
+desc 'Builds and Installs the gem'
+task :install => :build do
+  sh "gem install pkg/soulmate_rails-#{SoulmateRails::VERSION}.gem"
+end
+
+desc 'Open an irb session preloaded with this library'
+task :console do
+  sh 'irb -rubygems -I lib -r soulmate_rails.rb'
+end

data/lib/soulmate/base.rb

@@ -0,0 +1,23 @@
+module Soulmate
+  class Base
+    include Helpers
+
+    attr_accessor :type
+
+    def initialize(type)
+      @type = normalize(type)
+    end
+
+    def base
+      "soulmate-index:#{type}"
+    end
+
+    def database
+      "soulmate-data:#{type}"
+    end
+
+    def cachebase
+      "soulmate-cache:#{type}"
+    end
+  end
+end

data/lib/soulmate/helpers.rb

@@ -0,0 +1,21 @@
+# coding: utf-8
+
+module Soulmate
+  module Helpers
+
+    def prefixes_for_phrase(phrase)
+      words = normalize(phrase).split(' ').reject do |w|
+        Soulmate.stop_words.include?(w)
+      end
+      words.map do |w|
+        (MIN_COMPLETE-1..(w.length-1)).map{ |l| w[0..l] }
+      end.flatten.uniq
+    end
+
+    def normalize(str)
+      # Letter, Mark, Number, Connector_Punctuation (Chinese, Japanese, etc.)
+      str.downcase.gsub(/[^\p{Word}\ ]/i, '').strip
+    end
+
+  end
+end

data/lib/soulmate/loader.rb

@@ -0,0 +1,63 @@
+module Soulmate
+  class Loader < Base
+
+    def load(items)
+      # delete the sorted sets for this type
+      phrases = Soulmate.redis.smembers(base)
+      Soulmate.redis.pipelined do
+        phrases.each do |p|
+          Soulmate.redis.del("#{base}:#{p}")
+        end
+        Soulmate.redis.del(base)
+      end
+
+      # Redis can continue serving cached requests for this type while the reload is
+      # occuring. Some requests may be cached incorrectly as empty set (for requests
+      # which come in after the above delete, but before the loading completes). But
+      # everything will work itself out as soon as the cache expires again.
+
+      # delete the data stored for this type
+      Soulmate.redis.del(database)
+
+      items.each_with_index do |item, i|
+        add(item, :skip_duplicate_check => true)
+      end
+    end
+
+    # "id", "term", "score", "aliases", "data"
+    def add(item, opts = {})
+      opts = { :skip_duplicate_check => false }.merge(opts)
+      raise ArgumentError, 'Item must have an id AND a term' unless item["id"] && item["term"]
+      
+      # kill any old items with this id
+      remove("id" => item["id"]) unless opts[:skip_duplicate_check]
+      
+      Soulmate.redis.pipelined do
+        # store the raw data in a separate key to reduce memory usage
+        Soulmate.redis.hset(database, item["id"], MultiJson.encode(item))
+        phrase = ([item["term"]] + (item["aliases"] || [])).join(' ')
+        prefixes_for_phrase(phrase).each do |p|
+          Soulmate.redis.sadd(base, p) # remember this prefix in a master set
+          Soulmate.redis.zadd("#{base}:#{p}", item["score"], item["id"]) # store the id of this term in the index
+        end
+      end
+    end
+
+    # remove only cares about an item's id, but for consistency takes an object
+    def remove(item)
+      prev_item = Soulmate.redis.hget(database, item["id"])
+      if prev_item
+        prev_item = MultiJson.decode(prev_item)
+        # undo the operations done in add
+        Soulmate.redis.pipelined do
+          Soulmate.redis.hdel(database, prev_item["id"])
+          phrase = ([prev_item["term"]] + (prev_item["aliases"] || [])).join(' ')
+          prefixes_for_phrase(phrase).each do |p|
+            Soulmate.redis.srem(base, p)
+            Soulmate.redis.zrem("#{base}:#{p}", prev_item["id"])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/soulmate/matcher.rb

@@ -0,0 +1,31 @@
+module Soulmate
+  class Matcher < Base
+
+    def matches_for_term(term, options = {})
+      options = { :limit => 5, :cache => true }.merge(options)
+      
+      words = normalize(term).split(' ').reject do |w|
+        w.size < MIN_COMPLETE or Soulmate.stop_words.include?(w)
+      end.sort
+
+      return [] if words.empty?
+
+      cachekey = "#{cachebase}:" + words.join('|')
+
+      if !options[:cache] || !Soulmate.redis.exists(cachekey)
+        interkeys = words.map { |w| "#{base}:#{w}" }
+        Soulmate.redis.zinterstore(cachekey, interkeys)
+        Soulmate.redis.expire(cachekey, 10 * 60) # expire after 10 minutes
+      end
+
+      ids = Soulmate.redis.zrevrange(cachekey, 0, options[:limit] - 1)
+      if ids.size > 0
+        results = Soulmate.redis.hmget(database, *ids)
+        results = results.reject{ |r| r.nil? } # handle cached results for ids which have since been deleted
+        results.map { |r| MultiJson.decode(r) }
+      else
+        []
+      end
+    end
+  end
+end

data/lib/soulmate_rails.rb

@@ -0,0 +1,54 @@
+require 'uri'
+require 'redis'
+require 'multi_json'
+
+require 'active_support/concern'
+
+require 'soulmate/helpers'
+require 'soulmate/base'
+require 'soulmate/matcher'
+require 'soulmate/loader'
+
+require 'soulmate_rails/model_additions'
+require 'soulmate_rails/railtie' if defined? Rails
+
+module Soulmate
+
+  extend self
+
+  MIN_COMPLETE = 2
+  DEFAULT_STOP_WORDS = ["vs", "at", "the"]
+
+  def redis=(server)
+    if server.is_a?(String)
+      @redis = nil
+      @redis_url = server
+    else
+      @redis = server
+    end
+
+    redis
+  end
+
+  def redis
+    @redis ||= (
+      url = URI(@redis_url || ENV["REDIS_URL"] || "redis://127.0.0.1:6379/0")
+
+      ::Redis.new({
+        :host => url.host,
+        :port => url.port,
+        :db => url.path[1..-1],
+        :password => url.password
+      })
+    )
+  end
+
+  def stop_words
+    @stop_words ||= DEFAULT_STOP_WORDS
+  end
+
+  def stop_words=(arr)
+    @stop_words = Array(arr).flatten
+  end
+
+end

data/lib/soulmate_rails/model_additions.rb

@@ -0,0 +1,61 @@
+module SoulmateRails
+  module ModelAdditions
+    extend ActiveSupport::Concern
+
+    def update_index_for(attribute, options={})
+      loader = instance_variable_get("@#{loader_for(attribute)}") || instance_variable_set("@#{loader_for(attribute)}", Soulmate::Loader.new(loader_for(attribute)))
+      item = {
+        'id' => "#{attribute}_#{self.id}",
+        'term' => send(attribute),
+        'score' => ( respond_to?(options[:score]) ? send(options[:score]) : options[:score] )
+      }.merge( options[:aliases] ? ( respond_to?(options[:aliases]) ? send(options[:aliases]) : options[:aliases] ) : {} )
+      # NOTE: Not supporting :data for now, will find a better way to use this later.
+      # .merge( options[:data] ? ( respond_to?(options[:data]) ? send(options[:data]) : options[:data] ) : {} )
+      loader.add(item, options)
+    end
+
+    def remove_index_for(attribute)
+      loader = instance_variable_get("@#{loader_for(attribute)}") || instance_variable_set("@#{loader_for(attribute)}", Soulmate::Loader.new(loader_for(attribute)))
+      loader.remove('id' => "#{attribute}_#{self.id}")
+    end
+
+    def loader_for(attribute)
+      "#{self.class.normalized_class_name}_#{attribute}"
+    end
+
+    module ClassMethods
+      def autocomplete(attribute, options={})
+        define_method "update_index_for_#{attribute}" do
+          update_index_for(attribute, options)
+        end
+        after_save "update_index_for_#{attribute}"
+
+        define_method "remove_index_for_#{attribute}" do
+          remove_index_for(attribute)
+        end
+        before_destroy "remove_index_for_#{attribute}"
+
+        define_singleton_method "search_by_#{attribute}" do |term, *opts|
+          opts = opts.empty? ? {} : opts.first
+          search_by(attribute, term, opts)
+        end
+      end
+
+      def search_by(attribute, term, options={})
+        matcher = instance_variable_get("@#{matcher_for(attribute)}") || instance_variable_set("@#{matcher_for(attribute)}", Soulmate::Matcher.new(matcher_for(attribute)))
+        matches = matcher.matches_for_term(term, options)
+        matches = matches.map do |match|
+          find(match['id'].split('_')[-1].to_i) rescue nil
+        end.compact
+      end
+
+      def matcher_for(attribute)
+        "#{normalized_class_name}_#{attribute}"
+      end
+
+      def normalized_class_name
+        self.name.gsub('::', '_').downcase
+      end
+    end
+  end
+end

data/lib/soulmate_rails/railtie.rb

@@ -0,0 +1,15 @@
+module SoulmateRails
+  class Railtie < Rails::Railtie
+    initializer 'soulmate_rails.model_additions' do
+      ActiveSupport.on_load :active_record do
+        include ModelAdditions
+      end
+    end
+
+    initializer 'soulmate_rails.set_configs' do |app|
+      options = app.config.soulmate_rails
+
+      Soulmate.redis = options[:redis] if options[:redis]
+    end
+  end
+end

data/lib/soulmate_rails/version.rb

@@ -0,0 +1,8 @@
+module SoulmateRails
+  MAJOR = 0
+  MINOR = 2
+  PATCH = 0
+  STATUS = 'alpha'
+
+  VERSION = [MAJOR, MINOR, PATCH, STATUS].compact.join('.')
+end

data/soulmate_rails.gemspec

@@ -0,0 +1,33 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+$:.push File.expand_path("../lib", __FILE__)
+require "soulmate_rails/version"
+
+Gem::Specification.new do |s|
+  s.name = "soulmate_rails"
+  s.email = ["dhruva.sagar@gmail.com"]
+  s.version = SoulmateRails::VERSION
+  s.authors = ["Dhruva Sagar"]
+  s.homepage = "http://github.com/dhruvasagar/soulmate_rails"
+  s.summary = "Redis-backed autocompletion engine for Rails"
+  s.description = "Soulmate Rails is a tool to help solve the common problem of developing a fast autocomplete feature for Rails. It uses Redis's sorted sets to build an index of partial words and corresponding top matches."
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split("\n").map {|f| File.basename(f)}
+
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency 'redis', '>= 2.0'
+  s.add_runtime_dependency 'multi_json', '>= 1.0'
+  s.add_runtime_dependency 'activesupport', '>= 0'
+
+  s.add_development_dependency 'rake', '>= 0'
+  s.add_development_dependency 'rspec', '>= 0'
+  s.add_development_dependency 'supermodel', '>= 0'
+  s.add_development_dependency 'mock_redis', '>= 0'
+end

data/spec/config/test.conf

@@ -0,0 +1,8 @@
+dir ./spec/db
+pidfile ./redis.pid
+port 6380
+timeout 300
+loglevel debug
+logfile stdout
+databases 16
+daemonize yes

data/spec/samples/stop-words.txt

@@ -0,0 +1,4 @@
+vs
+at
+the
+to

data/spec/samples/venues.json

@@ -0,0 +1,7 @@
+{"id":1,"term":"Dodger Stadium","score":84,"data":{"url":"\/dodger-stadium-tickets\/","subtitle":"Los Angeles, CA"},"aliases":["Chavez Ravine"]}
+{"id":28,"term":"Angel Stadium","score":90,"data":{"url":"\/angel-stadium-tickets\/","subtitle":"Anaheim, CA"},"aliases":["Edison International Field of Anaheim"]}
+{"id":30,"term":"Chase Field ","score":80,"data":{"url":"\/chase-field-tickets\/","subtitle":"Phoenix, AZ"},"aliases":["Bank One Ballpark", "Bank One Stadium"]}
+{"id":29,"term":"Sun Life Stadium","score":75,"data":{"url":"\/sun-life-stadium-tickets\/","subtitle":"Miami, FL"},"aliases":["Dolphins Stadium","Land Shark Stadium"]}
+{"id":2,"term":"Turner Field","score":50,"data":{"url":"\/turner-field-tickets\/","subtitle":"Atlanta, GA"}}
+{"id":3,"term":"Citi Field","score":92,"data":{"url":"\/citi-field-tickets\/","subtitle":"Atlanta, GA"},"aliases":["Shea Stadium"]}
+{"id":8,"term":"中国佛山 李小龙","score":94,"data":{"url":"\/Bruce Lee\/","subtitle":"Chinese Foshan"},"aliases":["Li XiaoLong"]}

data/spec/soulmate/loader_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+module Soulmate
+  describe Loader do
+    before :each do
+      @loader = Loader.new('venues')
+    end
+
+    context 'add' do
+      it 'should successfully add acceptable value' do
+        expect {
+          @loader.add({"id" => 11,"term" => "Dodger Stadium","score" => 84,"data" => {"url" => "\/dodger-stadium-tickets\/","subtitle" => "Los Angeles, CA"},"aliases" => ["Chavez Ravine"]})
+        }.to_not raise_error
+      end
+
+      context 'invalid item' do
+        it 'should raise ArgumentError if id is missing' do
+          expect {
+            @loader.add({"term" => "Dodger Stadium","score" => 84,"data" => {"url" => "\/dodger-stadium-tickets\/","subtitle" => "Los Angeles, CA"},"aliases" => ["Chavez Ravine"]})
+          }.to raise_error
+        end
+
+        it 'should raise ArgumentError if term is missing' do
+          expect {
+            @loader.add({"id" => 11, "score" => 84,"data" => {"url" => "\/dodger-stadium-tickets\/","subtitle" => "Los Angeles, CA"},"aliases" => ["Chavez Ravine"]})
+          }.to raise_error(ArgumentError)
+        end
+      end
+    end
+
+    context 'load' do
+      before :each do
+        @items = []
+        venues = File.open(TestRoot + '/samples/venues.json', 'r')
+        venues.each_line do |venue|
+          @items << MultiJson.decode(venue)
+        end
+        @items_loaded = @loader.load(@items)
+      end
+
+      it 'should load values' do
+        @items_loaded.size.should eq(7)
+      end
+    end
+
+    context 'integration' do
+      before :each do
+        @matcher = Matcher.new('venues')
+      end
+
+      it 'should successfully remove the item' do
+        @loader.load([])
+        results = @matcher.matches_for_term('te', :cache => false)
+        results.size.should eq(0)
+
+        @loader.add('id' => 1, 'term' => 'Testing this', 'score' => 10)
+        results = @matcher.matches_for_term('te', :cache => false)
+        results.size.should eq(1)
+
+        @loader.remove('id' => 1)
+        results = @matcher.matches_for_term('te', :cache => false)
+        results.size.should eq(0)
+      end
+
+      it 'should successfully update items' do
+        @loader.load([])
+        @loader.add("id" => 1, "term" => "Testing this", "score" => 10)
+        @loader.add("id" => 2, "term" => "Another Term", "score" => 9)
+        @loader.add("id" => 3, "term" => "Something different", "score" => 5)
+
+        results = @matcher.matches_for_term('te', :cache => false)
+        results.size.should eq(2)
+        results.first['term'].should eq('Testing this')
+        results.first['score'].should eq(10)
+
+        @loader.add("id" => 1, "term" => "Updated", "score" => 5)
+        results = @matcher.matches_for_term('te', :cache => false)
+        results.size.should eq(1)
+        results.first['term'].should eq('Another Term')
+        results.first['score'].should eq(9)
+      end
+    end
+  end
+end

data/spec/soulmate/matcher_spec.rb

@@ -0,0 +1,37 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+module Soulmate
+  describe Matcher do
+    before :each do
+      items = []
+      loader = Loader.new('venues')
+      venues = File.open(TestRoot + '/samples/venues.json', 'r')
+      venues.each_line do |venue|
+        items << MultiJson.decode(venue)
+      end
+      loader.load(items)
+
+      @matcher = Matcher.new('venues')
+    end
+
+    it 'should successfully return matches for given term' do
+      results = @matcher.matches_for_term('stad')
+      results.size.should eq(5)
+      results.first['term'].should eq('Citi Field')
+    end
+
+    it 'should successfully return matches with aliases' do
+      results = @matcher.matches_for_term('land shark stadium')
+      results.size.should eq(1)
+      results.first['term'].should eq('Sun Life Stadium')
+    end
+
+    it 'should successfully return matches with chinese' do
+      results = @matcher.matches_for_term('中国')
+      results.size.should eq(1)
+      results.first['term'].should eq('中国佛山 李小龙')
+    end
+  end
+end

data/spec/soulmate_rails/model_additions_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+module SoulmateRails
+  class User < SuperModel::Base
+    include ModelAdditions
+
+    autocomplete :name, :score => :id
+  end
+
+  describe ModelAdditions do
+    context 'single autocomplete' do
+      before :each do
+        @user = User.create(:name => 'Dhruva Sagar')
+      end
+
+      it 'should successfully search by name' do
+        users = User.search_by_name('dhruv')
+        user = users.first
+        user.should eq(@user)
+      end
+    end
+
+    context 'multiple autocompletes' do
+      before :each do
+        # Define another autocomplete for country
+        User.autocomplete(:country, :score => :id)
+        @user = User.create(:name => 'Dhruva Sagar', :country => 'India')
+      end
+
+      it 'should successfully search by name as well as country' do
+        users = User.search_by_name('dhr')
+        user = users.first
+        user.should eq(@user)
+
+        users = User.search_by_country('ind')
+        user = users.first
+        user.should eq(@user)
+      end
+    end
+
+    after :each do
+      User.destroy_all
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'supermodel'
+require 'mock_redis'
+require 'soulmate_rails'
+
+TestRoot = File.expand_path(File.dirname(__FILE__))
+
+RSpec.configure do |config|
+  config.order = 'random'
+  config.color_enabled = true
+
+  config.before(:each) do
+    redis = MockRedis.new
+    redis.flushdb
+    Soulmate.redis = redis
+  end
+end
+

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: soulmate_rails
+version: !ruby/object:Gem::Version
+  version: 0.2.0.alpha
+  prerelease: 6
+platform: ruby
+authors:
+- Dhruva Sagar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-04 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: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: supermodel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mock_redis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Soulmate Rails is a tool to help solve the common problem of developing
+  a fast autocomplete feature for Rails. It uses Redis's sorted sets to build an index
+  of partial words and corresponding top matches.
+email:
+- dhruva.sagar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .document
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.markdown
+- Rakefile
+- lib/soulmate/base.rb
+- lib/soulmate/helpers.rb
+- lib/soulmate/loader.rb
+- lib/soulmate/matcher.rb
+- lib/soulmate_rails.rb
+- lib/soulmate_rails/model_additions.rb
+- lib/soulmate_rails/railtie.rb
+- lib/soulmate_rails/version.rb
+- soulmate_rails.gemspec
+- spec/config/test.conf
+- spec/samples/stop-words.txt
+- spec/samples/venues.json
+- spec/soulmate/loader_spec.rb
+- spec/soulmate/matcher_spec.rb
+- spec/soulmate_rails/model_additions_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/dhruvasagar/soulmate_rails
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2339712200945415298
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Redis-backed autocompletion engine for Rails
+test_files: []