PureBuilder Simplyの設計と構造

開発::util

TOP
Articles
開発
PureBuilder Simplyの設計と構造

序

完成度が上がってきて評判も上々のPureBuilder Simply。

バージョン1.8以降、立て続けのupdateで新しい姿を見せているが、このソフトウェアが長く続くことは確定的なので、そろそろ解説していこうと思う。

なお、ソフトウェアの概要と使い方に関しては過去の記事で紹介しており、動画を含む解説も別にある。

前提

私の昔のブログを読んでいた人しか知らないと思うが(つまりは誰も知らないと思うが)、私はACCSとは別にCMSのFRECS(FRECS’s Relation Enhancement Content System)を作っていた。

FRECSは極限まで単純なものである。PHPで書かれていたが、今改めてRubyで書くと、概念的には次のようになる。(もちろん、様々な考慮は省いている)

require 'cgi'
require 'erb'
require 'yaml'

cgi = CGI.new
template = ERB.new File.read "/srv/http/template.erb"

content = File.read "/srv/http/content/#{cgi}"
param = YAML.load File.read "/srv/http/content/#{cgi}_meta"

puts "Content-Type: text/html; charset=UTF-8"
puts
template.run(binding)

つまり、

コンテンツを読んで
付加情報を変数にセットして
テンプレートを解釈する

だけである。

そんなものがCMSと呼べるのか、と思うかもしれないが、実際これでCMSとしての本質的な機能は実現できる。 FRECSはCMSとしての機能が事前生成戦略によって成立することを確認するために作ったものであり、これはサイト構築を行うソフトウェアの基幹があると考えるようになった。

legacy

初代のPureBuilderは簡単に言えば次のように動作する。

#!/bin/zsh

. .purebuilder.rc

for i in ./**/*.pdoc
do
  puredoc $i > ${i/.\//$outdir/}
done

これに拡張したり割り込んだりするためのフィルタスクリプトを通す機能があったりするようなものであり、PureBuilderはこういう非常に単純なソフトウェアである。

PureBuilderはACCS4と組み合わせて使用することを想定していた。 ACCS4はPureDoc向けであり、PureDocのメタデータを動的に書き換える、いわゆるリフレクションスクリプトだ。だから

$ accs4.rb
$ purebuilder.zsh

とすればサイトが出来上がる、みたいな感じだった。

PureBuilder ngに関しては、こうした機能がひとつにまとめられている。 PureDocのコンバーターは当然ながら以前として別のソフトウェアだが、コマンドとしてPureDocを呼び出すのではなく、ライブラリとして使用するようになったし、さらにPureBuilder ng自体にKramdownを使ったMarkdownコンバーターが追加された。

だが、PureBuilder ngも方針としては、「やりたいことがあるならAPIを使ってね」という感じだった。「プラグイン」と呼んではいたが、PureBuilderが短いシェルスクリプトを書くことを前提にしていたのに対し、PureBuilder ngではRubyで書くことを前提としており、「サイト構築スクリプトを書くためのフレームワーク」みたいな感じだった。

だから、どちらかというとJykillみたいなソフトウェアというよりは、Railsの静的ビルド版みたいな感じのほうが近いかもしれない。特にPureBuilder ngは書くべきことが増えたのでそんな感じだった。

根幹

何度も言うように、PureBuilder SimplyはPandocを使っている。

Pandocはソースドキュメントを他形式のドキュメントに変換するソフトウェアだが、テンプレートエンジンを持っており、テンプレート変数はドキュメント内に含めるとこができる。

PureBuilderではPureDocがその役割を担っていたが、Pandocは同等にそれを担うことができるのである。ただし、PureDocはeRubyテンプレートなのでフルプログラマブルだが、Pandocはもっと単純なテンプレートエンジンであるという違いがある。

いずれにせよ、Pandocを前提にするとPureBuilderの考え方としては単純に再帰的に処理するくらいしかなくなってしまう。一方、Pandocを使う関係上、処理を差し挟む余地がなくなる。考えられるのは

ソースドキュメントを編集する
Pandocの引数をいじる
出力したドキュメントを編集する

の3つだけである。

PureBuilder Simplyはこの3つともを実現した。

Pandocの引数に関しては設定ファイルによってオプションを追加することができるし、出力したドキュメントはpost pluginsという仕組みによってフィルタを通される。 PureBuilder Simply 1.2でソースドキュメントを編集するpre pluginsにも対応した。

だが、これだと他の記事のメタデータを参照するようなことができない。それをスマートに実現するには、ずっと課題であった。

PureBuilder Simplyはこれを実現するために、「処理したドキュメントのメタデータをデータベースとして保存する」という方法をとった。 Ruby Marshal形式なのでRubyでしか扱えないが、post pluginsが呼ばれるのは全てのドキュメントの処理を終えた後なので、同ディレクトリ内の全てのドキュメントのメタデータにアクセスできる。

これが可能になっただけで自由度は飛躍的に向上した。力技ではあるが、たいていのことはできるようになったし、現時点でもMimir Yokohamaはその方法をとっている。

Chienomi

PureBuilder Simplyの設計と構造

開発::util

序

前提

legacy

根幹

最新版の概要