slack-ruby-bot 0.10.1 → 0.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 599b19f9020a13b61a9cda2f4bd570e4121a4208
-  data.tar.gz: 885f72dffbb46d911fb7368309713393a684d35f
+  metadata.gz: 15ac681a340b2b17bc5a4148c0b55dd7295fc1f2
+  data.tar.gz: 04d0018c8acf732715f5992af917a69fcaa6d337
 SHA512:
-  metadata.gz: 2f98b14588981310cafa3b95aa12b167551bdd32c7c0a78f77689d6d7ded74a10088f0b65a60a777f186f280a5e2ad1fd309e3166987d4f9c0e4fef83059a313
-  data.tar.gz: 25c471d74bf5b09f4ebe5de10f74add3decf68c226fa8e57506a58a282c7736441604431bac0773afc08a169e36b4c0c0c848643d255fe5ed13e7bb245e7b2fb
+  metadata.gz: 9f04ac47c686f1acd671d691826e7192d24da2b73c30fcdfda5a553f0906fa37439b5d4b4c2690148fd8fee7dd58cb9c6b2074e141b4d9670dbe5ceaa05e2e75
+  data.tar.gz: 9e65685bc89a791ac36000bfd955daef01ef230f1010e31ff71b2133d82ee241c6f81dd6660ff81488d7d20a5e0b3f6eab5b79ba22323e5a3794e7e93b22349f

data/.rspec

@@ -1,2 +1,3 @@
 --format documentation
 --color
+--require spec_helper

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### 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).
+* [#130](https://github.com/slack-ruby/slack-ruby-bot/issues/130): Added test dependencies in TUTORIAL.md - [@jbristow](https://github.com/jbristow).
+
 ### 0.10.1 (2/12/2017)
 
 * [#113](https://github.com/slack-ruby/slack-ruby-bot/issues/113): Fixed commands in subclassed `SlackRubyBot::Bot` - [@dblock](https://github.com/dblock).

data/README.md

@@ -19,7 +19,7 @@ If you are not familiar with Slack bots or Slack API concepts, you might want to
 
 ## Stable Release
 
-You're reading the documentation for the **stable** release of slack-ruby-bot, 0.10.1. See [CHANGELOG](CHANGELOG.md) for a history of changes and [UPGRADING](UPGRADING.md) for how to upgrade to more recent versions.
+You're reading the documentation for the **next** release of slack-ruby-bot. Please see the documentation for the [last stable release, v0.10.1](https://github.com/slack-ruby/slack-ruby-bot/tree/v0.10.1) unless you're integrating with HEAD. See [CHANGELOG](CHANGELOG.md) for a history of changes and [UPGRADING](UPGRADING.md) for how to upgrade to more recent versions.
 
 ## Usage
 
@@ -64,7 +64,9 @@ The following examples of bots based on slack-ruby-bot are listed in growing ord
 * [slack-mathbot](https://github.com/dblock/slack-mathbot): Slack integration with math.
 * [slack-google-bot](https://github.com/dblock/slack-google-bot): A Slack bot that searches Google, including CSE.
 * [slack-aws](https://github.com/dblock/slack-aws): Slack integration with Amazon Web Services.
+* [slack-deploy-bot](https://github.com/accessd/slack-deploy-bot): A Slack bot that helps you to deploy your apps.
 * [slack-gamebot](https://github.com/dblock/slack-gamebot): A game bot service for ping pong, chess, etc, hosted at [playplay.io](http://playplay.io).
+* [slack-victorbot](https://github.com/uShip/victorbot): A Slack bot to talk to the Victorops service.
 
 ### Commands and Operators
 
@@ -293,7 +295,7 @@ module MyBot
 end
 ```
 
-Hooks can also be written as blocks inside the `SlackBotRuby::Server` class, for example
+Hooks can also be written as blocks inside the `SlackRubyBot::Server` class, for example
 
 ```ruby
 module MyBot
@@ -344,6 +346,133 @@ end
 
 For an example of advanced integration that supports multiple teams, see [slack-gamebot](https://github.com/dblock/slack-gamebot) and [playplay.io](http://playplay.io) that is built on top of it.
 
+### Model-View-Controller Design
+
+The `command` method is essentially a controller method that receives input from the outside and acts upon it. Complex behaviors could lead to a long and difficult-to-understand `command` block. A complex `command` block is a candidate for separation into classes conforming to the Model-View-Controller pattern popularized by Rails.
+
+The library provides three helpful base classes named `SlackRubyBot::MVC::Model::Base`, `SlackRubyBot::MVC::View::Base`, and `SlackRubyBot::MVC::Controller::Base`.
+
+Testing a `command` block is difficult. As separate classes, the Model/View/Controller's behavior can be tested via `rspec` or a similar tool.
+
+#### Controller
+
+The Controller is the focal point of the bot behavior. Typically the code that would go into the `command` block will now go into an instance method in a Controller subclass. The instance method name should match the command name exactly (case sensitive).
+
+As an example, these two classes are functionally equivalent.
+
+Consider the following `Agent` class which is the simplest default approach to take.
+
+```ruby
+class Agent < SlackRubyBot::Bot
+  command 'sayhello' 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
+class MyController < SlackRubyBot::MVC::Controller::Base
+  def sayhello
+    client.say(channel: data.channel, text: "Received command #{match[:command]} with args #{match[:expression]}")
+  end
+end
+MyController.new(MyModel.new, MyView.new)
+```
+Note in the above example that the Controller instance method `sayhello` does not receive any arguments. When the instance method is called, the Controller class sets up some accessor methods to provide the normal `client`, `data`, and `match` objects. These are the same objects passed to the `command` block.
+
+However, the Controller anticipates that the model and view objects should contain business logic that will also operate on the `client`, `data`, and `match` objects. The controller provides access to the model and view via the `model` and `view` accessor methods. The [inventory example](examples/inventory/inventorybot.rb) provides a full example of a Model, View, and Controller working together.
+
+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.
+
+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
+
+A complex bot may need to read or write data from a database or other network resource. Setting up and tearing down these connections can be costly, so the model can do it once upon instantiation.
+
+The Model also includes `ActiveSupport::Callbacks`.
+
+```ruby
+class MyModel < SlackRubyBot::MVC::Model::Base
+  define_callbacks :sanitize
+  set_callback :sanitize, :around, :sanitize_resource
+  attr_accessor :_resource
+
+  def initialize
+    @db = setup_database_connection
+  end
+
+  def read(resource)
+    self._resource = resource
+	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}"
+  end
+end
+```
+
+Like Controllers, the Model is automatically loaded with the latest version of the `client`, `data`, and `match` objects each time the controller method is called. Therefore the model will always have access to the latest objects when doing its work. It will typically only use the `data` and `match` objects.
+
+Model methods are not matched to routes, so there is no restriction on how to name methods as there is in Controllers.
+
+#### View
+
+A typical bot just writes to a channel or uses the web client to react/unreact to a message. More complex bots will probably require more complex behaviors. These should be stored in a `SlackRubyBot::MVC::View::Base` subclass.
+
+```ruby
+class MyView < SlackRubyBot::MVC::View::Base
+  define_callbacks :logit
+  set_callbacks :logit, :around, :audit_trail
+
+  def initialize
+    @mailer = setup_mailer
+	@ftp = setup_ftp_handler
+  end
+
+  def email_admin(message)
+    run_callbacks :logit do
+	  @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)
+  end
+
+  def react_thumbsdown
+	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}]")
+  end
+end
+```
+Again, the View will have access to the most up to date `client`, `data`, and `match` objects. It will typically only use the `client` and `data` objects.
+
+View methods are not matched to routes, so there is no restriction on how to name methods as there is in Controllers.
+
 ### RSpec Shared Behaviors
 
 Slack-ruby-bot ships with a number of shared RSpec behaviors that can be used in your RSpec tests.

data/TUTORIAL.md

@@ -13,7 +13,7 @@ A typical production Slack bot is a combination of a vanilla web server and a we
 Create a `Gemfile` that uses [slack-ruby-bot](https://github.com/slack-ruby/slack-ruby-bot), [sinatra](https://github.com/sinatra/sinatra) (a web framework) and [puma](https://github.com/puma/puma) (a web server). For development we'll also use [foreman](https://github.com/theforeman/foreman) and write tests with [rspec](https://github.com/rspec/rspec).
 
 ```ruby
-source 'http://rubygems.org'
+source 'https://rubygems.org'
 
 gem 'slack-ruby-bot'
 gem 'puma'
@@ -29,6 +29,8 @@ end
 group :test do
   gem 'rspec'
   gem 'rack-test'
+  gem 'vcr'
+  gem 'webmock'
 end
 ```
 

data/examples/inventory/Gemfile

@@ -0,0 +1,5 @@
+source 'http://rubygems.org'
+
+gem 'slack-ruby-bot', path: '../..'
+gem 'celluloid-io'
+gem 'sqlite3'

data/examples/inventory/Procfile

@@ -0,0 +1 @@
+console: bundle exec ruby inventorybot.rb

data/examples/inventory/inventorybot.rb

@@ -0,0 +1,248 @@
+require 'slack-ruby-bot'
+require 'sqlite3'
+
+# Demonstrate the usage of the Model, View, and Controller
+# classes to build an inventory bot.
+
+SlackRubyBot::Client.logger.level = Logger::WARN
+
+# The Controller takes the place of the `command` block. It has access to the
+# `client`, `data`, and `match` arguments passed to the `command` block. Each
+# instance method generates a route for the bot to match against.
+#
+# The controller instance accesses the model and view via the `model` and
+# `view` accessor methods.
+#
+# ActiveSupport::Callbacks support is included so every method can have
+# before, after, or around hooks.
+#
+# Helper methods should begin with an underscore (e.g. _row) so that
+# `command` routes are not auto-generated for the method.
+#
+class InventoryController < SlackRubyBot::MVC::Controller::Base
+  define_callbacks :react, :notify
+  set_callback :react, :around, :around_reaction
+  set_callback :notify, :after, :notify_admin
+  attr_accessor :_row
+
+  def create
+    model.add_item(match[:expression])
+  end
+
+  def read
+    run_callbacks :react do
+      row = model.read_item(match[:expression])
+      view.say(channel: data.channel, text: row.inspect)
+    end
+  end
+
+  def update
+    run_callbacks :notify do
+      self._row = model.update_item(match[:expression])
+    end
+  end
+
+  def delete
+    result = model.delete_item(match[:expression])
+    if result
+      view.delete_succeeded
+    else
+      view.delete_failed
+    end
+  end
+
+  private
+
+  def notify_admin
+    row = _row.first
+    return if row[:quantity].to_i.zero?
+    view.email_admin("Inventory item #{row[:name]} needs to be refilled.")
+    view.say(channel: data.channel, text: "Administrator notified via email to refill #{row[:name]}.")
+  end
+
+  def around_reaction
+    view.react_wait
+    view.say(channel: data.channel, text: 'Please wait while long-running action completes...')
+    sleep 2.0
+    yield
+    view.say(channel: data.channel, text: 'Action has completed!')
+    view.unreact_wait
+  end
+end
+
+# The Model contains all business logic.
+#
+# ActiveSupport::Callbacks support is included for before, after,
+# or around hooks.
+#
+# The Model has access to the `client`, `data`, and `match` objects.
+#
+class InventoryModel < SlackRubyBot::MVC::Model::Base
+  define_callbacks :fixup
+  set_callback :fixup, :before, :normalize_data
+  attr_accessor :_line
+
+  def initialize
+    @db = SQLite3::Database.new ':memory'
+    @db.results_as_hash = true
+    @db.execute 'CREATE TABLE IF NOT EXISTS Inventory(Id INTEGER PRIMARY KEY,
+            Name TEXT, Quantity INT, Price INT)'
+
+    s = @db.prepare 'SELECT * FROM Inventory'
+    results = s.execute
+    count = 0
+    count += 1 while results.next
+    return if count < 4
+    add_item "'Audi',3,52642"
+    add_item "'Mercedes',1,57127"
+    add_item "'Skoda',5,9000"
+    add_item "'Volvo',1,29000"
+  end
+
+  def add_item(line)
+    self._line = line # make line accessible to callback
+    run_callbacks :fixup do
+      name, quantity, price = parse(_line)
+      row = @db.prepare('SELECT MAX(Id) FROM Inventory').execute
+      max_id = row.next_hash['MAX(Id)']
+      @db.execute "INSERT INTO Inventory VALUES(#{max_id + 1},'#{name}',#{quantity.to_i},#{price.to_i})"
+    end
+  end
+
+  def read_item(line)
+    self._line = line
+    run_callbacks :fixup do
+      name, _other = parse(_line)
+      statement = if name == '*'
+                    @db.prepare 'SELECT * FROM Inventory'
+                  else
+                    @db.prepare("SELECT * FROM Inventory WHERE Name='#{name}'")
+                  end
+
+      results = statement.execute
+      a = []
+      results.each do |row|
+        a << { id: row['Id'], name: row['Name'], quantity: row['Quantity'], price: row['Price'] }
+      end
+      a
+    end
+  end
+
+  def update_item(line)
+    self._line = line
+    run_callbacks :fixup do
+      name, quantity, price = parse(_line)
+      statement = if price
+                    @db.prepare "UPDATE Inventory SET Quantity=#{quantity}, Price=#{price} WHERE Name='#{name}'"
+                  else
+                    @db.prepare "UPDATE Inventory SET Quantity=#{quantity} WHERE Name='#{name}'"
+                  end
+      statement.execute
+      read_item(_line)
+    end
+  end
+
+  def delete_item(line)
+    self._line = line
+    run_callbacks :fixup do
+      name, _other = parse(_line)
+      before_count = row_count
+      statement = @db.prepare "DELETE FROM Inventory WHERE Name='#{name}'"
+      statement.execute
+      before_count != row_count
+    end
+  end
+
+  private
+
+  def row_count
+    statement = @db.prepare 'SELECT COUNT(*) FROM Inventory'
+    result = statement.execute
+    result.next_hash['COUNT(*)']
+  end
+
+  def parse(line)
+    line.split(',')
+  end
+
+  def normalize_data
+    name, quantity, price = parse(_line)
+    self._line = [name.capitalize, quantity, price].join(',')
+  end
+end
+
+# All interactivity logic should live in this class.
+#
+# ActiveSupport::Callbacks support is included for before, after,
+# or around hooks.
+#
+# The Model has access to the `client`, `data`, and `match` objects.
+#
+class InventoryView < SlackRubyBot::MVC::View::Base
+  def react_wait
+    client.web_client.reactions_add(
+      name: :hourglass_flowing_sand,
+      channel: data.channel,
+      timestamp: data.ts,
+      as_user: true
+    )
+  end
+
+  def unreact_wait
+    client.web_client.reactions_remove(
+      name: :hourglass_flowing_sand,
+      channel: data.channel,
+      timestamp: data.ts,
+      as_user: true
+    )
+  end
+
+  def email_admin(message)
+    # send email to administrator with +message+
+    # ...
+    puts "Sent email to administrator: #{message}"
+  end
+
+  def delete_succeeded
+    say(channel: data.channel, text: 'Item was successfully deleted.')
+  end
+
+  def delete_failed
+    say(channel: data.channel, text: 'Item failed to be deleted.')
+  end
+end
+
+class InventoryBot < SlackRubyBot::Bot
+  help do
+    title 'Inventory Bot'
+    desc 'This bot lets you create, read, update, and delete items from an inventory.'
+
+    command 'create' do
+      desc 'Add an item to the inventory.'
+    end
+
+    command 'read' do
+      desc 'Get inventory status for an item.'
+    end
+
+    command 'update' do
+      desc 'Update inventory levels for an item.'
+    end
+
+    command 'delete' do
+      desc 'Remove an item from inventory.'
+    end
+  end
+
+  # Instantiate the Model, View, and Controller objects within the +Bot+ subclass
+  # or within a SlackRubyBot::Commands::Base subclass.
+  #
+  model = InventoryModel.new
+  view = InventoryView.new
+  @controller = InventoryController.new(model, view)
+  @controller.class.command_class.routes.each do |route|
+    STDERR.puts route.inspect
+  end
+end
+
+InventoryBot.run

data/lib/slack-ruby-bot.rb

@@ -25,3 +25,4 @@ require 'slack-ruby-bot/client'
 require 'slack-ruby-bot/server'
 require 'slack-ruby-bot/app'
 require 'slack-ruby-bot/bot'
+require 'slack-ruby-bot/mvc'

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

@@ -36,7 +36,7 @@ module SlackRubyBot
         end
 
         def default_command_name
-          name && name.split(':').last.downcase
+          name ? name.split(':').last.downcase : object_id.to_s
         end
 
         def operator(*values, &block)

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

@@ -0,0 +1 @@
+require 'slack-ruby-bot/mvc/mvc'

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

@@ -0,0 +1,111 @@
+module SlackRubyBot
+  module MVC
+    module Controller
+      class Base
+        include ActiveSupport::Callbacks
+
+        class << self
+          attr_reader :abstract
+          alias abstract? abstract
+
+          def controllers
+            Base.instance_variable_get(:@controllers)
+          end
+
+          def command_class
+            Base.instance_variable_get(:@command_class)
+          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
+
+            # Create anonymous class to hold our #commands; required by SlackRubyBot::Commands::Base
+            Base.instance_variable_set(:@command_class, Class.new(SlackRubyBot::Commands::Base))
+            Base.instance_variable_set(:@controllers, [])
+          end
+
+          # Define a controller as abstract. See internal_methods for more
+          # details.
+          def abstract!
+            @abstract = true
+          end
+
+          def inherited(klass) # :nodoc:
+            # Define the abstract ivar on subclasses so that we don't get
+            # uninitialized ivar warnings
+            unless klass.instance_variable_defined?(:@abstract)
+              klass.instance_variable_set(:@abstract, false)
+            end
+            super
+          end
+
+          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
+            controller_ary = Base.instance_variable_get(:@controllers)
+            controller_ary << controller
+            klass = controller.class
+
+            methods = (klass.public_instance_methods(true) -
+                       # Except for public instance methods of Base and its ancestors
+                       internal_methods(klass) +
+                       # 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
+                end
+              end
+            end
+          end
+
+          # A list of all internal methods for a controller. This finds the first
+          # abstract superclass of a controller, and gets a list of all public
+          # instance methods on that abstract class. Public instance methods of
+          # a controller would normally be considered action methods, so methods
+          # declared on abstract classes are being removed.
+          # (Controller::Base is defined as abstract)
+          def internal_methods(controller)
+            controller = controller.superclass until controller.abstract?
+            controller.public_instance_methods(true)
+          end
+        end
+
+        abstract!
+        reset!
+
+        attr_reader :model, :view, :client, :data, :match
+
+        def initialize(model, view)
+          @model = model
+          @view = view
+          self.class.register_controller(self)
+        end
+
+        # Hand off the latest updated objects to the +model+ and +view+ and
+        # update our +client+, +data+, and +match+ accessors.
+        def use_args(client, data, match)
+          @client = client
+          @data = data
+          @match = match
+          model.use_args(client, data, match)
+          view.use_args(client, data, match)
+        end
+
+        # 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
+          public_send(verb)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+module SlackRubyBot
+  module MVC
+    module Model
+      class Base
+        include ActiveSupport::Callbacks
+
+        class << self
+          def inherited(klass) # :nodoc:
+            super
+          end
+        end
+
+        attr_reader :client, :data, :match
+
+        # Hand off the latest updated objects to the +model+ and +view+ and
+        # update our +client+, +data+, and +match+ accessors.
+        def use_args(client, data, match)
+          @client = client
+          @data = data
+          @match = match
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+require_relative '../mvc/controller/base'
+
+require_relative '../mvc/model/base'
+
+require_relative '../mvc/view/base'

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

@@ -0,0 +1,28 @@
+module SlackRubyBot
+  module MVC
+    module View
+      class Base
+        include ActiveSupport::Callbacks
+        extend Forwardable
+
+        class << self
+          def inherited(klass) # :nodoc:
+            super
+          end
+        end
+
+        attr_reader :client, :data, :match
+
+        def_delegators :@client, :say
+
+        # Hand off the latest updated objects to the +model+ and +view+ and
+        # update our +client+, +data+, and +match+ accessors.
+        def use_args(client, data, match)
+          @client = client
+          @data = data
+          @match = match
+        end
+      end
+    end
+  end
+end

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

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

data/spec/slack-ruby-bot/app_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 describe SlackRubyBot::App do
   def app
     SlackRubyBot::App.new

data/spec/slack-ruby-bot/client_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 describe SlackRubyBot::Client do
   describe '#send_gifs?' do
     context 'without giphy is false', unless: ENV.key?('WITH_GIPHY') do

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

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 describe SlackRubyBot::Commands::Default do
   it 'lowercase' do
     expect(message: SlackRubyBot.config.user).to respond_with_slack_message(SlackRubyBot::ABOUT)

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

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 describe SlackRubyBot do
   def client
     SlackRubyBot::Client.new aliases: %w(:emoji: alias каспаров)

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

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 describe SlackRubyBot::Commands::Help do
   def app
     SlackRubyBot::App.new

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

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 describe SlackRubyBot::Bot do
   let! :command do
     Class.new(SlackRubyBot::Bot) do

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

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 describe SlackRubyBot::Commands::Base do
   let! :command1 do
     Class.new(SlackRubyBot::Commands::Base) do
@@ -35,5 +33,12 @@ describe SlackRubyBot::Commands::Base do
       command_classes = SlackRubyBot::Commands::Base.command_classes
       expect(command_classes.find_index(command1)).to be < command_classes.find_index(command2)
     end
+
+    it 'uses the object_id of an anonymous class as the default command name' do
+      command_classes = SlackRubyBot::Commands::Base.command_classes
+      anon_class = Class.new(SlackRubyBot::Commands::Base)
+      expect(command_classes).to include anon_class
+      expect(command_classes.find { |obj| obj == anon_class }.object_id.to_s).to eq anon_class.default_command_name
+    end
   end
 end

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

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 describe SlackRubyBot::Commands do
   let! :command do
     Class.new(SlackRubyBot::Commands::Base) do

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

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 describe SlackRubyBot::Commands do
   let! :command do
     Class.new(SlackRubyBot::Commands::Base) do

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

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 describe SlackRubyBot::Commands do
   let! :command do
     Class.new(SlackRubyBot::Commands::Base) do

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

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 describe SlackRubyBot::Commands do
   let! :command do
     Class.new(SlackRubyBot::Commands::Base) do

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

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 describe SlackRubyBot::Commands do
   let! :command do
     Class.new(SlackRubyBot::Commands::Base) do

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

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 describe SlackRubyBot::Commands do
   let! :command do
     Class.new(SlackRubyBot::Commands::Base) do

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

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 describe SlackRubyBot do
   def app
     SlackRubyBot::App.new

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

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 describe SlackRubyBot::Commands do
   let! :command do
     Class.new(SlackRubyBot::Commands::Base) do

data/spec/slack-ruby-bot/commands/help/attrs_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 describe SlackRubyBot::Commands::Help::Attrs do
   let(:help_attrs) { described_class.new('WeatherBot') }
 

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

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 describe SlackRubyBot::Commands::Help do
   def app
     SlackRubyBot::App.new

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

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 describe SlackRubyBot::Commands::Hi do
   def app
     SlackRubyBot::App.new

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

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 describe SlackRubyBot::Commands do
   let! :command do
     Class.new(SlackRubyBot::Commands::Base) do

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

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 describe SlackRubyBot::App do
   def app
     SlackRubyBot::App.new

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

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 describe SlackRubyBot::Commands do
   let! :command do
     Class.new(SlackRubyBot::Commands::Base) do

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

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 describe SlackRubyBot::Commands::Base do
   let! :command do
     Class.new(SlackRubyBot::Commands::Base) do

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

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 describe SlackRubyBot::Commands do
   let! :command do
     Class.new(SlackRubyBot::Commands::Base) do

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

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 describe SlackRubyBot::Commands do
   let! :command do
     Class.new(SlackRubyBot::Commands::Base) do

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

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 describe SlackRubyBot::Commands do
   let! :command do
     Class.new(SlackRubyBot::Commands::Base) do

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

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 describe SlackRubyBot::Commands, if: ENV.key?('WITH_GIPHY') do
   let! :command do
     Class.new(SlackRubyBot::Commands::Base) do

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

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 describe SlackRubyBot::Commands do
   let! :command do
     Class.new(SlackRubyBot::Commands::Base) do

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

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 describe SlackRubyBot::Commands, if: ENV.key?('WITH_GIPHY') do
   let! :command do
     Class.new(SlackRubyBot::Commands::Base) do

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

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 describe SlackRubyBot::Commands::Unknown do
   it 'invalid command' do
     expect(message: "#{SlackRubyBot.config.user} foobar").to respond_with_slack_message("Sorry <@user>, I don't understand that command!")

data/spec/slack-ruby-bot/config_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 describe SlackRubyBot::Config do
   describe '.send_gifs?' do
     after { ENV.delete 'SLACK_RUBY_BOT_SEND_GIFS' }

data/spec/slack-ruby-bot/hooks/hook_support_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 describe SlackRubyBot::Hooks::HookSupport do
   subject do
     Class.new do

data/spec/slack-ruby-bot/hooks/message_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 describe SlackRubyBot::Hooks::Message do
   let(:message_hook) { described_class.new }
 

data/spec/slack-ruby-bot/hooks/set_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 describe SlackRubyBot::Hooks::Set do
   let(:client) { Slack::RealTime::Client.new }
 

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

@@ -0,0 +1,97 @@
+describe SlackRubyBot::MVC::Controller::Base, 'initialization' do
+  let(:model) { double('model') }
+  let(:view) { double('view') }
+  let(:controller) do
+    Class.new(SlackRubyBot::MVC::Controller::Base) do
+      def quxo() end
+    end
+  end
+
+  after(:each) { controller.reset! }
+
+  it 'sets :model accessor to passed in model' do
+    expect(controller.new(model, view).model).to eq(model)
+  end
+
+  it 'sets :view accessor to passed in view' do
+    expect(controller.new(model, view).view).to eq(view)
+  end
+
+  it 'saves the controller instance to the class' do
+    instance = controller.new(model, view)
+    expect(SlackRubyBot::MVC::Controller::Base.controllers).to include(instance)
+    SlackRubyBot::MVC::Controller::Base.controllers.clear
+  end
+
+  it 'creates a command route on SlackRubyBot::Commands::Base' do
+    controller.reset!
+    route_count = 0
+    controller.new(model, view)
+    expect(controller.command_class.routes.size).to eq(route_count + 1)
+  end
+
+  it 'does NOT create a command route on SlackRubyBot::Commands::Base when method starts with a single "_"' do
+    controller.reset!
+    route_count = 0
+    controller.class_eval do
+      def _no_route_to_me() end
+    end
+    controller.new(model, view)
+    expect(controller.command_class.routes.size).to eq(route_count + 1) # instead of +2
+  end
+end
+
+describe SlackRubyBot::MVC::Controller::Base, 'setup' do
+  let(:controller) do
+    Class.new(SlackRubyBot::MVC::Controller::Base) do
+      def quxo
+        client.say(channel: data.channel, text: "#{match[:command]}: #{match[:expression]}")
+      end
+    end
+  end
+
+  after(:each) { controller.reset! }
+
+  it 'passes client, data, and match args to the model' do
+    model = SlackRubyBot::MVC::Model::Base.new
+    view = SlackRubyBot::MVC::View::Base.new
+    controller.new(model, view)
+    expect(message: "  #{SlackRubyBot.config.user}   quxo red").to respond_with_slack_message('quxo: red')
+    expect(model.client).to be_kind_of(SlackRubyBot::Client)
+    expect(model.data).to be_kind_of(Hash)
+    expect(model.match).to be_kind_of(MatchData)
+  end
+
+  it 'passes client, data, and match args to the view' do
+    model = SlackRubyBot::MVC::Model::Base.new
+    view = SlackRubyBot::MVC::View::Base.new
+    controller.new(model, view)
+    expect(message: "  #{SlackRubyBot.config.user}   quxo red").to respond_with_slack_message('quxo: red')
+    expect(view.client).to be_kind_of(SlackRubyBot::Client)
+    expect(view.data).to be_kind_of(Hash)
+    expect(view.match).to be_kind_of(MatchData)
+  end
+end
+
+describe SlackRubyBot::MVC::Controller::Base, 'execution' do
+  let(:controller) do
+    Class.new(SlackRubyBot::MVC::Controller::Base) do
+      attr_accessor :__flag
+      def quxo
+        @__flag = true
+        client.say(channel: data.channel, text: "#{match[:command]}: #{match[:expression]}")
+      end
+    end
+  end
+
+  after(:each) { controller.reset! }
+
+  it 'runs the controller method' do
+    model = SlackRubyBot::MVC::Model::Base.new
+    view = SlackRubyBot::MVC::View::Base.new
+    instance = controller.new(model, view)
+    instance.__flag = false
+    expect(message: "  #{SlackRubyBot.config.user}   quxo red").to respond_with_slack_message('quxo: red')
+    expect(instance.__flag).to be_truthy
+  end
+end

data/spec/slack-ruby-bot/rspec/respond_with_error_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 describe RSpec do
   let! :command do
     Class.new(SlackRubyBot::Commands::Base) do

data/spec/slack-ruby-bot/server_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 describe SlackRubyBot::Server do
   let(:logger) { subject.send :logger }
   let(:client) { Slack::RealTime::Client.new }

data/spec/slack-ruby-bot/support/commands_helper_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 describe SlackRubyBot::CommandsHelper do
   let(:bot_class) { Testing::WeatherBot }
   let(:command_class) { Testing::HelloCommand }

data/spec/slack-ruby-bot/support/loggable_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 describe SlackRubyBot::Loggable do
   let! :class_with_logger do
     Class.new(SlackRubyBot::Commands::Base) do

data/spec/slack-ruby-bot/version_spec.rb

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 describe SlackRubyBot do
   it 'has a version' do
     expect(SlackRubyBot::VERSION).to_not be nil

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack-ruby-bot
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.10.2
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-12 00:00:00.000000000 Z
+date: 2017-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -144,6 +144,9 @@ files:
 - Rakefile
 - TUTORIAL.md
 - UPGRADING.md
+- examples/inventory/Gemfile
+- examples/inventory/Procfile
+- examples/inventory/inventorybot.rb
 - examples/market/Gemfile
 - examples/market/Procfile
 - examples/market/marketbot.rb
@@ -175,6 +178,11 @@ files:
 - lib/slack-ruby-bot/hooks/hook_support.rb
 - lib/slack-ruby-bot/hooks/message.rb
 - lib/slack-ruby-bot/hooks/set.rb
+- lib/slack-ruby-bot/mvc.rb
+- lib/slack-ruby-bot/mvc/controller/base.rb
+- lib/slack-ruby-bot/mvc/model/base.rb
+- lib/slack-ruby-bot/mvc/mvc.rb
+- lib/slack-ruby-bot/mvc/view/base.rb
 - lib/slack-ruby-bot/rspec.rb
 - lib/slack-ruby-bot/rspec/support/bots_for_tests.rb
 - lib/slack-ruby-bot/rspec/support/fixtures/slack/migration_in_progress.yml
@@ -231,6 +239,7 @@ files:
 - spec/slack-ruby-bot/hooks/hook_support_spec.rb
 - spec/slack-ruby-bot/hooks/message_spec.rb
 - spec/slack-ruby-bot/hooks/set_spec.rb
+- spec/slack-ruby-bot/mvc/controller/controller_to_command_spec.rb
 - spec/slack-ruby-bot/rspec/respond_with_error_spec.rb
 - spec/slack-ruby-bot/server_spec.rb
 - spec/slack-ruby-bot/support/commands_helper_spec.rb
@@ -257,7 +266,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: The easiest way to write a Slack bot in Ruby.
@@ -295,6 +304,7 @@ test_files:
 - spec/slack-ruby-bot/hooks/hook_support_spec.rb
 - spec/slack-ruby-bot/hooks/message_spec.rb
 - spec/slack-ruby-bot/hooks/set_spec.rb
+- spec/slack-ruby-bot/mvc/controller/controller_to_command_spec.rb
 - spec/slack-ruby-bot/rspec/respond_with_error_spec.rb
 - spec/slack-ruby-bot/server_spec.rb
 - spec/slack-ruby-bot/support/commands_helper_spec.rb