feat(number-parsing): parse numeric-like values as numbers

feat(number-parsing): parse numeric-like values as numbers

The **parse-numeric** module provides two features:

1. `parseNumeric` is a function that converts numeric strings into Number types.
2. `parseNumeric.isNumeric` evaluates a value and determines whether the value can be converted to a Number type.

**parse-numeric** differs from similar modules in how it evaluates `Strings` and what it returns:

```
parseNumeric
    when given a "value" that is
      a {string} that represents a {number}
        ✓ will convert the {string} to a {number}
      a non-numeric {string}
        ✓ will return the original value
      a {number}
        ✓ will return the {number}
      an empty {string}
        ✓ will return the empty {string}
      {null}
        ✓ will return {null} (1ms)
      {undefined}
        ✓ will return {undefined}
```

and

```
parseNumeric.isNumeric
    ✓ returns "false" for non-numeric values
    ✓ returns "true" for numbers and numeric strings
    ✓ returns "true" for numbers and numeric strings
```

This commit also includes CI build features with quality gates, as well as documentation.

#1

Author: gregswindle

.codeclimate.yml

@@ -0,0 +1,15 @@
+plugins:
+  editorconfig:
+    enabled: true
+  eslint:
+    enabled: true
+    channel: "eslint-5"
+    config:
+      config: .eslintrc.js
+  fixme:
+    enabled: true
+  # https://docs.codeclimate.com/docs/git-legal#section-enable-the-plugin
+  git-legal:
+    enabled: true
+  markdownlint:
+    enabled: false

.eslintignore

@@ -1,2 +1,3 @@
 coverage/
-docs/
+docs/
+lib/__tests__/__fixtures__/

.eslintrc.js

@@ -4,17 +4,23 @@ module.exports = {
     node: true
   },
   extends: [
+    'eslint:all',
     'standard',
-    'plugin:security/recommended',
-    'plugin:unicorn/recommended'
+    'xo',
+    'plugin:security/recommended'
   ],
   plugins: [
     'import',
     'node',
     'prettier',
     'promise',
     'security',
-    'standard',
-    'unicorn'
-  ]
+    'standard'
+  ],
+  rules: {
+    'arrow-parens': 'off',
+    indent: [2, 2, {SwitchCase: 1}],
+    'padding-line-between-statements': 'off',
+    semi: 'off'
+  }
 }

.fossa.yml

@@ -0,0 +1,14 @@
+# Generated by FOSSA CLI (https://github.com/fossas/fossa-cli)
+# Visit https://fossa.io to learn more
+
+version: 1
+cli:
+  server: https://app.fossa.io
+  fetcher: custom
+  project: https://github.com/gregswindle/parse-numeric.git
+analyze:
+  modules:
+  - name: .
+    type: npm
+    target: .
+    path: .

.github/ISSUE_TEMPLATE/Defect.md

@@ -46,7 +46,7 @@ _When working properly, I expect that:_
 > ⌦ Include as many relevant details about the environment in which the defect
 > occured.
 
-- <samp>data-loss-signatures</samp> version:
+- <samp>parse-numeric</samp> version:
 - `JavaScript` version (`node --version`):
 - `npm` version (`npm --version`):
 - Operating System and version (desktop or mobile):

.github/ISSUE_TEMPLATE/Refactoring.md

@@ -41,45 +41,41 @@
 <!-- SonarCloud badge refs -->
 
 [sonar-alert-status-badge]:
-  https://sonarcloud.io/api/project_badges/measure?project=data-loss-signatures-gitlab&metric=alert_status&template=FLAT
+  https://sonarcloud.io/api/project_badges/measure?project=parse-numeric-gitlab&metric=alert_status&template=FLAT
 [sonar-alert-status-url]:
-  https://sonarcloud.io/dashboard?id=data-loss-signatures-gitlab
+  https://sonarcloud.io/dashboard?id=parse-numeric-gitlab
 [sonar-bugs-badge]:
-  https://sonarcloud.io/api/project_badges/measure?project=data-loss-signatures-gitlab&metric=bugs&template=FLAT
-[sonar-bugs-url]: https://sonarcloud.io/dashboard?id=data-loss-signatures-gitlab
+  https://sonarcloud.io/api/project_badges/measure?project=parse-numeric-gitlab&metric=bugs&template=FLAT
+[sonar-bugs-url]: https://sonarcloud.io/dashboard?id=parse-numeric-gitlab
 [sonar-code-smells-badge]:
-  https://sonarcloud.io/api/project_badges/measure?project=data-loss-signatures-gitlab&metric=code_smells&template=FLAT
-[sonar-code-smells-url]:
-  https://sonarcloud.io/dashboard?id=data-loss-signatures-gitlab
+  https://sonarcloud.io/api/project_badges/measure?project=parse-numeric-gitlab&metric=code_smells&template=FLAT
+[sonar-code-smells-url]: https://sonarcloud.io/dashboard?id=parse-numeric-gitlab
 [sonar-coverage-badge]:
-  https://sonarcloud.io/api/project_badges/measure?project=data-loss-signatures-gitlab&metric=coverage&template=FLAT
-[sonar-coverage-url]:
-  https://sonarcloud.io/dashboard?id=data-loss-signatures-gitlab
+  https://sonarcloud.io/api/project_badges/measure?project=parse-numeric-gitlab&metric=coverage&template=FLAT
+[sonar-coverage-url]: https://sonarcloud.io/dashboard?id=parse-numeric-gitlab
 [sonar-duplicated-lines-density-badge]:
-  https://sonarcloud.io/api/project_badges/measure?project=data-loss-signatures-gitlab&metric=duplicated_lines_density&template=FLAT
+  https://sonarcloud.io/api/project_badges/measure?project=parse-numeric-gitlab&metric=duplicated_lines_density&template=FLAT
 [sonar-duplicated-lines-density-url]:
-  https://sonarcloud.io/dashboard?id=data-loss-signatures-gitlab
+  https://sonarcloud.io/dashboard?id=parse-numeric-gitlab
 [sonar-ncloc-badge]:
-  https://sonarcloud.io/api/project_badges/measure?project=data-loss-signatures-gitlab&metric=ncloc&template=FLAT
-[sonar-ncloc-url]:
-  https://sonarcloud.io/dashboard?id=data-loss-signatures-gitlab
+  https://sonarcloud.io/api/project_badges/measure?project=parse-numeric-gitlab&metric=ncloc&template=FLAT
+[sonar-ncloc-url]: https://sonarcloud.io/dashboard?id=parse-numeric-gitlab
 [sonar-reliability-rating-badge]:
-  https://sonarcloud.io/api/project_badges/measure?project=data-loss-signatures-gitlab&metric=reliability_rating&template=FLAT
+  https://sonarcloud.io/api/project_badges/measure?project=parse-numeric-gitlab&metric=reliability_rating&template=FLAT
 [sonar-reliability-rating-url]:
-  https://sonarcloud.io/dashboard?id=data-loss-signatures-gitlab
+  https://sonarcloud.io/dashboard?id=parse-numeric-gitlab
 [sonar-security-rating-badge]:
-  https://sonarcloud.io/api/project_badges/measure?project=data-loss-signatures-gitlab&metric=security_rating&template=FLAT
+  https://sonarcloud.io/api/project_badges/measure?project=parse-numeric-gitlab&metric=security_rating&template=FLAT
 [sonar-security-rating-url]:
-  https://sonarcloud.io/dashboard?id=data-loss-signatures-gitlab
+  https://sonarcloud.io/dashboard?id=parse-numeric-gitlab
 [sonar-sqale-index-badge]:
-  https://sonarcloud.io/api/project_badges/measure?project=data-loss-signatures-gitlab&metric=sqale_index&template=FLAT
-[sonar-sqale-index-url]:
-  https://sonarcloud.io/dashboard?id=data-loss-signatures-gitlab
+  https://sonarcloud.io/api/project_badges/measure?project=parse-numeric-gitlab&metric=sqale_index&template=FLAT
+[sonar-sqale-index-url]: https://sonarcloud.io/dashboard?id=parse-numeric-gitlab
 [sonar-sqale-rating-badge]:
-  https://sonarcloud.io/api/project_badges/measure?project=data-loss-signatures-gitlab&metric=sqale_rating&template=FLAT
+  https://sonarcloud.io/api/project_badges/measure?project=parse-numeric-gitlab&metric=sqale_rating&template=FLAT
 [sonar-sqale-rating-url]:
-  https://sonarcloud.io/dashboard?id=data-loss-signatures-gitlab
+  https://sonarcloud.io/dashboard?id=parse-numeric-gitlab
 [sonar-vulnerabilities-badge]:
-  https://sonarcloud.io/api/project_badges/measure?project=data-loss-signatures-gitlab&metric=vulnerabilities&template=FLAT
+  https://sonarcloud.io/api/project_badges/measure?project=parse-numeric-gitlab&metric=vulnerabilities&template=FLAT
 [sonar-vulnerabilities-url]:
-  https://sonarcloud.io/dashboard?id=data-loss-signatures-gitlab
+  https://sonarcloud.io/dashboard?id=parse-numeric-gitlab

.github/PULL_REQUEST_TEMPLATE/merge_request.md

@@ -38,8 +38,8 @@ Closes #ISSUE_NUMBER
 
 ### How to format, lint, and test your changes
 
-Open a Terminal, go to the root directory for <samp>data-loss-signatures</samp>,
-and run:
+Open a Terminal, go to the root directory for <samp>parse-numeric</samp>, and
+run:
 
 ```bash
 $ npm test
@@ -56,48 +56,48 @@ $ npm test
 <!-- SonarCloud badge refs -->
 
 [sonar-alert-status-badge]:
-  https://sonarcloud.io/api/project_badges/measure?project=data-loss-signatures-gitlab&metric=alert_status&template=FLAT
+  https://sonarcloud.io/api/project_badges/measure?project=parse-numeric-gitlab&metric=alert_status&template=FLAT
 [sonar-alert-status-url]:
-  https://sonarcloud.io/dashboard?id=data-loss-signatures-gitlab
+  https://sonarcloud.io/dashboard?id=parse-numeric-gitlab
 [sonar-bugs-badge]:
-  https://sonarcloud.io/api/project_badges/measure?project=data-loss-signatures-gitlab&metric=bugs&template=FLAT
-[sonar-bugs-url]: https://sonarcloud.io/dashboard?id=data-loss-signatures-gitlab
+  https://sonarcloud.io/api/project_badges/measure?project=parse-numeric-gitlab&metric=bugs&template=FLAT
+[sonar-bugs-url]: https://sonarcloud.io/dashboard?id=parse-numeric-gitlab
 [sonar-code-smells-badge]:
-  https://sonarcloud.io/api/project_badges/measure?project=data-loss-signatures-gitlab&metric=code_smells&template=FLAT
+  https://sonarcloud.io/api/project_badges/measure?project=parse-numeric-gitlab&metric=code_smells&template=FLAT
 [sonar-code-smells-url]:
-  https://sonarcloud.io/component_measures?id=data-loss-signatures-gitlab&metric=code_smells
+  https://sonarcloud.io/component_measures?id=parse-numeric-gitlab&metric=code_smells
 [sonar-coverage-badge]:
-  https://sonarcloud.io/api/project_badges/measure?project=data-loss-signatures-gitlab&metric=coverage&template=FLAT
+  https://sonarcloud.io/api/project_badges/measure?project=parse-numeric-gitlab&metric=coverage&template=FLAT
 [sonar-coverage-url]:
-  https://sonarcloud.io/component_measures?id=data-loss-signatures-gitlab&metric=coverage
+  https://sonarcloud.io/component_measures?id=parse-numeric-gitlab&metric=coverage
 [sonar-duplicated-lines-density-badge]:
-  https://sonarcloud.io/api/project_badges/measure?project=data-loss-signatures-gitlab&metric=duplicated_lines_density&template=FLAT
+  https://sonarcloud.io/api/project_badges/measure?project=parse-numeric-gitlab&metric=duplicated_lines_density&template=FLAT
 [sonar-duplicated-lines-density-url]:
-  https://sonarcloud.io/component_measures?id=data-loss-signatures-gitlab&metric=duplicated_lines_density
+  https://sonarcloud.io/component_measures?id=parse-numeric-gitlab&metric=duplicated_lines_density
 [sonar-ncloc-badge]:
-  https://sonarcloud.io/api/project_badges/measure?project=data-loss-signatures-gitlab&metric=ncloc&template=FLAT
+  https://sonarcloud.io/api/project_badges/measure?project=parse-numeric-gitlab&metric=ncloc&template=FLAT
 [sonar-ncloc-url]:
-  https://sonarcloud.io/component_measures?id=data-loss-signatures-gitlab&metric=ncloc
+  https://sonarcloud.io/component_measures?id=parse-numeric-gitlab&metric=ncloc
 [sonar-reliability-rating-badge]:
-  https://sonarcloud.io/api/project_badges/measure?project=data-loss-signatures-gitlab&metric=reliability_rating&template=FLAT
+  https://sonarcloud.io/api/project_badges/measure?project=parse-numeric-gitlab&metric=reliability_rating&template=FLAT
 [sonar-reliability-rating-url]:
-  https://sonarcloud.io/component_measures?id=data-loss-signatures-gitlab&metric=reliability_rating
+  https://sonarcloud.io/component_measures?id=parse-numeric-gitlab&metric=reliability_rating
 [sonar-security-rating-badge]:
-  https://sonarcloud.io/api/project_badges/measure?project=data-loss-signatures-gitlab&metric=security_rating&template=FLAT
+  https://sonarcloud.io/api/project_badges/measure?project=parse-numeric-gitlab&metric=security_rating&template=FLAT
 [sonar-security-rating-url]:
-  https://sonarcloud.io/component_measures?id=data-loss-signatures-gitlab&metric=security_rating
+  https://sonarcloud.io/component_measures?id=parse-numeric-gitlab&metric=security_rating
 [sonar-sqale-index-badge]:
-  https://sonarcloud.io/api/project_badges/measure?project=data-loss-signatures-gitlab&metric=sqale_index&template=FLAT
+  https://sonarcloud.io/api/project_badges/measure?project=parse-numeric-gitlab&metric=sqale_index&template=FLAT
 [sonar-sqale-index-url]:
-  https://sonarcloud.io/component_measures?id=data-loss-signatures-gitlab&metric=sqale_index
+  https://sonarcloud.io/component_measures?id=parse-numeric-gitlab&metric=sqale_index
 [sonar-sqale-rating-badge]:
-  https://sonarcloud.io/api/project_badges/measure?project=data-loss-signatures-gitlab&metric=sqale_rating&template=FLAT
+  https://sonarcloud.io/api/project_badges/measure?project=parse-numeric-gitlab&metric=sqale_rating&template=FLAT
 [sonar-sqale-rating-url]:
-  https://sonarcloud.io/component_measures?id=data-loss-signatures-gitlab&metric=sqale_rating
+  https://sonarcloud.io/component_measures?id=parse-numeric-gitlab&metric=sqale_rating
 [sonar-vulnerabilities-badge]:
-  https://sonarcloud.io/api/project_badges/measure?project=data-loss-signatures-gitlab&metric=vulnerabilities&template=FLAT
+  https://sonarcloud.io/api/project_badges/measure?project=parse-numeric-gitlab&metric=vulnerabilities&template=FLAT
 [sonar-vulnerabilities-url]:
-  https://sonarcloud.io/component_measures?id=data-loss-signatures-gitlab&metric=vulnerabilities
+  https://sonarcloud.io/component_measures?id=parse-numeric-gitlab&metric=vulnerabilities
 
 <!-- ⛔️ Badge references ⛔️  -->
 
@@ -115,10 +115,10 @@ $ npm test
 [standardjs-logo]: https://cdn.rawgit.com/feross/standard/master/badge.svg
 [standardjs-url]: https://github.com/feross/standard
 [eslint-logo]:
-  https://gitlab.com/gregswindle/data-loss-signatures/raw/master/docs/img/logos/logo-eslint.png
+  https://gitlab.com/gregswindle/parse-numeric/raw/master/docs/img/logos/logo-eslint.png
 [eslint-url]: https://eslint.org/docs/user-guide/getting-started
 [jest-logo]:
-  https://gitlab.com/gregswindle/data-loss-signatures/raw/master/docs/img/logo-jest.png
+  https://gitlab.com/gregswindle/parse-numeric/raw/master/docs/img/logo-jest.png
 [jest-url]: https://facebook.github.io/jest/docs/en/getting-started.html
 
 <!-- ⛔️ Octicon img references ⛔️  -->

.github/ci/legal/fossa-init.sh

@@ -0,0 +1,53 @@
+#!/bin/sh
+
+verify_fossa_cli() {
+  if test -n "$(fossa -v)"
+  then
+    echo "[fossa-init]: OK: fossa-cli installed"
+    return 0
+  else
+    echo "[fossa-init]: ERR: fossa-cli not found."
+    return 1
+  fi
+}
+
+verify_fossa_api_key() {
+  if test -n "$FOSSA_API_KEY"
+  then
+    echo "[fossa-init]: OK: Found FOSSA_API_KEY."
+    return 0
+  else
+    echo "[fossa-init]: ERR: ENVVAR FOSSA_API_KEY not found."
+    return 1
+  fi
+}
+
+install_fossa_cli() {
+  echo "[fossa-init]: INSTALL: installing the fossa-cli"
+  curl https://raw.githubusercontent.com/fossas/fossa-cli/master/install.sh | bash
+}
+
+run_fossa_analysis() {
+  echo "[fossa-init]: analyzing your dependencies' legal licenses"
+  fossa analyze
+}
+
+run_fossa_test() {
+  echo "[fossa-init]: testing for legal use compliance risks"
+  fossa test
+}
+
+main() {
+  if verify_fossa_cli && verify_fossa_api_key
+  then
+    fossa
+  else
+    install_fossa_cli
+    init_fossa
+    run_fossa_analysis
+    run_fossa_test
+  fi
+  exit 0
+}
+
+main

.github/ci/qa/code-climate-init.sh

@@ -0,0 +1,30 @@
+#!/bin/bash
+
+get_cc_test_reporter_url() {
+  if [[ "$TRAVIS_OS_NAME" == "osx" ]]
+  then
+    echo "https://codeclimate.com/downloads/test-reporter/test-reporter-latest-darwin-amd64"
+  else
+    echo "https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64"
+  fi
+}
+
+dl_cc_test_reporter() {
+  CC_URL=$(get_cc_test_reporter_url)
+  curl -L "$CC_URL" > "$TRAVIS_BUILD_DIR/cc-test-reporter"
+  echo "[code-climate-init]: OK: Dowloaded script to $TRAVIS_BUILD_DIR/cc-test-reporter"
+}
+
+init_cc_test_reporter() {
+  chmod +x "$TRAVIS_BUILD_DIR/cc-test-reporter"
+  echo "[code-climate-init]: OK: Apply exec to $TRAVIS_BUILD_DIR/cc-test-reporter"
+}
+
+main() {
+  dl_cc_test_reporter
+  init_cc_test_reporter
+  echo "[code-climate-init]: OK: $TRAVIS_BUILD_DIR/cc-test-reporter is ready for use."
+  exit 0
+}
+
+main

.remarkrc.js

@@ -0,0 +1,19 @@
+exports.plugins = [
+  require('remark-frontmatter'),
+  [
+    require('remark-retext'),
+    require('unified')().use({
+      plugins: [
+        require('retext-english'),
+        require('retext-syntax-urls'),
+        [require('retext-spell'), require('dictionary-en-us')],
+        [require('retext-sentence-spacing'), { preferred: 1 }],
+        require('retext-repeated-words'),
+        require('retext-usage'),
+      ],
+    }),
+  ],
+  require('remark-preset-lint-consistent'),
+  require('remark-preset-lint-recommended'),
+  require('remark-preset-lint-markdown-style-guide'),
+]