diff --git a/.README.md b/.README.md new file mode 100644 index 0000000..8cc8c11 --- /dev/null +++ b/.README.md @@ -0,0 +1,45 @@ +![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 diff --git a/.eslintignore b/.eslintignore new file mode 100644 index 0000000..82ff623 --- /dev/null +++ b/.eslintignore @@ -0,0 +1,5 @@ +**/node_modules/* +**/vendor/* +**/*.min.js +**/coverage/* +**/build/* \ No newline at end of file diff --git a/.eslintrc b/.eslintrc new file mode 100644 index 0000000..b663d77 --- /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" +} \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..393ef53 --- /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 \ No newline at end of file diff --git a/README.md b/README.md index 8cc8c11..abe47c2 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,4 @@ -![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 +# Got some texts completed + + +#### For some async functions you need this so you can stop the function from timing out and an anonymous function doesnt give this command. \ No newline at end of file diff --git a/assets/one.txt b/assets/one.txt new file mode 100644 index 0000000..70da150 --- /dev/null +++ b/assets/one.txt @@ -0,0 +1 @@ +One Word \ No newline at end of file diff --git a/assets/three.txt b/assets/three.txt new file mode 100644 index 0000000..bb52782 --- /dev/null +++ b/assets/three.txt @@ -0,0 +1 @@ +Even more words then two.txt we need this so the processes finish in order one.txt, two.txt, three.txt. \ No newline at end of file diff --git a/assets/two.txt b/assets/two.txt new file mode 100644 index 0000000..6f43899 --- /dev/null +++ b/assets/two.txt @@ -0,0 +1 @@ +Some more words then the One.text \ No newline at end of file diff --git a/index.js b/index.js new file mode 100644 index 0000000..e69de29 diff --git a/lib/read-assets.js b/lib/read-assets.js new file mode 100644 index 0000000..9a2c164 --- /dev/null +++ b/lib/read-assets.js @@ -0,0 +1,20 @@ +'use strict'; + +const fs = require('fs'); + +const assets = module.exports.assets = []; + +const readAssets = module.exports.readAssets = (file, callback) => { + fs.readFile(file, function(err, data) { + if (err) return callback(err); + data.dateAdded = new Date(); + assets.push({asset: data.toString(), date: new Date()}) +// console.log(assets) + return callback(null, data.slice(0, 8).toString()); +}); +} + +const sortAssets = module.exports.sortAssets = (arr) => { + Object.keys(assets).sort(function(a,b){return assets[a]-assets[b]}) + console.log(assets) +}; \ No newline at end of file diff --git a/package.json b/package.json new file mode 100644 index 0000000..fdb75d3 --- /dev/null +++ b/package.json @@ -0,0 +1,26 @@ +{ + "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/JohnScarrow/03-parallel_file_system.git" + }, + "author": "", + "license": "ISC", + "bugs": { + "url": "https://github.com/JohnScarrow/03-parallel_file_system/issues" + }, + "homepage": "https://github.com/JohnScarrow/03-parallel_file_system#readme", + "devDependencies": { + "chai": "^4.1.0", + "mocha": "^3.4.2" + } +} diff --git a/test/read-asserts-test.js b/test/read-asserts-test.js new file mode 100644 index 0000000..4f2ed09 --- /dev/null +++ b/test/read-asserts-test.js @@ -0,0 +1,39 @@ +'use strict'; + +const expect = require('chai').expect; +const readAssets = require('../lib/read-assets.js'); +const assets = module.exports.assets = []; + + +describe('Read assets', function() { + describe('is trying to find a file path to', function() { + it('one.txt', function(done) { + readAssets.readAssets(`${__dirname}/../assets/one.txt`, function(err) { + expect(err).to.not.be.an('error'); + done(); + }); + }); + it('two.txt', function(done) { + readAssets.readAssets(`${__dirname}/../assets/two.txt`, function(err) { + expect(err).to.not.be.an('error'); + done(); + }); + }); + it('three.txt', function(done) { + readAssets.readAssets(`${__dirname}/../assets/three.txt`, function(err) { + expect(err).to.not.be.an('error'); + done(); + console.log(readAssets.assets) + }); + }); + }); + describe('was loaded in the right order', () => { + it('assets loaded', () =>{ + readAssets.readAssets(`${__dirname}/../assets/one.txt`); + readAssets.readAssets(`${__dirname}/../assets/two.txt`); + readAssets.readAssets(`${__dirname}/../assets/three.txt`); + expect(assets).to.have.ordered.members( + Object.keys(assets).sort(function(a,b){return assets[a]-assets[b]})) + }) + }) +}); \ No newline at end of file