Cleanup Part 2: Electric Boogaloo (Reloaded) (#594)

* Cleanup Part 2: Electric Boogaloo (Reloaded)

* Moar cleanup

* Tweak NOT_A_PERMISSION error

src/client/ClientDataResolver.js

@@ -2,13 +2,12 @@ const path = require('path');
 const fs = require('fs');
 const request = require('superagent');
 
-const getStructure = name => require(`../structures/${name}`);
-
-const User = getStructure('User');
-const Message = getStructure('Message');
-const Guild = getStructure('Guild');
-const Channel = getStructure('Channel');
-const GuildMember = getStructure('GuildMember');
+const Constants = require('../util/constants');
+const User = require(`../structures/User`);
+const Message = require(`../structures/Message`);
+const Guild = require(`../structures/Guild`);
+const Channel = require(`../structures/Channel`);
+const GuildMember = require(`../structures/GuildMember`);
 
 /**
  * The DataResolver identifies different objects and tries to resolve a specific piece of information from them, e.g.
@@ -16,7 +15,9 @@ const GuildMember = getStructure('GuildMember');
  * @private
  */
 class ClientDataResolver {
-
+  /**
+   * @param {Client} client The client the resolver is for
+   */
   constructor(client) {
     this.client = client;
   }
@@ -33,7 +34,7 @@ class ClientDataResolver {
 
   /**
    * Resolves a UserResolvable to a User object
-   * @param {UserResolvable} user the UserResolvable to identify
+   * @param {UserResolvable} user The UserResolvable to identify
    * @returns {?User}
    */
   resolveUser(user) {
@@ -60,18 +61,12 @@ class ClientDataResolver {
 
   /**
    * Resolves a GuildResolvable to a Guild object
-   * @param {GuildResolvable} guild the GuildResolvable to identify
+   * @param {GuildResolvable} guild The GuildResolvable to identify
    * @returns {?Guild}
    */
   resolveGuild(guild) {
-    if (guild instanceof Guild) {
-      return guild;
-    }
-
-    if (typeof guild === 'string') {
-      return this.client.guilds.get(guild);
-    }
-
+    if (guild instanceof Guild) return guild;
+    if (typeof guild === 'string') return this.client.guilds.get(guild);
     return null;
   }
 
@@ -84,21 +79,16 @@ class ClientDataResolver {
 
   /**
    * Resolves a GuildMemberResolvable to a GuildMember object
-   * @param {GuildResolvable} guild the guild that the member is part of
-   * @param {UserResolvable} user the user that is part of the guild
+   * @param {GuildResolvable} guild The guild that the member is part of
+   * @param {UserResolvable} user The user that is part of the guild
    * @returns {?GuildMember}
    */
   resolveGuildMember(guild, user) {
-    if (user instanceof GuildMember) {
-      return user;
-    }
+    if (user instanceof GuildMember) return user;
 
     guild = this.resolveGuild(guild);
     user = this.resolveUser(user);
-
-    if (!guild || !user) {
-      return null;
-    }
+    if (!guild || !user) return null;
 
     return guild.members.get(user.id);
   }
@@ -112,14 +102,11 @@ class ClientDataResolver {
 
   /**
    * Resolves a Base64Resolvable to a Base 64 image
-   * @param {Base64Resolvable} data the base 64 resolvable you want to resolve
+   * @param {Base64Resolvable} data The base 64 resolvable you want to resolve
    * @returns {?string}
    */
   resolveBase64(data) {
-    if (data instanceof Buffer) {
-      return `data:image/jpg;base64,${data.toString('base64')}`;
-    }
-
+    if (data instanceof Buffer) return `data:image/jpg;base64,${data.toString('base64')}`;
     return data;
   }
 
@@ -132,43 +119,49 @@ class ClientDataResolver {
 
   /**
    * Resolves a ChannelResolvable to a Channel object
-   * @param {ChannelResolvable} channel the channel resolvable to resolve
+   * @param {ChannelResolvable} channel The channel resolvable to resolve
    * @returns {?Channel}
    */
   resolveChannel(channel) {
-    if (channel instanceof Channel) {
-      return channel;
-    }
-
-    if (typeof channel === 'string') {
-      return this.client.channels.get(channel.id);
-    }
-
+    if (channel instanceof Channel) return channel;
+    if (typeof channel === 'string') return this.client.channels.get(channel.id);
     return null;
   }
 
+  /**
+   * Data that can be resolved to give a permission number. This can be:
+   * * A string
+   * * A permission number
+   * @typedef {string|number} PermissionResolvable
+   */
+
+  /**
+   * Resolves a PermissionResolvable to a permission number
+   * @param {PermissionResolvable} permission The permission resolvable to resolve
+   * @returns {number}
+   */
+  resolvePermission(permission) {
+    if (typeof permission === 'string') permission = Constants.PermissionFlags[permission];
+    if (!permission) throw Constants.Errors.NOT_A_PERMISSION;
+    return permission;
+  }
+
   /**
    * Data that can be resolved to give a string. This can be:
    * * A string
    * * An Array (joined with a new line delimiter to give a string)
-   * * Any object
-   * @typedef {string|Array|Object} StringResolvable
+   * * Any value
+   * @typedef {string|Array|*} StringResolvable
    */
 
   /**
    * Resolves a StringResolvable to a string
-   * @param {StringResolvable} data the string resolvable to resolve
+   * @param {StringResolvable} data The string resolvable to resolve
    * @returns {string}
    */
   resolveString(data) {
-    if (typeof data === 'string') {
-      return data;
-    }
-
-    if (data instanceof Array) {
-      return data.join('\n');
-    }
-
+    if (typeof data === 'string') return data;
+    if (data instanceof Array) return data.join('\n');
     return String(data);
   }
 
@@ -182,8 +175,8 @@ class ClientDataResolver {
 
   /**
    * Resolves a FileResolvable to a Buffer
-   * @param {FileResolvable} resource the file resolvable to resolve
-   * @returns {string|Buffer}
+   * @param {FileResolvable} resource The file resolvable to resolve
+   * @returns {Promise<Buffer>}
    */
   resolveFile(resource) {
     if (typeof resource === 'string') {
@@ -194,19 +187,19 @@ class ClientDataResolver {
             .end((err, res) => err ? reject(err) : resolve(res.body));
         } else {
           const file = path.resolve(resource);
-          const stat = fs.statSync(file);
-          if (!stat.isFile()) {
-            throw new Error(`The file could not be found: ${file}`);
-          }
-
-          fs.readFile(file, (err, data) => {
-            if (err) reject(err); else resolve(data);
+          fs.stat(file, (err, stats) => {
+            if (err) reject(err);
+            if (!stats.isFile()) throw new Error(`The file could not be found: ${file}`);
+            fs.readFile(file, (err2, data) => {
+              if (err2) reject(err2); else resolve(data);
+            });
           });
         }
       });
     }
 
-    return Promise.resolve(resource);
+    if (resource instanceof Buffer) return Promise.resolve(resource);
+    return Promise.reject(new TypeError('resource is not a string or Buffer'));
   }
 }