Added support for generic routes via match, closes #5.

.rubocop_todo.yml

@@ -1,5 +1,5 @@
 # This configuration was generated by `rubocop --auto-gen-config`
-# on 2015-07-19 08:58:31 -0400 using RuboCop version 0.32.1.
+# on 2015-07-19 12:16:52 -0400 using RuboCop version 0.32.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -13,19 +13,19 @@ Lint/HandleExceptions:
 Lint/UselessAccessModifier:
   Enabled: false
 
-# Offense count: 1
+# Offense count: 2
 Metrics/AbcSize:
   Max: 21
 
-# Offense count: 28
+# Offense count: 37
 # Configuration parameters: AllowURI, URISchemes.
 Metrics/LineLength:
   Max: 142
 
-# Offense count: 1
+# Offense count: 2
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 17
+  Max: 18
 
 # Offense count: 15
 Style/Documentation:

CHANGELOG.md

@@ -1,5 +1,6 @@
 ### 0.3.0 (Next)
 
+* [#5](https://github.com/dblock/slack-ruby-bot/issues/5): Added support for free-formed routes via `match` - [@dblock](https://github.com/dblock).
 * [#6](https://github.com/dblock/slack-ruby-bot/issues/6): Commands and operators take blocks - [@dblock](https://github.com/dblock).
 * [#4](https://github.com/dblock/slack-ruby-bot/issues/4): Messages are posted with `as_user: true` by default - [@dblock](https://github.com/dblock).
 * Your contribution here.

README.md

@@ -28,7 +28,7 @@ module PongBot
   end
 
   class Ping < SlackRubyBot::Commands::Base
-    command 'ping' do |data, command, arguments|
+    command 'ping' do |data, _match|
       send_message data.channel, 'pong'
     end
   end
@@ -60,7 +60,7 @@ Bots are addressed by name and respond to commands and operators. By default a c
 class Phone < SlackRubyBot::Commands::Base
   command 'call'
 
-  def self.call(data, command, arguments)
+  def self.call(data, _match)
     send_message data.channel, 'called'
   end
 end
@@ -73,7 +73,7 @@ class Phone < SlackRubyBot::Commands::Base
   command 'call'
   command '呼び出し'
 
-  def self.call(data, command, arguments)
+  def self.call(data, _match)
     send_message data.channel, 'called'
   end
 end
@@ -83,22 +83,40 @@ You can combine multiple commands and use a block to implement them.
 
 ```ruby
 class Phone < SlackRubyBot::Commands::Base
-  command 'call', '呼び出し' do
+  command 'call', '呼び出し' do |data, _match|
     send_message data.channel, 'called'
   end
 end
 ```
 
+Command match data includes `match['bot']`, `match['command']` and `match['expression']`. The `bot` match always checks against the `SlackRubyBot::Config.user` setting.
+
 Operators are 1-letter long and are similar to commands. They don't require addressing a bot nor separating an operator from its arguments. The following class responds to `=2+2`.
 
 ```ruby
 class Calculator < SlackRubyBot::Commands::Base
-  operator '=' do
+  operator '=' do |_data, _match|
     # implementation detail
   end
 end
 ```
 
+Operator match data includes `match['operator']` and `match['expression']`. The `bot` match always checks against the `SlackRubyBot::Config.user` setting.
+
+### Generic Routing
+
+Commands and operators are generic versions of bot routes. You can respond to just about anything by defining a custom route.
+
+```ruby
+class Weather < SlackRubyBot::Commands::Base
+  match /^How is the weather in (<?location>\w*)\?$/ do |data, match|
+    send_message data.channel, "The weather in #{match[:location]} is nice."
+  end
+end
+```
+
+![](screenshots/weather.gif)
+
 ### Built-In Commands
 
 Slack-ruby-bot comes with several built-in commands. You can re-define built-in commands, normally, as described above.

TUTORIAL.md

@@ -51,7 +51,7 @@ Create a folder called `slack-mathbot/commands` and inside of it create `calcula
 module SlackMathbot
   module Commands
     class Calculate < SlackRubyBot::Commands::Base
-      def self.call(data, command, arguments)
+      command 'calculate' do |data, _match|
         send_message data.channel, '4'
       end
     end

examples/minimal/Gemfile.lock

@@ -1,11 +1,12 @@
 PATH
   remote: ../..
   specs:
-    slack-ruby-bot (0.2.0)
+    slack-ruby-bot (0.3.0)
       activesupport
       giphy (~> 2.0.2)
       hashie
       slack-api (~> 1.1.6)
+      websocket-driver (~> 0.5.4)
 
 GEM
   remote: http://rubygems.org/
@@ -20,7 +21,7 @@ GEM
     eventmachine (1.0.7)
     faraday (0.9.1)
       multipart-post (>= 1.2, < 3)
-    faraday_middleware (0.9.1)
+    faraday_middleware (0.9.2)
       faraday (>= 0.7.4, < 0.10)
     faraday_middleware-parse_oj (0.3.0)
       faraday (~> 0.9.0)
@@ -40,7 +41,7 @@ GEM
     launchy (2.4.3)
       addressable (~> 2.3)
     minitest (5.7.0)
-    multi_json (1.11.1)
+    multi_json (1.11.2)
     multipart-post (2.0.0)
     oj (2.12.9)
     slack-api (1.1.6)

examples/minimal/pongbot.rb

@@ -5,7 +5,7 @@ class App < SlackRubyBot::App
   end
 
   class Ping < SlackRubyBot::Commands::Base
-    def self.call(data, _command, _arguments)
+    def self.call(data, _match)
       send_message data.channel, 'pong'
     end
   end

examples/weather/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gem 'slack-ruby-bot', path: '../..'

examples/weather/weatherbot.rb

@@ -0,0 +1,14 @@
+require 'slack-ruby-bot'
+
+module WeatherBot
+  class App < SlackRubyBot::App
+  end
+
+  class Weather < SlackRubyBot::Commands::Base
+    match(/^How is the weather in (?<location>\w*)\?$/i) do |data, match|
+      send_message data.channel, "The weather in #{match[:location]} is nice."
+    end
+  end
+end
+
+WeatherBot::App.instance.run

lib/slack-ruby-bot.rb

@@ -4,8 +4,6 @@
 require 'slack-ruby-bot/about'
 require 'slack-ruby-bot/config'
 require 'slack-ruby-bot/hooks'
-require 'slack-ruby-bot/commands'
-require 'slack-ruby-bot/app'
 
 module SlackRubyBot
   class << self
@@ -18,3 +16,6 @@ def config
     end
   end
 end
+
+require 'slack-ruby-bot/commands'
+require 'slack-ruby-bot/app'

lib/slack-ruby-bot/commands/about.rb

@@ -1,10 +1,10 @@
 module SlackRubyBot
   module Commands
     class Default < Base
-      command 'default'
       command 'about'
+      match(/^(?<bot>\w*)$/)
 
-      def self.call(data, _command, _arguments)
+      def self.call(data, _match)
         send_message_with_gif data.channel, SlackRubyBot::ABOUT, 'selfie'
       end
     end

lib/slack-ruby-bot/commands/base.rb

@@ -1,8 +1,7 @@
 module SlackRubyBot
   module Commands
     class Base
-      class_attribute :operators
-      class_attribute :commands
+      class_attribute :routes
 
       def self.send_message(channel, text, options = { as_user: true })
         if text && text.length > 0
@@ -30,49 +29,58 @@ def self.logger
         end
       end
 
-      def self.responds_to_command?(command)
-        commands ? commands.keys.include?(command) : command == default_command_name
-      end
-
       def self.default_command_name
         name && name.split(':').last.downcase
       end
 
-      def self.responds_to_operator?(operator)
-        operators && operators.keys.include?(operator)
-      end
-
       def self.operator(*values, &block)
-        self.operators ||= {}
         values.each do |value|
-          self.operators[value] = block
+          match Regexp.new("^[\s]*(?<operator>\\#{value})(?<expression>.*)$", Regexp::IGNORECASE), &block
         end
       end
 
       def self.command(*values, &block)
-        self.commands ||= {}
         values.each do |value|
-          self.commands[value] = block
+          match Regexp.new("^[\s]*(?<bot>\\w*)[\\s]+(?<command>#{value})[\\s]*(?<expression>.*)$", Regexp::IGNORECASE), &block
         end
       end
 
-      def self.invoke(data, command, arguments)
-        method = self.commands[command] if self.commands
-        method ||= self.operators[command] if self.operators
-        if method
-          method.call(data, command, arguments)
-        elsif self.respond_to?(:call)
-          send :call, data, command, arguments
-        else
-          fail NotImplementedError, command
+      def self.invoke(data)
+        self.finalize_routes!
+        expression = data.text
+        called = false
+        routes.each_pair do |route, method|
+          match = route.match(expression)
+          next unless match
+          next if match.names.include?('bot') && match['bot'].downcase != SlackRubyBot.config.user
+          called = true
+          if method
+            method.call(data, match)
+          elsif self.respond_to?(:call)
+            send(:call, data, match)
+          else
+            fail NotImplementedError, data.text
+          end
+          break
         end
+        called
+      end
+
+      def self.match(match, &block)
+        self.routes ||= {}
+        self.routes[match] = block
       end
 
       private
 
       def self.chat_postMessage(message)
         Slack.chat_postMessage(message)
       end
+
+      def self.finalize_routes!
+        return if self.routes && self.routes.any?
+        command default_command_name
+      end
     end
   end
 end

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

@@ -1,7 +1,7 @@
 module SlackRubyBot
   module Commands
     class Help < Base
-      def self.call(data, _command, _arguments)
+      def self.call(data, _match)
         send_message_with_gif data.channel, 'See https://github.com/dblock/slack-ruby-bot, please.', 'help'
       end
     end

lib/slack-ruby-bot/commands/hi.rb

@@ -1,7 +1,7 @@
 module SlackRubyBot
   module Commands
     class Hi < Base
-      def self.call(data, _command, _arguments)
+      def self.call(data, _match)
         send_message_with_gif data.channel, "Hi <@#{data.user}>!", 'hi'
       end
     end

lib/slack-ruby-bot/commands/unknown.rb

@@ -1,7 +1,9 @@
 module SlackRubyBot
   module Commands
     class Unknown < Base
-      def self.call(data, _command, _arguments)
+      match(/^(?<bot>\w*)[\s]*(?<expression>.*)$/)
+
+      def self.call(data, _match)
         send_message_with_gif data.channel, "Sorry <@#{data.user}>, I don't understand that command!", 'idiot'
       end
     end