docs: add docs to methods and types

src/factories/password_validation_service_factory.go

@@ -5,6 +5,8 @@ import (
 	"github.com/brandaogabriel7/studio-sol-back-end-test/src/strategies/validation"
 )
 
+// Creates the a PasswordValidation service with the following rule validation strategies:
+// minSize, minSpecialChars, minDigit, noRepeted
 func GetDefaultPasswordValidationService() password_validation.PasswordValidationService {
 	validationStrategies := map[string]validation.ValidationStrategy{
 		string(validation.MIN_SIZE): validation.MinSizeValidationStrategy{},

src/services/password_validation/password_validation_service.go

@@ -5,6 +5,7 @@ import (
 	"github.com/brandaogabriel7/studio-sol-back-end-test/src/strategies/validation"
 )
 
+// Checks if the password is valid based on a set of rules.
 type PasswordValidationService struct {
 	strategies map[string]validation.ValidationStrategy
 }

src/strategies/validation/min_digit.go

@@ -2,6 +2,7 @@ package validation
 
 import "regexp"
 
+// Checks that the password contains at least the minimum number of digits.
 type MinDigitValidationStrategy struct {
 	digitRegexp regexp.Regexp
 }

src/strategies/validation/min_size.go

@@ -1,5 +1,6 @@
 package validation
 
+// Checks that the password is at least the minimum size.
 type MinSizeValidationStrategy struct {}
 
 func (md MinSizeValidationStrategy) IsValid(password string, value int) bool {

src/strategies/validation/min_special_chars.go

@@ -2,6 +2,8 @@ package validation
 
 import "regexp"
 
+// Checks that the password contains at least the minimum number of special chars.
+// The special chars are these: !@#$%^&*()-+\/{}[]
 type MinSpecialCharsStrategy struct {
 	specialCharsRegexp regexp.Regexp
 }

src/strategies/validation/no_repeted.go

@@ -2,6 +2,7 @@ package validation
 
 import "strings"
 
+// Checks that there are no consecutive repeated characters in the given password.
 type NoRepetedStrategy struct {}
 
 func (nr NoRepetedStrategy) IsValid(password string, _ int) bool {

src/strategies/validation/validation_strategy.go

@@ -1,5 +1,6 @@
 package validation
 
+// ValidationStrategy defines a strategy to validate passwords based on a rule.
 type ValidationStrategy interface {
 	IsValid(password string, value int) bool
 }

src/strategies/validation/validation_types.go

@@ -1,5 +1,6 @@
 package validation
 
+// ValidationType defines a password validation rule type.
 type ValidationType string
 
 const MIN_SIZE ValidationType = "minSize"

src/utils/slice_utils.go

@@ -1,5 +1,6 @@
 package utils
 
+// Contains checks if a slice contains the specified string.
 func Contains(s []string, str string) bool {
 	for _, v := range s {
 		if v == str {