adonisjs-queue/commands/Job/Base.js

An addon/plugin package to provide driver-based job queueing services in AdonisJS 4.0+

'use strict'

/*
 *
 * adonis-queue
 *
 *
 * (c) Harminder Virk <virk@adonisjs.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
*/

const path = require('path')
const { Command } = require('@adonisjs/ace')

const options = {
  appDir: 'app',
  dirs: {
    jobs: 'Jobs'
  }
}

class JobBase extends Command {
  /**
   * Ensures the command is executed within the
   * project root
   *
   * @method ensureInProjectRoot
   *
   * @return {void}
   */
  async ensureInProjectRoot () {
    const acePath = path.join(process.cwd(), 'ace')
    const exists = await this.pathExists(acePath)

    if (!exists) {
      throw new Error(`Make sure you are inside an Adonisjs app to run ${this.constructor.commandName} command`)
    }
  }

  /**
   * Generates the blueprint for a given resources
   * using pre-defined template
   *
   * @method generateBlueprint
   *
   * @param  {String}         templateFor
   * @param  {String}         name
   * @param  {Object}         flags
   *
   * @return {Object}
   */
  async generateBlueprint (templateFor, name, flags) {
    const generators = require('./Generators')

    options.appRoot = options.appRoot || process.cwd()

    const templateFile = path.join(__dirname, './Generators/templates', `${templateFor}.mustache`)

    const filePath = generators[templateFor].getFilePath(name, options)
    const data = generators[templateFor].getData(name, flags)

    const templateContents = await this.readFile(templateFile, 'utf-8')
    console.log(`${this.chalk.gray('Generating file(s) for')} - ${this.chalk.cyan(name)}`)

    await this.generateFile(filePath, templateContents, data)

    const createdFile = filePath.replace(process.cwd(), '').replace(path.sep, '')
    console.log(`${this.icon('success')} ${this.chalk.green('create')}  ${createdFile}`)

    return { file: createdFile, namespace: this.getNamespace(createdFile, templateFor) }
  }

  /**
   * Returns namespace for a given resource
   *
   * @method getNamespace
   *
   * @param  {String}     filePath
   * @param  {String}     namespaceFor
   *
   * @return {String}
   */
  getNamespace (filePath, namespaceFor) {
    const dir = options.dirs[namespaceFor] || options.dirs[`${namespaceFor}s`]
    return `App/${dir}/${path.basename(filePath).replace('.js', '')}`
  }
}

module.exports = JobBase