added helpers to manipulate validation in schemas and simple schemas (#132)

This only adds things and do not alter the exposed interface or types.

Signed-off-by: Frederic BIDON <fredbi@yahoo.com>

Author: fredbi

header.go

@@ -141,6 +141,12 @@ func (h *Header) AllowDuplicates() *Header {
 	return h
 }
 
+// WithValidations is a fluent method to set header validations
+func (h *Header) WithValidations(val CommonValidations) *Header {
+	h.SetValidations(SchemaValidations{CommonValidations: val})
+	return h
+}
+
 // MarshalJSON marshal this to JSON
 func (h Header) MarshalJSON() ([]byte, error) {
 	b1, err := json.Marshal(h.CommonValidations)

header_test.go

@@ -18,6 +18,7 @@ import (
 	"encoding/json"
 	"testing"
 
+	"github.com/go-openapi/swag"
 	"github.com/stretchr/testify/assert"
 )
 
@@ -166,3 +167,8 @@ func TestWithHeader(t *testing.T) {
 		},
 	}, *h)
 }
+
+func TestHeaderWithValidation(t *testing.T) {
+	h := new(Header).WithValidations(CommonValidations{MaxLength: swag.Int64(15)})
+	assert.EqualValues(t, swag.Int64(15), h.MaxLength)
+}

items.go

@@ -53,22 +53,6 @@ func (s *SimpleSchema) ItemsTypeName() string {
 	return s.Items.TypeName()
 }
 
-// CommonValidations describe common JSON-schema validations
-type CommonValidations struct {
-	Maximum          *float64      `json:"maximum,omitempty"`
-	ExclusiveMaximum bool          `json:"exclusiveMaximum,omitempty"`
-	Minimum          *float64      `json:"minimum,omitempty"`
-	ExclusiveMinimum bool          `json:"exclusiveMinimum,omitempty"`
-	MaxLength        *int64        `json:"maxLength,omitempty"`
-	MinLength        *int64        `json:"minLength,omitempty"`
-	Pattern          string        `json:"pattern,omitempty"`
-	MaxItems         *int64        `json:"maxItems,omitempty"`
-	MinItems         *int64        `json:"minItems,omitempty"`
-	UniqueItems      bool          `json:"uniqueItems,omitempty"`
-	MultipleOf       *float64      `json:"multipleOf,omitempty"`
-	Enum             []interface{} `json:"enum,omitempty"`
-}
-
 // Items a limited subset of JSON-Schema's items object.
 // It is used by parameter definitions that are not located in "body".
 //
@@ -180,6 +164,12 @@ func (i *Items) AllowDuplicates() *Items {
 	return i
 }
 
+// WithValidations is a fluent method to set Items validations
+func (i *Items) WithValidations(val CommonValidations) *Items {
+	i.SetValidations(SchemaValidations{CommonValidations: val})
+	return i
+}
+
 // UnmarshalJSON hydrates this items instance with the data from JSON
 func (i *Items) UnmarshalJSON(data []byte) error {
 	var validations CommonValidations

items_test.go

@@ -185,3 +185,8 @@ func TestJSONLookupItems(t *testing.T) {
 		return
 	}
 }
+
+func TestItemsWithValidation(t *testing.T) {
+	i := new(Items).WithValidations(CommonValidations{MaxLength: swag.Int64(15)})
+	assert.EqualValues(t, swag.Int64(15), i.MaxLength)
+}

parameter.go

@@ -277,6 +277,12 @@ func (p *Parameter) AllowDuplicates() *Parameter {
 	return p
 }
 
+// WithValidations is a fluent method to set parameter validations
+func (p *Parameter) WithValidations(val CommonValidations) *Parameter {
+	p.SetValidations(SchemaValidations{CommonValidations: val})
+	return p
+}
+
 // UnmarshalJSON hydrates this items instance with the data from JSON
 func (p *Parameter) UnmarshalJSON(data []byte) error {
 	if err := json.Unmarshal(data, &p.CommonValidations); err != nil {

parameters_test.go

@@ -18,6 +18,7 @@ import (
 	"encoding/json"
 	"testing"
 
+	"github.com/go-openapi/swag"
 	"github.com/stretchr/testify/assert"
 )
 
@@ -162,3 +163,8 @@ func TestParameterGobEncoding(t *testing.T) {
 	}
 	doTestAnyGobEncoding(t, &src, &dst)
 }
+
+func TestParametersWithValidation(t *testing.T) {
+	p := new(Parameter).WithValidations(CommonValidations{MaxLength: swag.Int64(15)})
+	assert.EqualValues(t, swag.Int64(15), p.MaxLength)
+}

schema.go

@@ -513,6 +513,56 @@ func (s *Schema) AsUnwrappedXML() *Schema {
 	return s
 }
 
+// SetValidations defines all schema validations.
+//
+// NOTE: Required, ReadOnly, AllOf, AnyOf, OneOf and Not are not considered.
+func (s *Schema) SetValidations(val SchemaValidations) {
+	s.Maximum = val.Maximum
+	s.ExclusiveMaximum = val.ExclusiveMaximum
+	s.Minimum = val.Minimum
+	s.ExclusiveMinimum = val.ExclusiveMinimum
+	s.MaxLength = val.MaxLength
+	s.MinLength = val.MinLength
+	s.Pattern = val.Pattern
+	s.MaxItems = val.MaxItems
+	s.MinItems = val.MinItems
+	s.UniqueItems = val.UniqueItems
+	s.MultipleOf = val.MultipleOf
+	s.Enum = val.Enum
+	s.MinProperties = val.MinProperties
+	s.MaxProperties = val.MaxProperties
+	s.PatternProperties = val.PatternProperties
+}
+
+// WithValidations is a fluent method to set schema validations
+func (s *Schema) WithValidations(val SchemaValidations) *Schema {
+	s.SetValidations(val)
+	return s
+}
+
+// Validations returns a clone of the validations for this schema
+func (s Schema) Validations() SchemaValidations {
+	return SchemaValidations{
+		CommonValidations: CommonValidations{
+			Maximum:          s.Maximum,
+			ExclusiveMaximum: s.ExclusiveMaximum,
+			Minimum:          s.Minimum,
+			ExclusiveMinimum: s.ExclusiveMinimum,
+			MaxLength:        s.MaxLength,
+			MinLength:        s.MinLength,
+			Pattern:          s.Pattern,
+			MaxItems:         s.MaxItems,
+			MinItems:         s.MinItems,
+			UniqueItems:      s.UniqueItems,
+			MultipleOf:       s.MultipleOf,
+			Enum:             s.Enum,
+		},
+		MinProperties:     s.MinProperties,
+		MaxProperties:     s.MaxProperties,
+		PatternProperties: s.PatternProperties,
+	}
+}
+
 // MarshalJSON marshal this to JSON
 func (s Schema) MarshalJSON() ([]byte, error) {
 	b1, err := json.Marshal(s.SchemaProps)

schema_test.go

@@ -18,6 +18,7 @@ import (
 	"encoding/json"
 	"testing"
 
+	"github.com/go-openapi/swag"
 	"github.com/stretchr/testify/assert"
 )
 
@@ -210,3 +211,13 @@ func BenchmarkSchemaUnmarshal(b *testing.B) {
 		_ = sch.UnmarshalJSON([]byte(schemaJSON))
 	}
 }
+
+func TestSchemaWithValidation(t *testing.T) {
+	s := new(Schema).WithValidations(SchemaValidations{CommonValidations: CommonValidations{MaxLength: swag.Int64(15)}})
+	assert.EqualValues(t, swag.Int64(15), s.MaxLength)
+
+	val := mkVal()
+	s = new(Schema).WithValidations(val)
+
+	assert.EqualValues(t, val, s.Validations())
+}

validations.go

@@ -0,0 +1,215 @@
+package spec
+
+// CommonValidations describe common JSON-schema validations
+type CommonValidations struct {
+	Maximum          *float64      `json:"maximum,omitempty"`
+	ExclusiveMaximum bool          `json:"exclusiveMaximum,omitempty"`
+	Minimum          *float64      `json:"minimum,omitempty"`
+	ExclusiveMinimum bool          `json:"exclusiveMinimum,omitempty"`
+	MaxLength        *int64        `json:"maxLength,omitempty"`
+	MinLength        *int64        `json:"minLength,omitempty"`
+	Pattern          string        `json:"pattern,omitempty"`
+	MaxItems         *int64        `json:"maxItems,omitempty"`
+	MinItems         *int64        `json:"minItems,omitempty"`
+	UniqueItems      bool          `json:"uniqueItems,omitempty"`
+	MultipleOf       *float64      `json:"multipleOf,omitempty"`
+	Enum             []interface{} `json:"enum,omitempty"`
+}
+
+// SetValidations defines all validations for a simple schema.
+//
+// NOTE: the input is the larger set of validations available for schemas.
+// For simple schemas, MinProperties and MaxProperties are ignored.
+func (v *CommonValidations) SetValidations(val SchemaValidations) {
+	v.Maximum = val.Maximum
+	v.ExclusiveMaximum = val.ExclusiveMaximum
+	v.Minimum = val.Minimum
+	v.ExclusiveMinimum = val.ExclusiveMinimum
+	v.MaxLength = val.MaxLength
+	v.MinLength = val.MinLength
+	v.Pattern = val.Pattern
+	v.MaxItems = val.MaxItems
+	v.MinItems = val.MinItems
+	v.UniqueItems = val.UniqueItems
+	v.MultipleOf = val.MultipleOf
+	v.Enum = val.Enum
+}
+
+type clearedValidation struct {
+	Validation string
+	Value      interface{}
+}
+
+type clearedValidations []clearedValidation
+
+func (c clearedValidations) apply(cbs []func(string, interface{})) {
+	for _, cb := range cbs {
+		for _, cleared := range c {
+			cb(cleared.Validation, cleared.Value)
+		}
+	}
+}
+
+// ClearNumberValidations clears all number validations.
+//
+// Some callbacks may be set by the caller to capture changed values.
+func (v *CommonValidations) ClearNumberValidations(cbs ...func(string, interface{})) {
+	done := make(clearedValidations, 0, 5)
+	defer func() {
+		done.apply(cbs)
+	}()
+
+	if v.Minimum != nil {
+		done = append(done, clearedValidation{Validation: "minimum", Value: v.Minimum})
+		v.Minimum = nil
+	}
+	if v.Maximum != nil {
+		done = append(done, clearedValidation{Validation: "maximum", Value: v.Maximum})
+		v.Maximum = nil
+	}
+	if v.ExclusiveMaximum {
+		done = append(done, clearedValidation{Validation: "exclusiveMaximum", Value: v.ExclusiveMaximum})
+		v.ExclusiveMaximum = false
+	}
+	if v.ExclusiveMinimum {
+		done = append(done, clearedValidation{Validation: "exclusiveMinimum", Value: v.ExclusiveMinimum})
+		v.ExclusiveMinimum = false
+	}
+	if v.MultipleOf != nil {
+		done = append(done, clearedValidation{Validation: "multipleOf", Value: v.MultipleOf})
+		v.MultipleOf = nil
+	}
+}
+
+// ClearStringValidations clears all string validations.
+//
+// Some callbacks may be set by the caller to capture changed values.
+func (v *CommonValidations) ClearStringValidations(cbs ...func(string, interface{})) {
+	done := make(clearedValidations, 0, 3)
+	defer func() {
+		done.apply(cbs)
+	}()
+
+	if v.Pattern != "" {
+		done = append(done, clearedValidation{Validation: "pattern", Value: v.Pattern})
+		v.Pattern = ""
+	}
+	if v.MinLength != nil {
+		done = append(done, clearedValidation{Validation: "minLength", Value: v.MinLength})
+		v.MinLength = nil
+	}
+	if v.MaxLength != nil {
+		done = append(done, clearedValidation{Validation: "maxLength", Value: v.MaxLength})
+		v.MaxLength = nil
+	}
+}
+
+// ClearArrayValidations clears all array validations.
+//
+// Some callbacks may be set by the caller to capture changed values.
+func (v *CommonValidations) ClearArrayValidations(cbs ...func(string, interface{})) {
+	done := make(clearedValidations, 0, 3)
+	defer func() {
+		done.apply(cbs)
+	}()
+
+	if v.MaxItems != nil {
+		done = append(done, clearedValidation{Validation: "maxItems", Value: v.MaxItems})
+		v.MaxItems = nil
+	}
+	if v.MinItems != nil {
+		done = append(done, clearedValidation{Validation: "minItems", Value: v.MinItems})
+		v.MinItems = nil
+	}
+	if v.UniqueItems {
+		done = append(done, clearedValidation{Validation: "uniqueItems", Value: v.UniqueItems})
+		v.UniqueItems = false
+	}
+}
+
+// Validations returns a clone of the validations for a simple schema.
+//
+// NOTE: in the context of simple schema objects, MinProperties, MaxProperties
+// and PatternProperties remain unset.
+func (v CommonValidations) Validations() SchemaValidations {
+	return SchemaValidations{
+		CommonValidations: v,
+	}
+}
+
+// HasNumberValidations indicates if the validations are for numbers or integers
+func (v CommonValidations) HasNumberValidations() bool {
+	return v.Maximum != nil || v.Minimum != nil || v.MultipleOf != nil
+}
+
+// HasStringValidations indicates if the validations are for strings
+func (v CommonValidations) HasStringValidations() bool {
+	return v.MaxLength != nil || v.MinLength != nil || v.Pattern != ""
+}
+
+// HasArrayValidations indicates if the validations are for arrays
+func (v CommonValidations) HasArrayValidations() bool {
+	return v.MaxItems != nil || v.MinItems != nil || v.UniqueItems
+}
+
+// HasEnum indicates if the validation includes some enum constraint
+func (v CommonValidations) HasEnum() bool {
+	return len(v.Enum) > 0
+}
+
+// SchemaValidations describes the validation properties of a schema
+//
+// NOTE: at this moment, this is not embedded in SchemaProps because this would induce a breaking change
+// in the exported members: all initializers using litterals would fail.
+type SchemaValidations struct {
+	CommonValidations
+
+	PatternProperties SchemaProperties `json:"patternProperties,omitempty"`
+	MaxProperties     *int64           `json:"maxProperties,omitempty"`
+	MinProperties     *int64           `json:"minProperties,omitempty"`
+}
+
+// HasObjectValidations indicates if the validations are for objects
+func (v SchemaValidations) HasObjectValidations() bool {
+	return v.MaxProperties != nil || v.MinProperties != nil || v.PatternProperties != nil
+}
+
+// SetValidations for schema validations
+func (v *SchemaValidations) SetValidations(val SchemaValidations) {
+	v.CommonValidations.SetValidations(val)
+	v.PatternProperties = val.PatternProperties
+	v.MaxProperties = val.MaxProperties
+	v.MinProperties = val.MinProperties
+}
+
+// Validations for a schema
+func (v SchemaValidations) Validations() SchemaValidations {
+	val := v.CommonValidations.Validations()
+	val.PatternProperties = v.PatternProperties
+	val.MinProperties = v.MinProperties
+	val.MaxProperties = v.MaxProperties
+	return val
+}
+
+// ClearObjectValidations returns a clone of the validations with all object validations cleared.
+//
+// Some callbacks may be set by the caller to capture changed values.
+func (v *SchemaValidations) ClearObjectValidations(cbs ...func(string, interface{})) {
+	done := make(clearedValidations, 0, 3)
+	defer func() {
+		done.apply(cbs)
+	}()
+
+	if v.MaxProperties != nil {
+		done = append(done, clearedValidation{Validation: "maxProperties", Value: v.MaxProperties})
+		v.MaxProperties = nil
+	}
+	if v.MinProperties != nil {
+		done = append(done, clearedValidation{Validation: "minProperties", Value: v.MinProperties})
+		v.MinProperties = nil
+	}
+	if v.PatternProperties != nil {
+		done = append(done, clearedValidation{Validation: "patternProperties", Value: v.PatternProperties})
+		v.PatternProperties = nil
+	}
+}