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

Ruby on RailsのJSON出力を「きれい」に、または適切にフォーマットしてください。

現在、私は呼び出しto_json、私のJSONはすべて1行になっています。JSON出力ストリームに問題があるかどうかを確認するのが難しい場合があります。

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

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"
}

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

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」ヘッダーなどの追加のロジックを導入して、オンデマンドで手動のカールリクエストのフォーマットをトリガーできます。

（Rails 3.2.8-5.0.0、Ruby 1.9.3-2.2.0、Linuxでテスト済み）

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

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

あなたがしたい場合は：

1. アプリからのすべての送信JSON応答を自動的に整えます。
2. Object＃to_json /＃as_jsonの汚染を避ける
3. ミドルウェアを使用してJSONの解析/再レンダリングを回避する（YUCK！）
4. RAILS WAYを実行してください！

次に... JSONのActionController :: Rendererを置き換えます！次のコードを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

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が表示しない色も追加します。

ActiveRecordオブジェクトをJSONにダンプする（Railsコンソールで）：

pp User.first.as_json

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

<pre>HTMLコードを使用して、pretty_generate良いトリックです：

<%
  require 'json'

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

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

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?"}
  ]
}

また、出力をさらにカスタマイズするためのさまざまなフォーマットオプションもサポートしています。たとえば、コロンの前後にいくつのスペースがありますか？コンマの前/後？配列とオブジェクトの括弧の中に？オブジェクトのキーを並べ替えますか？コロンをすべて揃えますか？

@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でテスト済み。

#At Controller
def branch
    @data = Model.all
    render json: JSON.pretty_generate(@data.as_json)
end

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

これにより、必要に応じて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

私はgem CodeRayを使用しましたが、それはかなりうまくいきます。フォーマットには色が含まれており、さまざまなフォーマットを認識します。

Rails APIのデバッグに使用できるgemで使用しましたが、かなりうまく機能します。

ちなみに、gemは 'api_explorer'（http://www.github.com/toptierlabs/api_explorer）という名前です。

これをRailsコントローラーアクションにすばやく実装してJSON応答を送信する場合：

def index
  my_json = '{ "key": "value" }'
  render json: JSON.pretty_generate( JSON.parse my_json )
end

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

# 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

ヘッダー、ステータス、JSON出力がセットとして役立つと思うので、以下を使用します。呼び出しルーチンは、http：//railscasts.com/episodes/151-rack-middleware？autoplay = trueのrailscastsプレゼンテーションからの推奨に基づいて分割されています。

  class LogJson

  def initialize(app)
    @app = app
  end

  def call(env)
    dup._call(env)
  end

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

  def each(&block)
    if @headers["Content-Type"] =~ /^application\/json/
      obj = JSON.parse(@response.body)
      pretty_str = JSON.pretty_unparse(obj)
      @headers["Content-Length"] = Rack::Utils.bytesize(pretty_str).to_s
      Rails.logger.info ("HTTP Headers:  #{ @headers } ")
      Rails.logger.info ("HTTP Status:  #{ @status } ")
      Rails.logger.info ("JSON Response:  #{ pretty_str} ")
    end

    @response.each(&block)
  end
  end

プリティプリントバリアント：

my_object = { :array => [1, 2, 3, { :sample => "hash"}, 44455, 677778, 9900 ], :foo => "bar", rrr: {"pid": 63, "state": false}}
puts my_object.as_json.pretty_inspect.gsub('=>', ': ')

結果：

{"array": [1, 2, 3, {"sample": "hash"}, 44455, 677778, 9900],
 "foo": "bar",
 "rrr": {"pid": 63, "state": false}}

最も単純な例として、次のことが考えられます。

my_json = '{ "name":"John", "age":30, "car":null }'
puts JSON.pretty_generate(JSON.parse(my_json))

Railsコンソールの例：

core dev 1555:0> my_json = '{ "name":"John", "age":30, "car":null }'
=> "{ \"name\":\"John\", \"age\":30, \"car\":null }"
core dev 1556:0> puts JSON.pretty_generate(JSON.parse(my_json))
{
  "name": "John",
  "age": 30,
  "car": null
}
=> nil