From 33df9f9eeeb816316b76445b5bb1a42bb30fede9 Mon Sep 17 00:00:00 2001 From: sharmarke Date: Wed, 19 Jul 2017 14:09:53 -0700 Subject: [PATCH 1/3] set up scaffold, lib, and tests --- lab-sharmarke/.eslintignore | 5 + lab-sharmarke/.eslintrc | 21 ++++ lab-sharmarke/.gitignore | 136 +++++++++++++++++++++++++ lab-sharmarke/assets/one.txt | 1 + lab-sharmarke/assets/three.txt | 1 + lab-sharmarke/assets/two.txt | 1 + lab-sharmarke/index.js | 20 ++++ lab-sharmarke/lib/file-reader.js | 11 ++ lab-sharmarke/package.json | 19 ++++ lab-sharmarke/test/file-reader-test.js | 37 +++++++ 10 files changed, 252 insertions(+) create mode 100644 lab-sharmarke/.eslintignore create mode 100644 lab-sharmarke/.eslintrc create mode 100644 lab-sharmarke/.gitignore create mode 100644 lab-sharmarke/assets/one.txt create mode 100644 lab-sharmarke/assets/three.txt create mode 100644 lab-sharmarke/assets/two.txt create mode 100644 lab-sharmarke/index.js create mode 100644 lab-sharmarke/lib/file-reader.js create mode 100644 lab-sharmarke/package.json create mode 100644 lab-sharmarke/test/file-reader-test.js diff --git a/lab-sharmarke/.eslintignore b/lab-sharmarke/.eslintignore new file mode 100644 index 0000000..05b1cf3 --- /dev/null +++ b/lab-sharmarke/.eslintignore @@ -0,0 +1,5 @@ +**/node_modules/* +**/vendor/* +**/*.min.js +**/coverage/* +**/build/* diff --git a/lab-sharmarke/.eslintrc b/lab-sharmarke/.eslintrc new file mode 100644 index 0000000..8dc6807 --- /dev/null +++ b/lab-sharmarke/.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/lab-sharmarke/.gitignore b/lab-sharmarke/.gitignore new file mode 100644 index 0000000..345130c --- /dev/null +++ b/lab-sharmarke/.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/lab-sharmarke/assets/one.txt b/lab-sharmarke/assets/one.txt new file mode 100644 index 0000000..4bcfe6b --- /dev/null +++ b/lab-sharmarke/assets/one.txt @@ -0,0 +1 @@ +some random text that is long diff --git a/lab-sharmarke/assets/three.txt b/lab-sharmarke/assets/three.txt new file mode 100644 index 0000000..e918404 --- /dev/null +++ b/lab-sharmarke/assets/three.txt @@ -0,0 +1 @@ +short af diff --git a/lab-sharmarke/assets/two.txt b/lab-sharmarke/assets/two.txt new file mode 100644 index 0000000..faa7978 --- /dev/null +++ b/lab-sharmarke/assets/two.txt @@ -0,0 +1 @@ +kinda long but not diff --git a/lab-sharmarke/index.js b/lab-sharmarke/index.js new file mode 100644 index 0000000..8d93617 --- /dev/null +++ b/lab-sharmarke/index.js @@ -0,0 +1,20 @@ +'use strict'; + +const fs = require('fs'); + +console.log('dirname:', __dirname); + +fs.readFile(`${__dirname}/assets/one.txt`, function(err, data) { + if (err) throw err; + console.log('og file:', data.toString()); + + fs.readFile(`${__dirname}/assets/two.txt`, function(err, data) { + if (err) throw err; + console.log('og file:', data.toString()); + + fs.readFile(`${__dirname}/assets/three.txt`, function(err, data) { + if (err) throw err; + console.log('og file:', data.toString()); + }); + }); +}); diff --git a/lab-sharmarke/lib/file-reader.js b/lab-sharmarke/lib/file-reader.js new file mode 100644 index 0000000..c904cce --- /dev/null +++ b/lab-sharmarke/lib/file-reader.js @@ -0,0 +1,11 @@ +'use strict'; + +const fs = require('fs'); + +const fileReader = module.exports = function(file, callback) { + fs.readFile(file, function(err, data) { + if(err) return callback(err); + console.log(data.toString('hex', 0, 8)); + return callback(null, data.toString('hex', 0, 8)); + }); +}; diff --git a/lab-sharmarke/package.json b/lab-sharmarke/package.json new file mode 100644 index 0000000..148ae6e --- /dev/null +++ b/lab-sharmarke/package.json @@ -0,0 +1,19 @@ +{ + "name": "lab-sharmarke", + "version": "1.0.0", + "description": "", + "main": "index.js", + "directories": { + "test": "test" + }, + "scripts": { + "test": "mocha" + }, + "keywords": [], + "author": "", + "license": "ISC", + "devDependencies": { + "chai": "^4.1.0", + "mocha": "^3.4.2" + } +} diff --git a/lab-sharmarke/test/file-reader-test.js b/lab-sharmarke/test/file-reader-test.js new file mode 100644 index 0000000..3b83001 --- /dev/null +++ b/lab-sharmarke/test/file-reader-test.js @@ -0,0 +1,37 @@ +'use strict'; + +const expect = require('chai').expect; +const fileReader = require('../lib/file-reader.js'); + +describe('File Reader Module', function() { + describe('improper file path', function() { + it('should return an error', function(done) { + fileReader(`${__dirname}/bruh.txt`, function(err) { + expect(err).to.be.an('error'); + done(); + }); + }); + }); + + describe('correct file path', function() { + it('should return the one.txt file', function(done) { + fileReader(`${__dirname}/../assets/one.txt`, function(err, assets) { + expect(err).to.equal(null); + expect(assets).to.be.a('string'); + it('should return the two.txt file', function(done) { + fileReader(`${__dirname}/../assets/two.txt`, function(err, assets) { + expect(err).to.equal(null); + expect(assets).to.be.a('string'); + it('should return the three.txt file', function(done) { + fileReader(`${__dirname}/../assets/three.txt`, function(err, assets) { + expect(err).to.equal(null); + expect(assets).to.be.a('string'); + }); + }); + }); + }); + }); + done(); + }); + }); +}); From 537456fb55dfb81fbd6a6b782223c83d59674ecc Mon Sep 17 00:00:00 2001 From: sharmarke Date: Wed, 19 Jul 2017 14:39:33 -0700 Subject: [PATCH 2/3] modified readme and refactored test --- lab-sharmarke/package.json | 3 ++- lab-sharmarke/test/file-reader-test.js | 19 ++++++++----------- 2 files changed, 10 insertions(+), 12 deletions(-) diff --git a/lab-sharmarke/package.json b/lab-sharmarke/package.json index 148ae6e..37a6c2c 100644 --- a/lab-sharmarke/package.json +++ b/lab-sharmarke/package.json @@ -7,7 +7,8 @@ "test": "test" }, "scripts": { - "test": "mocha" + "test": "mocha", + "lint": "eslint ." }, "keywords": [], "author": "", diff --git a/lab-sharmarke/test/file-reader-test.js b/lab-sharmarke/test/file-reader-test.js index 3b83001..3553e21 100644 --- a/lab-sharmarke/test/file-reader-test.js +++ b/lab-sharmarke/test/file-reader-test.js @@ -12,26 +12,23 @@ describe('File Reader Module', function() { }); }); }); - describe('correct file path', function() { - it('should return the one.txt file', function(done) { + it('should return the .txt files', function(done) { fileReader(`${__dirname}/../assets/one.txt`, function(err, assets) { expect(err).to.equal(null); expect(assets).to.be.a('string'); - it('should return the two.txt file', function(done) { - fileReader(`${__dirname}/../assets/two.txt`, function(err, assets) { + + fileReader(`${__dirname}/../assets/two.txt`, function(err, assets) { + expect(err).to.equal(null); + expect(assets).to.be.a('string'); + + fileReader(`${__dirname}/../assets/three.txt`, function(err, assets) { expect(err).to.equal(null); expect(assets).to.be.a('string'); - it('should return the three.txt file', function(done) { - fileReader(`${__dirname}/../assets/three.txt`, function(err, assets) { - expect(err).to.equal(null); - expect(assets).to.be.a('string'); - }); - }); + done(); }); }); }); - done(); }); }); }); From 5f52c6d066531ce12c883806cb2021cd3cc5b4cf Mon Sep 17 00:00:00 2001 From: sharmarke Date: Wed, 19 Jul 2017 14:51:11 -0700 Subject: [PATCH 3/3] removed ds_store --- README.md | 41 ++--------------------------------------- 1 file changed, 2 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index 8cc8c11..f8c2642 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,8 @@ -![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 +## How it works +This app will read a .txt file and log the 8byte hex code that is console.log'd.