Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Translate TextChannel#sendMessage to #send to fix deprecation warning #267

Merged
merged 1 commit into from
Jul 15, 2017
Merged

Translate TextChannel#sendMessage to #send to fix deprecation warning #267

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions lib/bot.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -355,9 +355,9 @@ class Bot {
logger.debug('Sending command message to Discord', `#${discordChannel.name}`, text);
if (this.formatCommandPrelude) {
const prelude = Bot.substitutePattern(this.formatCommandPrelude, patternMap);
discordChannel.sendMessage(prelude);
discordChannel.send(prelude);
}
discordChannel.sendMessage(text);
discordChannel.send(text);
return;
}

Expand Down Expand Up @@ -396,7 +396,7 @@ class Bot {
// Use custom formatting from config / default formatting with bold author
const withAuthor = Bot.substitutePattern(this.formatDiscord, patternMap);
logger.debug('Sending message to Discord', withAuthor, channel, '->', `#${discordChannel.name}`);
discordChannel.sendMessage(withAuthor);
discordChannel.send(withAuthor);
}

/* Sends a message to Discord exactly as it appears */
Expand All @@ -405,7 +405,7 @@ class Bot {
if (!discordChannel) return;

logger.debug('Sending special message to Discord', text, channel, '->', `#${discordChannel.name}`);
discordChannel.sendMessage(text);
discordChannel.send(text);
}
}

Expand Down
4 changes: 2 additions & 2 deletions test/bot-events.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,10 @@ describe('Bot Events', function () {
this.debugSpy = sandbox.stub(logger, 'debug');
this.warnSpy = sandbox.stub(logger, 'warn');
this.errorSpy = sandbox.stub(logger, 'error');
this.sendMessageStub = sandbox.stub();
this.sendStub = sandbox.stub();
this.getUserStub = sandbox.stub();
irc.Client = ClientStub;
discord.Client = createDiscordStub(this.sendMessageStub, this.getUserStub);
discord.Client = createDiscordStub(this.sendStub, this.getUserStub);
ClientStub.prototype.send = sandbox.stub();
ClientStub.prototype.join = sandbox.stub();
this.bot = createBot();
Expand Down
64 changes: 32 additions & 32 deletions test/bot.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,13 @@ describe('Bot', function () {
this.infoSpy = sandbox.stub(logger, 'info');
this.debugSpy = sandbox.stub(logger, 'debug');
this.errorSpy = sandbox.stub(logger, 'error');
this.sendMessageStub = sandbox.stub();
this.sendStub = sandbox.stub();
this.findUserStub = sandbox.stub();
this.findRoleStub = sandbox.stub();
this.findEmojiStub = sandbox.stub();
irc.Client = ClientStub;
discord.Client = createDiscordStub(
this.sendMessageStub, this.findUserStub, this.findRoleStub, this.findEmojiStub
this.sendStub, this.findUserStub, this.findRoleStub, this.findEmojiStub
);

ClientStub.prototype.say = sandbox.stub();
Expand Down Expand Up @@ -70,53 +70,53 @@ describe('Bot', function () {
const text = 'test message';
const formatted = `**<${username}>** ${text}`;
this.bot.sendToDiscord(username, '#irc', text);
this.sendMessageStub.should.have.been.calledWith(formatted);
this.sendStub.should.have.been.calledWith(formatted);
});

it('should lowercase channel names before sending to discord', function () {
const username = 'testuser';
const text = 'test message';
const formatted = `**<${username}>** ${text}`;
this.bot.sendToDiscord(username, '#IRC', text);
this.sendMessageStub.should.have.been.calledWith(formatted);
this.sendStub.should.have.been.calledWith(formatted);
});

it('should not send messages to discord if the channel isn\'t in the channel mapping',
function () {
this.bot.sendToDiscord('user', '#no-irc', 'message');
this.sendMessageStub.should.not.have.been.called;
this.sendStub.should.not.have.been.called;
});

it('should not send messages to discord if it isn\'t in the channel',
function () {
this.bot.sendToDiscord('user', '#otherirc', 'message');
this.sendMessageStub.should.not.have.been.called;
this.sendStub.should.not.have.been.called;
});

it('should send to a discord channel ID appropriately', function () {
const username = 'testuser';
const text = 'test message';
const formatted = `**<${username}>** ${text}`;
this.bot.sendToDiscord(username, '#channelforid', text);
this.sendMessageStub.should.have.been.calledWith(formatted);
this.sendStub.should.have.been.calledWith(formatted);
});

it('should not send special messages to discord if the channel isn\'t in the channel mapping',
function () {
this.bot.sendExactToDiscord('#no-irc', 'message');
this.sendMessageStub.should.not.have.been.called;
this.sendStub.should.not.have.been.called;
});

it('should not send special messages to discord if it isn\'t in the channel',
function () {
this.bot.sendExactToDiscord('#otherirc', 'message');
this.sendMessageStub.should.not.have.been.called;
this.sendStub.should.not.have.been.called;
});

it('should send special messages to discord',
function () {
this.bot.sendExactToDiscord('#irc', 'message');
this.sendMessageStub.should.have.been.calledWith('message');
this.sendStub.should.have.been.calledWith('message');
this.debugSpy.should.have.been.calledWith('Sending special message to Discord', 'message', '#irc', '->', '#discord');
});

Expand Down Expand Up @@ -414,7 +414,7 @@ describe('Bot', function () {
const expected = `**<${username}>** Hello, <@${testUser.id}>!`;

this.bot.sendToDiscord(username, '#irc', text);
this.sendMessageStub.should.have.been.calledWith(expected);
this.sendStub.should.have.been.calledWith(expected);
});

it('should not convert user mentions from IRC if such user does not exist', function () {
Expand All @@ -423,7 +423,7 @@ describe('Bot', function () {
const expected = `**<${username}>** See you there @5pm`;

this.bot.sendToDiscord(username, '#irc', text);
this.sendMessageStub.should.have.been.calledWith(expected);
this.sendStub.should.have.been.calledWith(expected);
});

it('should convert multiple user mentions from IRC', function () {
Expand All @@ -440,7 +440,7 @@ describe('Bot', function () {
' was our meeting scheduled @5pm?';

this.bot.sendToDiscord(username, '#irc', text);
this.sendMessageStub.should.have.been.calledWith(expected);
this.sendStub.should.have.been.calledWith(expected);
});

it('should convert emoji mentions from IRC', function () {
Expand All @@ -456,7 +456,7 @@ describe('Bot', function () {
const text = 'Here is a broken :emojitest:, a working :testemoji: and another :emoji: that won\'t parse';
const expected = `**<${username}>** Here is a broken :emojitest:, a working <:testemoji:987> and another :emoji: that won't parse`;
this.bot.sendToDiscord(username, '#irc', text);
this.sendMessageStub.should.have.been.calledWith(expected);
this.sendStub.should.have.been.calledWith(expected);
});

it('should convert newlines from discord', function () {
Expand Down Expand Up @@ -496,8 +496,8 @@ describe('Bot', function () {
const text = '!command';

this.bot.sendToDiscord(username, '#irc', text);
this.sendMessageStub.getCall(0).args.should.deep.equal(['Command sent from IRC by ircuser:']);
this.sendMessageStub.getCall(1).args.should.deep.equal([text]);
this.sendStub.getCall(0).args.should.deep.equal(['Command sent from IRC by ircuser:']);
this.sendStub.getCall(1).args.should.deep.equal([text]);
});

it('should use nickname instead of username when available', function () {
Expand Down Expand Up @@ -536,7 +536,7 @@ describe('Bot', function () {
const expected = `**<${username}>** Hello, <@${testUser.id}>!`;

this.bot.sendToDiscord(username, '#irc', text);
this.sendMessageStub.should.have.been.calledWith(expected);
this.sendStub.should.have.been.calledWith(expected);
});

it('should convert username mentions from IRC even if nickname differs', function () {
Expand All @@ -550,7 +550,7 @@ describe('Bot', function () {
const expected = `**<${username}>** Hello, <@${testUser.id}>!`;

this.bot.sendToDiscord(username, '#irc', text);
this.sendMessageStub.should.have.been.calledWith(expected);
this.sendStub.should.have.been.calledWith(expected);
});

it('should convert role mentions from discord', function () {
Expand Down Expand Up @@ -609,7 +609,7 @@ describe('Bot', function () {
const expected = `**<${username}>** Hello, <@&${testRole.id}>!`;

this.bot.sendToDiscord(username, '#irc', text);
this.sendMessageStub.should.have.been.calledWith(expected);
this.sendStub.should.have.been.calledWith(expected);
});

it('should not convert role mentions from IRC if role not mentionable', function () {
Expand All @@ -622,15 +622,15 @@ describe('Bot', function () {
const expected = `**<${username}>** Hello, @example-role!`;

this.bot.sendToDiscord(username, '#irc', text);
this.sendMessageStub.should.have.been.calledWith(expected);
this.sendStub.should.have.been.calledWith(expected);
});

it('should successfully send messages with default config', function () {
const bot = new Bot(configMsgFormatDefault);
bot.connect();

bot.sendToDiscord('testuser', '#irc', 'test message');
this.sendMessageStub.should.have.been.calledOnce;
this.sendStub.should.have.been.calledOnce;

const guild = createGuildStub();
const message = {
Expand All @@ -647,7 +647,7 @@ describe('Bot', function () {
};

bot.sendToIRC(message);
this.sendMessageStub.should.have.been.calledOnce;
this.sendStub.should.have.been.calledOnce;
});

it('should not replace unmatched patterns', function () {
Expand All @@ -659,7 +659,7 @@ describe('Bot', function () {
const msg = 'test message';
const expected = `{$unmatchedPattern} stays intact: ${username} ${msg}`;
bot.sendToDiscord(username, '#irc', msg);
this.sendMessageStub.should.have.been.calledWith(expected);
this.sendStub.should.have.been.calledWith(expected);
});

it('should respect custom formatting for Discord', function () {
Expand All @@ -671,15 +671,15 @@ describe('Bot', function () {
const msg = 'test @user <#1234>';
const expected = `<test> #irc => #discord: ${msg}`;
bot.sendToDiscord(username, '#irc', msg);
this.sendMessageStub.should.have.been.calledWith(expected);
this.sendStub.should.have.been.calledWith(expected);
});

it('should successfully send messages with default config', function () {
this.bot = new Bot(configMsgFormatDefault);
this.bot.connect();

this.bot.sendToDiscord('testuser', '#irc', 'test message');
this.sendMessageStub.should.have.been.calledOnce;
this.sendStub.should.have.been.calledOnce;

const guild = createGuildStub();
const message = {
Expand All @@ -696,7 +696,7 @@ describe('Bot', function () {
};

this.bot.sendToIRC(message);
this.sendMessageStub.should.have.been.calledOnce;
this.sendStub.should.have.been.calledOnce;
});

it('should not replace unmatched patterns', function () {
Expand All @@ -708,7 +708,7 @@ describe('Bot', function () {
const msg = 'test message';
const expected = `{$unmatchedPattern} stays intact: ${username} ${msg}`;
this.bot.sendToDiscord(username, '#irc', msg);
this.sendMessageStub.should.have.been.calledWith(expected);
this.sendStub.should.have.been.calledWith(expected);
});

it('should respect custom formatting for regular Discord output', function () {
Expand All @@ -720,7 +720,7 @@ describe('Bot', function () {
const msg = 'test @user <#1234>';
const expected = `<test> #irc => #discord: ${msg}`;
this.bot.sendToDiscord(username, '#irc', msg);
this.sendMessageStub.should.have.been.calledWith(expected);
this.sendStub.should.have.been.calledWith(expected);
});

it('should respect custom formatting for commands in Discord output', function () {
Expand All @@ -732,8 +732,8 @@ describe('Bot', function () {
const msg = '!testcmd';
const expected = 'test from #irc sent command to #discord:';
this.bot.sendToDiscord(username, '#irc', msg);
this.sendMessageStub.getCall(0).args.should.deep.equal([expected]);
this.sendMessageStub.getCall(1).args.should.deep.equal([msg]);
this.sendStub.getCall(0).args.should.deep.equal([expected]);
this.sendStub.getCall(1).args.should.deep.equal([msg]);
});

it('should respect custom formatting for regular IRC output', function () {
Expand Down Expand Up @@ -839,7 +839,7 @@ describe('Bot', function () {
const username = 'test';
const msg = '!testcmd';
this.bot.sendToDiscord(username, '#irc', msg);
this.sendMessageStub.should.have.been.calledOnce;
this.sendMessageStub.getCall(0).args.should.deep.equal([msg]);
this.sendStub.should.have.been.calledOnce;
this.sendStub.getCall(0).args.should.deep.equal([msg]);
});
});
4 changes: 2 additions & 2 deletions test/stubs/discord-stub.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
import events from 'events';
import sinon from 'sinon';

export default function createDiscordStub(sendMessageStub, findUserStub, findRoleStub,
export default function createDiscordStub(sendStub, findUserStub, findRoleStub,
findEmojiStub) {
return class DiscordStub extends events.EventEmitter {
constructor() {
Expand All @@ -28,7 +28,7 @@ export default function createDiscordStub(sendMessageStub, findUserStub, findRol
return {
name: 'discord',
id: 1234,
sendMessage: sendMessageStub,
send: sendStub,
guild: {
members: {
find: findUserStub,
Expand Down