Unindentable

With Unindentable, you can write heredocs without worry of wonky indentation.

Motivation

Heredocs are convenient. But the indentation can bite you. For example:

def hello
  html = "    <html>\n      <body>\n        <p>Hello</p>\n      </body>\n    </html>\n  BLOCK\nend\n"

The problem is that you get extra indentation you probably don't want:

irb> hello
=> "    <html>\n      <body>\n        <p>Hello</p>\n      </body>\n    </html>\n"

One solution is to move your heredoc to the left margin:

def hello
  html = "<html>\n  <body>\n    <p>Hello</p>\n  </body>\n</html>\n  BLOCK\nend\n"

So that you get the result you expect:

> hello
=> "<html>\n  <body>\n    <p>Hello</p>\n  </body>\n</html>\n"

But this doesn't look good in your source. With Unindentable, you can write:

include Unindentable
def hello
  html = unindent "    <html>\n      <body>\n        <p>Hello</p>\n      </body>\n    </html>\n  BLOCK\nend\n"

And get the nice unindented result you want:

> hello
=> "<html>\n  <body>\n    <p>Hello</p>\n  </body>\n</html>\n"

That's it.

Here are some examples from the Interwebs where people discuss potential solutions: