text-compare-tools

Overview

Initially a javascript/coffeescript port of threedaymonk's text library, written in ruby. https://github.com/threedaymonk/text Currently has code for Soundex, Metaphone, Double Metaphone and Whitespace Similarity. Was developed as a smart package for the Meteor framework http://meteor.com

Usage

in your smart.json packages field add an entry for text tools

"text-compare-tools": {
	"git": "https://github.com/doubledare/text-compare-tools.git"
}

Then run:

mrt list

and make sure that 'text-compare-tools' is in the list.

Next run:

mrt add text-compare-tools

You can then run 'mrt list --using' to make sure you have the package.

Text Tools provides several methods to help with text comparison.

Soundex
Metaphone
Double Metaphone
White space similarity
With more to follow..

To use TEXT_TOOLS, put something similar to the following in your code:

TEXT_TOOLS.doubleMetaphone( "Rachel" );

And you will get back the primary and secondary results:

["RXL", RKL]

For many words you may get a null value for the secondary result.

Testing

This package was developed using the Meteorite command wrapper for Meteor. https://github.com/oortcloud/meteorite

Once you have Meteorite and Meteor installed then cd into this package and simply run

'mrt'

on the command line. This will run the test server on localhost on the default port 3000.

Open this in your favourite browser to see the tests run.

http://localhost:3000/

The tests will autorun if any files are changed.

License

Three Day Monk's library was specified 'same as ruby'

Unless there is a problem I am publishing this code under the MIT License., do whatever you want but with it at your own risk.. etc.