From 7fa28d786e4aa7b88f03836988645499f14883d8 Mon Sep 17 00:00:00 2001 From: Jamesbillard12 Date: Mon, 17 Jul 2017 13:17:41 -0700 Subject: [PATCH 1/8] added most of the dirs and files needed --- lib/greet.js | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 lib/greet.js diff --git a/lib/greet.js b/lib/greet.js new file mode 100644 index 0000000..e69de29 From 5896e1c9b12dff348bca5764029d3a5dfe48a5c5 Mon Sep 17 00:00:00 2001 From: Jamesbillard12 Date: Mon, 17 Jul 2017 13:46:16 -0700 Subject: [PATCH 2/8] got the greet module to work --- index.js | 5 +++++ lib/arithmetic.js | 0 lib/greet.js | 9 +++++++++ test/greet-test.js | 18 ++++++++++++++++++ 4 files changed, 32 insertions(+) create mode 100644 index.js create mode 100644 lib/arithmetic.js create mode 100644 test/greet-test.js diff --git a/index.js b/index.js new file mode 100644 index 0000000..1f47bb4 --- /dev/null +++ b/index.js @@ -0,0 +1,5 @@ +'use strict'; + +const greet = require('./lib/greet.js'); + +greet.greet('world'); diff --git a/lib/arithmetic.js b/lib/arithmetic.js new file mode 100644 index 0000000..e69de29 diff --git a/lib/greet.js b/lib/greet.js index e69de29..de6171a 100644 --- a/lib/greet.js +++ b/lib/greet.js @@ -0,0 +1,9 @@ +'use strict'; + +module.exports = exports = {}; + +exports.greet = function(name){ + if (arguments.length === 0) throw new Error ('name not provided'); + return `hello ${name}!`; + console.log(`hello ${name}`); +} diff --git a/test/greet-test.js b/test/greet-test.js new file mode 100644 index 0000000..f74e73c --- /dev/null +++ b/test/greet-test.js @@ -0,0 +1,18 @@ +'use strict'; + +const greet = require('../lib/greet.js'); +const assert = require('assert'); + +describe('Greet Module', function(){ + describe('#greet', function(){ + it('should return hello world!', function(){ + var greetResult = greet.greet('world'); + assert.ok(greetResult === 'hello world!', 'not equal to hey james!') + }); + it('should throw a missing name error', function(){ + assert.throws(function(){ + greet.greet(); + }, 'error not thrown') + }); + }); +}); From 45871a424685d89df2ff38c965b0b062141b2176 Mon Sep 17 00:00:00 2001 From: Jamesbillard12 Date: Mon, 17 Jul 2017 14:13:12 -0700 Subject: [PATCH 3/8] both greet and rithmetic test true --- lib/arithmetic.js | 12 ++++++++++++ test/arithmetic-test.js | 29 +++++++++++++++++++++++++++++ 2 files changed, 41 insertions(+) create mode 100644 test/arithmetic-test.js diff --git a/lib/arithmetic.js b/lib/arithmetic.js index e69de29..a4f3598 100644 --- a/lib/arithmetic.js +++ b/lib/arithmetic.js @@ -0,0 +1,12 @@ +'use strict'; +module.exports = exports = {}; + +exports.add = function(num1, num2){ + if(arguments.length === 0) throw new Error ('add no numbers provided'); + return num1 + num2; +}; + +exports.sub = function(num1, num2){ + if (arguments.length === 0) throw new Error ('sub no numbers provided') + return num1 - num2; +}; diff --git a/test/arithmetic-test.js b/test/arithmetic-test.js new file mode 100644 index 0000000..d06b9cf --- /dev/null +++ b/test/arithmetic-test.js @@ -0,0 +1,29 @@ +'use strict'; + +const arithmetic = require('../lib/arithmetic.js') +const assert = require('assert'); + +describe('Arithmetic Module', function(){ + describe('#add', function(){ + it('should return 4', function(){ + var add = arithmetic.add(2, 2); + assert.ok(add === 4, 'not equal to 4'); + }); + it('should throw a missing number error', function(){ + assert.throws(function(){ + arithmetic.add(); + }, 'error not thrown') + }); + }); + describe('#sub', function(){ + it('should return 2', function(){ + var sub = arithmetic.sub(4, 2); + assert.ok(sub === 2, 'not equal to 2'); + }); + it('should throw a missing number error', function(){ + assert.throws(function(){ + arithmetic.sub(); + }, 'error not thrown') + }); + }); +}) From ce8f92b3aa9038db915ce223370537fde340e3b1 Mon Sep 17 00:00:00 2001 From: Jamesbillard12 Date: Mon, 17 Jul 2017 14:27:58 -0700 Subject: [PATCH 4/8] added the needed files --- .eslintignore | 5 ++ .eslintrc | 21 ++++++++ .gitignore | 136 ++++++++++++++++++++++++++++++++++++++++++++++++++ lib/greet.js | 2 +- 4 files changed, 163 insertions(+), 1 deletion(-) create mode 100644 .eslintignore create mode 100644 .eslintrc create mode 100644 .gitignore diff --git a/.eslintignore b/.eslintignore new file mode 100644 index 0000000..05b1cf3 --- /dev/null +++ b/.eslintignore @@ -0,0 +1,5 @@ +**/node_modules/* +**/vendor/* +**/*.min.js +**/coverage/* +**/build/* diff --git a/.eslintrc b/.eslintrc new file mode 100644 index 0000000..8dc6807 --- /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" +} diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..345130c --- /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 diff --git a/lib/greet.js b/lib/greet.js index de6171a..d605cac 100644 --- a/lib/greet.js +++ b/lib/greet.js @@ -4,6 +4,6 @@ module.exports = exports = {}; exports.greet = function(name){ if (arguments.length === 0) throw new Error ('name not provided'); - return `hello ${name}!`; console.log(`hello ${name}`); + return `hello ${name}!`; } From 5f54ac32933781bf82c8d285583d28dd39de27da Mon Sep 17 00:00:00 2001 From: Jamesbillard12 Date: Mon, 17 Jul 2017 14:32:45 -0700 Subject: [PATCH 5/8] added math to index.js file --- index.js | 4 ++++ lib/arithmetic.js | 4 +++- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/index.js b/index.js index 1f47bb4..d93e914 100644 --- a/index.js +++ b/index.js @@ -1,5 +1,9 @@ 'use strict'; const greet = require('./lib/greet.js'); +const arithmetic = require('./lib/arithmetic.js') greet.greet('world'); + +arithmetic.add(2, 2); +arithmetic.sub(4, 2); diff --git a/lib/arithmetic.js b/lib/arithmetic.js index a4f3598..8a4419d 100644 --- a/lib/arithmetic.js +++ b/lib/arithmetic.js @@ -3,10 +3,12 @@ module.exports = exports = {}; exports.add = function(num1, num2){ if(arguments.length === 0) throw new Error ('add no numbers provided'); + console.log(num1 + num2); return num1 + num2; }; exports.sub = function(num1, num2){ - if (arguments.length === 0) throw new Error ('sub no numbers provided') + if (arguments.length === 0) throw new Error ('sub no numbers provided'); + console.log(num1 - num2); return num1 - num2; }; From 5c6474d3aedffb9d570fc48acae15db32330fa7a Mon Sep 17 00:00:00 2001 From: Jamesbillard12 Date: Mon, 17 Jul 2017 14:59:02 -0700 Subject: [PATCH 6/8] finished both bonuses --- test/arithmetic-test.js | 12 ++++++++++++ test/greet-test.js | 8 +++++++- 2 files changed, 19 insertions(+), 1 deletion(-) diff --git a/test/arithmetic-test.js b/test/arithmetic-test.js index d06b9cf..1512d34 100644 --- a/test/arithmetic-test.js +++ b/test/arithmetic-test.js @@ -14,6 +14,12 @@ describe('Arithmetic Module', function(){ arithmetic.add(); }, 'error not thrown') }); + it('should return NaN if numbers were not used', function(){ + assert.throws(function(){ + var addnan = arithmetic.add('dog', 'cat'); + assert.ok(addnan === NaN, 'not equal to NaN') + }) + }); }); describe('#sub', function(){ it('should return 2', function(){ @@ -25,5 +31,11 @@ describe('Arithmetic Module', function(){ arithmetic.sub(); }, 'error not thrown') }); + it('should return NaN if numbers were not used', function(){ + assert.throws(function(){ + var subnan = arithmetic.sub('dog', 'cat'); + assert.ok(subnan === NaN, 'not equal to NaN') + }) + }); }); }) diff --git a/test/greet-test.js b/test/greet-test.js index f74e73c..a57a70f 100644 --- a/test/greet-test.js +++ b/test/greet-test.js @@ -7,12 +7,18 @@ describe('Greet Module', function(){ describe('#greet', function(){ it('should return hello world!', function(){ var greetResult = greet.greet('world'); - assert.ok(greetResult === 'hello world!', 'not equal to hey james!') + assert.ok(greetResult === 'hello world!', 'not equal to hello world!') }); it('should throw a missing name error', function(){ assert.throws(function(){ greet.greet(); }, 'error not thrown') }); + it('should return null if not a string', function(){ + assert.throws(function(){ + var greetnull = greet.greet(6); + assert.ok(greetnull === null, 'not equal to null') + }) + }) }); }); From 0e572670c0a80f501a61293c8cee9ed0c58d5ba0 Mon Sep 17 00:00:00 2001 From: Jamesbillard12 Date: Mon, 17 Jul 2017 15:03:06 -0700 Subject: [PATCH 7/8] finished all tests --- test/arithmetic-test.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/arithmetic-test.js b/test/arithmetic-test.js index 1512d34..ff503aa 100644 --- a/test/arithmetic-test.js +++ b/test/arithmetic-test.js @@ -33,7 +33,7 @@ describe('Arithmetic Module', function(){ }); it('should return NaN if numbers were not used', function(){ assert.throws(function(){ - var subnan = arithmetic.sub('dog', 'cat'); + var subnan = arithmetic.sub('cat', 'dog'); assert.ok(subnan === NaN, 'not equal to NaN') }) }); From 25c23e96bcceb56d733c8fc648c82cefaea9abc2 Mon Sep 17 00:00:00 2001 From: Jamesbillard12 Date: Mon, 17 Jul 2017 15:12:01 -0700 Subject: [PATCH 8/8] added info to read me --- README.md | 64 +++++-------------------------------------------------- 1 file changed, 5 insertions(+), 59 deletions(-) diff --git a/README.md b/README.md index a3aca54..9e4a2e4 100644 --- a/README.md +++ b/README.md @@ -1,59 +1,5 @@ -![CF](https://camo.githubusercontent.com/70edab54bba80edb7493cad3135e9606781cbb6b/687474703a2f2f692e696d6775722e636f6d2f377635415363382e706e67) 01: Node Ecosystem -=== - -## Submission Instructions - * work in a fork of this repository - * work in a branch on your fork - * write all of your code in a directory named `lab-` + `` **e.g.** `lab-susan` - * submit a pull request to this repository - * submit a link to your pull request on canvas - * submit a question, observation, and how long you spent on canvas - -## Resources -* [node assert docs](https://nodejs.org/dist/latest-v4.x/docs/api/assert.html) -* [mocha docs](http://mochajs.org/#getting-started) - -## 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 - * **.package.json** - contains all necessary dependencies and developer dependencies - * **lib/** - should contain your modules - * **test/** - should contain your unit tests - -#### Feature Tasks -* create a node.js module (`greet.js`) that exports a single function - * the `greet` function should have a single parameter that should expect a string as it's input - * the `greet` function should return the input name, concatenated with "hello " - * the `greet` function should return `null` if the input is not a string -* create a node.js module named `arithmetic.js` - * this module should have `add` and `sub` methods - * the `add` method should contain 2 parameters - * these parameters should be numbers and the method should return the sum of the 2 numbers - * the `sub` method should contain 2 parameters - * these parameters should be numbers and the method should return the first number minus the second number -* decide on the expected behavior for non-number inputs - -#### Testing -* write a test the expects the greet module to return "hello world!" - * this should happen when invoked with "world!" as a parameter -* write a test for the `add` and `subtract` methods on the arithmetic module - * this should ensure that your functions work with number inputs - -#### Documentation -* write a description of your project (this should be in your `README.md` file) - -###### BONUS 1pt -* write a test that expects the greet module to return null when you use non string values -* write a test that ensures the functions work as expected with non number inputs - -## Rubric -* 2pts configuration -* 3pts feature tasks -* 3pts tests -* 2pts documentation +## Lab-james Documentation + * index.js calls functions ./lib/greet.js and ./lib/arithmetic.js functions only accepting proper parameters + * greet.js returns 'null' if anything other than a string is passed in. + * arithmetic.js returns 'a is NaN!', etc. if a or b is not passed in an integer in either the arithmetic.add or arithmetic.sub methods. + * arithmetic-test.js and greet-test.js test the above functionality.