Como eu posso “bonito” formatar a minha saída JSON em Ruby on Rails?

Question

Eu gostaria que a minha saída JSON em Ruby on Rails para ser "bonito" ou bem formatado.

Agora, eu chamo to_json e meu JSON é tudo em uma linha. Às vezes isso pode ser difícil para ver se há um problema no fluxo de saída JSON.

Existe maneira de configurar ou um método para fazer o meu JSON "bonito" ou bem formatado em Rails?

Answer 1

Use a função pretty_generate(), construído em versões posteriores do JSON. Por exemplo:

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

O que você recebe:

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

Answer 2

Graças a cremalheira Middleware e Rails 3 você pode produzir muito JSON para cada pedido sem alterar qualquer controlador de sua aplicação. Eu escrevi tal trecho de middleware e eu fico bem impressos JSON no navegador e curl saída.

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

O código acima deve ser colocado em app/middleware/pretty_json_response.rb do seu projeto Rails. E o último passo é registrar o middleware em config/environments/development.rb:

config.middleware.use PrettyJsonResponse

Eu não recomendo usá-lo em production.rb . O reparsing JSON pode degradar o tempo de resposta e rendimento do seu aplicativo de produção. Eventualmente lógica extra, como 'X-Pretty-Json: true'. Cabeçalho pode ser introduzida para gatilho formatação para pedidos onda manuais sob demanda

(Testado com Rails 3.2.8-5.0.0, Ruby 1.9.3-2.2.0, Linux)

Answer 3

A tag <pre> em HTML, usada com JSON.pretty_generate, irá processar a JSON muito em sua vista. Eu estava tão feliz quando o meu ilustre chefe me mostrou isso:

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

Answer 4

Se você quiser:

1. Prettify todas as respostas JSON de saída de seu aplicativo automaticamente.
2. Evite poluentes Objeto # to_json / # as_json
3. Evite análise / re-renderização JSON utilizando middleware (eca!)
4. Faça-o a maneira dos trilhos!

Então ... substituir o ActionController :: Renderer para JSON! Basta adicionar o seguinte código ao seu 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

Confira awesome_print . Analisar a cadeia de JSON em um rubi Hash, em seguida, exibi-lo com awesome_print assim:

require "awesome_print"
require "json"

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

ap(JSON.parse(json))

Com o acima, você verá:

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

awesome_print também irá adicionar um pouco de cor que Stack Overflow não irá mostrar-lhe:)

Answer 6

Dumping um objeto ActiveRecord para JSON (no console Rails):

pp User.first.as_json

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

Answer 7

Se você (como eu) acham que a opção pretty_generate construído em biblioteca JSON de Ruby não é "bonito" o suficiente, eu recomendo o meu próprio NeatJSON jóia para sua formatação.

Para usá-lo gem install neatjson e depois usar JSON.neat_generate vez de JSON.pretty_generate.

pp de como Ruby vai manter objetos e arrays em uma linha quando eles se encaixam, mas envolva a múltiplas conforme necessário. Por exemplo:

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

Ele também suporta uma variedade de opções de formatação para personalizar ainda mais a sua saída. Por exemplo, quantos espaços antes / depois dois pontos? Antes / depois de vírgulas? Dentro dos suportes de matrizes e objetos? Você quer classificar as chaves do seu objeto? Quer os dois pontos a ser todos alinhados?

Answer 8

Usando o código html <pre> e pretty_generate é bom truque:

<%
  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

Aqui está uma solução de middleware modificado a partir do este excelente resposta por @gertas . Esta solução não é Rails específica -. Ele deve funcionar com qualquer aplicação Rack

A técnica middleware utilizado aqui, usando #each, é explicado em ASCIIcasts 151: Cremalheira Middleware por Eifion Bedford.

Este código vai em 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

Para ligá-lo, adicioná-lo ao config / environments / test.rb e config / environments / development.rb:

config.middleware.use "PrettyJsonResponse"

Como @gertas adverte em sua versão desta solução, evite usá-lo em produção. É um pouco lento.

Testado com Rails 4.1.6.

Answer 10

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

Answer 11

Aqui está a minha solução que eu derivada de outras mensagens durante a minha própria pesquisa.

Isto permite-lhe enviar o pp e jj saída para um arquivo conforme necessário.

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 12

Eu tenho usado o gem CodeRay e ele funciona muito bem. O formato inclui cores e reconhece uma série de formatos diferentes.

Eu usei-o em uma jóia que pode ser usado para depurar APIs trilhos e ele funciona muito bem.

A propósito, a gema é nomeado 'api_explorer' ( http://www.github.com/ toptierlabs / api_explorer )

Answer 13

Se você estiver olhando para implementar rapidamente isso em uma ação de controlador Rails para enviar uma resposta JSON:

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

Answer 14

Eu uso o seguinte que eu encontrar os cabeçalhos, status e de saída JSON úteis como um conjunto. A rotina de chamada é dividida em recomendação de um Railscasts apresentação em: http: // Railscasts .com / episódios / 151-rack-middleware? autoplay = true

  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

Answer 15

Se você estiver usando RABL você pode configurá-lo como descrito aqui usar 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

Um problema com o uso JSON.pretty_generate é que validadores esquema JSON não vai ser feliz com suas cordas de data e hora. Você pode corrigir aqueles em sua config / initializers / rabl_config.rb com:

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

Answer 16

# 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 17

variante A cópia consideravelmente:

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('=>', ': ')

Resultado:

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