mirror of
https://github.com/LukeHagar/libopenapi.git
synced 2025-12-06 12:37:49 +00:00
3649dc594f
Design is more uniformed and standardized, patterns are bubbling up. I think we're ready to tackle the schema soon. Signed-off-by: Dave Shanley <dave@quobix.com>
125 lines
3.4 KiB
Go
125 lines
3.4 KiB
Go
// Copyright 2022 Princess B33f Heavy Industries / Dave Shanley
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package what_changed
|
|
|
|
import (
|
|
"github.com/pb33f/libopenapi/datamodel/low/base"
|
|
"github.com/pb33f/libopenapi/datamodel/low/v3"
|
|
)
|
|
|
|
// InfoChanges represents the number of changes to an Info object. Part of an OpenAPI document
|
|
type InfoChanges struct {
|
|
PropertyChanges[*base.Info]
|
|
ContactChanges *ContactChanges
|
|
LicenseChanges *LicenseChanges
|
|
}
|
|
|
|
// TotalChanges represents the total number of changes made to an Info object.
|
|
func (i *InfoChanges) TotalChanges() int {
|
|
t := i.PropertyChanges.TotalChanges()
|
|
if i.ContactChanges != nil {
|
|
t += i.ContactChanges.TotalChanges()
|
|
}
|
|
if i.LicenseChanges != nil {
|
|
t += i.LicenseChanges.TotalChanges()
|
|
}
|
|
return t
|
|
}
|
|
|
|
// TotalBreakingChanges always returns 0 for Info objects, they are non-binding.
|
|
func (i *InfoChanges) TotalBreakingChanges() int {
|
|
return 0
|
|
}
|
|
|
|
// CompareInfo will compare a left (original) and a right (new) Info object. Any changes
|
|
// will be returned in a pointer to InfoChanges, otherwise if nothing is found, then nil is
|
|
// returned instead.
|
|
func CompareInfo(l, r *base.Info) *InfoChanges {
|
|
|
|
var changes []*Change[*base.Info]
|
|
var props []*PropertyCheck[*base.Info]
|
|
|
|
// Title
|
|
props = append(props, &PropertyCheck[*base.Info]{
|
|
LeftNode: l.Title.ValueNode,
|
|
RightNode: r.Title.ValueNode,
|
|
Label: v3.TitleLabel,
|
|
Changes: &changes,
|
|
Breaking: false,
|
|
Original: l,
|
|
New: r,
|
|
})
|
|
|
|
// Description
|
|
props = append(props, &PropertyCheck[*base.Info]{
|
|
LeftNode: l.Description.ValueNode,
|
|
RightNode: r.Description.ValueNode,
|
|
Label: v3.DescriptionLabel,
|
|
Changes: &changes,
|
|
Breaking: false,
|
|
Original: l,
|
|
New: r,
|
|
})
|
|
|
|
// TermsOfService
|
|
props = append(props, &PropertyCheck[*base.Info]{
|
|
LeftNode: l.TermsOfService.ValueNode,
|
|
RightNode: r.TermsOfService.ValueNode,
|
|
Label: v3.TermsOfServiceLabel,
|
|
Changes: &changes,
|
|
Breaking: false,
|
|
Original: l,
|
|
New: r,
|
|
})
|
|
|
|
// Version
|
|
props = append(props, &PropertyCheck[*base.Info]{
|
|
LeftNode: l.Version.ValueNode,
|
|
RightNode: r.Version.ValueNode,
|
|
Label: v3.VersionLabel,
|
|
Changes: &changes,
|
|
Breaking: false,
|
|
Original: l,
|
|
New: r,
|
|
})
|
|
|
|
// check properties
|
|
CheckProperties(props)
|
|
|
|
i := new(InfoChanges)
|
|
|
|
// compare contact.
|
|
if l.Contact.Value != nil && r.Contact.Value != nil {
|
|
i.ContactChanges = CompareContact(l.Contact.Value, r.Contact.Value)
|
|
} else {
|
|
if l.Contact.Value == nil && r.Contact.Value != nil {
|
|
CreateChange[*base.Info](&changes, ObjectAdded, v3.ContactLabel,
|
|
nil, r.Contact.ValueNode, false, nil, r.Contact.Value)
|
|
}
|
|
if l.Contact.Value != nil && r.Contact.Value == nil {
|
|
CreateChange[*base.Info](&changes, ObjectRemoved, v3.ContactLabel,
|
|
l.Contact.ValueNode, nil, false, l.Contact.Value, nil)
|
|
}
|
|
}
|
|
|
|
// compare license.
|
|
if l.License.Value != nil && r.License.Value != nil {
|
|
i.LicenseChanges = CompareLicense(l.License.Value, r.License.Value)
|
|
} else {
|
|
if l.License.Value == nil && r.License.Value != nil {
|
|
CreateChange[*base.Info](&changes, ObjectAdded, v3.LicenseLabel,
|
|
nil, r.License.ValueNode, false, nil, r.License.Value)
|
|
}
|
|
if l.License.Value != nil && r.License.Value == nil {
|
|
CreateChange[*base.Info](&changes, ObjectRemoved, v3.LicenseLabel,
|
|
l.License.ValueNode, nil, false, r.License.Value, nil)
|
|
}
|
|
}
|
|
i.Changes = changes
|
|
if i.TotalChanges() <= 0 {
|
|
return nil
|
|
}
|
|
return i
|
|
}
|