Dummy Space model. Set current space based on subdomain

Author: fbacall

README.md

@@ -57,3 +57,7 @@ See [here](docs/customization.md) for an overview of how you can customize your
 ## API
 
 See [here](docs/api.md) for details on programmatic access to TeSS via its API.
+
+## Multi-space TeSS
+
+See [here](docs/mtessx.md) for details on configuring multi-space TeSS.

app/controllers/application_controller.rb

@@ -19,6 +19,7 @@ class ApplicationController < ActionController::Base
   # User auth should be required in the web interface as well; it's here rather than in routes so that it
   # doesn't override the token auth, above.
   before_action :authenticate_user!, except: [:index, :show, :embed, :calendar, :check_exists, :handle_error, :count, :redirect]
+  before_action :set_space
   before_action :set_current_user
 
   # Should prevent forgery errors for JSON posts.
@@ -106,6 +107,16 @@ def user_not_authorized(exception)
     handle_error(:forbidden, t("#{policy_name}.#{exception.query}", scope: 'pundit', default: :default))
   end
 
+  def set_space
+    @current_space = Space.find(request.subdomain) if request.subdomain
+  end
+
+  def current_space
+    @current_space
+  end
+
+  helper_method :current_space
+
   def set_current_user
     User.current_user = current_user
     if TeSS::Config.sentry_enabled?

app/models/space.rb

@@ -0,0 +1,12 @@
+class Space
+  include ActiveModel::Model
+
+  attr_accessor :id, :name, :logo
+
+  def self.find(id)
+    return nil if id.nil?
+    if TeSS::Config.spaces&.key?(id)
+      self.new(TeSS::Config.spaces[id].merge(id: id))
+    end
+  end
+end

app/views/layouts/_header.html.erb

@@ -20,10 +20,20 @@
           <span class="icon-bar"></span>
           <span class="icon-bar"></span>
         </button>
-        <% if defined? TeSS::Config.site['logo'] and !TeSS::Config.site['logo'].blank? %>
+        <% if current_space %>
           <a class="navbar-brand" href="/">
-            <%= image_tag(TeSS::Config.site['logo'], alt: TeSS::Config.site['logo_alt']) %>
+            <% if current_space.logo %>
+              <%= image_tag(current_space.logo, alt: current_space.name) %>
+            <% else %>
+              <%= current_space.name %>
+            <% end %>
           </a>
+        <% else %>
+          <% if defined? TeSS::Config.site['logo'] and !TeSS::Config.site['logo'].blank? %>
+            <a class="navbar-brand" href="/">
+              <%= image_tag(TeSS::Config.site['logo'], alt: TeSS::Config.site['logo_alt']) %>
+            </a>
+          <% end %>
         <% end %>
       </div>
 

config/initializers/hosts.rb

@@ -0,0 +1 @@
+Rails.application.config.hosts << /.*\.mytess\.training(\:\d+)?/

docs/mtessx.md

@@ -0,0 +1,35 @@
+# Development
+
+## Simulating subdomains
+
+A multi-space enabled TeSS will set the current space based on the subdomain of the incoming request.
+
+To allow your local development server to respond to requests with a subdomain, 
+edit your hosts file (`/etc/hosts` on Linux) to include something like the following, e.g.:
+
+```
+127.0.0.1	plants.mytess.training
+127.0.0.1	astro.mytess.training
+127.0.0.1	whatever.mytess.training
+```
+
+This will ensure that if you visit e.g. plants.mytess.training, your browser will route it to your local development server
+(you may need to restart your browser after changing the hosts file).
+
+Edit `config/hosts.rb` to ensure your Rails application accepts requests to the hosts provided above.
+
+## Configuring spaces
+
+Edit `tess.yml` to define spaces, e.g.:
+
+```
+  spaces:
+    plants:
+      name: TeSS Plants Community
+    astro:
+      name: TeSS Space Community
+    whatever:
+      name: The Whatever Space
+```
+
+(Your server will need to be restarted after changing this file)

test/config/test_tess.yml

@@ -99,6 +99,13 @@ default: &default
     enabled: false
     stale_threshold: 0.3
     rejected_threshold: 0.3
+  spaces:
+    plants:
+      name: TeSS Plants Community
+    astro:
+      name: TeSS Space Community
+    other:
+      name: Other TeSS Community
 development:
   <<: *default
 

test/controllers/static_controller_test.rb

@@ -327,4 +327,16 @@ class StaticControllerTest < ActionController::TestCase
       end
     end
   end
+
+  test 'sets current space based on subdomain' do
+    old_host = @request.host
+    get :home
+    assert_nil assigns(:current_space)
+
+    @request.host = 'plants.mytess.training'
+    get :home
+    assert 'plants', assigns(:current_space).id
+  ensure
+    @request.host = old_host
+  end
 end