Adapt adjustments specs to test csv export text and use module method

Author: cyang-el

app/models/adjustment.rb

@@ -37,10 +37,8 @@ def split_difference
   def self.generate_csv(adjustments)
     return nil if adjustments.empty?
 
-    Exports::ExportAdjustmentsCSVService.new(
-      adjustments: adjustments,
-      organization: adjustments.first.organization
-    ).generate_csv
+    Exports::ExportAdjustmentsCSVService
+      .generate_csv(adjustments, adjustments.first.organization)
   end
 
   private

app/services/exports/export_adjustments_csv_service.rb

@@ -1,52 +1,48 @@
 module Exports
-  class ExportAdjustmentsCSVService
-    def initialize(adjustments:, organization:)
-      @adjustments = adjustments
-      @organization = organization
-    end
-
-    def generate_csv
-      CSV.generate(headers: true) do |csv|
-        generate_csv_data.each { |row| csv << row }
+  module ExportAdjustmentsCSVService
+    class << self
+      def generate_csv(adjustments, organization)
+        CSV.generate(headers: true) do |csv|
+          generate_csv_data(adjustments, organization).each { |row| csv << row }
+        end
       end
-    end
 
-    def generate_csv_data
-      [headers] + @adjustments.map { |adjustment| build_row(adjustment) }
-    end
+      def generate_csv_data(adjustments, organization)
+        item_names = get_item_names(organization)
+        headers = [
+          "Created date", "Storage Area",
+          "Comment", "# of changes"
+        ] + item_names
 
-    private
+        [headers] + adjustments.map { |adjustment| build_row(adjustment, item_names) }
+      end
 
-    def headers
-      [
-        "Created date", "Storage Area",
-        "Comment", "# of changes"
-      ] + item_names
-    end
+      private
 
-    def item_names
-      @organization.items.order(:name).pluck(:name).uniq
-    end
+      def get_item_names(organization)
+        organization.items.order(:name).pluck(:name).uniq
+      end
 
-    def build_row(adjustment)
-      row = [
-        adjustment.created_at.strftime("%F"),
-        adjustment.storage_location.name,
-        adjustment.comment,
-        adjustment.line_items.count { |item| !item.quantity.eql?(0) }
-      ]
+      def build_row(adjustment, item_names)
+        row = [
+          adjustment.created_at.strftime("%F"),
+          adjustment.storage_location.name,
+          adjustment.comment,
+          adjustment.line_items.count { |item| !item.quantity.eql?(0) }
+        ]
 
-      item_quantities = Hash.new(0)
+        item_quantities = Hash.new(0)
 
-      adjustment.line_items.each do |line_item|
-        item_quantities[line_item.item.name] += line_item.quantity
-      end
+        adjustment.line_items.each do |line_item|
+          item_quantities[line_item.item.name] += line_item.quantity
+        end
 
-      item_names.each do |item_name|
-        row << item_quantities[item_name]
-      end
+        item_names.each do |item_name|
+          row << item_quantities[item_name]
+        end
 
-      row
+        row
+      end
     end
   end
 end

spec/requests/adjustments_requests_spec.rb

@@ -1,4 +1,4 @@
-RSpec.describe "Adjustments", :wip, type: :request do
+RSpec.describe "Adjustments", type: :request do
   let(:organization) { create(:organization) }
   let(:user) { create(:user, organization: organization) }
 
@@ -104,29 +104,14 @@
           expect(response.header['Content-Type']).to include 'text/csv'
         end
 
-        it "includes appropriate headers for adjustments" do
-          expect(response.body).to include("Created date")
-          expect(response.body).to include("Storage Area")
-          expect(response.body).to include("Comment")
-          expect(response.body).to include("# of changes")
-          expect(response.body).to include(item1.name)
-          expect(response.body).to include(item2.name)
-        end
-
-        it "includes data from the adjustments" do
-          parsed_csv = CSV.parse(response.body, headers: true)
-
-          expect(parsed_csv.count).to eq(2)
+        it "includes appropriate headers and data" do
+          csv = <<~CSV
+            Created date,Storage Area,Comment,# of changes,#{item1.name},#{item2.name}
+            2019-06-30,Smithsonian Conservation Center,First adjustment,2,10,5
+            2019-06-26,Smithsonian Conservation Center,Second adjustment,1,-5,0
+          CSV
 
-          expect(parsed_csv[0]["Comment"]).to eq(adjustment1.comment)
-          expect(parsed_csv[1]["Comment"]).to eq(adjustment2.comment)
-
-          expect(parsed_csv[0][item1.name]).to eq("10")
-          expect(parsed_csv[0][item2.name]).to eq("5")
-          expect(parsed_csv[0]["# of changes"]).to eq("2")
-
-          expect(parsed_csv[1][item1.name]).to eq("-5")
-          expect(parsed_csv[1]["# of changes"]).to eq("1")
+          expect(response.body).to eq(csv)
         end
 
         context "when filtering by date" do
@@ -136,9 +121,12 @@
 
             get adjustments_path, params: { filters: { date_range: "#{start_date} - #{end_date}" }, format: 'csv' }
 
-            parsed_csv = CSV.parse(response.body, headers: true)
-            expect(parsed_csv.count).to eq(1)
-            expect(parsed_csv[0]["Comment"]).to eq(adjustment1.comment)
+            csv = <<~CSV
+              Created date,Storage Area,Comment,# of changes,#{item1.name},#{item2.name}
+              2019-06-30,Smithsonian Conservation Center,First adjustment,2,10,5
+            CSV
+
+            expect(response.body).to eq(csv)
           end
         end
       end

spec/services/exports/export_adjustments_csv_service_spec.rb

@@ -1,4 +1,4 @@
-RSpec.describe Exports::ExportAdjustmentsCSVService, :wip do
+RSpec.describe Exports::ExportAdjustmentsCSVService do
   # Create organization after items to ensure proper associations
   let!(:item1) { create(:item, name: "item1") }
   let!(:item2) { create(:item, name: "item2") }
@@ -19,18 +19,17 @@
     [item1, item2, item3, item4, item5].map(&:name).sort
   end
 
-  let(:expected_headers) do
-    [
-      "Created date", "Storage Area",
-      "Comment", "# of changes"
-    ] + sorted_item_names
-  end
-
   let(:storage_location) { create(:storage_location, organization: organization) }
   let(:user) { create(:user, organization: organization) }
 
+  around do |example|
+    travel_to Time.zone.local(2024, 12, 25)
+    example.run
+    travel_back
+  end
+
   describe "#generate_csv_data" do
-    subject { described_class.new(adjustments: adjustments, organization: organization).generate_csv_data }
+    subject { described_class.generate_csv(adjustments, organization) }
 
     context "with multiple adjustments and items" do
       let(:adjustments) do
@@ -67,114 +66,28 @@
         ]
       end
 
-      it "should have the expected headers" do
-        expect(subject[0]).to eq(expected_headers)
-      end
-
-      it "should include the adjustment data in the rows" do
-        # Check 1st adjustment
-        expect(subject[1]).to include(
-          adjustments[0].created_at.strftime("%F"),
-          storage_location.name,
-          "adjustment 1",
-          2  # Number of items changed
-        )
-
-        # Check 2nd adjustment
-        expect(subject[2]).to include(
-          adjustments[1].created_at.strftime("%F"),
-          storage_location.name,
-          "adjustment 2",
-          1  # Number of items changed
-        )
-
-        # Check 3rd adjustment
-        expect(subject[3]).to include(
-          adjustments[2].created_at.strftime("%F"),
-          storage_location.name,
-          "adjustment 3",
-          1  # Number of items changed
-        )
-      end
-
-      it "should include the correct item quantities" do
-        # Get indexes of item quantity columns
-        item1_idx = expected_headers.index(item1.name)
-        item2_idx = expected_headers.index(item2.name)
-        item3_idx = expected_headers.index(item3.name)
-        item4_idx = expected_headers.index(item4.name)
-        item5_idx = expected_headers.index(item5.name)
-
-        # Check 1st adjustment
-        expect(subject[1][item1_idx]).to eq(10)
-        expect(subject[1][item2_idx]).to eq(-5)
-        expect(subject[1][item3_idx]).to eq(0)
-        expect(subject[1][item4_idx]).to eq(0)
-        expect(subject[1][item5_idx]).to eq(0)
+      it "should include the correct adjustment data" do
+        csv = <<~CSV
+          Created date,Storage Area,Comment,# of changes,item1,item2,item3,item4,item5
+          2024-12-25,Smithsonian Conservation Center,adjustment 1,2,10,-5,0,0,0
+          2024-12-25,Smithsonian Conservation Center,adjustment 2,1,0,0,3,0,0
+          2024-12-25,Smithsonian Conservation Center,adjustment 3,1,7,0,0,0,0
+        CSV
 
-        # Check 2nd adjustment
-        expect(subject[2][item1_idx]).to eq(0)
-        expect(subject[2][item2_idx]).to eq(0)
-        expect(subject[2][item3_idx]).to eq(3)
-        expect(subject[2][item4_idx]).to eq(0)
-        expect(subject[2][item5_idx]).to eq(0)
-
-        # Check 3rd adjustment
-        expect(subject[3][item1_idx]).to eq(7)
-        expect(subject[3][item2_idx]).to eq(0)
-        expect(subject[3][item3_idx]).to eq(0)
-        expect(subject[3][item4_idx]).to eq(0)
-        expect(subject[3][item5_idx]).to eq(0)
-      end
-
-      it "should correctly sum up the number of changes" do
-        idx = expected_headers.index("# of changes")
-        expect(subject[1][idx]).to eq(2)
-        expect(subject[2][idx]).to eq(1)
-        expect(subject[3][idx]).to eq(1)
+        expect(subject).to eq(csv)
       end
     end
 
     context "when there are no adjustments" do
       let(:adjustments) { [] }
 
       it "returns only headers row" do
-        expect(subject.size).to eq(1)
-        expect(subject[0]).to eq(expected_headers)
-      end
-    end
-  end
+        csv = <<~CSV
+          Created date,Storage Area,Comment,# of changes,item1,item2,item3,item4,item5
+        CSV
 
-  describe "#generate_csv" do
-    subject { described_class.new(adjustments: adjustments, organization: organization).generate_csv }
-
-    let(:adjustments) do
-      [
-        create(:adjustment,
-          storage_location: storage_location,
-          organization: organization,
-          line_items_attributes: [
-            {item_id: item1.id, quantity: 111},
-            {item_id: item2.id, quantity: -7}
-          ])
-      ]
-    end
-
-    it "generates valid CSV data" do
-      expect(subject).to be_a(String)
-      parsed_csv = CSV.parse(subject, headers: true)
-      expect(parsed_csv.headers).to include("Created date",
-        "Storage Area",
-        "Comment",
-        "# of changes",
-        item1.name,
-        item2.name,
-        item3.name,
-        item4.name)
-
-      expect(parsed_csv.first["# of changes"]).to eq("2")
-      expect(parsed_csv.first[item1.name]).to eq("111")
-      expect(parsed_csv.first[item2.name]).to eq("-7")
+        expect(subject).to eq(csv)
+      end
     end
   end
 end