it/comparison.go - Code Metrics - Inspection of "Beta (update to generics)" - muonsoft/validation - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed
Pull Request — main (#71)

by Igor
created 2022-04-14 20:16 UTC
it/comparison.go F

↳ Parent: Project
Size/Duplication

Total Lines	830
Duplicated Lines	0 %
Test Coverage

Coverage
97.53%
Importance

Changes
Metric	Value
cc	130
eloc	436
dl	0
loc	830
ccs	158
cts	162
cp	0.9753
crap	130.2546
rs	2
c	0
b	0
f	0
package it

import (
	"fmt"
	"reflect"
	"strconv"
	"time"

	"github.com/muonsoft/validation"
	"github.com/muonsoft/validation/code"
	"github.com/muonsoft/validation/is"
	"github.com/muonsoft/validation/message"
)

// NumberComparisonConstraint is used for various numeric comparisons between integer and float values.
type NumberComparisonConstraint[T validation.Numeric] struct {
	isIgnored         bool
	value             T
	groups            []string
	code              string
	messageTemplate   string
	messageParameters validation.TemplateParameterList
	comparedValue     string
	isValid           func(value T) bool
}

// IsEqualToNumber checks that the number is equal to the specified value.
func IsEqualToNumber[T validation.Numeric](value T) NumberComparisonConstraint[T] {
	return NumberComparisonConstraint[T]{
		code:            code.Equal,
		value:           value,
		messageTemplate: message.Templates[code.Equal],
		comparedValue:   fmt.Sprint(value),
		isValid: func(n T) bool {
			return n == value
		},
	}
}

// IsNotEqualToNumber checks that the number is not equal to the specified value.
func IsNotEqualToNumber[T validation.Numeric](value T) NumberComparisonConstraint[T] {
	return NumberComparisonConstraint[T]{
		code:            code.NotEqual,
		value:           value,
		messageTemplate: message.Templates[code.NotEqual],
		comparedValue:   fmt.Sprint(value),
		isValid: func(n T) bool {
			return n != value
		},
	}
}

// IsLessThan checks that the number is less than the specified value.
func IsLessThan[T validation.Numeric](value T) NumberComparisonConstraint[T] {
	return NumberComparisonConstraint[T]{
		code:            code.TooHigh,
		value:           value,
		messageTemplate: message.Templates[code.TooHigh],
		comparedValue:   fmt.Sprint(value),
		isValid: func(n T) bool {
			return n < value
		},
	}
}

// IsLessThanOrEqual checks that the number is less than or equal to the specified value.
func IsLessThanOrEqual[T validation.Numeric](value T) NumberComparisonConstraint[T] {
	return NumberComparisonConstraint[T]{
		code:            code.TooHighOrEqual,
		value:           value,
		messageTemplate: message.Templates[code.TooHighOrEqual],
		comparedValue:   fmt.Sprint(value),
		isValid: func(n T) bool {
			return n <= value
		},
	}
}

// IsGreaterThan checks that the number is greater than the specified value.
func IsGreaterThan[T validation.Numeric](value T) NumberComparisonConstraint[T] {
	return NumberComparisonConstraint[T]{
		code:            code.TooLow,
		value:           value,
		messageTemplate: message.Templates[code.TooLow],
		comparedValue:   fmt.Sprint(value),
		isValid: func(n T) bool {
			return n > value
		},
	}
}

// IsGreaterThanOrEqual checks that the number is greater than or equal to the specified value.
func IsGreaterThanOrEqual[T validation.Numeric](value T) NumberComparisonConstraint[T] {
	return NumberComparisonConstraint[T]{
		code:            code.TooLowOrEqual,
		value:           value,
		messageTemplate: message.Templates[code.TooLowOrEqual],
		comparedValue:   fmt.Sprint(value),
		isValid: func(n T) bool {
			return n >= value
		},
	}
}

// IsPositive checks that the value is a positive number. Zero is neither positive nor negative.
// If you want to allow zero use IsPositiveOrZero comparison.
func IsPositive[T validation.Numeric]() NumberComparisonConstraint[T] {
	return NumberComparisonConstraint[T]{
		code:            code.NotPositive,
		value:           0,
		messageTemplate: message.Templates[code.NotPositive],
		comparedValue:   "0",
		isValid: func(n T) bool {
			return n > 0
		},
	}
}

// IsPositiveOrZero checks that the value is a positive number or equal to zero.
// If you don't want to allow zero as a valid value, use IsPositive comparison.
func IsPositiveOrZero[T validation.Numeric]() NumberComparisonConstraint[T] {
	return NumberComparisonConstraint[T]{
		code:            code.NotPositiveOrZero,
		value:           0,
		messageTemplate: message.Templates[code.NotPositiveOrZero],
		comparedValue:   "0",
		isValid: func(n T) bool {
			return n >= 0
		},
	}
}

// IsNegative checks that the value is a negative number. Zero is neither positive nor negative.
// If you want to allow zero use IsNegativeOrZero comparison.
func IsNegative[T validation.Numeric]() NumberComparisonConstraint[T] {
	return NumberComparisonConstraint[T]{
		code:            code.NotNegative,
		value:           0,
		messageTemplate: message.Templates[code.NotNegative],
		comparedValue:   "0",
		isValid: func(n T) bool {
			return n < 0
		},
	}
}

// IsNegativeOrZero checks that the value is a negative number or equal to zero.
// If you don't want to allow zero as a valid value, use IsNegative comparison.
func IsNegativeOrZero[T validation.Numeric]() NumberComparisonConstraint[T] {
	return NumberComparisonConstraint[T]{
		code:            code.NotNegativeOrZero,
		value:           0,
		messageTemplate: message.Templates[code.NotNegativeOrZero],
		comparedValue:   "0",
		isValid: func(n T) bool {
			return n <= 0
		},
	}
}

// Code overrides default code for produced violation.
func (c NumberComparisonConstraint[T]) Code(code string) NumberComparisonConstraint[T] {
	c.code = code
	return c
}

// Message sets the violation message template. You can set custom template parameters
// for injecting its values into the final message. Also, you can use default parameters:
//
//  {{ comparedValue }} - the expected value;
//  {{ value }} - the current (invalid) value.
func (c NumberComparisonConstraint[T]) Message(
	template string,
	parameters ...validation.TemplateParameter,
) NumberComparisonConstraint[T] {
	c.messageTemplate = template
	c.messageParameters = parameters
	return c
}

// When enables conditional validation of this constraint. If the expression evaluates to false,
// then the constraint will be ignored.
func (c NumberComparisonConstraint[T]) When(condition bool) NumberComparisonConstraint[T] {
	c.isIgnored = !condition
	return c
}

// WhenGroups enables conditional validation of the constraint by using the validation groups.
func (c NumberComparisonConstraint[T]) WhenGroups(groups ...string) NumberComparisonConstraint[T] {
	c.groups = groups
	return c
}

func (c NumberComparisonConstraint[T]) ValidateNumber(value *T, scope validation.Scope) error {
	if c.isIgnored || scope.IsIgnored(c.groups...) || value == nil || c.isValid(*value) {
		return nil
	}

	return scope.BuildViolation(c.code, c.messageTemplate).
		SetParameters(
			c.messageParameters.Prepend(
				validation.TemplateParameter{Key: "{{ comparedValue }}", Value: c.comparedValue},
				validation.TemplateParameter{Key: "{{ value }}", Value: fmt.Sprint(*value)},
			)...,
		).
		CreateViolation()
}

// RangeConstraint is used to check that a given number value is between some minimum and maximum.
type RangeConstraint[T validation.Numeric] struct {
	isIgnored         bool
	groups            []string
	code              string
	messageTemplate   string
	messageParameters validation.TemplateParameterList
	min               T
	max               T
}

// IsBetween checks that the number is between specified minimum and maximum numeric values.
func IsBetween[T validation.Numeric](min, max T) RangeConstraint[T] {
	return RangeConstraint[T]{
		min:             min,
		max:             max,
		code:            code.NotInRange,
		messageTemplate: message.Templates[code.NotInRange],
	}
}

// Name is the constraint name.
func (c RangeConstraint[T]) Name() string {
	return fmt.Sprintf("RangeConstraint[%s]", reflect.TypeOf(c.min).String())
}

// Code overrides default code for produced violation.
func (c RangeConstraint[T]) Code(code string) RangeConstraint[T] {
	c.code = code
	return c
}

// Message sets the violation message template. You can set custom template parameters
// for injecting its values into the final message. Also, you can use default parameters:
//
//  {{ max }} - the upper limit;
//  {{ min }} - the lower limit;
//  {{ value }} - the current (invalid) value.
func (c RangeConstraint[T]) Message(template string, parameters ...validation.TemplateParameter) RangeConstraint[T] {
	c.messageTemplate = template
	c.messageParameters = parameters
	return c
}

// When enables conditional validation of this constraint. If the expression evaluates to false,
// then the constraint will be ignored.
func (c RangeConstraint[T]) When(condition bool) RangeConstraint[T] {
	c.isIgnored = !condition
	return c
}

// WhenGroups enables conditional validation of the constraint by using the validation groups.
func (c RangeConstraint[T]) WhenGroups(groups ...string) RangeConstraint[T] {
	c.groups = groups
	return c
}

func (c RangeConstraint[T]) ValidateNumber(value *T, scope validation.Scope) error {
	if c.min >= c.max {
		return scope.NewConstraintError(c.Name(), "invalid range")
	}
	if c.isIgnored || value == nil || scope.IsIgnored(c.groups...) {
		return nil
	}
	if *value < c.min || *value > c.max {
		return c.newViolation(*value, scope)
	}

	return nil
}

func (c RangeConstraint[T]) newViolation(value T, scope validation.Scope) error {
	return scope.BuildViolation(c.code, c.messageTemplate).
		SetParameters(
			c.messageParameters.Prepend(
				validation.TemplateParameter{Key: "{{ min }}", Value: fmt.Sprint(c.min)},
				validation.TemplateParameter{Key: "{{ max }}", Value: fmt.Sprint(c.max)},
				validation.TemplateParameter{Key: "{{ value }}", Value: fmt.Sprint(value)},
			)...,
		).
		CreateViolation()
}

// StringComparisonConstraint is used to compare strings.
type StringComparisonConstraint struct {
	isIgnored         bool
	groups            []string
	code              string
	messageTemplate   string
	messageParameters validation.TemplateParameterList
	comparedValue     string
	isValid           func(value string) bool
}

// IsEqualToString checks that the string value is equal to the specified string value.
func IsEqualToString(value string) StringComparisonConstraint {
	return StringComparisonConstraint{
		code:            code.Equal,
		messageTemplate: message.Templates[code.Equal],
		comparedValue:   value,
		isValid: func(actualValue string) bool {
			return value == actualValue
		},
	}
}

// IsNotEqualToString checks that the string value is not equal to the specified string value.
func IsNotEqualToString(value string) StringComparisonConstraint {
	return StringComparisonConstraint{
		code:            code.NotEqual,
		messageTemplate: message.Templates[code.NotEqual],
		comparedValue:   value,
		isValid: func(actualValue string) bool {
			return value != actualValue
		},
	}
}

// Code overrides default code for produced violation.
func (c StringComparisonConstraint) Code(code string) StringComparisonConstraint {
	c.code = code
	return c
}

// Message sets the violation message template. You can set custom template parameters
// for injecting its values into the final message. Also, you can use default parameters:
//
//  {{ comparedValue }} - the expected value;
//  {{ value }} - the current (invalid) value.
//
// All string values are quoted strings.
func (c StringComparisonConstraint) Message(
	template string,
	parameters ...validation.TemplateParameter,
) StringComparisonConstraint {
	c.messageTemplate = template
	c.messageParameters = parameters
	return c
}

// When enables conditional validation of this constraint. If the expression evaluates to false,
// then the constraint will be ignored.
func (c StringComparisonConstraint) When(condition bool) StringComparisonConstraint {
	c.isIgnored = !condition
	return c
}

// WhenGroups enables conditional validation of the constraint by using the validation groups.
func (c StringComparisonConstraint) WhenGroups(groups ...string) StringComparisonConstraint {
	c.groups = groups
	return c
}

func (c StringComparisonConstraint) ValidateString(value *string, scope validation.Scope) error {
	if c.isIgnored || scope.IsIgnored(c.groups...) || value == nil || c.isValid(*value) {
		return nil
	}

	return scope.BuildViolation(c.code, c.messageTemplate).
		SetParameters(
			c.messageParameters.Prepend(
				validation.TemplateParameter{Key: "{{ comparedValue }}", Value: strconv.Quote(c.comparedValue)},
				validation.TemplateParameter{Key: "{{ value }}", Value: strconv.Quote(*value)},
			)...,
		).
		CreateViolation()
}

// TimeComparisonConstraint is used to compare time values.
type TimeComparisonConstraint struct {
	isIgnored         bool
	groups            []string
	code              string
	messageTemplate   string
	messageParameters validation.TemplateParameterList
	comparedValue     time.Time
	layout            string
	isValid           func(value time.Time) bool
}

// IsEarlierThan checks that the given time is earlier than the specified value.
func IsEarlierThan(value time.Time) TimeComparisonConstraint {
	return TimeComparisonConstraint{
		code:            code.TooLate,
		messageTemplate: message.Templates[code.TooLate],
		comparedValue:   value,
		layout:          time.RFC3339,
		isValid: func(actualValue time.Time) bool {
			return actualValue.Before(value)
		},
	}
}

// IsEarlierThanOrEqual checks that the given time is earlier or equal to the specified value.
func IsEarlierThanOrEqual(value time.Time) TimeComparisonConstraint {
	return TimeComparisonConstraint{
		code:            code.TooLateOrEqual,
		messageTemplate: message.Templates[code.TooLateOrEqual],
		comparedValue:   value,
		layout:          time.RFC3339,
		isValid: func(actualValue time.Time) bool {
			return actualValue.Before(value) || actualValue.Equal(value)
		},
	}
}

// IsLaterThan checks that the given time is later than the specified value.
func IsLaterThan(value time.Time) TimeComparisonConstraint {
	return TimeComparisonConstraint{
		code:            code.TooEarly,
		messageTemplate: message.Templates[code.TooEarly],
		comparedValue:   value,
		layout:          time.RFC3339,
		isValid: func(actualValue time.Time) bool {
			return actualValue.After(value)
		},
	}
}

// IsLaterThanOrEqual checks that the given time is later or equal to the specified value.
func IsLaterThanOrEqual(value time.Time) TimeComparisonConstraint {
	return TimeComparisonConstraint{
		code:            code.TooEarlyOrEqual,
		messageTemplate: message.Templates[code.TooEarlyOrEqual],
		comparedValue:   value,
		layout:          time.RFC3339,
		isValid: func(actualValue time.Time) bool {
			return actualValue.After(value) || actualValue.Equal(value)
		},
	}
}

// Code overrides default code for produced violation.
func (c TimeComparisonConstraint) Code(code string) TimeComparisonConstraint {
	c.code = code
	return c
}

// Message sets the violation message template. You can set custom template parameters
// for injecting its values into the final message. Also, you can use default parameters:
//
//  {{ comparedValue }} - the expected value;
//  {{ value }} - the current (invalid) value.
//
// All values are formatted by the layout that can be defined by the Layout method.
// Default layout is time.RFC3339.
func (c TimeComparisonConstraint) Message(
	template string,
	parameters ...validation.TemplateParameter,
) TimeComparisonConstraint {
	c.messageTemplate = template
	c.messageParameters = parameters
	return c
}

// Layout can be used to set the layout that is used to format time values.
func (c TimeComparisonConstraint) Layout(layout string) TimeComparisonConstraint {
	c.layout = layout
	return c
}

// When enables conditional validation of this constraint. If the expression evaluates to false,
// then the constraint will be ignored.
func (c TimeComparisonConstraint) When(condition bool) TimeComparisonConstraint {
	c.isIgnored = !condition
	return c
}

// WhenGroups enables conditional validation of the constraint by using the validation groups.
func (c TimeComparisonConstraint) WhenGroups(groups ...string) TimeComparisonConstraint {
	c.groups = groups
	return c
}

func (c TimeComparisonConstraint) ValidateTime(value *time.Time, scope validation.Scope) error {
	if c.isIgnored || scope.IsIgnored(c.groups...) || value == nil || c.isValid(*value) {
		return nil
	}

	return scope.BuildViolation(c.code, c.messageTemplate).
		SetParameters(
			c.messageParameters.Prepend(
				validation.TemplateParameter{Key: "{{ comparedValue }}", Value: c.comparedValue.Format(c.layout)},
				validation.TemplateParameter{Key: "{{ value }}", Value: value.Format(c.layout)},
			)...,
		).
		CreateViolation()
}

// TimeRangeConstraint is used to check that a given time value is between some minimum and maximum.
type TimeRangeConstraint struct {
	isIgnored         bool
	groups            []string
	code              string
	messageTemplate   string
	messageParameters validation.TemplateParameterList
	layout            string
	min               time.Time
	max               time.Time
}

// IsBetweenTime checks that the time is between specified minimum and maximum time values.
func IsBetweenTime(min, max time.Time) TimeRangeConstraint {
	return TimeRangeConstraint{
		code:            code.NotInRange,
		messageTemplate: message.Templates[code.NotInRange],
		layout:          time.RFC3339,
		min:             min,
		max:             max,
	}
}

// Code overrides default code for produced violation.
func (c TimeRangeConstraint) Code(code string) TimeRangeConstraint {
	c.code = code
	return c
}

// Message sets the violation message template. You can set custom template parameters
// for injecting its values into the final message. Also, you can use default parameters:
//
//  {{ max }} - the upper limit;
//  {{ min }} - the lower limit;
//  {{ value }} - the current (invalid) value.
//
// All values are formatted by the layout that can be defined by the Layout method.
// Default layout is time.RFC3339.
func (c TimeRangeConstraint) Message(template string, parameters ...validation.TemplateParameter) TimeRangeConstraint {
	c.messageTemplate = template
	c.messageParameters = parameters
	return c
}

// When enables conditional validation of this constraint. If the expression evaluates to false,
// then the constraint will be ignored.
func (c TimeRangeConstraint) When(condition bool) TimeRangeConstraint {
	c.isIgnored = !condition
	return c
}

// WhenGroups enables conditional validation of the constraint by using the validation groups.
func (c TimeRangeConstraint) WhenGroups(groups ...string) TimeRangeConstraint {
	c.groups = groups
	return c
}

// Layout can be used to set the layout that is used to format time values.
func (c TimeRangeConstraint) Layout(layout string) TimeRangeConstraint {
	c.layout = layout
	return c
}

func (c TimeRangeConstraint) ValidateTime(value *time.Time, scope validation.Scope) error {
	if c.min.After(c.max) || c.min.Equal(c.max) {
		return scope.NewConstraintError("TimeRangeConstraint", "invalid range")
	}
	if c.isIgnored || scope.IsIgnored(c.groups...) || value == nil {
		return nil
	}
	if value.Before(c.min) || value.After(c.max) {
		return c.newViolation(value, scope)
	}

	return nil
}

func (c TimeRangeConstraint) newViolation(value *time.Time, scope validation.Scope) validation.Violation {
	return scope.BuildViolation(c.code, c.messageTemplate).
		SetParameters(
			c.messageParameters.Prepend(
				validation.TemplateParameter{Key: "{{ min }}", Value: c.min.Format(c.layout)},
				validation.TemplateParameter{Key: "{{ max }}", Value: c.max.Format(c.layout)},
				validation.TemplateParameter{Key: "{{ value }}", Value: value.Format(c.layout)},
			)...,
		).
		CreateViolation()
}

// UniqueConstraint is used to check that all elements of the given collection are unique.
type UniqueConstraint[T comparable] struct {
	isIgnored         bool
	groups            []string
	code              string
	messageTemplate   string
	messageParameters validation.TemplateParameterList
}

// HasUniqueValues checks that all elements of the given collection are unique
// (none of them is present more than once).
func HasUniqueValues[T comparable]() UniqueConstraint[T] {
	return UniqueConstraint[T]{
		code:            code.NotUnique,
		messageTemplate: message.Templates[code.NotUnique],
	}
}

// Code overrides default code for produced violation.
func (c UniqueConstraint[T]) Code(code string) UniqueConstraint[T] {
	c.code = code
	return c
}

// Message sets the violation message template. You can set custom template parameters
// for injecting its values into the final message.
func (c UniqueConstraint[T]) Message(template string, parameters ...validation.TemplateParameter) UniqueConstraint[T] {
	c.messageTemplate = template
	c.messageParameters = parameters
	return c
}

// When enables conditional validation of this constraint. If the expression evaluates to false,
// then the constraint will be ignored.
func (c UniqueConstraint[T]) When(condition bool) UniqueConstraint[T] {
	c.isIgnored = !condition
	return c
}

// WhenGroups enables conditional validation of the constraint by using the validation groups.
func (c UniqueConstraint[T]) WhenGroups(groups ...string) UniqueConstraint[T] {
	c.groups = groups
	return c
}

func (c UniqueConstraint[T]) ValidateComparables(values []T, scope validation.Scope) error {
	if c.isIgnored || scope.IsIgnored(c.groups...) || is.Unique(values) {
		return nil
	}

	return scope.BuildViolation(c.code, c.messageTemplate).
		SetParameters(c.messageParameters...).
		CreateViolation()
}

muonsoft / validation

Pull Request — main (#71)

it/comparison.go F

Size/Duplication

Test Coverage

Importance

Duplication Side-by-Side

Filter issues like
