BanditHijo.dev

Export Data ke XLSX (SpreadSheet) pada Rails

Created at: 2020-07-09
Author by: BanditHijo

Prerequisite

ruby 2.6.6 rails 5.2.4 postgresql 12.3

Sekenario Masalah

Saya punya data yang ingin di-eksport ke dalam bentuk spreadsheet dengan format .xlsx.

Pemecahan Masalah

Kita dapat menggunakan bantuan gem axlsx & axlsx_rails. Namun, gem ini sudah tidak dimaintain lagi.

Nah, kita akan menggunakan versi yang dimaintain oleh komunitas bernama cxlsx & cxlsx_rails.

Instalasi

Pasang gem yang dibutuhkan di Gemfile.

Gemfile
1source 'https://rubygems.org'
2git_source(:github) { |repo| "https://github.com/#{repo}.git" }
3
4...
5...
6gem 'caxlsx', '~> 3.0', '>= 3.0.1'
7gem 'caxlsx_rails', '~> 0.6.2'

Kemudian install.

$ bundle install

Implementasi

Kita akan membuat tombol pada view template dan akan di-respon oleh controller.

Controller

Saya akan mengawali dengan membuat response ke controller apabila tombol pada view template di tekan.

app/controllers/cases_controller.rb
1class CasesController < ApplicationController
2
3 def index
4 @cases = Case.all
5
6 respond_to do |format|
7 format.html
8 format.xlsx {
9 response.headers['Content-Disposition'] = \
10 "attachment; \
11 filename=COVID-19_INDO_PERHARI_#{@cases.last.fetched_at}.xlsx"
12 }
13 end
14 end
15end

Apabila ingin merubah nama file, dapat merubah pada bagian filename=... di baris ke-13 tersebut.

View Template

Selanjutnya, kita buat link atau button yang akan di respon oleh controller.

app/views/cases/index.html.erb
1<%= link_to cases_path(format: "xlsx"), class: "button is-fullwidth-mobile" do %>
2 <span class="icon">
3 <%= image_tag 'file-download-solid.svg', width: '12' %>
4 </span>
5 <span class="has-text-weight-normal">Export as SpreadSheet</span>
6<% end %>

Bagian yang harus diperhatikan adalah baris ke-3, ..._path(format: "xlsx").

Selanjutnya, kita akan buat view template untuk file .xlsx yang akan di download.

Buat file view template app/views/cases/index.xlsx.axlsx.

app/views/cases/index.xlsx.axlsx
1wb = xlsx_package.workbook
2
3wb.add_worksheet(name: "Cases") do |sheet|
4 # Blok ini untuk head dari baris (baris head paling atas)
5 sheet.add_row %w(id fetched_at positif_covid meninggal_covid
6 sembuh_covid jumlah_odp jumlah_pdp)
7
8 # Blok ini untuk data, urutkan sesuai baris head di atas
9 @cases.each do |kasus|
10 sheet.add_row [kasus.id, kasus.fetched_at.strftime("%F"),
11 kasus.positif_covid, kasus.meninggal_covid,
12 kasus.sembuh_covid, kasus.jumlah_odp,
13 kasus.jumlah_pdp]
14 end
15end

Perhatikan pada baris ke-7 dan ke-12, basicnya .add_row() ini menampung value berupa Array.

Pada baris ke-7, adalah salah satu bentuk lain cara pemanggilan Array di Ruby.

Selesai!

Pesan Penulis

Catatan ini bukan merupakan tutorial, saya hanya ingin memberikan gambaran betapa mudahnya mengeksport data ke dalam format .xlsx dari Rails menggunakan cxlsx dan cxlsx_rails.

Maka dari itu, apabila teman-teman ingin mendapatkan penjelasan yang lebih baik, silahkan mengunjungin dokumentasi dari cxlsx_rails. Tentunya akan lebih up to date dari yang saya tulis di sini.

Saya juga memanfaatkan gem ini untuk mengeksport data ke spreadsheet seperti yang saya lakukan di bandithijo.github.io/covid19

Saya rasa hanya ini yang dapat saya tuliskan saat ini.

Mudah-mudahan dapat bermanfaat untuk teman-teman.

Terima kasih.

(^_^)

Referensi

  1. github.com/randym/axlsx
    Diakses tanggal: 2020/07/09

  2. github.com/caxlsx/caxlsx_rails
    Diakses tanggal: 2020/07/09

  3. github.com/caxlsx/caxlsx
    Diakses tanggal: 2020/07/09

  4. github.com/caxlsx/caxlsx_rails
    Diakses tanggal: 2020/07/09

  5. %Q, %q, %W, %w, %x, %r, %s
    Diakses tanggal: 2020/07/09