[BE Tools] RuboCop – Fix RuboCop violations so the to-do file is empty

[jeff2d2]

As of 11/1: 30 issues fixed.

Problem Statement

RuboCop provides many safety checks and best practices for use in vets-api. We're currently ignoring ~3000 RuboCop violations. Some of these are legitimate and should be ignored, but the bulk of them should not be and should be properly addressed.

How might we eliminate the illegitimately ignored RuboCop violations, to ensure that the proper safety checks and best practices are in place?

Hypothesis or Bet

We believe completing this initiative will significantly contribute to solving Objective 3.

If we eliminate the illegitimately ignored RuboCop violations, then we expect:

• Increased code readability and maintainability
• Increased VFS team satisfaction

We will know we're done when... ("Definition of Done")

We’ll know we’re successful when:

• [ ] Zero legitimate RuboCop violations are being ignored.

Known Blockers/Dependencies

• TBD

Projected Launch Date

Q4 2021

Launch Checklist

Guidance (delete before posting)

This checklist is intended to be used to help answer, "is my VSP initiative ready for launch?". All of the items in this checklist should be completed, with artifacts linked---or have a brief explanation of why they've been skipped---before launching a given VSP initiative. All links or explanations can be provided in Required Artifacts sections. The items that can be skipped are marked as such.

Keep in mind the distinction between Product and Initiative --- each Product needs specific supporting documentation, but Initiatives to improve existing Products should reuse existing documentation for that Product. VSP Product Terminology for details.

Is this service / tool / feature...

... tested?

• [ ] Usability test (TODO: link) has been performed, to validate that new changes enable users to do what was intended and that these changes don't worsen quality elsewhere. If usability test isn't relevant for this change, document the reason for skipping it.
  • [ ] ... and issues discovered in usability testing have been addressed.
  • Note on skipping: metrics that show the impact of before/after can be a substitute for usability testing.
• [ ] End-to-end manual QA or UAT is complete, to validate there are no high-severity issues before launching
• [ ] (if applicable) New functionality has thorough, automated tests running in CI/CD

... documented?

• [ ] New documentation is written pursuant to our documentation style guide
• [ ] Product is included in the List of VSP Products
  • List the existing product that this initiative fits within, or add a new product to this list.
• [ ] Internal-facing: there's a Product Outline checked into products/platform/PRODUCT_NAME/
  • Note: the Product Directory Name should match 1:1 with the List of VSP Products
• [ ] External-facing: a VFS-facing README exists for this product/feature tool
  • [ ] ... and should be located at platform/PRODUCT_NAME/README.md
• [ ] External-facing: a User Guide exists for this product/feature/tool, and is updated for changes from this initiative
  • [ ] ... and should be linked from the VFS-facing README for your product
  • [ ] ... and should be located within platform/PRODUCT_NAME/, unless you already have another location for it
  • [ ] (if applicable)... and post to #vsp-content-ia about whether this should be added to the Documentation homepage
• [ ] (if applicable) Post to #vsp-service-design for external communication about this change (e.g. VSP Newsletter, customer-facing meetings)

... measurable

• [ ] (if applicable) This change has clearly-defined success metrics, with instrumentation of those analytics where possible, or a reason documented for skipping it.
  • For help, see: Analytics team
• [ ] This change has an accompanying VSP Initiative Release Plan.

Required Artifacts

Documentation

• PRODUCT_NAME: directory name used for your product documentation
• Product Outline: link to Product Outline
• README: link to VFS-facing README for your product
• User Guide: link to User Guide

Testing

• Usability test: link to GitHub issue, or provide reason for skipping
• Manual QA: link to GitHub issue or documented results
• Automated tests: link to tests, or "N/A"

Measurement

• Success metrics: link to where success metrics are measured, or where they're defined (Product Outline is OK), or provide reason for skipping
• Release plan: link to Release Plan ticket

TODOs

• [x] Convert this issue to an epic
• [x] Add your team's label to this epic

[jeff2d2]

Stories to complete:

1. Discovery on which cops have the fewest offenses and are auto-correctable. Create list/sheet of all that need attention. Decide if some should turn into their own stories.
2. Figure out at the beginning of each sprint which ones we'd like to tackle in that sprint.