em trilhos, como retornar registros como um arquivo CSV
-
01-07-2019 - |
Pergunta
Eu tenho uma tabela de banco de dados simples chamado "Entradas":
class CreateEntries < ActiveRecord::Migration
def self.up
create_table :entries do |t|
t.string :firstName
t.string :lastName
#etc.
t.timestamps
end
end
def self.down
drop_table :entries
end
end
Como faço para escrever um manipulador que irá retornar o conteúdo da tabela de entradas como um arquivo CSV (de preferência de uma forma que ele será automaticamente aberto no Excel)?
class EntriesController < ApplicationController
def getcsv
@entries = Entry.find( :all )
# ??? NOW WHAT ????
end
end
Solução
Há um plugin chamado FasterCSV que lida com isso maravilhosamente.
Outras dicas
FasterCSV é definitivamente o caminho a percorrer, mas se você quer servir-lo diretamente a partir de sua aplicação Rails, você vai querer configurar alguns cabeçalhos de resposta, também.
Eu mantenho um método volta para configurar o nome do arquivo e cabeçalhos necessários:
def render_csv(filename = nil)
filename ||= params[:action]
filename += '.csv'
if request.env['HTTP_USER_AGENT'] =~ /msie/i
headers['Pragma'] = 'public'
headers["Content-type"] = "text/plain"
headers['Cache-Control'] = 'no-cache, must-revalidate, post-check=0, pre-check=0'
headers['Content-Disposition'] = "attachment; filename=\"#{filename}\""
headers['Expires'] = "0"
else
headers["Content-Type"] ||= 'text/csv'
headers["Content-Disposition"] = "attachment; filename=\"#{filename}\""
end
render :layout => false
end
Usando o que torna mais fácil para ter algo parecido com isso no meu controlador:
respond_to do |wants|
wants.csv do
render_csv("users-#{Time.now.strftime("%Y%m%d")}")
end
end
E tem uma visão parecida com esta: (generate_csv
é de FasterCSV)
UserID,Email,Password,ActivationURL,Messages
<%= generate_csv do |csv|
@users.each do |user|
csv << [ user[:id], user[:email], user[:password], user[:url], user[:message] ]
end
end %>
Eu aceito (e votou-se!) @ Resposta de Brian, para a primeira me apontando para FasterCSV. Então, quando eu pesquisei para encontrar a jóia, eu também encontrei um exemplo bastante completo em desta página wiki . Colocá-los juntos, me acomodei no seguinte código.
A propósito, o comando para instalar a gem é: sudo gem install FasterCSV (Em minúsculas)
require 'fastercsv'
class EntriesController < ApplicationController
def getcsv
entries = Entry.find(:all)
csv_string = FasterCSV.generate do |csv|
csv << ["first","last"]
entries.each do |e|
csv << [e.firstName,e.lastName]
end
end
send_data csv_string, :type => "text/plain",
:filename=>"entries.csv",
:disposition => 'attachment'
end
end
Outra maneira de fazer isso sem usar FasterCSV:
Exigir biblioteca csv do rubi em um arquivo inicializador como config / initializers / dependencies.rb
require "csv"
Como algum fundo o seguinte código é baseado fora de Pesquisa Avançada Formulário de Ryan Bate que cria um recurso de pesquisa . No meu caso o método show do recurso de busca irá retornar os resultados de uma pesquisa previamente salva. Ele também responde a csv, e usa um modelo de visão para formatar a saída desejada.
def show
@advertiser_search = AdvertiserSearch.find(params[:id])
@advertisers = @advertiser_search.search(params[:page])
respond_to do |format|
format.html # show.html.erb
format.csv # show.csv.erb
end
end
Os olhares de arquivo show.csv.erb como o seguinte:
<%- headers = ["Id", "Name", "Account Number", "Publisher", "Product Name", "Status"] -%>
<%= CSV.generate_line headers %>
<%- @advertiser_search.advertisers.each do |advertiser| -%>
<%- advertiser.subscriptions.each do |subscription| -%>
<%- row = [ advertiser.id,
advertiser.name,
advertiser.external_id,
advertiser.publisher.name,
publisher_product_name(subscription),
subscription.state ] -%>
<%= CSV.generate_line row %>
<%- end -%>
<%- end -%>
Na versão html da página do relatório eu tenho um link para exportar o relatório que o usuário está vendo. O seguinte é o link_to que retorna a versão CSV do relatório:
<%= link_to "Export Report", formatted_advertiser_search_path(@advertiser_search, :csv) %>
Dê uma olhada na FasterCSV jóia.
Se tudo que você precisa é de apoio excel, você pode olhar também para gerar um xls diretamente. (Veja Spreadsheet :: Excel)
gem install fastercsv
gem install spreadsheet-excel
I encontrar estas opções boas para abrir o arquivo CSV no Windows Excel:
FasterCSV.generate(:col_sep => ";", :row_sep => "\r\n") { |csv| ... }
Quanto à parte ActiveRecord, algo como isto faria:
CSV_FIELDS = %w[ title created_at etc ]
FasterCSV.generate do |csv|
Entry.all.map { |r| CSV_FIELDS.map { |m| r.send m } }.each { |row| csv << row }
end
Você precisa definir o cabeçalho Content-Type na sua resposta, em seguida, enviar os dados. Content_Type:. Application / vnd.ms-excel deve fazer o truque
Você também pode querer definir o cabeçalho Content-Disposition para que ele se parece com um documento Excel, eo navegador escolhe um nome de arquivo padrão razoável; Isso é algo como Content-Disposition: anexo; filename = "# {suggested_name} .xls"
Eu sugiro usar o ruby ??gem FasterCSV para gerar o CSV, mas há também um csv builtin. O código de exemplo FasterCSV (da documentação do gem) se parece com isso:
csv_string = FasterCSV.generate do |csv|
csv << ["row", "of", "CSV", "data"]
csv << ["another", "row"]
# ...
end
A seguir aproximou funcionou bem para o meu caso e faz com que o navegador para abrir o aplicativo apropriado para o tipo CSV após o download.
def index
respond_to do |format|
format.csv { return index_csv }
end
end
def index_csv
send_data(
method_that_returns_csv_data(...),
:type => 'text/csv',
:filename => 'export.csv',
:disposition => 'attachment'
)
end
tentar uma jóia agradável para gerar CSV do Rails https://github.com/crafterm/comma
Dê uma olhada no gem CSV Shaper.
https://github.com/paulspringett/csv_shaper
Tem uma DSL agradável e funciona muito bem com modelos Rails. Ele também lida com os cabeçalhos de resposta e permite a personalização do arquivo.
Se você está simplesmente querendo obter o banco de dados CSV-se a partir do console você pode fazê-lo em poucas linhas
tags = [Model.column_names]
rows = tags + Model.all.map(&:attributes).map(&:to_a).map { |m| m.inject([]) { |data, pair| data << pair.last } }
File.open("ss.csv", "w") {|f| f.write(rows.inject([]) { |csv, row| csv << CSV.generate_line(row) }.join(""))}