refactor audit csv exports for only audited items

Author: john-huang-121

app/controllers/audits_controller.rb

@@ -11,8 +11,7 @@ def index
     respond_to do |format|
       format.html
       format.csv do
-        inventory = View::Inventory.new(current_organization.id)
-        send_data Audit.generate_csv_from_inventory(@audits, inventory), filename: "Audits-#{Time.zone.today}.csv"
+        send_data Audit.generate_csv(@audits), filename: "Audits-#{Time.zone.today}.csv"
       end
     end
   end

app/models/audit.rb

@@ -50,26 +50,24 @@ def user_is_organization_admin_of_the_organization
     end
   end
 
-  def self.generate_csv_from_inventory(audits, inventory)
-    all_items = inventory.all_items.uniq(&:item_id).sort_by(&:name)
-    additional_headers = all_items.map(&:name).uniq
-    headers = csv_export_headers + additional_headers
+  def self.generate_csv(audits)
+    audited_items = audits.flat_map { |audit| audit.line_items.map(&:name) }.uniq
+    headers = csv_export_headers + audited_items
 
     CSV.generate(write_headers: true, headers: headers) do |csv|
       audits.map do |audit|
-        sl = audit.storage_location # preloaded earlier with includes to avoid n+1
-        total_quantity = inventory.quantity_for(storage_location: sl.id)
+        audit_hash = audited_items.index_with(0)
+        audit.line_items.each { |li| audit_hash[li.name] = li.quantity }
 
-        row = [audit.updated_at.strftime("%B %d %Y"), audit.status, sl.name, sl.address, sl.square_footage, sl.warehouse_type, total_quantity] +
-          all_items.map { |i| inventory.quantity_for(storage_location: sl.id, item_id: i.item_id) }
+        row = [audit.updated_at.strftime("%B %d %Y"), audit.status, audit.storage_location.name] + audit_hash.values
 
         csv << row.map { |attr| normalize_csv_attribute(attr) }
       end
     end
   end
 
   def self.csv_export_headers
-    ["Audit Date", "Audit Status", "Name", "Address", "Square Footage", "Warehouse Type", "Total Inventory"]
+    ["Audit Date", "Audit Status", "Storage Location Name"]
   end
 
   private

app/views/audits/index.html.erb

@@ -47,7 +47,7 @@
                 <%= clear_filter_button %>
 
                 <span class="float-right">
-                  <%= download_button_to(audits_path(format: :csv), {text: "Export Audit", size: "md"}) %>
+                  <%= download_button_to(audits_path(format: :csv), {text: "Export Audits", size: "md"}) %>
                   <%= new_button_to new_audit_path, {text: "New Audit"} %>
                 </span>
             <% end # form %>

docs/user_guide/bank/exports.md

@@ -92,19 +92,16 @@ For more information on these, please see the [Annual Survey Report](reports_ann
 - % difference in disposable diaper Donations
 
 ## Audits
-### Navigating to export Audit
-Click "Inventory", then "Inventory" in the left-hand menu. Then click "Export Report."
+### Navigating to export Audits
+Click "Inventory", then "Inventory Audit" in the left-hand menu. Then click "Export Audits".
 
 ### Contents of Audit exports
 For each Audit of Storage Location in the list:
 - Audit Date
 - Audit Status
-- Name,
-- Address,
-- Square Footage,
-- Warehouse Type,
-- Total Inventory, and
-- Quantity for each of the organization's Items.
+- Storage Location Name
+- Audited Items
+- Quantity for each of the audited items.
 
 ## Barcode Items
 ### Navigating to export barcode Items

spec/models/audit_spec.rb

@@ -128,29 +128,22 @@
       expect(Audit.finalized_since?(xfer3, storage_location5)).to be false # since status isn't finalized
     end
 
-    describe ".generate_csv_from_inventory" do
+    describe ".generate_csv" do
       let!(:audit) { create(:audit, :with_items, organization: organization) }
+      let!(:audit_2) { create(:audit, :with_items, organization: organization) }
       let(:sl) { audit.storage_location }
-      let(:inventory) { View::Inventory.new(organization.id) }
 
       it "generates a CSV" do
-        csv_data = described_class.generate_csv_from_inventory([audit], inventory)
+        csv_data = described_class.generate_csv([audit, audit_2])
 
         expect(csv_data).to be_a(String)
-
-        table = CSV.parse(csv_data)
-        header = table.first
-        row = table.second
-
-        expect(header).to eq(described_class.csv_export_headers)
-
-        expect(row[0]).to eq(audit.updated_at.strftime("%B %d %Y"))
-        expect(row[1]).to eq(audit.status)
-        expect(row[2]).to eq(sl.name)
-        expect(row[3]).to eq(sl.address)
-        expect(row[4]).to eq(sl.square_footage.to_s)
-        expect(row[5]).to eq(sl.warehouse_type.to_s)
-        expect(row[6]).to eq("0")
+        expect(csv_data).to eq(
+          <<~CSV
+            Audit Date,Audit Status,Storage Location Name,1Dont test this,2Dont test this
+            #{audit.updated_at.strftime("%B %d %Y")},#{audit.status},#{sl.name},#{audit.line_items.first.quantity},0
+            #{audit_2.updated_at.strftime("%B %d %Y")},#{audit_2.status},#{sl.name},0,#{audit_2.line_items.first.quantity}
+          CSV
+        )
       end
     end
   end

spec/requests/audits_requests_spec.rb

@@ -40,59 +40,23 @@
 
       context "csv" do
         let(:response_format) { 'csv' }
-        let!(:audits) do
-          [
-            create(:audit, organization: organization, storage_location: storage_location_with_duplicate_item),
-            create(:audit, organization: organization, storage_location: storage_location_with_items)
-          ]
-        end
-        let(:storage_location_with_duplicate_item) {
-          create(:storage_location,
-            name: "Storage Location with Duplicate Items",
-            address: "1500 Remount Road, Front Royal, VA 22630",
-            warehouse_type: StorageLocation::WAREHOUSE_TYPES.first,
-            square_footage: 100)
-        }
-        let(:storage_location_with_items) {
-          create(:storage_location,
-            name: "Storage Location with Items",
-            address: "123 Donation Site Way",
-            warehouse_type: StorageLocation::WAREHOUSE_TYPES.first,
-            square_footage: 100)
-        }
-        let(:item1) { create(:item, name: 'A') }
-        let(:item2) { create(:item, name: 'B') }
-        let(:item3) { create(:item, name: 'C') }
+        let(:csv_body) { "Stubbed CSV" }
 
         before do
-          TestInventory.create_inventory(storage_location_with_items.organization, {
-            storage_location_with_items.id => {
-              item1.id => 1,
-              item2.id => 1,
-              item3.id => 1
-            },
-            storage_location_with_duplicate_item.id => { item3.id => 1 }
-          })
+          allow(Audit).to receive(:generate_csv).and_return(csv_body)
         end
 
         it "succeeds" do
           get audits_path(format: response_format)
+          expect(response.content_type).to eq("text/csv")
           expect(response).to be_successful
         end
 
-        it "includes headers followed by alphabetized item names" do
+        it "returns a CSV" do
           get audits_path(format: response_format)
-          expect(response.body.split("\n")[0]).to eq([Audit.csv_export_headers, item1.name, item2.name, item3.name].join(','))
-        end
 
-        it "Generates csv with Storage Location fields, alphabetized item names, item quantities lined up in their columns, and zeroes for no inventory" do
-          get audits_path(format: response_format)
-          csv = <<~CSV
-            Audit Date,Audit Status,Name,Address,Square Footage,Warehouse Type,Total Inventory,A,B,C
-            #{audits[0].updated_at.strftime("%B %d %Y")},in_progress,Storage Location with Duplicate Items,"1500 Remount Road, Front Royal, VA 22630",100,Residential space used,1,0,0,1
-            #{audits[1].updated_at.strftime("%B %d %Y")},in_progress,Storage Location with Items,123 Donation Site Way,100,Residential space used,3,1,1,1
-          CSV
-          expect(response.body).to eq(csv)
+          expect(Audit).to have_received(:generate_csv)
+          expect(response.body).to eq(csv_body)
         end
       end
     end

spec/system/audit_system_spec.rb

@@ -135,9 +135,9 @@
     context "when viewing the audits index" do
       subject { audits_path }
 
-      it "should have the 'Export Audit' button" do
+      it "should have the 'Export Audits' button" do
         visit subject
-        expect(page).to have_content(" Export Audit")
+        expect(page).to have_content(" Export Audits")
       end
 
       it "should be able to filter the #index by storage location" do