go-mycms-marsutils

README

Marshal Utils

This package is a tool to read and write the following file types:

• JSON
• XML
• TOML
• YAML

Versions

Current version is v1.0.0

• v1.0.0

Install

In your go project, run the following command

go get github.com/Lucas-Palomo/go-mycms-marsutils@latest

Examples

All examples can be found in "examples" directory

Read Example

This is toml configuration file.

[database]
host="localhost"
port=3306
username="root"
password="toor"

I created a struct to represent this configuration

package examples_internal

type Conf struct {
	DB DatabaseConf `toml:"database" json:"database"`
}

type DatabaseConf struct {
	Host     string `toml:"host" json:"host"`
	Port     int    `toml:"port" json:"port"`
	Username string `toml:"username" json:"username"`
	Password string `toml:"password" json:"password"`
}

Calling toml configuration is easy, see the bellow code:

package main

import (
	"fmt"
	Model "github.com/Lucas-Palomo/go-mycms-marsutils/examples/internal"
	"github.com/Lucas-Palomo/go-mycms-marsutils/marsutils"
	"log"
)

func main() {
	conf := Model.Conf{}
	err := marsutils.ReadFile("./data/config.toml", &conf, marsutils.TOML)
	if err != nil {
		log.Fatal(err)
	}
	// Now conf has all populated values
	fmt.Printf("%#v\n", conf)
}

The output is

examples_internal.Conf{DB:examples_internal.DatabaseConf{Host:"localhost", Port:3306, Username:"root", Password:"toor"}}

Write Example

Another usage is to create configuration files, in this example, we're creating a json to store the project configuration:

package main

import (
	Model "github.com/Lucas-Palomo/go-mycms-marsutils/examples/internal"
	"github.com/Lucas-Palomo/go-mycms-marsutils/marsutils"
	"log"
)

func main() {
	conf := Model.Conf{
		DB: Model.DatabaseConf{
			Host:     "localhost",
			Port:     3306,
			Username: "root",
			Password: "toor",
		},
	}
	err := marsutils.WriteFile("./data/config.json", &conf, marsutils.JSON)
	if err != nil {
		log.Fatal(err)
	}
	// Now conf content is in the config.json
}

FromString and ToString

We can load structs from a string and parse structs to string.

package main

import (
	"fmt"
	Model "github.com/Lucas-Palomo/go-mycms-marsutils/examples/internal"
	"github.com/Lucas-Palomo/go-mycms-marsutils/marsutils"
	"log"
)

func main() {
	conf := Model.Conf{
		DB: Model.DatabaseConf{
			Host:     "localhost",
			Port:     3306,
			Username: "root",
			Password: "toor",
		},
	}

	str, err := marsutils.ToString(&conf, marsutils.TOML)

	if err != nil {
		log.Fatal(err)
	}

	conf2 := Model.Conf{}
	err = marsutils.FromString(str, &conf2, marsutils.TOML)

	if err != nil {
		log.Fatal(err)
	}

	// Now conf2 has all populated values
	fmt.Printf("%#v\n", conf2)
}