Add isPublished function

.gitignore

@@ -57,3 +57,5 @@ typings/
 # dotenv environment variables file
 .env
 
+# Webstorm
+.idea

README.md

@@ -28,6 +28,7 @@ npm install --save clayutils
 * **isDefaultComponent** [(code|tests|docs)](https://github.com/clay/clayutils/tree/master/lib/isDefaultComponent)
 * **isList** [(code|tests|docs)](https://github.com/clay/clayutils/tree/master/lib/isList)
 * **isPage** [(code|tests|docs)](https://github.com/clay/clayutils/tree/master/lib/isPage)
+* **isPublished** [(code|tests|docs)](https://github.com/clay/clayutils/tree/master/lib/isPublished)
 * **isUser** [(code|tests|docs)](https://github.com/clay/clayutils/tree/master/lib/isUser)
 * **jsonPrefixToSlug** [(code|tests|docs)](https://github.com/clay/clayutils/tree/master/lib/jsonPrefixToSlug)
 * **jsonSlugToPrefix** [(code|tests|docs)](https://github.com/clay/clayutils/tree/master/lib/jsonSlugToPrefix)

index.js

@@ -9,6 +9,7 @@ module.exports.getPrefix = require('./lib/getPrefix');
 module.exports.isComponent = require('./lib/isComponent');
 module.exports.isDefaultComponent = require('./lib/isDefaultComponent');
 module.exports.isPage = require('./lib/isPage');
+module.exports.isPublished = require('./lib/isPublished');
 module.exports.isList = require('./lib/isList');
 module.exports.isUser = require('./lib/isUser');
 module.exports.replaceVersion = require('./lib/replaceVersion');

lib/isPublished/README.md

@@ -0,0 +1,20 @@
+### isPublished
+
+Check if the uri ends with '@published'
+
+#### Params
+
+* `uri` _string_
+
+**Returns** _boolean_
+
+#### Example
+
+```js
+isPublished('nymag.com/press/_components/base/instances/foobarbaz@published')
+//=> true
+
+isPublished('nymag.com/press/_components/base/instances/foobarbaz')
+//=> false
+
+```

lib/isPublished/index.js

@@ -0,0 +1,15 @@
+'use strict';
+
+const isUriStringCheck = require('../strCheck'),
+  validationRegex = /.+@published$/;
+
+/**
+ * First test if argument is a String. If true, test if the string ends with '@published'.
+ * Otherwise, throw an error.
+ * @param  {string}  uri
+ * @return {Boolean}
+ */
+module.exports = function (uri) {
+  isUriStringCheck.strCheck(uri);
+  return validationRegex.test(uri);
+};

lib/isPublished/index.test.js

@@ -0,0 +1,23 @@
+'use strict';
+
+const name = __filename.split('/').pop().split('.').shift(),
+  fn = require('./' + name),
+  expect = require('chai').expect;
+
+describe('isPublished', () => {
+  it('returns true if the reference is published', () => {
+    expect(fn('domain.com/_components/foo/instances/bar@published')).to.equal(true);
+  });
+
+  it('returns false if the reference is not published', () => {
+    expect(fn('domain.com/_components/foo/instances/bar')).to.equal(false);
+  });
+
+  it('throws an error if the URI passed in is not a string', () => {
+    const nonStringArgument = function () {
+      return fn([0, 1, 2, 3]);
+    };
+
+    expect(nonStringArgument).to.throw(Error);
+  });
+});