-
-
Notifications
You must be signed in to change notification settings - Fork 471
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix #4138 fix delivery address #4540
Open
jimmyli97
wants to merge
9
commits into
rubyforgood:main
Choose a base branch
from
jimmyli97:4138-fix-delivery-address
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
4bb8332
REFACTOR group examples, remove rubocop disable lines,
jimmyli97 77b2a55
RED add rspec to test address output in distribution PDFs
jimmyli97 dcdc0f8
GREEN Fix #4138 address output changes based on delivery method
jimmyli97 aa38b4b
BUGFIX pdf now writes when test fails
jimmyli97 f1d7273
RED add rspec for when partner has no addresses
jimmyli97 d64acc4
GREEN don't print address if no address or delivery address
jimmyli97 4557128
Merge branch 'main' into 4138-fix-delivery-address
jimmyli97 0d53723
Add comments clarifying gitignore and comparison pdf helper rspec
jimmyli97 d722bca
Update bundler version
jimmyli97 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -801,4 +801,4 @@ DEPENDENCIES | |
webmock (~> 3.23) | ||
|
||
BUNDLED WITH | ||
2.5.16 | ||
2.5.18 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
Binary file not shown.
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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) } | ||
|
||
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 | ||
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,131 @@ | |
]) | ||
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) | ||
} | ||
let(:profile_name) { "Jaqueline Kihn DDS" } | ||
let(:profile_email) { "[email protected]" } | ||
# 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 partner has no addresses" do | ||
before(:each) do | ||
create(:partner_profile, | ||
partner_id: partner.id, | ||
primary_contact_name: profile_name, | ||
primary_contact_email: profile_email, | ||
address1: "", | ||
address2: "", | ||
city: "", | ||
state: "", | ||
zip_code: "", | ||
program_address1: "", | ||
program_address2: "", | ||
program_city: "", | ||
program_state: "", | ||
program_zip_code: "") | ||
end | ||
it "doesn't print any address if the delivery type is pickup" do | ||
compare_pdf(create_dist(:pick_up), expected_pickup_file) | ||
end | ||
it "doesn't print any address if the delivery type is delivery" do | ||
compare_pdf(create_dist(:delivery), expected_pickup_file) | ||
end | ||
it "doesn't print any address if the delivery type is shipped" do | ||
compare_pdf(create_dist(:shipped), 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 partner 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 | ||
context "when the partner 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 | ||
# this is written as a RSpec so we don't have duplicated code for setting up the RSpec test environment | ||
# call this test to generate PDFs from terminal by | ||
# 1) setting to `if true` | ||
# 2) calling the test's line number from terminal e.g. `bundle exec rspec spec/pdfs/distribution_pdf_spec.rb:228` | ||
# 3) disable the test afterwards by setting to `if false` | ||
# 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 |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's really confusing. If you want a helper method, why not define it as a method, and people can run it from the Rails console?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
to generate the pdf files correctly, the helper method generating the file needs to have the same test environment setup as the actual test itself. This way you don't have to repeat code setting up the test environment. I did research but I could not figure out a better way to do it without duplicating code.
you can call this method from the terminal by calling the test's line number e.g.
bundle exec rspec spec/pdfs/distribution_pdf_spec.rb:227
.I added a comment clarifying this in 0d53723
alternatively I could delete the method if you want, but I found it super helpful because I could just run that line whenever I made changes to the pdf generation and regenerate the test files. so if anyone in the future makes changes they could do the same thing.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There should definitely be a way to do this without duplicating code. Maybe it's the setup that needs to be extracted to a base method that's called from both places. And worse comes to worst, if you do need to duplicate a few lines of code, it's still a lot less messy than a test that's not actually a test.