valueobjects

Documentation

Index

• Variables
• type Email
  • func NewEmail(value string) (*Email, error)
  • func (e *Email) Domain() string
  • func (e *Email) Equals(other *Email) bool
  • func (e *Email) IsBusinessEmail() bool
  • func (e *Email) LocalPart() string
  • func (e Email) MarshalJSON() ([]byte, error)
  • func (e *Email) String() string
  • func (e *Email) UnmarshalJSON(data []byte) error
• type Name
  • func NewName(value string) (*Name, error)
  • func (n *Name) DisplayName() string
  • func (n *Name) Equals(other *Name) bool
  • func (n *Name) FirstName() string
  • func (n *Name) Initials() string
  • func (n *Name) IsMononym() bool
  • func (n *Name) LastName() string
  • func (n Name) MarshalJSON() ([]byte, error)
  • func (n *Name) MiddleNames() []string
  • func (n *Name) String() string
  • func (n *Name) UnmarshalJSON(data []byte) error
• type Password
  • func NewPassword(plainPassword string) (*Password, error)
  • func NewPasswordWithPolicy(plainPassword string, policy *PasswordPolicy) (*Password, error)
  • func (p *Password) String() string
• type PasswordPolicy
  • func DefaultPasswordPolicy() *PasswordPolicy
  • func (p *PasswordPolicy) ValidatePassword(password string) error
• type Status
  • func NewStatus(value string) (*Status, error)
  • func ParseStatus(value string) (Status, error)
  • func (s Status) CanPerformActions() bool
  • func (s Status) CanTransitionTo(target Status) bool
  • func (s Status) Equals(other Status) bool
  • func (s Status) GetAllowedTransitions() []Status
  • func (s Status) IsActive() bool
  • func (s Status) IsDeleted() bool
  • func (s Status) IsInactive() bool
  • func (s Status) IsPending() bool
  • func (s Status) IsSuspended() bool
  • func (s Status) IsTerminal() bool
  • func (s Status) MarshalJSON() ([]byte, error)
  • func (s Status) RequiresVerification() bool
  • func (s Status) String() string
  • func (s *Status) TransitionTo(target Status) error
  • func (s *Status) UnmarshalJSON(data []byte) error
• type Token
  • func GenerateToken() (*Token, error)
  • func NewTokenFromValue(value string) (*Token, error)
  • func (t *Token) Hash() string
  • func (t *Token) Value() string
  • func (t *Token) Verify(plainToken string) bool

Variables

var StatusTransitions = map[Status][]Status{
	StatusPending: {
		StatusActive,
		StatusInactive,
		StatusDeleted,
	},
	StatusActive: {
		StatusInactive,
		StatusSuspended,
		StatusDeleted,
	},
	StatusInactive: {
		StatusActive,
		StatusDeleted,
	},
	StatusSuspended: {
		StatusActive,
		StatusInactive,
		StatusDeleted,
	},
	StatusDeleted: {},
}

StatusTransitions defines allowed status transitions

var ValidStatuses = map[Status]bool{
	StatusActive:    true,
	StatusInactive:  true,
	StatusPending:   true,
	StatusSuspended: true,
	StatusDeleted:   true,
}

ValidStatuses contains all valid status values

Types

type Email

type Email struct {
	// contains filtered or unexported fields
}

Email represents an email address value object

func NewEmail

func NewEmail(value string) (*Email, error)

NewEmail creates a new Email value object with validation

func (*Email) Domain

func (e *Email) Domain() string

Domain returns the domain part of the email

func (*Email) Equals

func (e *Email) Equals(other *Email) bool

Equals checks if two email objects are equal

func (*Email) IsBusinessEmail

func (e *Email) IsBusinessEmail() bool

IsBusinessEmail checks if the email is from a business domain (not free email providers)

func (*Email) LocalPart

func (e *Email) LocalPart() string

LocalPart returns the local part of the email (before @)

func (Email) MarshalJSON

func (e Email) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler interface

func (*Email) String

func (e *Email) String() string

String returns the string representation of the email

func (*Email) UnmarshalJSON

func (e *Email) UnmarshalJSON(data []byte) error

UnmarshalJSON implements json.Unmarshaler interface

type Name

type Name struct {
	// contains filtered or unexported fields
}

Name represents a person's name value object

func NewName

func NewName(value string) (*Name, error)

NewName creates a new Name value object with validation

func (*Name) DisplayName

func (n *Name) DisplayName() string

DisplayName returns a formatted display name

func (*Name) Equals

func (n *Name) Equals(other *Name) bool

Equals checks if two name objects are equal

func (*Name) FirstName

func (n *Name) FirstName() string

FirstName returns the first name part

func (*Name) Initials

func (n *Name) Initials() string

Initials returns the initials of the name

func (*Name) IsMononym

func (n *Name) IsMononym() bool

IsMononym checks if the name is a single name (mononym)

func (*Name) LastName

func (n *Name) LastName() string

LastName returns the last name part

func (Name) MarshalJSON

func (n Name) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler interface

func (*Name) MiddleNames

func (n *Name) MiddleNames() []string

MiddleNames returns the middle names if any

func (*Name) String

func (n *Name) String() string

String returns the string representation of the name

func (*Name) UnmarshalJSON

func (n *Name) UnmarshalJSON(data []byte) error

UnmarshalJSON implements json.Unmarshaler interface

type Password

type Password struct {
	// contains filtered or unexported fields
}

func NewPassword

func NewPassword(plainPassword string) (*Password, error)

func NewPasswordWithPolicy

func NewPasswordWithPolicy(plainPassword string, policy *PasswordPolicy) (*Password, error)

NewPasswordWithPolicy creates a new password value object with custom policy

func (*Password) String

func (p *Password) String() string

type PasswordPolicy

type PasswordPolicy struct {
	MinLength        int
	RequireUppercase bool
	RequireLowercase bool
	RequireNumber    bool
	RequireSpecial   bool
}

PasswordPolicy defines the password validation rules

func DefaultPasswordPolicy

func DefaultPasswordPolicy() *PasswordPolicy

DefaultPasswordPolicy returns the default password policy with strong complexity requirements

func (*PasswordPolicy) ValidatePassword

func (p *PasswordPolicy) ValidatePassword(password string) error

ValidatePassword validates password against the policy

type Status

type Status string

Status represents the user status value object

const (
	StatusActive    Status = "active"
	StatusInactive  Status = "inactive"
	StatusPending   Status = "pending"
	StatusSuspended Status = "suspended"
	StatusDeleted   Status = "deleted"
)

Status constants

func NewStatus

func NewStatus(value string) (*Status, error)

NewStatus creates a new Status value object with validation

func ParseStatus

func ParseStatus(value string) (Status, error)

ParseStatus parses a string to Status (case-insensitive)

func (Status) CanPerformActions

func (s Status) CanPerformActions() bool

CanPerformActions checks if a user with this status can perform actions

func (Status) CanTransitionTo

func (s Status) CanTransitionTo(target Status) bool

CanTransitionTo checks if the current status can transition to the target status

func (Status) Equals

func (s Status) Equals(other Status) bool

Equals checks if two status objects are equal

func (Status) GetAllowedTransitions

func (s Status) GetAllowedTransitions() []Status

GetAllowedTransitions returns all allowed transitions from the current status

func (Status) IsActive

func (s Status) IsActive() bool

IsActive checks if the status is active

func (Status) IsDeleted

func (s Status) IsDeleted() bool

IsDeleted checks if the status is deleted

func (Status) IsInactive

func (s Status) IsInactive() bool

IsInactive checks if the status is inactive

func (Status) IsPending

func (s Status) IsPending() bool

IsPending checks if the status is pending

func (Status) IsSuspended

func (s Status) IsSuspended() bool

IsSuspended checks if the status is suspended

func (Status) IsTerminal

func (s Status) IsTerminal() bool

IsTerminal checks if the status is terminal (no further transitions possible)

func (Status) MarshalJSON

func (s Status) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler interface

func (Status) RequiresVerification

func (s Status) RequiresVerification() bool

RequiresVerification checks if the status requires verification before activation

func (Status) String

func (s Status) String() string

String returns the string representation of the status

func (*Status) TransitionTo

func (s *Status) TransitionTo(target Status) error

TransitionTo attempts to transition to a new status

func (*Status) UnmarshalJSON

func (s *Status) UnmarshalJSON(data []byte) error

UnmarshalJSON implements json.Unmarshaler interface

type Token

type Token struct {
	// contains filtered or unexported fields
}

func GenerateToken

func GenerateToken() (*Token, error)

func NewTokenFromValue

func NewTokenFromValue(value string) (*Token, error)

func (*Token) Hash

func (t *Token) Hash() string

func (*Token) Value

func (t *Token) Value() string

func (*Token) Verify

func (t *Token) Verify(plainToken string) bool