NotificationsYou must be signed in to change notification settings
Fork0
Star0

Commite069fb6

committed

Add docstrings to use cases

1 parent29d3593 commite069fb6Copy full SHA for e069fb6

File tree

1 file changed

+49

-0

lines changed

sponsors
- use_cases.py

1 file changed

+49

-0

lines changed

`‎sponsors/use_cases.py`

Lines changed: 49 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,7 @@`
	`1`	`+"""`
	`2`	`+This module holds Use Cases (UCs) implementations. These are indirections to trigger business rules`
	`3`	`+and avoid the sponsors core logic and state management to be spread across views codes.`
	`4`	`+"""`
`1`	`5`	`fromabcimportABC,abstractmethod`
`2`	`6`
`3`	`7`	`fromsponsorsimportnotifications`
`@@ -6,14 +10,24 @@`
`6`	`10`
`7`	`11`
`8`	`12`	`classBaseUseCaseWithNotifications(ABC):`
	`13`	`+"""`
	`14`	`+ Abstract base class to be used to implement use cases.`
	`15`	`+ It holds a list of notifications to be dispatched by the UC if needed`
	`16`	`+ """`
`9`	`17`	`notifications= []`
`10`	`18`
`11`	`19`	`@classmethod`
`12`	`20`	`defbuild(cls):`
	`21`	`+"""`
	`22`	`+ Factory method to explicity handle complex logic and/or dependency injection`
	`23`	`+ """`
`13`	`24`	`returncls(cls.notifications)`
`14`	`25`
`15`	`26`	`@abstractmethod`
`16`	`27`	`defexecute(self,args,*kwargs):`
	`28`	`+"""`
	`29`	`+ Abstract method to implement specific UC business rules`
	`30`	`+ """`
`17`	`31`	`pass`
`18`	`32`
`19`	`33`	`def__init__(self,notifications):`
`@@ -25,6 +39,10 @@ def notify(self, **kwargs):`
`25`	`39`
`26`	`40`
`27`	`41`	`classCreateSponsorshipApplicationUseCase(BaseUseCaseWithNotifications):`
	`42`	`+"""`
	`43`	`+ Use case called to create a new sponsorships application for submitted by a user`
	`44`	`+ """`
	`45`	`+`
`28`	`46`	`notifications= [`
`29`	`47`	`notifications.AppliedSponsorshipNotificationToPSF(),`
`30`	`48`	`notifications.AppliedSponsorshipNotificationToSponsors(),`
`@@ -37,6 +55,9 @@ def execute(self, user, sponsor, benefits, package=None, request=None):`
`37`	`55`
`38`	`56`
`39`	`57`	`classRejectSponsorshipApplicationUseCase(BaseUseCaseWithNotifications):`
	`58`	`+"""`
	`59`	`+ Use case to enable PSF staff to reject an application`
	`60`	`+ """`
`40`	`61`	`notifications= [`
`41`	`62`	`notifications.RejectedSponsorshipNotificationToPSF(),`
`42`	`63`	`notifications.RejectedSponsorshipNotificationToSponsors(),`
`@@ -50,6 +71,9 @@ def execute(self, sponsorship, request=None):`
`50`	`71`
`51`	`72`
`52`	`73`	`classApproveSponsorshipApplicationUseCase(BaseUseCaseWithNotifications):`
	`74`	`+"""`
	`75`	`+ Use case to enable PSF staff to approve an application`
	`76`	`+ """`
`53`	`77`	`notifications= [`
`54`	`78`	`notifications.SponsorshipApprovalLogger(),`
`55`	`79`	`]`
`@@ -77,6 +101,10 @@ def execute(self, sponsorship, start_date, end_date, **kwargs):`
`77`	`101`
`78`	`102`
`79`	`103`	`classSendContractUseCase(BaseUseCaseWithNotifications):`
	`104`	`+"""`
	`105`	`+ Use case to enable PSF staff to generate the contract .docx`
	`106`	`+ file and sent it over email`
	`107`	`+ """`
`80`	`108`	`notifications= [`
`81`	`109`	`notifications.ContractNotificationToPSF(),`
`82`	`110`	`# TODO: sponsor's notification will be enabled again once`
`@@ -98,6 +126,14 @@ def execute(self, contract, **kwargs):`
`98`	`126`
`99`	`127`
`100`	`128`	`classExecuteExistingContractUseCase(BaseUseCaseWithNotifications):`
	`129`	`+"""`
	`130`	`+ Use case to PSF Staff to finalize a sponsorship by "executing" a contract.`
	`131`	`+ This UC was created to enable to enable to upload existing contracts documents`
	`132`	`+ that weren't generated by the sponsors app.`
	`133`	`+`
	`134`	`+ It's probable that this UC will become a legacy one once all the new`
	`135`	`+ contracts and sponsorships were created via the Django application`
	`136`	`+ """`
`101`	`137`	`notifications= [`
`102`	`138`	`notifications.ExecutedExistingContractLogger(),`
`103`	`139`	`]`
`@@ -113,13 +149,22 @@ def execute(self, contract, contract_file, **kwargs):`
`113`	`149`
`114`	`150`
`115`	`151`	`classExecuteContractUseCase(ExecuteExistingContractUseCase):`
	`152`	`+"""`
	`153`	`+ Use case to PSF Staff to execute a contract created by the sponsors app.`
	`154`	`+ Execute a contract requires the admin user to upload the signed contract`
	`155`	`+ and this will flag the contract as Executed and the corresponding Sponsorship`
	`156`	`+ as Finalized.`
	`157`	`+ """`
`116`	`158`	`notifications= [`
`117`	`159`	`notifications.ExecutedContractLogger(),`
`118`	`160`	`]`
`119`	`161`	`force_execute=False`
`120`	`162`
`121`	`163`
`122`	`164`	`classNullifyContractUseCase(BaseUseCaseWithNotifications):`
	`165`	`+"""`
	`166`	`+ Use case to enable PSF staff to nullify non-executed contracts`
	`167`	`+ """`
`123`	`168`	`notifications= [`
`124`	`169`	`notifications.NullifiedContractLogger(),`
`125`	`170`	`]`
`@@ -133,6 +178,10 @@ def execute(self, contract, **kwargs):`
`133`	`178`
`134`	`179`
`135`	`180`	`classSendSponsorshipNotificationUseCase(BaseUseCaseWithNotifications):`
	`181`	`+"""`
	`182`	`+ Use case to enable PSF staff to send DB stored email notifications`
	`183`	`+ to a list of selected sponsorships.`
	`184`	`+ """`
`136`	`185`	`notifications= [`
`137`	`186`	`notifications.SendSponsorNotificationLogger(),`
`138`	`187`	`]`

0 commit comments

Comments

(0)

Movatterモバイル変換

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commite069fb6

File tree

1 file changed

1 file changed

`‎sponsors/use_cases.py`

0 commit comments