c4d

PlantUML C4 to object parser

Turns puml C4 notation in to structurized object

QuckStart guide:

Complete example located at example/main.go

1. Prepare puml c4 content

For example one string:

System(taxamo, "Taxamo", "Calculates local tax (for EU B2B customers) and acts as a front-end for Braintree Payments.")

2. Add parser

    import (
		...
		pc42obj "github.com/rzrbld/puml-c4-to-object-go"
		"github.com/rzrbld/puml-c4-to-object-go/types"
		...
	)
    ...
    pumlC4Str := `System(taxamo, "Taxamo", "Calculates local tax (for EU B2B customers) and acts as a front-end for Braintree Payments.")`

    // do Parse stuff
	var testObj = &types.EncodedObj{}
	testObj = pc42obj.Parse(pumlC4Str)

	// marshal to json
	jsonMarshaled, _ := json.MarshalIndent(testObj, "", "\t")

	// print json output
	fmt.Println(string(jsonMarshaled))

    ...

3. Compile and run

{
	"Nodes": [
		{
			"Object": {
				"Alias": "taxamo",
				"Descr": "\"Calculates local tax (for EU B2B customers) and acts as a front-end for Braintree Payments.\"",
				"GType": "System",
				"Label": "\"Taxamo\""
			},
			"BoundaryAlias": "",
			"IsRelation": false
		}
	],
	"Rels": []
}

Little more complex example

import (
		...
		pc42obj "github.com/rzrbld/puml-c4-to-object-go"
		"github.com/rzrbld/puml-c4-to-object-go/types"
		...
	)

func main() {
    //...
    pumlC4Str := `System(taxamo, "Taxamo", "Calculates local tax (for EU B2B customers) and acts as a front-end for Braintree Payments.")`

    // do Parse stuff
	var testObj = &types.EncodedObj{}
	testObj = pc42obj.Parse(pumlC4Str)

    foreachObjects(testObj.Nodes)
    //...
}

func foreachObjects(objMap []*types.ParserGenericType) {
	for index, elem := range objMap {

		fmt.Println("---", index, "---")
		fmt.Println(" Object: ", elem.Object, " BoundaryAlias:", elem.BoundaryAlias, " IsRelation:", elem.IsRelation)

		var node types.GenericC4Type
		err := mapstructure.Decode(elem.Object, &node)
		if err != nil {
			log.Errorln("Kind of error. ", err)
		}

		fmt.Println("Alias", node.Alias,
			"GType", node.GType,
			"Label", node.Label,
			"Techn", node.Techn,
			"Descr", node.Descr,
			"Type", node.Type,
			"Index", node.Index,
			"From", node.From,
			"To", node.To)
	}
}

Compile and run

--- 0 ---
 Object:  map[Alias:taxamo Descr:"Calculates local tax (for EU B2B customers) and acts as a front-end for Braintree Payments." GType:System Label:"Taxamo"]  BoundaryAlias:   IsRelation: false

Alias taxamo
GType System
Label "Taxamo"
Techn
Descr "Calculates local tax (for EU B2B customers) and acts as a front-end for Braintree Payments."
Type
Index
From
To

Supported elements and attributes