2017-03-03

path template engine の bouzuya/bath 2.0.1 をつくった

bouzuya/bath の 2.0.0 および 2.0.1 をつくった。

bath は path template engine 。 URL の pathname を組み立てるためのテンプレートエンジンだ。

path template engine という分類があるのかは知らない。ただ path をつくるためだけのテンプレートエンジンがあっても良いと思い、つくった。ちなみに「テンプレートエンジン」という言葉を、テンプレートとデータを与えると結果を返すもの、くらいの認識で使っている。

特徴としては次のとおりだ。

低機能
双方向の変換 (template -> path -> params / template -> params -> path)
必要分のみを import 可能
RFC 6570 level 1 に似たテンプレート構文

bath の利用イメージは次のようなもの。 README から抜粋した。

import assert from 'assert';
import bathFn from 'bath';

const { params, path } = bath('/users/{id}');

assert.deepEqual(params('/users/123'), { id: '123' });
assert.deepEqual(path({ id: '123' }), '/users/123');

import assert from 'assert';
import { params, path } from 'bath';

const template = '/users/{id}';
assert.deepEqual(params(template)('/users/123'), { id: '123' });
assert.deepEqual(path(template)({ id: '123' }), '/users/123');

import assert from 'assert';
import { params } from 'bath/params'; // import `params()` only
import { path } from 'bath/path';     // import `path()` only

const template = '/users/{id}';
assert.deepEqual(params(template)('/users/123'), { id: '123' });
assert.deepEqual(path(template)({ id: '123' }), '/users/123');

いわゆる router の実装に使える……といいな。

競合は pillarjs/path-to-regexp 。あちらは express の router に使われているし、勝負にはならない。違いとして、こちらは RegExp という実装を露出させないようにしている。また低機能なだけ使いかたを理解しやすい……と良いのだけど……。

1.x は path-to-regexp の wrapper だったが、2.x は独自の構文を持つことにした。 RFC 6570 の level 1 に似たものを選んだ。

2017-03-02

JavaScript の Error は適切に使われているだろうか

だらだらしていたら遅くなった。

bouzuya/bath の path 側をつくっていた。だいたいできた。ここからが長いんだけど……。

不正な入力に対して Error を投げるべきか迷う。型検査もないので、かなり変な値を受け取る可能性があるのだけど、それらを毎回検査するのはあまり良い習慣でもなさそうだ。またそれらの違反を Error で表現するより、多少のことなら | null を返してごまかすほうが JavaScript 界隈の空気にあっているんじゃないかとか思ってしまう。

2017-03-01

bouzuya/bath 2.x をつくっている

今日は bouzuya/bath の 2.x をつくっていた。

path-to-regexp の機能から不要なものを削って自前で実装する。実行イメージは次のような感じ。

import * as assert from 'assert';
import { params } from 'bath/params';

const p1 = params('/users/{id}');
assert.deepEqual(p1('/users/123'), { id: '123' });
assert.deepEqual(p2('/users/abc'), { id: 'abc' });

const p2 = params('/users/{id}', { id: /^\d+$/ });
assert.deepEqual(p2('/users/123'), { id: '123' });
assert.deepEqual(p2('/users/abc'), null);

2.x で考えている path-to-regexp との違いは次のとおりだ。

regexp を強調しない
path と template + params の相互変換への配慮
template + path -> params な params と template + params -> path な path を必要な側だけ import できる
template を RFC 6570 の level 1 に近づけている

同じで言うと、 router における path との match に使う点だろうか。ぼくのほうは逆に path を構築する用途にも使うつもりだけど。