Rubocop linter for "enhanced" analytics events

[matthinz]

🛠 Summary of changes

I wrote this linter originally as part of #10230, but that PR was getting very complicated so I pulled it out here.

Background

Idv::AnalyticsEventsEnhancer will "enhance" certain analytics logging methods by automatically filling in more arguments. Currently, that is limited to proofing_components, but that will be expanding in the future (e.g. LG-12617).

We want these "enhanced" arguments to be present in method signatures so that:

• We aren't over-relying on **extra
• Our analytics methods are documented properly

What this PR does

This PR adds a Rubocop Cop that looks at analytics_events.rb and verifies all of these "enhanced" arguments are:

1. Included in the signatures of the relevant methods
2. Passed through to track_event properly
3. Have a corresponding @param documentation line

There is also some autocorrecting built in, since I was originally thinking I'd be making lots of changes to analytics_events.rb.

📜 Testing Plan

Provide a checklist of steps to confirm the changes.

• Remove a method from Idv::AnalyticsEventsEnhancer::IGNORED_METHODS
• Run rubocop: rubocop --cache false app/services/analytics_events.rb
• Verify you get some errors about proofing_components not being present in method signature
• Fix the errors: rubocop --cache false -a app/services/analytics_events.rb
• Verify that all the issues are fixed

[zachmargolis]

very nice! big fan of leveraging automation for this

[aduth]

Is this something that #9946 could cover? We currently hide most errors from that with the allowed_extra_analytics, but I'd assume if we remove that from IdV specs we could uncover this?

The main downside I see to #9946 is that it requires that something actually calls the analytics methods, but I'd expect that's just a basic test coverage problem?

[matthinz]

@aduth Yeah, that is a good point. I originally had in mind making large-scale changes to analytics_events.rb as part of another PR. In my mind the Rubocop stuff is nice because of the autocorrect functionality--you can use it to automate those kind of code modifications.

I'm ok not actually landing this right now, and bringing it back if we want to investigate strategies for managing analytics_events.rb (like eventually getting rid of **extra or something).

[matthinz]

Closing this for now. I did find some of this useful for working on #10270 but may not be worth landing on main and committing long-term