lab-james

.eslintignore

@@ -0,0 +1,5 @@
+**/node_modules/*
+**/vendor/*
+**/*.min.js
+**/coverage/*
+**/build/*

.eslintrc

@@ -0,0 +1,21 @@
+{
+  "rules": {
+    "no-console": "off",
+    "indent": [ "error", 2 ],
+    "quotes": [ "error", "single" ],
+    "semi": ["error", "always"],
+    "linebreak-style": [ "error", "unix" ]
+  },
+  "env": {
+    "es6": true,
+    "node": true,
+    "mocha": true,
+    "jasmine": true
+  },
+  "ecmaFeatures": {
+    "modules": true,
+    "experimentalObjectRestSpread": true,
+    "impliedStrict": true
+  },
+  "extends": "eslint:recommended"
+}

.gitignore

@@ -0,0 +1,136 @@
+# Created by https://www.gitignore.io/api/osx,vim,node,macos,windows
+
+### macOS ###
+*.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### Node ###
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Typescript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+
+### OSX ###
+
+# Icon must end with two \r
+
+# Thumbnails
+
+# Files that might appear in the root of a volume
+
+# Directories potentially created on remote AFP share
+
+### Vim ###
+# swap
+[._]*.s[a-v][a-z]
+[._]*.sw[a-p]
+[._]s[a-v][a-z]
+[._]sw[a-p]
+# session
+Session.vim
+# temporary
+.netrwhist
+*~
+# auto-generated tag files
+tags
+
+### Windows ###
+# Windows thumbnail cache files
+Thumbs.db
+ehthumbs.db
+ehthumbs_vista.db
+
+# Folder config file
+Desktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+# End of https://www.gitignore.io/api/osx,vim,node,macos,windows

README.md

@@ -1,45 +1,10 @@
-![CF](https://camo.githubusercontent.com/70edab54bba80edb7493cad3135e9606781cbb6b/687474703a2f2f692e696d6775722e636f6d2f377635415363382e706e67) 04: Parallel File Processing
-===
+Lab-James Lab-02 Documentation
 
-## Submission Instructions
-  * fork this repository & create a new branch for your work
-  * write all of your code in a directory named `lab-` + `<your name>` **e.g.** `lab-susan`
-  * push to your repository
-  * submit a pull request to this repository
-  * submit a link to your PR in canvas
-  * write a question and observation on canvas
+*index.js contains a function 'orderHexBytes' which calls the module 'fileReader' in file-reader.js in an asynchronous callback format.
 
-## Learning Objectives  
-  * students will be able to create asynchronous programs using the node.js callback pattern
-  * students will be able to read, write, and encode binary data using the Buffer class
-  * students will be able to utilize the built-in `fs` module for basic file system I/O operations
-  * students will be able to use `done` (provided by mocha.js) for creating asynchronous tests
+*./lib/file-reader.js returns a converted a buffer into a 8 byte hex string from a specified file path to a .txt file.
 
-## Resources  
-  * [fs module docs](https://nodejs.org/api/fs.html)
-
-## Requirements  
-
-#### Configuration  
-<!-- list of files, configurations, tools, etc that are required -->
-* include the following:
-  * **README.md** - contains documentation about your lab
-  * **.gitignore** - contains a robust `.gitignore` file
-  * **.eslintrc** - contains the provided `.eslintrc` file
-  * **.eslintignore** - contains the provided `.eslintignore` file
-  * **lib/** - contains your modules
-  * **test/** - contains your unit tests
-  * **assets/** - contains the text files used by the program
-  * **index.js** - contains main program file
-
-#### Feature Tasks  
-  * for this assignment you will need to read three files and `console.log` the first 8 bytes ***(in hex)*** of each file
-  * regardless of file size, all three files should be read and logged in the order `'one.txt'`, `'two.txt'`, `'three.txt'`
-
-#### Testing  
-  * create a test that guarantees that the files are logged in the proper order
-  * create a test that checks for improper file paths
-
-####  Documentation
-  * create a simple description of your project
-  * create a simple layer of documentation that describes how to use `done` in mocha callbacks
+Tests
+*../test/file-reader-test.js tests the fileReader module
+*../test/index-test.js tests the orderHexBytes functions
+done() tells mocha that the asynchronous test has finished.

assets/one.txt

@@ -0,0 +1 @@
+No one can stop me if I was your boyfriend, I'd never let you go don't be so cold, we could be fire. Canada you know I'm a real OG and baby I ain't from the TO I'm all fancy, yeah I'm popping Pellegrino. I'd like to be an architect, that would be cool, cause I like drawing we don't need no wings to fly swag. I'm all fancy, yeah I'm popping Pellegrino baby, baby, baby, oh I'ma make you shine bright like you're laying in the snow, burr. We don't need no wings to fly I'm in pieces, so come fix me I could be your Buzz Lightyear fly across the globe. Smile on your face, even though your heart is frowning canada if I was your boyfriend, I'd never let you go. I'm in pieces, so come fix me when I met you girl my heart went knock knock I like The Notebook. Ooh no, ooh no, ooh we don't need no wings to fly I'm in pieces, so come fix me.

assets/three.txt

@@ -0,0 +1 @@
+Smile on your face, even though your heart is frowning swaggie and all the haters I swear they look so small from up here.

assets/two.txt

@@ -0,0 +1 @@
+No one can stop me if I was your boyfriend

index.js

@@ -0,0 +1,21 @@
+'use strict';
+
+const fileReader = require('../03-parallel_file_system/lib/file-reader.js');
+
+
+let orderHexBytes = module.exports = (cb) => { //eslint-disable-line
+  let hexArray = [];
+  fileReader(`${__dirname}/assets/one.txt`, function(err, data){
+    if(err) return cb(err);
+    hexArray.push(data);
+    fileReader(`${__dirname}/assets/two.txt`, function(err, data){
+      if(err) return cb(err);
+      hexArray.push(data);
+      fileReader(`${__dirname}/assets/three.txt`, function(err, data){
+        if(err) return cb(err);
+        hexArray.push(data);
+        cb(null, hexArray);
+      });
+    });
+  });
+};

lib/file-reader.js

@@ -0,0 +1,10 @@
+'use strict';
+
+const fs = require('fs');
+
+const fileReader = module.exports = (file, cb) => { //eslint-disable-line
+  fs.readFile(file, (err, data) => {
+    if(err) return cb(err);
+    return cb(null, data.toString('hex',0,8));
+  });
+};

package.json

@@ -0,0 +1,29 @@
+{
+  "name": "03-parallel_file_system",
+  "version": "1.0.0",
+  "description": "![CF](https://camo.githubusercontent.com/70edab54bba80edb7493cad3135e9606781cbb6b/687474703a2f2f692e696d6775722e636f6d2f377635415363382e706e67) 04: Parallel File Processing ===",
+  "main": "index.js",
+  "directories": {
+    "test": "test"
+  },
+  "scripts": {
+    "test": "mocha",
+    "start": "node index.js",
+    "lint": "eslint"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Jamesbillard12/03-parallel_file_system.git"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/Jamesbillard12/03-parallel_file_system/issues"
+  },
+  "homepage": "https://github.com/Jamesbillard12/03-parallel_file_system#readme",
+  "devDependencies": {
+    "chai": "^4.1.0",
+    "mocha": "^3.4.2"
+  }
+}

test/file-reader-test.js

@@ -0,0 +1,26 @@
+'use strict';
+
+const expect = require('chai').expect;
+const fileReader = require('../lib/file-reader.js');
+
+describe('file reader', () => {
+  describe('with improper file path', () => {
+    it('should return an error', (done) => {
+      fileReader(`${__dirname}/not-a-real-file.txt`, (err) =>{
+        expect(err).to.be.an('error');
+        done();
+      });
+    });
+  });
+
+  describe('with a proper file path', () => {
+    it('should return the content of the file', (done) =>{
+      fileReader(`${__dirname}/../assets/one.txt`, (err, data) => {
+        expect(err).to.equal(null);
+        console.log(typeof data);
+        expect(data).to.be.a('string');
+        done();
+      });
+    });
+  });
+});

test/index-test.js

@@ -0,0 +1,17 @@
+'use strict';
+
+const expect = require('chai').expect;
+const orderHexBytes = require('../index.js');
+
+
+describe('index', () => {
+  describe('orderHexBytes',() => {
+    it('should return an array that follows a specific order and have 8 bytes each', (done) => {
+      orderHexBytes((err, hexArray) => {
+        console.log(hexArray);
+        expect(hexArray).to.deep.equal(['4e6f206f6e652063','4e6f206f6e652063','536d696c65206f6e']);
+        done();
+      });
+    });
+  });
+});