object-formatterというライブラリをつくったはなし

1. object-formatter
@airtoxin

2. object-formatter
オブジェクトの整形がスキーマに基づいて行えるラ
イブラリ。
この中のこれのここの値を取ってきてこっちのあそ
このオブジェクトの値として保持して…みたいなの
をネストしたオブジェクトとかに対してもundefined
accessを気にせず簡単に出来るようにしたかった。
バベルしたかった。

3. インストール
npm i --save object-formatter

4. 使い方
var ObjectFormat = require('object-formatter');
var of = new ObjectFormat();
of.format(schema, object);

5. スキーマ定義
変換後のオブジェクトの形式を指定す
る。
keyはそのまま変換後のオブジェクトの
フィールドキーとなる。
valueは変換後の値をaccessorで定義。

6. var schema = {
raw: 'raw value',
foo: '@a',
bar: '@b.c.d="ipsum"',
baz: {
raw: 111,
a: '@c.cb',
b: '@c.c.c',
c: [ '@d', {
hoge: '@aa',
fuga: '@bb="b default"'
} ],
d: [ '@d', '@cc="c default"' ]
}
};

7. accessor
そのフィールドに入るべき値を指定する為の
文字列/配列
Simple accessorとCollection accessorの2種
類が存在。Simple accessorは単純なパス指
定をしているだけ。Collection accessorはコ
レクションに対して簡易map処理を行う。

8. raw value
accessor以外の値がvalueに存在した
場合、その値は処理されずにそのまま
変換後のオブジェクトに代入される。

9. var object = {
a: 1
};
var schema = {
hoge: 'a',
fuga: 100
};
of.format(schema, object);
// ->
// {
// hoge: 'a',
// fuga: 100
// }

10. Simple accessor
@から始まる文字列はSimple accessor
として認識され、@以降の文字列が
valueに入るべき値へのパスを示して
いる。

11. var object = {
a: 1,
b: { c: 111 }
};
var schema = {
hoge: '@a',
fuga: '@b.c'
};
of.format(schema, object);
// ->
// {
// hoge: 1,
// fuga: 111
// }

12. Default
accessorが示すパスの値が存在しなかった
場合のデフォ値を指定することができる。
accessorのパス指定の後に=を続け、その
後デフォ値としたい物を指定する。
内部的にevalしているので何とかしたい。

13. var object = {};
var schema = {
hoge: '@a=1',
fuga: '@a.b.c="not found"'
};
of.format(schema, object);
// ->
// {
// hoge: 1,
// fuga: 'not found'
// }

14. Collection accessor
変換前のオブジェクトがコレクションを持っ
ている時に、その中の値を処理したい場合に
使用する。簡易map処理。
配列の0番目にコレクションまでのパス、1番
目にスキーマを書くと、コレクション内全て
のオブジェクトに対してそのスキーマでフォー
マットしたオブジェクトの配列が得られる。

15. var object = {
c: [{a:1}, {a:2}, {b:3}]
};
var schema = {
hoge: ['@c', {fuga: '@a'}]
};
of.format(schema, object);
// ->
// {
// hoge: [
// { fuga: 1 },
// { fuga: 2 },
// { fuga: undefined }
// ]
// }

16. 使用感
自前のBandit APIで、APIの返却するJSONの型
を保証したかった。
型の保証だけだとJSON Schemaはでか過ぎて
大分つらい→簡単に指定出来るようになった。
オブジェクトのインターフェース保証が安全に
行える所がだいぶ気に入っている。

17. DSL
ドメイン固有言語。特定の操作に特化した言語。特化した
操作は行い易いが、DSL自体の学習コストがかかったり、
DSLでの操作を見てもやっていることが自明でなくなる。
あまり好きではなかったが、今回object-formatterのス
キーマ定義はDSLになっている。
→他のスキーマ定義言語があまりいい感じに使えなかった
ので用意した。もっといい感じのが有るならそれに乗っか
りたい。

18. DL数

19. みんなつかってくれ！

20. おわり