Can I override app/views/layouts/application.html.erb from a plugin?

Dev
1

I have a very specific scenario where I need to load and cache the site header and footer from our primary website. This is fairly trivial to do in ERB:

<!-- My Customization -->
  <% cache("footer_#{I18n.locale}", expires_in: 1.week) do %>
    <%= raw open("https://myserver.com/#{I18n.locale}/remote/footer").read %>
  <% end %>
<!-- End Customization -->

Note in my example that I am passing along the I18n locale as well.

Neither the caching nor passing the locale will work with the html custom header option provided with Discourse so I’m left with two options, both of which would need to be implemented as a plugin.

OPTION 1: Use Javascript

There are outlets placed where my header and footer would go, but I don’t know how to cache the requests and I can see this quickly becoming taxing on both the server and the Ember app if server-side caching is not used.

OPTION 2: Override the application.html.erb template

First off: I am very aware that I would have to keep my custom plugin in lock-step with any changes to Discourse to ensure that my override doesn’t interfere with upgrades.

This would be my preference but I can’t seem to find any convention that will let me override the ERB templates from a plugin.

Has anyone tried this? Am I on a fools errand?

Thanks in advance for your help.

2

Yes, you can override the set_layout method in application_controller.rb. Take a look at this (unfinished) plugin for an example:

https://github.com/scossar/feature-phone-first

3

This does EXACTLY what I needed. THANKS @simon!

4

Desculpe reviver este tópico muito antigo, espero que esteja tudo bem.

Podemos sobrescrever (em um plugin)?

app/views/layouts/application.html.erb

Assim:

register_asset '../views/layouts/application.html.erb'

Suspeito que a resposta seja “NÃO!”… Se for “não” (porque ‘assets’ não são ‘views’ no Rails), podemos ter um método de plugin futuro:

register_view

Para que possamos simplesmente fazer isso no futuro (por exemplo):

register_asset 'layouts/application.html.erb'

e sobrescrever 'layouts/application.html.erb'

Parece-me uma boa ideia, não sendo de forma alguma um especialista em plugins do Discourse.

Obrigado pela sua consideração.

5

Faça isso em um tema, em vez disso. Você pode adicionar uma camada de cache padrão na frente de qualquer API de onde as informações são buscadas.

6

Podemos usar código Ruby embutido em um tema?

Devo estar confuso… achando que o trabalho com temas não era o local para Ruby embutido.

Edição:

Acabei de revisar o tópico a seguir e, como suspeitava, não há nenhuma referência que eu possa encontrar sobre adicionar Ruby embutido em um tema :slight_smile:

Developing Discourse Themes & Theme Components

7

Relendo…

Eu havia esquecido da cláusula cache e estava assumindo que isso acessaria o servidor para cada solicitação, então achei que uma busca do lado do cliente também funcionaria.

Em vez disso, algo que poderia funcionar é fazer com que o servidor remoto envie o conteúdo para a seção de Rodapé do HTML de um Componente de Tema.