Fix #4138 fix delivery address (#4540)

* REFACTOR group examples, remove rubocop disable lines,

* group examples together with variables
* rubocop -A passes on this file without needing to disable ArrayAlignment

* RED add rspec to test address output in distribution PDFs

* Compare generated against expected PDFs
* Add helper test to regenerate expected PDFs
* Add helper module

* GREEN Fix #4138 address output changes based on delivery method

* Address output prints delivery address if filled in, otherwise partner address
* Only does this for delivery/shipped method

* BUGFIX pdf now writes when test fails

* RED add rspec for when partner has no addresses

* REFACTOR out profile name and email

* GREEN don't print address if no address or delivery address

* Add comments clarifying gitignore and comparison pdf helper rspec

* Update bundler version

* REFACTOR replace helper test with environment variable

* Use environment variable for regenerating comparison pdfs

* update schema date and bundler version

* RED remove env variable code, stub out console helper method

* GREEN add Rails console method for generating comparison pdfs, update comparison PDFs

* Replace instance vars with structs and let

* FIX destroy request so db is clean, use destroy! instead so exceptions fire

* Replace FactoryBot with calling ActiveModel.create, move methods to lib/

* Fix formatting when address is incomplete, add rspecs, create and delete item units correctly when generating test files

* FIX replace with space if partner primary contact name/email/phone is blank

* Add rspec
* Other comparison pdfs change because previously blank phone # skipped line,
  now blank phone # adds a blank line
* Move instance_method call inside function

* FIX spacing between issued to and delivery address

* RED Make methods module instead of instance

* Move helper compare_pdf method into Rspec group
* Failing tests are due to Items received year to date being inaccurate in new year

* GREEN fix test and comparison pdf generation errors

* travel_to time when creating distribution so Items received YTD is always the same
* use public_send
* regenerate comparison PDFs, contents are identical, only binaries differ (possibly because of prawn-rails update to 1.6.0?)
* write expected_file_path to filename when outputting non matching PDF

* Fix linting, use block for travel_to

* Switch to using transactions with rollback to clean up

* Remove accidental duped tests on merge, move merged test into example group

Author: jimmyli97

.gitignore

@@ -51,6 +51,9 @@ dump.rdb
 *.pdf
 /spec/example_failures.txt
 
+# Track, don't ignore, RSpec comparison PDFs
+!spec/fixtures/files/*.pdf
+
 # Ignore Docker stuff (see issues #503, #603)
 Dockerfile
 docker-compose.yml

Gemfile.lock

@@ -255,6 +255,7 @@ GEM
       concurrent-ruby (~> 1.1)
       webrick (~> 1.7)
       websocket-driver (~> 0.7)
+    ffi (1.17.0)
     ffi (1.17.0-arm64-darwin)
     ffi (1.17.0-x86_64-darwin)
     ffi (1.17.0-x86_64-linux-gnu)
@@ -374,6 +375,7 @@ GEM
     method_source (1.1.0)
     mini_magick (4.13.2)
     mini_mime (1.1.5)
+    mini_portile2 (2.8.8)
     minitest (5.25.4)
     monetize (1.12.0)
       money (~> 6.12)
@@ -404,6 +406,9 @@ GEM
       net-protocol
     newrelic_rpm (9.16.0)
     nio4r (2.7.4)
+    nokogiri (1.18.1)
+      mini_portile2 (~> 2.8.2)
+      racc (~> 1.4)
     nokogiri (1.18.1-arm64-darwin)
       racc (~> 1.4)
     nokogiri (1.18.1-x86_64-darwin)
@@ -717,6 +722,7 @@ PLATFORMS
   arm64-darwin-21
   arm64-darwin-22
   arm64-darwin-23
+  ruby
   x86_64-darwin-20
   x86_64-darwin-21
   x86_64-darwin-22

app/pdfs/distribution_pdf.rb

@@ -1,3 +1,5 @@
+require "prawn/table"
+
 # Configures a Prawn PDF template for generating Distribution manifests
 class DistributionPdf
   include Prawn::View
@@ -31,42 +33,53 @@ def compute_and_render
         text @organization.email, align: :right
       end
 
-      text "Issued to:", style: :bold
-      font_size 12
-      text @distribution.partner.name
-      move_up 24
+      profile = @distribution.partner.profile
 
+      font_size 12
       text "Partner Primary Contact:", style: :bold, align: :right
+      text (profile.primary_contact_name.presence || " "), align: :right
+      font_size 10
+      text (profile.primary_contact_email.presence || " "), align: :right
+      text (profile.primary_contact_phone.presence || " "), align: :right
+      move_up 40
+
+      text "Issued to:", style: :bold
       font_size 12
-      text @distribution.partner.profile.primary_contact_name, align: :right
+      text @distribution.partner.name
       font_size 10
-      text @distribution.partner.profile.primary_contact_email, align: :right
-      text @distribution.partner.profile.primary_contact_phone, align: :right
       move_down 10
 
-      if %w(shipped delivered).include?(@distribution.delivery_method)
-        move_up 10
+      if (profile.address1.present? || profile.program_address1.present?) &&
+          (@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
+
         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
-        move_up 40
-
-        text "Issued on:", style: :bold, align: :right
-        font_size 12
-        text @distribution.distributed_at, align: :right
-        font_size 10
-        move_down 30
-      else
-        text "Issued on:", style: :bold
-        font_size 12
-        text @distribution.distributed_at
-        font_size 10
+        text address1
+        text address2
+        text city
+        text state
+        text zip_code
       end
 
+      move_down 10
+      text "Issued on:", style: :bold
+      font_size 12
+      text @distribution.distributed_at
+      font_size 10
+
       if @organization.ytd_on_distribution_printout
         move_up 22
         text "Items Received Year-to-Date:", style: :bold, align: :right

lib/test_helpers/pdf_comparison_test_factory.rb

@@ -0,0 +1,164 @@
+require "active_support/testing/time_helpers"
+
+module PDFComparisonTestFactory
+  extend ActiveSupport::Testing::TimeHelpers
+
+  StorageCreation = Data.define(:organization, :storage_location, :items)
+  FilePaths = Data.define(:expected_pickup_file_path, :expected_same_address_file_path, :expected_different_address_file_path, :expected_incomplete_address_file_path, :expected_no_contact_file_path)
+
+  def self.get_logo_file
+    Rack::Test::UploadedFile.new(Rails.root.join("spec/fixtures/files/logo.jpg"), "image/jpeg")
+  end
+
+  def self.create_organization_storage_items(logo = get_logo_file)
+    org = Organization.create!(
+      name: "Essentials Bank 1",
+      short_name: "db",
+      street: "1500 Remount Road",
+      city: "Front Royal",
+      state: "VA",
+      zipcode: "22630",
+      email: "[email protected]",
+      logo: logo
+    )
+
+    storage_location = StorageLocation.create!(
+      name: "Smithsonian Conservation Center",
+      address: "1500 Remount Road, Front Royal, VA 22630",
+      organization: org
+    )
+
+    base_item = BaseItem.find_or_create_by!(name: "10T Diapers", partner_key: "10t_diapers")
+
+    item1 = Item.create!(name: "Item 1", package_size: 50, value_in_cents: 100, organization: org, partner_key: base_item.partner_key)
+    item2 = Item.create!(name: "Item 2", value_in_cents: 200, organization: org, partner_key: base_item.partner_key)
+    item3 = Item.create!(name: "Item 3", value_in_cents: 300, organization: org, partner_key: base_item.partner_key)
+    item4 = Item.create!(name: "Item 4", package_size: 25, value_in_cents: 400, organization: org, partner_key: base_item.partner_key)
+
+    StorageCreation.new(org, storage_location, [item1, item2, item3, item4])
+  end
+
+  def self.create_partner(organization)
+    Partner.create!(name: "Leslie Sue", organization: organization, email: "[email protected]")
+  end
+
+  def self.get_file_paths
+    expected_pickup_file_path = Rails.root.join("spec", "fixtures", "files", "distribution_pickup.pdf")
+    expected_same_address_file_path = Rails.root.join("spec", "fixtures", "files", "distribution_same_address.pdf")
+    expected_different_address_file_path = Rails.root.join("spec", "fixtures", "files", "distribution_program_address.pdf")
+    expected_incomplete_address_file_path = Rails.root.join("spec", "fixtures", "files", "distribution_incomplete_address.pdf")
+    expected_no_contact_file_path = Rails.root.join("spec", "fixtures", "files", "distribution_no_contact.pdf")
+    FilePaths.new(expected_pickup_file_path, expected_same_address_file_path, expected_different_address_file_path, expected_incomplete_address_file_path, expected_no_contact_file_path)
+  end
+
+  private_class_method def self.create_profile(partner:, program_address1:, program_address2:, program_city:, program_state:, program_zip:,
+    address1: "Example Address 1", city: "Example City", state: "Example State", zip: "12345", primary_contact_name: "Jaqueline Kihn DDS", primary_contact_email: "[email protected]")
+    Partners::Profile.create!(
+      partner_id: partner.id,
+      essentials_bank_id: partner.organization.id,
+      primary_contact_name: primary_contact_name,
+      primary_contact_email: primary_contact_email,
+      address1: address1,
+      address2: "",
+      city: city,
+      state: state,
+      zip_code: zip,
+      program_address1: program_address1,
+      program_address2: program_address2,
+      program_city: program_city,
+      program_state: program_state,
+      program_zip_code: program_zip
+    )
+  end
+
+  def self.create_profile_no_address(partner)
+    create_profile(partner: partner, program_address1: "", program_address2: "", program_city: "", program_state: "", program_zip: "", address1: "", city: "", state: "", zip: "")
+  end
+
+  def self.create_profile_without_program_address(partner)
+    create_profile(partner: partner, program_address1: "", program_address2: "", program_city: "", program_state: "", program_zip: "")
+  end
+
+  def self.create_profile_with_program_address(partner)
+    create_profile(partner: partner, program_address1: "Example Program Address 1", program_address2: "", program_city: "Example Program City", program_state: "Example Program State", program_zip: 54321)
+  end
+
+  def self.create_profile_with_incomplete_address(partner)
+    create_profile(partner: partner, program_address1: "Example Program Address 1", program_address2: "", program_city: "", program_state: "", program_zip: "")
+  end
+
+  def self.create_profile_no_contact_with_program_address(partner)
+    create_profile(partner: partner, program_address1: "Example Program Address 1", program_address2: "", program_city: "Example Program City", program_state: "Example Program State", program_zip: 54321, primary_contact_name: "", primary_contact_email: "")
+  end
+
+  def self.create_line_items_request(distribution, partner, storage_creation)
+    LineItem.create!(itemizable: distribution, item: storage_creation.items[0], quantity: 50)
+    LineItem.create!(itemizable: distribution, item: storage_creation.items[1], quantity: 100)
+    storage_creation.organization.request_units.find_or_create_by!(name: "pack")
+    ItemUnit.find_or_create_by!(item: storage_creation.items[3], name: "pack")
+    req1 = Partners::ItemRequest.new(item: storage_creation.items[1], quantity: 30, name: storage_creation.items[1].name, partner_key: storage_creation.items[1].partner_key)
+    req2 = Partners::ItemRequest.new(item: storage_creation.items[2], quantity: 50, name: storage_creation.items[2].name, partner_key: storage_creation.items[2].partner_key)
+    req3 = Partners::ItemRequest.new(item: storage_creation.items[3], quantity: 120, name: storage_creation.items[3].name, partner_key: storage_creation.items[3].partner_key, request_unit: "pack")
+    Request.create!(
+      organization: storage_creation.organization,
+      partner: partner,
+      distribution: distribution,
+      request_items: [
+        {"item_id" => storage_creation.items[1].id, "quantity" => 30},
+        {"item_id" => storage_creation.items[2].id, "quantity" => 50},
+        {"item_id" => storage_creation.items[3].id, "quantity" => 120, "request_unit" => "pack"}
+      ],
+      item_requests: [req1, req2, req3]
+    )
+  end
+
+  def self.create_dist(partner, storage_creation, delivery_method)
+    Time.zone = "America/Los_Angeles"
+    dist = Distribution.create!(partner: partner, delivery_method: delivery_method, issued_at: DateTime.new(2024, 7, 4, 0, 0, 0, "-07:00"), organization: storage_creation.organization, storage_location: storage_creation.storage_location)
+    create_line_items_request(dist, partner, storage_creation)
+    dist
+  end
+
+  def self.render_pdf_at_year_end(organization, distribution)
+    travel_to(Time.zone.local(2024, 12, 30, 0, 0, 0)) do
+      return DistributionPdf.new(organization, distribution).compute_and_render
+    end
+  end
+
+  private_class_method def self.create_comparison_pdf(storage_creation, profile_create_method, expected_file_path, delivery_method)
+    # Partner creation must be rolled back otherwise Items requested YTD will accumulate
+    ActiveRecord::Base.transaction(requires_new: true) do
+      partner = create_partner(storage_creation.organization)
+      PDFComparisonTestFactory.public_send(profile_create_method, partner)
+      dist = create_dist(partner, storage_creation, delivery_method)
+      pdf_file = render_pdf_at_year_end(storage_creation.organization, dist)
+      File.binwrite(expected_file_path, pdf_file)
+      raise ActiveRecord::Rollback
+    end
+  end
+
+  # helper function that can be called from Rails console to generate comparison PDFs
+  def self.create_comparison_pdfs
+    file_paths = get_file_paths
+
+    # ActiveStorage throws FileNotFoundError in a transaction
+    # unless logo is uploaded before transaction
+    logo = ActiveStorage::Blob.create_and_upload!(
+      io: get_logo_file,
+      filename: "logo.jpg",
+      content_type: "image/jpeg"
+    )
+
+    ActiveRecord::Base.transaction do
+      storage_creation = create_organization_storage_items(logo)
+
+      create_comparison_pdf(storage_creation, :create_profile_no_address, file_paths.expected_pickup_file_path, :pick_up)
+      create_comparison_pdf(storage_creation, :create_profile_without_program_address, file_paths.expected_same_address_file_path, :shipped)
+      create_comparison_pdf(storage_creation, :create_profile_with_program_address, file_paths.expected_different_address_file_path, :delivery)
+      create_comparison_pdf(storage_creation, :create_profile_with_incomplete_address, file_paths.expected_incomplete_address_file_path, :delivery)
+      create_comparison_pdf(storage_creation, :create_profile_no_contact_with_program_address, file_paths.expected_no_contact_file_path, :delivery)
+
+      raise ActiveRecord::Rollback
+    end
+  end
+end