acts_as_fuzzy_search 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in acts_as_fuzzy_search.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jordan Babe
+
+MIT License
+
+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.md

@@ -0,0 +1,41 @@
+# ActsAsFuzzySearch
+
+Return Activerecord records that match a search query. Ideally used for small sets of data and simple search terms.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'acts_as_fuzzy_search'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install acts_as_fuzzy_search
+
+## Usage
+
+		# app/models/foobar.rb
+		class Foobar < ActiveRecord::Base
+			acts_as_fuzzy_search
+			
+			# Or pass it some options:
+			# acts_as_fuzzy_search(:scope => :your_scope_name, :search_algorithm => :white_similarity)
+		end
+		
+		# Elsewhere in your code
+		Foobar.find_by_fuzzy_search 'smthing'
+		
+		# Or pass it some options
+		Foobar.find_by_fuzzy_search 'smthing', {:date_format => "%B %d %Y", :search_algorithm => :levenshtein_distance})
+		
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/acts_as_fuzzy_search.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/acts_as_fuzzy_search/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Jordan Babe"]
+  gem.email         = ["jorbabe@gmail.com"]
+  gem.description   = %q{ Return Activerecord records that match a search query. Ideally used for small sets of data and simple search terms.}
+  gem.summary       = %q{ AR find based on word matching }
+  gem.homepage      = "http://github.com/jbabe/acts_as_fuzzy_search"
+  
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "acts_as_fuzzy_search"
+  gem.require_paths = ["lib"]
+  gem.version       = ActsAsFuzzySearch::VERSION
+  
+  gem.add_dependency "text", "~> 1.0.0"
+  # gem.add_dependency "fuzzy-string-match", "~> 0.9.0" Drop this until we 
+
+  gem.add_development_dependency "minitest"
+end

data/lib/acts_as_fuzzy_search.rb

@@ -0,0 +1,8 @@
+require 'nokogiri'
+require 'text'
+require "acts_as_fuzzy_search/version"
+require "acts_as_fuzzy_search/fuzzy"
+
+module ActsAsFuzzySearch
+
+end

data/lib/acts_as_fuzzy_search/fuzzy.rb

@@ -0,0 +1,90 @@
+module ActsAsFuzzySearch
+  module Fuzzy
+
+    extend ActiveSupport::Concern
+ 
+    included do
+    end
+ 
+    module ClassMethods
+      
+      DEFAULT_ALGORITHM = :white_similarity
+      MATCH_SCORE = 0.8 # used by jarow-winkler and white-similarity
+      MIN_LEVENSHTEIN_DISTANCE = 3 # number of changes to get the strings to match
+      
+      DATE_FORMAT = "%B %d %Y"
+      SCOPE = "all"
+      
+      
+      
+      attr_accessor :config
+      
+      def acts_as_fuzzy_search(options = {})
+        @config = { :date_format => DATE_FORMAT,
+                    :scope => "all",
+                    :search_algorithm => DEFAULT_ALGORITHM,
+                    :jarow_score => MATCH_SCORE,
+                    :white_similarity_score => MATCH_SCORE,
+                    :min_levenshtein_distance => MIN_LEVENSHTEIN_DISTANCE,
+                    :debug => false }
+
+        @config.merge!(options)
+      end
+        
+      def find_by_fuzzy_search(search_term, options = {})
+        
+        @config.merge!(options)
+
+        search_term = search_term.strip.chomp
+        records = []
+
+        send(config[:scope]).each do |record|
+
+          attrs = record.attributes.values
+
+          # convert dates to ones humans will likely search on
+          attrs.collect! {|a| ([Date,Time,DateTime].include? a.class) ? a.strftime(config[:date_format]) : a }
+
+          # 'create' an html page
+          markup = Nokogiri::HTML(attrs.join(" "))
+
+          # strip all the tags and whitespace
+          no_tags = markup.text.gsub(/\s+|\n/, ' ')
+  
+          # Match each word in the document against each search term
+          no_tags.split(" ").each do |word|        
+             search_term.split(" ").each do |term|
+               records << record if matches?(term, word)
+             end
+           end
+        end
+        return records.uniq
+      end
+      
+      private
+      
+      def matches?(word1, word2)
+        # mostly for the regex - the other matches are probably smart enough
+        word1 = word1.downcase
+        word2 = word2.downcase
+        
+        case config[:search_algorithm]
+        when :jarow_winkler
+          # Drop for now cause we're using 1.8
+          raise "Jarow-Winkler not supported" #return FuzzyStringMatch::JaroWinkler.create(:native).getDistance(word1, word2) >= config[:jarow_score]
+        when :white_similarity
+          return Text::WhiteSimilarity.new.similarity(word1,word2) >= config[:white_similarity_score]
+        when :levenshtein_distance
+          return Text::Levenshtein.distance(word1,word2) <= config[:min_levenshtein_distance]
+        else
+          return word1.match(word2).present? # simple regex match
+        end
+
+      end
+
+      
+    end
+  end
+end
+ 
+ActiveRecord::Base.send :include, ActsAsFuzzySearch::Fuzzy

data/lib/acts_as_fuzzy_search/version.rb

@@ -0,0 +1,3 @@
+module ActsAsFuzzySearch
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_fuzzy_search
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jordan Babe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-16 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: text
+  requirement: &2160283960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2160283960
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &2160278160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2160278160
+description: ! ' Return Activerecord records that match a search query. Ideally used
+  for small sets of data and simple search terms.'
+email:
+- jorbabe@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- acts_as_fuzzy_search.gemspec
+- lib/acts_as_fuzzy_search.rb
+- lib/acts_as_fuzzy_search/fuzzy.rb
+- lib/acts_as_fuzzy_search/version.rb
+homepage: http://github.com/jbabe/acts_as_fuzzy_search
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.8
+signing_key: 
+specification_version: 3
+summary: AR find based on word matching
+test_files: []