fuzzily 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c6b37d6f8b23347b04d0efb6d069c41654def4e5
-  data.tar.gz: 30c2b6d4362466e5cb63a9ae14496bd92e26ac54
+  metadata.gz: 3c1f0be1e0222fd105f14a6021e65e0b92ecf154
+  data.tar.gz: a96c50991cf0d5f180960b2f81086dd22038bec7
 SHA512:
-  metadata.gz: b65ff29d86fb3822ee426f1f7731d4f254f5cc180c5b4b0cf8f5489d2c492d02341ca3747a349f60291bb035783d617d333a72c55c7e80e794b5198860423348
-  data.tar.gz: f2993001f8f9189101644ff8ce52d243832e2479f6cc1b567632d6f2d7d2ffe4c6be5cef87a9082eaf62bd50fe482907065dec22a24e561244a8a118e989a4d6
+  metadata.gz: 95b1281eba8a4898f740d2b5a2038ba05f8a83ada3766a136c9d468ab8d3091970d9ad26103f7fdb186001d0dbf67f6556d1c99bc53603d6389f901d1bc9a732
+  data.tar.gz: 0dedbefc9d1f58f78ee76e7b9777056d83b82f53396b5f4dd3edd647ccd6cf33d998959e10e5f5192b800a51bead6ba06516d0193f1e1254d3d3fe56f83ad08f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fuzzily (0.3.0)
+    fuzzily (0.3.1)
       activerecord (>= 2.3.17)
 
 GEM

data/README.md

@@ -11,7 +11,7 @@
 > Here aresome photos of **Marrakesh**, Morroco.
 > Did you mean **Martanesh**, Albania, **Marakkanam**, India, or **Marasheshty**, Romania?
 
-Blurrily finds misspelled, prefix, or partial needles in a haystack of
+Fuzzily finds misspelled, prefix, or partial needles in a haystack of
 strings. It's a fast, [trigram](http://en.wikipedia.org/wiki/N-gram)-based, database-backed [fuzzy](http://en.wikipedia.org/wiki/Approximate_string_matching) string search/match engine for Rails.
 Loosely inspired from an [old blog post](http://unirec.blogspot.co.uk/2007/12/live-fuzzy-search-using-n-grams-in.html).
 
@@ -45,63 +45,77 @@ You'll need to setup 2 things:
 
 Create and ActiveRecord model in your app (this will be used to store a "fuzzy index" of all the models and fields you will be indexing):
 
-    class Trigram < ActiveRecord::Base
-      include Fuzzily::Model
-    end
+```ruby
+class Trigram < ActiveRecord::Base
+  include Fuzzily::Model
+end
+```
 
 Create a migration for it:
 
-    class AddTrigramsModel < ActiveRecord::Migration
-      extend Fuzzily::Migration
-    end
+```ruby
+class AddTrigramsModel < ActiveRecord::Migration
+  extend Fuzzily::Migration
+end
+```
 
-Instrument your model (your searchable fields do not have to be stored, they can be dynamic methods too):
+Instrument your model:
 
-    class MyStuff < ActiveRecord::Base
-      # assuming my_stuffs has a 'name' attribute
-      fuzzily_searchable :name
-    end
+```ruby
+class MyStuff < ActiveRecord::Base
+  # assuming my_stuffs has a 'name' attribute
+  fuzzily_searchable :name
+end
+```
 
 Index your model (will happen automatically for new/updated records):
 
-    MyStuff.bulk_update_fuzzy_name
+```ruby
+MyStuff.bulk_update_fuzzy_name
+```
 
 Search!
 
-    MyStuff.find_by_fuzzy_name('Some Name', :limit => 10)
-    # => records
+```ruby
+MyStuff.find_by_fuzzy_name('Some Name', :limit => 10)
+# => records
+```
 
 You can force an update on a specific record with
 
-    MyStuff.find(123).update_fuzzy_name!
+```ruby
+MyStuff.find(123).update_fuzzy_name!
+```
 
 ## Indexing more than one field
 
 Just list all the field you want to index, or call `fuzzily_searchable` more than once: 
 
-    class MyStuff < ActiveRecord::Base
-      fuzzily_searchable :name_fr, :name_en
-      fuzzily_searchable :name_de
-    end
-
+```ruby
+class MyStuff < ActiveRecord::Base
+  fuzzily_searchable :name_fr, :name_en
+  fuzzily_searchable :name_de
+end
+```
 
 ## Custom name for the index model
 
 If you want or need to name your index model differently (e.g. because you already have a class called `Trigram`):
 
-    class CustomTrigram < ActiveRecord::Base
-      include Fuzzily::Model
-    end
-
-    class AddTrigramsModel < ActiveRecord::Migration
-      extend Fuzzily::Migration
-      trigrams_table_name = :custom_trigrams
-    end
+```ruby
+class CustomTrigram < ActiveRecord::Base
+  include Fuzzily::Model
+end
 
-    class MyStuff < ActiveRecord::Base
-      fuzzily_searchable :name, :class_name => 'CustomTrigram'
-    end
+class AddTrigramsModel < ActiveRecord::Migration
+  extend Fuzzily::Migration
+  trigrams_table_name = :custom_trigrams
+end
 
+class MyStuff < ActiveRecord::Base
+  fuzzily_searchable :name, :class_name => 'CustomTrigram'
+end
+```
 
 ## Speeding things up
 
@@ -117,6 +131,38 @@ MySQL and pgSQL.
 This is not the default in the gem as ActiveRecord does not suport `ENUM`
 columns in any version.
 
+## UUID's
+
+When using Rails 4 with UUID's, you will need to change the `owner_id` column type to `UUID`.
+
+```ruby
+class AddTrigramsModel < ActiveRecord::Migration
+  extend Fuzzily::Migration
+  trigrams_owner_id_column_type = :uuid
+end
+```
+
+## Searching virtual attributes
+
+Your searchable fields do not have to be stored, they can be dynamic methods
+too. Just remember to add a virtual change method as well.
+For instance, if you model has `first_name` and `last_name` attributes, and you
+want to index a compound `name` dynamic attribute: 
+
+```ruby
+class Employee < ActiveRecord::Base
+  fuzzily_searchable :name
+  def name
+    "#{first_name} #{last_name}"
+  end
+
+  def name_changed?
+    first_name_changed? || last_name_changed?
+  end
+end
+```
+
+
 
 ## License
 
@@ -133,5 +179,5 @@ Copyright (c) 2013 HouseTrip Ltd.
 5. Create a new Pull Request
 
 
-Thanks to @bclennox, @fdegiuli, @nickbender, @Shanison for pointing out
+Thanks to @bclennox, @fdegiuli, @nickbender, @Shanison, @rickbutton for pointing out
 and/or helping on various issues.

data/gemfiles/rails23.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: /Users/mezis/Dropbox/Development/fuzzily
   specs:
-    fuzzily (0.3.0)
+    fuzzily (0.3.1)
       activerecord (>= 2.3.17)
 
 GEM

data/gemfiles/rails30.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: /Users/mezis/Dropbox/Development/fuzzily
   specs:
-    fuzzily (0.3.0)
+    fuzzily (0.3.1)
       activerecord (>= 2.3.17)
 
 GEM

data/gemfiles/rails31.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: /Users/mezis/Dropbox/Development/fuzzily
   specs:
-    fuzzily (0.3.0)
+    fuzzily (0.3.1)
       activerecord (>= 2.3.17)
 
 GEM

data/gemfiles/rails32.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: /Users/mezis/Dropbox/Development/fuzzily
   specs:
-    fuzzily (0.3.0)
+    fuzzily (0.3.1)
       activerecord (>= 2.3.17)
 
 GEM

data/gemfiles/rails32_mysql.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: /Users/mezis/Dropbox/Development/fuzzily
   specs:
-    fuzzily (0.3.0)
+    fuzzily (0.3.1)
       activerecord (>= 2.3.17)
 
 GEM

data/gemfiles/rails32_pg.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: /Users/mezis/Dropbox/Development/fuzzily
   specs:
-    fuzzily (0.3.0)
+    fuzzily (0.3.1)
       activerecord (>= 2.3.17)
 
 GEM

data/gemfiles/rails40.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: /Users/mezis/Dropbox/Development/fuzzily
   specs:
-    fuzzily (0.3.0)
+    fuzzily (0.3.1)
       activerecord (>= 2.3.17)
 
 GEM

data/lib/fuzzily/migration.rb

@@ -12,11 +12,19 @@ module Fuzzily
           @trigrams_table_name ||= :trigrams
         end
 
+        def trigrams_owner_id_column_type=(custom_type)
+          @trigrams_owner_id_column_type = custom_type
+        end
+
+        def trigrams_owner_id_column_type
+          @trigrams_owner_id_column_type ||= :integer
+        end
+
         def up
           create_table trigrams_table_name do |t|
             t.string  :trigram, :limit => 3
             t.integer :score,   :limit => 2
-            t.integer :owner_id
+            t.send trigrams_owner_id_column_type, :owner_id
             t.string  :owner_type
             t.string  :fuzzy_field
           end

data/lib/fuzzily/model.rb

@@ -35,8 +35,7 @@ module Fuzzily
             scoped(:select => 'owner_id, owner_type, count(*) AS matches, MAX(score) AS score').
             scoped(:group => 'owner_id, owner_type').
             scoped(:order => 'matches DESC, score ASC').
-            with_trigram(trigrams).
-            map(&:owner)
+            with_trigram(trigrams)
         end
 
         def _add_fuzzy_scopes
@@ -59,8 +58,7 @@ module Fuzzily
             select('owner_id, owner_type, count(*) AS matches, MAX(score) AS score').
             group('owner_id, owner_type').
             order('matches DESC, score ASC').
-            with_trigram(trigrams).
-            map(&:owner)
+            with_trigram(trigrams)
         end
 
         def _add_fuzzy_scopes

data/lib/fuzzily/searchable.rb

@@ -36,12 +36,23 @@ module Fuzzily
 
       def _find_by_fuzzy(_o, pattern, options={})
         options[:limit] ||= 10
+        options[:offset] ||= 0
 
-        _o.trigram_class_name.constantize.
+        trigrams = _o.trigram_class_name.constantize.
           limit(options[:limit]).
+          offset(options[:offset]).
           for_model(self.name).
           for_field(_o.field.to_s).
           matches_for(pattern)
+        records = _load_for_ids(trigrams.map(&:owner_id))
+        # order records as per trigram query (no portable way to do this in SQL)
+        trigrams.map { |t| records[t.owner_id] }
+      end
+
+      def _load_for_ids(ids)
+        {}.tap do |result|
+          find(ids).each { |_r| result[_r.id] = _r }
+        end
       end
 
       def _bulk_update_fuzzy(_o)
@@ -123,9 +134,7 @@ module Fuzzily
       end
     end
 
-    module Rails2ClassMethods
-      include ClassMethods
-
+    module Rails2Rails3ClassMethods
       private
 
       def _add_trigram_association(_o)
@@ -142,7 +151,23 @@ module Fuzzily
       end
     end
 
-    Rails3ClassMethods = Rails2ClassMethods
+    module Rails2ClassMethods
+      include ClassMethods
+      include Rails2Rails3ClassMethods
+
+      def self.extended(base)
+        base.class_eval do
+          named_scope :offset, lambda { |*args| { :offset => args.first } }
+        end
+      end
+    end
+
+    module Rails3ClassMethods
+      include ClassMethods
+      include Rails2Rails3ClassMethods
+    end
+
+
 
     module Rails4ClassMethods
       include ClassMethods
@@ -164,4 +189,4 @@ module Fuzzily
     end
 
   end
-end
+end

data/lib/fuzzily/version.rb

@@ -1,3 +1,3 @@
 module Fuzzily
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/spec/fuzzily/model_spec.rb

@@ -43,21 +43,21 @@ describe Fuzzily::Model do
       end
 
       it 'finds matches' do
-        model.matches_for('Paris').should == [@paris]
+        model.matches_for('Paris').map(&:owner).should == [@paris]
       end
 
       it 'finds close matches' do
-        model.matches_for('Piriss').should == [@paris]
+        model.matches_for('Piriss').map(&:owner).should == [@paris]
       end
 
       it 'does not confuse fields' do
-        model.for_field(:name).matches_for('Paris').should == [@paris]
-        model.for_field(:data).matches_for('Paris').should be_empty
+        model.for_field(:name).matches_for('Paris').map(&:owner).should == [@paris]
+        model.for_field(:data).matches_for('Paris').map(&:owner).should be_empty
       end
 
       it 'does not confuse owner types' do
-        model.for_model(Stuff).matches_for('Paris').should == [@paris]
-        model.for_model(Object).matches_for('Paris').should be_empty
+        model.for_model(Stuff).matches_for('Paris').map(&:owner).should == [@paris]
+        model.for_model(Object).matches_for('Paris').map(&:owner).should be_empty
       end
 
       context '(with more than one entry)' do
@@ -69,7 +69,7 @@ describe Fuzzily::Model do
         end
 
         it 'returns ordered results' do
-          model.matches_for('Palmyre').should == [@palma, @paris]
+          model.matches_for('Palmyre').map(&:owner).should == [@palma, @paris]
         end
       end
     end

data/spec/fuzzily/searchable_spec.rb

@@ -135,12 +135,18 @@ describe Fuzzily::Searchable do
         subject.find_by_fuzzy_name('Lon').should == [@london, @lo]
       end
 
-      it 'honours limie option' do
+      it 'honours limit option' do
         subject.fuzzily_searchable :name
         3.times { subject.create!(:name => 'Paris') }
         subject.find_by_fuzzy_name('Paris', :limit => 2).length.should == 2
       end
+
+      it 'honours offset option' do
+        subject.fuzzily_searchable :name
+        3.times { subject.create!(:name => 'Paris') }
+        subject.find_by_fuzzy_name('Paris', :offset => 2).length.should == 1
+      end
     end
   end
 
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fuzzily
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Julien Letessier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-31 00:00:00.000000000 Z
+date: 2013-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord