Sharmarke

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-` + `<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
+## How it works  
+This app will read a .txt file and log the 8byte hex code that is console.log'd.

lab-sharmarke/.eslintignore

@@ -0,0 +1,5 @@
+**/node_modules/*
+**/vendor/*
+**/*.min.js
+**/coverage/*
+**/build/*

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"
+}

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

lab-sharmarke/assets/one.txt

@@ -0,0 +1 @@
+some random text that is long

lab-sharmarke/assets/three.txt

@@ -0,0 +1 @@
+short af

lab-sharmarke/assets/two.txt

@@ -0,0 +1 @@
+kinda long but not

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

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));
+  });
+};

lab-sharmarke/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "lab-sharmarke",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "directories": {
+    "test": "test"
+  },
+  "scripts": {
+    "test": "mocha",
+    "lint": "eslint ."
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "chai": "^4.1.0",
+    "mocha": "^3.4.2"
+  }
+}

lab-sharmarke/test/file-reader-test.js

@@ -0,0 +1,34 @@
+'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 .txt files', 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();
+          });
+        });
+      });
+    });
+  });
+});