From deb8ad42883729a0f13f4e96f51f37e60e6dd551 Mon Sep 17 00:00:00 2001 From: andyfiveeleven Date: Mon, 17 Jul 2017 13:48:35 -0700 Subject: [PATCH 1/8] added config files --- .eslintignore | 5 ++ .eslintrc | 22 ++++++++ .gitignore | 136 ++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 163 insertions(+) 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..9fff93a --- /dev/null +++ b/.eslintrc @@ -0,0 +1,22 @@ + +{ + "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 From 903c0668f111a8fe0e0aff47bee237781d20d226 Mon Sep 17 00:00:00 2001 From: andyfiveeleven Date: Mon, 17 Jul 2017 13:52:53 -0700 Subject: [PATCH 2/8] added files, nocontent in them yet --- lib/arithmetic.js | 0 lib/greet.js | 0 test/arithmetic-test.js | 0 test/greet-test.js | 0 4 files changed, 0 insertions(+), 0 deletions(-) create mode 100644 lib/arithmetic.js create mode 100644 lib/greet.js create mode 100644 test/arithmetic-test.js create mode 100644 test/greet-test.js 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 new file mode 100644 index 0000000..e69de29 diff --git a/test/arithmetic-test.js b/test/arithmetic-test.js new file mode 100644 index 0000000..e69de29 diff --git a/test/greet-test.js b/test/greet-test.js new file mode 100644 index 0000000..e69de29 From f6694f0a4398fb2b52c9481adefbefe7c39d23ea Mon Sep 17 00:00:00 2001 From: andyfiveeleven Date: Mon, 17 Jul 2017 14:01:43 -0700 Subject: [PATCH 3/8] wrote them methods --- lib/arithmetic.js | 13 +++++++++++++ lib/greet.js | 6 ++++++ 2 files changed, 19 insertions(+) diff --git a/lib/arithmetic.js b/lib/arithmetic.js index e69de29..073dadb 100644 --- a/lib/arithmetic.js +++ b/lib/arithmetic.js @@ -0,0 +1,13 @@ +'use strict'; + +module.exports = exports = {}; + +exports.add = function(num1, num2){ + if(typeof num1 !== 'number' || typeof num2 !== 'number') return 'not a number'; + return num1 + num2; +}; + +exports.sub = function(num1, num2){ + if(typeof num1 !== 'number' || typeof num2 !== 'number') return 'not a number'; + return num1 - num2; +}; diff --git a/lib/greet.js b/lib/greet.js index e69de29..0c124d6 100644 --- a/lib/greet.js +++ b/lib/greet.js @@ -0,0 +1,6 @@ +'use strict'; + +module.exports = function(name){ + if(typeof name !== 'string') return null; + return `hello ${name}!`; +}; From 8ec35bf5322eacb136c682f90f5286d1572aecfe Mon Sep 17 00:00:00 2001 From: andyfiveeleven Date: Mon, 17 Jul 2017 14:13:17 -0700 Subject: [PATCH 4/8] greet test done --- test/greet-test.js | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/test/greet-test.js b/test/greet-test.js index e69de29..18795b3 100644 --- a/test/greet-test.js +++ 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 result = greet('world'); + assert.ok(result === 'hello world!', 'not equal to hello world!'); + }); + // it('should throw not a string error', function(){ + // assert.throws(function(){ + // greet(); + // }, 'error not thrown'); + // }); + }); +}); From f3af6fdf4b9555565293e3f261d55bded75dcf02 Mon Sep 17 00:00:00 2001 From: andyfiveeleven Date: Mon, 17 Jul 2017 14:18:51 -0700 Subject: [PATCH 5/8] added math test --- test/arithmetic-test.js | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/test/arithmetic-test.js b/test/arithmetic-test.js index e69de29..cacf519 100644 --- a/test/arithmetic-test.js +++ b/test/arithmetic-test.js @@ -0,0 +1,19 @@ +'use strict'; + +const arithmetic = require('../lib/arithmetic.js'); +const assert = require('assert'); + +describe('Arithmetic Module', function(){ + describe('#add', function(){ + it('should return 5', function(){ + var result = arithmetic.add(2,3); + assert.ok(result === 5, 'you fucked up'); + }); + }); + describe('#sub', function(){ + it('should return 1', function(){ + var result = arithmetic.sub(3,2); + assert.ok(result === 1, 'you fucked up'); + }); + }); +}); From 27b19bdf6c03c7e6f8776037f069efdea5575d9f Mon Sep 17 00:00:00 2001 From: andyfiveeleven Date: Mon, 17 Jul 2017 14:22:33 -0700 Subject: [PATCH 6/8] greet test stretch goal --- test/greet-test.js | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/test/greet-test.js b/test/greet-test.js index 18795b3..b3f4852 100644 --- a/test/greet-test.js +++ b/test/greet-test.js @@ -9,10 +9,9 @@ describe('Greet Module', function(){ var result = greet('world'); assert.ok(result === 'hello world!', 'not equal to hello world!'); }); - // it('should throw not a string error', function(){ - // assert.throws(function(){ - // greet(); - // }, 'error not thrown'); - // }); + it('should throw not a string error', function(){ + var result = greet(4); + assert.ok(result === null, 'error not thrown'); + }); }); }); From 95421b200a1d67b2547abbf75a8b3663dc091006 Mon Sep 17 00:00:00 2001 From: andyfiveeleven Date: Mon, 17 Jul 2017 14:27:37 -0700 Subject: [PATCH 7/8] modified readme --- README.md | 67 ++++++++++--------------------------------------------- 1 file changed, 12 insertions(+), 55 deletions(-) diff --git a/README.md b/README.md index 490cacb..74184c8 100644 --- a/README.md +++ b/README.md @@ -1,58 +1,15 @@ -![CF](https://camo.githubusercontent.com/70edab54bba80edb7493cad3135e9606781cbb6b/687474703a2f2f692e696d6775722e636f6d2f377635415363382e706e67) 01: Node Ecosystem -=== +# Greeting and Arithmetic -## 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 +There are two applications in this code, an applications that returns hello to any name entered, and an application that accomplishes some basic arithmetic (added or subtracting two numbers). -## Resources -* [node assert docs](https://nodejs.org/dist/latest-v4.x/docs/api/assert.html) -* [mocha docs](http://mochajs.org/#getting-started) +#how to run the hello application + -open your node.js repl + -run module.exports(your-name-goes-here) + -talk to your computer in excitement -## 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/** - 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 +#how to run the arithementic application + -open your node.js repl + -#Adding + -run module.exports.add(number1, number2) + -#subtracting + -run module.exports.sub(number1, number2) From 7a558ddcdac3de23d239e7830526ee7d1da5a678 Mon Sep 17 00:00:00 2001 From: andyfiveeleven Date: Mon, 17 Jul 2017 14:28:21 -0700 Subject: [PATCH 8/8] fixed the problems in readme --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 74184c8..95599b3 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,12 @@ There are two applications in this code, an applications that returns hello to any name entered, and an application that accomplishes some basic arithmetic (added or subtracting two numbers). -#how to run the hello application +# how to run the hello application -open your node.js repl -run module.exports(your-name-goes-here) -talk to your computer in excitement -#how to run the arithementic application +# how to run the arithementic application -open your node.js repl -#Adding -run module.exports.add(number1, number2)