Add feature to print unfulfilled requests as a picklists PDF #4598

norrismei · 2024-08-16T06:15:51Z

Resolves #4406

Description

Stakeholder asked for new functionality that allows printing a single file containing all outstanding requests so that pickers may use the documents as picklists, checking off as they go and making note of any differences.

When an organization goes to their Requests, there will now be a Print Unfulfilled Picklists button next to the Export Requests button.

Design decisions made:

Page numbers are based on the number of pages in the PDF file instead of numbering each request page 1 of 1 or 1 of 2 because if somehow the pages were scrambled up, we'd want a way of putting them back in order vs. risking not being able to identify multiple non-descript 2 of 2 pages.
Format of the Picklists PDF follows the Distribution PDF closely. The OpenSans font does not support checkboxes so I chose to go with [ ] (open and close brackets) to get the job done with minimal effort.
Filename of PDF is Picklists_#{Date}_#{Time}.pdf in case the file is generated and printed multiple times in a day, we'd want different file names based on time.

Things to note

It takes a little while for the PDF to generate in the testing site because there are 180+ outstanding requests. A query was ran to see how many outstanding requests a real bank would have on average. We're assuming about 10 outstanding requests on average, with the most being 44 requests at the time of the query.

Type of change

New feature (non-breaking change which adds functionality)

How Has This Been Tested?

I manually tested the following scenarios:

With packs enabled, the PDF should have the Units (if applicable) column.
To enable, I pointed my browser to http://localhost:3000/flipper and logged in
userid: admin
password: password
The PDF shows Partner Pickup Person if there is one listed under the Partner settings. I logged in as a Partner to toggle this setting.

Screenshots

No packs enabled and no partner pickup person:

With packs enabled and no partner pickup person:

With packs enabled and a partner pickup person listed:

Index page with print button displaying unfulfilled requests count

awwaiid · 2024-08-25T04:32:38Z

Ready for a review @norrismei?

norrismei · 2024-08-29T18:55:21Z

@awwaiid There are a few changes I need to make and then I'll fill out the PR description and mark this ready for review.

cielf

Hey @norrismei! Good job so far!

I am a little concerned about perceived performance (prod is slower than our locals), but I'll let @awwaiid / @dorner chime in on that from a technical pov.

(Edit: I could see adding the number of requests that will be in the picklist into the button. Just as an indication of what they are getting into.)

One other question -- does this include "started" requests?

cielf · 2024-09-01T15:25:53Z

@norrismei Please do change the button to have the number of unfulfilled requests..

e.g. Print Unfulfilled Picklists (44)

dorner

Great first pass!

app/controllers/requests_controller.rb

config/routes.rb

norrismei · 2024-09-03T23:58:01Z

@cielf I added the number of unfulfilled requests to the print button, and yes, unfulfilled requests includes "started" requests.

@dorner I scoped the query to the organization (thanks for catching) and updated statuses to be more obvious. Awaiting clarity on item_requests vs request_items.

cielf · 2024-09-12T18:42:26Z

Hey @norrismei - just noting that the lint is failing -- just a wee thing to change there.

cielf · 2024-09-12T18:43:48Z

@norrismei, but do please change to @item_requests -- we are going to be stripping out request_items entirely in the near future.

I think I'll hold off on a final functional check until that's in.

dorner

This needs a unit test please!

app/pdfs/picklists_pdf.rb

app/controllers/requests_controller.rb

app/pdfs/picklists_pdf.rb

app/views/requests/index.html.erb

norrismei · 2024-09-24T07:18:15Z

@dorner unit tests added. Both for the PDF and the button on the index page

cielf

LGTM from a functional pov.

cielf · 2024-09-28T17:08:01Z

@norrismei FYI: We had an urgent fix that required all the senior contributors this week , so we didn't get to look at this again. Hopefully this week will go better.

dorner

One minor comment. Otherwise this looks great!

spec/factories/partners.rb

Addressed!

awwaiid

Looks great! Thank you :)

awwaiid · 2024-09-01T15:22:39Z

app/controllers/requests_controller.rb

@@ -40,6 +40,20 @@ def start
    redirect_to new_distribution_path(request_id: request.id)
  end

+  def print_unfulfilled
+    requests = Request.includes(partner: [:profile]).where(status: [0, 1])


Note to self -- is there something more explicit than 0 and 1?

awwaiid · 2024-09-01T15:26:47Z

app/views/requests/index.html.erb

+                  <% if @requests.any? { |request| request.status == "pending" || request.status == "started" } %>
+                    <%= print_button_to(
+                      print_unfulfilled_requests_path(format: :pdf),
+                      text: "Print Unfulfilled Picklists",


Maybe add a count so they know what to expect. "Print Unfulfilled Picklists (34 partner requests)"

Ahh -- this needs to pass the filter through for the pdf to also apply.

github-actions · 2024-10-20T16:48:01Z

@norrismei: Your PR Add feature to print unfulfilled requests as a picklists PDF is part of today's Human Essentials production release: 2024.10.20.
Thank you very much for your contribution!

norrismei marked this pull request as draft August 16, 2024 06:17

norrismei force-pushed the 4406-add-print-picklists branch 6 times, most recently from da53d82 to 69135be Compare August 18, 2024 07:43

awwaiid added this to the Request Units (Packs) milestone Aug 25, 2024

norrismei force-pushed the 4406-add-print-picklists branch from db42034 to 419a86c Compare August 29, 2024 21:28

norrismei marked this pull request as ready for review August 29, 2024 21:35

norrismei changed the title ~~[WIP] Add feature to print unfulfilled requests as a picklists PDF~~ Add feature to print unfulfilled requests as a picklists PDF Aug 29, 2024

cielf reviewed Aug 30, 2024

View reviewed changes

cielf requested a review from awwaiid August 30, 2024 16:13

dorner requested changes Sep 2, 2024

View reviewed changes

app/controllers/requests_controller.rb Outdated Show resolved Hide resolved

config/routes.rb Outdated Show resolved Hide resolved

norrismei force-pushed the 4406-add-print-picklists branch 3 times, most recently from c1f35e8 to 84c788b Compare September 3, 2024 23:52

norrismei force-pushed the 4406-add-print-picklists branch 2 times, most recently from 5b31977 to 03a7b79 Compare September 12, 2024 07:16

norrismei force-pushed the 4406-add-print-picklists branch 2 times, most recently from 826d4ec to 61aada6 Compare September 13, 2024 06:15

norrismei requested review from dorner and cielf September 13, 2024 06:30

dorner requested changes Sep 13, 2024

View reviewed changes

norrismei added 10 commits September 22, 2024 13:07

Show units column if using custom units

a20ae72

Support multiple requests in one PDF

a193f67

Replace Request.item_requests with RequestItem instead

9cf8a88

Add fixed width for table and quantity and checkbox columns

7ddcfec

lint

409df7e

Display unfulfilled count in button

a12d0c9

Scope query to org and use item_requests instead of request_items

4685938

Clarify using line_items instead of actual items

a09facb

Remove finding item by id because there are associations

71b84d7

Replace exists? with check for count

a643e2a

norrismei force-pushed the 4406-add-print-picklists branch 3 times, most recently from 854389f to b385ba2 Compare September 24, 2024 07:01

Add unit tests for PDF and index page

a537810

norrismei force-pushed the 4406-add-print-picklists branch from b385ba2 to a537810 Compare September 24, 2024 07:04

norrismei requested a review from dorner September 24, 2024 07:17

cielf reviewed Sep 24, 2024

View reviewed changes

dorner previously requested changes Sep 30, 2024

View reviewed changes

spec/factories/partners.rb Outdated Show resolved Hide resolved

norrismei force-pushed the 4406-add-print-picklists branch from 8243bad to 9173819 Compare October 4, 2024 17:50

Remove pick_up_person trait

8439cc2

norrismei force-pushed the 4406-add-print-picklists branch from fe12dfa to 8439cc2 Compare October 4, 2024 18:05

Merge branch 'main' into 4406-add-print-picklists

3a73391

norrismei requested a review from dorner October 4, 2024 18:25

Merge branch 'main' into 4406-add-print-picklists

cf557c6

awwaiid approved these changes Oct 13, 2024

View reviewed changes

awwaiid merged commit 5fe25bb into rubyforgood:main Oct 13, 2024
11 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add feature to print unfulfilled requests as a picklists PDF #4598

Add feature to print unfulfilled requests as a picklists PDF #4598

norrismei commented Aug 16, 2024 •

edited

Loading

awwaiid commented Aug 25, 2024

norrismei commented Aug 29, 2024

cielf left a comment •

edited

Loading

cielf commented Sep 1, 2024

dorner left a comment

norrismei commented Sep 3, 2024

cielf commented Sep 12, 2024

cielf commented Sep 12, 2024 •

edited

Loading

dorner left a comment

norrismei commented Sep 24, 2024

cielf left a comment

cielf commented Sep 28, 2024

dorner left a comment

awwaiid left a comment

awwaiid Sep 1, 2024

awwaiid Sep 1, 2024

awwaiid Sep 1, 2024

github-actions bot commented Oct 20, 2024

Add feature to print unfulfilled requests as a picklists PDF #4598

Add feature to print unfulfilled requests as a picklists PDF #4598

Conversation

norrismei commented Aug 16, 2024 • edited Loading

Description

Things to note

Type of change

How Has This Been Tested?

Screenshots

awwaiid commented Aug 25, 2024

norrismei commented Aug 29, 2024

cielf left a comment • edited Loading

Choose a reason for hiding this comment

cielf commented Sep 1, 2024

dorner left a comment

Choose a reason for hiding this comment

norrismei commented Sep 3, 2024

cielf commented Sep 12, 2024

cielf commented Sep 12, 2024 • edited Loading

dorner left a comment

Choose a reason for hiding this comment

norrismei commented Sep 24, 2024

cielf left a comment

Choose a reason for hiding this comment

cielf commented Sep 28, 2024

dorner left a comment

Choose a reason for hiding this comment

awwaiid left a comment

Choose a reason for hiding this comment

awwaiid Sep 1, 2024

Choose a reason for hiding this comment

awwaiid Sep 1, 2024

Choose a reason for hiding this comment

awwaiid Sep 1, 2024

Choose a reason for hiding this comment

github-actions bot commented Oct 20, 2024

norrismei commented Aug 16, 2024 •

edited

Loading

cielf left a comment •

edited

Loading

cielf commented Sep 12, 2024 •

edited

Loading