soulmate_rails 0.3.0 → 0.3.1

data/.rvmrc

@@ -1 +1 @@
-rvm 1.9.3-p385@soulmate_rails --create
+rvm 1.9.3-p194@soulmate_rails --create

data/Rakefile

@@ -20,7 +20,7 @@ end
 
 desc 'Open an irb session preloaded with this library'
 task :console do
-  sh 'irb -rubygems -I lib:spec -r soulmate_rails.rb -r spec_helper.rb'
+  sh 'irb -rubygems -I lib:spec -r irb/completion -r soulmate_rails.rb -r spec_helper.rb'
 end
 
 desc 'Release the gem'

data/lib/soulmate/base.rb

@@ -9,15 +9,15 @@ module Soulmate
     end
 
     def base
-      "soulmate-index:#{type}"
+      "soulmate-index:#{Soulmate.cache_namespace}_#{type}"
     end
 
     def database
-      "soulmate-data:#{type}"
+      "soulmate-data:#{Soulmate.cache_namespace}_#{type}"
     end
 
     def cachebase
-      "soulmate-cache:#{type}"
+      "soulmate-cache:#{Soulmate.cache_namespace}_#{type}"
     end
   end
 end

data/lib/soulmate/helpers.rb

@@ -8,7 +8,7 @@ module Soulmate
         Soulmate.stop_words.include?(w)
       end
       words.map do |w|
-        (MIN_COMPLETE-1..(w.length-1)).map{ |l| w[0..l] }
+        (Soulmate.min_complete-1..(w.length-1)).map{ |l| w[0..l] }
       end.flatten.uniq
     end
 

data/lib/soulmate/matcher.rb

@@ -2,10 +2,10 @@ module Soulmate
   class Matcher < Base
 
     def matches_for_term(term, options = {})
-      options = { :limit => 5, :cache => true }.merge(options)
-      
+      options = { :limit => Soulmate.max_results, :cache => true }.merge(options)
+
       words = normalize(term).split(' ').reject do |w|
-        w.size < MIN_COMPLETE or Soulmate.stop_words.include?(w)
+        w.size < Soulmate.min_complete or Soulmate.stop_words.include?(w)
       end.sort
 
       return [] if words.empty?
@@ -15,7 +15,7 @@ module Soulmate
       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
+        Soulmate.redis.expire(cachekey, Soulmate.cache_time)
       end
 
       ids = Soulmate.redis.zrevrange(cachekey, 0, options[:limit] - 1)
@@ -26,6 +26,7 @@ module Soulmate
       else
         []
       end
+
     end
   end
 end

data/lib/soulmate_rails.rb

@@ -17,6 +17,7 @@ module Soulmate
   extend self
 
   MIN_COMPLETE = 2
+
   DEFAULT_STOP_WORDS = ["vs", "at", "the"]
 
   def redis=(server)
@@ -51,4 +52,43 @@ module Soulmate
     @stop_words = Array(arr).flatten
   end
 
+  def min_complete
+    @min_complete ||= MIN_COMPLETE
+  end
+
+  def min_complete=(min_len)
+    if min_len.is_a? Integer
+      @min_complete = min_len unless min_len < 1 || min_len > 5
+    end
+  end
+
+  def cache_time
+    # default to 10 minutes
+    @cache_time ||= 10 * 60
+  end
+
+  def cache_time=(time_period)
+    if time_period.is_a? Integer
+      @cache_time = time_period unless time_period < 1
+    end
+  end
+
+  def cache_namespace
+    @cache_namespace
+  end
+
+  def cache_namespace=(namespace)
+    @cache_namespace = namespace
+  end
+
+  def max_results
+    # default to 10 max results returned
+    @max_results ||= 10
+  end
+
+  def max_results=(max_num)
+    if max_num.is_a? Integer
+      @max_results = max_num unless max_num < 1
+    end
+  end
 end

data/lib/soulmate_rails/model_additions.rb

@@ -12,7 +12,7 @@ module SoulmateRails
       loader = instance_variable_get("@#{self.class.name_for(attribute)}_loader") || instance_variable_set("@#{self.class.name_for(attribute)}_loader", Soulmate::Loader.new(self.class.name_for(attribute)))
       item = {
         'id' => "#{attribute}_#{self.id}",
-        'term' => send(attribute),
+        'term' => send(attribute).encode('UTF-8'),
         'score' => ( respond_to?(options[:score]) ? send(options[:score]) : options[:score] )
       }
 
@@ -59,6 +59,22 @@ module SoulmateRails
           opts = opts.empty? ? {} : opts.first
           search_by(attribute, term, opts)
         end
+
+        # use only redis cache without touching backend database
+        define_singleton_method "search_cache_by_#{attribute}" do |term, *opts|
+          opts = opts.empty? ? {} : opts.first
+          search_cache_by(attribute, term, opts)
+        end
+
+        # define utility function to clean out cached data
+        define_singleton_method "flush_cache_by_#{attribute}" do
+          flush_cache(attribute)
+        end
+
+        # define utility function to reload data from database
+        define_singleton_method "reload_cache_by_#{attribute}" do |options|
+          reload_cache(attribute, options)
+        end
       end
 
       def search_by(attribute, term, options={})
@@ -81,6 +97,47 @@ module SoulmateRails
       def normalized_class_name
         self.name.gsub('::', '_').downcase
       end
+
+      def flush_cache(attribute)
+        loader = instance_variable_get("@#{name_for(attribute)}") || instance_variable_set("@#{name_for(attribute)}", Soulmate::Loader.new(name_for(attribute)))
+
+        # delete the sorted sets for this type
+        phrases = Soulmate.redis.keys(loader.base + "*")
+
+        # delete cached sets for previous
+        cache_phrases = Soulmate.redis.keys(loader.cachebase + "*")
+
+        Soulmate.redis.pipelined do
+          phrases.each do |p|
+            Soulmate.redis.del(p)
+          end
+
+          cache_phrases.each do |p|
+            Soulmate.redis.del(p)
+          end
+        end
+
+        # delete the data stored for this type
+        Soulmate.redis.del(loader.database)
+      end
+
+      # example call: City.reload_cache(:name, {:score => :autocomplete_score, :data => :autocomplete_data})
+      # example call: City.reload_cache_by_name({:score => :autocomplete_score, :data => :autocomplete_data})
+      def reload_cache(attribute, options)
+        flush_cache(attribute)
+        self.find_each { |object| object.update_index_for(attribute, options) }
+      end
+
+      # define a mathod to return results from cache instead of connecting to backend database
+      def search_cache_by(attribute, term, options={})
+        matcher = instance_variable_get("@#{name_for(attribute)}_matcher") || instance_variable_set("@#{name_for(attribute)}_matcher", Soulmate::Matcher.new(name_for(attribute)))
+        matches = matcher.matches_for_term(term, options)
+
+        res = []
+        matches.each {|m| res << [m['id'].split('_')[-1].to_i, m['data']] }
+
+        res
+      end
     end
   end
 end

data/lib/soulmate_rails/railtie.rb

@@ -7,9 +7,23 @@ module SoulmateRails
     end
 
     initializer 'soulmate_rails.set_configs' do |app|
-      options = app.config.soulmate_rails
-
-      Soulmate.redis = options[:redis] if options[:redis]
+      # configuration file for redis server and soulmate
+      Soulmate.cache_namespace ||= "#{app.engine_name}_#{Rails.env}"
+      redis_config_file = "config/redis_server.yml"
+      if File.exists?(redis_config_file)
+        file = YAML.load_file(redis_config_file)
+        Soulmate.redis = file[:redis_url] if file[:redis_url]
+        Soulmate.cache_time = file[:cache_time] if file[:cache_time]
+        Soulmate.max_results = file[:max_results] if file[:max_results]
+      end
+      # configuration file for stopping words
+      stop_words_file = "config/stopping_words.yml"
+      if File.exists?(stop_words_file)
+        stopping_words = []
+        s_file = YAML.load_file(stop_words_file)
+        s_file.each_line { |line| stopping_words.push(line) }
+        Soulmate.stop_words = stopping_words
+      end
     end
   end
 end

data/lib/soulmate_rails/version.rb

@@ -1,7 +1,7 @@
 module SoulmateRails
   MAJOR = 0
   MINOR = 3
-  PATCH = 0
+  PATCH = 1
 
   VERSION = [MAJOR, MINOR, PATCH].compact.join('.')
 end

data/soulmate_rails.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |s|
   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.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. Modified by Jim Zhan to add utility functions and for bug fixing."
 
   s.files = `git ls-files`.split("\n")
   s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
@@ -23,6 +23,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_runtime_dependency 'redis', '>= 2.0'
+  s.add_runtime_dependency 'json', '>= 1.7.7'
   s.add_runtime_dependency 'multi_json', '>= 1.0'
   s.add_runtime_dependency 'activesupport', '>= 0'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: soulmate_rails
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-19 00:00:00.000000000 Z
+date: 2013-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -27,6 +27,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.7.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.7.7
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -125,7 +141,8 @@ dependencies:
         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.
+  of partial words and corresponding top matches. Modified by Jim Zhan to add utility
+  functions and for bug fixing.
 email:
 - dhruva.sagar@gmail.com
 executables: []
@@ -172,7 +189,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1107948345985026072
+      hash: 1304314171883105113
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -181,7 +198,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1107948345985026072
+      hash: 1304314171883105113
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23