Merge pull request #115 from dblock/view-paths

Added Config#view_paths to be used in Rack middleware.

Author: dblock

.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2020-04-20 08:35:29 -0400 using RuboCop version 0.81.0.
+# on 2020-04-26 17:46:16 -0400 using RuboCop version 0.81.0.
 # 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

CHANGELOG.md

@@ -6,8 +6,9 @@
 * [#113](https://github.com/slack-ruby/slack-ruby-bot-server/pull/113): Added support for intervals with `.every` - [@dblock](https://github.com/dblock).
 * [#112](https://github.com/slack-ruby/slack-ruby-bot-server/pull/112): Added support for multiple `.on` events as an argument - [@dblock](https://github.com/dblock).
 * [#111](https://github.com/slack-ruby/slack-ruby-bot-server/pull/111): Removed dependency on Virtus - [@dblock](https://github.com/dblock).
-* [#110](https://github.com/slack-ruby/slack-ruby-bot-server/pull/110): Fix ActiveRecord sample app - [@CeeBeeUK](https://github.com/CeeBeeUK).
-* [#114](https://github.com/slack-ruby/slack-ruby-bot-server/pull/114): Use `require_relative` to prevent local collisions - [@dblock](https://github.com/dblock).
+* [#110](https://github.com/slack-ruby/slack-ruby-bot-server/pull/110): Fixed ActiveRecord sample app - [@CeeBeeUK](https://github.com/CeeBeeUK).
+* [#114](https://github.com/slack-ruby/slack-ruby-bot-server/pull/114): Used `require_relative` to prevent local collisions - [@dblock](https://github.com/dblock).
+* [#115](https://github.com/slack-ruby/slack-ruby-bot-server/pull/115): Added `Config#view_paths` to be used by Rack middleware - [@dblock](https://github.com/dblock).
 
 #### 0.11.1 (2019/5/17)
 

README.md

@@ -266,7 +266,15 @@ SlackRubyBotServer::Service.instance.url # https://www.example.com
 
 ### HTML Templates
 
-This library provides a [default HTML template and JS scripts](public) that implement the "Add to Slack" button workflow. Customize your pages by adding a `public` directory in your application and starting with a [index.html.erb](public/index.html.erb) template. The `views` and `public` folders are [loaded by default](lib/slack-ruby-bot-server/api/middleware.rb#L32).
+This library provides a [default HTML template and JS scripts](public) that implement the "Add to Slack" button workflow. Customize your pages by adding a `public` directory in your application and starting with a [index.html.erb](public/index.html.erb) template. The application's `views` and `public` folders are [loaded by default](lib/slack-ruby-bot-server/api/middleware.rb#L32).
+
+You can add to or override template paths as follows.
+
+`ruby
+SlackRubyBotServer.configure do |config|
+  config.view_paths << File.expand_path(File.join(__dir__, 'public'))
+end
+```
 
 ### Access Tokens
 

lib/slack-ruby-bot-server/api/middleware.rb

@@ -30,11 +30,7 @@ def self.instance
           end
 
           use Rack::ServerPages do |config|
-            config.view_path = [
-              'views', # relative to Dir.pwd
-              'public', # relative to Dir.pwd
-              File.expand_path(File.join(__dir__, '../../../public')) # built-in fallback
-            ]
+            config.view_path = SlackRubyBotServer::Config.view_paths
           end
 
           run Middleware.new

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

@@ -5,10 +5,18 @@ module Config
     attr_accessor :server_class
     attr_accessor :service_class
     attr_accessor :database_adapter
+    attr_accessor :view_paths
 
     def reset!
       self.server_class = SlackRubyBotServer::Server
       self.service_class = SlackRubyBotServer::Service
+
+      self.view_paths = [
+        'views',
+        'public',
+        File.expand_path(File.join(__dir__, '../../public'))
+      ]
+
       self.database_adapter = if defined?(::Mongoid)
                                 :mongoid
                               elsif defined?(::ActiveRecord)

public/index.html.erb

@@ -3,6 +3,7 @@
   <title>Slack Ruby Bot Server</title>
   <script src="/scripts/jquery-1.7.1.min.js"></script>
   <script src="/scripts/url.min.js"></script>
+  <script src="/scripts/messages.js"></script>
   <script src="/scripts/register.js"></script>
   <script src="/scripts/stats.js"></script>
 </head>

public/scripts/messages.js

@@ -0,0 +1,33 @@
+var SlackRubyBotServer = {};
+
+$(document).ready(function() {
+
+  SlackRubyBotServer.message = function(text) {
+    $('#messages').fadeOut('slow', function() {
+      $('#messages').fadeIn('slow').html(text)
+    });
+  };
+
+  SlackRubyBotServer.error = function(xhr) {
+    try {
+      var message;
+      if (xhr.responseText) {
+        var rc = JSON.parse(xhr.responseText);
+        if (rc && rc.message) {
+          message = rc.message;
+          if (message == 'invalid_code') {
+            message = 'The code returned from the OAuth workflow was invalid.'
+          } else if (message == 'code_already_used') {
+            message = 'The code returned from the OAuth workflow has already been used.'
+          }
+        }
+      }
+
+      SlackRubyBotServer.message(message || xhr.statusText || xhr.responseText || 'Unexpected Error');
+
+    } catch(err) {
+      SlackRubyBotServer.message(err.message);
+    }
+  };
+
+});

public/scripts/register.js

@@ -1,35 +1,4 @@
-var SlackRubyBotServer = {};
-
 $(document).ready(function() {
-
-  SlackRubyBotServer.message = function(text) {
-    $('#messages').fadeOut('slow', function() {
-      $('#messages').fadeIn('slow').html(text)
-    });
-  };
-
-  SlackRubyBotServer.error = function(xhr) {
-    try {
-      var message;
-      if (xhr.responseText) {
-        var rc = JSON.parse(xhr.responseText);
-        if (rc && rc.message) {
-          message = rc.message;
-          if (message == 'invalid_code') {
-            message = 'The code returned from the OAuth workflow was invalid.'
-          } else if (message == 'code_already_used') {
-            message = 'The code returned from the OAuth workflow has already been used.'
-          }
-        }
-      }
-
-      SlackRubyBotServer.message(message || xhr.statusText || xhr.responseText || 'Unexpected Error');
-
-    } catch(err) {
-      SlackRubyBotServer.message(err.message);
-    }
-  };
-
   // Slack OAuth
   var code = $.url('?code')
   var state = $.url('?state')

spec/api/middleware_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe SlackRubyBotServer::Api::Middleware do
+  def middleware_classes(app)
+    r = [app]
+
+    while (next_app = r.last.instance_variable_get(:@app))
+      r << next_app
+    end
+
+    r
+  end
+
+  context 'overriding view_paths' do
+    after do
+      SlackRubyBotServer.config.reset!
+    end
+    it 'uses custom view paths' do
+      SlackRubyBotServer.configure do |config|
+        config.view_paths << 'custom'
+      end
+      server_pages = middleware_classes(SlackRubyBotServer::Api::Middleware.instance)[-2]
+      expect(server_pages).to be_a Rack::ServerPages
+      config = server_pages.instance_variable_get(:@config)
+      expect(config[:view_path].count).to eq 4
+      expect(config[:view_path][-1]).to eq 'custom'
+    end
+  end
+end