Pull Request for peer review

.codeclimate.yml

@@ -0,0 +1,47 @@
+engines:
+  eslint:
+    enabled: true
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - javascript
+  csslint:
+    enabled: false
+    # ... CONFIG CONTENT ...
+    checks:
+      comma-dangle:
+        enabled: false
+      import/no-unresolved:
+        enabled: false
+      no-console:
+        enabled: false
+      strict:
+        enabled: false
+      no-unused-vars:
+        enabled: false
+      no-undef:
+        enabled: false
+      class-methods-use-this:
+        enabled: false
+      no-param-reassign:
+        enabled: false
+      array-callback-return:
+        enabled: false
+  fixme:
+    enabled: true
+ratings:
+  paths:
+    - "src/invertedindex.js"
+exclude_paths:
+- "samples/*"
+- "*.json"
+- "src/app.js"
+- "src/module.js"
+- "css/*"
+- "index.html"
+- "specs/*"
+- .travis.yml
+- .eslintrc.json
+- "spec/*"
+- "images/*"

README.md

@@ -40,5 +40,6 @@ It can also be used locally by following the steps below
 - The application can not be distinguished between plural and singular words. It also does not distinguish between the past tense form of a verb. It does not identify synonyms and sees numbers as string
 
 ## More information
+- [DPlex Wiki](https://github.com/andela-aonifade/dplex/wiki)
 - [Inverted Index - Wikipedia](https://en.wikipedia.org/wiki/Inverted_index)
 - [Inverted Index](https://www.elastic.co/guide/en/elasticsearch/guide/current/inverted-index.html)

index.html

@@ -11,7 +11,7 @@
     <!-- Latest compiled and minified JavaScript -->
     <link rel="stylesheet" href="https://bootswatch.com/darkly/bootstrap.min.css">
     <link rel="stylesheet" href="https://unpkg.com/angular-toastr/dist/angular-toastr.css" />
-    <link rel="stylesheet" href="https://cdn.datatables.net/1.10.13/css/jquery.dataTables.min.css">    
+    <link rel="stylesheet" href="https://cdn.datatables.net/1.10.13/css/jquery.dataTables.min.css">
     <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/angular.js/1.5.8/angular.min.js"></script>
     <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.1.1/jquery.min.js"></script>
     <link rel="stylesheet" href="css/style.css">

server.js

@@ -2,4 +2,4 @@ const connect = require('connect');
 const serveStatic = require('serve-static');
 
 const port = process.env.PORT || 3000;
-connect().use(serveStatic('./src')).listen(port);
+connect().use(serveStatic('./')).listen(port);

spec/dplex-test-spec.js

@@ -1,6 +1,6 @@
 
 describe('InvertedIndex class', () => {
-  beforeEach(() => {
+  beforeAll(() => {
     this.indexInstance = new InvertedIndex();
     this.validBook = [{ title: 'Welcome to Test Environment',
       text: 'Enjoy this file' }];
@@ -100,6 +100,10 @@ describe('InvertedIndex class', () => {
       const term = { t1: 'Welcome home', text: 'This is really home' };
       expect(this.indexInstance.createIndex(term, 'term')).toBeFalsy();
     });
+    it('should return false for file with no content', () => {
+      const term = {};
+      expect(this.indexInstance.createIndex(term, 'term')).toBeFalsy();
+    });
   });
   describe('Search Index', () => {
     it('should search through single files that are indexed', () => {
@@ -118,6 +122,24 @@ describe('InvertedIndex class', () => {
       expect(this.indexInstance.searchIndex(term, 'books'))
       .toBeFalsy();
     });
+    it('should return an empty object for an words not found', () => {
+      const term = 'Aeroplane';
+      const expectedOutput =  this.indexInstance.searchIndex(term, 'books');
+      expect(expectedOutput[0].indexes).toEqual({ });
+    });
+    it('should return an array of objects if filename is all', () => {
+      const books1 = [{title: 'Alice in Wonderland too',
+        text: 'Alice adventure in the wonderland was full of drama and action'}];
+      this.indexInstance.createIndex(books, 'books');
+      this.indexInstance.createIndex(books1, 'books1');
+      const expectedOutput = [{ indexes: { alice: [0], wonderland: [0] },
+        searchedFile: 'books',
+        documents: [0, 1, 2] },
+        { indexes: { alice: [0], wonderland: [0] },
+        searchedFile: 'books1',
+        documents: [0] }];
+        expect(this.indexInstance.searchIndex('Alice Wonderland', 'all')).toEqual(expectedOutput);
+    });
   });
 
   describe('Tokenize words', () => {

src/invertedindex.js

@@ -5,6 +5,7 @@ let instance = null;
 /**
  * @class InvertedIndex class
  * Contains methods for InvertedIndex
+ * Only allows single instance of the object to be created
 */
 class InvertedIndex {
   /**
@@ -72,7 +73,7 @@ class InvertedIndex {
     let documentNum = 0;
     try {
       if (Object.keys(inputData).length < 1) {
-        this.handleError(filename, 'File contains no document', true);
+        this.handleError(filename, 'File contains no document', true); 
       }
       Object.keys(inputData).forEach((eachIndex) => {
         if (!this.validateFile(inputData[eachIndex])) {
@@ -84,6 +85,7 @@ class InvertedIndex {
       this.filesIndexed[filename].numOfDocs = documentNum;
       this.filesIndexed[filename].index = this.constructIndex(words);
       return true;
+
     } catch (err) {
       if (this.error.status) {
         return false;
@@ -178,7 +180,6 @@ class InvertedIndex {
   */
   searchIndex(searchTerm, filename) {
     if ((typeof searchTerm === 'string' && searchTerm.trim() === '') ||
-      (typeof searchTerm === 'object' && searchTerm.length === 0) ||
       searchTerm === undefined) {
       return false;
     }