What do you think about adding another method to the model instance that actually does the validation on saving?

[anyong]

Rough example:

module.exports = function (bookshelf, validator) {
  'use strict';

  let Model = bookshelf.Model.extend({
    validationErrors: function () {
        // existing code...
    },

    initialize: function () {
        // attach event listener to do the validations on save
        if (typeof this.validateOnSave === 'function') {
            this.on('saving', this.validateSave);
        }
    },

    validateOnSave: Promise.method(function () {
        var errors = this.validationErrors();
        if (errors == null) {
            return null;
        }
        // Throw the errors or something so the model won't save.
    })
  });

  bookshelf.Model = Model;
};

If you want to override initialize in a model then you need to do:

initialize: function () {
    bookshelf.Model.prototype.initialize.apply(this);
    // more initialization here
}

I'm currently using your plugin like this and it works really nicely, saves me a ton of boilerplate. Thanks!

[kripod]

I decided to use a separate validationErrors method in order to get information about more errors at once. You could add an optional attribute which triggers validation automatically before saving the Model: I'd happily accept a pull request for that! 😊

Also, I think there should be a custom Error object made for throwing exceptions.

[anyong]

Also, I think there should be a custom Error object made for throwing exceptions.

This is possible, but then you would probably also want to have your validations look like this:

validations: {
    email: [
        {
            method: 'isEmail',
            options: {/* validator isEmail options object */},
            error: 'E_INVALID_EMAIL'
        }
    ]
}

and the corresponding error messages:

{
    email: ['E_INVALID_EMAIL']
}

instead of the current one which returns just the called method name.

That way you can throw a custom error message for each validation even if it uses the same validation method in different models.

With that setup though it would reduce boilerplate to almost nothing, and just adding the validations object to a model would do pretty much everything you need.

[anyong]

Also, not sure if you're interested but I refactored the plugin just to be a bit cleaner, get rid of the new Function eval, changed all of your let to const where possible, and got rid of the continue statements in favor of control flow logic.

If you want to use that, I can make a pull request with it and for the custom error and auto-validate on save stuff after I write that.

[kripod]

That would be great, but please, submit the Error emission feature as a separate pull request.

I'd suggest to create a new ValidationError object with a data argument which shall return the values returned by the Model.validationErrors() function instead of adding an error property to Model.validations.[property]

[anyong]

Ok this is working really well, I'm happy with the result. I also recommend not adding the special isRequired checks in the Plugin, but rather onto the validator object as a normal method.

I'll make a couple of PRs in a minute...

[kripod]

Thank you very much for all the help you provided! I highly appreciate all of your efforts towards my project.