DEV-562, report count of commitments by phase & org

[mwarin]

What?

Originating ticket: DEV-562

This PR is primarily adding a new report class (Reports::SharedPrintPhaseCount), that gives a count of how many commitments per organization given a phase.

So, if umich has 100 phase 3 commitments and smu has 50, and we make a phase 3 report using this new class, we expect an output file with:

organization  |phase  |commitment_count
smu           |3      |50
umich         |3      |100

(pipes and spacing added here for human readability)

Also taking this time to add a module for simplifying report output location (Utils::ReportOutput), which is starting to bug me.
If successful/useful we can (on a rainy day) start implementing in the other report scripts.

How?

If you want to run the tests:

git clone https://github.com/hathitrust/holdings-backend.git
cd holdings-backend
git fetch
git checkout DEV-562
# Start bash sesh.
bash bin/setup/setup_dev.sh
docker-compose up -d pushgateway
# Start up a shell with a profile loaded
docker-compose run --rm -e MONGOID_ENV=test dev bash

# you are now in a holdings-backend shell
# run the tests
bundle exec rspec spec/reports/shared_print_phase_count_spec.rb spec/utils/report_output_spec.rb

# run a report (which will be empty unless you load some data):
bash phctl.sh report shared-print-phase-count --inline

# When bash sesh is over: do cleanup.
docker-compose down; yes

Why?

The reporting script is simply needed.

The util script is not strictly needed, but it allows any given script that produces output files to not have to figure out where to put those files, how to name them, or know/care much about the directory structure. This also standardizes timestamps in filenames, and automatically adds a short unique-enough-ish string to avoid filename collisions.

Files changed

4 all new files:

• lib/reports/shared_print_phase_count.rb : report script, the main payload of this PR
• spec/reports/shared_print_phase_count_spec.rb test for report script
• lib/utils/report_output.rb util class to potentially simplify report outputs
• spec/utils/report_output_spec.rb test for util class

2 minimally edited files to make report script runnable from phctl.sh:

• lib/phctl.rb
• lib/sidekiq_jobs.rb

Reviewing/Testing

I'm mostly looking for a sanity check of the tests and the util class.

From @aelkiss I am most interested in what you think about ReportOutput as a solution for simplifying reports, since you did the trick for the temporary spec-ouputs.

[coveralls]

coverage: 95.012% (+0.06%) from 94.951% when pulling 198668f on DEV-562 into 7952406 on main.

[aelkiss]

I left a few suggestions; in particular I would like to remove the mkdir parameter from Utils::ReportOutput#dir.

[mwarin]

@aelkiss I think I addressed all of your feedback. Thanks for catching the missing tests!