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/*"

.eslintignore

@@ -11,4 +11,5 @@ spec/*.html
 *.html
 karma.conf.js
 Profile
+build/
 

eslintrc.json → .eslintrc.json

@@ -11,15 +11,14 @@
   },
   "rules": {
     "import/no-unresolved": 0,
+    "max-len":[2, 80, 2],
     "one-var": 0,
     "one-var-declaration-per-line": 0,
     "new-cap": 0,
     "no-undef": 0,
     "func-names":0, 
     "consistent-return": 0,
-    "class-methods-use-this": 0,
     "no-param-reassign": 0,
-    "no-prototype-builtins": 0,
     "comma-dangle": 0,
     "curly": [ 1, "multi-line" ],
     "no-shadow": [ 1, { "allow": [ "req", "res", "err" ] } ],

README.md

@@ -1,4 +1,4 @@
-[![Coverage Status](https://coveralls.io/repos/github/andela-aonifade/dplex/badge.svg?branch=development)](https://coveralls.io/github/andela-aonifade/dplex?branch=development)
+[![Coverage Status](https://s3.amazonaws.com/assets.coveralls.io/badges/coveralls_98.svg?branch=development)](https://coveralls.io/github/andela-aonifade/dplex?branch=development)
 [![Code Climate](https://codeclimate.com/github/andela-aonifade/dplex/badges/gpa.svg)](https://codeclimate.com/github/andela-aonifade/dplex)
 [![Build Status](https://travis-ci.org/andela-aonifade/dplex.svg?branch=development)](https://travis-ci.org/andela-aonifade/dplex)
 
@@ -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)

build/bundle.js

@@ -0,0 +1,303 @@
+(function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);throw new Error("Cannot find module '"+o+"'")}var f=n[o]={exports:{}};t[o][0].call(f.exports,function(e){var n=t[o][1][e];return s(n?n:e)},f,f.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o<r.length;o++)s(r[o]);return s})({1:[function(require,module,exports){
+module.exports=[
+  {
+    "title": "Alice in Wonderland",
+    "text": "Alice falls into a rabbit hole and enters a world full of imagination."
+  },
+
+  {
+    "title": "The Lord of the Rings: The Fellowship of the Ring.",
+    "text": "An unusual alliance of man, elf, dwarf, wizard and hobbit seek to destroy a powerful ring."
+  }
+]
+
+},{}],2:[function(require,module,exports){
+const validBookFile = require('../samples/books.json');
+
+describe('InvertedIndex class', () => {
+  beforeAll(() => {
+    const indexInstance = new InvertedIndex();
+    const validBook = [{ title: 'Welcome to Test Environment',
+      text: 'Enjoy this file' }];
+    const books = [
+      {
+        title: 'Alice in Wonderland',
+        text:
+        'Alice falls into a rabbit hole and enters a world full of imagination.'
+      },
+
+      {
+        title: 'The Lord of the Rings: The Fellowship of the Ring.',
+        text: `An unusual alliance of man, elf, dwarf, 
+          wizard and hobbit seek to destroy a powerful ring.`
+      },
+      {
+        title: 'The Lord of the Rings: The Fellowship of the Ring.',
+        text: `An unusual alliance of man, elf, dwarf, 
+          wizard and hobbit seek to destroy a powerful ring.`
+      }
+    ];
+    const anotherBook = [{
+      title: 'Alice the Great',
+      text:
+        'There is no better way to greatness than not giving up'
+    },
+
+    {
+      title: 'Are you there for Development',
+      text: `I have tried so many times but it's been unyielding 
+          but I have made up my mind to develop no matter the obstacle`
+    }];
+    indexInstance.createIndex(books, 'books');
+    indexInstance.createIndex(anotherBook, 'anotherBook');
+  });
+  describe('InvertedIndex class', () => {
+    it('should check that the class has a createIndex method', () => {
+      expect(typeof indexInstance.createIndex).toBe('function');
+    });
+
+    it('should check that the class has a readFile method', () => {
+      expect(typeof InvertedIndex.readFile).toBe('function');
+    });
+
+    it('should check that the class has a validateFile method', () => {
+      expect(typeof InvertedIndex.validateFile).toBe('function');
+    });
+
+    it('should check that the class has a tokenize method', () => {
+      expect(typeof InvertedIndex.tokenize).toBe('function');
+    });
+
+    it('should check that the class has a getDocumentTokens method', () => {
+      expect(typeof InvertedIndex.getDocumentTokens).toBe('function');
+    });
+
+    it('should check that the class has a getIndex method', () => {
+      expect(typeof indexInstance.getIndex).toBe('function');
+    });
+
+    it('should check that the class has a searchIndex method', () => {
+      expect(typeof indexInstance.searchIndex).toBe('function');
+    });
+
+    it('should check that the class has a getSearchResults method', () => {
+      expect(typeof indexInstance.getSearchResults).toBe('function');
+    });
+
+    it('should check that the class has a getDocuments method', () => {
+      expect(typeof indexInstance.getDocuments).toBe('function');
+    });
+  });
+
+  describe('Read File', () => {
+    it('should return false for an invalid filename extension', () => {
+      const badFile = { name: 'badfileextension.jpg' };
+      const anotherBadFile = { name: 'badfileextension.jsona' };
+      InvertedIndex.readFile(badFile).then((response) => {
+        expect(response).toBeFalsy();
+      });
+      InvertedIndex.readFile(anotherBadFile).then((response) => {
+        expect(response).toBeFalsy();
+      });
+    });
+    const bookFile = new File([JSON.stringify(validBookFile)],
+      'books.json', { type: 'application/json' });
+    it('should return appropriate value for a valid json file', () => {
+      InvertedIndex.readFile(bookFile).then((response) => {
+        expect(response[0].title).toEqual(books[0].title);
+      });
+    });
+  });
+
+  describe('Create Index', () => {
+    it('should return mapped indices to words in a JSON file', () => {
+      const expectedResult =
+        { alice: [0],
+          falls: [0],
+          into: [0],
+          a: [0, 1, 2],
+          rabbit: [0],
+          hole: [0],
+          and: [0, 1, 2],
+          enters: [0],
+          world: [0],
+          full: [0],
+          of: [0, 1, 2],
+          imagination: [0],
+          in: [0],
+          wonderland: [0],
+          an: [1, 2],
+          unusual: [1, 2],
+          alliance: [1, 2],
+          man: [1, 2],
+          elf: [1, 2],
+          dwarf: [1, 2],
+          wizard: [1, 2],
+          hobbit: [1, 2],
+          seek: [1, 2],
+          to: [1, 2],
+          destroy: [1, 2],
+          powerful: [1, 2],
+          ring: [1, 2],
+          the: [1, 2],
+          lord: [1, 2],
+          rings: [1, 2],
+          fellowship: [1, 2] };
+      expect(indexInstance.filesIndexed.books.index)
+        .toEqual(expectedResult);
+    });
+    it('should return false for file with no content', () => {
+      const term = {};
+      expect(indexInstance.createIndex(term, 'term')).toBeFalsy();
+    });
+  });
+  describe('Search Index', () => {
+    it('should search through single files that are indexed', () => {
+      const requiredOutput = { alice: [0],
+        and: [0, 1, 2],
+        unusual: [1, 2],
+        imagination: [0] };
+      const searchTerm = indexInstance
+        .searchIndex('Alice, and her unusual imagination', 'books');
+      expect(Object.keys(searchTerm[0].indexes))
+        .toEqual(Object.keys(requiredOutput));
+      expect(searchTerm[0].indexes).toEqual(requiredOutput);
+    });
+    it('should return false for an empty String', () => {
+      const term = '';
+      expect(indexInstance.searchIndex(term, 'books'))
+      .toBeFalsy();
+    });
+    it('should return an empty object for words not found', () => {
+      const term = 'Aeroplane';
+      const expectedOutput = indexInstance.searchIndex(term, 'books');
+      expect(expectedOutput[0].indexes).toEqual({ });
+    });
+    it('should return appropriate result for when all files is selected',
+    () => {
+      const expectedOutput =
+        [{ indexes: { alice: [0], the: [1, 2] },
+          searchedFile: 'books',
+          documents: [0, 1, 2] },
+        { indexes: { alice: [0],
+          is: [0],
+          the: [0, 1] },
+          searchedFile: 'anotherBook',
+          documents: [0, 1] },
+        { indexes: { },
+          searchedFile: 'term',
+          documents: [] }];
+      expect(indexInstance
+        .searchIndex('Alice is the', 'all')).toEqual(expectedOutput);
+    });
+  });
+
+  describe('Tokenize words', () => {
+    it('should strip out special characters from text in documents', () => {
+      let excerpt = 'Alice l##$oves her ima&&gination?';
+      const expectedTokens = ['alice', 'loves', 'her', 'imagination'];
+      excerpt = InvertedIndex.tokenize(excerpt);
+      expect(excerpt).toEqual(expectedTokens);
+    });
+  });
+
+  describe('Get index', () => {
+    it('should return the appropriate output for the given filename', () => {
+      const filename = 'books';
+      const expectedOutput = { alice: [0],
+        falls: [0],
+        into: [0],
+        a: [0, 1, 2],
+        rabbit: [0],
+        hole: [0],
+        and: [0, 1, 2],
+        enters: [0],
+        world: [0],
+        full: [0],
+        of: [0, 1, 2],
+        imagination: [0],
+        in: [0],
+        wonderland: [0],
+        an: [1, 2],
+        unusual: [1, 2],
+        alliance: [1, 2],
+        man: [1, 2],
+        elf: [1, 2],
+        dwarf: [1, 2],
+        wizard: [1, 2],
+        hobbit: [1, 2],
+        seek: [1, 2],
+        to: [1, 2],
+        destroy: [1, 2],
+        powerful: [1, 2],
+        ring: [1, 2],
+        the: [1, 2],
+        lord: [1, 2],
+        rings: [1, 2],
+        fellowship: [1, 2] };
+      expect(indexInstance.getIndex(filename))
+        .toEqual(expectedOutput);
+    });
+    it('should return false for an empty filename', () => {
+      const filename = '';
+      expect(indexInstance.getIndex(filename))
+        .toBeFalsy();
+    });
+  });
+
+  describe('Validate File', () => {
+    it('should return false for incorrect document structure', () => {
+      const term = [{ t1: 'Welcome home', text: 'This is really home' }];
+      expect(InvertedIndex.validateFile(term, 'term')).toBeFalsy();
+    });
+    it('should return true for correct document structure', () => {
+      const term = [{ title: 'Welcome home', text: 'This is really home' }];
+      expect(InvertedIndex.validateFile(term, 'term')).toBeTruthy();
+    });
+  });
+
+  describe('Get Document Tokens', () => {
+    it('should return the appropriate object for a given document',
+    () => {
+      const expectedOutput = { documentCount: 0,
+        textTokens: ['welcome', 'this', 'is', 'a', 'test', 'document'] };
+      const documentCount = 0;
+      const term = [{ text: 'Welcome', title: 'This is a test document' }];
+      expect(InvertedIndex
+        .getDocumentTokens(term, documentCount)).toEqual(expectedOutput);
+    });
+  });
+
+  describe('Get Document Data', () => {
+    it('should return the appropriate array of documents for a given file',
+    () => {
+      const expectedOutput = [0, 1, 2];
+      expect(indexInstance
+        .getDocuments('books')).toEqual(expectedOutput);
+    });
+  });
+
+  describe('Get Search result Data', () => {
+    it('should return the appropriate result for tokens searched',
+    () => {
+      const words = 'Alice is a girl';
+      const expectedOutput = { alice: [0], a: [0, 1, 2] };
+      expect(indexInstance
+      .getSearchResults(words, 'books')).toEqual(expectedOutput);
+    });
+  });
+
+  describe('Get Construct Index Data', () => {
+    it('should return the appropriate indexed words for a given document',
+    () => {
+      const documentTokens = [{ documentCount: 0,
+        textTokens: ['welcome', 'this', 'is', 'a', 'test', 'document'] }];
+      const expectedOutput =
+        { welcome: [0], this: [0], is: [0], a: [0], test: [0], document: [0] };
+      expect(InvertedIndex.constructIndex(documentTokens))
+        .toEqual(expectedOutput);
+    });
+  });
+});
+
+},{"../samples/books.json":1}]},{},[2])

css/style.css

@@ -33,3 +33,8 @@
 .padding10{
   padding: 10px;
 }
+
+#myTable{
+  z-index: 1;
+  overflow-y: scroll;
+}