Merge pull request #203 from Throne3d/add/role-mentions

Parse role mentions appropriately, as with channel and user mentions

Author: ekmartin

lib/bot.js

@@ -142,6 +142,11 @@ class Bot {
         if (channel) return `#${channel.name}`;
         return '#deleted-channel';
       })
+      .replace(/<@&(\d+)>/g, (match, roleId) => {
+        const role = message.guild.roles.get(roleId);
+        if (role) return `@${role.name}`;
+        return '@deleted-role';
+      })
       .replace(/<(:\w+:)\d+>/g, (match, emoteName) => emoteName);
   }
 
@@ -221,6 +226,11 @@ class Bot {
           }
         }
 
+        const role = guild.roles.find('name', search);
+        if (role && role.mentionable) {
+          return role;
+        }
+
         return match;
       });
 

test/bot.test.js

@@ -25,8 +25,9 @@ describe('Bot', function () {
     sandbox.stub(logger, 'error');
     this.sendMessageStub = sandbox.stub();
     this.findUserStub = sandbox.stub();
+    this.findRoleStub = sandbox.stub();
     irc.Client = ClientStub;
-    discord.Client = createDiscordStub(this.sendMessageStub, this.findUserStub);
+    discord.Client = createDiscordStub(this.sendMessageStub, this.findUserStub, this.findRoleStub);
     ClientStub.prototype.say = sandbox.stub();
     ClientStub.prototype.send = sandbox.stub();
     ClientStub.prototype.join = sandbox.stub();
@@ -44,11 +45,14 @@ describe('Bot', function () {
     return attachments;
   };
 
-  const createGuildStub = (nickname = null) => ({
+  const createGuildStub = (findRoleStub, nickname = null) => ({
     members: {
       get() {
         return { nickname };
       }
+    },
+    roles: {
+      get: findRoleStub
     }
   });
 
@@ -446,7 +450,7 @@ describe('Bot', function () {
     const newConfig = { ...config, ircNickColor: false };
     const bot = new Bot(newConfig);
     const nickname = 'discord-nickname';
-    const guild = createGuildStub(nickname);
+    const guild = createGuildStub(null, nickname);
     bot.connect();
     const message = {
       content: text,
@@ -493,4 +497,76 @@ describe('Bot', function () {
     this.bot.sendToDiscord(username, '#irc', text);
     this.sendMessageStub.should.have.been.calledWith(expected);
   });
+
+  it('should convert role mentions from discord', function () {
+    const testRole = new discord.Role(this.bot.discord, { name: 'example-role', id: '12345' });
+    this.findRoleStub.withArgs('name', 'example-role').returns(testRole);
+    this.findRoleStub.withArgs('12345').returns(testRole);
+
+    const text = '<@&12345>';
+    const guild = createGuildStub(this.findRoleStub);
+    const message = {
+      content: text,
+      mentions: { users: [] },
+      channel: {
+        name: 'discord'
+      },
+      author: {
+        username: 'test',
+        id: 'not bot id'
+      },
+      guild
+    };
+
+    this.bot.parseText(message).should.equal('@example-role');
+  });
+
+  it('should use @deleted-role when referenced role fails to exist', function () {
+    const testRole = new discord.Role(this.bot.discord, { name: 'example-role', id: '12345' });
+    this.findRoleStub.withArgs('12345').returns(testRole);
+
+    const text = '<@&12346>';
+    const guild = createGuildStub(this.findRoleStub);
+    const message = {
+      content: text,
+      mentions: { users: [] },
+      channel: {
+        name: 'discord'
+      },
+      author: {
+        username: 'test',
+        id: 'not bot id'
+      },
+      guild
+    };
+
+    // Discord displays "@deleted-role" if role doesn't exist (e.g. <@&12346>)
+    this.bot.parseText(message).should.equal('@deleted-role');
+  });
+
+  it('should convert role mentions from IRC if role mentionable', function () {
+    const testRole = new discord.Role(this.bot.discord, { name: 'example-role', id: '12345', mentionable: true });
+    this.findRoleStub.withArgs('name', 'example-role').returns(testRole);
+    this.findRoleStub.withArgs('12345').returns(testRole);
+
+    const username = 'ircuser';
+    const text = 'Hello, @example-role!';
+    const expected = `**<${username}>** Hello, <@&${testRole.id}>!`;
+
+    this.bot.sendToDiscord(username, '#irc', text);
+    this.sendMessageStub.should.have.been.calledWith(expected);
+  });
+
+  it('should not convert role mentions from IRC if role not mentionable', function () {
+    const testRole = new discord.Role(this.bot.discord, { name: 'example-role', id: '12345' });
+    this.findRoleStub.withArgs('name', 'example-role').returns(testRole);
+    this.findRoleStub.withArgs('12345').returns(testRole);
+
+    const username = 'ircuser';
+    const text = 'Hello, @example-role!';
+    const expected = `**<${username}>** Hello, @example-role!`;
+
+    this.bot.sendToDiscord(username, '#irc', text);
+    this.sendMessageStub.should.have.been.calledWith(expected);
+  });
 });

test/stubs/discord-stub.js

@@ -2,7 +2,7 @@
 import events from 'events';
 import sinon from 'sinon';
 
-export default function createDiscordStub(sendMessageStub, findUserStub) {
+export default function createDiscordStub(sendMessageStub, findUserStub, findRoleStub) {
   return class DiscordStub extends events.EventEmitter {
     constructor() {
       super();
@@ -32,6 +32,10 @@ export default function createDiscordStub(sendMessageStub, findUserStub) {
           members: {
             find: findUserStub,
             get: findUserStub
+          },
+          roles: {
+            find: findRoleStub,
+            get: findRoleStub
           }
         }
       };