fuzzily 0.2.0 → 0.2.1

data/.gitignore

@@ -14,3 +14,10 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+
+# CTags
+.tags*
+
+# Data
+*.gz
+*.bz2

data/.ruby-version

@@ -0,0 +1 @@
+1.9.2-p320

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fuzzily (0.2.0)
+    fuzzily (0.2.1)
       activerecord (>= 2.3.17)
 
 GEM
@@ -24,10 +24,11 @@ GEM
     arel (3.0.2)
     builder (3.0.4)
     coderay (1.0.9)
-    diff-lcs (1.1.3)
-    i18n (0.6.1)
+    diff-lcs (1.2.1)
+    i18n (0.6.4)
     method_source (0.8.1)
     multi_json (1.6.1)
+    mysql2 (0.3.11)
     pry (0.9.12)
       coderay (~> 1.0.5)
       method_source (~> 0.8)
@@ -35,17 +36,17 @@ GEM
     pry-nav (0.2.3)
       pry (~> 0.9.10)
     rake (10.0.3)
-    rspec (2.12.0)
-      rspec-core (~> 2.12.0)
-      rspec-expectations (~> 2.12.0)
-      rspec-mocks (~> 2.12.0)
-    rspec-core (2.12.2)
-    rspec-expectations (2.12.1)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.12.2)
-    slop (3.4.3)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.0)
+    slop (3.4.4)
     sqlite3 (1.3.7)
-    tzinfo (0.3.35)
+    tzinfo (0.3.37)
 
 PLATFORMS
   ruby
@@ -53,6 +54,7 @@ PLATFORMS
 DEPENDENCIES
   appraisal
   fuzzily!
+  mysql2
   pry
   pry-nav
   rake

data/README.md

@@ -1,5 +1,8 @@
 # Fuzzily
 
+[![Build Status](https://travis-ci.org/mezis/fuzzily.png?branch=master)](https://travis-ci.org/mezis/fuzzily)
+[![Dependency Status](https://gemnasium.com/mezis/fuzzily.png)](https://gemnasium.com/mezis/fuzzily)
+
 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).

data/fuzzily.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'pry'
   gem.add_development_dependency 'pry-nav'
   gem.add_development_dependency 'sqlite3'
+  gem.add_development_dependency 'mysql2'
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/lib/fuzzily/migration.rb

@@ -21,11 +21,12 @@ module Fuzzily
             t.string  :fuzzy_field
           end
 
+          # owner_id goes first as we'll GROUP BY that
           add_index trigrams_table_name,
-            [:owner_type, :fuzzy_field, :trigram, :owner_id, :score],
+            [:owner_id, :owner_type, :fuzzy_field, :trigram, :score],
             :name => :index_for_match
           add_index trigrams_table_name,
-            [:owner_type, :owner_id],
+            [:owner_id, :owner_type],
             :name => :index_by_owner
         end
 

data/lib/fuzzily/model.rb

@@ -13,7 +13,7 @@ module Fuzzily
 
         belongs_to :owner, :polymorphic => true
         validates_presence_of     :owner
-        validates_uniqueness_of   :trigram, :scope => [:owner_type, :owner_id]
+        validates_uniqueness_of   :trigram, :scope => [:owner_type, :owner_id, :fuzzy_field]
         validates_length_of       :trigram, :is => 3
         validates_presence_of     :score
         validates_presence_of     :fuzzy_field
@@ -35,18 +35,13 @@ module Fuzzily
     end
 
     module ClassMethods
-      # options:
-      # - model (mandatory)
-      # - field (mandatory)
-      # - limit (default 10)
-      def matches_for(text, options = {})
-        options[:limit] ||= 10
+      def matches_for(text)
+        trigrams = Fuzzily::String.new(text).trigrams
         self.
-          scoped(:select => 'owner_id, owner_type, SUM(score) AS total_score').
+          scoped(:select => 'owner_id, owner_type, count(*) AS matches, score').
           scoped(:group => :owner_id).
-          scoped(:order => 'total_score DESC').
-          scoped(:limit => options[:limit]).
-          with_trigram(text.extend(String).trigrams).
+          scoped(:order => 'matches DESC, score ASC').
+          with_trigram(trigrams).
           map(&:owner)
       end
     end

data/lib/fuzzily/searchable.rb

@@ -34,6 +34,8 @@ module Fuzzily
           else        raise 'Wrong # of arguments'
         end
 
+        options[:limit] ||= 10
+
         trigram_class_name.constantize.
           scoped(options).
           for_model(self.name).
@@ -47,7 +49,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).scored_trigrams.each do |trigram, score|
+            data = Fuzzily::String.new(record.send(field))
+            data.scored_trigrams.each do |trigram, score|
               inserts << sanitize_sql_array(['(?,?,?,?,?)', self.name, record.id, field.to_s, score, trigram])
             end
           end
@@ -66,7 +69,7 @@ module Fuzzily
 
       define_method update_trigrams_method do
         self.send(trigram_association).delete_all
-        self.send(field).extend(String).scored_trigrams.each do |trigram, score|
+        String.new(self.send(field)).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

@@ -1,7 +1,8 @@
 require 'active_support/core_ext/string/multibyte'
-
+require 'delegate'
 module Fuzzily
-  module String
+  class String < SimpleDelegator
+
     def trigrams
       normalized = self.normalize
       number_of_trigrams = normalized.length - 3
@@ -9,9 +10,7 @@ module Fuzzily
     end
 
     def scored_trigrams
-      trigrams_ = self.trigrams
-      score = 32_768 / trigrams_.length
-      trigrams_.map { |t| [t, score] }
+      trigrams.map { |t| [t, self.length] }
     end
 
     protected
@@ -22,9 +21,10 @@ module Fuzzily
       # Iconv.iconv('ascii//translit//ignore', 'utf-8', self).first.
       ActiveSupport::Multibyte::Chars.new(self).
         mb_chars.normalize(:kd).gsub(/[^\x00-\x7F]/,'').downcase.to_s.
-        gsub(/\W/,' ').
+        gsub(/[^a-z]/,' ').
         gsub(/\s+/,'*').
-        gsub(/^/,'**')
+        gsub(/^/,'**').
+        gsub(/$/,'*')
     end
   end
 end

data/lib/fuzzily/version.rb

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

data/spec/fuzzily/model_spec.rb

@@ -68,10 +68,6 @@ describe Fuzzily::Model do
           end
         end
 
-        it 'honors the limit option' do
-          model.matches_for('Palmyre', :limit => 1).should == [@palma]
-        end
-
         it 'returns ordered results' do
           model.matches_for('Palmyre').should == [@palma, @paris]
         end

data/spec/fuzzily/searchable_spec.rb

@@ -57,7 +57,7 @@ describe Fuzzily::Searchable do
     it 'updates all trigram records on save' do
       subject.create(:name => 'Paris')
       subject.first.update_attribute :name, 'Rome'
-      Trigram.all.map(&:trigram).should =~ %w(**r *ro rom ome)
+      Trigram.all.map(&:trigram).should =~ %w(**r *ro rom ome me*)
     end
   end
 
@@ -91,7 +91,16 @@ describe Fuzzily::Searchable do
         @york       = subject.create(:name => 'York')
         @yorkisthan = subject.create(:name => 'Yorkisthan')
 
-        subject.find_by_fuzzy_name('York').should == [@york, @yorkshire, @yorkisthan, @new_york]
+        subject.find_by_fuzzy_name('York').should      == [@york, @new_york, @yorkshire, @yorkisthan]
+        subject.find_by_fuzzy_name('Yorkshire').should == [@yorkshire, @york, @yorkisthan, @new_york]
+      end
+
+      it 'does not favour short words' do
+        subject.fuzzily_searchable :name
+        @lo     = subject.create(:name => 'Lo')      # **l *lo lo*
+        @london = subject.create(:name => 'London')  # **l *lo lon ond ndo don on*
+                                                     # **l *lo lon
+        subject.find_by_fuzzy_name('Lon').should == [@london, @lo]
       end
     end
   end

data/spec/fuzzily/trigram_spec.rb

@@ -3,22 +3,23 @@ require 'spec_helper'
 
 describe Fuzzily::String do
   def result(string)
-    string.extend(described_class).trigrams
+    described_class.new(string).trigrams
   end
   
   it 'splits strings into trigrams' do
-    result('Paris').should == %w(**p *pa par ari ris)
+    result('Paris').should == %w(**p *pa par ari ris is*)
   end
 
   it 'removes accents' do
-    result('Montélimar').should == %w(**m *mo mon ont nte tel eli lim ima mar)
+    result('Montélimar').should == %w(**m *mo mon ont nte tel eli lim ima mar ar*)
   end
 
   it 'handles multi word strings' do
-    result('Le Mans').should == %w(**l *le le* e*m *ma man ans)
+    result('Le Mans').should == %w(**l *le le* e*m *ma man ans ns*)
   end
 
-  it 'removes symbols' do
+  it 'removes symbols and duplicates' do
+    # The final ess, sse, se* would be dupes.
     result('Besse-en-Chandesse').should == %w(**b *be bes ess sse se* e*e *en en* n*c *ch cha han and nde des)
   end
 end

metadata

@@ -1,135 +1,154 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: fuzzily
-version: !ruby/object:Gem::Version 
-  hash: 23
+version: !ruby/object:Gem::Version
+  version: 0.2.1
   prerelease: 
-  segments: 
-  - 0
-  - 2
-  - 0
-  version: 0.2.0
 platform: ruby
-authors: 
+authors:
 - Julien Letessier
 autorequire: 
 bindir: bin
 cert_chain: []
-
-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 
-        hash: 33
-        segments: 
-        - 2
-        - 3
-        - 17
-        version: 2.3.17
-  prerelease: false
+date: 2013-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.17
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.17
+- !ruby/object:Gem::Dependency
   name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
   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
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  requirement: &id007 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id007
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  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: Fast fuzzy string matching for rails
-email: 
+email:
 - julien.letessier@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rspec
+- .ruby-version
 - .travis.yml
 - Appraisals
 - Gemfile
@@ -158,41 +177,38 @@ files:
 - spec/fuzzily/trigram_spec.rb
 - spec/meta_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
-homepage: ""
+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 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: 2813832546497713737
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: 2813832546497713737
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.9.5
+rubygems_version: 1.8.23
 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