Use double splat

[shimoju]

POST /api/card/:card-id/query/:export-formatを実装しようとしていて、

• :card-idはいいけど:export-formatを普通の引数で渡すと、client.query_card(1, :csv)のようになってわかりにくい
• client.query_card(1, format: :csv)のようにキーワード引数を使いたい
• しかし、引数のハッシュの{}を省略できる仕様は最後の引数にしか使えない
• 通常引数→キーワード引数の順序で定義する必要があるので、キーワード引数を使う場合このテクニックが使えず不便
• URLパスに含むパラメータと、オプションのquery string/リクエストボディは明確に区別したい
  • paramsで全部受け取ってパスに必要なものを切り出し、残りをリクエストボディに、みたいな操作をすると複雑になっていく
  • 必須な値を表現できない
• どうしようかと思っていたところ、可変長キーワード引数(double splat, **args)を使えばいいことに気がついた

というわけで既存のparams = {}になっているところを可変長キーワード引数**paramsに置き換えます。 引数がうまく渡せているかの確認のため、#loginにテストを追加しました。 ハッシュを組み立ててそれを渡したいときは不便かもと思ったら、可変長キーワード引数にハッシュをそのまま渡せるんだなー便利

さらに考えると、GET /api/card/:idはclient.card(1)でもidを表すことはわかるけど、 GET /api/embed/card/:tokenは、client.embed_card('hoge')じゃなくてclient.embed_card(token: 'hoge')にしたいよなあとなる。 GET /api/embed/dashboard/:token/dashcard/:dashcard-id/card/:card-idはもうだいぶわからない。 全部キーワード引数にしてしまう方がわかりやすくなるし統一感も出るなと。 client.card(id: 1)やclient.query_card(id: 1, format: :csv)でも結構いい感じはする。

いまのところは「パスのパラメータで、かつリソースのidを表す引数は通常引数、それ以外はキーワード引数」というような規約でいってみて、無理ぽってなったら全部キーワード引数にしてみようかなと思う。