Ruby on RailsでCSVファイルとして出力(ダウンロード)する方法を紹介します。
【Rails】CSVファイルとして出力(ダウンロード)する方法
例としてユーザIDに紐づいたユーザ情報をCSV出力します。「CSVダウンロード」ボタンを押下すると、ユーザIDをusersコントローラのcsvメソッドに送ります。
・index.html.erb
1 2 3 4 5 6 7 | ・・・ <%= button_to csv_users_path, method: :get, params: {user_id: @params[:user_id]}, type: 'button' do %> CSVダウンロード <% end %> ・・・ |
viewから受け取ったユーザIDからfindメソッドでユーザ情報を取得します。
csvファイルのヘッダーを生成するためにcreate_csv_file_header()メソッドを呼び出します。ここでは「user_test_file_name_」という文字列に年月日を足したファイル名を引数にしています。
create_csv_file_header()メソッドは他のコントローラでも使用することを考えて、ApplicationControllerに定義し、継承する形で使います。
・users_controller.rb
1 2 3 4 5 6 7 8 9 10 11 12 13 | class UsersController < ApplicationController # csvダウンロード def csv @users = Users.find(params[:expiration_execution_request_id]) respond_to do |format| format.csv do create_csv_file_header("user_test_file_name_#{ Time.zone.now.strftime('%Y%m%d') }") end end end end |
CSVファイルのヘッダーを生成します。
ダウンロードするブラウザがIEの場合はファイル名の文字列の文字コードを変換します。IE6からのユーザエージェントは「MSIE」、IE10からは「Trident」が表記されています。
=~演算子を使ってIEのユーザエージェントにパターンマッチした場合、文字列の文字コードを変換します。
・application_controller.rb
1 2 3 4 5 6 7 8 9 | class ApplicationController # CSVファイルのヘッダーを生成 # @param [String] csv_file_name csvファイル名 def create_csv_file_header(csv_file_name) file_name = ERB::Util.url_encode(file_name) if (/MSIE/ =~ request.user_agent) || (/Trident/ =~ request.user_agent) headers['Content-Disposition'] = "attachment; filename=\"#{file_name}.csv\"" end end |
request.user_agentでHTTP_USER_AGENTを取得できます。実際にrequest.user_agentでログを出力してみると以下のようになります。
1 2 | Rails.logger.info(request.user_agent) # => Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/73.0.3683.103 Safari/537.36 |
CSVファイルとして出力するため、〇〇.csv.rubyという拡張子のファイルを作成します。
generateメソッドを使ってた文字列をCSV形式に変換処理しています。
・csv.csv.ruby
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 | require 'csv' CSV.generate(encoding: Encoding::SJIS, row_sep: "\r\n", force_quotes: true) do |csv| csv << [ "ユーザID", "ユーザ名", "年齢", "出身", "電話番号", "登録日", ] @users.each do |user| data = [ user.id, user.name, user.age, user.place, user.tel, formated_date(user.created_at) ] csv << data end end |
以上、Ruby on RailsでCSVファイルとして出力する方法でした。