Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix docs how to register all possible interceptors #1824

Merged
merged 2 commits into from Nov 12, 2023
Merged

Fix docs how to register all possible interceptors #1824

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
49e3ef4
Fix docs how to register all possible interceptors
Vampire Nov 7, 2023
1c49943
Review Feedback Vol. 1
Vampire Nov 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
22 changes: 16 additions & 6 deletions docs/extensions.adoc
View file
Open in desktop
Expand Up @@ -903,22 +903,32 @@ each at addition time whether it is attached to the method interceptor or the ot
----
class I extends AbstractMethodInterceptor { I(def s) {} }

// DISCLAIMER: The following shows all possible injection points that you could use
// depending on need and situation. You should normally not need to
// register a listener to all these places.
//
// Also, when building an annotation driven local extension, you should
// consider where you want the effects to be present, for example only
// for the features in the same class (specInfo.features), or for features
// in the same and superclasses (specInfo.allFeatures), or also for
// features in subclasses (specInfo.bottomSpec.allFeatures), and so on.

// on SpecInfo
specInfo.addSharedInitializerInterceptor new I('shared initializer')
specInfo.specsBottomToTop*.addSharedInitializerInterceptor new I('shared initializer')
specInfo.specsBottomToTop*.sharedInitializerMethod*.addInterceptor new I('shared initializer method')
specInfo.addInterceptor new I('specification')
specInfo.addSetupSpecInterceptor new I('setup spec')
specInfo.specsBottomToTop*.addSetupSpecInterceptor new I('setup spec')
specInfo.specsBottomToTop.collectMany { it.setupSpecMethods }*.addInterceptor new I('setup spec method')
specInfo.allFeatures*.addInterceptor new I('feature')
specInfo.addInitializerInterceptor new I('initializer')
specInfo.specsBottomToTop*.addInitializerInterceptor new I('initializer')
specInfo.specsBottomToTop*.initializerMethod*.addInterceptor new I('initializer method')
specInfo.allFeatures*.addIterationInterceptor new I('iteration')
specInfo.addSetupInterceptor new I('setup')
specInfo.specsBottomToTop*.addSetupInterceptor new I('setup')
specInfo.specsBottomToTop.collectMany { it.setupMethods }*.addInterceptor new I('setup method')
specInfo.allFeatures*.featureMethod*.addInterceptor new I('feature method')
specInfo.addCleanupInterceptor new I('cleanup')
specInfo.specsBottomToTop*.addCleanupInterceptor new I('cleanup')
specInfo.specsBottomToTop.collectMany { it.cleanupMethods }*.addInterceptor new I('cleanup method')
specInfo.addCleanupSpecInterceptor new I('cleanup spec')
specInfo.specsBottomToTop*.addCleanupSpecInterceptor new I('cleanup spec')
specInfo.specsBottomToTop.collectMany { it.cleanupSpecMethods }*.addInterceptor new I('cleanup spec method')
specInfo.allFixtureMethods*.addInterceptor new I('fixture method')

Expand Down