Add opt-in CodeTeams test helpers #23
Open
Conversation
This file contains hidden or 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
Adds an opt-in testing helper for creating in-memory teams and exposing them via CodeTeams.all/find.
Provides an opt-in RSpec helper (code_team_with_config) and per-example cleanup for in-memory teams.
Stop auto-including CodeTeams::RSpecHelpers; clients can include it in their own RSpec config. The testing integration remains opt-in via requiring code_teams/rspec.
Move RSpec configuration into enable! method so clients explicitly opt-in rather than having it auto-run on require. This gives consumers control over when testing infrastructure is activated.
Specs now call CodeTeams::Testing.enable! at the top level before RSpec.describe, matching the intended client usage pattern.
Document how to use code_teams/rspec and Testing.enable! for creating temporary teams in specs.
This eliminates the conditional check for RSpecHelpers and simplifies client usage - they only need to require code_teams/testing.
File name now matches the module it defines.
Consolidates utility methods in one place.
- Add typed: strict sigil and signatures to Utils - Use T::Hash[Symbol, T.untyped] for create_code_team attributes - Fix nilable string handling in Plugin.default_data_accessor_name
These belong in .git/info/exclude, not in the repo.
The enable! around hook handles cleanup automatically.
- inherited(base) now typed as T.class_of(Plugin) instead of T.untyped - raw_hash now typed as T::Hash[String, T.untyped] since YAML produces string keys
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
CodeTeams::Testingmodule for creating in-memory teams in tests without writing YML files to diskCodeTeams::RSpecHelperswithcode_team_with_confighelper methodCodeTeams::Testing.enable!which registers RSpec hooks for cleanup and includes helpersUsage
Why
Extracts pre-existing test helpers from Gusto's monolith, making them reusable for any
code_teamsconsumer after the next release.Type signature improvements
While adding the new code, I noticed opportunities to reduce
T.untypedusage across the codebase:Utilsnow hastyped: strictwith proper signatures forunderscore,demodulize, anddeep_stringify_keysPlugin.inherited(base)now typed asT.class_of(Plugin)instead ofT.untypedraw_hashnow typed asT::Hash[String, T.untyped]since YAML parsing produces string keyscreate_code_teamattributes typed asT::Hash[Symbol, T.untyped]since callers pass symbol keysT.must(name)inPlugin.default_data_accessor_namebecauseClass#namereturnsT.nilable(String)(anonymous classes have nil names), but Plugin subclasses are always named