Merge pull request #703 from rubyforgood/702-CSV-importing

Fixes #702: check if csv file is empty or has wrong headers

Author: seanmarcia

app/controllers/concerns/importable.rb

@@ -26,8 +26,13 @@ module Importable
   def import_csv
     if params[:file].present?
       data = File.read(params[:file].path, encoding: "BOM|UTF-8")
-      resource_model.import_csv(data, current_organization.id)
-      flash[:notice] = "#{resource_model_humanized} were imported successfully!"
+      csv = CSV.parse(data, headers: true).reject { |row| row.to_hash.values.any?(&:nil?) }
+      if csv.count.positive? && csv.first.headers.all? { |header| !header.nil? }
+        resource_model.import_csv(csv, current_organization.id)
+        flash[:notice] = "#{resource_model_humanized} were imported successfully!"
+      else
+        flash[:error] = "Check headers in file!"
+      end
     else
       flash[:error] = "No file was attached!"
     end

app/models/diaper_drive_participant.rb

@@ -39,8 +39,8 @@ def volume
     donations.map { |d| d.line_items.total }.reduce(:+)
   end
 
-  def self.import_csv(data, organization)
-    CSV.parse(data, headers: true) do |row|
+  def self.import_csv(csv, organization)
+    csv.each do |row|
       loc = DiaperDriveParticipant.new(row.to_hash)
       loc.organization_id = organization
       loc.save!

app/models/donation_site.rb

@@ -29,8 +29,8 @@ class DonationSite < ApplicationRecord
       .order(:name)
   }
 
-  def self.import_csv(data, organization)
-    CSV.parse(data, headers: true) do |row|
+  def self.import_csv(csv, organization)
+    csv.each do |row|
       loc = DonationSite.new(row.to_hash)
       loc.organization_id = organization
       loc.save!

app/models/partner.rb

@@ -29,8 +29,8 @@ class Partner < ApplicationRecord
   after_create :register_on_partnerbase
 
   # better to extract this outside of the model
-  def self.import_csv(data, organization_id)
-    CSV.parse(data, headers: true) do |row|
+  def self.import_csv(csv, organization_id)
+    csv.each do |row|
       hash_rows = Hash[row.to_hash.map { |k, v| [k.downcase, v] }]
       loc = Partner.new(hash_rows)
       loc.organization_id = organization_id

app/models/storage_location.rb

@@ -156,8 +156,8 @@ def distribute!(distribution)
     update_inventory_inventory_items(updated_quantities)
   end
 
-  def self.import_csv(data, organization)
-    CSV.parse(data, headers: true) do |row|
+  def self.import_csv(csv, organization)
+    csv.each do |row|
       loc = StorageLocation.new(row.to_hash)
       loc.organization_id = organization
       loc.save!

spec/fixtures/wrong_headers.csv

@@ -0,0 +1,4 @@
+name,email,,
+Partner 1,[email protected]
+Partner 2,[email protected]
+Partner 3,[email protected]

spec/models/diaper_drive_participant_spec.rb

@@ -52,7 +52,8 @@
       organization = create(:organization)
       import_file_path = Rails.root.join("spec", "fixtures", "diaper_drive_participants.csv")
       data = File.read(import_file_path, encoding: "BOM|UTF-8")
-      DiaperDriveParticipant.import_csv(data, organization.id)
+      csv = CSV.parse(data, headers: true)
+      DiaperDriveParticipant.import_csv(csv, organization.id)
       expect(DiaperDriveParticipant.count).to eq before_import + 3
     end
   end

spec/models/donation_site_spec.rb

@@ -30,7 +30,8 @@
       organization = create(:organization)
       import_file_path = Rails.root.join("spec", "fixtures", "donation_sites.csv")
       data = File.read(import_file_path, encoding: "BOM|UTF-8")
-      DonationSite.import_csv(data, organization.id)
+      csv = CSV.parse(data, headers: true)
+      DonationSite.import_csv(csv, organization.id)
       expect(DonationSite.count).to eq 3
     end
   end

spec/models/partner_spec.rb

@@ -64,15 +64,17 @@
       before_import = Partner.count
       import_file_path = Rails.root.join("spec", "fixtures", "partners.csv")
       data = File.read(import_file_path, encoding: "BOM|UTF-8")
-      Partner.import_csv(data, organization.id)
+      csv = CSV.parse(data, headers: true)
+      Partner.import_csv(csv, organization.id)
       expect(Partner.count).to eq before_import + 3
     end
 
     it "imports storage locations from a csv file with BOM encodings" do
       import_file_path = Rails.root.join("spec", "fixtures", "partners_with_bom_encoding.csv")
       data = File.read(import_file_path, encoding: "BOM|UTF-8")
+      csv = CSV.parse(data, headers: true)
       expect do
-        Partner.import_csv(data, organization.id)
+        Partner.import_csv(csv, organization.id)
       end.to change { Partner.count }.by(20)
     end
   end

spec/models/storage_location_spec.rb

@@ -198,7 +198,8 @@
         before_import = StorageLocation.count
         import_file_path = Rails.root.join("spec", "fixtures", "storage_locations.csv")
         data = File.read(import_file_path, encoding: "BOM|UTF-8")
-        StorageLocation.import_csv(data, organization.id)
+        csv = CSV.parse(data, headers: true)
+        StorageLocation.import_csv(csv, organization.id)
         expect(StorageLocation.count).to eq before_import + 3
       end
     end