fuzzy_record 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a99f00e5952ab300334f7484bdfdaca35aab18c9
+  data.tar.gz: da59bc75ff14e06de1b1564f79a3cd65acf887aa
+SHA512:
+  metadata.gz: 50d161e9909a4d16b9bc4a138c0512f932bf9e9c9a98c8b41d98d8aa3db303c08183bdc04db2ca85a07f4f9b5f612206f3c3016e93d0773124c6d70b787d5787
+  data.tar.gz: e8c3ef7214bf2c9f5a303c77b555f11756ca299def56ef5c24ea7f30eb98843c71b50e54bc7130028ccb4996b88bfeb76eb765779464ceb9a42b838aea54e635

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Chris Moody
+
+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,60 @@
+# FuzzyRecord
+
+FuzzyRecord searches through active records using fuzzy matchers and orders them based on FuzzyString.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fuzzy_record'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fuzzy_record
+
+## Usage
+
+To use for any active record model:
+
+```ruby
+    $ Model.fuzzy_search('string')
+```
+
+It will search through your model for records where the first of these that exists
+(:fuzzy_name, :ident, :name) fuzzy_matches and order it by best match
+
+Alternatively you can use a hash where the field to be searched is the key:
+
+```ruby
+    $ Model.fuzzy_search(title: 'string')
+```
+
+To make this the default behavior for your model simply add the definition:
+
+```ruby
+    $ def self.fuzzy_search(str) super(title: str) end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/fuzzy_record/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+Author
+-------
+
+* Chris Moody
+
+License
+-------
+
+This is free software released into the public domain.

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = "test/*_test.rb"
+end
+

data/fuzzy_record.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fuzzy_record/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fuzzy_record"
+  spec.version       = FuzzyRecord::VERSION
+  spec.authors       = ["Chris Moody"]
+  spec.email         = ["cmoody@transcon.com"]
+  spec.summary       = %q{Active Record fuzzy search}
+  spec.homepage      = "https://github.com/transcon/fuzzy_record"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "fuzzy_string"
+  spec.add_dependency "rails"
+  
+  spec.add_development_dependency "flying_table"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'awesome_print'
+  spec.add_development_dependency 'minitest-reporters',  '>= 1.0.1'
+  spec.add_development_dependency 'sqlite3'
+end

data/lib/fuzzy_record/fuzzy_searcher.rb

@@ -0,0 +1,24 @@
+class FuzzyRecord::FuzzySearcher
+  def self.find(klass,args) new(klass,args).find end
+  def initialize(klass,args)
+    @class  = klass
+    @args   = args
+    @search = create_search
+  end
+  def find
+    @class.all.select{ |record| include_record(record)}.sort_by{|record| sorter(record)}
+  end
+  private
+  def generalize(str) ".*#{str.gsub(/[^a-zA-Z&0-9]/, "").chars.to_a.join(".*")}.*" end
+  def ave(arry) arry.sum.to_f / arry.length end
+  def matches?(record,k,v) !!(record.send(k) =~ /#{generalize(v)}/i) end
+  def sorter(record) ave(@search.map{|k,v| record.send(k) ^ v}) end
+  def include_record(record) @search.map{|k,v| matches?(record,k,v)}.inject(:&) end
+
+  def create_search
+    return @args if @args.is_a? Hash
+    [:fuzzy_name, :ident, :name].each do |field|
+      return {field => @args} if @class.instance_methods.include?(field)
+    end
+  end
+end

data/lib/fuzzy_record/version.rb

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

data/lib/fuzzy_record.rb

@@ -0,0 +1,12 @@
+require "fuzzy_record/version"
+require "fuzzy_record/fuzzy_searcher"
+require "active_record"
+require "fuzzy_string"
+module FuzzyRecord
+  extend ActiveSupport::Concern
+  module ClassMethods
+    def fuzzy_search(args) FuzzySearcher.find(self,args) end
+  end
+end
+ActiveRecord::Base.include(FuzzyRecord)
+

data/test/fuzzy_record_test.rb

@@ -0,0 +1,53 @@
+require "test_helper"
+class FuzzyRecordTest < TestCase
+  def test_search_responds_to_name
+    FlyingTable.create(test_tables: {name: :string, title: :string})
+    first  = TestTable.create(name: 'A very long string')
+    second = TestTable.create(name: 'A very longer string')
+    search = TestTable.fuzzy_search('a very long')
+    assert_equal 2, search.count
+    assert_equal first, search.first
+    FlyingTable.destroy(:test_tables)
+  end
+
+  def test_search_responds_to_ident
+    FlyingTable.create(ident_test_tables: {ident: :string, name: :string, title: :string})
+    first  = IdentTestTable.create(name: 'A very long string',   ident: 'a longer string')
+    second = IdentTestTable.create(name: 'A very longer string', ident: 'a long string')
+    search = IdentTestTable.fuzzy_search('a long string')
+    assert_equal 2, search.count
+    assert_equal second, search.first
+    FlyingTable.destroy(:ident_test_tables)
+  end
+
+  def test_search_responds_to_fuzzy_name
+    FlyingTable.create(fuzzy_test_tables: {fuzzy_name: :string, ident: :string, name: :string,title: :string})
+    first  = FuzzyTestTable.create(ident: 'a longer string', fuzzy_name: 'a string')
+    second = FuzzyTestTable.create(ident: 'a long string',   fuzzy_name: 'a stringer')
+    search = FuzzyTestTable.fuzzy_search('a string')
+    assert_equal 2, search.count
+    assert_equal first, search.first
+    FlyingTable.destroy(:fuzzy_test_tables)
+  end
+
+  def test_search_responds_to_any_name
+    FlyingTable.create(any_name_test_tables: {fuzzy_name: :string, ident: :string, name: :string,title: :string})
+    first  = AnyNameTestTable.create(ident: 'a longer string', title: 'a string')
+    second = AnyNameTestTable.create(ident: 'a long string',   title: 'a stringer')
+    search = AnyNameTestTable.fuzzy_search(title: 'a string')
+    assert_equal 2, search.count
+    assert_equal first, search.first
+    FlyingTable.destroy(:any_name_test_tables)
+  end
+
+  def test_search_responds_to_multiple_name
+    FlyingTable.create(multiple_name_test_tables: {fuzzy_name: :string, ident: :string, name: :string,title: :string})
+    first  = MultipleNameTestTable.create(ident: 'a long string',   title: 'a string')
+    second = MultipleNameTestTable.create(ident: 'a longer string', title: 'a stringer')
+    search = MultipleNameTestTable.fuzzy_search(title: 'a string', ident: 'a longer string')
+    assert_equal 1, search.count
+    assert_equal second, search.first
+    FlyingTable.destroy(:multiple_name_test_tables)
+  end
+end
+  

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+require 'minitest/autorun'
+require 'fuzzy_record'
+require 'minitest/reporters'
+require 'flying_table'
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new
+    
+
+class TestCase < MiniTest::Test
+end

metadata

@@ -0,0 +1,183 @@
+--- !ruby/object:Gem::Specification
+name: fuzzy_record
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Chris Moody
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fuzzy_string
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: flying_table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- cmoody@transcon.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fuzzy_record.gemspec
+- lib/fuzzy_record.rb
+- lib/fuzzy_record/fuzzy_searcher.rb
+- lib/fuzzy_record/version.rb
+- test/fuzzy_record_test.rb
+- test/test_helper.rb
+homepage: https://github.com/transcon/fuzzy_record
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Active Record fuzzy search
+test_files:
+- test/fuzzy_record_test.rb
+- test/test_helper.rb