Init

Author: RichardLitt

.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+indent_style = tab
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[package.json]
+indent_style = space
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false

.jshintrc

@@ -0,0 +1,14 @@
+{
+	"node": true,
+	"esnext": true,
+	"bitwise": true,
+	"camelcase": true,
+	"curly": true,
+	"immed": true,
+	"newcap": true,
+	"noarg": true,
+	"undef": true,
+	"unused": "vars",
+	"strict": true,
+	"asi": true
+}

index.js

@@ -0,0 +1,18 @@
+'use strict';
+
+// TODO Capture final segment for fragments
+// (\\.[a-zA-Z]{1}[0-9]{3})?
+var doiRegex = '(10[.][0-9]{4,}(?:[.][0-9]+)*/(?:(?!["&\/\'<>])\\S)+)'
+var doiTextPrefix = 'doi\\:'
+
+var doi = module.exports = function (opts) {
+	opts = opts || {}
+	return opts.exact ? new RegExp('(?:^' + doiRegex + '$)') :
+											new RegExp('(?:' + doiRegex + ')', 'g')
+}
+
+doi.declared = function(opts) {
+	opts = opts || {}
+	return opts.exact ? new RegExp('^' + doiTextPrefix + doiRegex + '$') :
+											new RegExp(doiTextPrefix + doiRegex, 'g')
+}

license

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) Richard Littauer <[email protected]> (burntfen.com)
+
+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.

package.json

@@ -1,23 +1,44 @@
 {
   "name": "doi-regex",
   "version": "0.0.0",
-  "description": "Regex all the dois",
+  "description": "Regular expression for matching DOIs",
   "main": "index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "node test.js"
   },
   "repository": {
     "type": "git",
     "url": "[email protected]:BeagleLab/doi.git"
   },
   "keywords": [
     "doi",
-    "beagle"
+    "beagle",
+    "regex",
+    "regexp",
+    "re",
+    "match",
+    "test",
+    "find",
+    "pattern",
+    "doi",
+    "digital object identifier",
+    "validate"
   ],
-  "author": "Richard Littauer <[email protected]>",
+  "author": {
+    "name": "Richard Littauer",
+    "email": "[email protected]",
+    "url": "http://www.burntfen.com"
+  },
+  "engines": {
+    "node": ">=0.10.0"
+  },
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/BeagleLab/doi/issues"
   },
-  "homepage": "https://github.com/BeagleLab/doi"
+  "homepage": "https://github.com/BeagleLab/doi",
+  "devDependencies": {
+    "ava": "0.0.4",
+    "lodash": "^2.4.1"
+  }
 }

readme.md

@@ -0,0 +1,55 @@
+# doi-regex [![Build Status](https://travis-ci.org/BeagleLab/doi-regex.svg?branch=master)](https://travis-ci.org/BeagleLab/doi-regex)
+
+> Regular expression for matching DOIs
+
+
+## Install
+
+```sh
+$ npm install --save doi-regex
+```
+
+
+## Usage
+
+```js
+var doiRegex = require('doi-regex');
+
+// contains a DOI
+doiRegex().test('unicorn 10.1000/xyz000');
+//=> true
+
+// is a DOI address
+doiRegex({exact: true}).test('unicorn 10.1000/xyz000');
+//=> false
+
+doiRegex.declared({exact: true}).test('doi:10.1000/xyz000');
+//=> true
+
+'unicorn 10.1000/xyz000 cake 10.1000/xyz001 rainbow'.match(doiRegex());
+//=> ['10.1000/xyz000', '10.1000/xyz000']
+```
+
+
+## API
+
+### doiRegex(options)
+
+Returns a regex for matching a DOI.
+
+### doiRegex.declared(options)
+
+Returns a regex for matching a DOI that has been declared with a `doi:` string in front.
+
+#### options.exact
+
+Type: `boolean`  
+Default: `false` *(Matches any DOI in a string)*
+
+Only match an exact string.  
+Useful with `RegExp#test` to check if a string is an DOI.
+
+
+## License
+
+MIT © [Richard Littauer](http://burntfen.com)

test.js

@@ -0,0 +1,72 @@
+'use strict';
+var test = require('ava')
+var _ = require('lodash')
+var doiRegex = require('./');
+
+var doi = [
+	'10.1371/journal.pone.0077056'
+];
+
+var doiNot = [
+	'10.1000//journal.pone.0011111',
+	'10..1000/journal.pone.0011111',
+	'1.1/1.1'
+];
+
+var doiDeclared = [
+	'doi:10.1000/journal.pone.0011111',
+];
+
+var doiNotDeclared = [
+	'do:10.1000/journal.pone.0011111',
+	'doi:10..1000/journal.pone.0011111',
+	'DO:10.1000/journal.pone.0011111',
+	':10.1000/journal.pone.0011111',
+	'10.1000/journal.pone.0011111',
+];
+
+test('exact DOIs as passing', function (t) {
+	_(doi).each(function (el) {
+		t.assert(doiRegex({exact: true}).test(el), el)
+	})
+	t.end()
+})
+
+test('embeded DOIs as passing', function (t) {
+	_(doi).each(function (el) {
+		t.assert(doiRegex().exec('foo' + el)[0] === el, el)
+	})
+	t.end()
+})
+
+test('non-exact DOIs as failing', function (t) {
+	_(doiNot).each(function (el) {
+		t.assert(!doiRegex({exact: true}).test(el), el)
+	})
+
+	t.end()
+})
+
+test('DOI declared as passing', function (t) {
+	_(doiDeclared).each(function (el) {
+		t.assert(doiRegex.declared({exact: true}).test(el), el)
+	})
+
+	t.end()
+})
+
+test('DOI declared embeded as passing', function (t) {
+	_(doiDeclared).each(function (el) {
+		t.assert((doiRegex.declared().exec('foo' + el) || [])[0] === el, el)
+	})
+
+	t.end()
+})
+
+test('DOI not declared as failing', function(t) {
+	_(doiNotDeclared).each(function (el) {
+		t.assert(!doiRegex.declared({exact: true}).test(el), el)
+	})
+
+	t.end()
+})