Merge pull request #39 from aceakash/3.0.1-rc

3.0.1 rc

Author: aceakash

README.md

@@ -18,6 +18,7 @@ Finds degree of similarity between two strings, based on [Dice's Coefficient](ht
 * [Release Notes](#release-notes)
     * [2.0.0](#200)
     * [3.0.0](#300)
+    * [3.0.1](#301)
 
 
 ## Usage
@@ -119,6 +120,9 @@ stringSimilarity.findBestMatch('Olive-green table for sale, in extremely good co
 * The algorithm has been tweaked slightly to disregard spaces and word boundaries. This will change the rating values slightly but not enough to make a significant difference
 * Adding a `bestMatchIndex` to the results for `findBestMatch(..)` to point to the best match in the supplied `targetStrings` array
 
+### 3.0.1
+* Refactoring: removed unused functions; used `substring` instead of `substr`
+* Updated dependencies
 
 ![Build status](https://codeship.com/projects/2aa453d0-0959-0134-8a76-4abcb29fe9b4/status?branch=master)
 [![Known Vulnerabilities](https://snyk.io/test/github/aceakash/string-similarity/badge.svg)](https://snyk.io/test/github/aceakash/string-similarity)

compare-strings.js

@@ -15,7 +15,7 @@ function compareTwoStrings(first, second) {
 
 	let firstBigrams = new Map();
 	for (let i = 0; i < first.length - 1; i++) {
-		const bigram = first.substr(i, 2);
+		const bigram = first.substring(i, i + 2);
 		const count = firstBigrams.has(bigram)
 			? firstBigrams.get(bigram) + 1
 			: 1;
@@ -25,7 +25,7 @@ function compareTwoStrings(first, second) {
 
 	let intersectionSize = 0;
 	for (let i = 0; i < second.length - 1; i++) {
-		const bigram = second.substr(i, 2);
+		const bigram = second.substring(i, i + 2);
 		const count = firstBigrams.has(bigram)
 			? firstBigrams.get(bigram)
 			: 0;
@@ -60,25 +60,10 @@ function findBestMatch(mainString, targetStrings) {
 	return { ratings, bestMatch, bestMatchIndex };
 }
 
-function flattenDeep(arr) {
-	return Array.isArray(arr) ? arr.reduce((a, b) => a.concat(flattenDeep(b)), []) : [arr];
-}
-
 function areArgsValid(mainString, targetStrings) {
 	if (typeof mainString !== 'string') return false;
 	if (!Array.isArray(targetStrings)) return false;
 	if (!targetStrings.length) return false;
 	if (targetStrings.find(s => typeof s !== 'string')) return false;
 	return true;
 }
-
-function letterPairs(str) {
-	const pairs = [];
-	for (let i = 0, max = str.length - 1; i < max; i++) pairs[i] = str.substring(i, i + 2);
-	return pairs;
-}
-
-function wordLetterPairs(str) {
-	const pairs = str.toUpperCase().split(' ').map(letterPairs);
-	return flattenDeep(pairs);
-}

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "string-similarity",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "Finds degree of similarity between strings, based on Dice's Coefficient, which is mostly better than Levenshtein distance.",
   "main": "compare-strings.js",
   "scripts": {
@@ -29,6 +29,6 @@
   "author": "Akash Kurdekar <[email protected]> (http://untilfalse.com/)",
   "license": "ISC",
   "devDependencies": {
-    "jasmine": "^3.3.0"
+    "jasmine": "^3.4.0"
   }
 }