Fix #4138 fix delivery address

.gitignore

@@ -49,6 +49,7 @@ dump.rdb
 .DS_Store
 .ruby-gemset
 *.pdf
+!spec/fixtures/files/*.pdf
 /spec/example_failures.txt
 
 # Ignore Docker stuff (see issues #503, #603)

app/pdfs/distribution_pdf.rb

@@ -36,23 +36,39 @@ def compute_and_render
       text @distribution.partner.name
       move_up 24
 
+      profile = @distribution.partner.profile
+
       text "Partner Primary Contact:", style: :bold, align: :right
       font_size 12
-      text @distribution.partner.profile.primary_contact_name, align: :right
+      text profile.primary_contact_name, align: :right
       font_size 10
-      text @distribution.partner.profile.primary_contact_email, align: :right
-      text @distribution.partner.profile.primary_contact_phone, align: :right
+      text profile.primary_contact_email, align: :right
+      text profile.primary_contact_phone, align: :right
       move_down 10
 
-      if %w(shipped delivered).include?(@distribution.delivery_method)
+      if @distribution.delivery? || @distribution.shipped?
+        if profile.program_address1.blank?
+          address1 = profile.address1
+          address2 = profile.address2
+          city = profile.city
+          state = profile.state
+          zip_code = profile.zip_code
+        else
+          address1 = profile.program_address1
+          address2 = profile.program_address2
+          city = profile.program_city
+          state = profile.program_state
+          zip_code = profile.program_zip_code.to_s
+        end
+
         move_up 10
         text "Delivery address:", style: :bold
         font_size 10
-        text @distribution.partner.profile.address1
-        text @distribution.partner.profile.address2
-        text @distribution.partner.profile.city
-        text @distribution.partner.profile.state
-        text @distribution.partner.profile.zip_code
+        text address1
+        text address2
+        text city
+        text state
+        text zip_code
         move_up 40
 
         text "Issued on:", style: :bold, align: :right

spec/pdfs/distribution_pdf_spec.rb

@@ -1,54 +1,100 @@
-# avoid Rubocop failing with an infinite loop when it checks this cop
-# rubocop:disable Layout/ArrayAlignment
+require_relative("../support/distribution_pdf_helper")
+
+RSpec.configure do |c|
+  c.include DistributionPDFHelper
+end
+
 describe DistributionPdf do
-  let(:organization) { create(:organization) }
-  let(:distribution) { create(:distribution, organization: organization) }
-  let(:item1) { FactoryBot.create(:item, name: "Item 1", package_size: 50, value_in_cents: 100) }
-  let(:item2) { FactoryBot.create(:item, name: "Item 2", value_in_cents: 200) }
-  let(:item3) { FactoryBot.create(:item, name: "Item 3", value_in_cents: 300) }
-  let(:item4) { FactoryBot.create(:item, name: "Item 4", package_size: 25, value_in_cents: 400) }
-
-  let(:org_hiding_packages_and_values) do
-    FactoryBot.create(:organization, name: DEFAULT_TEST_ORGANIZATION_NAME,
-      hide_value_columns_on_receipt: true, hide_package_column_on_receipt: true)
-  end
-  let(:org_hiding_packages) { FactoryBot.create(:organization, name: DEFAULT_TEST_ORGANIZATION_NAME, hide_package_column_on_receipt: true) }
-  let(:org_hiding_values) { FactoryBot.create(:organization, name: DEFAULT_TEST_ORGANIZATION_NAME, hide_value_columns_on_receipt: true) }
-
-  before(:each) do
-    create(:line_item, itemizable: distribution, item: item1, quantity: 50)
-    create(:line_item, itemizable: distribution, item: item2, quantity: 100)
-    create(:request, distribution: distribution,
-      request_items: [{"item_id" => item2.id, "quantity" => 30},
-        {"item_id" => item3.id, "quantity" => 50}, {"item_id" => item4.id, "quantity" => 120}])
-  end
+  let(:organization) {
+    create(:organization,
+      name: "Essentials Bank 1",
+      street: "1500 Remount Road",
+      city: "Front Royal",
+      state: "VA",
+      zipcode: "22630",
+      email: "[email protected]")
+  }
 
-  specify "#request_data" do
-    results = described_class.new(organization, distribution).request_data
-    expect(results).to eq([
-      ["Items Received", "Requested", "Received", "Value/item", "In-Kind Value Received", "Packages"],
-      ["Item 1", "", 50, "$1.00", "$50.00", "1"],
-      ["Item 2", 30, 100, "$2.00", "$200.00", nil],
-      ["Item 3", 50, "", "$3.00", nil, nil],
-      ["Item 4", 120, "", "$4.00", nil, nil],
-      ["", "", "", "", ""],
-      ["Total Items Received", 200, 150, "", "$250.00", ""]
-    ])
-  end
+  let(:storage_location) { create(:storage_location, organization: organization) }
 
-  specify "#non_request_data" do
-    results = described_class.new(organization, distribution).non_request_data
-    expect(results).to eq([
-      ["Items Received", "Value/item", "In-Kind Value", "Quantity", "Packages"],
-      ["Item 1", "$1.00", "$50.00", 50, "1"],
-      ["Item 2", "$2.00", "$200.00", 100, nil],
-      ["", "", "", "", ""],
-      ["Total Items Received", "", "$250.00", 150, ""]
-    ])
-  end
+  let(:item1) { create(:item, name: "Item 1", package_size: 50, value_in_cents: 100) }
+  let(:item2) { create(:item, name: "Item 2", value_in_cents: 200) }
+  let(:item3) { create(:item, name: "Item 3", value_in_cents: 300) }
+  let(:item4) { create(:item, name: "Item 4", package_size: 25, value_in_cents: 400) }
+
+  describe "pdf item and column displays" do
+    let(:org_hiding_packages_and_values) {
+      create(:organization, name: DEFAULT_TEST_ORGANIZATION_NAME,
+        hide_value_columns_on_receipt: true, hide_package_column_on_receipt: true)
+    }
+    let(:org_hiding_packages) { create(:organization, name: DEFAULT_TEST_ORGANIZATION_NAME, hide_package_column_on_receipt: true) }
+    let(:org_hiding_values) { create(:organization, name: DEFAULT_TEST_ORGANIZATION_NAME, hide_value_columns_on_receipt: true) }
+
+    let(:distribution) { create(:distribution, organization: organization, storage_location: storage_location) }
 
-  context "with request data" do
-    describe "#hide_columns" do
+    before(:each) do
+      create_line_items_request(distribution)
+    end
+
+    specify "#request_data" do
+      results = described_class.new(organization, distribution).request_data
+      expect(results).to eq([
+        ["Items Received", "Requested", "Received", "Value/item", "In-Kind Value Received", "Packages"],
+        ["Item 1", "", 50, "$1.00", "$50.00", "1"],
+        ["Item 2", 30, 100, "$2.00", "$200.00", nil],
+        ["Item 3", 50, "", "$3.00", nil, nil],
+        ["Item 4", 120, "", "$4.00", nil, nil],
+        ["", "", "", "", ""],
+        ["Total Items Received", 200, 150, "", "$250.00", ""]
+      ])
+    end
+
+    specify "#non_request_data" do
+      results = described_class.new(organization, distribution).non_request_data
+      expect(results).to eq([
+        ["Items Received", "Value/item", "In-Kind Value", "Quantity", "Packages"],
+        ["Item 1", "$1.00", "$50.00", 50, "1"],
+        ["Item 2", "$2.00", "$200.00", 100, nil],
+        ["", "", "", "", ""],
+        ["Total Items Received", "", "$250.00", 150, ""]
+      ])
+    end
+
+    context "with request data" do
+      describe "#hide_columns" do
+        it "hides value and package columns when true on organization" do
+          pdf = described_class.new(org_hiding_packages_and_values, distribution)
+          data = pdf.request_data
+          pdf.hide_columns(data)
+          expect(data).to eq([
+            ["Items Received", "Requested", "Received"],
+            ["Item 1", "", 50],
+            ["Item 2", 30, 100],
+            ["Item 3", 50, ""],
+            ["Item 4", 120, ""],
+            ["", "", ""],
+            ["Total Items Received", 200, 150]
+          ])
+        end
+
+        it "hides value columns when true on organization" do
+          pdf = described_class.new(org_hiding_values, distribution)
+          data = pdf.request_data
+          pdf.hide_columns(data)
+          expect(data).to eq([
+            ["Items Received", "Requested", "Received", "Packages"],
+            ["Item 1", "", 50, "1"],
+            ["Item 2", 30, 100, nil],
+            ["Item 3", 50, "", nil],
+            ["Item 4", 120, "", nil],
+            ["", "", ""],
+            ["Total Items Received", 200, 150, ""]
+          ])
+        end
+      end
+    end
+
+    context "with non request data" do
       it "hides value and package columns when true on organization" do
         pdf = described_class.new(org_hiding_packages_and_values, distribution)
         data = pdf.request_data
@@ -79,56 +125,97 @@
         ])
       end
     end
+    context "regardles of request data" do
+      describe "#hide_columns" do
+        it "hides package column when true on organization" do
+          pdf = described_class.new(org_hiding_packages, distribution)
+          data = pdf.request_data
+          pdf.hide_columns(data)
+          expect(data).to eq([
+            ["Items Received", "Requested", "Received", "Value/item", "In-Kind Value Received"],
+            ["Item 1", "", 50, "$1.00", "$50.00"],
+            ["Item 2", 30, 100, "$2.00", "$200.00"],
+            ["Item 3", 50, "", "$3.00", nil],
+            ["Item 4", 120, "", "$4.00", nil],
+            ["", "", "", "", ""],
+            ["Total Items Received", 200, 150, "", "$250.00"]
+          ])
+        end
+      end
+    end
   end
 
-  context "with non request data" do
-    it "hides value and package columns when true on organization" do
-      pdf = described_class.new(org_hiding_packages_and_values, distribution)
-      data = pdf.request_data
-      pdf.hide_columns(data)
-      expect(data).to eq([
-        ["Items Received", "Requested", "Received"],
-        ["Item 1", "", 50],
-        ["Item 2", 30, 100],
-        ["Item 3", 50, ""],
-        ["Item 4", 120, ""],
-        ["", "", ""],
-        ["Total Items Received", 200, 150]
-      ])
-    end
+  describe "address pdf output" do
+    let(:partner) {
+      create(:partner, :uninvited, without_profile: true,
+        name: "Leslie Sue",
+        organization: organization)
+    }
+    # there is a helper test at the bottom to regenerate these PDFs easily
+    let(:expected_pickup_file_path) { Rails.root.join("spec", "fixtures", "files", "distribution_pickup.pdf") }
+    let(:expected_pickup_file) { IO.binread(expected_pickup_file_path) }
+    let(:expected_same_address_file_path) { Rails.root.join("spec", "fixtures", "files", "distribution_same_address.pdf") }
+    let(:expected_same_address_file) { IO.binread(expected_same_address_file_path) }
+    let(:expected_different_address_file_path) { Rails.root.join("spec", "fixtures", "files", "distribution_program_address.pdf") }
+    let(:expected_different_address_file) { IO.binread(expected_different_address_file_path) }
 
-    it "hides value columns when true on organization" do
-      pdf = described_class.new(org_hiding_values, distribution)
-      data = pdf.request_data
-      pdf.hide_columns(data)
-      expect(data).to eq([
-        ["Items Received", "Requested", "Received", "Packages"],
-        ["Item 1", "", 50, "1"],
-        ["Item 2", 30, 100, nil],
-        ["Item 3", 50, "", nil],
-        ["Item 4", 120, "", nil],
-        ["", "", ""],
-        ["Total Items Received", 200, 150, ""]
-      ])
+    context "when the organization doesn't have a different program address" do
+      before(:each) do
+        create_profile_without_program_address
+      end
+      it "prints the address if the delivery type is delivery" do
+        compare_pdf(create_dist(:delivery), expected_same_address_file)
+      end
+      it "prints the address if the delivery type is shipped" do
+        compare_pdf(create_dist(:shipped), expected_same_address_file)
+      end
+      it "doesn't print the address if the delivery type is pickup" do
+        compare_pdf(create_dist(:pick_up), expected_pickup_file)
+      end
     end
-  end
-  context "regardles of request data" do
-    describe "#hide_columns" do
-      it "hides package column when true on organization" do
-        pdf = described_class.new(org_hiding_packages, distribution)
-        data = pdf.request_data
-        pdf.hide_columns(data)
-        expect(data).to eq([
-          ["Items Received", "Requested", "Received", "Value/item", "In-Kind Value Received"],
-          ["Item 1", "", 50, "$1.00", "$50.00"],
-          ["Item 2", 30, 100, "$2.00", "$200.00"],
-          ["Item 3", 50, "", "$3.00", nil],
-          ["Item 4", 120, "", "$4.00", nil],
-          ["", "", "", "", ""],
-          ["Total Items Received", 200, 150, "", "$250.00"]
-        ])
+    context "when the organization has a different program/delivery address" do
+      before(:each) do
+        create_profile_with_program_address
+      end
+      it "prints the delivery address if the delivery type is delivery" do
+        compare_pdf(create_dist(:delivery), expected_different_address_file)
+      end
+      it "prints the delivery address if the delivery type is shipped" do
+        compare_pdf(create_dist(:shipped), expected_different_address_file)
+      end
+      it "doesn't print any address if the delivery type is pickup" do
+        compare_pdf(create_dist(:pick_up), expected_pickup_file)
+      end
+    end
+    # this test is a helper function to regenerate expected PDFs, only commit with it skipped
+    # rubocop:disable Lint/LiteralAsCondition
+    if false
+      # rubocop:enable Lint/LiteralAsCondition
+      it "skip this helper function for regenerating the expected pdfs", type: :request do
+        user = create(:user, organization: organization)
+        sign_in(user)
+
+        profile = create_profile_without_program_address
+
+        dist = create_dist(:pick_up)
+        get print_distribution_path(dist)
+        File.binwrite(expected_pickup_file_path, response.body)
+        dist.destroy
+
+        dist = create_dist(:shipped)
+        get print_distribution_path(dist)
+        File.binwrite(expected_same_address_file_path, response.body)
+        dist.destroy
+
+        profile.destroy
+        create_profile_with_program_address
+
+        dist = create_dist(:shipped)
+        get print_distribution_path(dist)
+        File.binwrite(expected_different_address_file_path, response.body)
+
+        raise "Do not commit this helper function"
       end
     end
   end
 end
-# rubocop:enable Layout/ArrayAlignment

spec/support/distribution_pdf_helper.rb

@@ -0,0 +1,51 @@
+module DistributionPDFHelper
+  private def create_profile(program_address1, program_address2, program_city, program_state, program_zip)
+    create(:partner_profile,
+      partner_id: partner.id,
+      primary_contact_name: "Jaqueline Kihn DDS",
+      primary_contact_email: "[email protected]",
+      address1: "Example Address 1",
+      address2: "",
+      city: "Example City",
+      state: "Example State",
+      zip_code: "12345",
+      program_address1: program_address1,
+      program_address2: program_address2,
+      program_city: program_city,
+      program_state: program_state,
+      program_zip_code: program_zip)
+  end
+
+  def create_profile_without_program_address
+    create_profile("", "", "", "", "")
+  end
+
+  def create_profile_with_program_address
+    create_profile("Example Program Address 1", "", "Example Program City", "Example Program State", 54321)
+  end
+
+  def create_line_items_request(distribution)
+    create(:line_item, itemizable: distribution, item: item1, quantity: 50)
+    create(:line_item, itemizable: distribution, item: item2, quantity: 100)
+    create(:request, distribution: distribution,
+      request_items: [{"item_id" => item2.id, "quantity" => 30},
+        {"item_id" => item3.id, "quantity" => 50}, {"item_id" => item4.id, "quantity" => 120}])
+  end
+
+  def create_dist(delivery_method)
+    dist = create(:distribution, partner: partner, delivery_method: delivery_method, issued_at: DateTime.new(2024, 7, 4, 0, 0), organization: organization, storage_location: storage_location)
+    create_line_items_request(dist)
+    dist
+  end
+
+  def compare_pdf(distribution, expected_file)
+    pdf = DistributionPdf.new(organization, distribution)
+    begin
+      pdf_file = pdf.compute_and_render
+      expect(pdf_file).to eq(expected_file)
+    rescue RSpec::Expectations::ExpectationNotMetError => e
+      File.binwrite(Rails.root.join("tmp", "failed_match_distribution_" + delivery_method.to_s + "_" + Time.current.to_s + ".pdf"), pdf_file)
+      raise e.class, "PDF does not match, written to tmp/", cause: nil
+    end
+  end
+end