ruby-on-rails - Ruby on Rails で JSON 出力を「きれいに」フォーマットする方法

Question

Ruby on Rails での JSON 出力を「きれいに」または適切にフォーマットしたいと考えています。

今、私は電話をかけto_json、JSON はすべて 1 行にまとめられています。JSON 出力ストリームに問題があるかどうかを確認するのが難しい場合があります。

RailsでJSONを「きれいに」または適切にフォーマットするように構成する方法はありますか?

Answer 1

pretty_generate()以降のバージョンの JSON に組み込まれている関数を使用します。例えば：

require 'json'
my_object = { :array => [1, 2, 3, { :sample => "hash"} ], :foo => "bar" }
puts JSON.pretty_generate(my_object)

それはあなたを得る：

{
  "array": [
    1,
    2,
    3,
    {
      "sample": "hash"
    }
  ],
  "foo": "bar"
}

Answer 2

<pre>で使用される HTMLのタグはJSON.pretty_generate、ビューで JSON をきれいにレンダリングします。私の著名な上司が私にこれを見せてくれたとき、私はとてもうれしかったです：

<% if @data.present? %>
   <pre><%= JSON.pretty_generate(@data) %></pre>
<% end %>

Answer 3

Rack Middleware と Rails 3 のおかげで、アプリのコントローラーを変更することなく、すべてのリクエストに対してきれいな JSON を出力できます。私はそのようなミドルウェアのスニペットを書いており、ブラウザーとcurl出力できれいに印刷された JSON を取得します。

class PrettyJsonResponse
  def initialize(app)
    @app = app
  end

  def call(env)
    status, headers, response = @app.call(env)
    if headers["Content-Type"] =~ /^application\/json/
      obj = JSON.parse(response.body)
      pretty_str = JSON.pretty_unparse(obj)
      response = [pretty_str]
      headers["Content-Length"] = pretty_str.bytesize.to_s
    end
    [status, headers, response]
  end
end

上記のコードはapp/middleware/pretty_json_response.rb、Rails プロジェクトに配置する必要があります。最後のステップは、ミドルウェアを に登録することですconfig/environments/development.rb。

config.middleware.use PrettyJsonResponse

での使用はお勧めしませんproduction.rb。JSON の再解析により、本番アプリの応答時間とスループットが低下する可能性があります。最終的には、「X-Pretty-Json: true」ヘッダーなどの追加のロジックが導入され、オンデマンドで手動の curl リクエストのフォーマットがトリガーされる可能性があります。

(Rails 3.2.8-5.0.0、Ruby 1.9.3-2.2.0、Linux でテスト済み)

Answer 4

あなたがしたい場合は：

1. アプリから送信されるすべての JSON 応答を自動的に整形します。
2. Object#to_json/#as_json の汚染を避ける
3. ミドルウェアを使用して JSON を解析/再レンダリングすることは避けてください (YUCK!)
4. RAILS WAY でやってみよう！

次に ... ActionController::Renderer を JSON に置き換えます! 次のコードを ApplicationController に追加するだけです。

ActionController::Renderers.add :json do |json, options|
  unless json.kind_of?(String)
    json = json.as_json(options) if json.respond_to?(:as_json)
    json = JSON.pretty_generate(json, options)
  end

  if options[:callback].present?
    self.content_type ||= Mime::JS
    "#{options[:callback]}(#{json})"
  else
    self.content_type ||= Mime::JSON
    json
  end
end

Answer 5

Awesome Printをご覧ください。JSON 文字列を解析して Ruby ハッシュにし、次のapように表示します。

require "awesome_print"
require "json"

json = '{"holy": ["nested", "json"], "batman!": {"a": 1, "b": 2}}'

ap(JSON.parse(json))

上記を使用すると、次のことがわかります。

{
  "holy" => [
    [0] "nested",
    [1] "json"
  ],
  "batman!" => {
    "a" => 1,
    "b" => 2
  }
}

Awesome Print は、Stack Overflow では表示されない色も追加します。

Answer 6

pretty_generateRuby の JSON ライブラリに組み込まれているオプションが「きれい」ではないことがわかった場合は、書式設定に独自のNeatJSON gem をお勧めします。

使用するには:

gem install neatjson

そして使用する

JSON.neat_generate

それ以外の

JSON.pretty_generate

Ruby のppように、オブジェクトと配列が収まるときは 1 行に保持されますが、必要に応じて複数行に折り返されます。例えば：

{
  "navigation.createroute.poi":[
    {"text":"Lay in a course to the Hilton","params":{"poi":"Hilton"}},
    {"text":"Take me to the airport","params":{"poi":"airport"}},
    {"text":"Let's go to IHOP","params":{"poi":"IHOP"}},
    {"text":"Show me how to get to The Med","params":{"poi":"The Med"}},
    {"text":"Create a route to Arby's","params":{"poi":"Arby's"}},
    {
      "text":"Go to the Hilton by the Airport",
      "params":{"poi":"Hilton","location":"Airport"}
    },
    {
      "text":"Take me to the Fry's in Fresno",
      "params":{"poi":"Fry's","location":"Fresno"}
    }
  ],
  "navigation.eta":[
    {"text":"When will we get there?"},
    {"text":"When will I arrive?"},
    {"text":"What time will I get to the destination?"},
    {"text":"What time will I reach the destination?"},
    {"text":"What time will it be when I arrive?"}
  ]
}

また、出力をさらにカスタマイズするためのさまざまな書式設定オプションもサポートしています。たとえば、コロンの前後のスペースはいくつですか? コンマの前後？配列とオブジェクトの括弧内ですか? オブジェクトのキーをソートしますか? コロンをすべて並べますか？

Answer 7

ActiveRecord オブジェクトを JSON にダンプする (Rails コンソールで):

pp User.first.as_json

# => {
 "id" => 1,
 "first_name" => "Polar",
 "last_name" => "Bear"
}

Answer 8

Using <pre> HTML code and pretty_generate is good trick:

<%
  require 'json'

  hash = JSON[{hey: "test", num: [{one: 1, two: 2, threes: [{three: 3, tthree: 33}]}]}.to_json] 
%>

<pre>
  <%=  JSON.pretty_generate(hash) %>
</pre>

Answer 9

これは、 @gertas によるこの優れた回答から変更されたミドルウェア ソリューションです。このソリューションは Rails 固有のものではありません。どの Rack アプリケーションでも動作するはずです。

ここで使用されている #each を使用したミドルウェア手法は、Eifion Bedford によるASCIIcasts 151: Rack Middlewareで説明されています。

このコードはapp/middleware/pretty_json_response.rbに入ります:

class PrettyJsonResponse

  def initialize(app)
    @app = app
  end

  def call(env)
    @status, @headers, @response = @app.call(env)
    [@status, @headers, self]
  end

  def each(&block)
    @response.each do |body|
      if @headers["Content-Type"] =~ /^application\/json/
        body = pretty_print(body)
      end
      block.call(body)
    end
  end

  private

  def pretty_print(json)
    obj = JSON.parse(json)  
    JSON.pretty_unparse(obj)
  end

end

オンにするには、これを config/environments/test.rb と config/environments/development.rb に追加します。

config.middleware.use "PrettyJsonResponse"

@gertas がこのソリューションの彼のバージョンで警告しているように、本番環境での使用は避けてください。やや遅いです。

Rails 4.1.6 でテスト済み。

Answer 10

これが、自分の検索中に他の投稿から導き出した私の解決策です。

これにより、必要に応じて pp および jj の出力をファイルに送信できます。

require "pp"
require "json"

class File
  def pp(*objs)
    objs.each {|obj|
      PP.pp(obj, self)
    }
    objs.size <= 1 ? objs.first : objs
  end
  def jj(*objs)
    objs.each {|obj|
      obj = JSON.parse(obj.to_json)
      self.puts JSON.pretty_generate(obj)
    }
    objs.size <= 1 ? objs.first : objs
  end
end

test_object = { :name => { first: "Christopher", last: "Mullins" }, :grades => [ "English" => "B+", "Algebra" => "A+" ] }

test_json_object = JSON.parse(test_object.to_json)

File.open("log/object_dump.txt", "w") do |file|
  file.pp(test_object)
end

File.open("log/json_dump.txt", "w") do |file|
  file.jj(test_json_object)
end

Answer 11

# example of use:
a_hash = {user_info: {type: "query_service", e_mail: "my@email.com", phone: "+79876543322"}, cars_makers: ["bmw", "mitsubishi"], car_models: [bmw: {model: "1er", year_mfc: 2006}, mitsubishi: {model: "pajero", year_mfc: 1997}]}
pretty_html = a_hash.pretty_html

# include this module to your libs:
module MyPrettyPrint
    def pretty_html indent = 0
        result = ""
        if self.class == Hash
            self.each do |key, value|
                result += "#{key}
: #{[Array, Hash].include?(value.class) ? value.pretty_html(indent+1) : value}
"
            end
        elsif self.class == Array
            result = "[#{self.join(', ')}]"
        end
        "#{result}"
    end

end

class Hash
    include MyPrettyPrint
end

class Array
    include MyPrettyPrint
end

Answer 12

RABL を使用している場合は、JSON.pretty_generateを使用するようにここで説明されているように構成できます。

class PrettyJson
  def self.dump(object)
    JSON.pretty_generate(object, {:indent => "  "})
  end
end

Rabl.configure do |config|
  ...
  config.json_engine = PrettyJson if Rails.env.development?
  ...
end

JSON.pretty_generate を使用する際の問題は、JSON スキーマ バリデーターが日時文字列に満足できなくなることです。config/initializers/rabl_config.rb でこれらを修正するには、次のようにします。

ActiveSupport::TimeWithZone.class_eval do
  alias_method :orig_to_s, :to_s
  def to_s(format = :default)
    format == :default ? iso8601 : orig_to_s(format)
  end
end