https://github.com/jfairbank/whitesimilarity
Ruby gem implementation of the White Similarity Algorithm
https://github.com/jfairbank/whitesimilarity
Last synced: 3 months ago
JSON representation
Ruby gem implementation of the White Similarity Algorithm
- Host: GitHub
- URL: https://github.com/jfairbank/whitesimilarity
- Owner: jfairbank
- License: mit
- Created: 2014-01-14T16:56:57.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2014-03-02T23:51:41.000Z (over 11 years ago)
- Last Synced: 2024-11-16T05:43:21.105Z (11 months ago)
- Language: C
- Size: 204 KB
- Stars: 12
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# WhiteSimilarity
WhiteSimilarity is a Ruby gem that implements the White String Similarity Algorithm for computing the similarity between two strings. The algorithm was introduced by Simon White [here](http://www.catalysoft.com/articles/StrikeAMatch.html).
For this gem, the actual algorithm is implemented in C and maintained at [jfairbank/c_white_algorithm](https://github.com/jfairbank/c_white_similarity).
## Installation
Add this line to your application's Gemfile:
gem 'whitesimilarity'
And then execute:
$ bundle
Or install it yourself as:
$ gem install whitesimilarity
## Usage
The only method is `WhiteSimilarity.similarity` which takes two strings to compare.
```ruby
WhiteSimilarity.similarity('foo', 'bar') # 0.0
WhiteSimilarity.similarity('dog', 'doge') # 0.8
WhiteSimilarity.similarity('dog', 'DOGE') # 0.8 - Case insensitive
WhiteSimilarity.similarity('foo', 'for') # 0.5
```
A common use case for the similarity algorithm is to find the best matching string for another given string.
```ruby
class Choices < Array
def best_match_to(a_string)
self.sort do |a, b|
WhiteSimilarity.similarity(a_string, b) <=> WhiteSimilarity.similarity(a_string, a)
end.first
end
end
c = Choices.new %w(foo bar quux hello world)
puts c.best_match_to 'help' #=> 'hello'
```
## Contributing
To contribute to the algorithm implementation, please fork [jfairbank/c_white_algorithm](https://github.com/jfairbank/c_white_similarity) instead of this repo
1. Fork jfairbank/c_white_algorithm
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 new Pull Request