https://github.com/sphere-sh/go-struct-sync
A Go package for comparing struct instances and applying detected changes.
https://github.com/sphere-sh/go-struct-sync
data-structures golang sphere structures sync
Last synced: about 1 year ago
JSON representation
A Go package for comparing struct instances and applying detected changes.
- Host: GitHub
- URL: https://github.com/sphere-sh/go-struct-sync
- Owner: sphere-sh
- Created: 2025-03-07T09:16:02.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-03-07T10:07:55.000Z (about 1 year ago)
- Last Synced: 2025-03-07T10:26:59.017Z (about 1 year ago)
- Topics: data-structures, golang, sphere, structures, sync
- Language: Go
- Homepage: https://www.sphere.sh/
- Size: 11.7 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: change/change.go
Awesome Lists containing this project
README
# GO Struct Compare
A Go package for comparing struct instances and applying detected changes.
### Installation
```bash
go get github.com/sphere-sh/go-struct-sync
````
## Overview
This package provides utilities to:
- Compare two structs and detect differences (added, modified, or deleted fields)
- Apply a set of changes to a struct
- Filter, merge, and manipulate change sets
- Convert changes to human-readable format or JSON
## Usage
### Basic Comparison
```go
package main
import (
"fmt"
"github.com/sphere-sh/go-struct-sync/compare"
)
func main() {
type Person struct {
Name string
Age int
Address string
Active bool
}
// Original struct
old := Person{
Name: "John Doe",
Age: 30,
Address: "123 Main St",
Active: true,
}
// Modified struct
new := Person{
Name: "John Doe",
Age: 31,
Address: "456 Oak Ave",
Active: false,
}
// Compare the structs
changes, err := compare.CompareStructs(old, new)
if err != nil {
fmt.Printf("Error: %v\n", err)
return
}
// Print the changes
fmt.Println(compare.FormatChanges(changes))
}
```
### Applying Changes
```go
import (
"github.com/sphere-sh/go-struct-sync/change"
)
// Apply changes to the original struct
result, err := change.ApplyChanges(old, changes)
if err != nil {
fmt.Printf("Error applying changes: %v\n", err)
return
}
// Cast to the correct type
modifiedPerson := result.(Person)
fmt.Printf("Modified person: %+v\n", modifiedPerson)
```
### Filtering Changes
```go
import (
"github.com/sphere-sh/go-struct-sync/compare"
)
// Get only modified fields
modifiedChanges := compare.FilterChanges(
changes,
[]change.ChangeType{change.Modified},
nil,
)
// Get only changes to specific fields
addressChanges := compare.FilterChanges(
changes,
nil,
[]string{"Address"},
)
```
### Working with Change Maps
```go
import (
"github.com/sphere-sh/go-struct-sync/compare"
)
// Convert changes to map for efficient lookup
changeMap := compare.ChangesToMap(changes)
// Get change for specific field
addressChange, exists := changeMap["Address"]
if exists {
fmt.Printf("Address changed from %v to %v\n", addressChange.OldValue, addressChange.NewValue)
}
```
## API Reference
### Types
```go
type ChangeType int
const (
Modified ChangeType = iota
Added
Deleted
)
type Change struct {
Field string
ChangeType ChangeType
OldValue interface{}
NewValue interface{}
}
```
### Functions
```go
// Compares two structs and returns a list of changes
func CompareStructs(old, new interface{}) ([]Change, error)
// Applies a list of changes to a struct
func ApplyChanges(original interface{}, changes []Change) (interface{}, error)
// Filters changes by type and/or field name
func FilterChanges(changes []Change, changeTypes []ChangeType, fields []string) []Change
// Converts a list of changes to a map keyed by field name
func ChangesToMap(changes []Change) map[string]Change
// Merges multiple change lists, with later changes taking precedence
func MergeChanges(changeLists ...[]Change) []Change
// Returns a human-readable representation of changes
func FormatChanges(changes []Change) string
// Serializes changes to JSON
func ChangesToJSON(changes []Change) ([]byte, error)
// Deserializes changes from JSON
func ChangesFromJSON(data []byte) ([]Change, error)
// Creates a new change list that would undo the given changes
func RevertChanges(changes []Change) []Change
```
## License
MIT License
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.