feat: add-editable supports --model-path option, so you can scaffold a form for a model in another b

Author: jezhiggins

lib/actions/add-editable/index.js

@@ -2,32 +2,65 @@ const c = require('ansi-colors')
 const { prompt } = require('enquirer')
 const Blueprint = require('../blueprint')
 const validator = require('../../util/validators')
+const path = require('path')
+const fs = require('fs-extra')
 
 async function addEditable (options) {
   const blueprint = Blueprint.load(options)
   if (!blueprint) return
 
-  const models = blueprint.models()
-
-  if (models.length === 0) {
-    console.log(c.bold.red('Blueprint has no models to scaffold a form against'))
+  const model = await selectModel(blueprint, options.modelPath)
+  if (!model) {
     return
   }
-  const model = await selectModel(models)
+
   const fields = await selectFields(model.fields)
   const filename = await chooseFilename(`${model.name}-editing-form`)
 
   const scaffold = blueprint.scaffold
   scaffold.makeEditable({
     modelName: model.name,
+    modelSchema: model.schema,
     fields: fields,
     filename: filename
   })
   await scaffold.commit()
-}
+} // addEditable
+
+async function selectModel (blueprint, modelPath) {
+  if (modelPath) {
+    return loadExternalModel(modelPath)
+  }
+
+  return selectInternalModel(blueprint)
+} // 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 = schema.properties
+  console.log(c.bold(`Loading model ${c.cyan(name)}`))
+  return {
+    name,
+    schema,
+    fields
+  }
+} // loadExternalModel
+
+async function selectInternalModel (blueprint) {
+  const models = blueprint.models()
+
+  if (models.length === 0) {
+    console.log(c.bold.red('Blueprint has no models to scaffold a form against'))
+    return
+  }
 
-async function selectModel (models) {
   if (models.length === 1) {
+    console.log(c.bold(`Blueprint has one model - ${c.cyan(models[0].name)}`))
     return models[0]
   }
 

lib/index.js

@@ -38,6 +38,7 @@ function tymlyCli (argv) {
     .command('add-editable')
     .description('Scaffold a new form')
     .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.addEditableAction(options)
     })

package.json

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

test/add-editable-test.js

@@ -1,6 +1,7 @@
 /* eslint-env mocha */
 
 const helpers = require('./test-helpers')
+const path = require('path')
 
 const addEditable = require('../lib/actions').addEditableAction
 
@@ -27,7 +28,16 @@ describe('tymly add-editable', () => {
     'set-file-name': [
       'Y',
       'the-pizza-form.json'
-    ]
+    ],
+    'path-to-external-model': {
+      user: [
+        'Y',
+        ''
+      ],
+      options: {
+        'modelPath': path.join(__dirname, 'fixtures/additional-blueprint/models/drinks.json')
+      }
+    }
   }
 
   const suiteName = 'add-editable'
@@ -37,12 +47,19 @@ describe('tymly add-editable', () => {
   })
 
   for (const [name, inputs] of Object.entries(tests)) {
+    let userInput = inputs
+    let options = { }
+    if (!Array.isArray(inputs)) {
+      userInput = inputs.user
+      options = inputs.options
+    }
+
     helpers.runTest(
       suiteName,
       name,
-      inputs,
+      userInput,
       addEditable,
-      { }
+      options
     )
   }
 })

test/fixtures/add-editable/expected/path-to-external-model/.gitignore

@@ -0,0 +1,179 @@
+# Compiled source #
+###################
+*.com
+*.class
+*.dll
+*.exe
+*.o
+*.so
+
+# Packages #
+############
+# it's better to unpack these files and commit the raw source
+# git has its own built in compression methods
+*.7z
+*.dmg
+*.gz
+*.iso
+*.jar
+*.rar
+*.tar
+*.zip
+
+# Logs and databases #
+######################
+*.log
+
+*.sqlite
+
+## Node ###
+~*
+.~*
+\#*
+
+# Logs
+logs
+*.log
+npm-debug.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules
+jspm_packages
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+
+## IDE things ##
+
+# Webstorm
+.idea
+
+# Eclipse:
+
+.project
+.metadata
+bin/
+tmp/
+*.tmp
+*.bak
+*.swp
+*~.nib
+local.properties
+.settings/
+.loadpath
+.recommenders
+
+
+scratch.txt
+package-lock.json
+
+output/
+
+# Ignore Rush temporary files
+/common/temp/**
+
+package-deps.json
+
+.yo-rc.json
+
+lerna-debug.log
+
+TEST-result.xml
+.gradle/
+.embedpostgresql/
+build/
+
+# Windows thumbnail cache files
+Thumbs.db
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+# OS generated files #
+######################
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk

test/fixtures/add-editable/expected/path-to-external-model/.releaserc.json

@@ -0,0 +1,44 @@
+{
+  "branch": "master",
+  "analyzeCommits": {
+    "preset": "angular",
+    "releaseRules": [
+      {
+        "type": "build",
+        "scope": "deps",
+        "release": "minor"
+      }
+    ]
+  },
+  "verifyConditions": [
+    "@semantic-release/changelog",
+    "@semantic-release/npm",
+    "@semantic-release/git"
+  ],
+  "generateNotes": {
+    "preset": "metahub"
+  },
+  "prepare": [
+    {
+      "path": "@semantic-release/changelog",
+      "changelogFile": "CHANGELOG.md"
+    },
+    {
+      "path": "@semantic-release/git",
+      "assets": [
+        "CHANGELOG.md"
+      ]
+    },
+    "@semantic-release/npm"
+  ],
+  "publish": [
+    "@semantic-release/npm",
+    "@semantic-release/github"
+  ],
+  "success": [
+    "@semantic-release/github"
+  ],
+  "fail": [
+    "@semantic-release/github"
+  ]
+}

test/fixtures/add-editable/expected/path-to-external-model/.travis.yml

@@ -0,0 +1,25 @@
+language: node_js
+notifications:
+  email: false
+node_js:
+  - lts/*
+sudo: false
+dist: trusty
+branches:
+  only:
+  - master
+env:
+  global:
+    - TIMEOUT=15000
+install:
+  - travis_retry npm install
+test:
+  - npm test
+before_deploy:
+  - npm run coverage
+deploy:
+  - provider: script
+    skip_cleanup: true
+    script: npx semantic-release
+    on:
+      branch: master