refactor: Moving towards add-search-docs

Author: jezhiggins

lib/actions/add-editable/index.js

@@ -2,10 +2,8 @@ const c = require('ansi-colors')
 const Blueprint = require('../blueprint')
 const validator = require('../util/validators')
 const ask = require('../util/ask')
-const selectInternalModel = require('../util/select-model')
+const selectModel = require('../util/select-model')
 const chooseFilename = require('../util/choose-filename')
-const path = require('path')
-const fs = require('fs-extra')
 const _ = require('lodash')
 
 async function addEditable (options) {
@@ -31,28 +29,6 @@ async function addEditable (options) {
   await scaffold.commit()
 } // addEditable
 
-async function selectModel (blueprint, modelPath) {
-  const model = modelPath ? loadExternalModel(modelPath) : await selectInternalModel(blueprint)
-
-  return model
-} // selectInternalModel
-
-function loadExternalModel (modelPath) {
-  if (!fs.pathExistsSync(modelPath)) {
-    console.log(c.bold.red(`Can not find model at ${c.cyan(modelPath)}`))
-  }
-
-  const name = path.basename(modelPath, path.extname(modelPath))
-  const schema = fs.readJsonSync(modelPath)
-  const fields = Object.keys(schema.properties)
-  console.log(c.bold(`Loading external model ${c.cyan(name)}`))
-  return {
-    name,
-    schema,
-    fields
-  }
-} // loadExternalModel
-
 async function selectFields (modelName, propertyNames, properties) {
   console.log()
   const allProperties = await ask({

lib/actions/add-search-doc/index.js

@@ -1,5 +1,37 @@
-function addSearchDoc (options) {
+const c = require('ansi-colors')
+const Blueprint = require('../blueprint')
+const selectModel = require('../util/select-model')
+const chooseCategory = require('../util/choose-category')
+const chooseFilename = require('../util/choose-filename')
 
+async function addSearchDoc (options) {
+  const blueprint = Blueprint.load(options)
+  if (!blueprint) return
+
+  const model = await selectModel(blueprint, options.modelPath)
+
+  const category = await chooseCategory(blueprint, model.name)
+
+  const filename = await chooseFilename(
+    'Search-doc filename',
+    `${model.name}`
+  )
+
+  const scaffold = blueprint.scaffold
+  scaffold.makeSearchDoc({
+    namespace: blueprint.namespace,
+    model: model.name,
+    primaryKeys: model.schema.primaryKey,
+    title: 'washboard',
+    description: ['phonic'],
+    roles: ['$everyone'],
+    sort: 'label',
+    category: category,
+    launches: 'boop',
+    filename: filename
+  })
+  console.log(c.bold(`\nCreating search-doc ${c.cyan(filename)}`))
+  await scaffold.commit()
 } // addSearchDoc
 
 module.exports = addSearchDoc

lib/actions/add-state-machine/index.js

@@ -3,6 +3,7 @@ const ask = require('../util/ask')
 const Blueprint = require('../blueprint')
 const Scaffold = require('@wmfs/tymly-scaffold')
 const selectInternalModel = require('../util/select-model')
+const chooseCategories = require('../util/choose-categories')
 const chooseFilename = require('../util/choose-filename')
 const _ = require('lodash')
 
@@ -78,31 +79,4 @@ async function selectModel (form, blueprint) {
   })
 } // selectModel
 
-async function chooseCategories (blueprint) {
-  const categories = blueprint.categories()
-
-  if (categories.length === 0) {
-    console.log(c.bold.red('Blueprint has no categories defined'))
-    return ask({
-      message: 'Please enter categories',
-      hint: 'You can enter several categories, separated by commas',
-      type: 'list'
-    })
-  }
-
-  if (categories.length === 1) {
-    console.log(c.bold(`Blueprint has one category - ${c.cyan(categories[0])}`))
-    return categories
-  }
-
-  const cats = await ask({
-    type: 'multiselect',
-    message: 'Select categories',
-    hint: '(Use <space> to select, <return> to submit)',
-    choices: categories
-  })
-
-  return cats
-} // chooseCategories
-
 module.exports = addStateMachine

lib/actions/util/choose-categories.js

@@ -0,0 +1,31 @@
+const c = require('ansi-colors')
+const ask = require('./ask')
+
+async function chooseCategories (blueprint) {
+  const categories = blueprint.categories()
+
+  if (categories.length === 0) {
+    console.log(c.bold.red('Blueprint has no categories defined'))
+    return ask({
+      message: 'Please enter categories',
+      hint: 'You can enter several categories, separated by commas',
+      type: 'list'
+    })
+  }
+
+  if (categories.length === 1) {
+    console.log(c.bold(`Blueprint has one category - ${c.cyan(categories[0])}`))
+    return categories
+  }
+
+  const cats = await ask({
+    type: 'multiselect',
+    message: 'Select categories',
+    hint: '(Use <space> to select, <return> to submit)',
+    choices: categories
+  })
+
+  return cats
+} // chooseCategories
+
+module.exports = chooseCategories

lib/actions/util/choose-category.js

@@ -0,0 +1,29 @@
+const c = require('ansi-colors')
+const ask = require('./ask')
+
+async function chooseCategory (blueprint, suggestion) {
+  const categories = blueprint.categories()
+
+  if (categories.length === 0) {
+    console.log(c.bold.red('Blueprint has no categories defined'))
+    return ask({
+      message: 'Please a categories',
+      initial: suggestion
+    })
+  }
+
+  if (categories.length === 1) {
+    console.log(c.bold(`Blueprint has one category - ${c.cyan(categories[0])}`))
+    return categories[0]
+  }
+
+  const cat = await ask({
+    type: 'select',
+    message: 'Select a category',
+    choices: categories
+  })
+
+  return cat
+} // chooseCategories
+
+module.exports = chooseCategory

lib/actions/util/select-internal-model.js

@@ -0,0 +1,26 @@
+const ask = require('./ask')
+const c = require('ansi-colors')
+
+async function selectInternalModel (blueprint) {
+  const models = blueprint.models()
+
+  if (models.length === 0) {
+    console.log(c.bold.red('Blueprint has no models to scaffold against'))
+    return
+  }
+
+  if (models.length === 1) {
+    console.log(c.bold(`Blueprint has one model - ${c.cyan(models[0].name)}`))
+    return models[0]
+  }
+
+  const modelName = await ask({
+    type: 'select',
+    message: 'Model to scaffold against',
+    choices: models.map(m => m.name)
+  })
+
+  return models.find(m => m.name === modelName)
+} // selectModel
+
+module.exports = selectInternalModel

lib/actions/util/select-model.js

@@ -1,26 +1,28 @@
-const ask = require('./ask')
 const c = require('ansi-colors')
+const path = require('path')
+const fs = require('fs-extra')
+const selectInternalModel = require('./select-internal-model')
 
-async function selectModel (blueprint) {
-  const models = blueprint.models()
+async function selectModel (blueprint, modelPath) {
+  const model = modelPath ? loadExternalModel(modelPath) : await selectInternalModel(blueprint)
 
-  if (models.length === 0) {
-    console.log(c.bold.red('Blueprint has no models to scaffold against'))
-    return
-  }
+  return model
+} // selectInternalModel
 
-  if (models.length === 1) {
-    console.log(c.bold(`Blueprint has one model - ${c.cyan(models[0].name)}`))
-    return models[0]
+function loadExternalModel (modelPath) {
+  if (!fs.pathExistsSync(modelPath)) {
+    console.log(c.bold.red(`Can not find model at ${c.cyan(modelPath)}`))
   }
 
-  const modelName = await ask({
-    type: 'select',
-    message: 'Model to scaffold against',
-    choices: models.map(m => m.name)
-  })
-
-  return models.find(m => m.name === modelName)
-} // selectModel
+  const name = path.basename(modelPath, path.extname(modelPath))
+  const schema = fs.readJsonSync(modelPath)
+  const fields = Object.keys(schema.properties)
+  console.log(c.bold(`Loading external model ${c.cyan(name)}`))
+  return {
+    name,
+    schema,
+    fields
+  }
+} // loadExternalModel
 
 module.exports = selectModel

lib/index.js

@@ -67,6 +67,15 @@ function tymlyCli (argv) {
       actions.addStateMachine(options)
     })
 
+  program
+    .command('add-search-doc')
+    .description('Scaffold a new search document')
+    .option('-p, --path <path>', 'blueprint directory - defaults to "."')
+    .option('-m, --model-path <path>', 'path to the model file, useful if you want to add a form for a model that is defined in another blueprint')
+    .action((options) => {
+      actions.addSearchDoc(options)
+    })
+
   program
     .arguments('<command>')
     .action((cmd) => {