refactor: change mongoose models to use ES6 classes

models/Comment.js

@@ -1,6 +1,6 @@
 const mongoose = require('mongoose');
 
-const CommentSchema = new mongoose.Schema(
+const schema = new mongoose.Schema(
   {
     body: String,
     author: { type: mongoose.Schema.Types.ObjectId, ref: 'User' },
@@ -9,14 +9,17 @@ const CommentSchema = new mongoose.Schema(
   { timestamps: true },
 );
 
-// Requires population of author
+class Comment extends mongoose.Model {
-CommentSchema.methods.toJSONFor = function (user) {
+  toJSONFor(user) {
     return {
       id: this._id,
       body: this.body,
       createdAt: this.createdAt,
       author: this.author.toProfileJSONFor(user),
     };
-};
+  }
+}
 
-mongoose.model('Comment', CommentSchema);
+mongoose.model(Comment, schema);
+
+module.exports = Comment;

models/Track.js

@@ -2,7 +2,7 @@ const mongoose = require('mongoose');
 const uniqueValidator = require('mongoose-unique-validator');
 const slug = require('slug');
 
-const TrackSchema = new mongoose.Schema(
+const schema = new mongoose.Schema(
   {
     slug: { type: String, lowercase: true, unique: true },
     title: String,
@@ -18,9 +18,9 @@ const TrackSchema = new mongoose.Schema(
   { timestamps: true },
 );
 
-TrackSchema.plugin(uniqueValidator, { message: 'is already taken' });
+schema.plugin(uniqueValidator, { message: 'is already taken' });
 
-TrackSchema.pre('validate', function (next) {
+schema.pre('validate', function (next) {
   if (!this.slug) {
     this.slugify();
   }
@@ -28,11 +28,12 @@ TrackSchema.pre('validate', function (next) {
   next();
 });
 
-TrackSchema.methods.slugify = function () {
+class Track extends mongoose.Model {
+  slugify() {
     this.slug = slug(this.title) + '-' + ((Math.random() * Math.pow(36, 6)) | 0).toString(36);
-};
+  }
 
-TrackSchema.methods.isVisibleTo = function (user) {
+  isVisibleTo(user) {
     if (this.visible) {
       return true;
     }
@@ -46,9 +47,9 @@ TrackSchema.methods.isVisibleTo = function (user) {
     }
 
     return false;
-};
+  }
 
-TrackSchema.methods.toJSONFor = function (user, include) {
+  toJSONFor(user, include) {
     return {
       slug: this.slug,
       title: this.title,
@@ -60,6 +61,9 @@ TrackSchema.methods.toJSONFor = function (user, include) {
       author: this.author.toProfileJSONFor(user),
       ...(include && include.body ? { body: this.body } : {}),
     };
-};
+  }
+}
 
-mongoose.model('Track', TrackSchema);
+mongoose.model(Track, schema);
+
+module.exports = Track;

models/TrackData.js

@@ -2,7 +2,7 @@ const mongoose = require('mongoose');
 const uniqueValidator = require('mongoose-unique-validator');
 const slug = require('slug');
 
-const TrackDataSchema = new mongoose.Schema(
+const schema = new mongoose.Schema(
   {
     slug: { type: String, lowercase: true, unique: true },
     points: [
@@ -23,17 +23,21 @@ const TrackDataSchema = new mongoose.Schema(
   { timestamps: true },
 );
 
-TrackDataSchema.plugin(uniqueValidator, { message: 'is already taken' });
+schema.plugin(uniqueValidator, { message: 'is already taken' });
 
-TrackDataSchema.pre('validate', function (next) {
+schema.pre('validate', function (next) {
   if (!this.slug) {
     this.slugify();
   }
   next();
 });
 
-TrackDataSchema.methods.slugify = function () {
+class TrackData extends mongoose.Model {
-  this.slug = slug('td') + '-' + ((Math.random() * Math.pow(36, 6)) | 0).toString(36);
+  slugify() {
-};
+    this.slug = 'td-' + String((Math.random() * Math.pow(36, 6)) | 0).toString(36);
+  }
+}
 
-mongoose.model('TrackData', TrackDataSchema);
+mongoose.model(TrackData, schema);
+
+module.exports = TrackData;

models/User.js

@@ -4,7 +4,7 @@ const crypto = require('crypto');
 const jwt = require('jsonwebtoken');
 const secret = require('../config').secret;
 
-const UserSchema = new mongoose.Schema(
+const schema = new mongoose.Schema(
   {
     username: {
       type: String,
@@ -39,19 +39,20 @@ const UserSchema = new mongoose.Schema(
   { timestamps: true },
 );
 
-UserSchema.plugin(uniqueValidator, { message: 'ist bereits vergeben. Sorry!' });
+schema.plugin(uniqueValidator, { message: 'ist bereits vergeben. Sorry!' });
 
-UserSchema.methods.validPassword = function (password) {
+class User extends mongoose.Model {
+  validPassword(password) {
     const hash = crypto.pbkdf2Sync(password, this.salt, 10000, 512, 'sha512').toString('hex');
     return this.hash === hash;
-};
+  }
 
-UserSchema.methods.setPassword = function (password) {
+  setPassword(password) {
     this.salt = crypto.randomBytes(16).toString('hex');
     this.hash = crypto.pbkdf2Sync(password, this.salt, 10000, 512, 'sha512').toString('hex');
-};
+  }
 
-UserSchema.methods.generateJWT = function () {
+  generateJWT() {
     const today = new Date();
     const exp = new Date(today);
     exp.setDate(today.getDate() + 60);
@@ -64,9 +65,9 @@ UserSchema.methods.generateJWT = function () {
       },
       secret,
     );
-};
+  }
 
-UserSchema.methods.toAuthJSON = function () {
+  toAuthJSON() {
     return {
       username: this.username,
       email: this.email,
@@ -76,59 +77,50 @@ UserSchema.methods.toAuthJSON = function () {
       areTracksVisibleForAll: this.areTracksVisibleForAll,
       apiKey: this._id,
     };
-};
+  }
 
-UserSchema.methods.toProfileJSONFor = function (user) {
+  toProfileJSONFor(user) {
     return {
       username: this.username,
       bio: this.bio,
       image: this.image || 'https://static.productionready.io/images/smiley-cyrus.jpg',
       following: user ? user.isFollowing(this._id) : false,
     };
-};
+  }
 
-UserSchema.methods.favorite = function (id) {
+  async favorite(id) {
     if (this.favorites.indexOf(id) === -1) {
       this.favorites.push(id);
     }
 
-  return this.save();
+    return await this.save();
-};
+  }
 
-UserSchema.methods.unfavorite = function (id) {
+  async unfavorite(id) {
     this.favorites.remove(id);
-  return this.save();
+    return await this.save();
-};
+  }
 
-UserSchema.methods.isFavorite = function (id) {
+  follow(id) {
-  return this.favorites.some(function (favoriteId) {
-    return favoriteId.toString() === id.toString();
-  });
-};
-
-UserSchema.methods.isTrackVisible = function (id) {
-  return this.areTracksVisibleForAll();
-};
-
-UserSchema.methods.follow = function (id) {
     if (this.following.indexOf(id) === -1) {
       this.following.push(id);
     }
 
     return this.save();
-};
+  }
 
-UserSchema.methods.unfollow = function (id) {
+  unfollow(id) {
     this.following.remove(id);
     return this.save();
-};
+  }
 
-UserSchema.methods.isFollowing = function (id) {
+  isFollowing(id) {
     return this.following.some(function (followId) {
       return followId.toString() === id.toString();
     });
-};
+  }
+}
 
-mongoose.model('User', UserSchema);
+mongoose.model(User, schema);
 
-module.exports = mongoose.model('User');
+module.exports = User;