fuzzily 0.1.0 → 0.2.0

data/Gemfile.lock

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

data/README.md

@@ -48,9 +48,7 @@ Instrument your model (your searchable fields do not have to be stored, they can
 
 Index your model (will happen automatically for new/updated records):
 
-    MyStuff.find_each do |record|
-      record.update_fuzzy_name!
-    end
+    MyStuff.bulk_update_fuzzy_name
 
 Search!
 
@@ -87,6 +85,21 @@ If you want or need to name your index model differently (e.g. because you alrea
     end
 
 
+## Speeding things up
+
+For large data sets (millions of rows to index), the "compatible" storage
+used by default will typically no longer be enough to keep the index small
+enough.
+
+Users have reported **major improvements** (2 order of magniture) when turning
+the `owner_type` and `fuzzy_field` columns of the `trigrams` table from
+`VARCHAR` (the default) into `ENUM`. This is particularly efficient with
+MySQL and pgSQL.
+
+This is not the default in the gem as ActiveRecord does not suport `ENUM`
+columns in any version
+
+
 ## License
 
 MIT licence. Quite permissive if you ask me.

data/lib/fuzzily/migration.rb

@@ -15,7 +15,7 @@ module Fuzzily
         def up
           create_table trigrams_table_name do |t|
             t.string  :trigram, :limit => 3
-            t.integer :score
+            t.integer :score,   :limit => 2
             t.integer :owner_id
             t.string  :owner_type
             t.string  :fuzzy_field

data/lib/fuzzily/searchable.rb

@@ -47,8 +47,8 @@ module Fuzzily
         self.scoped(:include => trigram_association).find_in_batches(:batch_size => 100) do |batch|
           inserts = []
           batch.each do |record|
-            record.send(field).extend(String).trigrams.each do |trigram|
-              inserts << sanitize_sql_array(['(?,?,?,?,?)', self.name, record.id, field.to_s, 1, trigram])
+            record.send(field).extend(String).scored_trigrams.each do |trigram, score|
+              inserts << sanitize_sql_array(['(?,?,?,?,?)', self.name, record.id, field.to_s, score, trigram])
             end
           end
 
@@ -66,8 +66,8 @@ module Fuzzily
 
       define_method update_trigrams_method do
         self.send(trigram_association).delete_all
-        self.send(field).extend(String).trigrams.each do |trigram|
-          self.send(trigram_association).create!(:score => 1, :trigram => trigram, :owner_type => self.class.name)
+        self.send(field).extend(String).scored_trigrams.each do |trigram, score|
+          self.send(trigram_association).create!(:score => score, :trigram => trigram, :owner_type => self.class.name)
         end
       end
 

data/lib/fuzzily/trigram.rb

@@ -4,7 +4,14 @@ module Fuzzily
   module String
     def trigrams
       normalized = self.normalize
-      (0..(normalized.length - 3)).map { |index| normalized[index,3] }.uniq
+      number_of_trigrams = normalized.length - 3
+      trigrams = (0..number_of_trigrams).map { |index| normalized[index,3] }.uniq
+    end
+
+    def scored_trigrams
+      trigrams_ = self.trigrams
+      score = 32_768 / trigrams_.length
+      trigrams_.map { |t| [t, score] }
     end
 
     protected

data/lib/fuzzily/version.rb

@@ -1,3 +1,3 @@
 module Fuzzily
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/fuzzily/searchable_spec.rb

@@ -83,6 +83,16 @@ describe Fuzzily::Searchable do
         subject.find_by_fuzzy_name('Piris').should =~ [@paris, @palma]
         subject.find_by_fuzzy_name('Paradise').should =~ [@paris, @palma, @palmyre]
       end
+
+      it 'favours exact matches' do
+        subject.fuzzily_searchable :name
+        @new_york   = subject.create(:name => 'New York')
+        @yorkshire  = subject.create(:name => 'Yorkshire')
+        @york       = subject.create(:name => 'York')
+        @yorkisthan = subject.create(:name => 'Yorkisthan')
+
+        subject.find_by_fuzzy_name('York').should == [@york, @yorkshire, @yorkisthan, @new_york]
+      end
     end
   end
 

metadata

@@ -1,135 +1,133 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: fuzzily
-version: !ruby/object:Gem::Version
-  version: 0.1.0
+version: !ruby/object:Gem::Version 
+  hash: 23
   prerelease: 
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
-authors:
+authors: 
 - Julien Letessier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-04 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: activerecord
-  requirement: !ruby/object:Gem::Requirement
+
+date: 2013-03-06 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 33
+        segments: 
+        - 2
+        - 3
+        - 17
         version: 2.3.17
-  type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  name: activerecord
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 2.3.17
-- !ruby/object:Gem::Dependency
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
   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
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
   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
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
   name: appraisal
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
   type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
   name: pry
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
   type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
   name: pry-nav
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
   type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
   name: sqlite3
-  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'
+  version_requirements: *id007
 description: Fast fuzzy string matching for rails
-email:
+email: 
 - julien.letessier@gmail.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - .rspec
 - .travis.yml
@@ -160,38 +158,41 @@ files:
 - spec/fuzzily/trigram_spec.rb
 - spec/meta_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+has_rdoc: true
+homepage: ""
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
       - 0
-      hash: -3139686676920702806
-required_rubygems_version: !ruby/object:Gem::Requirement
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
       - 0
-      hash: -3139686676920702806
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.3.9.5
 signing_key: 
 specification_version: 3
-summary: A fast, trigram-based, database-backed fuzzy string search/match engine for
-  Rails.
-test_files:
+summary: A fast, trigram-based, database-backed fuzzy string search/match engine for Rails.
+test_files: 
 - spec/fuzzily/migration_spec.rb
 - spec/fuzzily/model_spec.rb
 - spec/fuzzily/searchable_spec.rb