Rendering HAML partials from within HAML outside of Rails

hamlruby

I'm using HAML to generate some static html pages for a site, and I was wanting to split out common components into partials that I can include in multiple pages, just like in Rails. However I don't want to use the whole Rails stack to do this as it seems like overkill.

I've looked around on the Internet but haven't found anything, better than just doing something like:

Haml::Engine.new(IO.read("header.haml")).render

Is there a nicer way of including so-called partials from within HAML? An existing filter or command that I'm missing?

Best Answer

It's best to combine haml & sass with a tool for building static websites. Here's some links:

StaticMatic
Serve
Haml Jekyll -- a fork of Jekyll that supports haml.
Middleman

I'm using jekyll for my blog, but if you're not building a blog it's probably not appropriate for your needs.

If you need the task to behave as a method, how about using an actual method?

task :build => [:some_other_tasks] do
  build
end

task :build_all do
  [:debug, :release].each { |t| build t }
end

def build(type = :debug)
  # ...
end

If you'd rather stick to `rake`'s idioms, here are your possibilities, compiled from past answers:

This always executes the task, but it doesn't execute its dependencies:
```
Rake::Task["build"].execute
```
This one executes the dependencies, but it only executes the task if it has not already been invoked:
```
Rake::Task["build"].invoke
```
This first resets the task's already_invoked state, allowing the task to then be executed again, dependencies and all:
```
Rake::Task["build"].reenable
Rake::Task["build"].invoke
```
Note that dependencies already invoked are not automatically re-executed unless they are re-enabled. In Rake >= 10.3.2, you can use the following to re-enable those as well:
```
Rake::Task["build"].all_prerequisite_tasks.each(&:reenable)
```

Javascript – Ruby methods within Javascript within HAML

Usually, if something is a pain in haml, it means you should refactor the the tricky bit to a helper or partial and call that.

// some_helper.rb
def new_snazzy_select_tag(options = [])
  select_tag 'tag_name_here', options.map { |option| [option.id, option.name] }
end

Also, you should use the :javascript filter to render javascript since it will put it in a script tag for you and allow indentation.

Lastly, you can use #{ruby_expression} anywhere in haml, including :javascript filters, which is very handy when you need to output the result of ruby expressions to places that are not directly contents of html elements.

// some_view.html.haml
:javascript
  $('#mylink').click(function() {  
    $('#mylink').after("#{escape_javascript new_snazzy_select_tag(myarray)}");
  };

Best Answer

Related Solutions

Ruby – How to run Rake tasks from within Rake tasks

If you need the task to behave as a method, how about using an actual method?

If you'd rather stick to rake's idioms, here are your possibilities, compiled from past answers:

Javascript – Ruby methods within Javascript within HAML

Related Topic

If you'd rather stick to `rake`'s idioms, here are your possibilities, compiled from past answers: