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/README.md b/README.md index 67e3b00..688ad7c 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,20 @@ -![cf](https://i.imgur.com/7v5ASc8.png) 02: Tools and Context -====== +# Functional Programming and Standalone Functions -## To Submit this Assignment - * fork this repository & create a new branch for your work - * write all of your code in a directory named `lab-` + `` **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 +This lab focuses on creating standalone functions of Array prototype methods and using ChaiJS to implement BDD/TDD styles to testing. -## Directions - * create a `/lib` and `/test` directory - * add a robust `.gitignore` file - * include a `package.json` - * include the provided `.eslintrc` file - * create a `lint` script for running eslint - * create a `test` script for running mocha - * create a `lib/fp.js` file for holding the following: - * create stand alone `map`, `filter`, `reduce`, `concat`, and `splice` functions using the `call`, and `apply` methods we discussed today - * you are welcome to use/experiment with `bind` too! - * *note:* - all functions should be created using the es6 lexical arrow function syntax +## Methods -# Tests - * create a test for each of your custom functions in `lib/fp.js` - * note - feel free to create additional tests, if you choose! +### Map +Applies a function on each element of an array -## Bonus 2pts - * create a CLI (`index.js`) that will use your new `map` function to uppercase all command line arguments and print them to the screen: 1pt - * **hint:** - you'll want to check out the `process` object (and it's methods) to get an array of provided command line arguments - * test your CLI: 1pt +### Filter +Predicate applied to each element, returns new array of true values + +### Concat +Joins two arrays + +### Splice +Manipulates array by inserting or deleting at a specific index. Returns manipulated array. + +### Reduce +Sums values in an array diff --git a/index.js b/index.js new file mode 100644 index 0000000..35fc8fd --- /dev/null +++ b/index.js @@ -0,0 +1,9 @@ +'use strict'; + +module.exports = exports = {}; + +const fp = require('./lib/fp.js'); + +exports.upCase = arr => fp.map(arr, el => el.toUpperCase()); + +console.log(exports.upCase(process.argv)); diff --git a/lib/fp.js b/lib/fp.js new file mode 100644 index 0000000..5f25606 --- /dev/null +++ b/lib/fp.js @@ -0,0 +1,41 @@ +'use strict'; + +module.exports = exports = {}; + +exports.map = (arr, callback) => { + if (!arr) throw new Error('no array provided'); + if (!callback) throw new Error('no callback provided'); + + return Array.prototype.map.call(arr, callback); +}; + +exports.filter = (arr, callback) => { + if (!arr) throw new Error('no array provided'); + if (!callback) throw new Error('no callback provided'); + + return Array.prototype.filter.call(arr, callback); +}; + +exports.concat = (arr1, arr2) => { + if (!arr1) throw new Error('no array provided'); + if (!arr2) throw new Error('no array provided'); + + return Array.prototype.concat.apply(arr1, arr2); +}; + +exports.splice = (arr, start, deleteCount, item=[]) => { + if (!arr) throw new Error('no array provided'); + if (!start) throw new Error('no start provided'); + if (!item) throw new Error('item is undefined'); + if (typeof deleteCount !== 'number') throw new Error('no deleteCount provided'); + + Array.prototype.splice.call(arr, start, deleteCount, ...item); + return arr; +}; + +exports.reduce = (arr, callback, start=0) => { + if (!arr) throw new Error('no array provided'); + if (!callback) throw new Error('no callback provided'); + + return Array.prototype.reduce.call(arr, callback, start); +}; diff --git a/package.json b/package.json new file mode 100644 index 0000000..2d072eb --- /dev/null +++ b/package.json @@ -0,0 +1,29 @@ +{ + "name": "02-tools_and_context", + "version": "1.0.0", + "description": "![cf](https://i.imgur.com/7v5ASc8.png) 02: Tools and Context ======", + "main": "index.js", + "directories": { + "test": "test" + }, + "scripts": { + "start": "node index.js", + "test": "mocha", + "lint": "eslint .; exit 0" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/codefellows-javascript-401d17/02-tools_and_context.git" + }, + "keywords": [], + "author": "", + "license": "ISC", + "bugs": { + "url": "https://github.com/codefellows-javascript-401d17/02-tools_and_context/issues" + }, + "homepage": "https://github.com/codefellows-javascript-401d17/02-tools_and_context#readme", + "devDependencies": { + "chai": "^4.1.0", + "mocha": "^3.4.2" + } +} diff --git a/test/fp-test.js b/test/fp-test.js new file mode 100644 index 0000000..aa65329 --- /dev/null +++ b/test/fp-test.js @@ -0,0 +1,58 @@ +'use strict'; + +const fp = require('../lib/fp.js'); +const expect = require('chai').expect; + +describe('FP Module', () => { + describe('#map', () => { + it('should return [2, 4, 6, 8]', () => { + var result = fp.map([1, 2, 3, 4], (n) => n * 2); + expect(fp.map).to.be.a('function'); + expect(result).to.deep.equal([2, 4, 6, 8]); + }); + }); + + describe('#filter', () => { + it('should return [1, 3, 4]', () => { + var result = fp.filter([1, 2, 3, 4], n => n !== 2); + expect(fp.filter).to.be.a('function'); + expect(result).to.deep.equal([1, 3, 4]); + }); + }); + + describe('#concat', () => { + it('should return [1, 2, 3, a, b, c]', () => { + var result = fp.concat([1, 2, 3], ['a', 'b', 'c']); + expect(fp.concat).to.be.a('function'); + expect(result).to.deep.equal([1, 2, 3, 'a', 'b', 'c']); + }); + }); + + describe('#splice', () => { + it('should return [duck, duck, duck]', () => { + var result = fp.splice(['duck', 'duck', 'goose', 'duck'], 2, 1); + expect(fp.splice).to.be.a('function'); + expect(result).to.deep.equal(['duck', 'duck', 'duck']); + }); + + it('should return [duck0, duck1, oyster, duck2]', () => { + var result = fp.splice(['duck0', 'duck1', 'duck2'], 2, 0, ['oyster']); + expect(fp.splice).to.be.a('function'); + expect(result).to.deep.equal(['duck0', 'duck1', 'oyster', 'duck2']); + }); + }); + + describe('#reduce', () => { + it('should return 25', () => { + var result = fp.reduce([1, 2, 3, 4], (a, b) => a + b, 15); + expect(fp.reduce).to.be.a('function'); + expect(result).to.equal(25); + }); + + it('should return 10', () => { + var result = fp.reduce([1, 2, 3, 4], (a, b) => a + b); + expect(fp.reduce).to.be.a('function'); + expect(result).to.equal(10); + }); + }); +}); diff --git a/test/index-test.js b/test/index-test.js new file mode 100644 index 0000000..3725459 --- /dev/null +++ b/test/index-test.js @@ -0,0 +1,13 @@ +'use-strict'; + +const index = require('../index.js'); +const expect = require('chai').expect; + +describe('Index Module', () => { + it('should return uppercase el in arr', () => { + var result = index.upCase(['a', 'b', 'c']); + + expect(index.upCase).to.be.a('function'); + expect(result).to.deep.equal(['A', 'B', 'C']); + }); +});