active_admin_excel_upload 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 337bcac793c6bdd8aa517b13808502d69139bb9b
-  data.tar.gz: e43dc70e3611487c96f18feeaa3a74ac68a850cd
+  metadata.gz: 2aa53db46cafcd3a4577834b6d3d2a5c0ba19a24
+  data.tar.gz: 9df562b957c30174e9db058e02b47a034bcd275a
 SHA512:
-  metadata.gz: 7a1ba5e0ab1ab2914d46e949bafe303a9a1fec291b47bd788ea3aa5edeafc10edab702bbb4774d9c954ff7ca6326fb921e00820ce0b7ab722a5aa3f67c08b4a2
-  data.tar.gz: 0ecc1def5227899b7147cb14238d2a34268a197a2ca4ab84bf077bcb2a54c5e56da550404bc08d2fd442427f4eb7adcb95d0acd06a95afb4f9d31843dde83a49
+  metadata.gz: f775b0a480e53e0e0991acc37bd0d7a89b3e01438410e63a0f51d41f618dea29752b985bf9297ce0d10cb854f0673e6aebebd467e35cdddbae7194299c5a6222
+  data.tar.gz: 86e39b7be4890ebbb035991dbf4834b4d372d958c052fafc2e926c667c6df35de35648da94089c932d7ddd2cbf45d5b8072fcfe5ad8ee3d187779f4fc6eaf85d

data/README.md

@@ -1,8 +1,14 @@
-# ActiveAdminExcelUpload
-Short description and motivation.
+# 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.
 
-## Usage
-How to use my plugin.
+
+## prerequisites
+```ruby
+  active-admin,
+  Devise,
+  Rails 5,
+  redis
+  ```
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -21,6 +27,81 @@ Or install it yourself as:
 $ gem install active_admin_excel_upload
 ```
 
+##Config generator
+```bash
+$rails g active_admin_excel_upload:install
+```
+
+## Usage
+configure your active admin resource to use it.
+
+```ruby
+# RAILS_ROOT/app/admin/post.rb
+ActiveAdmin.register Post do
+  excel_importable         
+end
+```
+set your queue backend in application.rb
+```ruby
+  config.active_job.queue_adapter = :sidekiq
+```
+You can use any queuing backend e.g resque etc.
+
+You may need redis adapter in cable.yml to work it in dev mode. By default rails uses redis adaper for production mode.
+```ruby
+  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
+
+```ruby
+  ActiveAdminExcelUpload.configure do |config|
+    config.use_default_connecion_authentication = false
+    config.connection_identifier = :current_admin_user
+  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
+
+```ruby
+  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 cureated 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.
+
+```ruby
+  ActionCable.server.broadcast channel_name, message: "Successfully cureated record for #{row}, id: #{record.id}"
+```
+This particular line is used to broadcast messsages on particular channel.
+
+By default it sends string as message but you can render anuthing you want. e.g
+
+``` ruby
+ApplicationController.renderer.render(partial: 'messages/message', locals: { message: message })
+```
+
 ## Contributing
 Contribution directions go here.
 

data/app/assets/javascripts/active_admin_excel_upload/channels/excel.coffee

@@ -7,13 +7,17 @@ App.room = App.cable.subscriptions.create "ActiveAdminExcelUpload::ExcelChannel"
 
   received: (data) ->
     # Called when there's incoming data on the websocket for this channel
-    para = document.createElement("P");
-    t = document.createTextNode(data["message"]);
-    para.appendChild(t);
-    para.style.borderBottom = "1px solid lightgrey";
-    para.style.margin = "0px";
-    para.style.padding= "10px";
-    document.getElementById("show_status").appendChild(para);
+    searchParams = new URLSearchParams(window.location.search);
+    model = searchParams.get("model")
+    modelInMessage = data.message.match("\\[(\\w+\)]")[1]
+    if model == modelInMessage
+      para = document.createElement("P");
+      t = document.createTextNode(data["message"].match("\\[(\\w+\)](.*)")[2]);
+      para.appendChild(t);
+      para.style.borderBottom = "1px solid lightgrey";
+      para.style.margin = "0px";
+      para.style.padding= "10px";
+      document.getElementById("show_status").appendChild(para);
 
   speak: ->
     @perform 'speak'

data/lib/active_admin_excel_upload.rb

@@ -4,6 +4,7 @@ require "active_admin_excel_upload/dsl"
 require "active_admin_excel_upload/railtie"
 require "active_admin_excel_upload/authenticable"
 require "active_admin_excel_upload/excel_parsable"
+require "roo"
 module ActiveAdminExcelUpload
   class << self
    attr_accessor :configuration
@@ -25,4 +26,14 @@ module ActiveAdminExcelUpload
      @connection_identifier = :current_admin_user
    end
   end
+
+
+  # find a better place for this method
+  def self.move_file_to_rails_tmp(params)
+    file_name = DateTime.now.to_s + params[:dump][:file].original_filename
+    tmp = params[:dump][:file].tempfile
+    final_path = Rails.root.join('tmp', file_name)
+    FileUtils.move tmp.path, final_path
+    return final_path
+  end
 end

data/lib/active_admin_excel_upload/dsl.rb

@@ -11,14 +11,10 @@ module ActiveAdminExcelUpload
       collection_action :excel_upload_result do
         render "admin/excel/excel_result"
       end
-
       collection_action :import_excel, :method => :post do
-        file_name = DateTime.now.to_s + params[:dump][:file].original_filename
-        tmp = params[:dump][:file].tempfile
-        final_path = Rails.root.join('tmp', file_name)
-        FileUtils.move tmp.path, final_path
+        final_path = ActiveAdminExcelUpload.move_file_to_rails_tmp(params)
         ExcelParserJob.perform_later(self.resource_class.to_s,final_path.to_s,self.send(ActiveAdmin.application.current_user_method))
-        redirect_to :action => :excel_upload_result, :notice => "CSV imported successfully!"
+        redirect_to :action => :excel_upload_result,:model => self.resource_class.to_s
       end
     end
   end

data/lib/active_admin_excel_upload/excel_parsable.rb

@@ -3,31 +3,38 @@ module ActiveAdminExcelUpload
     extend ActiveSupport::Concern
 
     class_methods do
+      def publish_to_channel(channel_name,message)
+        message = "[#{self.to_s}]#{message}"
+        ActionCable.server.broadcast channel_name, message: message
+      end
+
       def excel_create_record(row, index, header,channel_name)
-        ActionCable.server.broadcast channel_name, message: "processing for #{row}"
+        self.publish_to_channel(channel_name, "processing for #{row}")
         object = Hash[header.zip row]
         record = self.new(object)
         if record.save
-          ActionCable.server.broadcast channel_name, message: "Successfully cureated record for #{row}, id: #{record.id}"
+          self.publish_to_channel(channel_name,"Successfully cureated record for #{row}, id: #{record.id}")
         else
-          ActionCable.server.broadcast channel_name, message: "Could not create record for #{row}, error: #{record.errors.messages}"
+          self.publish_to_channel(channel_name,"Could not create record for #{row}, error: #{record.errors.messages}")
         end
       end
+
+
       def excel_process_sheet(sheet,current_admin_user)
         xlsx = Roo::Spreadsheet.open(sheet)
         sheet = xlsx.sheet(xlsx.sheets.index(self.table_name))
         header = sheet.row(1)
         channel_name = "excel_channel_#{current_admin_user.id}"
         header_downcase = header.map(&:parameterize).map(&:underscore)
-        ActionCable.server.broadcast channel_name, message: "Start processing sheet #{self.table_name}"
+        self.publish_to_channel(channel_name,"Start processing sheet #{self.table_name}")
         sheet.parse.each_with_index do |row, index|
           begin
             self.excel_create_record(row,index,header_downcase,channel_name)
           rescue StandardError => e
-            ActionCable.server.broadcast channel_name, message: "Exception while processing #{row}, Exception: #{e.message}"
+            self.publish_to_channel(channel_name,"Exception while processing #{row}, Exception: #{e.message}")
           end
         end
-        ActionCable.server.broadcast channel_name, message: "End processing sheet #{self.table_name}"
+        self.publish_to_channel(channel_name, "End processing sheet #{self.table_name}")
       end
     end
   end

data/lib/active_admin_excel_upload/version.rb

@@ -1,3 +1,3 @@
 module ActiveAdminExcelUpload
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/lib/generators/active_admin_excel_upload/install_generator.rb

@@ -0,0 +1,14 @@
+module ActiveAdminExcelUpload
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+      desc "Creates ActiveAdminExcelUpload initializer for your application"
+
+      def copy_initializer
+        template "active_admin_excel_uplaod_initializer.rb", "config/initializers/active_admin_excel_uplaod.rb"
+
+        puts "Install complete! Truly Outrageous!"
+      end
+    end
+  end
+end

data/lib/generators/templates/active_admin_excel_uplaod_initializer.rb

@@ -0,0 +1,4 @@
+ActiveAdminExcelUpload.configure do |config|
+  config.use_default_connecion_authentication = true
+  config.connection_identifier = :current_admin_user
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_admin_excel_upload
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Shiv Garg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-08 00:00:00.000000000 Z
+date: 2018-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coffee-rails
@@ -38,20 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.7.0
-- !ruby/object:Gem::Dependency
-  name: pg
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: active_admin_excel_upload gem brings convention over configuration for
   your excel uploads. This gem is designed to process your excel sheet on a active
   job and display the results live using action cables
@@ -87,6 +73,8 @@ files:
 - lib/active_admin_excel_upload/excel_parsable.rb
 - lib/active_admin_excel_upload/railtie.rb
 - lib/active_admin_excel_upload/version.rb
+- lib/generators/active_admin_excel_upload/install_generator.rb
+- lib/generators/templates/active_admin_excel_uplaod_initializer.rb
 - lib/tasks/active_admin_excel_upload_tasks.rake
 homepage: https://github.com/shivgarg5676/active_admin_excel_upload
 licenses:
@@ -108,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Excel upload for active admin resources using background jobs and action