docs(app): jsdoc integrated

Author: jankapunkt

app/__mocks__/@react-native-async-storage/async-storage.js

@@ -0,0 +1,2 @@
+// eslint-disable-next-line
+export default from '@react-native-async-storage/async-storage/jest/async-storage-mock'

app/__testHelpers__/expectThrowAsync.js

@@ -0,0 +1,20 @@
+/**
+ * Test helper to test async functions to throw
+ * expected errors
+ * @param fn
+ * @param message
+ * @returns {Promise<void>}
+ */
+export const expectThrowAsync = async ({ fn, message }) => {
+  let catched = false
+  try {
+    await fn()
+  }
+  catch (e) {
+    expect(e.message).toEqual(message)
+    catched = true
+  }
+  finally {
+    expect(catched).toEqual(true)
+  }
+}

app/__testHelpers__/mockCollection.js

@@ -0,0 +1,24 @@
+import { createCollection } from '../lib/infrastructure/createCollection'
+
+const map = new Map()
+
+export const mockCollection = (context) => {
+  if (!map.has(context.name)) {
+    map.set(context.name, createCollection({
+      name: context.name,
+      isLocal: true
+    }))
+  }
+  const collection = map.get(context.name)
+  context.collection = () => collection
+  return context
+}
+
+export const resetCollection = context => context.collection().remove({})
+
+export const restoreCollection = context => {
+  map.delete(context.name)
+  context.collection = () => {
+    throw new Error('is not initialized')
+  }
+}

app/__testHelpers__/simpleRandom.js

@@ -0,0 +1,3 @@
+export const simpleRandom = (size = 6) => [...Array(size)]
+  .map(() => Math.floor(Math.random() * 16).toString(16))
+  .join('')

app/__testHelpers__/stub.js

@@ -0,0 +1,37 @@
+import sinon from 'sinon'
+
+const stubs = new Map()
+
+export const stub = (target, name, handler) => {
+  if (stubs.get(target)) {
+    throw new Error(`already stubbed: ${name}`)
+  }
+  const stubbedTarget = sinon.stub(target, name)
+  if (typeof handler === 'function') {
+    stubbedTarget.callsFake(handler)
+  }
+  else {
+    stubbedTarget.value(handler)
+  }
+  stubs.set(stubbedTarget, name)
+}
+
+export const restore = (target, name) => {
+  if (!target[name] || !target[name].restore) {
+    throw new Error(`not stubbed: ${name}`)
+  }
+  target[name].restore()
+  stubs.delete(target)
+}
+
+export const overrideStub = (target, name, handler) => {
+  restore(target, name)
+  stub(target, name, handler)
+}
+
+export const restoreAll = () => {
+  stubs.forEach((name, target) => {
+    stubs.delete(target)
+    target.restore()
+  })
+}

app/jsdoc.conf.json

@@ -0,0 +1,31 @@
+{
+  "tags": {
+    "allowUnknownTags": true,
+    "dictionaries": ["jsdoc", "closure"]
+  },
+  "source": {
+    "include": ["."],
+    "exclude": [
+      ".expo",
+      ".expo-shared",
+      "__mocks__",
+      "__tests__",
+      "node_modules"
+    ],
+    "includePattern": ".+\\.js(doc|x)?$",
+    "excludePattern": "(^|\\/|\\\\)_"
+  },
+  "plugins": [
+    "plugins/markdown"
+  ],
+  "templates": {
+    "better-docs": {
+      "name": "React components"
+    }
+  },
+  "opts": {
+    "destination": "../docs/api/app",
+    "recurse": true,
+    "readme": "../README.md"
+  }
+}