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"
}
138 changes: 138 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@

# Created by https://www.gitignore.io/api/vim,node,macos,linux,microsoftoffice

### Linux ###
*~

# temporary files which can be created if a process still has a handle open of a deleted file
.fuse_hidden*

# KDE directory preferences
.directory

# Linux trash folder which might appear on any partition or disk
.Trash-*

# .nfs files are created when an open file is removed but is still being accessed
.nfs*

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

### MicrosoftOffice ###
*.tmp

# Word temporary
~$*.doc*

# Excel temporary
~$*.xls*

# Excel Backup File
*.xlk

# PowerPoint temporary
~$*.ppt*

# Visio autosave temporary files
*.~vsd*

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


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

# End of https://www.gitignore.io/api/vim,node,macos,linux,microsoftoffice
48 changes: 6 additions & 42 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,45 +1,9 @@
![CF](https://camo.githubusercontent.com/70edab54bba80edb7493cad3135e9606781cbb6b/687474703a2f2f692e696d6775722e636f6d2f377635415363382e706e67) 04: Parallel File Processing
===
#### What this app does!
* Converts a .txt file into hex and obtains the first 8 and logs it to the console.

## 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
#### What is going on.
* This code is ran asynchronously.

## 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
* This app uses Node Modules and a File System alongside a dev help tool of mocha and chai to read through text, run a test, and verify that our code is working.

## 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
* Tests are used by callback functions and is used by done(). Mocha uses done() so that the test know it is completed.
1 change: 1 addition & 0 deletions assets/one.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
this text has one a really really really really really really really really really really really really long message
1 change: 1 addition & 0 deletions assets/three.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
shortest
1 change: 1 addition & 0 deletions assets/two.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
hello, from the other side
12 changes: 12 additions & 0 deletions index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
'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, function(err, data) {
console.log('my data:', data);
});
23 changes: 23 additions & 0 deletions lib/file-reader.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
'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 , 8));

fs.readFile(paths[1], function(err, data) {
if(err) return callback(err);
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 , 8));
return callback(null, buffers);
});
});
});
};
29 changes: 29 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -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": {
"start": "index.js",
"test": "mocha",
"lint": "eslint ."
},
"repository": {
"type": "git",
"url": "git+https://github.com/Loaye/03-parallel_file_system.git"
},
"keywords": [],
"author": "",
"license": "ISC",
"bugs": {
"url": "https://github.com/Loaye/03-parallel_file_system/issues"
},
"homepage": "https://github.com/Loaye/03-parallel_file_system#readme",
"devDependencies": {
"chai": "^4.1.0",
"mocha": "^3.4.2"
}
}
31 changes: 31 additions & 0 deletions test/file-reader-test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
'use strict';

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

describe('File Reader', function() {
describe('with 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 proper file paths and data', function() {
it('should return: 7468697320746578, 68656c6c6f2c2066, 73686f7274657374', 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([ '7468697320746578', '68656c6c6f2c2066', '73686f7274657374' ]);
done();
});
});
});
});