Passed
Push — main ( 957b58...866640 )
by Igor
02:11 queued 24s
created

it.ChoiceConstraint.When   A

Complexity

Conditions 1

Size

Total Lines 3
Code Lines 3

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 2
CRAP Score 1

Importance

Changes 0
Metric Value
cc 1
eloc 3
dl 0
loc 3
ccs 2
cts 2
cp 1
crap 1
rs 10
c 0
b 0
f 0
nop 1
1
package it
2
3
import (
4
	"strings"
5
6
	"github.com/muonsoft/validation"
7
	"github.com/muonsoft/validation/code"
8
	"github.com/muonsoft/validation/message"
9
)
10
11
// ChoiceConstraint is used to ensure that the given value corresponds to one of the expected choices.
12
type ChoiceConstraint struct {
13
	choices           map[string]bool
14
	choicesValue      string
15
	groups            []string
16
	code              string
17
	messageTemplate   string
18
	messageParameters validation.TemplateParameterList
19
	isIgnored         bool
20
}
21
22
// IsOneOfStrings creates a ChoiceConstraint for checking that values are in the expected list of strings.
23
func IsOneOfStrings(values ...string) ChoiceConstraint {
24 1
	choices := make(map[string]bool, len(values))
25 1
	for _, value := range values {
26 1
		choices[value] = true
27
	}
28
29 1
	return ChoiceConstraint{
30
		choices:         choices,
31
		choicesValue:    strings.Join(values, ", "),
32
		code:            code.NoSuchChoice,
33
		messageTemplate: message.Templates[code.NoSuchChoice],
34
	}
35
}
36
37
// SetUp will return an error if the list of choices is empty.
38
func (c ChoiceConstraint) SetUp() error {
39 1
	if len(c.choices) == 0 {
40 1
		return errEmptyChoices
41
	}
42
43 1
	return nil
44
}
45
46
// Name is the constraint name.
47
func (c ChoiceConstraint) Name() string {
48 1
	return "ChoiceConstraint"
49
}
50
51
// Code overrides default code for produced violation.
52
func (c ChoiceConstraint) Code(code string) ChoiceConstraint {
53 1
	c.code = code
54 1
	return c
55
}
56
57
// Message sets the violation message template. You can set custom template parameters
58
// for injecting its values into the final message. Also, you can use default parameters:
59
//
60
//	{{ choices }} - a comma-separated list of available choices;
61
//	{{ value }} - the current (invalid) value.
62
func (c ChoiceConstraint) Message(template string, parameters ...validation.TemplateParameter) ChoiceConstraint {
63 1
	c.messageTemplate = template
64 1
	c.messageParameters = parameters
65 1
	return c
66
}
67
68
// When enables conditional validation of this constraint. If the expression evaluates to false,
69
// then the constraint will be ignored.
70
func (c ChoiceConstraint) When(condition bool) ChoiceConstraint {
71 1
	c.isIgnored = !condition
72 1
	return c
73
}
74
75
// WhenGroups enables conditional validation of the constraint by using the validation groups.
76
func (c ChoiceConstraint) WhenGroups(groups ...string) ChoiceConstraint {
77 1
	c.groups = groups
78 1
	return c
79
}
80
81
func (c ChoiceConstraint) ValidateString(value *string, scope validation.Scope) error {
82 1
	if c.isIgnored || scope.IsIgnored(c.groups...) || value == nil || *value == "" {
83 1
		return nil
84
	}
85 1
	if c.choices[*value] {
86 1
		return nil
87
	}
88
89 1
	return scope.
90
		BuildViolation(c.code, c.messageTemplate).
91
		SetParameters(
92
			c.messageParameters.Prepend(
93
				validation.TemplateParameter{Key: "{{ value }}", Value: *value},
94
				validation.TemplateParameter{Key: "{{ choices }}", Value: c.choicesValue},
95
			)...,
96
		).
97
		CreateViolation()
98
}
99