From 187cb78cd8d36e499e04569e6312f00a48a02224 Mon Sep 17 00:00:00 2001 From: Awilum Date: Sat, 8 Jan 2022 23:17:42 +0300 Subject: [PATCH] feat(core): initial code commit --- .editorconfig | 18 ++++++++++++++++++ .github/workflows/tests.yml | 17 +++++++++++++++++ .gitignore | 12 ++++++++++++ CHANGELOG.md | 3 +++ LICENSE | 21 ++++++++++++++++++++ README.md | 38 ++++++++++++++++++++++++++++++++++++- index.js | 34 +++++++++++++++++++++++++++++++++ package.json | 32 +++++++++++++++++++++++++++++++ test.js | 31 ++++++++++++++++++++++++++++++ 9 files changed, 205 insertions(+), 1 deletion(-) create mode 100644 .editorconfig create mode 100644 .github/workflows/tests.yml create mode 100755 .gitignore create mode 100755 CHANGELOG.md create mode 100644 LICENSE create mode 100644 index.js create mode 100644 package.json create mode 100644 test.js diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..e98f58d --- /dev/null +++ b/.editorconfig @@ -0,0 +1,18 @@ +# EditorConfig: http://EditorConfig.org + +# top-most EditorConfig file +root = true + +# Unix-style newlines with a newline ending every file +[*] +charset = utf-8 +end_of_line = lf +trim_trailing_whitespace = true +insert_final_newline = true +indent_style = space +indent_size = 4 + +# 2 space indentation +[*.yaml, *.yml] +indent_style = space +indent_size = 2 diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml new file mode 100644 index 0000000..81ac59e --- /dev/null +++ b/.github/workflows/tests.yml @@ -0,0 +1,17 @@ +name: Tests +on: ['push', 'pull_request'] +jobs: + test: + name: Node.js ${{ matrix.node-version }} + runs-on: ubuntu-latest + strategy: + fail-fast: false + matrix: + node-version: [^12, ^14, ^16, ^17] + steps: + - uses: actions/checkout@v2 + - uses: actions/setup-node@v2 + with: + node-version: ${{ matrix.node-version }} + - run: npm install + - run: npm test \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100755 index 0000000..e7ef1ee --- /dev/null +++ b/.gitignore @@ -0,0 +1,12 @@ +# Global +node_modules/ + +# OS Generated +.DS_Store* +ehthumbs.db +Icon? +Thumbs.db +*.swp + +# phpstorm +.idea/* diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100755 index 0000000..d4bffb0 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,3 @@ + +# [1.0.0](https://github.com/faker-javascript/age) (2022-01-08) +* Initial release diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..3006bf0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) Sergey Romanenko + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index a4681ee..5183eaf 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,38 @@ -# age +

Age

+

Age package provides functionality to generate a fake age value. +

+ +

+Version License + +## Install + +``` +$ npm install --save @fakerjs/age +``` + +## Usage + +```js +import fakeAge from '@fakerjs/age'; + +fakeAge(); +//=> 42 + +fakeAge({type: 'child'}); +//=> 10 +// Allowed types are: child, teen, adult, senior +``` + +## Tests + +Run tests + +``` +npm run test +``` + +## License +[The MIT License (MIT)](https://github.com/faker-javascript/age/blob/master/LICENSE.txt) +Copyright (c) [Sergey Romanenko](https://github.com/Awilum) diff --git a/index.js b/index.js new file mode 100644 index 0000000..2cde5d1 --- /dev/null +++ b/index.js @@ -0,0 +1,34 @@ +export default function fakeAge(options) { + options = options || {}; + let min = 0; + let max = 100; + switch (options.type) { + case 'child': + min = 0; + max = 12; + break; + case 'teen': + min = 13; + max = 19; + break; + case 'adult': + min = 18; + max = 65; + break; + case 'senior': + min = 65; + max = 100; + break; + case 'all': + min = 0; + max = 100; + break; + default: + min = 0; + max = 100; + break; + } + min = Math.ceil(min); + max = Math.floor(max); + return Math.floor(Math.random() * (max - min + 1)) + min; +}; \ No newline at end of file diff --git a/package.json b/package.json new file mode 100644 index 0000000..0eeb20b --- /dev/null +++ b/package.json @@ -0,0 +1,32 @@ +{ + "name": "@fakerjs/age", + "version": "1.0.0", + "description": "Age package provides functionality to generate a fake age value.", + "license": "MIT", + "repository": "faker-javascript/age", + "author": { + "name": "Sergey Romanenko", + "email": "awilum@msn.com", + "url": "https://github.com/Awilum" + }, + "type": "module", + "exports": "./index.js", + "engines": { + "node": ">=12" + }, + "scripts": { + "test": "ava" + }, + "devDependencies": { + "ava": "^3.15.0" + }, + "files": [ + "index.js" + ], + "keywords": [ + "fakerjs", + "fake", + "random", + "age" + ] +} diff --git a/test.js b/test.js new file mode 100644 index 0000000..9758c3a --- /dev/null +++ b/test.js @@ -0,0 +1,31 @@ +import fakeAge from './index.js'; +import test from 'ava'; + +test('fakeAge return type to be number', t => { + t.is(typeof fakeAge(), 'number'); +}); + +test('fakeAge with type child less than 13 and more than -1', t => { + t.true(fakeAge({type: 'child'}) < 13); + t.true(fakeAge({type: 'child'}) > -1); +}); + +test('fakeAge with type teen less than 20 and more than 12', t => { + t.true(fakeAge({type: 'teen'}) < 20); + t.true(fakeAge({type: 'teen'}) > 12); +}); + +test('fakeAge with type adult less than 69 and more than 17', t => { + t.true(fakeAge({type: 'adult'}) < 69); + t.true(fakeAge({type: 'adult'}) > 17); +}); + +test('fakeAge with type senior less than 101 and more than 64', t => { + t.true(fakeAge({type: 'senior'}) < 101); + t.true(fakeAge({type: 'senior'}) > 64); +}); + +test('fakeAge with type all less than 101 and more than -1', t => { + t.true(fakeAge({type: 'all'}) < 101); + t.true(fakeAge({type: 'all'}) > -1); +}); \ No newline at end of file