Chrononaut-no_fuzz 0.0.1 → 0.0.2

data/CHANGELOG

@@ -1 +1,2 @@
-v0.0.1 Test release
+v0.0.2. Basic normalization, bug fixes and documentation. First patch from a contributor - thanks sabman!
+v0.0.1. Test release.

data/Manifest

@@ -1,21 +1,20 @@
 Rakefile
 README.markdown
+no_fuzz.gemspec
 tasks/no_fuzz_tasks.rake
-uninstall.rb
 init.rb
-generators/no_fuzz/no_fuzz_generator.rb
-generators/no_fuzz/templates/model.rb
-generators/no_fuzz/templates/migration.rb
-generators/no_fuzz/USAGE
-rails/init.rb
-CHANGELOG
 lib/no_fuzz.rb
+generators/no_fuzz/USAGE
+generators/no_fuzz/templates/migration.rb
+generators/no_fuzz/templates/model.rb
+generators/no_fuzz/no_fuzz_generator.rb
 MIT-LICENSE
-no_fuzz.gemspec
 install.rb
 test/no_fuzz_test.rb
-test/test_helper.rb
 test/database.yml
 test/schema.rb
-test/test.sqlite3
+test/test_helper.rb
+rails/init.rb
+CHANGELOG
+uninstall.rb
 Manifest

data/README.markdown

@@ -1,21 +1,34 @@
-# NoFuzz
+# No Fuzz
+## Simple Rails-plugin that provides offline fuzzy-search for ActiveRecord
 
 Simple as can be fuzzy search. Works with any database supported by Active
-Record. No dependencies.
-
-Based on code and ideas in Steven Ruttenberg's nice blog entry "Live fuzzy
-search using n-grams in Rails" [1].
+Record. No dependencies. The notion of being offline means that it creates an
+index which the search algorithm leverages. Note that this index has to be
+updated to reflect changes in the database content. The plugin creates a
+separate database model for the index. This means that no changes will be made
+to your existing schema.
 
 Note that this family of fuzzy search techniques work best on dictionary-type
-lookups, i.e not for large amounts of text.
+lookups (names, words, etc).
+
+The plugin is based on code and ideas in Steven Ruttenberg's nice blog entry
+["Live fuzzy search using n-grams in Rails"](http://unirec.blogspot.com/2007/12/live-fuzzy-search-using-n-grams-in.html).
 
-kristian's acts_as_fuzzy_search [2] is a similar plugin, but it targets DataMapper.
+kristian's
+[acts_as_fuzzy_search](http://github.com/mkristian/kristians_rails_plugins/tree/master/act_as_fuzzy_search)
+is a similar plugin, but it targets DataMapper.
 
-1: http://unirec.blogspot.com/2007/12/live-fuzzy-search-using-n-grams-in.html
+## Installation and Setup
 
-2: http://github.com/mkristian/kristians_rails_plugins/tree/master/act_as_fuzzy_search
+    cd your_rails_project
+    script/plugin install git://github.com/Chrononaut/no_fuzz.git
+    # Now we create a trigram migration for the model we want to add fuzzy search to:
+    script/generate no_fuzz Model
+    rake db:migrate
 
-# Basic Usage
+(Note that the plugin is available as a gem as well - you don't have to use script/plugin)
+
+## Basic Usage
 
 Add the following code in the model you'd like to index:
 
@@ -31,4 +44,16 @@ search fuzzily with the fuzzy_find method:
     Model.fuzzy_find("query")
     Model.fuzzy_find("query", 10) # find maximum 10 rows
 
+A concrete example from a real app can look like this:
+
+    >> Contractor.fuzzy_find('johm')
+    => [#<Contractor id: 1, full_name: "John Doe", created_at: "2009-04-30 10:05:02", updated_at: "2009-04-30 10:05:02">]
+
+## Contributors
+
+The following people have submitted changes which have been applied to the core:
+
+* [Bjørn Arild Mæland](http://github.com/Chrononaut)
+* [Shoaib Burq](http://github.com/sabman)
+
 Copyright (c) 2009 Bjørn Arild Mæland, released under the MIT license

data/Rakefile

@@ -13,7 +13,7 @@ Echoe.new('no_fuzz') do |p|
   p.author = "Bjørn Arild Mæland"
   p.email = "bjorn.maeland@gmail.com"
   p.summary = "No Fuzz"
-  p.url = "http://www.github.com/Chrononaut/no_fuzz/"
+  p.url = "http://github.com/Chrononaut/no_fuzz"
   p.ignore_pattern = FileList[".gitignore"]
   p.include_rakefile = true
 end

data/generators/no_fuzz/no_fuzz_generator.rb

@@ -13,21 +13,20 @@ class NoFuzzGenerator < Rails::Generator::NamedBase
   end
 
   private
-  def local_custom_name
-    class_name.underscore.downcase
-  end
-
-  def gracefully_pluralize(str)
-    str.pluralize! if ActiveRecord::Base.pluralize_table_names
-    str
-  end
-
   def local_assigns
     returning(assigns = {}) do
-      assigns[:class_name] = local_custom_name.classify
+      assigns[:class_name] = class_name.underscore.downcase.classify
       assigns[:migration_class_name] = "CreateTrigramsTableFor#{assigns[:class_name]}"
-      assigns[:table_name] = gracefully_pluralize(local_custom_name + "_trigram")
+      assigns[:table_name] = gracefully_pluralize(class_name.underscore.downcase + "_trigram")
       assigns[:foreign_key] = (class_name.underscore.downcase + "_id")
     end
   end
 end
+
+module GeneratorHelpers
+  def gracefully_pluralize(str)
+    ActiveRecord::Base.pluralize_table_names ? str.pluralize : str
+  end
+end
+
+NoFuzzGenerator.send(:include, GeneratorHelpers)

data/generators/no_fuzz/templates/migration.rb

@@ -1,4 +1,4 @@
-class <%= migration_name -%> < ActiveRecord::Migration
+class <%= migration_class_name -%> < ActiveRecord::Migration
   def self.up
     create_table :<%= table_name -%>, :force => true do |t|
       t.integer :<%= foreign_key -%>, :null => false

data/lib/no_fuzz.rb

@@ -2,7 +2,6 @@
 # - scores
 #   I.e fuzzy {:first_name => 1, :last_name => 2}, last_name gives double score
 #   Currently everything gets scored with 1
-# - normalization
 # - weighting of fuzzy_find results
 
 module NoFuzz
@@ -18,7 +17,7 @@ module NoFuzz
     def fuzzy(*fields)
       # put the parameters as instance variable of the model
       @@model.instance_variable_set(:@fuzzy_fields, fields)
-      @@model.instance_variable_set(:@fuzzy_ref_id, "#{@@model}_id".downcase)
+      @@model.instance_variable_set(:@fuzzy_ref_id, "#{@@model.to_s.demodulize.underscore}_id")
       @@model.instance_variable_set(:@fuzzy_trigram_model, "#{@@model}Trigram".constantize)
     end
 
@@ -33,7 +32,8 @@ module NoFuzz
         self.all.each do |i|
           word = ' ' + i.send(f)
           (0..word.length-3).each do |idx|
-            tg = word[idx,3]
+            tg = word[idx,3].downcase # Force normalization by downcasing for
+                                      # now - should be overridable by the user
             trigram_model.create(:tg => tg, fuzzy_ref_id => i.id)
           end
         end

data/no_fuzz.gemspec

@@ -2,17 +2,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{no_fuzz}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bj\303\270rn Arild M\303\246land"]
-  s.date = %q{2009-03-30}
+  s.date = %q{2009-04-30}
   s.description = %q{No Fuzz}
   s.email = %q{bjorn.maeland@gmail.com}
-  s.extra_rdoc_files = ["README.markdown", "tasks/no_fuzz_tasks.rake", "CHANGELOG", "lib/no_fuzz.rb"]
-  s.files = ["Rakefile", "README.markdown", "tasks/no_fuzz_tasks.rake", "uninstall.rb", "init.rb", "generators/no_fuzz/no_fuzz_generator.rb", "generators/no_fuzz/templates/model.rb", "generators/no_fuzz/templates/migration.rb", "generators/no_fuzz/USAGE", "rails/init.rb", "CHANGELOG", "lib/no_fuzz.rb", "MIT-LICENSE", "install.rb", "test/no_fuzz_test.rb", "test/test_helper.rb", "test/database.yml", "test/schema.rb", "test/test.sqlite3", "Manifest", "no_fuzz.gemspec"]
+  s.extra_rdoc_files = ["README.markdown", "tasks/no_fuzz_tasks.rake", "lib/no_fuzz.rb", "CHANGELOG"]
+  s.files = ["Rakefile", "README.markdown", "no_fuzz.gemspec", "tasks/no_fuzz_tasks.rake", "init.rb", "lib/no_fuzz.rb", "generators/no_fuzz/USAGE", "generators/no_fuzz/templates/migration.rb", "generators/no_fuzz/templates/model.rb", "generators/no_fuzz/no_fuzz_generator.rb", "MIT-LICENSE", "install.rb", "test/no_fuzz_test.rb", "test/database.yml", "test/schema.rb", "test/test_helper.rb", "rails/init.rb", "CHANGELOG", "uninstall.rb", "Manifest"]
   s.has_rdoc = true
-  s.homepage = %q{http://www.github.com/Chrononaut/no_fuzz/}
+  s.homepage = %q{http://github.com/Chrononaut/no_fuzz}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "No_fuzz", "--main", "README.markdown"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{no_fuzz}
@@ -25,11 +25,8 @@ Gem::Specification.new do |s|
     s.specification_version = 2
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<echoe>, [">= 0"])
     else
-      s.add_dependency(%q<echoe>, [">= 0"])
     end
   else
-    s.add_dependency(%q<echoe>, [">= 0"])
   end
 end

data/test/no_fuzz_test.rb

@@ -1,18 +1,38 @@
 require File.dirname(__FILE__) + '/test_helper.rb'
+require 'rails_generator'
+require 'rails_generator/scripts/generate'
+require 'generators/no_fuzz/no_fuzz_generator'
 
 class NoFuzzTest < ActiveSupport::TestCase
 
   load_schema
 
-  class Package < ActiveRecord::Base
+  class PackageTrigram < ActiveRecord::Base
   end
 
-  class PackageTrigram < ActiveRecord::Base
+  class Package < ActiveRecord::Base
+    include NoFuzz
+
+    fuzzy :name
   end
 
-  def test_schema_has_loaded_correctly
-    assert_equal [], Package.all
-    assert_equal [], PackageTrigram.all
+  def test_populating_and_deleting_trigram_index
+    Package.create!(:name => "abcdef")
+    Package.populate_trigram_index
+    assert_equal 5, PackageTrigram.count
+    Package.clear_trigram_index
+    assert_equal 0, PackageTrigram.count
   end
 
 end
+
+class GeneratorHelpersTest < Test::Unit::TestCase
+  include GeneratorHelpers
+
+  def test_graceful_pluralization
+    ActiveRecord::Base.pluralize_table_names = false
+    assert_equal "chicken", gracefully_pluralize("chicken")
+    ActiveRecord::Base.pluralize_table_names = true
+    assert_equal "chickens", gracefully_pluralize("chicken")
+  end
+end

data/test/test_helper.rb

@@ -29,6 +29,6 @@ def load_schema
   end
 
   ActiveRecord::Base.establish_connection(config[db_adapter])
-  #load(File.dirname(__FILE__) + "/schema.rb")
+  load(File.dirname(__FILE__) + "/schema.rb")
   require File.dirname(__FILE__) + '/../rails/init.rb'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: Chrononaut-no_fuzz
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - "Bj\xC3\xB8rn Arild M\xC3\xA6land"
@@ -9,19 +9,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-30 00:00:00 -07:00
+date: 2009-04-30 00:00:00 -07:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: echoe
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
+dependencies: []
+
 description: No Fuzz
 email: bjorn.maeland@gmail.com
 executables: []
@@ -31,32 +22,31 @@ extensions: []
 extra_rdoc_files: 
 - README.markdown
 - tasks/no_fuzz_tasks.rake
-- CHANGELOG
 - lib/no_fuzz.rb
+- CHANGELOG
 files: 
 - Rakefile
 - README.markdown
+- no_fuzz.gemspec
 - tasks/no_fuzz_tasks.rake
-- uninstall.rb
 - init.rb
-- generators/no_fuzz/no_fuzz_generator.rb
-- generators/no_fuzz/templates/model.rb
-- generators/no_fuzz/templates/migration.rb
-- generators/no_fuzz/USAGE
-- rails/init.rb
-- CHANGELOG
 - lib/no_fuzz.rb
+- generators/no_fuzz/USAGE
+- generators/no_fuzz/templates/migration.rb
+- generators/no_fuzz/templates/model.rb
+- generators/no_fuzz/no_fuzz_generator.rb
 - MIT-LICENSE
 - install.rb
 - test/no_fuzz_test.rb
-- test/test_helper.rb
 - test/database.yml
 - test/schema.rb
-- test/test.sqlite3
+- test/test_helper.rb
+- rails/init.rb
+- CHANGELOG
+- uninstall.rb
 - Manifest
-- no_fuzz.gemspec
 has_rdoc: true
-homepage: http://www.github.com/Chrononaut/no_fuzz/
+homepage: http://github.com/Chrononaut/no_fuzz
 post_install_message: 
 rdoc_options: 
 - --line-numbers