From 5156a8ecd3185d3b83935c70c699ee36a42d884f Mon Sep 17 00:00:00 2001 From: Jamesbillard12 Date: Wed, 19 Jul 2017 12:28:18 -0700 Subject: [PATCH 1/9] got basic structures and dependencies --- .eslintignore | 5 ++ .eslintrc | 21 ++++++++ .gitignore | 136 +++++++++++++++++++++++++++++++++++++++++++++++ assets/one.txt | 0 assets/three.txt | 0 assets/two.txt | 0 index.js | 0 package.json | 29 ++++++++++ 8 files changed, 191 insertions(+) create mode 100644 .eslintignore create mode 100644 .eslintrc create mode 100644 .gitignore create mode 100644 assets/one.txt create mode 100644 assets/three.txt create mode 100644 assets/two.txt create mode 100644 index.js create mode 100644 package.json diff --git a/.eslintignore b/.eslintignore new file mode 100644 index 0000000..05b1cf3 --- /dev/null +++ b/.eslintignore @@ -0,0 +1,5 @@ +**/node_modules/* +**/vendor/* +**/*.min.js +**/coverage/* +**/build/* diff --git a/.eslintrc b/.eslintrc new file mode 100644 index 0000000..8dc6807 --- /dev/null +++ b/.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" +} diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..345130c --- /dev/null +++ b/.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 diff --git a/assets/one.txt b/assets/one.txt new file mode 100644 index 0000000..e69de29 diff --git a/assets/three.txt b/assets/three.txt new file mode 100644 index 0000000..e69de29 diff --git a/assets/two.txt b/assets/two.txt new file mode 100644 index 0000000..e69de29 diff --git a/index.js b/index.js new file mode 100644 index 0000000..e69de29 diff --git a/package.json b/package.json new file mode 100644 index 0000000..2c6316a --- /dev/null +++ b/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" + } +} From 4b277b005859f9427b46b3fabba03a2b92882cd8 Mon Sep 17 00:00:00 2001 From: Jamesbillard12 Date: Wed, 19 Jul 2017 12:57:25 -0700 Subject: [PATCH 2/9] wrote readfile helper module --- lib/file-reader.js | 10 ++++++++++ test/file-reader-test.js | 26 ++++++++++++++++++++++++++ 2 files changed, 36 insertions(+) create mode 100644 lib/file-reader.js create mode 100644 test/file-reader-test.js diff --git a/lib/file-reader.js b/lib/file-reader.js new file mode 100644 index 0000000..e86ec5f --- /dev/null +++ b/lib/file-reader.js @@ -0,0 +1,10 @@ +'use strict'; + +const fs = require('fs'); + +const fileReader = module.exports = (file, cb) => { + fs.readFile(file, (err, data) => { + if(err) return cb(err); + return cb(null, data.toString('hex')); + }); +} diff --git a/test/file-reader-test.js b/test/file-reader-test.js new file mode 100644 index 0000000..e5e6023 --- /dev/null +++ b/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(); + }) + }) + }) +}); From d37fada044ee5d6596ef9303823d6066a73965ee Mon Sep 17 00:00:00 2001 From: Jamesbillard12 Date: Wed, 19 Jul 2017 14:13:11 -0700 Subject: [PATCH 3/9] file reader is not owkring in my indexfile. trying to fix that --- assets/one.txt | 5 +++++ assets/three.txt | 1 + assets/two.txt | 1 + index.js | 15 +++++++++++++++ lib/file-reader.js | 2 +- test/file-reader-test.js | 6 +++--- 6 files changed, 26 insertions(+), 4 deletions(-) diff --git a/assets/one.txt b/assets/one.txt index e69de29..c4bc3dd 100644 --- a/assets/one.txt +++ b/assets/one.txt @@ -0,0 +1,5 @@ +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. + +I like Sour Patch Kids I'ma make you shine bright like you're laying in the snow, burr let the music blast we gon' do our dance. I'm in pieces, so come fix me you know I'm a real OG and baby I ain't from the TO let the music blast we gon' do our dance. If I was your boyfriend, I'd never let you go I'ma make you shine bright like you're laying in the snow, burr I like The Notebook. Baby know for sho', I'll never let you go when I met you girl my heart went knock knock I like Sour Patch Kids. And all the haters I swear they look so small from up here but something would be nothing and all the haters I swear they look so small from up here. What you got, a billion could've never bought man, we steppin' out like whoa but something would be nothing. If I was your boyfriend, I'd never let you go ooh no, ooh no, ooh swaggie. Ooh no, ooh no, ooh I could be your Buzz Lightyear fly across the globe I like Sour Patch Kids. + +It's a Bieber world live it or die worst birthday ever swag. Swag I could be your Buzz Lightyear fly across the globe I make good grilled cheese and I like girls. Swaggie worst birthday ever and all the haters I swear they look so small from up here. What you got, a billion could've never bought swag got your girlfriend at my crib watching Netflix. We don't need no wings to fly I like Sour Patch Kids I like The Notebook. I like Sour Patch Kids baby, baby, baby, oh and all the haters I swear they look so small from up here. Got your girlfriend at my crib watching Netflix when I met you girl my heart went knock knock I make good grilled cheese and I like girls. Baby, baby, baby, oh canada I make good grilled cheese and I like girls. diff --git a/assets/three.txt b/assets/three.txt index e69de29..ec298c9 100644 --- a/assets/three.txt +++ b/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. diff --git a/assets/two.txt b/assets/two.txt index e69de29..bb4f626 100644 --- a/assets/two.txt +++ b/assets/two.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. diff --git a/index.js b/index.js index e69de29..375bfb2 100644 --- a/index.js +++ b/index.js @@ -0,0 +1,15 @@ +'use strict'; + +const filereader = require('../03-parallel_file_system/lib/file-reader.js'); + +var filePaths = [`${__dirname}/assets/one.txt`,`${__dirname}/assets/two.txt`, `${__dirname}/assets/three.txt`]; + +var printHexInOrder = (err) => { + if(err) throw err; + filePaths.map((path) => { + console.log(path); + console.log(fileReader(path)); + }); +}; + +printHexInOrder(); diff --git a/lib/file-reader.js b/lib/file-reader.js index e86ec5f..f5be5de 100644 --- a/lib/file-reader.js +++ b/lib/file-reader.js @@ -7,4 +7,4 @@ const fileReader = module.exports = (file, cb) => { if(err) return cb(err); return cb(null, data.toString('hex')); }); -} +}; diff --git a/test/file-reader-test.js b/test/file-reader-test.js index e5e6023..889f3e4 100644 --- a/test/file-reader-test.js +++ b/test/file-reader-test.js @@ -20,7 +20,7 @@ describe('file reader', () => { console.log(typeof data); expect(data).to.be.a('string'); done(); - }) - }) - }) + }); + }); + }); }); From fdcc26f6a7754fb3d7c587748b776f50ed938054 Mon Sep 17 00:00:00 2001 From: Jamesbillard12 Date: Wed, 19 Jul 2017 14:55:29 -0700 Subject: [PATCH 4/9] got the buffer to work --- assets/one.txt | 4 ---- assets/two.txt | 2 +- index.js | 31 +++++++++++++++++++++---------- 3 files changed, 22 insertions(+), 15 deletions(-) diff --git a/assets/one.txt b/assets/one.txt index c4bc3dd..bb4f626 100644 --- a/assets/one.txt +++ b/assets/one.txt @@ -1,5 +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. - -I like Sour Patch Kids I'ma make you shine bright like you're laying in the snow, burr let the music blast we gon' do our dance. I'm in pieces, so come fix me you know I'm a real OG and baby I ain't from the TO let the music blast we gon' do our dance. If I was your boyfriend, I'd never let you go I'ma make you shine bright like you're laying in the snow, burr I like The Notebook. Baby know for sho', I'll never let you go when I met you girl my heart went knock knock I like Sour Patch Kids. And all the haters I swear they look so small from up here but something would be nothing and all the haters I swear they look so small from up here. What you got, a billion could've never bought man, we steppin' out like whoa but something would be nothing. If I was your boyfriend, I'd never let you go ooh no, ooh no, ooh swaggie. Ooh no, ooh no, ooh I could be your Buzz Lightyear fly across the globe I like Sour Patch Kids. - -It's a Bieber world live it or die worst birthday ever swag. Swag I could be your Buzz Lightyear fly across the globe I make good grilled cheese and I like girls. Swaggie worst birthday ever and all the haters I swear they look so small from up here. What you got, a billion could've never bought swag got your girlfriend at my crib watching Netflix. We don't need no wings to fly I like Sour Patch Kids I like The Notebook. I like Sour Patch Kids baby, baby, baby, oh and all the haters I swear they look so small from up here. Got your girlfriend at my crib watching Netflix when I met you girl my heart went knock knock I make good grilled cheese and I like girls. Baby, baby, baby, oh canada I make good grilled cheese and I like girls. diff --git a/assets/two.txt b/assets/two.txt index bb4f626..8f1aa4d 100644 --- a/assets/two.txt +++ b/assets/two.txt @@ -1 +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. +No one can stop me if I was your boyfriend diff --git a/index.js b/index.js index 375bfb2..1a52ed1 100644 --- a/index.js +++ b/index.js @@ -1,15 +1,26 @@ 'use strict'; -const filereader = require('../03-parallel_file_system/lib/file-reader.js'); +const fs = require('fs'); +const fileReader = require('../03-parallel_file_system/lib/file-reader.js'); +// +// var filePaths = [`${__dirname}/assets/one.txt`,`${__dirname}/assets/two.txt`, `${__dirname}/assets/three.txt`]; +// +// var printHexInOrder = (err) => { +// if(err) throw err; +// filePaths.map((path) => { +// fs.fileReader(); +// }); +// }; +// +// printHexInOrder(); -var filePaths = [`${__dirname}/assets/one.txt`,`${__dirname}/assets/two.txt`, `${__dirname}/assets/three.txt`]; +fileReader(`${__dirname}/assets/one.txt`, function(err, data){ + console.log(data); + fileReader(`${__dirname}/assets/two.txt`, function(err, data){ + console.log(data); + fileReader(`${__dirname}/assets/three.txt`, function(err, data){ + console.log(data); -var printHexInOrder = (err) => { - if(err) throw err; - filePaths.map((path) => { - console.log(path); - console.log(fileReader(path)); + }); }); -}; - -printHexInOrder(); +}); From fafc69269402e22cd2f3192ac9952f477133871e Mon Sep 17 00:00:00 2001 From: Jamesbillard12 Date: Wed, 19 Jul 2017 17:26:27 -0700 Subject: [PATCH 5/9] finally finished all testing, need to work on my linting --- index.js | 31 +++++++++++++------------------ lib/file-reader.js | 2 +- test/index-test.js | 17 +++++++++++++++++ 3 files changed, 31 insertions(+), 19 deletions(-) create mode 100644 test/index-test.js diff --git a/index.js b/index.js index 1a52ed1..a857891 100644 --- a/index.js +++ b/index.js @@ -1,26 +1,21 @@ 'use strict'; -const fs = require('fs'); const fileReader = require('../03-parallel_file_system/lib/file-reader.js'); -// -// var filePaths = [`${__dirname}/assets/one.txt`,`${__dirname}/assets/two.txt`, `${__dirname}/assets/three.txt`]; -// -// var printHexInOrder = (err) => { -// if(err) throw err; -// filePaths.map((path) => { -// fs.fileReader(); -// }); -// }; -// -// printHexInOrder(); -fileReader(`${__dirname}/assets/one.txt`, function(err, data){ - console.log(data); - fileReader(`${__dirname}/assets/two.txt`, function(err, data){ + +let orderHexBytes = module.exports = (callback) => { + let hexArray = []; + fileReader(`${__dirname}/assets/one.txt`, function(err, data){ console.log(data); - fileReader(`${__dirname}/assets/three.txt`, function(err, data){ + hexArray.push(data); + fileReader(`${__dirname}/assets/two.txt`, function(err, data){ console.log(data); - + hexArray.push(data); + fileReader(`${__dirname}/assets/three.txt`, function(err, data){ + console.log(data); + hexArray.push(data); + callback(hexArray); + }); }); }); -}); +}; diff --git a/lib/file-reader.js b/lib/file-reader.js index f5be5de..4da9e7a 100644 --- a/lib/file-reader.js +++ b/lib/file-reader.js @@ -5,6 +5,6 @@ const fs = require('fs'); const fileReader = module.exports = (file, cb) => { fs.readFile(file, (err, data) => { if(err) return cb(err); - return cb(null, data.toString('hex')); + return cb(null, data.toString('hex',0,8)); }); }; diff --git a/test/index-test.js b/test/index-test.js new file mode 100644 index 0000000..5bedf38 --- /dev/null +++ b/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((hexArray) => { + console.log(hexArray); + expect(hexArray).to.deep.equal(['4e6f206f6e652063','4e6f206f6e652063','536d696c65206f6e']); + done(); + }); + }); + }); +}); From 733b8c72cf5814ed7d137df7c2e31b729a8138a4 Mon Sep 17 00:00:00 2001 From: Jamesbillard12 Date: Wed, 19 Jul 2017 17:35:54 -0700 Subject: [PATCH 6/9] wrote in error handling in index file --- index.js | 10 +++++----- test/index-test.js | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/index.js b/index.js index a857891..3c15df4 100644 --- a/index.js +++ b/index.js @@ -3,18 +3,18 @@ const fileReader = require('../03-parallel_file_system/lib/file-reader.js'); -let orderHexBytes = module.exports = (callback) => { +let orderHexBytes = module.exports = (cb) => { let hexArray = []; fileReader(`${__dirname}/assets/one.txt`, function(err, data){ - console.log(data); + if(err) return cb(err); hexArray.push(data); fileReader(`${__dirname}/assets/two.txt`, function(err, data){ - console.log(data); + if(err) return cb(err); hexArray.push(data); fileReader(`${__dirname}/assets/three.txt`, function(err, data){ - console.log(data); + if(err) return cb(err); hexArray.push(data); - callback(hexArray); + cb(null, hexArray); }); }); }); diff --git a/test/index-test.js b/test/index-test.js index 5bedf38..c3e3522 100644 --- a/test/index-test.js +++ b/test/index-test.js @@ -7,7 +7,7 @@ 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((hexArray) => { + orderHexBytes((err, hexArray) => { console.log(hexArray); expect(hexArray).to.deep.equal(['4e6f206f6e652063','4e6f206f6e652063','536d696c65206f6e']); done(); From dfcfe6917c22599f35ac52006715d50b1643a1f2 Mon Sep 17 00:00:00 2001 From: Jamesbillard12 Date: Wed, 19 Jul 2017 17:45:26 -0700 Subject: [PATCH 7/9] finished assignment --- index.js | 2 +- lib/file-reader.js | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/index.js b/index.js index 3c15df4..e628a8e 100644 --- a/index.js +++ b/index.js @@ -3,7 +3,7 @@ const fileReader = require('../03-parallel_file_system/lib/file-reader.js'); -let orderHexBytes = module.exports = (cb) => { +let orderHexBytes = module.exports = (cb) => { //eslint-disable-line let hexArray = []; fileReader(`${__dirname}/assets/one.txt`, function(err, data){ if(err) return cb(err); diff --git a/lib/file-reader.js b/lib/file-reader.js index 4da9e7a..f51d8a7 100644 --- a/lib/file-reader.js +++ b/lib/file-reader.js @@ -2,7 +2,7 @@ const fs = require('fs'); -const fileReader = module.exports = (file, cb) => { +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)); From b30068e82f1143848e0270d14a08868040d2212d Mon Sep 17 00:00:00 2001 From: Jamesbillard12 Date: Thu, 20 Jul 2017 10:05:25 -0700 Subject: [PATCH 8/9] added a readme file --- README.md | 48 ++++++------------------------------------------ 1 file changed, 6 insertions(+), 42 deletions(-) diff --git a/README.md b/README.md index 8cc8c11..df2b7f3 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,9 @@ -![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-` + `` **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 - -* 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 From 07ba5dfd2122b434ad0b3731af09a665d56dd69a Mon Sep 17 00:00:00 2001 From: Jamesbillard12 Date: Thu, 20 Jul 2017 12:33:25 -0700 Subject: [PATCH 9/9] added what done does --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index df2b7f3..4530054 100644 --- a/README.md +++ b/README.md @@ -7,3 +7,4 @@ Lab-James Lab-02 Documentation 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.