JSONAPI-Resources / JSONAPI-Resources/jsonapi-resources

Meta key_format setting

オープン
#825 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
Ruby
スター
2.3k
フォーク
546
PR マージ指標
30日以内にマージされた PR はありません

説明

Right now (in 0.8.0-beta2) we can use the configuration option of json_key_format to change the style of the attribute key names (dasherized, camelized, etc) but there is no way to do so for meta data!

I am suggesting we add a similar configuration option for formatting the key names of meta data. Something along the lines of json_meta_key_format.


Here is an example:

# using: config.json_key_format = :camelized_key

class UserResource < JSONAPI::Resource
  attributes :first_name, :last_name

  def meta(_options = {})
    {
      formal_name: "#{@model.last_name}, #{@model.first_name}"
    }
  end
end

Will return something like this currently:

"data": {
  "attributes": {
    "firstName": "foo",
    "lastName": "bar"
  },
  "meta": {
    "formal_name": "bar, foo"
  },
  ...
}

What I propose is a json_meta_key_format configuration, which, for example sake would return with the following when using config.json_meta_key_format = :camelized_key:

"data": {
  "attributes": {
    "firstName": "foo",
    "lastName": "bar"
  },
  "meta": {
    "formalName": "bar, foo"
  },
  ...
}

(Notice formalName instead of formal_name)

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

既存の json_key_format 設定と issue に示されているリソースメタメソッドから始め、次にメタデータキーがシリアライズされる箇所を追跡します。formal_name を formalName にできるよう、提案されている json_meta_key_format の動作を追加し、生成された JSON が例と一致することを確認します。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
ruby
領域
api
issue の種類
機能追加
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
42/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。