Skip to content

bartiaco/poirot

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Poirot

Description

Allows you to use Mustache template partials in Rails, also ads a helper method to easily allow JavaScript to re-use the same templates.

Usage

Create a partial just like you would with erb, prefixing the name with an underscore.

app/views/posts/_post_list.html.mustache

The template will have access to all normal rails helper methods and any instance variables that were set in the controller. If you need more than this an optional view class can be included, it should have the same name as the partial, but without the underscore.

app/views/posts/post_list_view.rb

module Posts
  class PostListView < Poirot::View
    def foo
      "bar"
    end

    def post_link
      post_path(post)
    end
  end
end

The view class has access to all the normal Rails helpers and access to the controller instance variables, e.g @post becomes the method post.

Also included is a simple view helper for including mustache templates in a page ready for use by JavaScript.

<%= template_include_tag 'post_list' %>

The above will insert a script tag with the contents of the partial called post_list, the type will be set as text/mustache and the id will be post-list-template.

<script id="post-list-template" type="text/mustache">
  <!-- template will be here! -->
</script>

Dependencies

  • Rails >3.0.0
  • Mustache

More

An example app using Poirot

Credits

Mark Evans & Oliver Nightingale

About

mustaches in your rails

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Ruby 100.0%