fuzzily_reloaded 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ccfb4a3ddebd786b36963599dc73afc65feac6968873c5895deccaa3c5dae044
+  data.tar.gz: f11961215c5c6937c006ac69d03f0b69f362eec24c2e5dd571bae2728dc402ea
+SHA512:
+  metadata.gz: 62d203f5c2d84624dbcdb98390eed6b042242b3017e34282289991ec26fd9602626ffc321f41e32260e73b78bdde9dc8bc53b6cbad03c9b6f566ea4fd1e47d51
+  data.tar.gz: a7ea210ef1db362b1d5abfca1191576d493b2f76f528ba3727eef8fd76f5d543939e476d3d470224796de33aa4244153c768ee4fa19fdeb475b484ff240a771f

data/.gitignore

@@ -0,0 +1,26 @@
+*.gem
+*.rbc
+.config
+.yardoc
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# CTags
+.tags*
+
+# Data
+*.gz
+*.bz2
+
+# Bundler
+.bundle
+vendor/bundle

data/.rspec

@@ -0,0 +1,3 @@
+--colour
+--format d
+--backtrace

data/.travis.yml

@@ -0,0 +1,39 @@
+---
+language: ruby
+services:
+  - mysql
+  - postgresql
+before_script:
+  - psql -c 'create database fuzzily_test;' -U postgres
+  - mysql -e 'create database fuzzily_test;'
+env:
+  - FUZZILY_ADAPTER=sqlite3
+  - FUZZILY_ADAPTER=mysql FUZZILY_DB_USER=travis
+  - FUZZILY_ADAPTER=postgresql FUZZILY_DB_USER=postgres
+script:
+  - bundle exec rspec
+rvm:
+  - 2.3.8
+  - 2.4.9
+  - 2.5.7
+  - 2.6.5
+  - 2.7.0
+  - ruby-head
+  - jruby-9.2.6.0
+  - jruby-head
+gemfile:
+  - gemfiles/rails51.gemfile
+  - gemfiles/rails60.gemfile
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+    - rvm: jruby-9.2.6.0
+  exclude:
+    - rvm: 2.3.8
+      gemfile: gemfiles/rails60.gemfile
+    - rvm: 2.4.9
+      gemfile: gemfiles/rails60.gemfile
+  fast_finish: true
+branches:
+  only: master

data/Gemfile

@@ -0,0 +1,4 @@
+source ENV.fetch("GEM_SOURCE", "https://rubygems.org")
+
+# Specify your gem's dependencies in fuzzily.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,61 @@
+PATH
+  remote: .
+  specs:
+    fuzzily_reloaded (1.0.0)
+      activerecord (>= 5.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.2.2)
+      activesupport (= 6.0.2.2)
+    activerecord (6.0.2.2)
+      activemodel (= 6.0.2.2)
+      activesupport (= 6.0.2.2)
+    activesupport (6.0.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.3)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.0)
+    mysql2 (0.5.3)
+    pg (1.2.3)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    sqlite3 (1.4.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.6)
+      thread_safe (~> 0.1)
+    zeitwerk (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  fuzzily_reloaded!
+  mysql2
+  pg
+  rake
+  rspec
+  sqlite3
+
+BUNDLED WITH
+   2.1.2

data/LICENSE.txt

@@ -0,0 +1,23 @@
+Copyright (c) 2020, Sven Pachnit aka. 2called-chaos (forked)
+Copyright (c) 2012, HouseTrip Ltd
+
+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,221 @@
+# Fuzzily - fuzzy string matching for ActiveRecord
+
+[![Gem Version](https://badge.fury.io/rb/fuzzily_reloaded.png)](https://badge.fury.io/rb/fuzzily_reloaded)
+[![Build Status](https://travis-ci.org/2called-chaos/fuzzily.png?branch=master)](https://travis-ci.org/2called-chaos/fuzzily)
+
+> Show me photos of **Marakech** !
+>
+> Here aresome photos of **Marrakesh**, Morroco.
+> Did you mean **Martanesh**, Albania, **Marakkanam**, India, or **Marasheshty**, Romania?
+
+Fuzzily finds misspelled, prefix, or partial needles in a haystack of
+strings. It's 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).
+
+Tested with ActiveRecord (5.1, 6.0) on various Rubies (2.3, 2.4, 2.5, 2.6, 2.7) and the most common adapters (SQLite3, MySQL, and PostgreSQL).
+
+If your dateset is big, if you need yet more speed, or do not use ActiveRecord,
+check out [blurrily](http://github.com/mezis/blurrily), another gem (backed with a C extension)
+with the same intent.
+
+## Fork differences
+
+- Added support for Rails 5.1 and 6.0
+- Removed support for Rails <5.1
+
+### Breaking changes
+
+- Dirty attributes behaviour has changed in after_save context.
+  Use `saved_change_to_ATTR?` instead of `ATTR_changed?`!
+- Semi-breaking: The string is now being checked for `blank?` instead of `nil?` to prevent `***` ngrams
+
+### Fixes
+
+- Numbers are now supported but using a Converter is recommended
+- Fixed deprecation warning regarding uniqueness validator
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fuzzily_reloaded'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fuzzily_reloaded
+
+## Usage
+
+You'll need to setup 2 things:
+
+- a trigram model (your search index) and its migration
+- the model you want to search for
+
+Create an ActiveRecord model in your app (this will be used to store a "fuzzy index" of all the models and fields you will be indexing):
+
+```ruby
+class Trigram < ActiveRecord::Base
+  include Fuzzily::Model
+end
+```
+
+Create a migration for it:
+
+```ruby
+class AddTrigramsModel < ActiveRecord::Migration[6.0]
+  extend Fuzzily::Migration
+end
+```
+
+Instrument your model:
+
+```ruby
+class MyStuff < ActiveRecord::Base
+  # assuming my_stuffs has a 'name' attribute
+  fuzzily_searchable :name
+end
+```
+
+*Note: The `name` part in the following method calls refers to the `:name` field. Replace it to match your searchable attribute.*
+
+Index your model (will happen automatically for new/updated records):
+
+```ruby
+MyStuff.bulk_update_fuzzy_name
+```
+
+Search!
+
+```ruby
+MyStuff.find_by_fuzzy_name('Some Name', :limit => 10)
+# => records
+```
+
+You can force an update on a specific record with
+
+```ruby
+MyStuff.find(123).update_fuzzy_name!
+```
+
+## Handling numbers
+
+Numbers `\d` are supported but it is recommended to evaluate a custom conversion.
+We had way better results for product names that included both, arabic and roman numbers,
+with the following converter (note that both the search input and fuzzily input are converted):
+
+https://gist.github.com/2called-chaos/64f64fc7fb35959fbf68f6018494a698
+
+## Indexing more than one field
+
+Just list all the field you want to index, or call `fuzzily_searchable` more than once:
+
+```ruby
+class MyStuff < ActiveRecord::Base
+  fuzzily_searchable :name_fr, :name_en
+  fuzzily_searchable :name_de
+end
+```
+
+## Custom name for the index model
+
+If you want or need to name your index model differently (e.g. because you already have a class called `Trigram`):
+
+```ruby
+class CustomTrigram < ActiveRecord::Base
+  include Fuzzily::Model
+end
+
+class AddTrigramsModel < ActiveRecord::Migration
+  extend Fuzzily::Migration
+  self.trigrams_table_name = :custom_trigrams
+end
+
+class MyStuff < ActiveRecord::Base
+  fuzzily_searchable :name, class_name: 'CustomTrigram'
+end
+```
+
+## Speeding things up
+
+For large data sets (millions of rows to index), the "compatible" storage
+used by default will typically no longer be enough to keep the index small
+enough.
+
+Users have reported **major improvements** (2 order of magnitude) when turning
+the `owner_type` and `fuzzy_field` columns of the `trigrams` table from
+`VARCHAR` (the default) into `ENUM`. This is particularly efficient with
+MySQL and pgSQL.
+
+This is not the default in the gem as ActiveRecord does not suport `ENUM`
+columns in any version.
+
+## UUID's
+
+When using Rails 4 with UUID's, you will need to change the `owner_id` column type to `UUID`.
+
+```ruby
+class AddTrigramsModel < ActiveRecord::Migration
+  extend Fuzzily::Migration
+  trigrams_owner_id_column_type = :uuid
+end
+```
+
+## Model primary key (id) is VARCHAR
+
+If you set your Model primary key (id) AS `VARCHAR` instead of `INT`, you will need to change the `owner_id` column type from `INT` to `VARCHAR` in the trigrams table.
+
+## Searching virtual attributes
+
+Your searchable fields do not have to be stored, they can be dynamic methods
+too. Just remember to add a virtual change method as well.
+For instance, if you model has `first_name` and `last_name` attributes, and you
+want to index a compound `name` dynamic attribute:
+
+```ruby
+class Employee < ActiveRecord::Base
+  fuzzily_searchable :name
+  def name
+    "#{first_name} #{last_name}"
+  end
+
+  def saved_change_to_name?
+    saved_change_to_first_name? || saved_change_to_last_name?
+  end
+end
+```
+
+## Update Trigram index using `sidekiq-delay`
+
+For larger text, it takes time to build the index. Thus it can be moved into delay task using `sidekiq` + `sidekiq-delay` or `delayed_job` gem, both of them provide the method `delay` to move the execution to background thread by adding option `async`:
+
+```ruby
+class Employee < ActiveRecord::Base
+  fuzzily_searchable :name, async: true
+
+end
+```
+
+## License
+
+MIT licence. Quite permissive if you ask me.
+
+Copyright (c) 2013, HouseTrip Ltd.
+Copyright (c) 2020, Sven Pachnit aka. 2called-chaos (forked)
+
+## Contributing
+
+1. Fork it
+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
+
+
+Thanks to @mezis for creating this literal gem.
+Thanks to @bclennox, @fdegiuli, @nickbender, @Shanison, @rickbutton for pointing out
+and/or helping on various issues.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/fuzzily.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "fuzzily/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "fuzzily_reloaded"
+  spec.version       = Fuzzily::VERSION
+  spec.authors       = ["Julien Letessier", "Sven Pachnit"]
+  spec.email         = ["julien.letessier@gmail.com", "sven@bmonkeys.net"]
+  spec.description   = %q{Fast fuzzy string matching for rails}
+  spec.summary       = %q{A fast, trigram-based, database-backed fuzzy string search/match engine for Rails.}
+  spec.homepage      = "http://github.com/2called-chaos/fuzzily"
+  spec.license       = "MIT"
+
+  spec.add_runtime_dependency "activerecord", ">= 5.1"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "pg"
+  spec.add_development_dependency "mysql2"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+end

data/gemfiles/rails51.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "activerecord", "~> 5.1.0"
+
+gemspec path: "../"

data/gemfiles/rails60.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "activerecord", "~> 6.0.0"
+
+gemspec path: "../"