Rename special->exact and getDiscordChannelFor->findDiscordChannel

Author: Throne3d

lib/bot.js

@@ -104,18 +104,18 @@ class Bot {
     this.ircClient.on('join', (channel, nick) => {
       if (!this.ircStatusNotices) return;
       if (nick === this.nickname && !this.announceSelfJoin) return;
-      this.sendSpecialToDiscord(channel, `*${nick}* has joined the channel`);
+      this.sendExactToDiscord(channel, `*${nick}* has joined the channel`);
     });
 
     this.ircClient.on('part', (channel, nick, reason) => {
       if (!this.ircStatusNotices || nick === this.nickname) return;
-      this.sendSpecialToDiscord(channel, `*${nick}* has left the channel (${reason})`);
+      this.sendExactToDiscord(channel, `*${nick}* has left the channel (${reason})`);
     });
 
     this.ircClient.on('quit', (nick, reason, channels) => {
       if (!this.ircStatusNotices || nick === this.nickname) return;
       channels.forEach((channel) => {
-        this.sendSpecialToDiscord(channel, `*${nick}* has quit (${reason})`);
+        this.sendExactToDiscord(channel, `*${nick}* has quit (${reason})`);
       });
     });
 
@@ -220,7 +220,7 @@ class Bot {
     }
   }
 
-  getDiscordChannelFor(ircChannel) {
+  findDiscordChannel(ircChannel) {
     const discordChannelName = this.invertedMapping[ircChannel.toLowerCase()];
     if (discordChannelName) {
       // #channel -> channel before retrieving and select only text channels:
@@ -239,7 +239,7 @@ class Bot {
   }
 
   sendToDiscord(author, channel, text) {
-    const discordChannel = this.getDiscordChannelFor(channel);
+    const discordChannel = this.findDiscordChannel(channel);
     if (!discordChannel) return;
 
     // Convert text formatting (bold, italics, underscore)
@@ -273,8 +273,8 @@ class Bot {
   }
 
   /* Sends a message to Discord exactly as it appears */
-  sendSpecialToDiscord(channel, text) {
-    const discordChannel = this.getDiscordChannelFor(channel);
+  sendExactToDiscord(channel, text) {
+    const discordChannel = this.findDiscordChannel(channel);
     if (!discordChannel) return;
 
     logger.debug('Sending special message to Discord', text, channel, '->', `#${discordChannel.name}`);

test/bot-events.test.js

@@ -24,7 +24,7 @@ describe('Bot Events', function () {
     const bot = new Bot(useConfig);
     bot.sendToIRC = sandbox.stub();
     bot.sendToDiscord = sandbox.stub();
-    bot.sendSpecialToDiscord = sandbox.stub();
+    bot.sendExactToDiscord = sandbox.stub();
     return bot;
   };
 
@@ -130,7 +130,7 @@ describe('Bot Events', function () {
     const nick = 'user';
     const text = `*${nick}* has joined the channel`;
     bot.ircClient.emit('join', channel, nick);
-    bot.sendSpecialToDiscord.should.have.been.calledWithExactly(channel, text);
+    bot.sendExactToDiscord.should.have.been.calledWithExactly(channel, text);
   });
 
   it('should not announce itself joining by default', function () {
@@ -139,7 +139,7 @@ describe('Bot Events', function () {
     const channel = '#channel';
     const nick = bot.nickname;
     bot.ircClient.emit('join', channel, nick);
-    bot.sendSpecialToDiscord.should.not.have.been.called;
+    bot.sendExactToDiscord.should.not.have.been.called;
   });
 
   it('should be possible to get the bot to announce itself joining', function () {
@@ -149,7 +149,7 @@ describe('Bot Events', function () {
     const nick = this.bot.nickname;
     const text = `*${nick}* has joined the channel`;
     bot.ircClient.emit('join', channel, nick);
-    bot.sendSpecialToDiscord.should.have.been.calledWithExactly(channel, text);
+    bot.sendExactToDiscord.should.have.been.calledWithExactly(channel, text);
   });
 
   it('should send part messages to discord when config enabled', function () {
@@ -160,7 +160,7 @@ describe('Bot Events', function () {
     const reason = 'Leaving';
     const text = `*${nick}* has left the channel (${reason})`;
     bot.ircClient.emit('part', channel, nick, reason);
-    bot.sendSpecialToDiscord.should.have.been.calledWithExactly(channel, text);
+    bot.sendExactToDiscord.should.have.been.calledWithExactly(channel, text);
   });
 
   it('should send quit messages to discord when config enabled', function () {
@@ -172,8 +172,8 @@ describe('Bot Events', function () {
     const reason = 'Quit: Leaving';
     const text = `*${nick}* has quit (${reason})`;
     bot.ircClient.emit('quit', nick, reason, [channel1, channel2]);
-    bot.sendSpecialToDiscord.getCall(0).args.should.deep.equal([channel1, text]);
-    bot.sendSpecialToDiscord.getCall(1).args.should.deep.equal([channel2, text]);
+    bot.sendExactToDiscord.getCall(0).args.should.deep.equal([channel1, text]);
+    bot.sendExactToDiscord.getCall(1).args.should.deep.equal([channel2, text]);
   });
 
   it('should be possible to disable join/part/quit messages', function () {
@@ -187,7 +187,7 @@ describe('Bot Events', function () {
     bot.ircClient.emit('part', channel, nick, reason);
     bot.ircClient.emit('join', channel, nick);
     bot.ircClient.emit('quit', nick, reason, [channel]);
-    bot.sendSpecialToDiscord.should.not.have.been.called;
+    bot.sendExactToDiscord.should.not.have.been.called;
   });
 
   it('should not listen to discord debug messages in production', function () {

test/bot.test.js

@@ -98,19 +98,19 @@ describe('Bot', function () {
 
   it('should not send special messages to discord if the channel isn\'t in the channel mapping',
   function () {
-    this.bot.sendSpecialToDiscord('#no-irc', 'message');
+    this.bot.sendExactToDiscord('#no-irc', 'message');
     this.sendMessageStub.should.not.have.been.called;
   });
 
   it('should not send special messages to discord if it isn\'t in the channel',
   function () {
-    this.bot.sendSpecialToDiscord('#otherirc', 'message');
+    this.bot.sendExactToDiscord('#otherirc', 'message');
     this.sendMessageStub.should.not.have.been.called;
   });
 
   it('should send special messages to discord',
   function () {
-    this.bot.sendSpecialToDiscord('#irc', 'message');
+    this.bot.sendExactToDiscord('#irc', 'message');
     this.sendMessageStub.should.have.been.calledWith('message');
     this.debugSpy.should.have.been.calledWith('Sending special message to Discord', 'message', '#irc', '->', '#discord');
   });