Merge pull request #6 from juampi92/dev

2.0.0 merge

Author: juampi92

README.md

@@ -5,11 +5,12 @@ This package brings you a MongooseProvider that connects to the database, a Mong
 
 <img src="http://res.cloudinary.com/adonisjs/image/upload/q_100/v1497112678/adonis-purple_pzkmzt.svg" width="200px" align="right" hspace="30px" vspace="50px">
 
-## What's in the box?
+## Features
 
 1. Support for Mongoose model creation.
-2. Support for a Mongoose serializer.
-3. Adonis command for creating mongoose models
+2. Strong BaseModel that's Hook compatible, indexable and easy es6 inheritance
+3. Support for a Mongoose serializer.
+4. Adonis command for creating mongoose models
 
 ## Installation
 You can install the package from npm.

commands/MakeModel.js

@@ -45,7 +45,11 @@ class MakeMongoose extends Command {
    * @return {String}
    */
   static get signature () {
-    return 'make:mongoose {name : Name of the Mongoose Model}'
+    return `make:mongoose
+      { name? : Name of the Mongoose Model }
+      { --simple : Ignore prompts when creating the model }
+      { --raw : Creates a vanilla mongoose model }
+    `
   }
 
   /* istanbul ignore next */
@@ -69,11 +73,18 @@ class MakeMongoose extends Command {
    *
    * @return {void}
    */
-  async handle ({ name }) {
+  async handle ({ name = null }, { simple = false, raw = false }) {
+
+    if (!name) {
+      name = await this.ask('Enter model name')
+    }
+
+    const mustachePath = raw ? 'raw_model' : 'model'
+
     /**
      * Reading template as a string form the mustache file
      */
-    const template = await this.readFile(path.join(__dirname, './templates/model.mustache'), 'utf8')
+    const template = await this.readFile(path.join(__dirname, `./templates/${mustachePath}.mustache`), 'utf8')
 
     /**
      * Directory paths
@@ -89,12 +100,29 @@ class MakeMongoose extends Command {
      */
     name = name.split('/').pop()
 
+    let options = {}
+
+    if (!simple && !raw) {
+      options.timestamps = await this
+        .confirm('Include timestamps?')
+
+      options.boot = await this
+        .confirm('Include boot method?')
+
+    }
+
+    const templ_options = {
+      name,
+      exclude_timestamps: !simple ? !options.timestamps : false,
+      include_boot: !simple ? options.boot : true
+    }
+
     /**
      * If command is not executed via command line, then return
      * the response
      */
     if (!this.viaAce) {
-      return this.generateFile(validatorPath, template, { name })
+      return this.generateFile(validatorPath, template, templ_options)
     }
 
     /* istanbul ignore next */
@@ -103,7 +131,7 @@ class MakeMongoose extends Command {
      * to the end user.
      */
     try {
-      await this.generateFile(validatorPath, template, { name })
+      await this.generateFile(validatorPath, template, templ_options)
       this.completed('create', relativePath)
     } catch (error) {
       this.error(`${relativePath} validator already exists`)

commands/templates/model.mustache

@@ -1,24 +1,36 @@
 'use strict'
 
-const mongoose = use('Mongoose')
-const { Schema } = mongoose
-const Model = use('Model')
+const BaseModel = use('Model')
 
 /**
- * {{ name }}'s db Schema
+ * @class {{ name }}
  */
-const {{ name }}Schema = new Schema({
-
-})
-
-/**
- * {{ name }}'s instance and static methods
- * @class
- */
-class {{ name }} extends Model {
+class {{ name }} extends BaseModel {
+  {{#exclude_timestamps}}
+  /**
+   * Exclude created_at and updated_at from the model
+   */
+  static get timestamps () {
+    return false
+  }
+  {{/exclude_timestamps}}
+  {{#include_boot}}
+  static boot () {
+    // Hooks:
+    // this.addHook('preSave', () => {})
+    // this.addHook('preSave', '{{ name }}Hook.method')
+    // Indexes:
+    // this.index({}, {background: true})
+  }
+  {{/include_boot}}
+  /**
+   * {{ name }}'s schema
+   */
+  static get schema () {
+    return {
 
+    }
+  }
 }
 
-{{ name }}Schema.loadClass({{ name }})
-
-module.exports = mongoose.model('{{ name }}', {{ name }}Schema)
+module.exports = {{ name }}.buildModel('{{ name }}')

commands/templates/raw_model.mustache

@@ -0,0 +1,23 @@
+'use strict'
+
+const mongoose = use('Mongoose')
+const { Schema } = mongoose
+
+/**
+ * {{ name }}'s db Schema
+ */
+const {{ name }}Schema = new Schema({
+
+})
+
+/**
+ * {{ name }}'s instance and static methods
+ * @class
+ */
+class {{ name }} {
+
+}
+
+{{ name }}Schema.loadClass({{ name }})
+
+module.exports = mongoose.model('{{ name }}', {{ name }}Schema)