Merge branch 'release/v1.0.0'

Author: ja573

.babelrc

@@ -0,0 +1,3 @@
+{
+  "presets": ["@babel/preset-env"]
+}

.eslintignore

@@ -0,0 +1,3 @@
+coverage/*
+build
+node_modules

.eslintrc.json

@@ -0,0 +1,12 @@
+{
+    "extends": [
+        "eslint:recommended"
+    ],
+    "parserOptions": {
+        "sourceType": "module"
+    },
+    "env": {
+      "jest": true,
+      "es6": true
+    }
+}

.github/workflows/build_test_and_check.yml

@@ -0,0 +1,19 @@
+name: Build, test and lint
+on:
+  push:
+    branches:
+      - master
+      - develop
+  pull_request:
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: '12.x'
+      - run: yarn install
+      - run: yarn test
+      - run: yarn lint
+      - run: yarn build

.github/workflows/publish.yml

@@ -0,0 +1,21 @@
+name: Node.js Package
+on:
+  release:
+    types: [published]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      # Setup .npmrc file to publish to npm
+      - uses: actions/setup-node@v2
+        with:
+          node-version: '12.x'
+          registry-url: 'https://registry.npmjs.org'
+      - run: yarn install
+      - run: yarn test
+      - run: yarn lint
+      - run: yarn build
+      - run: yarn publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

README.md

@@ -1,2 +1,25 @@
-# doi-prop-type
-DOI React Prop Type
+# DOI Prop Type
+
+[![Build](https://github.com/OpenBookPublishers/doi-prop-type/actions/workflows/build_test_and_check.yml/badge.svg)](https://github.com/OpenBookPublishers/doi-prop-type/actions/workflows/build_test_and_check.yml)
+[![npm](https://img.shields.io/npm/v/doi-prop-type.svg)](https://www.npmjs.com/package/doi-prop-type)
+![GitHub](https://img.shields.io/github/license/OpenBookPublishers/doi-prop-type)
+
+This package is used to validate if a React Prop value is a valid DOI, e.g. `10.11647/obp.0229`. To do so we compare the input against this regex: `/^10.\d{4,9}\/[-._\;\(\)\/:a-zA-Z0-9]+$/g`.
+
+The [`prop-types` package](https://www.npmjs.com/package/prop-types) does not support a DOI prop type, therefore you can use this package to validate them, instead of using the permissive `PropType.string`.
+
+## Installation
+`npm install --save doi-prop-type`
+
+## Example Usage
+```javascript
+import React from 'react';
+import doiPropType from 'doi-prop-type';
+
+// Create a generic component
+const Doi = props => ( <a href={`https://doi.org/${props.doi}`}>{props.doi}</a> );
+
+Doi.propTypes = {
+  link: doiPropType.isRequired, // can also specify doiPropType if it is not required
+};
+```

lib/index.js

@@ -0,0 +1,25 @@
+const isDoi = (value) => {
+    return /^10.\d{4,9}\/[-._;()/:a-zA-Z0-9]+$/g.test(value);
+}
+
+const requiredDoiPropType = (props, propName, componentName) => {
+    const value = props[propName];
+
+    if (value == null || typeof value !== 'string' || !isDoi(value)) {
+        return new TypeError(`Invalid DOI Prop Value: ${value} for ${propName} in ${componentName}`);
+    }
+
+    return null;
+};
+
+const doiPropType = (props, propName, componentName) => {
+    if (props[propName] == null) {
+        return null;
+    }
+
+    return requiredDoiPropType(props, propName, componentName);
+};
+
+doiPropType.isRequired = requiredDoiPropType;
+
+export default doiPropType;

lib/index.test.js

@@ -0,0 +1,51 @@
+import doiPropType from './index';
+
+describe('DOI Prop Type', () => {
+    const propName = 'someproperty';
+    const componentName = 'somecomponent';
+    const validDoi = '10.11647/obp.0226';
+    const invalidDoi = '10:11647/OBP.0226?%98.leon';
+    const nonStringDoi = 10.001;
+
+    describe('doiPropType', () => {
+        it('should throw an error if prop value is not a string', () => {
+            const props = {};
+            props[propName] = nonStringDoi;
+            expect(doiPropType(props, propName, componentName))
+                .toEqual(new TypeError(`Invalid DOI Prop Value: ${nonStringDoi} for ${propName} in ${componentName}`));
+        });
+
+        it('should throw an error if prop value is not a valid DOI', () => {
+            const props = {};
+            props[propName] = invalidDoi;
+            expect(doiPropType(props, propName, componentName))
+                .toEqual(new TypeError(`Invalid DOI Prop Value: ${invalidDoi} for ${propName} in ${componentName}`));
+        });
+
+        it('should return null if prop value is a valid DOI', () => {
+            const props = {};
+            props[propName] = validDoi;
+            expect(doiPropType(props, propName, componentName)).toBeNull();
+        });
+
+        it('should return null if prop is not defined', () => {
+            const props = {};
+            expect(doiPropType(props, propName, componentName)).toBeNull();
+        });
+    });
+
+    describe('validateRequiredDoi', () => {
+        it('should throw an error if prop value is not a valid DOI', () => {
+            const props = {};
+            props[propName] = invalidDoi;
+            expect(doiPropType.isRequired(props, propName, componentName))
+                .toEqual(new TypeError(`Invalid DOI Prop Value: ${invalidDoi} for ${propName} in ${componentName}`));
+        });
+
+        it('should throw an error if prop is not defined', () => {
+            const props = {};
+            expect(doiPropType.isRequired(props, propName, componentName))
+                .toEqual(new TypeError(`Invalid DOI Prop Value: undefined for ${propName} in ${componentName}`));
+        });
+    });
+});

package.json

@@ -0,0 +1,37 @@
+{
+  "name": "doi-prop-type",
+  "version": "1.0.0",
+  "description": "React Prop Types DOI Validator",
+  "main": "./dist/index.js",
+  "scripts": {
+    "codecov": "codecov",
+    "test": "jest",
+    "build": "babel -d dist/ lib/ --ignore \"**/*.test.js\"",
+    "lint": "eslint --ext .js .",
+    "clean": "rm -rf dist/"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/OpenBookPublishers/doi-prop-type.git"
+  },
+  "keywords": [
+    "react",
+    "prop-types"
+  ],
+  "author": "Javier Arias <javi@openbookpublishers.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/OpenBookPublishers/doi-prop-type/issues"
+  },
+  "homepage": "https://github.com/OpenBookPublishers/doi-prop-type#readme",
+  "devDependencies": {
+    "@babel/cli": "^7.8.4",
+    "@babel/core": "^7.8.4",
+    "@babel/preset-env": "^7.8.4",
+    "codecov": "^3.8.3",
+    "eslint": "^6.8.0",
+    "eslint-config-airbnb-base": "^14.0.0",
+    "eslint-plugin-import": "^2.20.1",
+    "jest": "^27.4.3"
+  }
+}