Add code comment to indicate operation type in operations

GrottoPress · Jul 5, 2024 · 458133d · 458133d
1 parent 8685c29
commit 458133d
Show file tree

Hide file tree

Showing 52 changed files with 52 additions and 52 deletions.
diff --git a/src/shield/operations/create_bearer_login.cr b/src/shield/operations/create_bearer_login.cr
@@ -1,4 +1,4 @@
-module Shield::CreateBearerLogin
+module Shield::CreateBearerLogin # BearerLogin::SaveOperation
   macro included
     permit_columns :name, :scopes
 

diff --git a/src/shield/operations/create_oauth_access_token_from_client.cr b/src/shield/operations/create_oauth_access_token_from_client.cr
@@ -1,4 +1,4 @@
-module Shield::CreateOauthAccessTokenFromClient
+module Shield::CreateOauthAccessTokenFromClient # BearerLogin::SaveOperation
   macro included
     getter credentials : OauthGrantCredentials?
 

diff --git a/src/shield/operations/create_oauth_access_token_from_grant.cr b/src/shield/operations/create_oauth_access_token_from_grant.cr
@@ -1,4 +1,4 @@
-module Shield::CreateOauthAccessTokenFromGrant
+module Shield::CreateOauthAccessTokenFromGrant # BearerLogin::SaveOperation
   # IMPORTANT
   #
   # Revoke access tokens if authorization used more than once,

diff --git a/src/shield/operations/deactivate_oauth_client.cr b/src/shield/operations/deactivate_oauth_client.cr
@@ -1,4 +1,4 @@
-module Shield::DeactivateOauthClient
+module Shield::DeactivateOauthClient # OauthClient::SaveOperation
   macro included
     include Lucille::Deactivate
 

diff --git a/src/shield/operations/deactivate_user_oauth_clients.cr b/src/shield/operations/deactivate_user_oauth_clients.cr
@@ -1,4 +1,4 @@
-module Shield::DeactivateUserOauthClients
+module Shield::DeactivateUserOauthClients # User::SaveOperation
   macro included
     after_save deactivate_oauth_clients
 

diff --git a/src/shield/operations/delete_bearer_login.cr b/src/shield/operations/delete_bearer_login.cr
@@ -1,4 +1,4 @@
-module Shield::DeleteBearerLogin
+module Shield::DeleteBearerLogin # BearerLogin::DeleteOperation
   macro included
   end
 end
diff --git a/src/shield/operations/delete_email_confirmation.cr b/src/shield/operations/delete_email_confirmation.cr
@@ -1,4 +1,4 @@
-module Shield::DeleteEmailConfirmation
+module Shield::DeleteEmailConfirmation # EmailConfirmation::DeleteOperation
   macro included
     include Shield::DeleteSession
 

diff --git a/src/shield/operations/delete_login.cr b/src/shield/operations/delete_login.cr
@@ -1,4 +1,4 @@
-module Shield::DeleteLogin
+module Shield::DeleteLogin # Login::DeleteOperation
   macro included
     include Shield::DeleteSession
 

diff --git a/src/shield/operations/delete_oauth_client.cr b/src/shield/operations/delete_oauth_client.cr
@@ -1,4 +1,4 @@
-module Shield::DeleteOauthClient
+module Shield::DeleteOauthClient # OauthClient::DeleteOperation
   macro included
   end
 end
diff --git a/src/shield/operations/delete_oauth_grant.cr b/src/shield/operations/delete_oauth_grant.cr
@@ -1,4 +1,4 @@
-module Shield::DeleteOauthGrant
+module Shield::DeleteOauthGrant # OauthGrant::DeleteOperation
   macro included
   end
 end
diff --git a/src/shield/operations/delete_oauth_permission.cr b/src/shield/operations/delete_oauth_permission.cr
@@ -1,4 +1,4 @@
-module Shield::DeleteOauthPermission
+module Shield::DeleteOauthPermission # OauthClient::SaveOperation
   macro included
     needs user : User
 

diff --git a/src/shield/operations/delete_oauth_token.cr b/src/shield/operations/delete_oauth_token.cr
@@ -1,4 +1,4 @@
-module Shield::DeleteOauthToken
+module Shield::DeleteOauthToken # Avram::Operation
   macro included
     include Shield::RevokeOauthToken
 

diff --git a/src/shield/operations/delete_password_reset.cr b/src/shield/operations/delete_password_reset.cr
@@ -1,4 +1,4 @@
-module Shield::DeletePasswordReset
+module Shield::DeletePasswordReset # PasswordReset::DeleteOperation
   macro included
     include Shield::DeleteSession
 

diff --git a/src/shield/operations/delete_user.cr b/src/shield/operations/delete_user.cr
@@ -1,4 +1,4 @@
-module Shield::DeleteUser
+module Shield::DeleteUser # User::DeleteOperation
   macro included
     needs current_user : User?
 

diff --git a/src/shield/operations/delete_user_bearer_logins.cr b/src/shield/operations/delete_user_bearer_logins.cr
@@ -1,4 +1,4 @@
-module Shield::DeleteUserBearerLogins
+module Shield::DeleteUserBearerLogins # User::SaveOperation
   macro included
     needs current_bearer_login : BearerLogin?
 

diff --git a/src/shield/operations/delete_user_email_confirmations.cr b/src/shield/operations/delete_user_email_confirmations.cr
@@ -1,4 +1,4 @@
-module Shield::DeleteUserEmailConfirmations
+module Shield::DeleteUserEmailConfirmations # User::SaveOperation
   macro included
     after_commit delete_email_confirmations
 

diff --git a/src/shield/operations/delete_user_logins.cr b/src/shield/operations/delete_user_logins.cr
@@ -1,4 +1,4 @@
-module Shield::DeleteUserLogins
+module Shield::DeleteUserLogins # User::SaveOperation
   macro included
     needs current_login : Login?
 

diff --git a/src/shield/operations/delete_user_oauth_access_tokens.cr b/src/shield/operations/delete_user_oauth_access_tokens.cr
@@ -1,4 +1,4 @@
-module Shield::DeleteUserOauthAccessTokens
+module Shield::DeleteUserOauthAccessTokens # User::SaveOperation
   macro included
     after_save delete_access_tokens
 

diff --git a/src/shield/operations/delete_user_oauth_clients.cr b/src/shield/operations/delete_user_oauth_clients.cr
@@ -1,4 +1,4 @@
-module Shield::DeleteUserOauthClients
+module Shield::DeleteUserOauthClients # User::SaveOperation
   macro included
     after_commit delete_oauth_clients
 

diff --git a/src/shield/operations/delete_user_oauth_grants.cr b/src/shield/operations/delete_user_oauth_grants.cr
@@ -1,4 +1,4 @@
-module Shield::DeleteUserOauthGrants
+module Shield::DeleteUserOauthGrants # User::SaveOperation
   macro included
     after_commit delete_oauth_grants
 

diff --git a/src/shield/operations/delete_user_password_resets.cr b/src/shield/operations/delete_user_password_resets.cr
@@ -1,4 +1,4 @@
-module Shield::DeleteUserPasswordResets
+module Shield::DeleteUserPasswordResets # User::SaveOperation
   macro included
     after_commit delete_password_resets
 

diff --git a/src/shield/operations/end_email_confirmation.cr b/src/shield/operations/end_email_confirmation.cr
@@ -1,4 +1,4 @@
-module Shield::EndEmailConfirmation
+module Shield::EndEmailConfirmation # EmailConfirmation::SaveOperation
   macro included
     include Lucille::Deactivate
     include Shield::DeleteSession

diff --git a/src/shield/operations/end_login.cr b/src/shield/operations/end_login.cr
@@ -1,4 +1,4 @@
-module Shield::EndLogin
+module Shield::EndLogin # Login::SaveOperation
   macro included
     include Lucille::Deactivate
     include Shield::DeleteSession

diff --git a/src/shield/operations/end_oauth_grant.cr b/src/shield/operations/end_oauth_grant.cr
@@ -1,4 +1,4 @@
-module Shield::EndOauthGrant
+module Shield::EndOauthGrant # OauthGrant::SaveOperation
   macro included
     include Lucille::Deactivate
   end

diff --git a/src/shield/operations/end_oauth_grant_gracefully.cr b/src/shield/operations/end_oauth_grant_gracefully.cr
@@ -1,4 +1,4 @@
-module Shield::EndOauthGrantGracefully
+module Shield::EndOauthGrantGracefully # OauthGrant::SaveOperation
   macro included
     include Lucille::Deactivate
 

diff --git a/src/shield/operations/end_password_reset.cr b/src/shield/operations/end_password_reset.cr
@@ -1,4 +1,4 @@
-module Shield::EndPasswordReset
+module Shield::EndPasswordReset # PasswordReset::SaveOperation
   macro included
     include Lucille::Deactivate
     include Shield::DeleteSession

diff --git a/src/shield/operations/end_user_email_confirmations.cr b/src/shield/operations/end_user_email_confirmations.cr
@@ -1,4 +1,4 @@
-module Shield::EndUserEmailConfirmations
+module Shield::EndUserEmailConfirmations # User::SaveOperation
   macro included
     after_save end_email_confirmations
 

diff --git a/src/shield/operations/end_user_logins.cr b/src/shield/operations/end_user_logins.cr
@@ -1,4 +1,4 @@
-module Shield::EndUserLogins
+module Shield::EndUserLogins # User::SaveOperation
   macro included
     needs current_login : Login?
 

diff --git a/src/shield/operations/end_user_oauth_grants.cr b/src/shield/operations/end_user_oauth_grants.cr
@@ -1,4 +1,4 @@
-module Shield::EndUserOauthGrants
+module Shield::EndUserOauthGrants # User::SaveOperation
   macro included
     after_save end_oauth_grants
 

diff --git a/src/shield/operations/end_user_password_resets.cr b/src/shield/operations/end_user_password_resets.cr
@@ -1,4 +1,4 @@
-module Shield::EndUserPasswordResets
+module Shield::EndUserPasswordResets # User::SaveOperation
   macro included
     after_save end_password_resets
 

diff --git a/src/shield/operations/register_email_confirmation_user.cr b/src/shield/operations/register_email_confirmation_user.cr
@@ -1,4 +1,4 @@
-module Shield::RegisterEmailConfirmationUser
+module Shield::RegisterEmailConfirmationUser # User::SaveOperation
   macro included
     needs session : Lucky::Session?
 

diff --git a/src/shield/operations/register_oauth_client.cr b/src/shield/operations/register_oauth_client.cr
@@ -1,4 +1,4 @@
-module Shield::RegisterOauthClient
+module Shield::RegisterOauthClient # OauthClient::SaveOperation
   macro included
     permit_columns :name, :redirect_uris
 

diff --git a/src/shield/operations/register_user.cr b/src/shield/operations/register_user.cr
@@ -1,4 +1,4 @@
-module Shield::RegisterUser
+module Shield::RegisterUser # User::SaveOperation
   macro included
     permit_columns :email
 

diff --git a/src/shield/operations/reset_password.cr b/src/shield/operations/reset_password.cr
@@ -1,4 +1,4 @@
-module Shield::ResetPassword
+module Shield::ResetPassword # PasswordReset::SaveOperation
   macro included
     needs current_login : Login?
 

diff --git a/src/shield/operations/revoke_bearer_login.cr b/src/shield/operations/revoke_bearer_login.cr
@@ -1,4 +1,4 @@
-module Shield::RevokeBearerLogin
+module Shield::RevokeBearerLogin # BearerLogin::SaveOperation
   macro included
     include Lucille::Deactivate
   end

diff --git a/src/shield/operations/revoke_oauth_permission.cr b/src/shield/operations/revoke_oauth_permission.cr
@@ -1,4 +1,4 @@
-module Shield::RevokeOauthPermission
+module Shield::RevokeOauthPermission # OauthClient::SaveOperation
   macro included
     needs user : User
 

diff --git a/src/shield/operations/revoke_oauth_token.cr b/src/shield/operations/revoke_oauth_token.cr
@@ -1,4 +1,4 @@
-module Shield::RevokeOauthToken
+module Shield::RevokeOauthToken # Avram::Operation
   macro included
     @bearer_login : BearerLogin?
 

diff --git a/src/shield/operations/revoke_user_bearer_logins.cr b/src/shield/operations/revoke_user_bearer_logins.cr
@@ -1,4 +1,4 @@
-module Shield::RevokeUserBearerLogins
+module Shield::RevokeUserBearerLogins # User::SaveOperation
   macro included
     needs current_bearer_login : BearerLogin?
 

diff --git a/src/shield/operations/revoke_user_oauth_access_tokens.cr b/src/shield/operations/revoke_user_oauth_access_tokens.cr
@@ -1,4 +1,4 @@
-module Shield::RevokeUserOauthAccessTokens
+module Shield::RevokeUserOauthAccessTokens # User::SaveOperation
   macro included
     after_save revoke_access_tokens
 

diff --git a/src/shield/operations/rotate_oauth_client_secret.cr b/src/shield/operations/rotate_oauth_client_secret.cr
@@ -1,4 +1,4 @@
-module Shield::RotateOauthClientSecret
+module Shield::RotateOauthClientSecret # OauthClient::SaveOperation
   macro included
     include Shield::SetSecret
 

diff --git a/src/shield/operations/rotate_oauth_grant.cr b/src/shield/operations/rotate_oauth_grant.cr
@@ -1,4 +1,4 @@
-module Shield::RotateOauthGrant
+module Shield::RotateOauthGrant # OauthGrant::SaveOperation
   macro included
     getter credentials : OauthGrantCredentials?
 

diff --git a/src/shield/operations/save_user_options.cr b/src/shield/operations/save_user_options.cr
@@ -1,4 +1,4 @@
-module Shield::SaveUserOptions
+module Shield::SaveUserOptions # UserOptions::SaveOperation
   macro included
     permit_columns :password_notify
 

diff --git a/src/shield/operations/start_email_confirmation.cr b/src/shield/operations/start_email_confirmation.cr
@@ -1,4 +1,4 @@
-module Shield::StartEmailConfirmation
+module Shield::StartEmailConfirmation # EmailConfirmation::SaveOperation
   macro included
     permit_columns :email
 

diff --git a/src/shield/operations/start_login.cr b/src/shield/operations/start_login.cr
@@ -1,4 +1,4 @@
-module Shield::StartLogin
+module Shield::StartLogin # Login::SaveOperation
   macro included
     attribute email : String
     attribute password : String

diff --git a/src/shield/operations/start_oauth_grant.cr b/src/shield/operations/start_oauth_grant.cr
@@ -1,4 +1,4 @@
-module Shield::StartOauthGrant
+module Shield::StartOauthGrant # OauthGrant::SaveOperation
   macro included
     attribute granted : Bool
     attribute code_challenge : String

diff --git a/src/shield/operations/start_password_reset.cr b/src/shield/operations/start_password_reset.cr
@@ -1,4 +1,4 @@
-module Shield::StartPasswordReset
+module Shield::StartPasswordReset # PasswordReset::SaveOperation
   macro included
     attribute email : String
 

diff --git a/src/shield/operations/update_bearer_login.cr b/src/shield/operations/update_bearer_login.cr
@@ -1,4 +1,4 @@
-module Shield::UpdateBearerLogin
+module Shield::UpdateBearerLogin # BearerLogin::SaveOperation
   macro included
     permit_columns :name, :scopes
 

diff --git a/src/shield/operations/update_confirmed_email.cr b/src/shield/operations/update_confirmed_email.cr
@@ -1,4 +1,4 @@
-module Shield::UpdateConfirmedEmail
+module Shield::UpdateConfirmedEmail # EmailConfirmation::SaveOperation
   macro included
     before_save do
       set_success

diff --git a/src/shield/operations/update_email_confirmation_user.cr b/src/shield/operations/update_email_confirmation_user.cr
@@ -1,4 +1,4 @@
-module Shield::UpdateEmailConfirmationUser
+module Shield::UpdateEmailConfirmationUser # User::SaveOperation
   macro included
     getter new_email : String?
     getter credentials : EmailConfirmationCredentials?

diff --git a/src/shield/operations/update_oauth_client.cr b/src/shield/operations/update_oauth_client.cr
@@ -1,4 +1,4 @@
-module Shield::UpdateOauthClient
+module Shield::UpdateOauthClient # OauthClient::SaveOperation
   macro included
     permit_columns :name, :redirect_uris
 

diff --git a/src/shield/operations/update_password.cr b/src/shield/operations/update_password.cr
@@ -1,4 +1,4 @@
-module Shield::UpdatePassword
+module Shield::UpdatePassword # User::SaveOperation
   macro included
     attribute password : String
 

diff --git a/src/shield/operations/update_user.cr b/src/shield/operations/update_user.cr
@@ -1,4 +1,4 @@
-module Shield::UpdateUser
+module Shield::UpdateUser # User::SaveOperation
   macro included
     permit_columns :email