From 8852a7136fd8265928e4e4085aa5a74775f9af10 Mon Sep 17 00:00:00 2001 From: andyfiveeleven Date: Wed, 19 Jul 2017 12:56:45 -0700 Subject: [PATCH 1/5] fixed all the things, set up scaffolding --- .eslintignore | 5 ++ .eslintrc | 21 ++++++++ .gitignore | 136 ++++++++++++++++++++++++++++++++++++++++++++++++++ index.js | 0 package.json | 27 ++++++++++ 5 files changed, 189 insertions(+) create mode 100644 .eslintignore create mode 100644 .eslintrc create mode 100644 .gitignore 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/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..0cee035 --- /dev/null +++ b/package.json @@ -0,0 +1,27 @@ +{ + "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" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/codefellows-javascript-401d17/03-parallel_file_system.git" + }, + "keywords": [], + "author": "", + "license": "ISC", + "bugs": { + "url": "https://github.com/codefellows-javascript-401d17/03-parallel_file_system/issues" + }, + "homepage": "https://github.com/codefellows-javascript-401d17/03-parallel_file_system#readme", + "devDependencies": { + "chai": "^4.1.0", + "mocha": "^3.4.2" + } +} From 50316982f6f2560c22ab8a5f4e97a4c0fe073c12 Mon Sep 17 00:00:00 2001 From: andyfiveeleven Date: Wed, 19 Jul 2017 15:33:53 -0700 Subject: [PATCH 2/5] worked in index and file guesser for tests --- assets/one.txt | 1 + assets/three.txt | 3 +++ assets/two.txt | 1 + index.js | 10 ++++++++++ lib/file-reader.js | 22 ++++++++++++++++++++++ 5 files changed, 37 insertions(+) create mode 100644 assets/one.txt create mode 100644 assets/three.txt create mode 100644 assets/two.txt create mode 100644 lib/file-reader.js diff --git a/assets/one.txt b/assets/one.txt new file mode 100644 index 0000000..e4afef9 --- /dev/null +++ b/assets/one.txt @@ -0,0 +1 @@ +This text has one diff --git a/assets/three.txt b/assets/three.txt new file mode 100644 index 0000000..e8abbb2 --- /dev/null +++ b/assets/three.txt @@ -0,0 +1,3 @@ +This text is a lot longer than the otherones, probably because three is the biggest number, but lets be real, it probably has something to do with the randomness of the universe, sort of like what brandi was talking about in terms of Karma, but on a more quantum scale. + +What i'm really trying to get at here is that we don't have any control over anything except our own decisions, and it was my decision to make this one longer, because i chose it randomly. diff --git a/assets/two.txt b/assets/two.txt new file mode 100644 index 0000000..5007dfa --- /dev/null +++ b/assets/two.txt @@ -0,0 +1 @@ +This one is two, which is slightly longer than one. diff --git a/index.js b/index.js index e69de29..76ff7cf 100644 --- a/index.js +++ b/index.js @@ -0,0 +1,10 @@ +'use strict'; + +const readFiles = require('lib/file-reader.js'); +const paths = [ + `${__dirname}/assets/one.txt`, + `${__dirname}/assets/two.txt`, + `${__dirname}/assets/three.txt` +] + +readFiles(paths); diff --git a/lib/file-reader.js b/lib/file-reader.js new file mode 100644 index 0000000..b0798c1 --- /dev/null +++ b/lib/file-reader.js @@ -0,0 +1,22 @@ +'use strict'; + +const fs = require('fs'); + +const fileReader = module.exports = function(paths, callback){ + let buffers = []; + fs.readFile(paths[0], function(err, data){ + if (err) return callback(err); + buffers.push(data.toString('hex', 0, 7)); + + fs.readFile(paths[1], function(err, data){ + if (err) return callback(err); + buffers.push(data.toString('hex', 0, 7)); + + fs.readFile(paths[2], function(err, data){ + if (err) return callback(err); + buffers.push(data.toString('hex', 0, 7)); + console.log(buffers); + }); + }); + }); +}; From 6ee087a84a607c1d760397f9ca0becb27172d788 Mon Sep 17 00:00:00 2001 From: andyfiveeleven Date: Wed, 19 Jul 2017 15:37:57 -0700 Subject: [PATCH 3/5] got the hex to show up! on to tests next --- index.js | 6 ++++-- lib/file-reader.js | 8 ++++---- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/index.js b/index.js index 76ff7cf..249ba9b 100644 --- a/index.js +++ b/index.js @@ -1,10 +1,12 @@ 'use strict'; -const readFiles = require('lib/file-reader.js'); +const readFiles = require('./lib/file-reader.js'); const paths = [ `${__dirname}/assets/one.txt`, `${__dirname}/assets/two.txt`, `${__dirname}/assets/three.txt` ] -readFiles(paths); +readFiles(paths, function(err, data){ + console.log('Some data:', data); +}); diff --git a/lib/file-reader.js b/lib/file-reader.js index b0798c1..a92c6e6 100644 --- a/lib/file-reader.js +++ b/lib/file-reader.js @@ -6,16 +6,16 @@ const fileReader = module.exports = function(paths, callback){ let buffers = []; fs.readFile(paths[0], function(err, data){ if (err) return callback(err); - buffers.push(data.toString('hex', 0, 7)); + buffers.push(data.toString('hex', 0, 8)); fs.readFile(paths[1], function(err, data){ if (err) return callback(err); - buffers.push(data.toString('hex', 0, 7)); + buffers.push(data.toString('hex', 0, 8)); fs.readFile(paths[2], function(err, data){ if (err) return callback(err); - buffers.push(data.toString('hex', 0, 7)); - console.log(buffers); + buffers.push(data.toString('hex', 0, 8)); + return callback(null, buffers); }); }); }); From e0b33ddbed1222d6ade44d49ddb66701e926fbc7 Mon Sep 17 00:00:00 2001 From: andyfiveeleven Date: Wed, 19 Jul 2017 15:54:35 -0700 Subject: [PATCH 4/5] finished testing paths, watch out for the ..'s in your file paths! --- index.js | 2 +- test/file-reader-test.js | 31 +++++++++++++++++++++++++++++++ 2 files changed, 32 insertions(+), 1 deletion(-) create mode 100644 test/file-reader-test.js diff --git a/index.js b/index.js index 249ba9b..5a3fa94 100644 --- a/index.js +++ b/index.js @@ -5,7 +5,7 @@ const paths = [ `${__dirname}/assets/one.txt`, `${__dirname}/assets/two.txt`, `${__dirname}/assets/three.txt` -] +]; readFiles(paths, function(err, data){ console.log('Some data:', data); diff --git a/test/file-reader-test.js b/test/file-reader-test.js new file mode 100644 index 0000000..bd5c944 --- /dev/null +++ b/test/file-reader-test.js @@ -0,0 +1,31 @@ +'use strict'; + +const expect = require('chai').expect; +const fileReader = require('../lib/file-reader.js'); + +describe('file reading module', function(){ + describe('bad file path', function(){ + it('should give an error', function(done){ + fileReader(`${__dirname}/bad-file.txt`, function(err){ + expect(err).to.be.a('error'); + done(); + }); + }); + }); + + describe('Good path and data', function(){ + it('should return wierd numbers, ending in 78, 65, 78', function(done){ + let paths = [ + `${__dirname}/../assets/one.txt`, + `${__dirname}/../assets/two.txt`, + `${__dirname}/../assets/three.txt` + ]; + fileReader(paths, function(err, data){ + expect(err).to.equal(null); + expect(data).to.be.an('array'); + expect(data).to.deep.equal([ '5468697320746578', '54686973206f6e65', '5468697320746578' ]); + done(); + }); + }); + }); +}); From d3100b776ca4c93065a05d7e2045a170933b48e4 Mon Sep 17 00:00:00 2001 From: andyfiveeleven Date: Thu, 20 Jul 2017 11:31:49 -0700 Subject: [PATCH 5/5] readme formatting fix --- README.md | 46 +--------------------------------------------- 1 file changed, 1 insertion(+), 45 deletions(-) diff --git a/README.md b/README.md index 8cc8c11..787e9ce 100644 --- a/README.md +++ b/README.md @@ -1,45 +1 @@ -![CF](https://camo.githubusercontent.com/70edab54bba80edb7493cad3135e9606781cbb6b/687474703a2f2f692e696d6775722e636f6d2f377635415363382e706e67) 04: Parallel File Processing -=== - -## 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 - -## 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 - -## 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 +Done kicks us out of the test because we're working asynchronously.