feat: Solicit label and description for state machines

Author: jezhiggins

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

@@ -2,6 +2,7 @@ const c = require('ansi-colors')
 const ask = require('../util/ask')
 const Blueprint = require('../blueprint')
 const Scaffold = require('@wmfs/tymly-scaffold')
+const labelAndDescription = require('../util/label-and-description')
 const selectInternalModel = require('../util/select-model')
 const chooseCategories = require('../util/choose-categories')
 const chooseRoles = require('../util/choose-roles')
@@ -14,10 +15,20 @@ async function addStateMachine (options) {
 
   const stateMachine = await selectMachine()
   if (!stateMachine) return
+
+  console.log()
   const form = await selectForm(blueprint)
   if (!form) return
   const model = await selectModel(form, blueprint)
   if (!model) return
+
+  console.log()
+  const { label, description } =
+      await labelAndDescription(
+        `${_.upperFirst(stateMachine)} ${model}`,
+        `${_.upperFirst(stateMachine)} ${model} using ${form.name} form.`
+      )
+
   const categories = await chooseCategories(blueprint)
 
   const roles = await chooseRoles(blueprint)
@@ -27,6 +38,8 @@ async function addStateMachine (options) {
 
   const scaffold = blueprint.scaffold
   scaffold.makeStateMachine({
+    label: label,
+    description: description,
     stateMachine: stateMachine,
     namespace: blueprint.namespace,
     modelName: model,

lib/actions/util/label-and-description.js

@@ -0,0 +1,24 @@
+const validator = require('../util/validators')
+const ask = require('../util/ask')
+
+async function labelDescription (
+  labelSuggestion,
+  descriptionSuggestion
+) {
+  const label = await ask({
+    message: 'Label',
+    initial: labelSuggestion,
+    validate: validator.notEmpty()
+  })
+  const description = await ask({
+    message: 'Description',
+    initial: descriptionSuggestion
+  })
+
+  return {
+    label,
+    description
+  }
+} // labelDescription
+
+module.exports = labelDescription

lib/actions/util/name-label-and-description.js

@@ -1,5 +1,6 @@
 const validator = require('../util/validators')
 const ask = require('../util/ask')
+const labelAndDescription = require('./label-and-description')
 const _ = require('lodash')
 
 async function nameLabelDescription (thing) {
@@ -8,15 +9,10 @@ async function nameLabelDescription (thing) {
     validate: validator.notEmptyNoSpaces()
   })
   console.log()
-  const label = await ask({
-    message: 'Label',
-    initial: _.upperFirst(_.lowerCase(name)),
-    validate: validator.notEmpty()
-  })
-  const description = await ask({
-    message: 'Description',
-    initial: _.upperFirst(_.lowerCase(name))
-  })
+
+  const suggestion = _.upperFirst(_.lowerCase(name))
+  const { label, description } =
+    await labelAndDescription(suggestion, suggestion)
 
   return {
     name,

package.json

@@ -23,7 +23,7 @@
     "tymly": "bin/tymly-cli.js"
   },
   "dependencies": {
-    "@wmfs/tymly-scaffold": "1.15.0",
+    "@wmfs/tymly-scaffold": "1.17.0",
     "ansi-colors": "3.2.3",
     "commander": "2.19.0",
     "enquirer": "2.3.0",

test/add-state-machine-test.js

@@ -8,19 +8,25 @@ describe('tymly add-state-machine', () => {
   const tests = {
     'update': [
       helpers.down,
+      '', // default title
+      '', // default description
       '', // default role
       ''
     ],
     'two-forms-no-meta': [
       helpers.down + helpers.down, // state machine
       helpers.down, // choose form
       helpers.down, // choose model
+      '', // default title
+      '', // default description
       '', // default role
       ''
     ],
     'set-file-name': [
       helpers.down,
-      '', // default role
+      '', // default title
+      'Pizza for everyone!',
+      ' ', // $everyone role
       'futz-around-with-pizza'
     ]
   }

test/fixtures/add-state-machine/expected/set-file-name/state-machines/futz-around-with-pizza.json

@@ -1,6 +1,6 @@
 {
-  "Comment": "Edit pizza using pizza-editing-form form.",
-  "name": "Edit pizza",
+  "Comment": "Pizza for everyone!",
+  "name": "Update pizza",
   "version": "1.0",
   "categories": [
     "pizza"
@@ -40,7 +40,7 @@
   },
   "restrictions": [
     {
-      "roleId": "$authenticated",
+      "roleId": "$everyone",
       "allows": [
         "*"
       ]

test/fixtures/add-state-machine/expected/two-forms-no-meta/state-machines/view-pizza.json

@@ -1,6 +1,6 @@
 {
-  "Comment": "Edit pizza using pizza-editing-form form.",
-  "name": "Edit pizza",
+  "Comment": "View pizza using pizza-editing-form form.",
+  "name": "View pizza",
   "version": "1.0",
   "categories": [
     "pizza"

test/fixtures/add-state-machine/expected/update/state-machines/update-pizza.json

@@ -1,6 +1,6 @@
 {
-  "Comment": "Edit pizza using pizza-editing-form form.",
-  "name": "Edit pizza",
+  "Comment": "Update pizza using pizza-editing-form form.",
+  "name": "Update pizza",
   "version": "1.0",
   "categories": [
     "pizza"