Jekyll(Octopress)プラグインを作る際にmarkupの最後の空白に気をつける

Octopress用に使ってるプラグインの仕様で空白の取り扱いが結構罠にハマる所だったのでそれについて。

空白は除かれない

下のプラグインは

{% gemoji smile %}

と書くと絵文字を出力してくれるプラグインです。

中ではもともとinitialize関数の中で、第二引数として受け取るmarkupという値をそのまま絵文字を表す文字列として扱っていました。

def initialize(name, markup, tokens)
  @emoji = markup
end

ですが、これをもし、

{% gemoji smile %}

の様に空白を入れて書くとmarkupはsmile の様に最後の空白も含んでしまうので絵文字を検索しても見つけられません。

これを回避するために以下のようにstrip!で空白削除する部分を追加しました。

def initialize(name, markup, tokens)
  @emoji = markup
  @emoji.strip!
  end
end

他のプラグインの中でもこの仕様によって、最後に空白を入れると上手く動かない物もあるので注意が必要です。 (以前、Octopressの中のgistのプラグインについてもこれに似たような事があって pull request出して直してもらいました ¹)

空白に意味を持たせることも可能なのでこの様に最後の空白も含めて渡すようなのは間違ってないと思いますが、特に、1つのワードだけを使う様な単純なプラグイン程この問題に引っかかりやすいので注意が必要だと思います。