Skip to content

Latest commit

 

History

History
111 lines (75 loc) · 4.03 KB

README.md

File metadata and controls

111 lines (75 loc) · 4.03 KB
Raw

#SoundCord

Build Status Code Climate

Make comparisons of phonetically similar terms easier.

SoundCord matches two different words with similar pronunciation to the same code, which allows phonetic similarity based word set comparison and indexing.

Often it is quite difficult to find atypical name (or surname) in your records, for example:

— Hey, John, look for Adolf Schwarzenegger. — Adolf Shwardseneger? There is no such person!

In this case, the use of SoundCord (especially in combination with fuzzy matching algorithms) can significantly simplify the problem.

##Installation Install it through terminal:

gem install soundcord

Or, if you want to get the latest, you can get master from the main SoundCord repository:

gem "soundcord", :git => "[email protected]:lukelex/soundcord.git"

If you`are trying to use features that don't seem to be in the latest released gem, but are mentioned in the README, then you probably need to specify the master branch if you want to use them. This README is probably ahead of the latest released version, if you're reading it on GitHub.

###Rails integration To easily integrate SoundCord with rails, please visit: http://lukelex.github.com/soundcord_rails

##Usage Words can be phonetically transformed:

"João".to_sound # "J"
"Maria".to_sound # "MR"
"Helena".to_sound # "LM"
"Walmir".to_sound # "VLM"

"gnome".to_sound # "NM"
"pneumonic".to_sound # "NMNK"
"theater".to_sound # "0TR"
"crutch".to_sound # "KRX"

And also, compared:

"Walmir".homophone? "Valmir" # true
"Courtiney".homophone? "kourtiney" # true

Array's can be searched for homonyms:

collection = ["leonardo", "lucene", "rodrigo", "luciana", "lussene"]
collection.homophones "lucene" # ["lucene", "luciana", "lussene"]

collection = ["mail", "male", "main", "Maine", "mane"]
collection.homophones "main" # ["main", "Maine", "mane"]

##Setting language The language, to be used in comparisons, can be defined through the following lines:

SoundCord.load_language "pt-BR"
SoundCord.load_language "en"

If no language is defined SoundCord will fallback to its default, pt-BR.

##Information

###Language support SoundCord was idealized to support a wide range of languages. Currently, we are supporting these:

  • Brazilian Portuguese;
  • English.

We are already working on supporting these:

  • Spanish.

##How to contribute Please ensure that you provide appropriate test coverage and ensure the documentation is up-to-date. It is encouraged that you perform changes in a clean topic branch rather than a master and that you create a pull request for them. This will facilitate discussion and revision.

Please be clean, keep your commits atomic and with the smallest possible logical change. This will increase the likelihood of your submission to be used.

###Bug reports If you discover any bugs, feel free to create an issue on GitHub. Please add as much information as possible to help us fixing the possible bug.

https://github.com/lukelex/soundcord/issues

##License Copyright (c) 2012 Lukas Alexandre. http://codelogic.me/

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to use, copy and modify copies of the Software, 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.