Allow testing of commands that return multiple messages with respond_with_slack_message

CHANGELOG.md

@@ -1,6 +1,7 @@
 ### 0.10.5 (Next)
 
 * Refactored `SlackRubyBot::MVC::Controller::Base`, consolidated ivar handling, centralized object allocations and DRYed up the code - [@chuckremes](https://github.com/chuckremes).
+* [#157](https://github.com/slack-ruby/slack-ruby-bot/pull/157): Added support for checking multiple responses at once via new `respond_with_slack_messages` matcher, and single response out of multiple responses to `response_with_slack_message` matcher - [@gcraig99](https://github.com/gcraig99) 
 * Your contribution here.
 
 ### 0.10.4 (07/05/2017)

README.md

@@ -547,6 +547,7 @@ Slack-ruby-bot ships with a number of shared RSpec behaviors that can be used in
 
 * [behaves like a slack bot](lib/slack-ruby-bot/rspec/support/slack-ruby-bot/it_behaves_like_a_slack_bot.rb): A bot quacks like a Slack Ruby bot.
 * [respond with slack message](lib/slack-ruby-bot/rspec/support/slack-ruby-bot/respond_with_slack_message.rb): The bot responds with a message.
+* [respond with slack messages](lib/slack-ruby-bot/rspec/support/slack-ruby-bot/respond_with_slack_messages.rb): The bot responds with a set of message.
 * [respond with error](lib/slack-ruby-bot/rspec/support/slack-ruby-bot/respond_with_error.rb): An exception is raised inside a bot command.
 
 Require `slack-ruby-bot/rspec` in your `spec_helper.rb` along with the following dependencies in Gemfile.

lib/slack-ruby-bot/rspec/support/slack-ruby-bot/respond_with_slack_message.rb

@@ -13,8 +13,9 @@
 
     allow(Giphy).to receive(:random) if defined?(Giphy)
 
-    expect(client).to receive(:message).with(channel: channel, text: expected)
+    allow(client).to receive(:message)
     message_command.call(client, Hashie::Mash.new(text: message, channel: channel, user: user))
+    expect(client).to have_received(:message).with(channel: channel, text: expected).once
     true
   end
 

lib/slack-ruby-bot/rspec/support/slack-ruby-bot/respond_with_slack_messages.rb

@@ -0,0 +1,30 @@
+require 'rspec/expectations'
+RSpec::Matchers.define :respond_with_slack_messages do |expected|
+  match do |actual|
+    raise ArgumentError, 'respond_with_slack_messages expects an array of ordered responses' unless expected.is_a? Array
+    client = if respond_to?(:client)
+               send(:client)
+             else
+               SlackRubyBot::Client.new
+             end
+
+    message_command = SlackRubyBot::Hooks::Message.new
+    channel, user, message = parse(actual)
+
+    allow(Giphy).to receive(:random) if defined?(Giphy)
+
+    allow(client).to receive(:message)
+    message_command.call(client, Hashie::Mash.new(text: message, channel: channel, user: user))
+    expected.each do |exp|
+      expect(client).to have_received(:message).with(channel: channel, text: exp).once
+    end
+    true
+  end
+
+private
+
+  def parse(actual)
+    actual = { message: actual } unless actual.is_a?(Hash)
+    [actual[:channel] || 'channel', actual[:user] || 'user', actual[:message]]
+  end
+end

spec/slack-ruby-bot/rspec/respond_with_slack_message_spec.rb

@@ -0,0 +1,30 @@
+describe RSpec do
+  let! :command do
+    Class.new(SlackRubyBot::Commands::Base) do
+      command 'single message' do |client, data, _match|
+        client.say(text: 'single response', channel: data.channel)
+      end
+      command 'respond 5 times' do |client, data, _match|
+        5.times do |i|
+          client.say(text: "response #{i}", channel: data.channel)
+        end
+      end
+    end
+  end
+
+  def app
+    SlackRubyBot::App.new
+  end
+  it 'respond_with_single_message_using_regex_match' do
+    expect(message: "#{SlackRubyBot.config.user} single message")
+      .to respond_with_slack_message(/single response/i)
+  end
+  it 'respond_with_single_message_using_string_match' do
+    expect(message: "#{SlackRubyBot.config.user} single message")
+      .to respond_with_slack_message('single response')
+  end
+  it 'respond_with_multiple_messages_looking_for_single_match' do
+    expect(message: "#{SlackRubyBot.config.user} respond 5 times")
+      .to respond_with_slack_message('response 1')
+  end
+end

spec/slack-ruby-bot/rspec/respond_with_slack_messages_spec.rb

@@ -0,0 +1,28 @@
+describe RSpec do
+  let! :command do
+    Class.new(SlackRubyBot::Commands::Base) do
+      command 'respond 5 times' do |client, data, _match|
+        5.times do |i|
+          client.say(text: "response #{i}", channel: data.channel)
+        end
+      end
+    end
+  end
+
+  def app
+    SlackRubyBot::App.new
+  end
+
+  it 'respond_with_multiple_messages_using_regex_matches' do
+    expected_responses = []
+    5.times { |i| expected_responses.push(/response #{i}/i) }
+    expect(message: "#{SlackRubyBot.config.user} respond 5 times")
+      .to respond_with_slack_messages(expected_responses)
+  end
+  it 'respond_with_multiple_messages_using_string_matches' do
+    expected_responses = []
+    5.times { |i| expected_responses.push("response #{i}") }
+    expect(message: "#{SlackRubyBot.config.user} respond 5 times")
+      .to respond_with_slack_messages(expected_responses)
+  end
+end