From 24f9101b64a3cd5f726fae19f62686f7c06e961a Mon Sep 17 00:00:00 2001 From: sharmarke Date: Mon, 17 Jul 2017 14:34:14 -0700 Subject: [PATCH 1/6] added files --- lab-sharmarke/config/.eslintignore | 5 + lab-sharmarke/config/.eslintrc | 21 ++++ lab-sharmarke/config/.gitignore | 136 ++++++++++++++++++++++++++ lab-sharmarke/lib/arithmetic.js | 13 +++ lab-sharmarke/lib/greet.js | 6 ++ lab-sharmarke/test/arithmetic-test.js | 0 lab-sharmarke/test/greet-test.js | 14 +++ 7 files changed, 195 insertions(+) create mode 100644 lab-sharmarke/config/.eslintignore create mode 100644 lab-sharmarke/config/.eslintrc create mode 100644 lab-sharmarke/config/.gitignore create mode 100644 lab-sharmarke/lib/arithmetic.js create mode 100644 lab-sharmarke/lib/greet.js create mode 100644 lab-sharmarke/test/arithmetic-test.js create mode 100644 lab-sharmarke/test/greet-test.js diff --git a/lab-sharmarke/config/.eslintignore b/lab-sharmarke/config/.eslintignore new file mode 100644 index 0000000..05b1cf3 --- /dev/null +++ b/lab-sharmarke/config/.eslintignore @@ -0,0 +1,5 @@ +**/node_modules/* +**/vendor/* +**/*.min.js +**/coverage/* +**/build/* diff --git a/lab-sharmarke/config/.eslintrc b/lab-sharmarke/config/.eslintrc new file mode 100644 index 0000000..8dc6807 --- /dev/null +++ b/lab-sharmarke/config/.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/lab-sharmarke/config/.gitignore b/lab-sharmarke/config/.gitignore new file mode 100644 index 0000000..345130c --- /dev/null +++ b/lab-sharmarke/config/.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/lab-sharmarke/lib/arithmetic.js b/lab-sharmarke/lib/arithmetic.js new file mode 100644 index 0000000..d3f5583 --- /dev/null +++ b/lab-sharmarke/lib/arithmetic.js @@ -0,0 +1,13 @@ +'use strict'; + +module.exports = exports = {}; + +exports.add = function(a, b) { + if(isNaN(a) || isNaN(b) return 'Not a number!'); + return a + b; +} + +export.sub = function(a,b) { + if(isNaN(a) || isNaN(b) return 'Not a number!' + return a + b; +} diff --git a/lab-sharmarke/lib/greet.js b/lab-sharmarke/lib/greet.js new file mode 100644 index 0000000..fd76c3f --- /dev/null +++ b/lab-sharmarke/lib/greet.js @@ -0,0 +1,6 @@ +'use strict'; + +module.exports = function(name) { + if (!name) return null; + return `hello ${name}!`; +} diff --git a/lab-sharmarke/test/arithmetic-test.js b/lab-sharmarke/test/arithmetic-test.js new file mode 100644 index 0000000..e69de29 diff --git a/lab-sharmarke/test/greet-test.js b/lab-sharmarke/test/greet-test.js new file mode 100644 index 0000000..0bb9b8d --- /dev/null +++ b/lab-sharmarke/test/greet-test.js @@ -0,0 +1,14 @@ +'use strict'; + +const greet = require('../lib/greet.js'); +const assert = require('assert'); + +describe ('Greet Module', function() { + it('should return hello world!', function() { + var result = greet(world); + assert.ok(result ==='hello world!', 'not equal to hello world!'); + }); + it('should throw a missing name error', function() { + greet(); + },'error not thrown'); +}); From c140a61d747b993f316dc25c17fcdcc165a34d69 Mon Sep 17 00:00:00 2001 From: sharmarke Date: Mon, 17 Jul 2017 14:47:52 -0700 Subject: [PATCH 2/6] added testing --- lab-sharmarke/test/arithmetic-test.js | 18 ++++++++++++++++++ lab-sharmarke/test/greet-test.js | 2 +- 2 files changed, 19 insertions(+), 1 deletion(-) diff --git a/lab-sharmarke/test/arithmetic-test.js b/lab-sharmarke/test/arithmetic-test.js index e69de29..1a3fb09 100644 --- a/lab-sharmarke/test/arithmetic-test.js +++ b/lab-sharmarke/test/arithmetic-test.js @@ -0,0 +1,18 @@ +'use strict'; + +const arithmetic = required('../lib/arithmetic.js'); +const assert = require('assert'); + +describe('Arithmetic Module', function() { + describe('#add', function() { + it('should return 10', function() { + var results = arithmetic.add(5+5); + assert.ok(result === 10, 'you are wrong!'); + }); + }); + describe(#sub, function() { + it('should return 0', function() { + var results = arithmetic.sub(5-5); + assert.ok(result ===10, 'you are wrong!'); + }); + }); diff --git a/lab-sharmarke/test/greet-test.js b/lab-sharmarke/test/greet-test.js index 0bb9b8d..fcb68f2 100644 --- a/lab-sharmarke/test/greet-test.js +++ b/lab-sharmarke/test/greet-test.js @@ -5,7 +5,7 @@ const assert = require('assert'); describe ('Greet Module', function() { it('should return hello world!', function() { - var result = greet(world); + var result = greet('world'); assert.ok(result ==='hello world!', 'not equal to hello world!'); }); it('should throw a missing name error', function() { From 1259aa10ddf0c7952bdfafd6a5366620af1b6feb Mon Sep 17 00:00:00 2001 From: sharmarke Date: Mon, 17 Jul 2017 14:55:05 -0700 Subject: [PATCH 3/6] spelling errors --- lab-sharmarke/lib/arithmetic.js | 8 ++++---- lab-sharmarke/test/arithmetic-test.js | 11 ++++++----- 2 files changed, 10 insertions(+), 9 deletions(-) diff --git a/lab-sharmarke/lib/arithmetic.js b/lab-sharmarke/lib/arithmetic.js index d3f5583..fbe5b7a 100644 --- a/lab-sharmarke/lib/arithmetic.js +++ b/lab-sharmarke/lib/arithmetic.js @@ -3,11 +3,11 @@ module.exports = exports = {}; exports.add = function(a, b) { - if(isNaN(a) || isNaN(b) return 'Not a number!'); + if(isNaN(a) || isNaN(b)) return 'Not a number!'; return a + b; } -export.sub = function(a,b) { - if(isNaN(a) || isNaN(b) return 'Not a number!' - return a + b; +exports.sub = function(a,b) { + if(isNaN(a) || isNaN(b)) return 'Not a number!' + return a - b; } diff --git a/lab-sharmarke/test/arithmetic-test.js b/lab-sharmarke/test/arithmetic-test.js index 1a3fb09..f734d15 100644 --- a/lab-sharmarke/test/arithmetic-test.js +++ b/lab-sharmarke/test/arithmetic-test.js @@ -1,18 +1,19 @@ 'use strict'; -const arithmetic = required('../lib/arithmetic.js'); +const arithmetic = require('../lib/arithmetic.js'); const assert = require('assert'); describe('Arithmetic Module', function() { describe('#add', function() { it('should return 10', function() { - var results = arithmetic.add(5+5); + var result = arithmetic.add(5+5); assert.ok(result === 10, 'you are wrong!'); }); }); - describe(#sub, function() { + describe('#sub', function() { it('should return 0', function() { - var results = arithmetic.sub(5-5); - assert.ok(result ===10, 'you are wrong!'); + var result = arithmetic.sub(5-5); + assert.ok(result === 0, 'you are wrong!'); }); }); +}); From 31e934fa10deb70e41e05230766ac9315112b6eb Mon Sep 17 00:00:00 2001 From: sharmarke Date: Mon, 17 Jul 2017 15:01:29 -0700 Subject: [PATCH 4/6] all tests passed --- lab-sharmarke/lib/arithmetic.js | 4 ++-- lab-sharmarke/test/arithmetic-test.js | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/lab-sharmarke/lib/arithmetic.js b/lab-sharmarke/lib/arithmetic.js index fbe5b7a..a478def 100644 --- a/lab-sharmarke/lib/arithmetic.js +++ b/lab-sharmarke/lib/arithmetic.js @@ -7,7 +7,7 @@ exports.add = function(a, b) { return a + b; } -exports.sub = function(a,b) { - if(isNaN(a) || isNaN(b)) return 'Not a number!' +exports.sub = function(a, b) { + if(isNaN(a) || isNaN(b)) return 'Not a number!'; return a - b; } diff --git a/lab-sharmarke/test/arithmetic-test.js b/lab-sharmarke/test/arithmetic-test.js index f734d15..9c66b79 100644 --- a/lab-sharmarke/test/arithmetic-test.js +++ b/lab-sharmarke/test/arithmetic-test.js @@ -6,13 +6,13 @@ const assert = require('assert'); describe('Arithmetic Module', function() { describe('#add', function() { it('should return 10', function() { - var result = arithmetic.add(5+5); + var result = arithmetic.add(5, 5); assert.ok(result === 10, 'you are wrong!'); }); }); describe('#sub', function() { it('should return 0', function() { - var result = arithmetic.sub(5-5); + var result = arithmetic.sub(5, 5); assert.ok(result === 0, 'you are wrong!'); }); }); From 8fbd57b83fe8025987f38619f8963c6c6158cb08 Mon Sep 17 00:00:00 2001 From: sharmarke Date: Mon, 17 Jul 2017 19:39:28 -0700 Subject: [PATCH 5/6] readme added --- README.md | 62 +++---------------------------------------------------- 1 file changed, 3 insertions(+), 59 deletions(-) diff --git a/README.md b/README.md index a3aca54..542dd10 100644 --- a/README.md +++ b/README.md @@ -1,59 +1,3 @@ -![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 +## Greet and Arithmetic +### The greet.js file will output the 'Hello, + the name' passed in as a parameter when the function greet is invoke. +### The arithmetic.js file will do basic addition and subtraction. These two funciton both require 2 parameters. When the function is invoke and two parameters are passed into them and will add or subtract both numbers. From f6bdb9226e0f8002c19c44064cd1be3a9b7d8423 Mon Sep 17 00:00:00 2001 From: sharmarke Date: Mon, 17 Jul 2017 19:41:17 -0700 Subject: [PATCH 6/6] updated readme --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 542dd10..cba88d5 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,3 @@ ## Greet and Arithmetic -### The greet.js file will output the 'Hello, + the name' passed in as a parameter when the function greet is invoke. -### The arithmetic.js file will do basic addition and subtraction. These two funciton both require 2 parameters. When the function is invoke and two parameters are passed into them and will add or subtract both numbers. + The greet.js file will output the 'Hello, + the name' passed in as a parameter when the function greet is invoke. + The arithmetic.js file will do basic addition and subtraction. These two funciton both require 2 parameters. When the function is invoke and two parameters are passed into them and will add or subtract both numbers.