From bc3b1b477e796f0799c604f09a884b6fad61d21f Mon Sep 17 00:00:00 2001 From: Alex Turchyn Date: Sun, 20 Aug 2023 15:18:15 +0300 Subject: [PATCH] add export button --- Gemfile | 1 + Gemfile.lock | 5 + .../submissions_export_controller.rb | 28 ++++ app/javascript/application.js | 21 +++ app/javascript/elements/turbo_modal.js | 6 +- app/views/shared/_clipboard_copy.html.erb | 10 ++ app/views/shared/_turbo_modal.html.erb | 2 +- app/views/submissions_export/new.html.erb | 32 ++++ app/views/templates/show.html.erb | 18 ++- config/initializers/csv.rb | 3 + config/routes.rb | 1 + lib/submissions/generate_export_files.rb | 137 ++++++++++++++++++ 12 files changed, 256 insertions(+), 8 deletions(-) create mode 100644 app/controllers/submissions_export_controller.rb create mode 100644 app/views/submissions_export/new.html.erb create mode 100644 config/initializers/csv.rb create mode 100644 lib/submissions/generate_export_files.rb diff --git a/Gemfile b/Gemfile index 9e47f8f3..2acbdb86 100644 --- a/Gemfile +++ b/Gemfile @@ -28,6 +28,7 @@ gem 'rails_autolink' gem 'rails-i18n' gem 'rollbar', require: ENV.key?('ROLLBAR_ACCESS_TOKEN') gem 'ruby-vips' +gem 'rubyXL' gem 'shakapacker' gem 'sidekiq', require: ENV.key?('REDIS_URL') gem 'sqlite3', require: false diff --git a/Gemfile.lock b/Gemfile.lock index 66557037..fa4781da 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -458,6 +458,10 @@ GEM ruby-vips (2.1.4) ffi (~> 1.12) ruby2_keywords (0.0.5) + rubyXL (3.4.25) + nokogiri (>= 1.10.8) + rubyzip (>= 1.3.0) + rubyzip (2.3.2) semantic_range (3.0.0) shakapacker (7.0.0) activesupport (>= 5.2) @@ -566,6 +570,7 @@ DEPENDENCIES rubocop-rails rubocop-rspec ruby-vips + rubyXL shakapacker sidekiq simplecov diff --git a/app/controllers/submissions_export_controller.rb b/app/controllers/submissions_export_controller.rb new file mode 100644 index 00000000..33045b1d --- /dev/null +++ b/app/controllers/submissions_export_controller.rb @@ -0,0 +1,28 @@ +# frozen_string_literal: true + +class SubmissionsExportController < ApplicationController + before_action :load_template + + def index + submissions = @template.submissions.active + .preload(submitters: { documents_attachments: :blob, + attachments_attachments: :blob }) + .order(id: :asc) + + if params[:format] == 'csv' + send_data Submissions::GenerateExportFiles.call(submissions, format: params[:format]), + filename: "#{@template.name}.csv" + elsif params[:format] == 'xlsx' + send_data Submissions::GenerateExportFiles.call(submissions, format: params[:format]), + filename: "#{@template.name}.xlsx" + end + end + + def new; end + + private + + def load_template + @template = current_account.templates.find(params[:template_id]) + end +end diff --git a/app/javascript/application.js b/app/javascript/application.js index 70d8578c..496bbbf4 100644 --- a/app/javascript/application.js +++ b/app/javascript/application.js @@ -45,6 +45,27 @@ window.customElements.define('set-timezone', SetTimezone) window.customElements.define('autoresize-textarea', AutoresizeTextarea) document.addEventListener('turbo:before-fetch-request', encodeMethodIntoRequestBody) +document.addEventListener('turbo:submit-end', async (event) => { + const resp = event.detail?.formSubmission?.result?.fetchResponse?.response + + if (!resp?.headers?.get('content-disposition')?.includes('attachment')) { + return + } + + const url = URL.createObjectURL(await resp.blob()) + const link = document.createElement('a') + + link.href = url + link.setAttribute('download', decodeURIComponent(resp.headers.get('content-disposition').split('"')[1])) + + document.body.appendChild(link) + + link.click() + + document.body.removeChild(link) + + URL.revokeObjectURL(url) +}) window.customElements.define('template-builder', class extends HTMLElement { connectedCallback () { diff --git a/app/javascript/elements/turbo_modal.js b/app/javascript/elements/turbo_modal.js index 810a69fc..5009f60b 100644 --- a/app/javascript/elements/turbo_modal.js +++ b/app/javascript/elements/turbo_modal.js @@ -5,8 +5,12 @@ export default actionable(class extends HTMLElement { document.body.classList.add('overflow-hidden') document.addEventListener('keyup', this.onEscKey) - document.addEventListener('turbo:submit-end', this.onSubmit) + document.addEventListener('turbo:before-cache', this.close) + + if (this.dataset.closeAfterSubmit !== 'false') { + document.addEventListener('turbo:submit-end', this.onSubmit) + } } disconnectedCallback () { diff --git a/app/views/shared/_clipboard_copy.html.erb b/app/views/shared/_clipboard_copy.html.erb index c4579794..1c9fdc25 100644 --- a/app/views/shared/_clipboard_copy.html.erb +++ b/app/views/shared/_clipboard_copy.html.erb @@ -6,12 +6,22 @@ + <% if local_assigns[:copy_title_md] %> + + <%= local_assigns[:copy_title_md] %> + + <% end %> diff --git a/app/views/shared/_turbo_modal.html.erb b/app/views/shared/_turbo_modal.html.erb index c4fee1b4..33af1175 100644 --- a/app/views/shared/_turbo_modal.html.erb +++ b/app/views/shared/_turbo_modal.html.erb @@ -1,5 +1,5 @@ - +
<% if local_assigns[:title] %> diff --git a/app/views/submissions_export/new.html.erb b/app/views/submissions_export/new.html.erb new file mode 100644 index 00000000..336cff3b --- /dev/null +++ b/app/views/submissions_export/new.html.erb @@ -0,0 +1,32 @@ +<%= render 'shared/turbo_modal', title: 'Export', close_after_submit: false do %> +
+ <%= button_to template_submissions_export_index_path(@template), params: { format: :xlsx }, method: :get, data: { turbo_frame: :_top } do %> +
+
+ <%= svg_icon('download', class: 'w-12 h-12 stroke-2 mr-2') %> +
+
+ <%= svg_icon('loader', class: 'w-12 h-12 stroke-2 mr-2 animate-spin') %> +
+
+ XLSX +

Primarily opened with Microsoft Excel. Other options include Google Sheets, LibreOffice Calc, and OpenOffice Calc.

+
+
+ <% end %> + <%= button_to template_submissions_export_index_path(@template), params: { format: :csv }, method: :get, data: { turbo_frame: :_top } do %> +
+
+ <%= svg_icon('download', class: 'w-12 h-12 stroke-2 mr-2') %> +
+
+ <%= svg_icon('loader', class: 'w-12 h-12 stroke-2 mr-2 animate-spin') %> +
+
+ CSV +

Can be opened with Microsoft Excel, Google Sheets, or any text editor like Notepad.

+
+
+ <% end %> +
+<% end %> diff --git a/app/views/templates/show.html.erb b/app/views/templates/show.html.erb index d66f0ced..73f730d5 100644 --- a/app/views/templates/show.html.erb +++ b/app/views/templates/show.html.erb @@ -1,4 +1,4 @@ -
+

<%= @template.name %>

@@ -17,16 +17,22 @@
<% if !@pagy.count.zero? || @template.submitters.to_a.size == 1 %> -
+

Submissions

-
+
+ <%= link_to new_template_submissions_export_path(@template), class: 'order-3 md:order-1 btn btn-ghost text-base', data: { turbo_frame: 'modal' } do %> + <%= svg_icon('download', class: 'w-6 h-6 stroke-2') %> + Export + <% end %> <% if @template.submitters.to_a.size == 1 %> - <%= render 'shared/clipboard_copy', text: start_form_url(slug: @template.slug), class: 'base-button', icon_class: 'w-6 h-6 text-white', copy_title: 'Copy Share Link', copied_title: 'Copied to Clipboard' %> + + <%= render 'shared/clipboard_copy', text: start_form_url(slug: @template.slug), class: 'base-button', icon_class: 'w-6 h-6 text-white', copy_title: 'Copy Share Link', copied_title: 'Copied to Clipboard', copy_title_md: 'Copy', copied_title_md: 'Copied' %> + <% end %> <% unless @pagy.count.zero? %> - <%= link_to new_template_submission_path(@template), class: 'btn btn-primary text-base', data: { turbo_frame: 'modal' } do %> + <%= link_to new_template_submission_path(@template), class: 'order-1 btn btn-primary text-base', data: { turbo_frame: 'modal' } do %> <%= svg_icon('plus', class: 'w-6 h-6 stroke-2') %> - + Add <% end %> <% end %>
diff --git a/config/initializers/csv.rb b/config/initializers/csv.rb new file mode 100644 index 00000000..c278004d --- /dev/null +++ b/config/initializers/csv.rb @@ -0,0 +1,3 @@ +# frozen_string_literal: true + +require 'csv' diff --git a/config/routes.rb b/config/routes.rb index 774d5786..ec81cd86 100644 --- a/config/routes.rb +++ b/config/routes.rb @@ -44,6 +44,7 @@ Rails.application.routes.draw do resources :console_redirect, only: %i[index] resources :templates, only: %i[new create edit show destroy] do resources :submissions, only: %i[new create] + resources :submissions_export, only: %i[index new] end resources :start_form, only: %i[show update], path: 'd', param: 'slug' do diff --git a/lib/submissions/generate_export_files.rb b/lib/submissions/generate_export_files.rb new file mode 100644 index 00000000..0cd1e6e0 --- /dev/null +++ b/lib/submissions/generate_export_files.rb @@ -0,0 +1,137 @@ +# frozen_string_literal: true + +module Submissions + module GenerateExportFiles + UnknownFormat = Class.new(StandardError) + + module_function + + def call(submissions, format: :csv) + rows = build_table_rows(submissions) + + if format.to_sym == :csv + rows_to_csv(rows) + elsif format.to_sym == :xlsx + rows_to_xlsx(rows) + else + raise UnknownFormat + end + end + + def rows_to_xlsx(rows) + workbook = RubyXL::Workbook.new + worksheet = workbook[0] + worksheet.sheet_name = I18n.l(Time.current.to_date) + + headers = build_headers(rows) + headers.each_with_index do |column_name, column_index| + worksheet.add_cell(0, column_index, column_name) + end + + rows.each.with_index(1) do |row, row_index| + extract_columns(row, headers).each_with_index do |value, column_index| + worksheet.add_cell(row_index, column_index, value) + end + end + + workbook.stream.string + end + + def rows_to_csv(rows) + headers = build_headers(rows) + + CSV.generate do |csv| + csv << headers + + rows.each do |row| + csv << extract_columns(row, headers) + end + end + end + + def build_headers(rows) + rows.reduce(Set.new) { |acc, row| acc + row.pluck(:name) } + end + + def extract_columns(row, headers) + headers.map { |key| row.find { |e| e[:name] == key }&.dig(:value) } + end + + def build_table_rows(submissions) + submissions.map do |submission| + submission_data = [] + submitters_count = submission.submitters.size + + submission.submitters.each do |submitter| + template_submitters = submission.template_submitters || submission.template.submitters + submitter_name = template_submitters.find { |s| s['uuid'] == submitter.uuid }['name'] + + submission_data += build_submission_data(submitter, submitter_name, submitters_count) + + submission_data += submitter_formatted_fields(submitter).map do |field| + { + name: column_name(field[:name], submitter_name, submitters_count), + value: field[:value] + } + end + + next if submitter != submission.submitters.select(&:completed_at?).max_by(&:completed_at) + + submission_data += submitter.documents.map.with_index(1) do |attachment, index| + { + name: "Document #{index}", + value: attachment.url + } + end + end + + submission_data + end + end + + def build_submission_data(submitter, submitter_name, submitters_count) + [ + { + name: column_name('Email', submitter_name, submitters_count), + value: submitter.email + }, + { + name: column_name('Completed At', submitter_name, submitters_count), + value: submitter.completed_at + } + ] + end + + def column_name(name, submitter_name, submitters_count = 1) + submitters_count > 1 ? "#{submitter_name} - #{name}" : name + end + + def submitter_formatted_fields(submitter) + fields = submitter.submission.template_fields || submitter.submission.template.fields + + template_fields = fields.select { |f| f['submitter_uuid'] == submitter.uuid } + + attachments_index = submitter.attachments.index_by(&:uuid) + + template_field_counters = Hash.new { 0 } + template_fields.map do |template_field| + submitter_value = submitter.values.fetch(template_field['uuid'], nil) + template_field_type = template_field['type'] + template_field_counters[template_field_type] += 1 + template_field_name = template_field['name'].presence + template_field_name ||= "#{template_field_type.titleize} Field #{template_field_counters[template_field_type]}" + + value = + if template_field_type.in?(%w[image signature]) + attachments_index[submitter_value]&.url + elsif template_field_type == 'file' + Array.wrap(submitter_value).compact_blank.filter_map { |e| attachments_index[e]&.url } + else + submitter_value + end + + { name: template_field_name, uuid: template_field['uuid'], value: } + end + end + end +end