Text::Xatena - はてな記法のような記法フォーマットパーサー

Text::Xatena の位置づけ

みなさんご存知かもしれませんが、既に CPAN には Text::Hatena というモジュールがあります。ではなぜ今また、似たようなフォーマットの別のモジュールを書く必要があったのでしょうか。これには以下のような理由があります。

• Text::Hatena は実のところあまり Hatena::Diary と互換がない
• Text::Hatena は非常に遅い
• Text::Hatena ははてなに依存した記法がいくつか存在する (id 記法など)

これらのことを解決するために、Text::Xatena は作られました。

Rate   Hatena  Textile Markdown   Xatena
Hatena   26.8/s       --     -84%     -86%     -89%
Textile   171/s     537%       --      -8%     -27%
Markdown  186/s     594%       9%       --     -20%
Xatena    233/s     770%      37%      25%       --

Text::Xatena の使いかた

簡易的には単に以下の通りに使えます。

my $thx = Text::Xatena->new;
$thx->format($string);

Inline フォーマットは独立しており、別に指定することができます。デフォルトの Inline フォーマッタは http://...:title というタイトルを自動的にとってくる記法に対応していませんが、以下のようにするとそれが有効になります (cache は実際には Cache::File などにすべきでしょう)。

my $thx = Text::Xatena->new;
$thx->format($string,
	inline => Text::Xatena::Inline::Aggressive->new(cache => Cache::MemoryCache->new)
);

さらに、いくつかデフォルトの挙動がはてな記法と異る部分については、hatena_compatible オプションを渡すと、はてなダイアリーの記法により近くなります。すなわち、改行1つで p が挿入されるようになり、見出し記法は構造化されず全部フラットになります。

my $thx = Text::Xatena->new(hatena_compatible => 1);;
$thx->format($string,
	inline => Text::Xatena::Inline::Aggressive->new(cache => Cache::MemoryCache->new)
);

ちなみに format メソッドが返す値は本文の部分のHTMLだけです。どういうことかというと、脚注記法 *1 の内容は含まれません。脚注記法の結果を取得して表示するには以下のようにします。

my $thx = Text::Xatena->new;
my $inline = Text::Xatena::Inline->new;
my $formatted = $thx->format('aaa((foobar)) bbb((barbaz))', inline => $inline);
my $out = '';
$out .= '<div class="body">';
$out .= $formatted;
$out .= '</div>';
$out .= '<div class="notes">';
for my $footnote (@{ $inline->footnotes }) {
 $out .= sprintf('<div class="footnote" id="#fn%d">*%d: %s</div>',
   $footnote->{number},
   $footnote->{number},
   $footnote->{note}, ### HTML を含む
 );
}
$out .= '</div>';

ちなみに脚注記法は若干実装が面倒で、まぁ以上に書いたように本文の要素とは別のものを扱うという点でも面倒ですが、俗にgkbr対応とか言われるのがあります。どういうことかというと以下の通りです。

(((；゜Д゜))))ガクブル を書けるようにするために

(((foobar))) は脚注にしない。((foobar)) は脚注。)((foobar))( は ((foobar)) となり、脚注にならない。

とかいうルールがあり、割と面倒です。

まとめ

Text::Hatena ははてな記法との互換性もいまいちですし、遅いのであまりオススメできませんが、Text::Xatena を使うとお手軽にはてな記法のような記法に対応できます。

ダイアリー完全互換な実装セットも作りたいなあとは思っていますが、自分が全く使わない記法は挙動をよく知らないので割と困ってます。「こういう記法に対応して欲しい!」ということがあれば、ご意見をいただければ実装するかもしれません。あるいはパッチを頂ければなんとかします。

ということで、Text::Xatena で快適なブロッギングライフを送りましょう! それでは!