Added groups, match, tests

Author: RichardLitt

cli-index.js

@@ -17,7 +17,8 @@ if (process.argv.length <= 2) {
 var flags = {
 	"exact": ['-e', '--exact'],
 	"declared": ['-d', '--declared'],
-	"match": ['-m', '--match']
+	"match": ['-m', '--match'],
+	"groups": ['-g', '--groups']
 };
 
 for (var index in flags) {
@@ -27,22 +28,27 @@ for (var index in flags) {
 			flags[index] = true
 		}
 	})
+
+	if (flags[index] !== true) {
+		flags[index] = null
+	}
 }
 
 var doi = process.argv[2];
 
 if (flags.match === true) {
 	console.log(doi.match(doiRegex()))
+} else if (flags.groups === true) {
+	console.log(doiRegex.groups(doi));
 } else {
-	if (flags.exact !== true && flags.declared !== true) {
-		console.log('Does a DOI exist?', doiRegex().test(doi))
-	} else if (flags.exact === true && flags.declared !== true) {
+	if (flags.exact && flags.declared) {
+		console.log('Is this a declared DOI',
+			doiRegex.declared({exact: true}).test(doi))
+	} else if (flags.exact && !flags.declared) {
 		console.log('Is this a DOI?', doiRegex({exact: true}).test(doi))
-	} else if (flags.exact !== true && flags.declared === true) {
+	} else if (!flags.exact && flags.declared) {
 		console.log('Is the DOI declared?', doiRegex.declared().test(doi))
-	} else if (flags.match !== true) {
-		console.log('Is this a declared DOI',
-			doiRegex.declared({expect: true}).test(doi))
+	} else {
+		console.log('Does a DOI exist?', doiRegex().test(doi))
 	}
 }
-

index.js

@@ -11,6 +11,22 @@ var doi = module.exports = function (opts) {
 											new RegExp('(?:' + doiRegex + ')', 'g')
 }
 
+doi.groups = function (str) {
+	// Javascript fails at lookaheads for optional groups. This circumvents that
+	// problem by just automatically removing and saving suffixes if they are in
+	// as specific format - .a000 is the format used by PLoS, but this may need
+	// to be filled out.
+	var suffixes = [];
+	var newStr = str.replace(/\.[a-zA-Z]{1}[0-9]{3}$/g, function(s){
+		suffixes.push(s)
+		return ''
+	})
+	var match = doi().exec(newStr)
+	match[0] = str;
+	match.push((!!suffixes.length) ? suffixes[0] : '')
+	return match
+}
+
 doi.declared = function(opts) {
 	opts = opts || {}
 	return opts.exact ? new RegExp('^' + doiTextPrefix + doiRegex + '$') :

readme.md

@@ -26,6 +26,9 @@ doiRegex({exact: true}).test('unicorn 10.1000/xyz000');
 doiRegex.declared({exact: true}).test('doi:10.1000/xyz000');
 //=> true
 
+doiRegex.groups().test('10.1000/xyz1000.a001');
+//=> ['10.1000/xyz1000', '10.1000/xyz1000', '.a001']
+
 'unicorn 10.1000/xyz000 cake 10.1000/xyz001 rainbow'.match(doiRegex());
 //=> ['10.1000/xyz000', '10.1000/xyz000']
 ```
@@ -41,6 +44,10 @@ Returns a regex for matching a DOI.
 
 Returns a regex for matching a DOI that has been declared with a `doi:` string in front.
 
+### doiRegex.groups(doi)
+
+Returns a regex match object with a final string as the first two indices, and any suffixes that are commonly used for supplemental information if they are attached to the doi. For instance, `10.1000/journal.pone.0000000.g001` would return `10.1000/journal.pone.0000000` and `.g001`. 
+
 #### options.exact
 
 Type: `boolean`  
@@ -59,11 +66,14 @@ $ node cli-index.js -e `10.000/xyz1000`
 true
 ```
 
+Run it without arguments to see all possible flags.
+
 Possible Flags:
 
-* `-e`, `--exact`	Find an exact match \n\
-* `-d`, `--declared` 	Find a DOI with a 'doi:' prefix\n\
-* `-m`, `--match`	Find all matches within the given string");
+* `-e`, `--exact`	Find an exact match
+* `-d`, `--declared` 	Find a DOI with a 'doi:' prefix
+* `-m`, `--match`	Find all matches within the given string
+* `-g`, `--groups` Find the stripped DOI and any suffix it might have
 
 ## License
 

test.js

@@ -25,48 +25,70 @@ var doiNotDeclared = [
 	'10.1000/journal.pone.0011111',
 ];
 
+var doiGroups = [
+	'10.1000/journal.pone.0011111.a001',
+	'doi:10.1000/journal.pone.0011111.a001'
+]
+
 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) {
+test('DOI not declared as failing', function (t) {
 	_(doiNotDeclared).each(function (el) {
 		t.assert(!doiRegex.declared({exact: true}).test(el), el)
 	})
+})
+
+test('DOI group catching returns original', function (t) {
+	_(doiGroups).each(function (el) {
+		t.assert(doiRegex.groups(el)[0] === el, el)
+	})
+	_(doi).each(function (el) {
+		t.assert(doiRegex.groups(el)[0] === el, el)
+	})
+})
 
-	t.end()
+test('DOI group catching returns DOI', function (t) {
+	_(doiGroups).each(function (el) {
+		t.assert(doiRegex(doiRegex.groups(el)[1]), el)
+	})
+	_(doi).each(function (el) {
+		t.assert(doiRegex(doiRegex.groups(el)[1]), el)
+	})
+})
+
+test('DOI group catching returns extension', function (t) {
+	_(doiGroups).each(function (el) {
+		t.assert(doiRegex.groups(el)[2].length === 5, el)
+	})
+	_(doi).each(function (el) {
+		t.assert(doiRegex.groups(el)[2].length === 0, el)
+	})
 })