Use relevant search in step docs

lib/tools.js

@@ -11,12 +11,18 @@ var util = require("util");
 require("colors");
 var _ = require("lodash");
 var highlight = require("cli-highlight").highlight;
+var natural = require("natural");
 var U = require("glace-utils");
 
 var d = U.switchColor();
-
 var self = module.exports;
 
+var classifier = new natural.BayesClassifier();
+classifier.isTrained = false;
+
+var all_steps = [];
+all_steps.isFilled = false;
+
 self.listSteps = (filter, namesOnly) => {
     namesOnly = namesOnly || false;
 
@@ -36,28 +42,56 @@ self.listSteps = (filter, namesOnly) => {
         .filter(i => /^\w+$/.test(i))
         .filter(i => /^\D/.test(i));
 
-    var i = 0;
+    var filtered_steps = [];
+
     for (var s of steps) {
+        if (all_steps.isFilled && !filter) break;
+
         var func = SS[s];
 
         if (!util.isFunction(func)) continue;
 
         var doc = getDoc(func);
 
+        var tmp = {
+            name: s,
+            description: `  ${func.toString().split("{")[0]}{...}`,
+            doc: doc,
+        };
+
+        if (!all_steps.isFilled) all_steps.push(tmp);
+
+        if (doc && !classifier.isTrained) {
+            classifier.addDocument(doc, s);
+        }
+
         if (namesOnly) {
             if (!U.textContains(s, filter)) continue;
         } else {
             if (!(U.textContains(s, filter) || U.textContains(doc, filter))) continue;
         }
 
-        console.log(d(`${++i}. ${s}:`));
-        console.log(d(`  ${func.toString().split("{")[0]}{...}`));
-
-        if (doc) {
-            doc = `  /**\n${doc}\n   */`;
-            console.log(highlight(doc, { language: "js" }));
-        }
+        filtered_steps.push(tmp);
     };
+    all_steps.isFilled = true;
+
+    if (!classifier.isTrained) {
+        classifier.train();
+        classifier.isTrained = true;
+    }
+
+    if (filter && !namesOnly) {
+        filtered_steps = getRelevant(
+            all_steps, filtered_steps,
+            classifier.getClassifications(filter));
+    }
+
+    var i = 0;
+    for (s of (filter ? filtered_steps : all_steps)) {
+        console.log(d(`${++i}. ${s.name}:`));
+        console.log(d(s.description));
+        if (s.doc) console.log(highlight(s.doc, { language: "js" }));
+    }
 
     if (i === 0) {
         console.log("No steps are found".yellow);
@@ -100,7 +134,6 @@ self.listFixtures = (filter, namesOnly) => {
         console.log(d(`${++i}. ${fx}`));
 
         if (doc) {
-            doc = `  /**\n${doc}\n   */`;
             console.log(highlight(doc, { language: "js" }));
         }
     };
@@ -110,14 +143,44 @@ self.listFixtures = (filter, namesOnly) => {
     };
 };
 
+var getRelevant = (all, filtered, classified) => {
+    if (classified.map(i => i.value).reduce((j, i) => j === i ? j : NaN)) {
+        return filtered;
+    }
+
+    classified = classified.slice(0, 3);
+
+    var result = [];
+
+    for (var cls of classified) {
+        result.push(getStep(all, cls.label));
+    };
+
+    for (var f of filtered) {
+        if (getStep(result, f.name)) continue;
+        result.push(f);
+    };
+
+    return result.reverse();
+};
+
+var getStep = (bucket, name) => {
+    for (var b of bucket) {
+        if (b.name === name) return b;
+    }
+    return null;
+};
+
 var getDoc = func => {
-    return func
+    var doc = func
         .__doc__
         .split("\n")
         .map(i => i.trim())
         .filter(i => i)
         .map(i => `   ${i}`)
         .join("\n");
+    if (!doc) return doc;
+    return `  /**\n${doc}\n   */`;
 };
 
 var load = () => {

package.json

@@ -39,6 +39,7 @@
     "glace-utils": "^1.1.7",
     "lodash": "^4.17.5",
     "mocha": "^4.0.1",
+    "natural": "^0.5.6",
     "rewire": "^3.0.2",
     "sinon": "^4.4.5",
     "sinon-chai": "^2.14.0",