From d9dc198d463a5bb97558e44b5ce6312769a853b8 Mon Sep 17 00:00:00 2001 From: David Erwin Date: Thu, 10 Nov 2016 14:52:05 -0500 Subject: [PATCH 1/4] Moved chained funcitons to multiple lines --- .eslintrc.json | 3 +- bin/cli-settings | 6 +- bin/cli-users | 9 +- .../src/containers/ModerationQueue.js | 17 ++- client/coral-framework/store/actions/items.js | 3 +- client/coral-plugin-commentbox/CommentBox.js | 3 +- models/user.js | 3 +- routes/api/comments/index.js | 137 +++++++++++------- routes/api/settings/index.js | 10 +- routes/api/stream/index.js | 3 +- tests/routes/api/settings/index.js | 6 +- 11 files changed, 131 insertions(+), 69 deletions(-) diff --git a/.eslintrc.json b/.eslintrc.json index 23bdea410..6ac5a08e6 100644 --- a/.eslintrc.json +++ b/.eslintrc.json @@ -59,6 +59,7 @@ "no-multiple-empty-lines": [ "error", {"max": 1} - ] + ], + "newline-per-chained-call": ["error", { "ignoreChainWithDepth": 2 }] } } diff --git a/bin/cli-settings b/bin/cli-settings index 0920473da..cff6c04ed 100755 --- a/bin/cli-settings +++ b/bin/cli-settings @@ -24,11 +24,13 @@ program const Setting = require('../models/setting'); const defaults = {id: '1', moderation: 'pre'}; - Setting.update({id: '1'}, {$setOnInsert: defaults}, {upsert: true}) + Setting + .update({id: '1'}, {$setOnInsert: defaults}, {upsert: true}) .then(() => { console.log('Created settings object.'); mongoose.disconnect(); - }).catch((err) => { + }) + .catch((err) => { console.error(`failed to create the settings object ${JSON.stringify(err)}`); throw new Error(err); // just to be safe }); diff --git a/bin/cli-users b/bin/cli-users index 74aa902eb..b27c41e14 100755 --- a/bin/cli-users +++ b/bin/cli-users @@ -71,10 +71,12 @@ function createUser(options) { }) .then((result) => { return User.createLocalUser(result.email.trim(), result.password.trim(), result.displayName.trim()); - }).then((user) => { + }) + .then((user) => { console.log(`Created user ${user.id}.`); mongoose.disconnect(); - }).catch((err) => { + }) + .catch((err) => { console.error(err); mongoose.disconnect(); }); @@ -249,7 +251,8 @@ function mergeUsers(dstUserID, srcUserID) { .then(() => { console.log(`User ${srcUserID} was merged into user ${dstUserID}.`); mongoose.disconnect(); - }).catch((err) => { + }) + .catch((err) => { console.error(err); mongoose.disconnect(); }); diff --git a/client/coral-admin/src/containers/ModerationQueue.js b/client/coral-admin/src/containers/ModerationQueue.js index 6cd9f46fc..9178bda57 100644 --- a/client/coral-admin/src/containers/ModerationQueue.js +++ b/client/coral-admin/src/containers/ModerationQueue.js @@ -73,7 +73,12 @@ class ModerationQueue extends React.Component { !comments.get('byId').get(id).get('status'))} + commentIds={ + comments.get('ids') + .filter(id => !comments.get('byId') + .get(id) + .get('status')) + } comments={comments.get('byId')} onClickAction={(action, id) => this.onCommentAction(action, id)} actions={['reject', 'approve']} @@ -83,7 +88,15 @@ class ModerationQueue extends React.Component { comments.get('byId').get(id).get('status') === 'rejected')} + commentIds={ + comments + .get('ids') + .filter(id => + comments + .get('byId') + .get(id) + .get('status') === 'rejected') + } comments={comments.get('byId')} onClickAction={(action, id) => this.onCommentAction(action, id)} actions={['approve']} diff --git a/client/coral-framework/store/actions/items.js b/client/coral-framework/store/actions/items.js index b690c6f0a..173413d66 100644 --- a/client/coral-framework/store/actions/items.js +++ b/client/coral-framework/store/actions/items.js @@ -241,7 +241,8 @@ export function postAction (item_id, action_type, user_id, item_type) { return response.ok ? response.json() : Promise.reject(`${response.status} ${response.statusText}`); } - ).then((json)=>{ + ) + .then((json)=>{ return json; }); }; diff --git a/client/coral-plugin-commentbox/CommentBox.js b/client/coral-plugin-commentbox/CommentBox.js index a4e32d73b..dbcd9dd97 100644 --- a/client/coral-plugin-commentbox/CommentBox.js +++ b/client/coral-plugin-commentbox/CommentBox.js @@ -40,7 +40,8 @@ class CommentBox extends Component { .then((comment_id) => { appendItemArray(parent_id || id, related, comment_id, !parent_id, parent_type); addNotification('success', 'Your comment has been posted.'); - }).catch((err) => console.error(err)); + }) + .catch((err) => console.error(err)); this.setState({body: ''}); } diff --git a/models/user.js b/models/user.js index 6800b59ef..0370a7e33 100644 --- a/models/user.js +++ b/models/user.js @@ -112,7 +112,8 @@ UserSchema.statics.mergeUsers = function(dstUserID, srcUserID) { }); return srcUser.remove(); - }).then(() => dstUser.save()); + }) + .then(() => dstUser.save()); }; /** diff --git a/routes/api/comments/index.js b/routes/api/comments/index.js index a2e77b417..3a0129ff4 100644 --- a/routes/api/comments/index.js +++ b/routes/api/comments/index.js @@ -12,17 +12,21 @@ const router = express.Router(); router.get('/', (req, res, next) => { Comment.find({}).then((comments) => { res.status(200).json(comments); - }).catch(error => { + }) + .catch(error => { next(error); }); }); router.get('/:comment_id', (req, res, next) => { - Comment.findById(req.params.comment_id).then((comment) => { - res.status(200).json(comment); - }).catch(error => { - next(error); - }); + Comment + .findById(req.params.comment_id) + .then(comment => { + res.status(200).json(comment); + }) + .catch(error => { + next(error); + }); }); //============================================================================== @@ -31,20 +35,26 @@ router.get('/:comment_id', (req, res, next) => { // Get all the comments that have that action_type over them. router.get('/action/:action_type', (req, res, next) => { - Comment.findByActionType(req.params.action_type).then((comments) => { - res.status(200).json(comments); - }).catch(error => { - next(error); - }); + Comment + .findByActionType(req.params.action_type) + .then((comments) => { + res.status(200).json(comments); + }) + .catch(error => { + next(error); + }); }); // Get all the comments that were rejected. router.get('/status/rejected', (req, res, next) => { - Comment.findByStatus('rejected').then((comments) => { - res.status(200).json(comments); - }).catch(error => { - next(error); - }); + Comment + .findByStatus('rejected') + .then(comments => { + res.status(200).json(comments); + }) + .catch(error => { + next(error); + }); }); // Returns back all the comments that are in the moderation queue. The moderation queue is pre or post moderated, @@ -52,17 +62,23 @@ router.get('/status/rejected', (req, res, next) => { // Pre-moderation: New comments are shown in the moderator queues immediately. // Post-moderation: New comments do not appear in moderation queues unless they are flagged by other users. router.get('/status/pending', (req, res, next) => { - Setting.getModerationSetting().then(function({moderation}){ - let moderationValue = req.query.moderation; - if (typeof moderationValue === 'undefined' || moderationValue === undefined) { - moderationValue = moderation; - } - Comment.moderationQueue(moderationValue).then((comments) => { - res.status(200).json(comments); + + Setting + .getModerationSetting() + .then(function({moderation}){ + let moderationValue = req.query.moderation; + if (typeof moderationValue === 'undefined' || moderationValue === undefined) { + moderationValue = moderation; + } + Comment + .moderationQueue(moderationValue) + .then((comments) => { + res.status(200).json(comments); + }); + }) + .catch(error => { + next(error); }); - }).catch(error => { - next(error); - }); }); //============================================================================== @@ -70,27 +86,36 @@ router.get('/status/pending', (req, res, next) => { //============================================================================== router.post('/', (req, res, next) => { + const {body, author_id, asset_id, parent_id, status, username} = req.body; - Comment.new(body, author_id, asset_id, parent_id, status, username).then((comment) => { - res.status(200).send({'id': comment.id}); - }).catch(error => { - next(error); - }); + + Comment + .new(body, author_id, asset_id, parent_id, status, username) + .then((comment) => { + res.status(200).send({'id': comment.id}); + }) + .catch(error => { + next(error); + }); }); router.post('/:comment_id', (req, res, next) => { - Comment.findById(req.params.comment_id).then((comment) => { - comment.body = req.body.body; - comment.author_id = req.body.author_id; - comment.asset_id = req.body.asset_id; - comment.parent_id = req.body.parent_id; - comment.status = req.body.status; - return comment.save(); - }).then((comment) => { - res.status(200).send(comment); - }).catch(error => { - next(error); - }); + Comment + .findById(req.params.comment_id) + .then((comment) => { + comment.body = req.body.body; + comment.author_id = req.body.author_id; + comment.asset_id = req.body.asset_id; + comment.parent_id = req.body.parent_id; + comment.status = req.body.status; + return comment.save(); + }) + .then((comment) => { + res.status(200).send(comment); + }) + .catch(error => { + next(error); + }); }); router.post('/:comment_id/status', (req, res, next) => { @@ -103,11 +128,14 @@ router.post('/:comment_id/status', (req, res, next) => { }); router.post('/:comment_id/actions', (req, res, next) => { - Comment.addAction(req.params.comment_id, req.body.user_id, req.body.action_type).then((action) => { - res.status(200).send(action); - }).catch(error => { - next(error); - }); + Comment + .addAction(req.params.comment_id, req.body.user_id, req.body.action_type) + .then((action) => { + res.status(200).send(action); + }) + .catch(error => { + next(error); + }); }); //============================================================================== @@ -115,11 +143,14 @@ router.post('/:comment_id/actions', (req, res, next) => { //============================================================================== router.delete('/:comment_id', (req, res, next) => { - Comment.removeById(req.params.comment_id).then(() => { - res.status(201).send('OK. Removed'); - }).catch(error => { - next(error); - }); + Comment + .removeById(req.params.comment_id) + .then(() => { + res.status(201).send('OK. Removed'); + }) + .catch(error => { + next(error); + }); }); module.exports = router; diff --git a/routes/api/settings/index.js b/routes/api/settings/index.js index 53bf53f3c..585bf083a 100644 --- a/routes/api/settings/index.js +++ b/routes/api/settings/index.js @@ -3,11 +3,17 @@ const router = express.Router(); const Setting = require('../../../models/setting'); router.get('/', (req, res, next) => { - Setting.getSettings().then(settings => res.json(settings)).catch(next); + Setting + .getSettings() + .then(settings => res.json(settings)) + .catch(next); }); router.put('/', (req, res, next) => { - Setting.updateSettings(req.body).then(() => res.status(204).end()).catch(next); + Setting + .updateSettings(req.body) + .then(() => res.status(204).end()) + .catch(next); }); module.exports = router; diff --git a/routes/api/stream/index.js b/routes/api/stream/index.js index 1e3e39d81..3f49d48fc 100644 --- a/routes/api/stream/index.js +++ b/routes/api/stream/index.js @@ -36,7 +36,8 @@ router.get('/', (req, res, next) => { users, actions }); - }).catch(error => { + }) + .catch(error => { next(error); }); }); diff --git a/tests/routes/api/settings/index.js b/tests/routes/api/settings/index.js index 5bcf9de28..41c37828e 100644 --- a/tests/routes/api/settings/index.js +++ b/tests/routes/api/settings/index.js @@ -43,11 +43,13 @@ describe('update settings', () => { return Setting.getSettings(); - }).then(settings => { + }) + .then(settings => { // confirm updated settings in db expect(settings).to.have.property('moderation'); expect(settings.moderation).to.equal('post'); - }).catch(err => { + }) + .catch(err => { throw err; }); }); From 89398120d5ca770d08654d90346a6d31f1da3314 Mon Sep 17 00:00:00 2001 From: David Erwin Date: Thu, 10 Nov 2016 14:57:57 -0500 Subject: [PATCH 2/4] Remove function keyword --- routes/api/comments/index.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/routes/api/comments/index.js b/routes/api/comments/index.js index 3a0129ff4..e8a995089 100644 --- a/routes/api/comments/index.js +++ b/routes/api/comments/index.js @@ -65,7 +65,7 @@ router.get('/status/pending', (req, res, next) => { Setting .getModerationSetting() - .then(function({moderation}){ + .then(({moderation}) => { let moderationValue = req.query.moderation; if (typeof moderationValue === 'undefined' || moderationValue === undefined) { moderationValue = moderation; From f7249c4016e7b5c802771ffbabde7f98aebd0558 Mon Sep 17 00:00:00 2001 From: David Erwin Date: Thu, 10 Nov 2016 15:12:56 -0500 Subject: [PATCH 3/4] More linting and commenting --- models/comment.js | 25 +++++++++--- models/setting.js | 9 +++-- models/user.js | 73 +++++++++++++++++++----------------- routes/api/comments/index.js | 20 +++------- 4 files changed, 67 insertions(+), 60 deletions(-) diff --git a/models/comment.js b/models/comment.js index 3f99bcb6a..a80e353f0 100644 --- a/models/comment.js +++ b/models/comment.js @@ -86,9 +86,13 @@ CommentSchema.statics.findAcceptedAndNewByAssetId = function(asset_id) { * @param {String} action_type the type of action that was performed on the comment */ CommentSchema.statics.findByActionType = function(action_type) { - return Action.findCommentsIdByActionType(action_type, 'comment').then((actions) => { - return Comment.find({'id': {'$in': actions.map(function(a){return a.item_id;})}}); - }); + return Action + .findCommentsIdByActionType(action_type, 'comment') + .then((actions) => { + return Comment.find({'id': {'$in': actions.map(function(a){ + return a.item_id;})} + }); + }); }; /** @@ -97,9 +101,18 @@ CommentSchema.statics.findByActionType = function(action_type) { * @param {String} status the status of the comment to search for */ CommentSchema.statics.findByStatusByActionType = function(status, action_type) { - return Action.findCommentsIdByActionType(action_type, 'comment').then((actions) => { - return Comment.find({'status': status, 'id': {'$in': actions.map(function(a){return a.item_id;})}}); - }); + return Action + .findCommentsIdByActionType(action_type, 'comment') + .then((actions) => { + + return Comment.find({ + 'status': status, + 'id': {'$in': actions.map(a => { + return a.item_id;} + )} + }); + + }); }; /** diff --git a/models/setting.js b/models/setting.js index 15c457307..7d1f4b367 100644 --- a/models/setting.js +++ b/models/setting.js @@ -12,7 +12,7 @@ const SettingSchema = new Schema({ }); /** - * gets the entire settings record and sends it back + * Gets the entire settings record and sends it back * @return {Promise} settings the whole settings record */ SettingSchema.statics.getSettings = function () { @@ -20,7 +20,7 @@ SettingSchema.statics.getSettings = function () { }; /** - * gets the moderation settings and sends it back + * Gets the moderation settings and sends it back * @return {Promise} moderation the settings for how to moderate comments */ SettingSchema.statics.getModerationSetting = function () { @@ -28,12 +28,13 @@ SettingSchema.statics.getModerationSetting = function () { }; /** - * this will update the settings object with whatever you pass in + * This will update the settings object with whatever you pass in * @param {object} setting a hash of whatever settings you want to update * @return {Promise} settings Promise that resolves to the entire (updated) settings object. */ SettingSchema.statics.updateSettings = function (setting) { - // there should only ever be one record unless something has gone wrong. + // There should only ever be one record unless something has gone wrong. + // In the future we may have multiple records for custom settings for objects/users. return this.findOneAndUpdate({id: '1'}, {$set: setting}, {new: true}); }; diff --git a/models/user.js b/models/user.js index 0370a7e33..ac642c910 100644 --- a/models/user.js +++ b/models/user.js @@ -100,20 +100,22 @@ UserSchema.statics.findLocalUser = function(email, password) { UserSchema.statics.mergeUsers = function(dstUserID, srcUserID) { let srcUser, dstUser; - return Promise.all([ - User.findOne({id: dstUserID}).exec(), - User.findOne({id: srcUserID}).exec() - ]).then((users) => { - dstUser = users[0]; - srcUser = users[1]; + return Promise + .all([ + User.findOne({id: dstUserID}).exec(), + User.findOne({id: srcUserID}).exec() + ]) + .then((users) => { + dstUser = users[0]; + srcUser = users[1]; - srcUser.profiles.forEach((profile) => { - dstUser.profiles.push(profile); - }); + srcUser.profiles.forEach((profile) => { + dstUser.profiles.push(profile); + }); - return srcUser.remove(); - }) - .then(() => dstUser.save()); + return srcUser.remove(); + }) + .then(() => dstUser.save()); }; /** @@ -123,33 +125,34 @@ UserSchema.statics.mergeUsers = function(dstUserID, srcUserID) { * @param {Function} done [description] */ UserSchema.statics.findOrCreateExternalUser = function(profile) { - return User.findOne({ - profiles: { - $elemMatch: { - id: profile.id, - provider: profile.provider - } - } - }) - .then((user) => { - if (user) { - return user; - } - - // The user was not found, lets create them! - user = new User({ - displayName: profile.displayName, - roles: [], - profiles: [ - { + return User + .findOne({ + profiles: { + $elemMatch: { id: profile.id, provider: profile.provider } - ] - }); + } + }) + .then((user) => { + if (user) { + return user; + } - return user.save(); - }); + // The user was not found, lets create them! + user = new User({ + displayName: profile.displayName, + roles: [], + profiles: [ + { + id: profile.id, + provider: profile.provider + } + ] + }); + + return user.save(); + }); }; UserSchema.statics.changePassword = function(id, password) { diff --git a/routes/api/comments/index.js b/routes/api/comments/index.js index e8a995089..5126bf93c 100644 --- a/routes/api/comments/index.js +++ b/routes/api/comments/index.js @@ -13,9 +13,7 @@ router.get('/', (req, res, next) => { Comment.find({}).then((comments) => { res.status(200).json(comments); }) - .catch(error => { - next(error); - }); + .catch(next); }); router.get('/:comment_id', (req, res, next) => { @@ -24,9 +22,7 @@ router.get('/:comment_id', (req, res, next) => { .then(comment => { res.status(200).json(comment); }) - .catch(error => { - next(error); - }); + .catch(next); }); //============================================================================== @@ -40,9 +36,7 @@ router.get('/action/:action_type', (req, res, next) => { .then((comments) => { res.status(200).json(comments); }) - .catch(error => { - next(error); - }); + .catch(next); }); // Get all the comments that were rejected. @@ -52,9 +46,7 @@ router.get('/status/rejected', (req, res, next) => { .then(comments => { res.status(200).json(comments); }) - .catch(error => { - next(error); - }); + .catch(next); }); // Returns back all the comments that are in the moderation queue. The moderation queue is pre or post moderated, @@ -76,9 +68,7 @@ router.get('/status/pending', (req, res, next) => { res.status(200).json(comments); }); }) - .catch(error => { - next(error); - }); + .catch(next); }); //============================================================================== From 95f3b86f3b02fdcfad56f0aa66fbba9f6ae8a90f Mon Sep 17 00:00:00 2001 From: David Erwin Date: Thu, 10 Nov 2016 15:24:34 -0500 Subject: [PATCH 4/4] cleaning up nested objects --- models/comment.js | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/models/comment.js b/models/comment.js index a80e353f0..8eab6aff4 100644 --- a/models/comment.js +++ b/models/comment.js @@ -107,9 +107,11 @@ CommentSchema.statics.findByStatusByActionType = function(status, action_type) { return Comment.find({ 'status': status, - 'id': {'$in': actions.map(a => { - return a.item_id;} - )} + 'id': { + '$in': actions.map(a => { + return a.item_id; + }) + } }); });