Adds ability to CSV export collections from the ActionMenu

Author: kaptron

app/controllers/api/v1/collections_controller.rb

@@ -2,13 +2,13 @@ class Api::V1::CollectionsController < Api::V1::BaseController
   deserializable_resource :collection, class: DeserializableCollection, only: %i[update]
   load_and_authorize_resource :collection_card, only: [:create]
   load_and_authorize_resource except: %i[update destroy in_my_collection clear_collection_cover clear_background_image
-                                         challenge_submission_boxes next_available_submission_test insert_row remove_row]
+                                         challenge_submission_boxes next_available_submission_test insert_row remove_row csv]
   skip_before_action :check_api_authentication!, only: %i[show]
 
   before_action :join_collection_group, only: :show, if: :join_collection_group?
   before_action :switch_to_organization, only: :show, if: :user_signed_in?
   before_action :load_and_authorize_collection_layout_update, only: %i[insert_row remove_row]
-  before_action :load_collection_with_roles, only: %i[show update]
+  before_action :load_collection_with_roles, only: %i[show update csv]
   before_action :load_and_authorize_collection_update, only: %i[update clear_collection_cover
                                                                 clear_background_image collection_challenge_setup]
   before_action :load_and_authorize_parent_challenge, only: %i[challenge_submission_boxes next_available_submission_test]
@@ -33,6 +33,16 @@ def show
     )
   end
 
+  before_action :load_and_authorize_collection_view, only: %i[csv]
+  def csv
+    csv_data = CollectionCSVBuilder.call(@collection)
+    filename = "#{@collection.id}-#{@collection.name.parameterize}-#{Date.today}.csv"
+
+    respond_to do |format|
+      format.any { send_data csv_data, filename: filename }
+    end
+  end
+
   before_action :load_and_authorize_template_and_parent, only: %i[create_template]
   def create_template
     builder = CollectionTemplateBuilder.new(
@@ -291,6 +301,11 @@ def log_viewing_activities
     log_collection_activity(:viewed)
   end
 
+  def load_and_authorize_collection_view
+    @collection = Collection.find(params[:id])
+    authorize! :read, @collection
+  end
+
   def load_and_authorize_template_and_parent
     @parent_collection = Collection.find(json_api_params[:parent_id])
     @template_collection = Collection.find(json_api_params[:template_id])

app/helpers/application_helper.rb

@@ -1,13 +1,13 @@
 module ApplicationHelper
   # NOTE: this is somewhat similar to RoutingStore.js by necessity
-  def frontend_url_for(obj, with_id: true)
+  def frontend_url_for(obj, with_id: true, slug: nil)
     return admin_root_url if obj == Role::SHAPE_ADMIN.to_s.titleize
 
-    "#{root_url.chomp('/')}#{frontend_path_for(obj, with_id: with_id)}"
+    "#{root_url.chomp('/')}#{frontend_path_for(obj, with_id: with_id, slug: slug)}"
   end
 
-  def frontend_path_for(obj, with_id: true)
-    slug = obj&.organization&.slug
+  def frontend_path_for(obj, with_id: true, slug: nil)
+    slug ||= obj&.organization&.slug
     url = ''
     url += "/#{slug}" if slug
     obj_id = with_id ? "/#{obj.id}" : ''

app/javascript/ui/grid/ActionMenu.js

@@ -118,12 +118,21 @@ class ActionMenu extends React.Component {
   downloadCard = () => {
     const { card } = this.props
     const { record } = card
+    if (record.isCollection) {
+      return this.downloadCsv()
+    }
     if (record.filestack_file) {
       Activity.trackActivity('downloaded', record)
       window.open(record.filestack_file.url, '_blank')
     }
   }
 
+  downloadCsv = () => {
+    const { card } = this.props
+    const { record } = card
+    window.open(`/api/v1/collections/${record.id}/csv`, '_blank')
+  }
+
   showRolesMenu = () => {
     const { uiStore, card } = this.props
     uiStore.update('rolesMenuOpen', card.record)
@@ -309,6 +318,11 @@ class ActionMenu extends React.Component {
         iconRight: <PrintIcon />,
         onClick: this.printPage,
       })
+      items.push({
+        name: 'Export',
+        iconRight: <DownloadIcon />,
+        onClick: this.downloadCsv,
+      })
     }
 
     // if record is system required, we always remove these actions

app/services/collection_csv_builder.rb

@@ -0,0 +1,108 @@
+require 'csv'
+
+class CollectionCSVBuilder < SimpleService
+  include Rails.application.routes.url_helpers
+  include ApplicationHelper
+
+  def initialize(collection)
+    @collection = collection
+  end
+
+  def call
+    CSV.generate do |csv|
+      csv << %w[
+        id
+        type
+        name
+        created_by_name
+        created_by_email
+        content
+        data_content
+        col
+        row
+        height
+        width
+        url
+        image_url
+        shape_url
+        shape_csv_url
+      ]
+
+      row = [
+        @collection.id,
+        @collection.type || 'Collection',
+        @collection.name,
+        @collection.created_by&.name,
+        @collection.created_by&.email,
+        nil,
+        nil,
+        nil,
+        nil,
+        nil,
+        nil,
+        nil,
+        nil,
+        url_for(@collection),
+        csv_url_for(@collection),
+      ]
+
+      csv << row
+
+      @collection.collection_cards.find_each do |card|
+        csv << card_row(card)
+      end
+
+      next unless @collection.is_a?(Collection::SubmissionBox)
+
+      @collection.submissions_collection.collection_cards.find_each do |card|
+        csv << card_row(card)
+      end
+    end
+  end
+
+  private
+
+  def card_row(card)
+    record = card.record
+    record_type = record&.type
+    record_type = record.class.name if record_type.nil? && record.present?
+
+    [
+      card.id,
+      record_type,
+      card.name,
+      record.try(:created_by)&.name,
+      record.try(:created_by)&.email,
+      record.try(:content),
+      record.try(:data_content),
+      card.col,
+      card.row,
+      card.height,
+      card.width,
+      record.try(:url),
+      record.try(:image_url),
+      url_for(record),
+      csv_url_for(record),
+    ]
+  end
+
+  def org_slug
+    @org_slug ||= @collection.organization.slug
+  end
+
+  def url_for(obj)
+    return nil unless obj.present?
+
+    frontend_url_for(obj, slug: org_slug)
+  end
+
+  def csv_url_for(coll)
+    return nil unless coll&.is_a?(Collection)
+
+    "#{root_url}api/v1/collections/#{coll.id}/csv"
+  end
+
+  def default_url_options
+    Rails.application.config.action_mailer.default_url_options
+  end
+end

config/routes.rb

@@ -32,6 +32,7 @@
           get 'phase_sub_collections'
           get 'next_available_submission_test'
           get 'challenge_phase_collections'
+          get 'csv'
           post 'clear_collection_cover'
           post 'clear_background_image'
           patch 'submit'