Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
**/node_modules/*
**/vendor/*
**/*.min.js
**/coverage/*
**/build/*
21 changes: 21 additions & 0 deletions .eslintrc
Original file line number Diff line number Diff line change
@@ -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"
}
136 changes: 136 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -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
46 changes: 2 additions & 44 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,45 +1,3 @@
![CF](https://camo.githubusercontent.com/70edab54bba80edb7493cad3135e9606781cbb6b/687474703a2f2f692e696d6775722e636f6d2f377635415363382e706e67) 04: Parallel File Processing
===
#This project is a example of asynchronous coding using callback functions and tests to make sure that our data is in the proper order.

## 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

## 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
<!-- 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
##When using "done" in mocha callbacks you have to make sure to use it in the right code block or else you'll get a false positive for your tests. Also if your done call takes more than 2 seconds to load, a timeout error occurs.
1 change: 1 addition & 0 deletions assets/one.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
The back end is super fun!
1 change: 1 addition & 0 deletions assets/three.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
memetastic
1 change: 1 addition & 0 deletions assets/two.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
my name is Bret
26 changes: 26 additions & 0 deletions index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
'use strict';

const fileReader = require('../lib/file-reader.js');

let testFunction = function(path, callback) {
let arr = [];
fileReader(`${__dirname}/assets/one.txt`, function(err, data) {
if (err) throw err;
console.log('content of my file:1', data.toString());
arr.push(data.toString());

fileReader(`${__dirname}/assets/two.txt`, function(err, data) {
if (err) throw err;
console.log('content of my file:2', data.toString());
arr.push(data.toString());

fileReader(`${__dirname}/assets/three.txt`, function(err, data) {
if (err) throw err;
console.log('content of my file:3', data.toString());
arr.push(data.toString());
callback();
});
});
});
};
testFunction();
11 changes: 11 additions & 0 deletions lib/file-reader.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
'use strict';

const fs = require('fs');

const fileReader = module.exports = function(file, callback) {//eslint-disable-line
fs.readFile(file, function(err, data) {
if (err) return callback(err);
console.log(data.toString('hex', 0, 8));
return callback(null, data.toString());
});
};
28 changes: 28 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
{
"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",
"lint": "eslint ."
},
"repository": {
"type": "git",
"url": "git+https://github.com/bretladenburg/03-parallel_file_system.git"
},
"keywords": [],
"author": "",
"license": "ISC",
"bugs": {
"url": "https://github.com/bretladenburg/03-parallel_file_system/issues"
},
"homepage": "https://github.com/bretladenburg/03-parallel_file_system#readme",
"devDependencies": {
"chai": "^4.1.0",
"mocha": "^3.4.2"
}
}
35 changes: 35 additions & 0 deletions test/file-reader-test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
'use strict';

const expect = require('chai').expect;
const fileReader = require('../lib/file-reader.js');

describe('File Reader Module', function() {
describe('with an improper file path', function() {
it('should return an error', function(done) {
fileReader(`${__dirname}/not-a-file.txt`, function(err) {
expect(err).to.be.an('error');
done();
});
});
});

describe('with a proper file path', function() {
it('should return the content in the file', function(done) {
fileReader(`${__dirname}/../assets/one.txt`, function(err, assets) {
expect(err).to.equal(null);
expect(assets).to.be.a('string');

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');
done();
});
});
});
});
});
});