slack-ruby-bot 0.10.2 → 0.10.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 15ac681a340b2b17bc5a4148c0b55dd7295fc1f2
-  data.tar.gz: 04d0018c8acf732715f5992af917a69fcaa6d337
+  metadata.gz: 88982b31e113e853ff4c707a7718f0739ccf260e
+  data.tar.gz: 9f818712b6659e1281a89b0a144b922f9b66e61d
 SHA512:
-  metadata.gz: 9f04ac47c686f1acd671d691826e7192d24da2b73c30fcdfda5a553f0906fa37439b5d4b4c2690148fd8fee7dd58cb9c6b2074e141b4d9670dbe5ceaa05e2e75
-  data.tar.gz: 9e65685bc89a791ac36000bfd955daef01ef230f1010e31ff71b2133d82ee241c6f81dd6660ff81488d7d20a5e0b3f6eab5b79ba22323e5a3794e7e93b22349f
+  metadata.gz: 537ee07e13e6500c453b71cbfffa1b9eeda032baaf86319af4c298a6e65b3adc51de771694e6cc5107e4858d3344633bfaca7b70f23025afc6c5a1eb8bb23580
+  data.tar.gz: 6e2f758c616871af780b376613ef9eac7c0bfe6438f65e5950b035e4e450da31d207674b558b9e3726ca3287f0e468adda333988fa3c2a53b7fe0ac50757b660

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### 0.10.3 (06/15/2017)
+
+* [#145](https://github.com/slack-ruby/slack-ruby-bot/pull/145): Map multiple command strings to same controller method - [@chuckremes](https://github.com/chuckremes).
+* [#144](https://github.com/slack-ruby/slack-ruby-bot/pull/144): Support usage of commands with embedded spaces when using Controller methods - [@chuckremes](https://github.com/chuckremes).
+
 ### 0.10.2 (06/03/2017)
 
 * [#137](https://github.com/slack-ruby/slack-ruby-bot/pull/137): Add Model-View-Controller classes to allow for more explicit control over how `command`s are designed - [@chuckremes](https://github.com/chuckremes).

data/README.md

@@ -364,10 +364,11 @@ Consider the following `Agent` class which is the simplest default approach to t
 
 ```ruby
 class Agent < SlackRubyBot::Bot
-  command 'sayhello' do |client, data, match|
+  command 'sayhello', 'alternate way to call hello' do |client, data, match|
     client.say(channel: data.channel, text: "Received command #{match[:command]} with args #{match[:expression]}")
   end
 end
+```
 
 Using the MVC functionality, we would create a controller instead to encapsulate this function.
 ```ruby
@@ -375,6 +376,7 @@ class MyController < SlackRubyBot::MVC::Controller::Base
   def sayhello
     client.say(channel: data.channel, text: "Received command #{match[:command]} with args #{match[:expression]}")
   end
+  alternate_name :sayhello, :alternate_way_to_call_hello
 end
 MyController.new(MyModel.new, MyView.new)
 ```
@@ -384,6 +386,8 @@ However, the Controller anticipates that the model and view objects should conta
 
 A Controller may need helper methods for certain work. To prevent the helper method from creating a route that the bot will respond to directly, the instance method name should begin with an underscore (e.g. `_my_helper_method`). When building the bot routes, these methods will be skipped.
 
+Calling `alternate_name` after the method definition allows for method aliases similar to the regular `command` structure. When commands can be triggered by multiple text strings it's useful to have that ability map to the controller methods too.
+
 Lastly, the Controller class includes `ActiveSupport::Callbacks` which allows for full flexibility in creating `before`, `after`, and `around` hooks for all methods. Again, see the [inventory example](examples/inventory/inventorybot.rb) for more information.
 
 #### Model
@@ -404,18 +408,18 @@ class MyModel < SlackRubyBot::MVC::Model::Base
 
   def read(resource)
     self._resource = resource
-	run_callbacks :sanitize do
-		@db.select(:column1 => resource)
-		# ... do some expensive work
-	end
+    run_callbacks :sanitize do
+      @db.select(:column1 => resource)
+      # ... do some expensive work
+    end
   end
 
   private
 
   def sanitize_resource
     self._resource.downcase
-	result = yield
-	puts "After read, result is #{result.inspect}"
+    result = yield
+    puts "After read, result is #{result.inspect}"
   end
 end
 ```
@@ -435,37 +439,37 @@ class MyView < SlackRubyBot::MVC::View::Base
 
   def initialize
     @mailer = setup_mailer
-	@ftp = setup_ftp_handler
+    @ftp = setup_ftp_handler
   end
 
   def email_admin(message)
     run_callbacks :logit do
-	  @mailer.send(:administrator, message)
-	end
+      @mailer.send(:administrator, message)
+    end
   end
 
   def react_thumbsup
-	client.web_client.reactions_add(
-	name: :thumbs_up,
-	channel: data.channel,
-	timestamp: data.ts,
-	as_user: true)
+    client.web_client.reactions_add(
+      name: :thumbs_up,
+      channel: data.channel,
+      timestamp: data.ts,
+      as_user: true)
   end
 
   def react_thumbsdown
-	client.web_client.reactions_remove(
-	name: :thumbs_up,
-	channel: data.channel,
-	timestamp: data.ts,
-	as_user: true)
+    client.web_client.reactions_remove(
+      name: :thumbs_up,
+      channel: data.channel,
+      timestamp: data.ts,
+      as_user: true)
   end
 
   private
 
   def audit_trail
     Logger.audit("Sending email at [#{Time.now}]")
-	yield
-	Logger.audit("Email sent by [#{Time.now}]")
+    yield
+    Logger.audit("Email sent by [#{Time.now}]")
   end
 end
 ```

data/RELEASING.md

@@ -7,6 +7,7 @@ There're no particular rules about when to release slack-ruby-bot. Release bug f
 Run tests, check that all tests succeed locally.
 
 ```
+export CONCURRENCY=celluloid-io
 bundle install
 rake
 ```

data/lib/slack-ruby-bot/mvc/controller/base.rb

@@ -16,6 +16,10 @@ module SlackRubyBot
             Base.instance_variable_get(:@command_class)
           end
 
+          def aliases
+            Base.instance_variable_get(:@aliases)
+          end
+
           def reset!
             # Remove any earlier anonymous classes from prior calls so we don't leak them
             Commands::Base.command_classes.delete(Controller::Base.command_class) if Base.command_class
@@ -43,6 +47,7 @@ module SlackRubyBot
           def register_controller(controller)
             # Only used to keep a reference around so the instance object doesn't get garbage collected
             Base.instance_variable_set(:@controllers, []) unless controllers
+            Base.instance_variable_set(:@aliases, Hash.new { |h, k| h[k] = [] }) unless aliases
             controller_ary = Base.instance_variable_get(:@controllers)
             controller_ary << controller
             klass = controller.class
@@ -53,14 +58,18 @@ module SlackRubyBot
                        # Be sure to include shadowed public instance methods of this class
                        klass.public_instance_methods(false)).uniq.map(&:to_s)
 
-            methods.each do |meth_name|
-              next if meth_name[0] == '_'
-
-              # sprinkle a little syntactic sugar on top of existing `command` infrastructure
-              command_class.class_eval do
-                command meth_name.to_s do |client, data, match|
-                  controller.use_args(client, data, match)
-                  controller.call_command
+            methods.each do |name|
+              next if name[0] == '_'
+              commands = lookup_command_name(name)
+
+              # Generates a command for each controller method *and* its aliases
+              commands.each do |command_string|
+                # sprinkle a little syntactic sugar on top of existing `command` infrastructure
+                command_class.class_eval do
+                  command command_string do |client, data, match|
+                    controller.use_args(client, data, match)
+                    controller.call_command
+                  end
                 end
               end
             end
@@ -76,6 +85,47 @@ module SlackRubyBot
             controller = controller.superclass until controller.abstract?
             controller.public_instance_methods(true)
           end
+
+          # Maps a controller method name to an alternate command name. Used in cases where
+          # a command can be called via multiple text strings.
+          #
+          # Call this method *after* defining the original method.
+          #
+          #  Class.new(SlackRubyBot::MVC::Controller::Base) do
+          #    def quxo_foo_bar
+          #      client.say(channel: data.channel, text: "quxo foo bar: #{match[:expression]}")
+          #    end
+          #    # setup alias name after original method definition
+          #    alternate_name :quxo_foo_bar, :another_text_string
+          #  end
+          #
+          # This is equivalent to:
+          #
+          # e.g.
+          #  command 'quxo foo bar', 'another text string' do |*args|
+          #    ..
+          #  end
+          def alternate_name(original_name, *alias_names)
+            command_name = convert_method_name_to_command_string(original_name)
+            command_aliases = alias_names.map do |name|
+              convert_method_name_to_command_string(name)
+            end
+
+            aliases[command_name] += command_aliases
+
+            alias_names.each { |alias_name| alias_method(alias_name, original_name) }
+          end
+
+          private
+
+          def lookup_command_name(name)
+            name = convert_method_name_to_command_string(name)
+            [name] + aliases[name]
+          end
+
+          def convert_method_name_to_command_string(name)
+            name.to_s.tr('_', ' ')
+          end
         end
 
         abstract!
@@ -102,9 +152,15 @@ module SlackRubyBot
         # Determine the command issued and call the corresponding instance method
         def call_command
           verb = match.captures[match.names.index('command')]
-          verb = verb.downcase if verb
+          verb = normalize_command_string(verb)
           public_send(verb)
         end
+
+        private
+
+        def normalize_command_string(string)
+          string.downcase.tr(' ', '_')
+        end
       end
     end
   end

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

@@ -1,3 +1,3 @@
 module SlackRubyBot
-  VERSION = '0.10.2'.freeze
+  VERSION = '0.10.3'.freeze
 end

data/spec/slack-ruby-bot/mvc/controller/controller_to_command_spec.rb

@@ -95,3 +95,56 @@ describe SlackRubyBot::MVC::Controller::Base, 'execution' do
     expect(instance.__flag).to be_truthy
   end
 end
+
+describe SlackRubyBot::MVC::Controller::Base, 'command text conversion' do
+  let(:controller) do
+    Class.new(SlackRubyBot::MVC::Controller::Base) do
+      def quxo_foo_bar
+        client.say(channel: data.channel, text: "#{match[:command].downcase}: #{match[:expression]}")
+      end
+    end
+  end
+
+  after(:each) { controller.reset! }
+
+  it 'converts a command with spaces into a controller method with underscores separating the tokens' do
+    model = SlackRubyBot::MVC::Model::Base.new
+    view = SlackRubyBot::MVC::View::Base.new
+    controller.new(model, view)
+    expect(message: "  #{SlackRubyBot.config.user}   quxo foo bar red").to respond_with_slack_message('quxo foo bar: red')
+  end
+
+  it 'converts a command with upper case letters into a lower case method call' do
+    model = SlackRubyBot::MVC::Model::Base.new
+    view = SlackRubyBot::MVC::View::Base.new
+    controller.new(model, view)
+    expect(message: "  #{SlackRubyBot.config.user}   Quxo Foo Bar red").to respond_with_slack_message('quxo foo bar: red')
+  end
+end
+
+describe SlackRubyBot::MVC::Controller::Base, 'alternate command text conversion' do
+  let(:controller) do
+    Class.new(SlackRubyBot::MVC::Controller::Base) do
+      def quxo_foo_bar
+        client.say(channel: data.channel, text: "quxo foo bar: #{match[:expression]}")
+      end
+      alternate_name :quxo_foo_bar, :another_text_string, :third_text_string
+    end
+  end
+
+  after(:each) { controller.reset! }
+
+  it 'aliases another valid command string to the controller method' do
+    model = SlackRubyBot::MVC::Model::Base.new
+    view = SlackRubyBot::MVC::View::Base.new
+    controller.new(model, view)
+    expect(message: "  #{SlackRubyBot.config.user}   another text string red").to respond_with_slack_message('quxo foo bar: red')
+  end
+
+  it 'allows for aliasing multiple names in a single call' do
+    model = SlackRubyBot::MVC::Model::Base.new
+    view = SlackRubyBot::MVC::View::Base.new
+    controller.new(model, view)
+    expect(message: "  #{SlackRubyBot.config.user}   third text string red").to respond_with_slack_message('quxo foo bar: red')
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack-ruby-bot
 version: !ruby/object:Gem::Version
-  version: 0.10.2
+  version: 0.10.3
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-03 00:00:00.000000000 Z
+date: 2017-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -266,7 +266,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: The easiest way to write a Slack bot in Ruby.