Ghost/core/server/models/product.js
Fabien O'Carroll cbac3d1eb0 Added Benefit model
refs https://github.com/TryGhost/Team/issues/806

This is the model to represent the Benefit resource stored in the
`benefits` table. The `onSaving` method has been copied from the Tag
model and ensures that we have a unique slug.
2021-06-29 16:53:15 +01:00

117 lines
3.6 KiB
JavaScript

const ghostBookshelf = require('./base');
const _ = require('lodash');
const Product = ghostBookshelf.Model.extend({
tableName: 'products',
async onSaving(model, _attr, options) {
ghostBookshelf.Model.prototype.onSaving.apply(this, arguments);
if (model.get('name')) {
model.set('name', model.get('name').trim());
}
if (model.hasChanged('slug') || !model.get('slug')) {
const slug = model.get('slug') || model.get('name');
if (slug) {
const cleanSlug = await ghostBookshelf.Model.generateSlug(Product, slug, {
transacting: options.transacting
});
model.set({slug: cleanSlug});
}
}
let benefitsToSave = [];
if (_.isUndefined(this.get('benefits'))) {
this.unset('benefits');
return;
}
// CASE: detect lowercase/uppercase label slugs
if (!_.isUndefined(this.get('benefits')) && !_.isNull(this.get('benefits'))) {
benefitsToSave = [];
// and deduplicate upper/lowercase tags
_.each(this.get('benefits'), function each(item) {
item.name = item.name && item.name.trim();
for (let i = 0; i < benefitsToSave.length; i = i + 1) {
if (benefitsToSave[i].name && item.name && benefitsToSave[i].name.toLocaleLowerCase() === item.name.toLocaleLowerCase()) {
return;
}
}
benefitsToSave.push(item);
});
}
const existingBenefits = await ghostBookshelf.model('Benefit').findAll(Object.assign({
columns: ['id', 'name']
}, _.pick(options, 'transacting')));
benefitsToSave.forEach((benefitToSave) => {
const existingBenefitModel = existingBenefits.find((existingBenefit) => {
return benefitToSave.name.toLowerCase() === existingBenefit.get('name').toLowerCase();
});
if (existingBenefitModel) {
benefitToSave.name = existingBenefitModel.get('name');
}
});
model.set('benefits', benefitsToSave);
},
/**
* The base model keeps only the columns, which are defined in the schema.
* We have to add the relations on top, otherwise bookshelf-relations
* has no access to the nested relations, which should be updated.
*/
permittedAttributes: function permittedAttributes() {
let filteredKeys = ghostBookshelf.Model.prototype.permittedAttributes.apply(this, arguments);
this.relationships.forEach((key) => {
filteredKeys.push(key);
});
return filteredKeys;
},
monthlyPrice() {
return this.belongsTo('StripePrice', 'monthly_price_id', 'id');
},
yearlyPrice() {
return this.belongsTo('StripePrice', 'yearly_price_id', 'id');
},
stripeProducts() {
return this.hasMany('StripeProduct', 'product_id', 'id');
},
stripePrices() {
return this.belongsToMany(
'StripePrice',
'stripe_products',
'product_id',
'stripe_product_id',
'id',
'stripe_product_id'
);
},
members() {
return this.belongsToMany('Member', 'members_products', 'product_id', 'member_id');
}
});
const Products = ghostBookshelf.Collection.extend({
model: Product
});
module.exports = {
Product: ghostBookshelf.model('Product', Product),
Products: ghostBookshelf.collection('Products', Products)
};