slack-ruby-bot 0.10.5 → 0.11.0

data/lib/slack-ruby-bot/commands/help.rb

@@ -1,6 +1,6 @@
 module SlackRubyBot
   module Commands
-    class HelpCommand < Base
+    class Help < Base
       help do
         title 'help'
         desc 'Shows help information.'
@@ -10,7 +10,7 @@ module SlackRubyBot
         command = match[:expression]
 
         text = if command.present?
-                 CommandsHelper.instance.command_full_desc(command)
+                 Support::Help.instance.command_full_desc(command)
                else
                  general_text
                end
@@ -22,8 +22,8 @@ module SlackRubyBot
         private
 
         def general_text
-          bot_desc = CommandsHelper.instance.bot_desc_and_commands
-          other_commands_descs = CommandsHelper.instance.other_commands_descs
+          bot_desc = Support::Help.instance.bot_desc_and_commands
+          other_commands_descs = Support::Help.instance.other_commands_descs
           <<TEXT
 #{bot_desc.join("\n")}
 

data/lib/slack-ruby-bot/commands/{help → support}/attrs.rb

@@ -1,6 +1,6 @@
 module SlackRubyBot
   module Commands
-    module Help
+    module Support
       class Attrs
         attr_accessor :command_name, :command_desc, :command_long_desc
         attr_reader :klass, :commands

data/lib/slack-ruby-bot/commands/support/help.rb

@@ -0,0 +1,80 @@
+require 'singleton'
+require_relative 'attrs'
+
+module SlackRubyBot
+  module Commands
+    module Support
+      class Help
+        include Singleton
+        attr_reader :commands_help_attrs
+
+        def initialize
+          @commands_help_attrs = []
+        end
+
+        def capture_help(klass, &block)
+          k = Commands::Support::Attrs.new(klass)
+          k.instance_eval(&block)
+          @commands_help_attrs << k
+        end
+
+        def bot_desc_and_commands
+          collect_help_attrs(bot_help_attrs) do |help_attrs|
+            bot_commands_descs = collect_name_and_desc(help_attrs.commands)
+            "#{command_name_and_desc(help_attrs)}\n\n*Commands:*\n#{bot_commands_descs.join("\n")}"
+          end
+        end
+
+        def other_commands_descs
+          collect_name_and_desc(other_commands_help_attrs)
+        end
+
+        def command_full_desc(name)
+          unescaped_name = Slack::Messages::Formatting.unescape(name)
+          help_attrs = find_command_help_attrs(unescaped_name)
+          return "There's no command *#{unescaped_name}*" unless help_attrs
+          return "There's no description for command *#{unescaped_name}*" if help_attrs.command_long_desc.blank?
+          "#{command_name_and_desc(help_attrs)}\n\n#{help_attrs.command_long_desc}"
+        end
+
+        def find_command_help_attrs(name)
+          help_attrs = commands_help_attrs.find { |k| k.command_name == name }
+          return help_attrs if help_attrs
+          commands_help_attrs.each { |k| k.commands.each { |c| return c if c.command_name == name } }
+          nil
+        end
+
+        private
+
+        def collect_help_attrs(help_attrs)
+          help_attrs_with_present_names(help_attrs).map do |ha|
+            yield(ha)
+          end
+        end
+
+        def collect_name_and_desc(help_attrs)
+          collect_help_attrs(help_attrs) do |ha|
+            command_name_and_desc(ha)
+          end
+        end
+
+        def command_name_and_desc(help_attrs)
+          desc = help_attrs.command_desc.present? ? " - #{help_attrs.command_desc}" : ''
+          "*#{help_attrs.command_name}*#{desc}"
+        end
+
+        def help_attrs_with_present_names(help_attrs)
+          help_attrs.select { |k| k.command_name.present? }
+        end
+
+        def bot_help_attrs
+          commands_help_attrs.select { |k| k.klass.ancestors.include?(SlackRubyBot::Bot) }
+        end
+
+        def other_commands_help_attrs
+          commands_help_attrs.select { |k| k.klass.ancestors.include?(SlackRubyBot::Commands::Base) && !k.klass.ancestors.include?(SlackRubyBot::Bot) }
+        end
+      end
+    end
+  end
+end

data/lib/slack-ruby-bot/commands/support/match.rb

@@ -0,0 +1,22 @@
+module SlackRubyBot
+  module Commands
+    module Support
+      class Match
+        extend Forwardable
+
+        delegate MatchData.public_instance_methods(false) => :@match_data
+
+        attr_reader :attachment, :attachment_field
+
+        def initialize(match_data, attachment = nil, attachment_field = nil)
+          unless match_data.is_a? MatchData
+            raise ArgumentError, 'match_data should be a type of MatchData'
+          end
+          @match_data = match_data
+          @attachment = attachment
+          @attachment_field = attachment_field
+        end
+      end
+    end
+  end
+end

data/lib/slack-ruby-bot/config.rb

@@ -2,7 +2,7 @@ module SlackRubyBot
   module Config
     extend self
 
-    ATTRS = [:token, :url, :aliases, :user, :user_id, :team, :team_id, :allow_message_loops, :send_gifs, :logger].freeze
+    ATTRS = %i[token url aliases user user_id team team_id allow_message_loops send_gifs logger].freeze
     attr_accessor(*ATTRS)
 
     def allow_message_loops?

data/lib/slack-ruby-bot/rspec/support/slack-ruby-bot/not_respond.rb

@@ -9,10 +9,10 @@ RSpec::Matchers.define :not_respond do
              end
 
     message_command = SlackRubyBot::Hooks::Message.new
-    channel, user, message = parse(actual)
+    channel, user, message, attachments = parse(actual)
 
     expect(client).not_to receive(:message)
-    message_command.call(client, Hashie::Mash.new(text: message, channel: channel, user: user))
+    message_command.call(client, Hashie::Mash.new(text: message, channel: channel, user: user, attachments: attachments))
     true
   end
 
@@ -20,6 +20,8 @@ RSpec::Matchers.define :not_respond do
 
   def parse(actual)
     actual = { message: actual } unless actual.is_a?(Hash)
-    [actual[:channel] || 'channel', actual[:user] || 'user', actual[:message]]
+    attachments = actual[:attachments]
+    attachments = [attachments] unless attachments.nil? || attachments.is_a?(Array)
+    [actual[:channel] || 'channel', actual[:user] || 'user', actual[:message], attachments]
   end
 end

data/lib/slack-ruby-bot/rspec/support/slack-ruby-bot/respond_with_error.rb

@@ -9,13 +9,13 @@ RSpec::Matchers.define :respond_with_error do |error, error_message|
              end
 
     message_command = SlackRubyBot::Hooks::Message.new
-    channel, user, message = parse(actual)
+    channel, user, message, attachments = parse(actual)
 
     allow(Giphy).to receive(:random) if defined?(Giphy)
 
     begin
       expect do
-        message_command.call(client, Hashie::Mash.new(text: message, channel: channel, user: user))
+        message_command.call(client, Hashie::Mash.new(text: message, channel: channel, user: user, attachments: attachments))
       end.to raise_error error, error_message
     rescue RSpec::Expectations::ExpectationNotMetError => e
       @error_message = e.message
@@ -33,6 +33,8 @@ RSpec::Matchers.define :respond_with_error do |error, error_message|
 
   def parse(actual)
     actual = { message: actual } unless actual.is_a?(Hash)
-    [actual[:channel] || 'channel', actual[:user] || 'user', actual[:message]]
+    attachments = actual[:attachments]
+    attachments = [attachments] unless attachments.nil? || attachments.is_a?(Array)
+    [actual[:channel] || 'channel', actual[:user] || 'user', actual[:message], attachments]
   end
 end

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

@@ -14,12 +14,12 @@ RSpec::Matchers.define :respond_with_slack_message do |expected|
     end
 
     message_command = SlackRubyBot::Hooks::Message.new
-    channel, user, message = parse(actual)
+    channel, user, message, attachments = 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))
+    message_command.call(client, Hashie::Mash.new(text: message, channel: channel, user: user, attachments: attachments))
     @messages = client.test_messages
     expect(client).to have_received(:message).with(hash_including(channel: channel, text: expected)).once
     true

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

@@ -15,12 +15,12 @@ RSpec::Matchers.define :respond_with_slack_messages do |expected|
     end
 
     message_command = SlackRubyBot::Hooks::Message.new
-    channel, user, message = parse(actual)
+    channel, user, message, attachments = 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))
+    message_command.call(client, Hashie::Mash.new(text: message, channel: channel, user: user, attachments: attachments))
     @messages = client.test_messages
     @responses = []
     expected.each do |exp|

data/lib/slack-ruby-bot/rspec/support/spec_helpers.rb

@@ -4,7 +4,9 @@ module SlackRubyBot
 
     def parse(actual)
       actual = { message: actual } unless actual.is_a?(Hash)
-      [actual[:channel] || 'channel', actual[:user] || 'user', actual[:message]]
+      attachments = actual[:attachments]
+      attachments = [attachments] unless attachments.nil? || attachments.is_a?(Array)
+      [actual[:channel] || 'channel', actual[:user] || 'user', actual[:message], attachments]
     end
   end
 end

data/lib/slack-ruby-bot/server.rb

@@ -6,7 +6,7 @@ module SlackRubyBot
 
     include SlackRubyBot::Hooks::HookSupport
 
-    TRAPPED_SIGNALS = %w(INT TERM).freeze
+    TRAPPED_SIGNALS = %w[INT TERM].freeze
 
     def initialize(options = {})
       @token = options[:token]

data/lib/slack-ruby-bot/version.rb

@@ -1,3 +1,3 @@
 module SlackRubyBot
-  VERSION = '0.10.5'.freeze
+  VERSION = '0.11.0'.freeze
 end

data/slack-ruby-bot.gemspec

@@ -16,10 +16,10 @@ Gem::Specification.new do |s|
   s.summary = 'The easiest way to write a Slack bot in Ruby.'
   s.add_dependency 'hashie'
   s.add_dependency 'slack-ruby-client', '>= 0.6.0'
+  s.add_development_dependency 'rack-test'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
-  s.add_development_dependency 'rack-test'
+  s.add_development_dependency 'rubocop', '0.51.0'
   s.add_development_dependency 'vcr'
   s.add_development_dependency 'webmock'
-  s.add_development_dependency 'rubocop', '0.38.0'
 end

data/spec/slack-ruby-bot/commands/attachment_spec.rb

@@ -0,0 +1,102 @@
+describe SlackRubyBot::Commands do
+  context 'optional fields to scan' do
+    let! :command do
+      Class.new(SlackRubyBot::Commands::Base) do
+        attachment(/Match by text3 field/, :text3) do |client, data, _match|
+          client.say(text: "The matched field: 'text3'", channel: data.channel)
+        end
+        attachment(/Match by either title or text2 field/, %i[title text2]) do |client, data, match|
+          client.say(text: "The matched field: '#{match.attachment_field}'", channel: data.channel)
+        end
+      end
+    end
+
+    it 'matches by only text3 field' do
+      attachment = {
+        text3: 'Match by text3 field'
+      }
+      expect(attachments: attachment).to respond_with_slack_message("The matched field: 'text3'")
+    end
+
+    it 'matches by text2 field' do
+      attachment = {
+        text2: 'Match by either title or text2 field'
+      }
+      expect(attachments: attachment).to respond_with_slack_message("The matched field: 'text2'")
+    end
+    it 'matches by title field' do
+      attachment = {
+        title: 'Match by either title or text2 field'
+      }
+      expect(attachments: attachment).to respond_with_slack_message("The matched field: 'title'")
+    end
+    it 'does not match by default pretext field' do
+      attachment = {
+        pretext: 'Match by either title or text2 field'
+      }
+      expect(attachments: attachment).to not_respond
+    end
+  end
+
+  context 'default fields to scan' do
+    let! :command do
+      Class.new(SlackRubyBot::Commands::Base) do
+        attachment(/New comment matched by pretext #(?<id>\d+)/) do |client, data, match|
+          client.say(text: "The id: #{match[:id]}", channel: data.channel)
+          client.say(text: "Comment: '#{match.attachment.text}'", channel: data.channel)
+          client.say(text: "The matched field: '#{match.attachment_field}'", channel: data.channel)
+        end
+        attachment(/New comment matched by text #(?<id>\d+)/) do |client, data, match|
+          client.say(text: "The id: #{match[:id]}", channel: data.channel)
+          client.say(text: "Comment: '#{match.attachment.title}'", channel: data.channel)
+          client.say(text: "The matched field: '#{match.attachment_field}'", channel: data.channel)
+        end
+        attachment(/New comment matched by title #(?<id>\d+)/) do |client, data, match|
+          client.say(text: "The id: #{match[:id]}", channel: data.channel)
+          client.say(text: "Comment: '#{match.attachment.pretext}'", channel: data.channel)
+          client.say(text: "The matched field: '#{match.attachment_field}'", channel: data.channel)
+        end
+      end
+    end
+    def app
+      SlackRubyBot::App.new
+    end
+
+    let :expected_responses do
+      [
+        'The id: 12345',
+        "Comment: 'foo bar'"
+      ]
+    end
+    it 'matches pretext' do
+      expected_responses << "The matched field: 'pretext'"
+      attachment = {
+        pretext: 'New comment matched by pretext #12345',
+        text: 'foo bar'
+      }
+      expect(attachments: attachment).to respond_with_slack_messages(expected_responses)
+    end
+    it 'matches text' do
+      expected_responses << "The matched field: 'text'"
+      attachment = {
+        text: 'New comment matched by text #12345',
+        title: 'foo bar'
+      }
+      expect(attachments: attachment).to respond_with_slack_messages(expected_responses)
+    end
+    it 'matches title' do
+      expected_responses << "The matched field: 'title'"
+      attachment = {
+        title: 'New comment matched by title #12345',
+        pretext: 'foo bar'
+      }
+      expect(attachments: attachment).to respond_with_slack_messages(expected_responses)
+    end
+    it 'does not respond' do
+      attachment = {
+        text: 'no match'
+      }
+      expect(attachments: attachment).to not_respond
+    end
+  end
+end

data/spec/slack-ruby-bot/commands/bot_message_spec.rb

@@ -1,4 +1,4 @@
-describe SlackRubyBot::Commands::Help do
+describe SlackRubyBot::Commands::Unknown do
   def app
     SlackRubyBot::App.new
   end

data/spec/slack-ruby-bot/commands/commands_regexp_escape_spec.rb

@@ -6,10 +6,16 @@ describe SlackRubyBot::Commands do
       end
     end
   end
+
   def app
     SlackRubyBot::App.new
   end
+
   it 'does not return error' do
     expect(message: "#{SlackRubyBot.config.user} ( /").to respond_with_slack_message('(: /')
   end
+
+  it 'allows multiline expression' do
+    expect(message: "#{SlackRubyBot.config.user} (\n1\n2").to respond_with_slack_message("(: 1\n2")
+  end
 end

data/spec/slack-ruby-bot/commands/{help → support}/attrs_spec.rb

@@ -1,4 +1,4 @@
-describe SlackRubyBot::Commands::Help::Attrs do
+describe SlackRubyBot::Commands::Support::Attrs do
   let(:help_attrs) { described_class.new('WeatherBot') }
 
   it 'captures commands help attributes' do

data/spec/slack-ruby-bot/{support/commands_helper_spec.rb → commands/support/help_spec.rb}

@@ -1,10 +1,10 @@
-describe SlackRubyBot::CommandsHelper do
+describe SlackRubyBot::Commands::Support::Help do
   let(:bot_class) { Testing::WeatherBot }
   let(:command_class) { Testing::HelloCommand }
-  let(:commands_helper) { described_class.instance }
+  let(:help) { described_class.instance }
 
   describe '#capture_help' do
-    let(:help_attrs) { commands_helper.commands_help_attrs }
+    let(:help_attrs) { help.commands_help_attrs }
     let(:bot_help_attrs) { help_attrs.find { |k| k.klass == bot_class } }
     let(:command_help_attrs) { help_attrs.find { |k| k.klass == command_class } }
 
@@ -59,8 +59,22 @@ describe SlackRubyBot::CommandsHelper do
     end
   end
 
+  describe '#find_command_help_attrs' do
+    let(:hello_help_attrs) { help.find_command_help_attrs('hello') }
+
+    before(:each) do
+      command_class
+    end
+
+    it 'returns help attrs for hello command' do
+      expect(hello_help_attrs.command_name).to eq('hello')
+      expect(hello_help_attrs.command_desc).to eq('Says hello.')
+      expect(hello_help_attrs.command_long_desc).to eq('The long description')
+    end
+  end
+
   describe '#bot_desc_and_commands' do
-    let(:bot_desc_and_commands) { commands_helper.bot_desc_and_commands }
+    let(:bot_desc_and_commands) { help.bot_desc_and_commands }
     let(:bot_desc) { bot_desc_and_commands.first }
 
     it 'returns bot name and description' do
@@ -107,7 +121,7 @@ describe SlackRubyBot::CommandsHelper do
       end
     end
 
-    let(:other_commands_descs) { commands_helper.other_commands_descs }
+    let(:other_commands_descs) { help.other_commands_descs }
     let(:hello_command_desc) { other_commands_descs.find { |desc| desc =~ /\*hello\*/ } }
 
     it 'returns command name and description' do
@@ -122,7 +136,7 @@ describe SlackRubyBot::CommandsHelper do
   describe '#command_full_desc' do
     context 'for bot commands' do
       it 'returns long description' do
-        full_desc = commands_helper.command_full_desc("What's the weather in <city>?")
+        full_desc = help.command_full_desc("What's the weather in <city>?")
         expect(full_desc).to include "Accurate 10 Day Weather Forecasts for thousands of places around the World.\n" \
           'We provide detailed Weather Forecasts over a 10 day period updated four times a day.'
       end
@@ -130,18 +144,18 @@ describe SlackRubyBot::CommandsHelper do
 
     context 'for other commands' do
       it 'returns long description' do
-        full_desc = commands_helper.command_full_desc('hello')
+        full_desc = help.command_full_desc('hello')
         expect(full_desc).to include 'The long description'
       end
     end
 
     it 'returns correct message if there is no such command' do
-      full_desc = commands_helper.command_full_desc('deploy')
+      full_desc = help.command_full_desc('deploy')
       expect(full_desc).to eq "There's no command *deploy*"
     end
 
     it 'returns correct message if there is no long description for the command' do
-      full_desc = commands_helper.command_full_desc('clouds')
+      full_desc = help.command_full_desc('clouds')
       expect(full_desc).to eq "There's no description for command *clouds*"
     end
   end