Added XML object to what-changed.

Picking off low hanging fruit, before attacking the big, ugly stuff. Signed-off-by: Dave Shanley <dave@quobix.com>
2025-12-09 04:20:17 +00:00 · 2022-10-04 07:35:06 -04:00
parent 65fa21be86
commit 07c05ee540
5 changed files with 254 additions and 3 deletions
--- a/what-changed/xml.go
+++ b/what-changed/xml.go
@@ -0,0 +1,99 @@
+// Copyright 2022 Princess B33f Heavy Industries / Dave Shanley
+// SPDX-License-Identifier: MIT
+
+package what_changed
+
+import (
+	"github.com/pb33f/libopenapi/datamodel/low/base"
+	v3 "github.com/pb33f/libopenapi/datamodel/low/v3"
+)
+
+// XMLChanges represents changes made to the XML object of an OpenAPI document.
+type XMLChanges struct {
+	PropertyChanges[*base.XML]
+	ExtensionChanges *ExtensionChanges
+}
+
+// TotalChanges returns a count of everything that was changed within an XML object.
+func (x *XMLChanges) TotalChanges() int {
+	c := len(x.Changes)
+	if x.ExtensionChanges != nil {
+		c += len(x.ExtensionChanges.Changes)
+	}
+	return c
+}
+
+// CompareXML will compare a left (original) and a right (new) XML instance, and check for
+// any changes between them. If changes are found, the function returns a pointer to XMLChanges,
+// otherwise, if nothing changed - it will return nil
+func CompareXML(l, r *base.XML) *XMLChanges {
+	xc := new(XMLChanges)
+	var changes []*Change[*base.XML]
+	var props []*PropertyCheck[*base.XML]
+
+	// Name (breaking change)
+	props = append(props, &PropertyCheck[*base.XML]{
+		LeftNode:  l.Name.ValueNode,
+		RightNode: r.Name.ValueNode,
+		Label:     v3.NameLabel,
+		Changes:   &changes,
+		Breaking:  true,
+		Original:  l,
+		New:       r,
+	})
+
+	// Namespace (breaking change)
+	props = append(props, &PropertyCheck[*base.XML]{
+		LeftNode:  l.Namespace.ValueNode,
+		RightNode: r.Namespace.ValueNode,
+		Label:     v3.NamespaceLabel,
+		Changes:   &changes,
+		Breaking:  true,
+		Original:  l,
+		New:       r,
+	})
+
+	// Prefix (breaking change)
+	props = append(props, &PropertyCheck[*base.XML]{
+		LeftNode:  l.Prefix.ValueNode,
+		RightNode: r.Prefix.ValueNode,
+		Label:     v3.PrefixLabel,
+		Changes:   &changes,
+		Breaking:  true,
+		Original:  l,
+		New:       r,
+	})
+
+	// Attribute (breaking change)
+	props = append(props, &PropertyCheck[*base.XML]{
+		LeftNode:  l.Attribute.ValueNode,
+		RightNode: r.Attribute.ValueNode,
+		Label:     v3.AttributeLabel,
+		Changes:   &changes,
+		Breaking:  true,
+		Original:  l,
+		New:       r,
+	})
+
+	// Wrapped (breaking change)
+	props = append(props, &PropertyCheck[*base.XML]{
+		LeftNode:  l.Wrapped.ValueNode,
+		RightNode: r.Wrapped.ValueNode,
+		Label:     v3.WrappedLabel,
+		Changes:   &changes,
+		Breaking:  true,
+		Original:  l,
+		New:       r,
+	})
+
+	// check properties
+	CheckProperties(props)
+
+	// check extensions
+	xc.ExtensionChanges = CheckExtensions(l, r)
+	xc.Changes = changes
+	if len(xc.Changes) <= 0 && xc.ExtensionChanges == nil {
+		return nil
+	}
+	return xc
+}