chore(pad-array): create initial structure

mljs · maasencioh · Sep 7, 2015 · Sep 5, 2015 · Sep 6, 2015 · Sep 7, 2015
commit 71fa8578af4204308c56901a06579b46c7dcce4f
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+node_modules
+.idea
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,5 @@
+language: node_js
+node_js:
+  - "0.12"
+  - "iojs"
+sudo: false
diff --git a/History.md b/History.md
@@ -0,0 +1,4 @@
+0.0.0 / HEAD
+============
+
+* first release
diff --git a/README.md b/README.md
@@ -1 +1,49 @@
 # pad-array
+
+[![NPM version][npm-image]][npm-url]
+[![build status][travis-image]][travis-url]
+[![David deps][david-image]][david-url]
+[![npm download][download-image]][download-url]
+
+Function to pads an array in Javascript
+
+This code is based in the MATLAB's code [padarray](http://www.mathworks.com/help/images/ref/padarray.html)
+
+## Installation
+
+`npm install ml-pad-array`
+
+## Methods
+
+### pad-array(data, [options])
+
+Pads the array `data` given the current `options`.
+
+__Options__
+* padsize: 
+* padval: 
+* direction: 
+
+## Test
+
+```bash
+$ npm install
+$ npm test
+```
+
+## Authors
+
+- [Miguel Asencio](https://github.com/maasencioh)
+
+## License
+
+[MIT](./LICENSE)
+
+[npm-image]: https://img.shields.io/npm/v/ml-pad-array.svg?style=flat-square
+[npm-url]: https://npmjs.org/package/ml-pad-array
+[travis-image]: https://img.shields.io/travis/mljs/pad-array/master.svg?style=flat-square
+[travis-url]: https://travis-ci.org/mljs/pad-array
+[david-image]: https://img.shields.io/david/mljs/pad-array.svg?style=flat-square
+[david-url]: https://david-dm.org/mljs/pad-array
+[download-image]: https://img.shields.io/npm/dm/ml-pad-array.svg?style=flat-square
+[download-url]: https://npmjs.org/package/ml-pad-array
diff --git a/package.json b/package.json
@@ -0,0 +1,36 @@
+{
+  "name": "ml-pad-array",
+  "version": "0.0.0",
+  "description": "Function to pads an array in Javascript",
+  "main": "src/index.js",
+  "directories": {
+    "lib": "src",
+    "test": "test"
+  },
+  "scripts": {
+    "test": "mocha --require should --reporter mocha-better-spec-reporter --recursive"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/mljs/pad-array"
+  },
+  "keywords": [
+    "pad",
+    "array",
+    "utils"
+  ],
+  "author": {
+    "name": "Miguel Asencio",
+    "mail": "maasencioh@gmail.com"
+  },
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/mljs/pad-array/issues"
+  },
+  "homepage": "https://github.com/mljs/pad-array",
+  "devDependencies": {
+    "mocha": "latest",
+    "mocha-better-spec-reporter": "latest",
+    "should": "latest"
+  }
+}
diff --git a/src/index.js b/src/index.js
@@ -0,0 +1,22 @@
+'use strict';
+
+var defaultOptions = {
+    padsize: 1,
+    padval: 0,
+    direction: 'both'
+};
+
+/**
+ * Pads and array
+ * @param {Array <number>} data
+ * @param {object} options
+ */
+function padArray (data, options) {
+    options = options || {};
+    for (var o in defaultOptions)
+        if (!(options[o]))
+            options[o] = defaultOptions[o];
+    return data;
+}
+
+module.exports = padArray;
diff --git a/test/test.js b/test/test.js
@@ -0,0 +1,13 @@
+'use strict';
+
+var padArray = require('..');
+
+describe('Pad array test', function () {
+
+    it('Default test', function () {
+        var data = new Array(200);
+        for (var i = 0; i < data.length; i++)
+            data[i] = Math.sin(i);
+        var model = padArray(data);
+    });
+});