soulmate_rails 0.2.0.alpha → 0.2.1.beta

data/README.markdown

@@ -1,17 +1,22 @@
-# Soulmate Rails
+# Soulmate Rails [![Gem Version](https://badge.fury.io/rb/soulmate_rails.png)](http://badge.fury.io/rb/soulmate_rails) [![Build Status](https://travis-ci.org/dhruvasagar/soulmate_rails.png?branch=master)](https://travis-ci.org/dhruvasagar/soulmate_rails) [![Dependency Status](https://gemnasium.com/dhruvasagar/soulmate_rails.png)](https://gemnasium.com/dhruvasagar/soulmate_rails)
+<!--[![Build Status](https://drone.io/github.com/dhruvasagar/soulmate_rails/status.png)](https://drone.io/github.com/dhruvasagar/soulmate_rails/latest)-->
 
-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.
+Soulmate Rails is a rails plugin that helps to solve the common problem
+building auto-completion back-end 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
 ```
+OR add this to your `Gemfile` :
+
+```ruby
+gem 'soulmate_rails'
+```
 
 ### Usage :
 
@@ -24,7 +29,7 @@ class User < ActiveRecord::Base
   autocomplete :last_name, :score => :id
 
   def calculate_score
-    # Some magic calculation returning a number.
+    100 / self.id # simple score calculator
   end
 end
 
@@ -33,15 +38,23 @@ end
 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},
+  @attributes={"first_name"=>"First1", "last_name"=>"Last1" "id"=>1},
   @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},
+  @attributes={"first_name"=>"First3", "last_name"=>"Last3" "id"=>3},
   @changed_attributes={}>]
 1.9.3p385 :005 > User.search_by_last_name('last1')
+  => [#<User:0x000000014bb1e8 @new_record=false,
+  @attributes={"first_name"=>"First1", "last_name"=>"Last1" "id"=>1},
+  @changed_attributes={}>]
+1.9.3p385 :006 > User.search_by_last_name('las')
   => [#<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={}>]
 ```
 
@@ -50,8 +63,7 @@ The `autocomplete` method takes 2 arguments :
 * attribute name to use for autocompletion.
 * options that determine how autocompletion works for indexing.
 
-Methods added by autocomplete :
-
+### Methods added by autocomplete :
 * Class Methods
   * `search_by(attribute, term, options={})` - Generic method to search by
     an attribute for which an autocomplete was defined.
@@ -67,14 +79,36 @@ Methods added by autocomplete :
     `delete` to ensure the callbacks are invoked appropriately by rails and
     soulmate updates the index.
 
-Options you can provide to `autocomplete` :
+### 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
+  the name of a method which returns an array of values.
+* `:data` : This is optional. This can either be the name of a method which
+  returns data or a hash or a string. Once you perform your search using
+  `search_by` or `search_by_#{attribute}` it will set the value of :data
+  corresponding to the object to soulmate_data attr_accessor and can be
+  accessed by calling the soulmate_data accessor on the model object.
+
+### Configuration :
+Within your rails application inside config/application.rb you can optionally
+provide redis configuration. Example :
 
-  * `: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.
+```ruby
+config.soulmate_rails.redis = 'redis://127.0.0.1:6380/0'
+# or you can assign an existing instance of Redis, Redis::Namespace, etc.
+# config.soulmate_rails.redis = $redis
+```
+
+Alternatively, you can also add configuration in an initializer. Example :
+
+```ruby
+Soulmate.redis = 'redis://127.0.0.1:6380/0'
+# or you can assign an existing instance of Redis, Redis::Namespace, etc.
+# Soulmate.redis = $redis
+```
 
 ## Contributing
 ### Reporting an Issue :
@@ -88,6 +122,7 @@ Options you can provide to `autocomplete` :
 * Open a Pull Request.
 
 ## License
-Soulmate Rails is released under the MIT License
+Soulmate Rails is released under the <a
+href="http://www.opensource.org/licenses/MIT">MIT License</a>
 
 <!-- vim: set tw=80 colorcolumn=80 -->

data/lib/soulmate_rails/model_additions.rb

@@ -2,15 +2,39 @@ module SoulmateRails
   module ModelAdditions
     extend ActiveSupport::Concern
 
+    included do
+      class_eval do
+        attr_accessor :soulmate_data
+      end
+    end
+
     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] ) : {} )
+      }
+
+      if options[:aliases]
+        if options[:aliases].is_a?(Array)
+          item.merge!({'aliases' => options[:aliases]})
+        elsif respond_to?(options[:aliases])
+          aliases = send(options[:aliases])
+          item.merge!({'aliases' => aliases}) if aliases && aliases.is_a?(Array)
+        end
+      end
+
+      if options[:data]
+        if options[:data].is_a?(Hash)
+          item.merge!({'data' => options[:data]})
+        elsif respond_to?(options[:data])
+          item.merge!({'data' => send(options[:data])})
+        elsif options[:data].is_a?(String)
+          item.merge!({'data' => options[:data]})
+        end
+      end
+
       loader.add(item, options)
     end
 
@@ -45,8 +69,10 @@ module SoulmateRails
         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
+          object = find(match['id'].split('_')[-1].to_i)
+          object.soulmate_data = match['data'].symbolize_keys if object && match['data']
+          object
+        end
       end
 
       def matcher_for(attribute)

data/lib/soulmate_rails/version.rb

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

data/spec/samples/models/user_aliases.rb

@@ -0,0 +1,9 @@
+class UserAliases < SuperModel::Base
+  include SoulmateRails::ModelAdditions
+
+  autocomplete :name, :score => :id, :aliases => :name_aliases
+
+  def name_aliases
+    self.name.split(' ').map(&:reverse)
+  end
+end

data/spec/samples/models/user_data.rb

@@ -0,0 +1,5 @@
+class UserData < SuperModel::Base
+  include SoulmateRails::ModelAdditions
+
+  autocomplete :name, :score => :id, :data => {:source => 'test'}
+end

data/spec/samples/models/user_multiple.rb

@@ -0,0 +1,6 @@
+class UserMultiple < SuperModel::Base
+  include SoulmateRails::ModelAdditions
+
+  autocomplete :name, :score => :id
+  autocomplete :country, :score => :id
+end

data/spec/samples/models/user_single.rb

@@ -0,0 +1,5 @@
+class UserSingle < SuperModel::Base
+  include SoulmateRails::ModelAdditions
+
+  autocomplete :name, :score => :id
+end

data/spec/soulmate_rails/model_additions_spec.rb

@@ -1,45 +1,91 @@
 require 'spec_helper'
 
-module SoulmateRails
-  class User < SuperModel::Base
-    include ModelAdditions
-
-    autocomplete :name, :score => :id
-  end
+require 'samples/models/user_single'
+require 'samples/models/user_multiple'
+require 'samples/models/user_aliases'
+require 'samples/models/user_data'
 
+module SoulmateRails
   describe ModelAdditions do
-    context 'single autocomplete' do
+    context 'autocomplete for name' do
       before :each do
-        @user = User.create(:name => 'Dhruva Sagar')
+        @user = UserSingle.create(:name => 'Dhruva Sagar')
       end
 
       it 'should successfully search by name' do
-        users = User.search_by_name('dhruv')
+        # By first name
+        users = UserSingle.search_by_name('dhr')
         user = users.first
         user.should eq(@user)
+
+        # By last name
+        users = UserSingle.search_by_name('sag')
+        user = users.first
+        user.should eq(@user)
+      end
+
+      after :each do
+        UserSingle.destroy_all
       end
     end
 
-    context 'multiple autocompletes' do
+    context 'autocomplete for name and country' do
       before :each do
-        # Define another autocomplete for country
-        User.autocomplete(:country, :score => :id)
-        @user = User.create(:name => 'Dhruva Sagar', :country => 'India')
+        @user = UserMultiple.create(:name => 'Dhruva Sagar', :country => 'India')
       end
 
       it 'should successfully search by name as well as country' do
-        users = User.search_by_name('dhr')
+        users = UserMultiple.search_by_name('dhr')
+        user = users.first
+        user.should eq(@user)
+
+        users = UserMultiple.search_by_country('ind')
+        user = users.first
+        user.should eq(@user)
+      end
+
+      after :each do
+        UserMultiple.destroy_all
+      end
+    end
+
+    context 'autocomplete name with aliases' do
+      before :each do
+        @user = UserAliases.create(:name => 'Dhruva Sagar')
+      end
+
+      it 'should successfully search by name'  do
+        # By reverse of my first name
+        users = UserAliases.search_by_name('avu')
         user = users.first
         user.should eq(@user)
 
-        users = User.search_by_country('ind')
+        # By reverse of my last name
+        users = UserAliases.search_by_name('rag')
         user = users.first
         user.should eq(@user)
       end
+
+      after :each do
+        UserAliases.destroy_all
+      end
     end
 
-    after :each do
-      User.destroy_all
+    context 'autocomplete name with additional data' do
+      before :each do
+        @user = UserData.create(:name => 'Dhruva Sagar', :country => 'India')
+      end
+
+      it 'should successfully search by name and set data' do
+        users = UserData.search_by_name('dhr')
+        user = users.first
+        user.should eq(@user)
+        user.soulmate_data.should eq({:source => 'test'})
+      end
+
+      after :each do
+        UserData.destroy_all
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: soulmate_rails
 version: !ruby/object:Gem::Version
-  version: 0.2.0.alpha
+  version: 0.2.1.beta
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-04 00:00:00.000000000 Z
+date: 2013-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -132,11 +132,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .document
 - .gitignore
 - .rvmrc
 - Gemfile
-- LICENSE.txt
 - README.markdown
 - Rakefile
 - lib/soulmate/base.rb
@@ -149,6 +147,10 @@ files:
 - lib/soulmate_rails/version.rb
 - soulmate_rails.gemspec
 - spec/config/test.conf
+- spec/samples/models/user_aliases.rb
+- spec/samples/models/user_data.rb
+- spec/samples/models/user_multiple.rb
+- spec/samples/models/user_single.rb
 - spec/samples/stop-words.txt
 - spec/samples/venues.json
 - spec/soulmate/loader_spec.rb
@@ -170,7 +172,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2339712200945415298
+      hash: 270579878346958434
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/.document

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

data/LICENSE.txt

@@ -1,20 +0,0 @@
-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.