Marten Turbo

Marten Turbo provides helpers to interact with Turbo applications using the Marten Framework.

Installation

Simply add the following entry to your project's shard.yml:

dependencies:
  marten_turbo:
    github: treagod/marten-turbo

And run shards install afterward.

First, add the following requirement to your project's src/project.cr file:

require "marten_turbo"

Afterwards you can use the template helper dom_id and the turbo handlers.

Tags

Marten Turbo introduces a new template tag dom_id, which supports the creation of turbo frame ids for Marten models

{% for article in articles %}
  <div id="{% dom_id article %}"> <!-- Generates id artcle_1, artcle_2, etc. -->
    <!-- some content-->
  </div>
{% endfor %}

<form id="{% dom_id article %}" method="POST" action="/articles">
  <!-- Assuming the article instance is new an id of new_article is generated -->
  <!-- Otherwise the id will be for example article_1 -->
</form>

Identifier will respect your namespace of the model. I.e. if you have an Article model in the app blogging the generated id will be blogging_article_1.

Marten Turbo also provides a turbo stream tag helper

{% turbo_stream 'append' "articles" do %}
  <div class="{% dom_id article %}">
    {{ article.name }}
  </div>
{% end_turbo_stream %}

<!--
  <turbo-stream action="append" target="articles">
    <template>
      <div class="article_1">
        My First Article
      </div>
    </template>
  </turbo-stream>
-->

<!-- or in one line -->
{% turbo_stream 'append' "articles" template: "articles/article.html" %}
<!--
  <turbo-stream action="append" target="articles">
    <template>
      content of "articles/article.html"
    </template>
  </turbo-stream>
-->

<!-- dom_id is automatically applied if targeting a record -->
{% turbo_stream 'remove' article %}
<!--
  <turbo-stream action="remove" target="article_1">
  </turbo-stream>
-->

Handlers

Marten Turbo provides an extension to the generic Marten handlers:

Record Creation: To create a record, use

class ArticleCreateHandler < MartenTurbo::Handlers::RecordCreate
  model Article
  schema ArticleSchema
  template_name "articles/create.html"
  turbo_stream_name "articles/create.turbo_stream.html"
  success_route_name "articles"
end

Notice how we use MartenTurbo::Handlers::RecordCreate instead of Marten::Handlers::RecordCreate. Also the #turbo_stream_name class method gives you the option to define a turbo stream template which is rendered instead of the normal template if a turbo request is made.

Record Update: To update a record, use

class ArticleUpdateHandler < MartenTurbo::Handlers::RecordUpdate
  model Article
  schema ArticleSchema
  template_name "articles/update.html"
  turbo_stream_name "articles/update.turbo_stream.html"
  success_route_name "articles"
end

Record Deletion: It's also possible to define a turbo_stream method

class ArticleDeleteHandler < MartenTurbo::Handlers::RecordDelete
  model Article
  template_name "articles/delete.html"
  success_route_name "articles"

  def turbo_stream
    MartenTurbo::TurboStream.remove(record)
  end
end