pg_scope_by_soundex 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Alejandro Juarez
+
+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.

data/README.rdoc

@@ -0,0 +1,48 @@
+= Description
+
+The pg_scope_by_soundex gem provides a simple interface to use the set of functions of contrib/fuzzystringmatching for PostgreSQL.
+
+== How to install It
+
+Edit your Gemfile and insert the next line:
+
+  gem "pg_scope_by_soundex"
+
+Then use the bundler to install It:
+
+  $ bundle install
+
+Add the next line into your file config/initializers/my_gems.rb:
+
+  require 'pg_scope_by_soundex'
+
+Then execute the rails migration generator:
+
+   $ ./script/rails generate pg_scope_by_soundex_install
+
+And finally run the rails migrations to add the functions for PostgreSQL:
+
+  $ rake db:migrate
+
+== How to use It
+
+  # scope_by_soundex_matcher
+
+  class Person < ActiveRecord::Base
+      scope_by_soundex_matcher :find_by_fullname, :fields => [:firstname, :lastname]
+  end
+
+  Person.find_by_fullname 'Alejandro' => Returns a collection of active_record objects
+
+
+  # scope_by_difference_matcher
+
+  class Person < ActiveRecord::Base
+      scope_by_difference_matcher :find_by_fullname, :fields => [:firstname, :lastname]
+  end
+
+  Person.find_by_fullname 'Alejandro' => Returns a collection of active_record objects
+ 
+== Copyright
+
+Copyright (c) 2010 Alejandro Juarez. See LICENSE for details.

data/init.rb

@@ -0,0 +1 @@
+require 'pg_scope_by_soundex'

data/lib/generators/pg_scope_by_soundex_install/USAGE

@@ -0,0 +1,3 @@
+To copy the PgScopeBySoundex migration to your Rails App, just do:
+
+    rails generate pg_scope_by_soundex_install

data/lib/generators/pg_scope_by_soundex_install/pg_scope_by_soundex_install_generator.rb

@@ -0,0 +1,18 @@
+require 'rails/generators/migration'
+class PgScopeBySoundexInstallGenerator < Rails::Generators::Base  
+  include Rails::Generators::Migration
+  
+  desc "Generates a migration file to add Fuzzy String Matching functions to your PostgreSQL database."
+  
+  def self.source_root
+    @_source_root = File.expand_path('../templates', __FILE__)
+  end
+
+  def self.next_migration_number(path)
+    Time.now.utc.strftime("%Y%m%d%H%M%S")
+  end
+
+  def copy_migration_template
+    migration_template  "migration.rb", "db/migrate/add_pg_scope_by_soundex"
+  end
+end

data/lib/generators/pg_scope_by_soundex_install/templates/migration.rb

@@ -0,0 +1,42 @@
+class AddPgScopeBySoundexMatcher < ActiveRecord::Migration
+  
+  def self.up
+    execute "SET search_path = public;"
+
+    execute "CREATE OR REPLACE FUNCTION levenshtein (text,text) RETURNS int AS '$libdir/fuzzystrmatch','levenshtein'  LANGUAGE C IMMUTABLE STRICT;"
+
+    execute "CREATE OR REPLACE FUNCTION levenshtein (text,text,int,int,int) RETURNS int AS '$libdir/fuzzystrmatch','levenshtein_with_costs' LANGUAGE C IMMUTABLE STRICT;"
+
+    execute "CREATE OR REPLACE FUNCTION metaphone (text,int) RETURNS text AS '$libdir/fuzzystrmatch','metaphone'LANGUAGE C IMMUTABLE STRICT;"
+
+    execute "CREATE OR REPLACE FUNCTION soundex(text) RETURNS text AS '$libdir/fuzzystrmatch', 'soundex' LANGUAGE C IMMUTABLE STRICT;"
+
+    execute "CREATE OR REPLACE FUNCTION text_soundex(text) RETURNS text AS '$libdir/fuzzystrmatch', 'soundex' LANGUAGE C IMMUTABLE STRICT;"
+
+    execute "CREATE OR REPLACE FUNCTION difference(text,text) RETURNS int AS '$libdir/fuzzystrmatch', 'difference' LANGUAGE C IMMUTABLE STRICT;"
+
+    execute "CREATE OR REPLACE FUNCTION dmetaphone (text) RETURNS text AS '$libdir/fuzzystrmatch', 'dmetaphone' LANGUAGE C IMMUTABLE STRICT;"
+
+    execute "CREATE OR REPLACE FUNCTION dmetaphone_alt (text) RETURNS text AS '$libdir/fuzzystrmatch', 'dmetaphone_alt' LANGUAGE C IMMUTABLE STRICT;"
+  end
+  
+  def self.down
+    execute "SET search_path = public;"
+
+    execute "DROP FUNCTION dmetaphone_alt (text);"
+
+    execute "DROP FUNCTION dmetaphone (text);"
+
+    execute "DROP FUNCTION difference(text,text);"
+
+    execute "DROP FUNCTION text_soundex(text);"
+
+    execute "DROP FUNCTION soundex(text);"
+
+    execute "DROP FUNCTION metaphone (text,int);"
+
+    execute "DROP FUNCTION levenshtein (text,text,int,int,int);"
+
+    execute "DROP FUNCTION levenshtein (text,text);"
+  end
+end

data/lib/pg_scope_by_soundex.rb

@@ -0,0 +1,12 @@
+module PgScopeBySoundex
+  def enable_activerecord
+    return if ActiveRecord::Base.respond_to? :scope_by_soundex_matcher and ActiveRecord::Base.respond_to? :scope_by_difference_matcher
+    require 'pg_scope_by_soundex/named_scope'
+    ::ActiveRecord::Base.send :include, PgScopeBySoundex::NamedScope
+  end
+end
+   
+if defined? Rails
+  include PgScopeBySoundex
+  PgScopeBySoundex.enable_activerecord if defined? ActiveRecord
+end

data/lib/pg_scope_by_soundex/named_scope.rb

@@ -0,0 +1,50 @@
+module PgScopeBySoundex
+  module NamedScope
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+
+      # scope_by_soundex_matcher
+      #
+      # Example:
+      # class Person < ActiveRecord::Base
+      #     scope_by_soundex_matcher find_by_fullname, :fields => [:firstname, :lastname]
+      # end
+      # Person.find_by_fullname 'Alejandro'
+      def scope_by_soundex_matcher(method_name, options={})
+        class_eval do
+          sql = options[:fields].collect { |field| "soundex(#{field}) = soundex(:q)"}.join(' OR ')
+          scope method_name.to_sym, lambda {|string| where(sql, :q => string) }
+        end
+      end
+
+      # scope_by_difference_matcher
+      #
+      # Example:
+      # class Person < ActiveRecord::Base
+      #     scope_by_difference_matcher find_by_fullname, :fields => [:firstname, :lastname]
+      #       OR
+      #     scope_by_difference_matcher find_by_fullname, :fields => [:firstname, :lastname], :position => 4, :operator => '>'
+      #       OR
+      #     scope_by_difference_matcher find_by_fullname, :by_sql => 'difference(firstname, :q)  > 3 OR difference(:lastname, :q) > 4"
+      # end
+      # Person.find_by_fullname 'Alejandro'
+      def scope_by_difference_matcher(method_name, options={})
+        class_eval do
+          if options[:by_sql].nil?
+            options[:position] ||= 3
+            options[:operator] = '>'
+            sql = options[:fields].collect { |field|"difference(#{field}, :q) #{options[:operator]} #{options[:position]}" }.join(' OR ')
+          else
+            sql = options[:by_sql]
+          end
+          scope method_name.to_sym, lambda {|string| where(sql, :q => string) }
+        end
+      end
+
+      # TODO: The following PostgreSQL functions are not implemented: dmetaphone_alt, dmetaphone, text_soundex, metaphone and levenshtein.
+    end
+  end
+end

data/spec/pg_scope_by_soundex_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "PgScopeBySoundex" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'fuzzy_string_matcher'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: pg_scope_by_soundex
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Alejandro Juarez
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-01 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: The pg_scope_by_soundex gem uses the set of functions of contrib/fuzzystringmatching for PostgreSQL.
+email: alex@monsterlabs.com.mx
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- init.rb
+- lib/generators/pg_scope_by_soundex_install/USAGE
+- lib/generators/pg_scope_by_soundex_install/pg_scope_by_soundex_install_generator.rb
+- lib/generators/pg_scope_by_soundex_install/templates/migration.rb
+- lib/pg_scope_by_soundex.rb
+- lib/pg_scope_by_soundex/named_scope.rb
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/alecz/pg_scope_by_soundex
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: This gem provides the soundex and difference postgresql functions to determine similarities and distance between strings
+test_files: 
+- spec/pg_scope_by_soundex_spec.rb
+- spec/spec_helper.rb