Add support for allowApostrophes

Author: wooorm

component.json

@@ -13,7 +13,7 @@
   "repository": "wooorm/nlcst-search",
   "dependencies": {
     "wooorm/nlcst-is-literal": "^1.0.0",
-    "wooorm/nlcst-normalize": "^1.0.0",
+    "wooorm/nlcst-normalize": "^1.1.0",
     "wooorm/unist-util-visit": "^1.0.0"
   },
   "scripts": [

index.js

@@ -44,8 +44,11 @@ var T_WHITE_SPACE = 'WhiteSpaceNode';
  * @param {Object|Array.<string>} phrases - Phrases to
  *   search for.  When `object`, searches for its keys.
  * @param {Function} handler - Handler.
+ * @param {boolean} allowApostrophes - Do not strip
+ *   apostrophes, normalize them.
  */
-function search(tree, phrases, handler) {
+function search(tree, phrases, handler, allowApostrophes) {
+    var apos = allowApostrophes;
     var byWord = {};
     var length;
     var index;
@@ -58,7 +61,7 @@ function search(tree, phrases, handler) {
      * @param {string} phrase - Phrase to search for.
      */
     function handlePhrase(phrase) {
-        firstWord = normalize(phrase.split(C_SPACE, 1)[0]);
+        firstWord = normalize(phrase.split(C_SPACE, 1)[0], apos);
 
         if (has.call(byWord, firstWord)) {
             byWord[firstWord].push(phrase);
@@ -143,7 +146,7 @@ function search(tree, phrases, handler) {
             if (
                 !node ||
                 node.type !== T_WORD ||
-                normalize(expression[index]) !== normalize(node)
+                normalize(expression[index], apos) !== normalize(node, apos)
             ) {
                 return null;
             }

package.json

@@ -21,7 +21,7 @@
   "author": "Titus Wormer <[email protected]> (http://wooorm.com)",
   "dependencies": {
     "nlcst-is-literal": "^1.0.0",
-    "nlcst-normalize": "^1.0.0",
+    "nlcst-normalize": "^1.1.0",
     "unist-util-visit": "^1.0.0"
   },
   "devDependencies": {

readme.md

@@ -63,7 +63,7 @@ search(tree, ['do blocklevel'], function (nodes) {
 
 ## API
 
-### `search(node, patterns, handler)`
+### `search(node, patterns, handler[, allowApostrophes])`
 
 Search for patterns in an NLCST tree.
 
@@ -83,7 +83,10 @@ Note that the algorithm ignores [literal][literal] words.
 *   `handler` ([`Function`][fn-handler])
     — Patterns to search for. If an `Object`, uses its keys.
     Each pattern is a space-delimited list of words, where each
-    word is normalized to remove casing, apostrophes, and dashes.
+    word is normalized to remove casing, apostrophes, and dashes;
+
+*   `allowApostrophes` (`boolean`, default: `false`)
+    — Do not strip apostrophes (but normalize them).
 
 **Throws**: `Error` — When not given `node` or `patterns`.
 

test.js

@@ -160,6 +160,19 @@ var tree = {
                     'value': 'this'
                 }
             ]
+        },
+        {
+            'type': 'WhiteSpaceNode',
+            'value': ' '
+        },
+        {
+            'type': 'WordNode',
+            'children': [
+                {
+                    'type': 'TextNode',
+                    'value': 'hell'
+                }
+            ]
         }
     ]
 };
@@ -169,7 +182,7 @@ var tree = {
  */
 
 test('search(tree, patterns, handle)', function (t) {
-    t.plan(39);
+    t.plan(40);
 
     t.throws(
         function () {
@@ -261,4 +274,8 @@ test('search(tree, patterns, handle)', function (t) {
         t.equal(parent, match[2], 'should pass the parent (phrases)');
         t.equal(phrase, match[3], 'should pass the phrase (phrases)');
     });
+
+    t.doesNotThrow(function () {
+        search(tree, ['he’ll'], null, true);
+    }, 'should not find non-apostrophe words when `allowApostrophes` is true');
 });