ActiveAdminExcelUpload (active_admin_excel_upload)

A gem for excel upload for active admin. It is designed for large excel sheets that consume too much time on normal process. It uses active job to process sheets on a different queue and action cables to show progress of your upload. Active admin excel upload brings rails convention for excel uploads.

prerequisites

  active-admin,
  Devise,
  Rails 5,
  redis

Installation

Add this line to your application's Gemfile:

gem 'active_admin_excel_upload'

And then execute:

$ bundle

Or install it yourself as:

$ gem install active_admin_excel_upload

##Config generator

$rails g active_admin_excel_upload:install

Usage

configure your active admin resource to use it.

# RAILS_ROOT/app/admin/post.rb
ActiveAdmin.register Post do
  excel_importable         
end

set your queue backend in application.rb

  config.active_job.queue_adapter = :sidekiq

You can use any queuing backend e.g resque etc. You can set active job queue to be used for excel uploads in config/initializers/active_admin_excel_upload.rb

You may need redis adapter in cable.yml to work it in dev mode. By default rails uses redis adapter for production mode.

  development:
    adapter: redis

Convention

1. By default it searches for sheet in your excel file with the same name as of the table in the db for current model.
2. First row in the sheet is considered as header. Header names has to match either column names in the table or humanized version of column names.
3. It tries it create record every time for every row. If record is not created due to some error or validation failue they are shown live and process moves to next row.

configuration

if You are using your own authentication method for action cables. You can pass the identified by to the active_admin_excel_upload.

config/initializers/active_admin_excel_upload.rb

  ActiveAdminExcelUpload.configure do |config|
    config.use_default_connecion_authentication = false
    config.connection_identifier = :current_admin_user
    config.active_job_queue = :default
  end

Overrides

Override Parsing method.

Active admin excel upload defines a method in ActiveRecord::Base class. if you want custom behaviour for your row you can define a method in your model as follows

  def excel_create_record(row, index, header, channel_name)
    ActionCable.server.broadcast channel_name, message: "processing for #{row}"
    object = Hash[header.zip row]
    record = self.new(object)
    if record.save
      ActionCable.server.broadcast channel_name, message: "Successfully created record for #{row}, id: #{record.id}"
    else
      ActionCable.server.broadcast channel_name, message: "Could not create record for #{row}, error: #{record.errors.messages}"
    end
  end

active_admin_excel_upload send 4 arguments to this method. First is the array for the current processing row in the excel. Second is the index for the row. Third is header of the sheet. Fourth is the channel_name to send messages on.

  ActionCable.server.broadcast channel_name, message: "Successfully created record for #{row}, id: #{record.id}"

This particular line is used to broadcast messages on particular channel.

By default it sends string as message but you can render anything you want. e.g

ApplicationController.renderer.render(partial: 'messages/message', locals: { message: message })

Contributing

This gem is in very new state and we are actively looking for contributors to join us and improve and increase the functionality of this gem.

We are currently working on following features.

User should be able to run validations on the sheet before processing the sheet. User should be able to do bulk upload. User should be able to see the failed and passed incidents with clarity. User should be able to execute preprocessing and post processing hooks.

License

The gem is available as open source under the terms of the MIT License.