feat(kitsu-core): add splitModel

Author: wopian

packages/kitsu-core/src/index.js

@@ -5,6 +5,7 @@ export * from './filterIncludes'
 export * from './linkRelationships'
 export * from './query'
 export * from './serialise'
+export * from './splitModel'
 export { default as camel } from './camel'
 export { default as kebab } from './kebab'
 export { default as snake } from './snake'

packages/kitsu-core/src/splitModel/index.js

@@ -0,0 +1,38 @@
+
+/**
+ * splitModel
+ *
+ * @param {String} url URL path for the model
+ * @param {Object} options
+ * @param {Function} options.resourceCase Convert libraryEntries to library-entries or library_entries (default no conversion). To use parameter, import kebab or snake from kitsu-core
+ * @param {Function} options.pluralModel Pluralise models (default no pluralisation). To use parameter, import pluralize (or another pluralisation npm package)
+ * @returns {Array} Array containing the model name and the resource URL with pluralisation applied
+ *
+ * @example
+ * splitModel('posts/1/comments')
+ * // [ 'comments', 'posts/1/comments' ]
+ *
+ * @example <caption>With pluralModel option</caption>
+ * import plural from 'pluralize'
+ * splitModel('posts/1/comment', { pluralModel: plural })
+ * // [ 'comment', 'posts/1/comments' ]
+ *
+ * @example <caption>With resourceCase option</caption>
+ * import { kebab, snake } from 'kitsu-core'
+ * splitModel('libraryEntries', { resourceCase: kebab })
+ * // [ 'libraryEntries', 'library-entries' ]
+ *
+ * splitModel('libraryEntries', { resourceCase: snake })
+ * // [ 'libraryEntries', 'library_entries' ]
+ */
+export function splitModel (url, options = {}) {
+  if (!options.pluralModel) options.pluralModel = s => s
+  if (!options.resourceCase) options.resourceCase = s => s
+
+  const urlSegments = url.split('/')
+  const resourceModel = urlSegments.pop()
+  urlSegments.push(options.pluralModel(options.resourceCase(resourceModel)))
+  const newUrl = urlSegments.join('/')
+
+  return [ resourceModel, newUrl ]
+}

packages/kitsu-core/src/splitModel/index.spec.js

@@ -0,0 +1,65 @@
+import { splitModel } from './'
+import { kebab, snake } from '../'
+import plural from 'pluralize'
+
+describe('kitsu-core', () => {
+  describe('splitModel', () => {
+    it('anime -> anime', () => {
+      expect.assertions(1)
+      expect(splitModel('anime'))
+        .toStrictEqual([ 'anime', 'anime' ])
+    })
+
+    it('anime -> anime (plural, mass noun)', () => {
+      expect.assertions(1)
+      expect(splitModel('anime', {
+        pluralModel: plural
+      }))
+        .toStrictEqual([ 'anime', 'anime' ])
+    })
+
+    it('post -> post', () => {
+      expect.assertions(1)
+      expect(splitModel('post'))
+        .toStrictEqual([ 'post', 'post' ])
+    })
+
+    it('post -> posts (plural)', () => {
+      expect.assertions(1)
+      expect(splitModel('post', {
+        pluralModel: plural
+      }))
+        .toStrictEqual([ 'post', 'posts' ])
+    })
+
+    it('post/1/relationships/comment -> comment', () => {
+      expect.assertions(1)
+      expect(splitModel('post/1/relationships/comment'))
+        .toStrictEqual([ 'comment', 'post/1/relationships/comment' ])
+    })
+
+    it('post/1/relationships/comment -> comment (plural)', () => {
+      expect.assertions(1)
+      expect(splitModel('post/1/relationships/comment', {
+        pluralModel: plural
+      }))
+        .toStrictEqual([ 'comment', 'post/1/relationships/comments' ])
+    })
+
+    it('libraryEntry -> library-entry', () => {
+      expect.assertions(1)
+      expect(splitModel('libraryEntry', {
+        resourceCase: kebab
+      }))
+        .toStrictEqual([ 'libraryEntry', 'library-entry' ])
+    })
+
+    it('libraryEntry -> library_entry', () => {
+      expect.assertions(1)
+      expect(splitModel('libraryEntry', {
+        resourceCase: snake
+      }))
+        .toStrictEqual([ 'libraryEntry', 'library_entry' ])
+    })
+  })
+})